feat: crypto can be passed in DB.start, this enables restarting the DB with a new crypto object

Author: CMCDragonkai

README.md

@@ -21,7 +21,6 @@ npm install --save @matrixai/db
 
 ## Usage
 
-
 ```ts
 import { DB } from '@matrixai/db';
 
@@ -76,6 +75,8 @@ async function main () {
 main();
 ```
 
+If you created the `DB` with a `crypto` object, then upon restarting the `DB`, you must pass in the same `crypto` object.
+
 ## Development
 
 Run `nix-shell`, and once you're inside, you can use:

src/DB.ts

@@ -54,11 +54,14 @@ class DB {
     logger.info(`Creating ${this.name}`);
     const db = new this({
       dbPath,
-      crypto,
       fs,
       logger,
     });
-    await db.start({ fresh, ...dbOptions });
+    await db.start({
+      crypto,
+      fresh,
+      ...dbOptions,
+    });
     logger.info(`Created ${this.name}`);
     return db;
   }
@@ -106,28 +109,27 @@ class DB {
 
   constructor({
     dbPath,
-    crypto,
     fs,
     logger,
   }: {
     dbPath: string;
-    crypto?: {
-      key: Buffer;
-      ops: Crypto;
-    };
     fs: FileSystem;
     logger: Logger;
   }) {
     this.logger = logger;
     this.dbPath = dbPath;
-    this.crypto = crypto;
     this.fs = fs;
   }
 
   public async start({
+    crypto,
     fresh = false,
     ...dbOptions
   }: {
+    crypto?: {
+      key: Buffer;
+      ops: Crypto;
+    };
     fresh?: boolean;
   } & DBOptions = {}) {
     this.logger.info(`Starting ${this.constructor.name}`);
@@ -142,6 +144,7 @@ class DB {
         throw new errors.ErrorDBDelete(e.message, { cause: e });
       }
     }
+    this.crypto = crypto;
     const db = await this.setupDb(this.dbPath, {
       ...dbOptions,
       createIfMissing: true,
@@ -179,6 +182,7 @@ class DB {
       }
     }
     await rocksdbP.dbClose(this._db);
+    delete this.crypto;
     this.logger.info(`Stopped ${this.constructor.name}`);
   }
 

tests/DB.test.ts

@@ -57,7 +57,7 @@ describe(DB.name, () => {
     await db.start();
     await db.put('a', 'value0');
     await db.stop();
-    await db.start();
+    await db.start({ crypto });
     expect(await db.get('a')).toBe('value0');
     await db.stop();
   });
@@ -98,7 +98,7 @@ describe(DB.name, () => {
     await db._put(['canary'], 'bad ju ju');
     await db.stop();
     // Start will fail, the DB will still be stopped
-    await expect(db.start()).rejects.toThrow(errors.ErrorDBKey);
+    await expect(db.start({ crypto })).rejects.toThrow(errors.ErrorDBKey);
     // DB is still corrupted at this point
     await expect(DB.createDB({ dbPath, crypto, logger })).rejects.toThrow(
       errors.ErrorDBKey,