Merge pull request #8 from adobe-rnd/kv-confis

feat: use kv storage for configs

Author: maxakuru

src/config.js

@@ -10,29 +10,6 @@
  * governing permissions and limitations under the License.
  */
 
-/**
- * @type {Record<string, Record<string, Config>>}
- */
-const TENANT_CONFIGS = {
-  visualcomfort: {
-    base: {
-      apiKey: '59878b5d8af24fe9a354f523f5a0bb62',
-      magentoEnvironmentId: '97034e45-43a5-48ab-91ab-c9b5a98623a8',
-      magentoWebsiteCode: 'base',
-      magentoStoreViewCode: 'default',
-      coreEndpoint: 'https://www.visualcomfort.com/graphql',
-    },
-    '/us/p/{{urlkey}}/{{sku}}': {
-      pageType: 'product',
-      apiKey: '59878b5d8af24fe9a354f523f5a0bb62',
-      magentoEnvironmentId: '97034e45-43a5-48ab-91ab-c9b5a98623a8',
-      magentoWebsiteCode: 'base',
-      magentoStoreViewCode: 'default',
-      coreEndpoint: 'https://www.visualcomfort.com/graphql',
-    },
-  },
-};
-
 /**
  * @param {string[]} patterns
  * @param {string} path
@@ -59,13 +36,17 @@ function extractPathParams(pattern, path) {
  * @param {Context} ctx
  * @param {string} tenant
  * @param {Partial<Config>} [overrides={}]
- * @returns {Config|null}
+ * @returns {Promise<Config|null>}
  */
-export function resolveConfig(ctx, tenant, overrides, configs = TENANT_CONFIGS) {
-  const confMap = configs[tenant];
+export async function resolveConfig(ctx, tenant, overrides = {}) {
+  const confMap = await ctx.env.CONFIGS.get(tenant, 'json');
   if (!confMap) {
     return null;
   }
+  if (typeof confMap !== 'object') {
+    ctx.log.warn('invalid config for tenant', tenant);
+    return null;
+  }
 
   // order paths by preference
   const suffix = `/${ctx.url.pathname.split('/').slice(3).join('/')}`;

src/index.js

@@ -147,7 +147,7 @@ export default {
     }
 
     const overrides = Object.fromEntries(ctx.url.searchParams.entries());
-    const config = resolveConfig(ctx, tenant, overrides);
+    const config = await resolveConfig(ctx, tenant, overrides);
     if (!config) {
       return errorResponse(404, 'config not found');
     }

src/types.d.ts

@@ -1,4 +1,4 @@
-import type { ExecutionContext } from "@cloudflare/workers-types/experimental";
+import type { ExecutionContext, KVNamespace } from "@cloudflare/workers-types/experimental";
 
 declare global {
   export interface Config {
@@ -14,12 +14,16 @@ declare global {
   export interface Env {
     VERSION: string;
     ENVIRONMENT: string;
-    [key: string]: string;
+
+    // KV namespaces
+    CONFIGS: KVNamespace<string>;
+
+    [key: string]: string | KVNamespace<string>;
   }
 
   export interface Context extends ExecutionContext {
     url: URL;
-    env: Record<string, string>;
+    env: Env;
     log: Console;
     info: {
       method: string;

test/config.test.js

@@ -15,10 +15,15 @@ import { resolveConfig } from '../src/config.js';
 
 /**
  * @param {string} path
+ * @param {Record<string, Config>} configMap
  * @returns {Context}
  */
-const TEST_CONTEXT = (path) => ({
-  env: {},
+const TEST_CONTEXT = (path, configMap) => ({
+  env: {
+    CONFIGS: {
+      get: async (tenant) => configMap[tenant],
+    },
+  },
   log: console,
   url: new URL(`https://www.example.com/tenant/content${path}`),
   info: {
@@ -28,7 +33,7 @@ const TEST_CONTEXT = (path) => ({
 });
 
 describe('config tests', () => {
-  it('should extract path params', () => {
+  it('should extract path params', async () => {
     const tenantConfigs = {
       'test-tenant': {
         base: {
@@ -40,15 +45,18 @@ describe('config tests', () => {
         },
       },
     };
-    const config = resolveConfig(TEST_CONTEXT('/us/p/my-url-key/some-sku'), 'test-tenant', undefined, tenantConfigs);
+    const config = await resolveConfig(
+      TEST_CONTEXT('/us/p/my-url-key/some-sku', tenantConfigs),
+      'test-tenant',
+    );
     assert.deepStrictEqual(config, {
       apiKey: 'good',
       params: { urlkey: 'my-url-key', sku: 'some-sku' },
       pageType: 'product',
     });
   });
 
-  it('should allow wildcard path segments', () => {
+  it('should allow wildcard path segments', async () => {
     const tenantConfigs = {
       'test-tenant': {
         base: {
@@ -60,15 +68,18 @@ describe('config tests', () => {
         },
       },
     };
-    const config = resolveConfig(TEST_CONTEXT('/us/p/something-here/some-sku'), 'test-tenant', undefined, tenantConfigs);
+    const config = await resolveConfig(
+      TEST_CONTEXT('/us/p/something-here/some-sku', tenantConfigs),
+      'test-tenant',
+    );
     assert.deepStrictEqual(config, {
       apiKey: 'good',
       params: { sku: 'some-sku' },
       pageType: 'product',
     });
   });
 
-  it('should allow overrides', () => {
+  it('should allow overrides', async () => {
     const tenantConfigs = {
       'test-tenant': {
         base: {
@@ -80,7 +91,11 @@ describe('config tests', () => {
         },
       },
     };
-    const config = resolveConfig(TEST_CONTEXT('/us/p/some-sku'), 'test-tenant', { apiKey: 'good' }, tenantConfigs);
+    const config = await resolveConfig(
+      TEST_CONTEXT('/us/p/some-sku', tenantConfigs),
+      'test-tenant',
+      { apiKey: 'good' },
+    );
     assert.deepStrictEqual(config, {
       apiKey: 'good',
       params: { sku: 'some-sku' },

wrangler.toml

@@ -7,6 +7,10 @@ send_metrics = false
 
 build = { command = "npm install && node build.js" }
 
+kv_namespaces = [
+  { binding = "CONFIGS", id = "bb91e12a65a8462282396f32e63406f1", preview_id = "bb91e12a65a8462282396f32e63406f1" }
+]
+
 [vars]
 VERSION = "@@VERSION@@-dev"
 ENVIRONMENT = "dev"