From b40cf75c9de6178ac84796e242009b246f911656 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Date: Mon, 14 Nov 2022 10:01:05 +0000
Subject: [PATCH] Remove `Crypto.start()` (#2871)

This isn't really needed, and its semantics are poorly defined. (Contrary to
the comment, it dos *not* set background processes running).
---
 spec/unit/crypto.spec.ts                    | 18 ++++++++++++++++++
 src/client.ts                               |  1 -
 src/crypto/OutgoingRoomKeyRequestManager.ts |  9 +--------
 src/crypto/index.ts                         |  6 ++++--
 4 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/spec/unit/crypto.spec.ts b/spec/unit/crypto.spec.ts
index 333868c78..e8a95370c 100644
--- a/spec/unit/crypto.spec.ts
+++ b/spec/unit/crypto.spec.ts
@@ -1122,4 +1122,22 @@ describe("Crypto", function() {
             expect(free).toHaveBeenCalled();
         });
     });
+
+    describe("start", () => {
+        let client: TestClient;
+
+        beforeEach(async () => {
+            client = new TestClient("@alice:example.org", "aliceweb");
+            await client.client.initCrypto();
+        });
+
+        afterEach(async function() {
+            await client!.stop();
+        });
+
+        // start() is a no-op nowadays, so there's not much to test here.
+        it("should complete successfully", async () => {
+            await client!.client.crypto!.start();
+        });
+    });
 });
diff --git a/src/client.ts b/src/client.ts
index 316e554c0..9b545540e 100644
--- a/src/client.ts
+++ b/src/client.ts
@@ -1200,7 +1200,6 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
 
         if (this.crypto) {
             this.crypto.uploadDeviceKeys();
-            this.crypto.start();
         }
 
         // periodically poll for turn servers if we support voip
diff --git a/src/crypto/OutgoingRoomKeyRequestManager.ts b/src/crypto/OutgoingRoomKeyRequestManager.ts
index ff534be38..d5d1c3003 100644
--- a/src/crypto/OutgoingRoomKeyRequestManager.ts
+++ b/src/crypto/OutgoingRoomKeyRequestManager.ts
@@ -100,7 +100,7 @@ export class OutgoingRoomKeyRequestManager {
     // of sendOutgoingRoomKeyRequests
     private sendOutgoingRoomKeyRequestsRunning = false;
 
-    private clientRunning = false;
+    private clientRunning = true;
 
     constructor(
         private readonly baseApis: MatrixClient,
@@ -108,13 +108,6 @@ export class OutgoingRoomKeyRequestManager {
         private readonly cryptoStore: CryptoStore,
     ) {}
 
-    /**
-     * Called when the client is started. Sets background processes running.
-     */
-    public start(): void {
-        this.clientRunning = true;
-    }
-
     /**
      * Called when the client is stopped. Stops any running background processes.
      */
diff --git a/src/crypto/index.ts b/src/crypto/index.ts
index 66fdad668..fa67ac4f9 100644
--- a/src/crypto/index.ts
+++ b/src/crypto/index.ts
@@ -1775,9 +1775,11 @@ export class Crypto extends TypedEventEmitter<CryptoEvent, CryptoEventHandlerMap
         eventEmitter.on(MatrixEventEvent.Decrypted, this.onTimelineEvent);
     }
 
-    /** Start background processes related to crypto */
+    /**
+     * @deprecated this does nothing and will be removed in a future version
+     */
     public start(): void {
-        this.outgoingRoomKeyRequestManager.start();
+        logger.warn("MatrixClient.crypto.start() is deprecated");
     }
 
     /** Stop background processes related to crypto */