feat: move getCachePlugin to shared

packages/helix-shared-tokencache/src/FSCachePlugin.d.ts

@@ -26,4 +26,6 @@ export declare class FSCachePlugin implements ICachePlugin {
   afterCacheAccess(tokenCacheContext: TokenCacheContext): Promise<boolean>;
 
   beforeCacheAccess(tokenCacheContext: TokenCacheContext): Promise<boolean>;
+
+  location: string;
 }

packages/helix-shared-tokencache/src/FSCachePlugin.js

@@ -70,4 +70,8 @@ export class FSCachePlugin {
     }
     return false;
   }
+
+  get location() {
+    return this.filePath;
+  }
 }

packages/helix-shared-tokencache/src/MemCachePlugin.d.ts

@@ -31,4 +31,6 @@ export declare class MemCachePlugin implements ICachePlugin {
   afterCacheAccess(tokenCacheContext: TokenCacheContext): Promise<boolean>;
 
   beforeCacheAccess(tokenCacheContext: TokenCacheContext): Promise<boolean>;
+
+  location: string;
 }

packages/helix-shared-tokencache/src/MemCachePlugin.js

@@ -85,4 +85,8 @@ export class MemCachePlugin {
     }
     return false;
   }
+
+  get location() {
+    return this.base ? this.base.location : this.key;
+  }
 }

packages/helix-shared-tokencache/src/S3CachePlugin.d.ts

@@ -43,6 +43,8 @@ export declare class S3CachePlugin implements ICachePlugin {
 
   deleteCache(): Promise<void>;
 
+  location: string;
+
   afterCacheAccess(tokenCacheContext: TokenCacheContext): Promise<boolean>;
 
   beforeCacheAccess(tokenCacheContext: TokenCacheContext): Promise<boolean>;

packages/helix-shared-tokencache/src/S3CachePlugin.js

@@ -110,6 +110,10 @@ export class S3CachePlugin {
     }
     return false;
   }
+
+  get location() {
+    return `${this.bucket}/${this.key}`;
+  }
 }
 
 S3CachePlugin.encrypt = encrypt;

packages/helix-shared-tokencache/src/getCachePlugin.js

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+/* eslint-disable no-param-reassign */
+
+import { MemCachePlugin } from './MemCachePlugin.js';
+import { S3CacheManager } from './S3CacheManager.js';
+
+/**
+ * Returns the S3 cache plugin
+ *
+ * @returns {ICachePlugin} the cache plugin
+ */
+export async function getCachePlugin(opts, type) {
+  const { log, contentBusId } = opts;
+
+  const derivedOpts = [];
+  if (contentBusId) {
+    derivedOpts.push({
+      prefix: `${contentBusId}/.helix-auth`,
+      secret: contentBusId,
+    });
+  }
+  const basePlugin = await S3CacheManager.findCache('content', {
+    log,
+    prefix: 'default/.helix-auth',
+    secret: 'default',
+    bucket: 'helix-content-bus',
+    type,
+  }, ...derivedOpts);
+
+  log.info(`using connected user from ${basePlugin.location}`);
+
+  /** @type MemCachePluginOptions */
+  const cacheOpts = {
+    log,
+    key: basePlugin.key,
+    base: basePlugin,
+  };
+  if (process.env.HELIX_ONEDRIVE_LOCAL_AUTH_CACHE) {
+    cacheOpts.caches = new Map();
+  }
+  return new MemCachePlugin(cacheOpts);
+}

packages/helix-shared-tokencache/test/fs-cache-plugin.test.js

@@ -46,6 +46,7 @@ describe('FSCachePlugin Test', () => {
     assert.deepStrictEqual(JSON.parse(await fs.readFile(testFilePath, 'utf-8')), {
       access_token: '1234',
     });
+    assert.strictEqual(p.location, testFilePath);
   });
 
   it('does not the cache data to the filesystem if context not changed', async () => {

packages/helix-shared-tokencache/test/getCachePlugin.test.js

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+/* eslint-env mocha */
+import assert from 'assert';
+import { getCachePlugin } from '../src/getCachePlugin.js';
+import { Nock } from './utils.js';
+
+const DEFAULT_ENV = {
+  AZURE_HELIX_SERVICE_CLIENT_ID: 'client-id',
+  AZURE_HELIX_SERVICE_CLIENT_SECRET: 'client-secret',
+};
+
+describe('getCachePlugin tests', () => {
+  let nock;
+  let savedProcessEnv;
+  beforeEach(() => {
+    nock = new Nock();
+    savedProcessEnv = process.env;
+    process.env = {
+      ...process.env,
+      AWS_REGION: 'us-east-1',
+      AWS_ACCESS_KEY_ID: 'fake-key-id',
+      AWS_SECRET_ACCESS_KEY: 'fake-secret',
+    };
+  });
+
+  afterEach(() => {
+    nock.done();
+    process.env = savedProcessEnv;
+  });
+
+  it('uses derived opts if contentBusId is available', async () => {
+    const contentBusId = '0123456789abcdef0123456789abcdef0123456789abcdef0123456789a';
+    nock('https://helix-content-bus.s3.us-east-1.amazonaws.com')
+      .head(`/${contentBusId}/.helix-auth/auth-onedrive-content.json`)
+      .reply(200);
+
+    const cachePlugin = await getCachePlugin({
+      log: console,
+      env: DEFAULT_ENV,
+      contentBusId,
+    }, 'onedrive');
+    assert.ok(cachePlugin);
+    assert.strictEqual(cachePlugin.location, `helix-content-bus/${contentBusId}/.helix-auth/auth-onedrive-content.json`);
+  });
+
+  it('uses empty opts if contentBusId is not available', async () => {
+    // "content-bus-id/.helix-auth/auth-onedrive-content.json"
+    const cachePlugin = await getCachePlugin({
+      log: console,
+      env: DEFAULT_ENV,
+      contentBusId: null,
+    }, 'onedrive');
+    assert.ok(cachePlugin);
+    assert.strictEqual(cachePlugin.location, 'helix-content-bus/default/.helix-auth/auth-onedrive-content.json');
+  });
+});

packages/helix-shared-tokencache/test/mem-cache-plugin.test.js

@@ -39,6 +39,7 @@ describe('MemCachePlugin Test', () => {
     const ret = await p.afterCacheAccess(ctx);
     assert.strictEqual(ret, true);
     assert.strictEqual(caches.get('foobar-key'), 'foobar');
+    assert.strictEqual(p.location, 'foobar-key');
   });
 
   it('read/writes the cache w/o base with global cache', async () => {