@bedrock/kms 10.0.0 → 10.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # bedrock-kms ChangeLog
 
+## 10.1.0 - 2022-05-13
+
+### Added
+- Add `fresh` option to `keystores.get()` API to allow for retrieving a fresh
+  (not previously cached) keystore config record.
+
 ## 10.0.0 - 2022-04-29
 
 ### Changed

package/lib/keystores.js

@@ -17,6 +17,9 @@ import './config.js';
 const USAGE_COUNTER_MAX_CONCURRENCY = 100;
 let KEYSTORE_CONFIG_CACHE;
 
+// cache only exported for testing purposes
+export {KEYSTORE_CONFIG_CACHE as _KEYSTORE_CONFIG_CACHE};
+
 bedrock.events.on('bedrock.init', async () => {
   const cfg = bedrock.config.kms;
   KEYSTORE_CONFIG_CACHE = new LruCache({
@@ -100,8 +103,7 @@ export async function insert({config} = {}) {
     config
   };
   try {
-    const result = await database.collections['kms-keystore'].insertOne(
-      record, database.writeOptions);
+    const result = await database.collections['kms-keystore'].insertOne(record);
     return result.ops[0];
   } catch(e) {
     if(!database.isDuplicateError(e)) {
@@ -180,7 +182,7 @@ export async function update({config, explain = false} = {}) {
       config,
       'meta.updated': Date.now()
     }
-  }, database.writeOptions);
+  });
 
   if(result.result.n === 0) {
     // no records changed...
@@ -207,11 +209,16 @@ export async function update({config, explain = false} = {}) {
  *
  * @param {object} options - The options to use.
  * @param {string} options.id - The ID of the keystore.
+ * @param {boolean} [options.fresh=false] - False if it is safe to use a
+ *   potentially cached value, false to always get a fresh value.
  *
  * @returns {Promise<object>} Resolves to `{config, meta}`.
  */
-export async function get({id} = {}) {
+export async function get({id, fresh = false} = {}) {
   assert.string(id, 'id');
+  if(fresh) {
+    KEYSTORE_CONFIG_CACHE.delete(id);
+  }
   const fn = () => _getUncachedRecord({id});
   return KEYSTORE_CONFIG_CACHE.memoize({key: id, fn});
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrock/kms",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "type": "module",
   "description": "Key management for Bedrock applications",
   "main": "./lib/index.js",

package/test/mocha/13-keystores-update-api.js

@@ -24,6 +24,12 @@ describe('keystores APIs', () => {
     controller: 'f2da13ee-50d2-46ab-865d-ee23d609edbd',
     sequence: 0,
   };
+  const mockConfigDelta = {
+    id: 'https://example.com/keystores/f9da6f23-6e13-42e9-88d3-5c03011ecbbf',
+    kmsModule: 'ssm-v1',
+    controller: '17e77da1-bb7e-4fe2-b4dd-1c4bba933d7c',
+    sequence: 0,
+  };
 
   before(async () => {
     let err;
@@ -31,6 +37,7 @@ describe('keystores APIs', () => {
       await keystores.insert({config: mockConfigAlpha});
       await keystores.insert({config: mockConfigBeta});
       await keystores.insert({config: mockConfigGamma});
+      await keystores.insert({config: mockConfigDelta});
     } catch(e) {
       err = e;
     }
@@ -93,6 +100,39 @@ describe('keystores APIs', () => {
       result.should.be.a('boolean');
       result.should.be.true;
     });
+    it('successfully updates a keystore and gets a fresh value', async () => {
+      const config = klona(mockConfigDelta);
+
+      // get keystore config to prime cache
+      await keystores.get({id: config.id});
+
+      // now update config
+      let err;
+      let result;
+      config.sequence++;
+      config.controller = 'someOtherController';
+      const oldDelete = keystores._KEYSTORE_CONFIG_CACHE.delete;
+      try {
+        // remove cache delete functionality to test fresh API
+        keystores._KEYSTORE_CONFIG_CACHE.delete = () => {};
+        result = await keystores.update({config});
+      } catch(e) {
+        err = e;
+      } finally {
+        keystores._KEYSTORE_CONFIG_CACHE.delete = oldDelete;
+      }
+      assertNoError(err);
+      result.should.be.a('boolean');
+      result.should.be.true;
+
+      // get keystore config, should be stale
+      const stale = await keystores.get({id: config.id});
+      stale.config.controller.should.not.equal(config.controller);
+
+      // get fresh config
+      const fresh = await keystores.get({id: config.id, fresh: true});
+      fresh.config.controller.should.equal(config.controller);
+    });
     it('fails to updates a keystore using wrong sequence number', async () => {
       let err;
       let result;