@trieb.work/nextjs-turbo-redis-cache 1.12.0 → 1.13.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/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-16-0-3/postcss.config.mjs

@@ -1,7 +1,7 @@
-const config = {
-  plugins: {
-    "@tailwindcss/postcss": {},
-  },
-};
-
-export default config;
+const config = {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+};
+
+export default config;

package/test/integration/next-app-16-1-1/postcss.config.mjs

@@ -1,7 +1,7 @@
-const config = {
-  plugins: {
-    "@tailwindcss/postcss": {},
-  },
-};
-
-export default config;
+const config = {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+};
+
+export default config;

package/test/integration/next-app-16-1-1-cache-components/postcss.config.mjs

@@ -1,7 +1,7 @@
-const config = {
-  plugins: {
-    "@tailwindcss/postcss": {},
-  },
-};
-
-export default config;
+const config = {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+};
+
+export default config;