Add methods to terminate idb worker (#3362)

spec/unit/stores/indexeddb.spec.ts

@@ -254,4 +254,31 @@ describe("IndexedDBStore", () => {
         });
         await expect(store.startup()).rejects.toThrow("Test");
     });
+
+    it("remote worker should terminate upon destroy call", async () => {
+        const terminate = jest.fn();
+        const worker = new (class MockWorker {
+            private onmessage!: (data: any) => void;
+            postMessage(data: any) {
+                this.onmessage({
+                    data: {
+                        command: "cmd_success",
+                        seq: data.seq,
+                        result: [],
+                    },
+                });
+            }
+            public terminate = terminate;
+        })() as unknown as Worker;
+
+        const store = new IndexedDBStore({
+            indexedDB: indexedDB,
+            dbName: "database",
+            localStorage,
+            workerFactory: () => worker,
+        });
+        await store.startup();
+        await expect(store.destroy()).resolves;
+        expect(terminate).toHaveBeenCalled();
+    });
 });

src/store/index.ts

@@ -245,4 +245,9 @@ export interface IStore {
      * Removes a specific batch of to-device messages from the queue
      */
     removeToDeviceBatch(id: number): Promise<void>;
+
+    /**
+     * Stop the store and perform any appropriate cleanup
+     */
+    destroy(): Promise<void>;
 }

src/store/indexeddb-backend.ts

@@ -35,6 +35,7 @@ export interface IIndexedDBBackend {
     saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void>;
     getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null>;
     removeToDeviceBatch(id: number): Promise<void>;
+    destroy(): Promise<void>;
 }
 
 export type UserTuple = [userId: string, presenceEvent: Partial<IEvent>];

src/store/indexeddb-local-backend.ts

@@ -594,4 +594,11 @@ export class LocalIndexedDBStoreBackend implements IIndexedDBBackend {
         store.delete(id);
         await txnAsPromise(txn);
     }
+
+    /*
+     * Close the database
+     */
+    public async destroy(): Promise<void> {
+        this.db?.close();
+    }
 }

src/store/indexeddb-remote-backend.ts

@@ -200,4 +200,11 @@ export class RemoteIndexedDBStoreBackend implements IIndexedDBBackend {
             logger.warn("Unrecognised message from worker: ", msg);
         }
     };
+
+    /*
+     * Destroy the web worker
+     */
+    public async destroy(): Promise<void> {
+        this.worker?.terminate();
+    }
 }

src/store/indexeddb.ts

@@ -151,6 +151,13 @@ export class IndexedDBStore extends MemoryStore {
             });
     }
 
+    /*
+     * Close the database and destroy any associated workers
+     */
+    public destroy(): Promise<void> {
+        return this.backend.destroy();
+    }
+
     private onClose = (): void => {
         this.emitter.emit("closed");
     };

src/store/memory.ts

@@ -435,4 +435,8 @@ export class MemoryStore implements IStore {
         this.pendingToDeviceBatches = this.pendingToDeviceBatches.filter((batch) => batch.id !== id);
         return Promise.resolve();
     }
+
+    public async destroy(): Promise<void> {
+        // Nothing to do
+    }
 }

src/store/stub.ts

@@ -266,4 +266,8 @@ export class StubStore implements IStore {
     public async removeToDeviceBatch(id: number): Promise<void> {
         return Promise.resolve();
     }
+
+    public async destroy(): Promise<void> {
+        // Nothing to do
+    }
 }