@trieb.work/nextjs-turbo-redis-cache 1.12.0 → 1.14.0

package/src/utils/prefix.test.ts

@@ -0,0 +1,115 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import os from 'node:os';
+import fs from 'node:fs';
+import path from 'node:path';
+import { resolveKeyPrefix } from './prefix';
+
+function withEnv<T>(env: Partial<NodeJS.ProcessEnv>, fn: () => T): T {
+  const original: NodeJS.ProcessEnv = { ...process.env };
+  Object.entries(env).forEach(([k, v]) => {
+    const envRec = process.env as Record<string, string | undefined>;
+    if (v === undefined) delete envRec[k];
+    else envRec[k] = v as string;
+  });
+  try {
+    return fn();
+  } finally {
+    process.env = original;
+  }
+}
+
+function makeBuildIdTree(buildId: string) {
+  const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'prefix-test-'));
+  const nextDir = path.join(tmp, '.next');
+  const serverDir = path.join(nextDir, 'server');
+  fs.mkdirSync(serverDir, { recursive: true });
+  fs.writeFileSync(path.join(nextDir, 'BUILD_ID'), buildId, 'utf8');
+  return {
+    serverDistDir: serverDir,
+    cleanup: () => fs.rmSync(tmp, { recursive: true, force: true }),
+  };
+}
+
+describe('resolveKeyPrefix', () => {
+  beforeEach(() => {
+    const envRec = process.env as Record<string, string | undefined>;
+    delete envRec.KEY_PREFIX;
+    delete envRec.VERCEL_URL;
+  });
+
+  it('returns option keyPrefix when provided (including empty string)', () => {
+    const p1 = resolveKeyPrefix({ optionKeyPrefix: 'opt_', env: process.env });
+    expect(p1).toBe('opt_');
+
+    const p2 = resolveKeyPrefix({ optionKeyPrefix: '', env: process.env });
+    expect(p2).toBe('');
+  });
+
+  it('uses KEY_PREFIX when option is undefined', () => {
+    const res = withEnv({ KEY_PREFIX: 'envkp_' }, () =>
+      resolveKeyPrefix({ optionKeyPrefix: undefined, env: process.env }),
+    );
+    expect(res).toBe('envkp_');
+  });
+
+  it('uses BUILD_ID when KEY_PREFIX and VERCEL_URL are absent and BUILD_ID readable', () => {
+    const { serverDistDir, cleanup } = makeBuildIdTree('BID123');
+    try {
+      const res = resolveKeyPrefix({
+        optionKeyPrefix: undefined,
+        env: process.env,
+        serverDistDir,
+      });
+      expect(res).toBe('BID123');
+    } finally {
+      cleanup();
+    }
+  });
+
+  it('uses VERCEL_URL before BUILD_ID when both are available', () => {
+    const { serverDistDir, cleanup } = makeBuildIdTree('BIDXYZ');
+    try {
+      const res = withEnv({ VERCEL_URL: 'vercel.example' }, () =>
+        resolveKeyPrefix({
+          optionKeyPrefix: undefined,
+          env: process.env,
+          serverDistDir,
+        }),
+      );
+      expect(res).toBe('vercel.example');
+    } finally {
+      cleanup();
+    }
+  });
+
+  it('uses VERCEL_URL when KEY_PREFIX and BUILD_ID not available', () => {
+    const res = withEnv({ VERCEL_URL: 'vercel.example' }, () =>
+      resolveKeyPrefix({ optionKeyPrefix: undefined, env: process.env }),
+    );
+    expect(res).toBe('vercel.example');
+  });
+
+  it('falls back to UNDEFINED_URL_ when nothing else available', () => {
+    const res = resolveKeyPrefix({
+      optionKeyPrefix: undefined,
+      env: process.env,
+    });
+    expect(res).toBe('UNDEFINED_URL_');
+  });
+
+  it('treats empty env values as absent', () => {
+    const { serverDistDir, cleanup } = makeBuildIdTree('BIDX');
+    try {
+      const res = withEnv({ KEY_PREFIX: '', VERCEL_URL: '' }, () =>
+        resolveKeyPrefix({
+          optionKeyPrefix: undefined,
+          env: process.env,
+          serverDistDir,
+        }),
+      );
+      expect(res).toBe('BIDX');
+    } finally {
+      cleanup();
+    }
+  });
+});

package/src/utils/prefix.ts

@@ -0,0 +1,44 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+export function readBuildId(serverDistDir?: string): string | undefined {
+  try {
+    if (serverDistDir) {
+      const buildIdPath = path.join(serverDistDir, '..', 'BUILD_ID');
+      const buildId = fs.readFileSync(buildIdPath, 'utf8').trim();
+      return buildId || undefined;
+    }
+  } catch {
+    // fall through to cwd-based read
+  }
+  try {
+    const fromCwd = path.join(process.cwd(), '.next', 'BUILD_ID');
+    const buildId = fs.readFileSync(fromCwd, 'utf8').trim();
+    return buildId || undefined;
+  } catch {
+    return undefined;
+  }
+}
+
+export function resolveKeyPrefix({
+  optionKeyPrefix,
+  serverDistDir,
+  env,
+}: {
+  optionKeyPrefix?: string;
+  serverDistDir?: string;
+  env: NodeJS.ProcessEnv;
+}): string {
+  // If the option is explicitly provided, honor it even if it's an empty string
+  if (optionKeyPrefix !== undefined) {
+    return optionKeyPrefix;
+  }
+
+  const keyPrefixEnv =
+    env.KEY_PREFIX && env.KEY_PREFIX.length > 0 ? env.KEY_PREFIX : undefined;
+  const vercelUrl =
+    env.VERCEL_URL && env.VERCEL_URL.length > 0 ? env.VERCEL_URL : undefined;
+  const buildId = readBuildId(serverDistDir);
+
+  return keyPrefixEnv ?? vercelUrl ?? buildId ?? 'UNDEFINED_URL_';
+}

package/test/cache-components/cache-components.integration.spec.ts

@@ -28,7 +28,7 @@ describe('Next.js 16 Cache Components Integration', () => {
       __dirname,
       '..',
       'integration',
-      'next-app-16-1-1-cache-components',
+      'next-app-16-2-3-cache-components',
     );
 
     console.log('Installing Next.js app dependencies...');

package/test/integration/build-id-prefix.integration.test.ts

@@ -0,0 +1,102 @@
+import { describe, it, expect, beforeAll, afterAll } from 'vitest';
+import { spawn, ChildProcessWithoutNullStreams } from 'child_process';
+import { createClient, RedisClientType } from 'redis';
+import path from 'path';
+import fs from 'fs';
+import fetch from 'node-fetch';
+
+const NEXT_APP = 'next-app-15-4-7';
+const PORT = 3075;
+const BASE_URL = `http://localhost:${PORT}`;
+
+async function waitForServer(url: string, timeout = 20000) {
+  const start = Date.now();
+  while (Date.now() - start < timeout) {
+    try {
+      const res = await fetch(url + '/api/cached-static-fetch');
+      if (res.ok) return;
+    } catch {}
+    await new Promise((r) => setTimeout(r, 300));
+  }
+  throw new Error('Next.js server did not start in time');
+}
+
+describe('BUILD_ID-based key prefix (Next handlers)', () => {
+  let nextProcess: ChildProcessWithoutNullStreams | undefined;
+  let redis: RedisClientType;
+  let appDir: string;
+  let buildId: string;
+
+  beforeAll(async () => {
+    appDir = path.join(__dirname, NEXT_APP);
+
+    // Ensure clean env so BUILD_ID precedence kicks in
+    delete (process.env as Record<string, string | undefined>).KEY_PREFIX;
+    delete (process.env as Record<string, string | undefined>).VERCEL_URL;
+    process.env.VERCEL_ENV = 'production';
+    process.env.REDISHOST = process.env.REDISHOST || 'localhost';
+    process.env.REDISPORT = process.env.REDISPORT || '6379';
+
+    // Install + build
+    await new Promise<void>((resolve, reject) => {
+      const p = spawn('pnpm', ['install'], { cwd: appDir, stdio: 'inherit' });
+      p.on('close', (code) =>
+        code === 0 ? resolve() : reject(new Error('pnpm i failed')),
+      );
+    });
+    await new Promise<void>((resolve, reject) => {
+      const p = spawn('pnpm', ['build'], { cwd: appDir, stdio: 'inherit' });
+      p.on('close', (code) =>
+        code === 0 ? resolve() : reject(new Error('pnpm build failed')),
+      );
+    });
+
+    // Read BUILD_ID from the built app
+    buildId = fs
+      .readFileSync(path.join(appDir, '.next', 'BUILD_ID'), 'utf8')
+      .trim();
+
+    // Start server without KEY_PREFIX/VERCEL_URL
+    nextProcess = spawn('npx', ['next', 'start', '-p', String(PORT)], {
+      cwd: appDir,
+      env: { ...process.env, SKIP_KEYSPACE_CONFIG_CHECK: 'true' },
+      stdio: 'pipe',
+    });
+
+    nextProcess.stderr?.on(
+      'data',
+      (d) => process.env.DEBUG_INTEGRATION && console.error(String(d)),
+    );
+
+    await waitForServer(BASE_URL);
+
+    // Connect Redis
+    redis = createClient({
+      url: `redis://${process.env.REDISHOST}:${process.env.REDISPORT}`,
+    });
+    await redis.connect();
+  }, 180000);
+
+  afterAll(async () => {
+    try {
+      if (redis) await redis.quit();
+    } finally {
+      if (nextProcess) nextProcess.kill();
+    }
+  });
+
+  it('uses BUILD_ID as the Redis key prefix when no KEY_PREFIX/VERCEL_URL set', async () => {
+    // Warm cache twice to ensure a set occurs even if first was during startup
+    const res1 = await fetch(BASE_URL + '/api/cached-static-fetch');
+    expect(res1.ok).toBe(true);
+    await new Promise((r) => setTimeout(r, 500));
+    const res2 = await fetch(BASE_URL + '/api/cached-static-fetch');
+    expect(res2.ok).toBe(true);
+
+    // Allow background syncs
+    await new Promise((r) => setTimeout(r, 1500));
+
+    const keys = await redis.keys(`${buildId}*`);
+    expect(keys.length).toBeGreaterThan(0);
+  });
+});

package/test/integration/next-app-15-0-3/pnpm-lock.yaml

@@ -155,67 +155,79 @@ packages:
     resolution: {integrity: sha512-9B+taZ8DlyyqzZQnoeIvDVR/2F4EbMepXMc/NdVbkzsJbzkUjhXv/70GQJ7tdLA4YJgNP25zukcxpX2/SueNrA==}
     cpu: [arm64]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-libvips-linux-arm@1.0.5':
     resolution: {integrity: sha512-gvcC4ACAOPRNATg/ov8/MnbxFDJqf/pDePbBnuBDcjsI8PssmjoKMAz4LtLaVi+OnSb5FK/yIOamqDwGmXW32g==}
     cpu: [arm]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-libvips-linux-s390x@1.0.4':
     resolution: {integrity: sha512-u7Wz6ntiSSgGSGcjZ55im6uvTrOxSIS8/dgoVMoiGE9I6JAfU50yH5BoDlYA1tcuGS7g/QNtetJnxA6QEsCVTA==}
     cpu: [s390x]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-libvips-linux-x64@1.0.4':
     resolution: {integrity: sha512-MmWmQ3iPFZr0Iev+BAgVMb3ZyC4KeFc3jFxnNbEPas60e1cIfevbtuyf9nDGIzOaW9PdnDciJm+wFFaTlj5xYw==}
     cpu: [x64]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-libvips-linuxmusl-arm64@1.0.4':
     resolution: {integrity: sha512-9Ti+BbTYDcsbp4wfYib8Ctm1ilkugkA/uscUn6UXK1ldpC1JjiXbLfFZtRlBhjPZ5o1NCLiDbg8fhUPKStHoTA==}
     cpu: [arm64]
     os: [linux]
+    libc: [musl]
 
   '@img/sharp-libvips-linuxmusl-x64@1.0.4':
     resolution: {integrity: sha512-viYN1KX9m+/hGkJtvYYp+CCLgnJXwiQB39damAO7WMdKWlIhmYTfHjwSbQeUK/20vY154mwezd9HflVFM1wVSw==}
     cpu: [x64]
     os: [linux]
+    libc: [musl]
 
   '@img/sharp-linux-arm64@0.33.5':
     resolution: {integrity: sha512-JMVv+AMRyGOHtO1RFBiJy/MBsgz0x4AWrT6QoEVVTyh1E39TrCUpTRI7mx9VksGX4awWASxqCYLCV4wBZHAYxA==}
     engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
     cpu: [arm64]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-linux-arm@0.33.5':
     resolution: {integrity: sha512-JTS1eldqZbJxjvKaAkxhZmBqPRGmxgu+qFKSInv8moZ2AmT5Yib3EQ1c6gp493HvrvV8QgdOXdyaIBrhvFhBMQ==}
     engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
     cpu: [arm]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-linux-s390x@0.33.5':
     resolution: {integrity: sha512-y/5PCd+mP4CA/sPDKl2961b+C9d+vPAveS33s6Z3zfASk2j5upL6fXVPZi7ztePZ5CuH+1kW8JtvxgbuXHRa4Q==}
     engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
     cpu: [s390x]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-linux-x64@0.33.5':
     resolution: {integrity: sha512-opC+Ok5pRNAzuvq1AG0ar+1owsu842/Ab+4qvU879ippJBHvyY5n2mxF1izXqkPYlGuP/M556uh53jRLJmzTWA==}
     engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
     cpu: [x64]
     os: [linux]
+    libc: [glibc]
 
   '@img/sharp-linuxmusl-arm64@0.33.5':
     resolution: {integrity: sha512-XrHMZwGQGvJg2V/oRSUfSAfjfPxO+4DkiRh6p2AFjLQztWUuY/o8Mq0eMQVIY7HJ1CDQUJlxGGZRw1a5bqmd1g==}
     engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
     cpu: [arm64]
     os: [linux]
+    libc: [musl]
 
   '@img/sharp-linuxmusl-x64@0.33.5':
     resolution: {integrity: sha512-WT+d/cgqKkkKySYmqoZ8y3pxx7lx9vVejxW/W4DOFMYVSkErR+w7mf2u8m/y4+xHe7yY9DAXQMWQhpnMuFfScw==}
     engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
     cpu: [x64]
     os: [linux]
+    libc: [musl]
 
   '@img/sharp-wasm32@0.33.5':
     resolution: {integrity: sha512-ykUW4LVGaMcU9lu9thv85CbRMAwfeadCJHRsg2GmeRa/cJxsVY9Rbd57JcMxBkKHag5U/x7TSBpScF4U8ElVzg==}
@@ -260,24 +272,28 @@ packages:
     engines: {node: '>= 10'}
     cpu: [arm64]
     os: [linux]
+    libc: [glibc]
 
   '@next/swc-linux-arm64-musl@15.0.3':
     resolution: {integrity: sha512-WkAk6R60mwDjH4lG/JBpb2xHl2/0Vj0ZRu1TIzWuOYfQ9tt9NFsIinI1Epma77JVgy81F32X/AeD+B2cBu/YQA==}
     engines: {node: '>= 10'}
     cpu: [arm64]
     os: [linux]
+    libc: [musl]
 
   '@next/swc-linux-x64-gnu@15.0.3':
     resolution: {integrity: sha512-gWL/Cta1aPVqIGgDb6nxkqy06DkwJ9gAnKORdHWX1QBbSZZB+biFYPFti8aKIQL7otCE1pjyPaXpFzGeG2OS2w==}
     engines: {node: '>= 10'}
     cpu: [x64]
     os: [linux]
+    libc: [glibc]
 
   '@next/swc-linux-x64-musl@15.0.3':
     resolution: {integrity: sha512-QQEMwFd8r7C0GxQS62Zcdy6GKx999I/rTO2ubdXEe+MlZk9ZiinsrjwoiBL5/57tfyjikgh6GOU2WRQVUej3UA==}
     engines: {node: '>= 10'}
     cpu: [x64]
     os: [linux]
+    libc: [musl]
 
   '@next/swc-win32-arm64-msvc@15.0.3':
     resolution: {integrity: sha512-9TEp47AAd/ms9fPNgtgnT7F3M1Hf7koIYYWCMQ9neOwjbVWJsHZxrFbI3iEDJ8rf1TDGpmHbKxXf2IFpAvheIQ==}
@@ -386,24 +402,28 @@ packages:
     engines: {node: '>= 10'}
     cpu: [arm64]
     os: [linux]
+    libc: [glibc]
 
   '@tailwindcss/oxide-linux-arm64-musl@4.1.4':
     resolution: {integrity: sha512-X3As2xhtgPTY/m5edUtddmZ8rCruvBvtxYLMw9OsZdH01L2gS2icsHRwxdU0dMItNfVmrBezueXZCHxVeeb7Aw==}
     engines: {node: '>= 10'}
     cpu: [arm64]
     os: [linux]
+    libc: [musl]
 
   '@tailwindcss/oxide-linux-x64-gnu@4.1.4':
     resolution: {integrity: sha512-2VG4DqhGaDSmYIu6C4ua2vSLXnJsb/C9liej7TuSO04NK+JJJgJucDUgmX6sn7Gw3Cs5ZJ9ZLrnI0QRDOjLfNQ==}
     engines: {node: '>= 10'}
     cpu: [x64]
     os: [linux]
+    libc: [glibc]
 
   '@tailwindcss/oxide-linux-x64-musl@4.1.4':
     resolution: {integrity: sha512-v+mxVgH2kmur/X5Mdrz9m7TsoVjbdYQT0b4Z+dr+I4RvreCNXyCFELZL/DO0M1RsidZTrm6O1eMnV6zlgEzTMQ==}
     engines: {node: '>= 10'}
     cpu: [x64]
     os: [linux]
+    libc: [musl]
 
   '@tailwindcss/oxide-wasm32-wasi@4.1.4':
     resolution: {integrity: sha512-2TLe9ir+9esCf6Wm+lLWTMbgklIjiF0pbmDnwmhR9MksVOq+e8aP3TSsXySnBDDvTTVd/vKu1aNttEGj3P6l8Q==}
@@ -439,7 +459,7 @@ packages:
   '@trieb.work/nextjs-turbo-redis-cache@file:../../..':
     resolution: {directory: ../../.., type: directory}
     peerDependencies:
-      next: '>=15.0.3 <= 15.4.7'
+      next: '>=15.0.3 <16.3.0'
       redis: 4.7.0
 
   '@tybys/wasm-util@0.9.0':
@@ -541,36 +561,43 @@ packages:
     resolution: {integrity: sha512-FX2FV7vpLE/+Z0NZX9/1pwWud5Wocm/2PgpUXbT5aSV3QEB10kBPJAzssOQylvdj8mOHoKl5pVkXpbCwww/T2g==}
     cpu: [arm64]
     os: [linux]
+    libc: [glibc]
 
   '@unrs/resolver-binding-linux-arm64-musl@1.5.0':
     resolution: {integrity: sha512-+gF97xst1BZb28T3nwwzEtq2ewCoMDGKsenYsZuvpmNrW0019G1iUAunZN+FG55L21y+uP7zsGX06OXDQ/viKw==}
     cpu: [arm64]
     os: [linux]
+    libc: [musl]
 
   '@unrs/resolver-binding-linux-ppc64-gnu@1.5.0':
     resolution: {integrity: sha512-5bEmVcQw9js8JYM2LkUBw5SeELSIxX+qKf9bFrfFINKAp4noZ//hUxLpbF7u/3gTBN1GsER6xOzIZlw/VTdXtA==}
     cpu: [ppc64]
     os: [linux]
+    libc: [glibc]
 
   '@unrs/resolver-binding-linux-riscv64-gnu@1.5.0':
     resolution: {integrity: sha512-GGk/8TPUsf1Q99F+lzMdjE6sGL26uJCwQ9TlvBs8zR3cLQNw/MIumPN7zrs3GFGySjnwXc8gA6J3HKbejywmqA==}
     cpu: [riscv64]
     os: [linux]
+    libc: [glibc]
 
   '@unrs/resolver-binding-linux-s390x-gnu@1.5.0':
     resolution: {integrity: sha512-5uRkFYYVNAeVaA4W/CwugjFN3iDOHCPqsBLCCOoJiMfFMMz4evBRsg+498OFa9w6VcTn2bD5aI+RRayaIgk2Sw==}
     cpu: [s390x]
     os: [linux]
+    libc: [glibc]
 
   '@unrs/resolver-binding-linux-x64-gnu@1.5.0':
     resolution: {integrity: sha512-j905CZH3nehYy6NimNqC2B14pxn4Ltd7guKMyPTzKehbFXTUgihQS/ZfHQTdojkMzbSwBOSgq1dOrY+IpgxDsA==}
     cpu: [x64]
     os: [linux]
+    libc: [glibc]
 
   '@unrs/resolver-binding-linux-x64-musl@1.5.0':
     resolution: {integrity: sha512-dmLevQTuzQRwu5A+mvj54R5aye5I4PVKiWqGxg8tTaYP2k2oTs/3Mo8mgnhPk28VoYCi0fdFYpgzCd4AJndQvQ==}
     cpu: [x64]
     os: [linux]
+    libc: [musl]
 
   '@unrs/resolver-binding-wasm32-wasi@1.5.0':
     resolution: {integrity: sha512-LtJMhwu7avhoi+kKfAZOKN773RtzLBVVF90YJbB0wyMpUj9yQPeA+mteVUI9P70OG/opH47FeV5AWeaNWWgqJg==}
@@ -1284,24 +1311,28 @@ packages:
     engines: {node: '>= 12.0.0'}
     cpu: [arm64]
     os: [linux]
+    libc: [glibc]
 
   lightningcss-linux-arm64-musl@1.29.2:
     resolution: {integrity: sha512-Q64eM1bPlOOUgxFmoPUefqzY1yV3ctFPE6d/Vt7WzLW4rKTv7MyYNky+FWxRpLkNASTnKQUaiMJ87zNODIrrKQ==}
     engines: {node: '>= 12.0.0'}
     cpu: [arm64]
     os: [linux]
+    libc: [musl]
 
   lightningcss-linux-x64-gnu@1.29.2:
     resolution: {integrity: sha512-0v6idDCPG6epLXtBH/RPkHvYx74CVziHo6TMYga8O2EiQApnUPZsbR9nFNrg2cgBzk1AYqEd95TlrsL7nYABQg==}
     engines: {node: '>= 12.0.0'}
     cpu: [x64]
     os: [linux]
+    libc: [glibc]
 
   lightningcss-linux-x64-musl@1.29.2:
     resolution: {integrity: sha512-rMpz2yawkgGT8RULc5S4WiZopVMOFWjiItBT7aSfDX4NQav6M44rhn5hjtkKzB+wMTRlLLqxkeYEtQ3dd9696w==}
     engines: {node: '>= 12.0.0'}
     cpu: [x64]
     os: [linux]
+    libc: [musl]
 
   lightningcss-win32-arm64-msvc@1.29.2:
     resolution: {integrity: sha512-nL7zRW6evGQqYVu/bKGK+zShyz8OVzsCotFgc7judbt6wnB2KbiKKJwBE4SGoDBQ1O94RjW4asrCjQL4i8Fhbw==}