Replace Vercel KV adapter with Vercel Runtime Cache API

Author: Nathan Booker

.changeset/chatty-forks-sniff.md

@@ -0,0 +1,5 @@
+---
+"@bigcommerce/catalyst-core": minor
+---
+
+Implement Vercel Runtime Cache API as replacement for Vercel KV adapter

core/lib/kv/adapters/bc.ts

@@ -2,23 +2,14 @@ import { Redis } from '@upstash/redis';
 
 import { KvAdapter, SetCommandOptions } from '../types';
 
-import { MemoryKvAdapter } from './memory';
-
-const memoryKv = new MemoryKvAdapter();
-
 export class UpstashKvAdapter implements KvAdapter {
   private upstashKv = Redis.fromEnv();
-  private memoryKv = memoryKv;
 
   async mget<Data>(...keys: string[]) {
-    const memoryValues = await this.memoryKv.mget<Data>(...keys);
-
-    return memoryValues.length ? memoryValues : this.upstashKv.mget<Data[]>(keys);
+    return this.upstashKv.mget<Data[]>(keys);
   }
 
   async set<Data>(key: string, value: Data, opts?: SetCommandOptions) {
-    await this.memoryKv.set(key, value, opts);
-
     const response = await this.upstashKv.set(key, value, opts);
 
     if (response === 'OK') {

core/lib/kv/adapters/upstash.ts

@@ -0,0 +1,75 @@
+import { getCache } from '@vercel/functions';
+
+import { KvAdapter, SetCommandOptions } from '../types';
+
+export class RuntimeCacheAdapter implements KvAdapter {
+  private cache = getCache();
+
+  async mget<Data>(...keys: string[]): Promise<Array<Data | null>> {
+    this.logger(
+      `MGET - Keys: ${keys.toString()} - Source: RUNTIME_CACHE - Fetching ${keys.length} keys`,
+    );
+
+    try {
+      const values = await Promise.all(
+        keys.map(async (key) => {
+          try {
+            // Use the Runtime Cache API
+            const cachedValue = await this.cache.get(key);
+
+            if (cachedValue !== null) {
+              this.logger(`RUNTIME_CACHE GET - Key: ${key} - Found: true`);
+              return cachedValue;
+            }
+
+            this.logger(`RUNTIME_CACHE GET - Key: ${key} - Found: false`);
+            return null;
+          } catch (error) {
+            this.logger(
+              `RUNTIME_CACHE GET ERROR - Key: ${key} - Error: ${error instanceof Error ? error.message : 'Unknown error'}`,
+            );
+            return null;
+          }
+        }),
+      );
+
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      return values as Array<Data | null>;
+    } catch (error) {
+      this.logger(
+        `RUNTIME_CACHE ACCESS ERROR - Returning null values: ${error instanceof Error ? error.message : 'Unknown error'}`,
+      );
+
+      // Return null for all keys if Runtime Cache is unavailable
+      return keys.map(() => null);
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async set<Data>(key: string, value: Data, _opts?: SetCommandOptions): Promise<Data | null> {
+    this.logger(`SET - Key: ${key} - Setting in runtime cache`);
+
+    try {
+      await this.cache.set(key, value);
+      this.logger(`RUNTIME_CACHE SET - Key: ${key} - Success`);
+    } catch (error) {
+      this.logger(
+        `RUNTIME_CACHE SET ERROR - Key: ${key} - Error: ${error instanceof Error ? error.message : 'Unknown error'}`,
+      );
+    }
+
+    return value;
+  }
+
+  private logger(message: string) {
+    // Check if logging is enabled using the same logic as the main KV class
+    const loggingEnabled =
+      (process.env.NODE_ENV !== 'production' && process.env.KV_LOGGER !== 'false') ||
+      process.env.KV_LOGGER === 'true';
+
+    if (loggingEnabled) {
+      // eslint-disable-next-line no-console
+      console.log(`[BigCommerce] Runtime Cache ${message}`);
+    }
+  }
+}

core/lib/kv/adapters/vercel-runtime-cache.ts

@@ -3,6 +3,7 @@ import { KvAdapter, SetCommandOptions } from './types';
 
 interface Config {
   logger?: boolean;
+  disableMemory?: boolean;
 }
 
 const memoryKv = new MemoryKvAdapter();
@@ -25,6 +26,19 @@ class KV<Adapter extends KvAdapter> implements KvAdapter {
   async mget<Data>(...keys: string[]) {
     const kv = await this.getKv();
 
+    // Skip memory cache if disabled (useful for testing)
+    if (this.config.disableMemory) {
+      this.logger(`MGET - Keys: ${keys.toString()} - MEMORY DISABLED - Direct adapter access`);
+
+      const directValues = await kv.mget<Data>(...keys);
+
+      this.logger(
+        `MGET - Keys: ${keys.toString()} - Value: ${JSON.stringify(directValues, null, 2)}`,
+      );
+
+      return directValues;
+    }
+
     const memoryValues = (await this.memoryKv.mget<Data>(...keys)).filter(Boolean);
 
     if (memoryValues.length === keys.length) {
@@ -60,6 +74,13 @@ class KV<Adapter extends KvAdapter> implements KvAdapter {
 
     this.logger(`SET - Key: ${key} - Value: ${JSON.stringify(value, null, 2)}`);
 
+    // Skip memory cache if disabled (useful for testing)
+    if (this.config.disableMemory) {
+      this.logger(`SET - Key: ${key} - MEMORY DISABLED - Direct adapter only`);
+
+      return kv.set(key, value, opts);
+    }
+
     await Promise.all([this.memoryKv.set(key, value, opts), kv.set(key, value, opts)]);
 
     return value;
@@ -82,16 +103,11 @@ class KV<Adapter extends KvAdapter> implements KvAdapter {
 }
 
 async function createKVAdapter() {
-  if (process.env.BC_KV_REST_API_URL && process.env.BC_KV_REST_API_TOKEN) {
-    const { BcKvAdapter } = await import('./adapters/bc');
-
-    return new BcKvAdapter();
-  }
-
-  if (process.env.KV_REST_API_URL && process.env.KV_REST_API_TOKEN) {
-    const { VercelKvAdapter } = await import('./adapters/vercel');
+  // Prioritize Runtime Cache for Vercel environments
+  if (process.env.VERCEL === '1') {
+    const { RuntimeCacheAdapter } = await import('./adapters/vercel-runtime-cache');
 
-    return new VercelKvAdapter();
+    return new RuntimeCacheAdapter();
   }
 
   if (process.env.UPSTASH_REDIS_REST_URL && process.env.UPSTASH_REDIS_REST_TOKEN) {
@@ -107,6 +123,7 @@ const adapterInstance = new KV(createKVAdapter, {
   logger:
     (process.env.NODE_ENV !== 'production' && process.env.KV_LOGGER !== 'false') ||
     process.env.KV_LOGGER === 'true',
+  disableMemory: process.env.KV_DISABLE_MEMORY === 'true',
 });
 
 export { adapterInstance as kv };

core/lib/kv/adapters/vercel.ts

@@ -34,7 +34,7 @@
     "@t3-oss/env-core": "^0.13.6",
     "@upstash/redis": "^1.35.0",
     "@vercel/analytics": "^1.5.0",
-    "@vercel/kv": "^3.0.0",
+    "@vercel/functions": "^2.2.3",
     "@vercel/speed-insights": "^1.2.0",
     "clsx": "^2.1.1",
     "content-security-policy-builder": "^2.3.0",