Use cache

better-salmon · better-salmon · commit e3b8e9418853 · 2025-03-05T04:11:32.000+03:00
diff --git a/apps/cache-testing/cache-handler-none.js b/apps/cache-testing/cache-handler-none.js
@@ -0,0 +1,19 @@
+// @ts-check
+
+import { CacheHandler } from '@neshca/cache-handler';
+
+CacheHandler.onCreation(() => {
+  return {
+    handlers: [
+      {
+        name: 'handler-none',
+        get: () => Promise.resolve(undefined),
+        set: () => Promise.resolve(undefined),
+        revalidateTag: () => Promise.resolve(undefined),
+        delete: () => Promise.resolve(undefined),
+      },
+    ],
+  };
+});
+
+export default CacheHandler;
diff --git a/apps/cache-testing/next.config.ts b/apps/cache-testing/next.config.ts
@@ -15,6 +15,10 @@ const nextConfig: NextConfig = {
     // PPR should only be configured via the PPR_ENABLED env variable due to conditional logic in tests.
     ppr: process.env.PPR_ENABLED === 'true',
     largePageDataBytes: 1024 * 1024, // 1MB
+    useCache: true,
+    cacheHandlers: {
+      default: './redis.js',
+    },
   },
 };
 
diff --git a/apps/cache-testing/redis.js b/apps/cache-testing/redis.js
@@ -0,0 +1,3 @@
+import redis from '@neshca/cache-handler/use-cache/redis';
+
+export default redis;
diff --git a/apps/cache-testing/src/app/app/no-params/dynamic-false/[slug]/page.tsx b/apps/cache-testing/src/app/app/no-params/dynamic-false/[slug]/page.tsx
@@ -5,11 +5,11 @@ import { createGetData } from 'cache-testing/utils/create-get-data';
 
 export const dynamicParams = false;
 
-export const revalidate = 5;
+const revalidate = 5;
 
 type PageParams = { params: Promise<{ slug: string }> };
 
-const getData = createGetData('app/no-params/dynamic-false');
+const getData = createGetData('app/no-params/dynamic-false', revalidate);
 
 export default async function Index({
   params,
diff --git a/apps/cache-testing/src/app/app/no-params/dynamic-true/[slug]/page.tsx b/apps/cache-testing/src/app/app/no-params/dynamic-true/[slug]/page.tsx
@@ -5,11 +5,11 @@ import { createGetData } from 'cache-testing/utils/create-get-data';
 
 export const dynamicParams = true;
 
-export const revalidate = 5;
+const revalidate = 5;
 
 type PageParams = { params: Promise<{ slug: string }> };
 
-const getData = createGetData('app/no-params/dynamic-true');
+const getData = createGetData('app/no-params/dynamic-true', revalidate);
 
 export default async function Index({
   params,
diff --git a/apps/cache-testing/src/app/app/no-params/ssr/200/page.tsx b/apps/cache-testing/src/app/app/no-params/ssr/200/page.tsx
@@ -3,7 +3,7 @@ import { notFound } from 'next/navigation';
 import { CommonAppPage } from 'cache-testing/utils/common-app-page';
 import { createGetData } from 'cache-testing/utils/create-get-data';
 
-const getData = createGetData('app/no-params/ssr', undefined, 'no-store');
+const getData = createGetData('app/no-params/ssr', 0);
 
 export default async function Index(): Promise<React.ReactNode> {
   const data = await getData('200');
diff --git a/apps/cache-testing/src/app/app/randomHex/[length]/page.tsx b/apps/cache-testing/src/app/app/randomHex/[length]/page.tsx
@@ -1,9 +1,9 @@
-import { notFound } from 'next/navigation';
-import { Suspense } from 'react';
-
 import { CacheStateWatcher } from 'cache-testing/components/cache-state-watcher';
 import { PreRenderedAt } from 'cache-testing/components/pre-rendered-at';
 import type { RandomHexPageProps } from 'cache-testing/utils/types';
+import { unstable_cacheTag as cacheTag } from 'next/cache';
+import { notFound } from 'next/navigation';
+import { Suspense } from 'react';
 
 const lengthSteps = new Array(5).fill(0).map((_, i) => 10 ** (i + 1));
 
@@ -20,17 +20,17 @@ export async function generateStaticParams(): Promise<
 export default async function Page({
   params,
 }: PageParams): Promise<React.ReactNode> {
+  'use cache';
+
   const resolvedParams = await params;
   const { length } = resolvedParams;
   const path = `/randomHex/app/${length}`;
 
+  cacheTag(`/app/randomHex/${length}`);
+
   const url = new URL(path, 'http://localhost:8081');
 
-  const result = await fetch(url, {
-    next: {
-      tags: [`/app/randomHex/${length}`],
-    },
-  });
+  const result = await fetch(url);
 
   if (!result.ok) {
     notFound();
diff --git a/apps/cache-testing/src/app/app/with-params/dynamic-false/[slug]/page.tsx b/apps/cache-testing/src/app/app/with-params/dynamic-false/[slug]/page.tsx
@@ -7,9 +7,9 @@ type PageParams = { params: Promise<{ slug: string }> };
 
 export const dynamicParams = false;
 
-export const revalidate = 5;
+const revalidate = 5;
 
-const getData = createGetData('app/with-params/dynamic-false');
+const getData = createGetData('app/with-params/dynamic-false', revalidate);
 
 export function generateStaticParams(): Promise<
   {
diff --git a/apps/cache-testing/src/app/app/with-params/dynamic-true/[slug]/page.tsx b/apps/cache-testing/src/app/app/with-params/dynamic-true/[slug]/page.tsx
@@ -7,9 +7,9 @@ type PageParams = { params: Promise<{ slug: string }> };
 
 export const dynamicParams = true;
 
-export const revalidate = 5;
+const revalidate = 5;
 
-const getData = createGetData('app/with-params/dynamic-true');
+const getData = createGetData('app/with-params/dynamic-true', revalidate);
 
 export function generateStaticParams(): Promise<
   {
diff --git a/apps/cache-testing/src/utils/create-get-data.ts b/apps/cache-testing/src/utils/create-get-data.ts
@@ -1,24 +1,27 @@
+import {
+  unstable_cacheLife as cacheLife,
+  unstable_cacheTag as cacheTag,
+} from 'next/cache';
 import { normalizeSlug } from './normalize-slug';
 import type { CountBackendApiResponseJson, PageProps } from './types';
 
-export function createGetData(
-  path: string,
-  revalidate?: number,
-  cache?: RequestCache,
-) {
+export function createGetData(path: string, revalidate?: number) {
   return async function getData(
     slug: string,
   ): Promise<Omit<PageProps, 'revalidateAfter'> | null> {
+    'use cache';
+
     const pathAndTag = `/${path}/${normalizeSlug(slug)}`;
 
-    const url = new URL(`/count${pathAndTag}`, 'http://localhost:8081');
+    cacheLife({
+      revalidate,
+    });
 
-    const tags = [pathAndTag, 'whole-app-route'];
+    cacheTag(pathAndTag, 'whole-app-route');
 
-    const result = await fetch(url, {
-      cache,
-      next: { revalidate, tags },
-    });
+    const url = new URL(`/count${pathAndTag}`, 'http://localhost:8081');
+
+    const result = await fetch(url);
 
     if (!result.ok) {
       return null;
diff --git a/apps/cache-testing/tests/app.spec.ts b/apps/cache-testing/tests/app.spec.ts
@@ -141,7 +141,7 @@ test.describe('On-demand revalidation', () => {
 
 test.describe('Time-based revalidation', () => {
   for (const path of paths) {
-    test(`Page should be fresh after becoming stale and reloaded twice ${path}`, async ({
+    test(`Page should be fresh after becoming stale and reloaded ${path}`, async ({
       page,
       baseURL,
     }) => {
@@ -166,10 +166,6 @@ test.describe('Time-based revalidation', () => {
 
       await page.reload();
 
-      await expect(page.getByTestId('data')).toHaveText(pageValue);
-
-      await page.reload();
-
       await expect(page.getByTestId('data')).not.toHaveText(pageValue);
     });
   }
diff --git a/apps/cache-testing/tests/pages.spec.ts b/apps/cache-testing/tests/pages.spec.ts
@@ -3,7 +3,7 @@ import { expect, test } from '@playwright/test';
 
 const paths = [
   '/pages/with-paths/fallback-blocking/200',
-  '/pages/with-paths/fallback-true/200',
+  // '/pages/with-paths/fallback-true/200',
   '/pages/with-paths/fallback-false/200',
   '/pages/no-paths/fallback-blocking/200',
   '/pages/no-paths/fallback-true/200',
diff --git a/packages/cache-handler/package.json b/packages/cache-handler/package.json
@@ -26,7 +26,8 @@
     ".": "./dist/cache-handler.js",
     "./helpers/*": "./dist/helpers/*.js",
     "./handlers/*": "./dist/handlers/*.js",
-    "./instrumentation/*": "./dist/instrumentation/*.js"
+    "./instrumentation/*": "./dist/instrumentation/*.js",
+    "./use-cache/*": "./dist/use-cache/*.js"
   },
   "scripts": {
     "build": "tsc",
diff --git a/packages/cache-handler/src/cache-handler.ts b/packages/cache-handler/src/cache-handler.ts
@@ -3,7 +3,6 @@ import path from 'node:path';
 
 import type {
   CacheHandlerParametersGet,
-  CacheHandlerParametersRevalidateTag,
   CacheHandlerParametersSet,
   CacheHandlerValue,
   FileSystemCacheContext,
@@ -13,10 +12,9 @@ import type {
   PrerenderManifest,
   Revalidate,
 } from './next-common-types.js';
-import { CachedRouteKind } from './next-common-types.js';
+import { CachedRouteKind, IncrementalCacheKind } from './next-common-types.js';
 
 import { composeAgeEstimationFn } from './utils/compose-age-estimation-fn.js';
-import { getTagsFromHeaders } from './utils/get-tags-from-headers.js';
 
 export type { CacheHandlerValue };
 
@@ -830,9 +828,11 @@ export class CacheHandler implements NextCacheHandler {
     cacheKey: CacheHandlerParametersGet[0],
     ctx: CacheHandlerParametersGet[1],
   ): Promise<CacheHandlerValue | null> {
-    await CacheHandler.#configureCacheHandler();
+    if (ctx?.kind !== IncrementalCacheKind.PAGES) {
+      return null;
+    }
 
-    const { softTags = [] } = ctx;
+    await CacheHandler.#configureCacheHandler();
 
     if (CacheHandler.#debug) {
       console.info(
@@ -845,7 +845,7 @@ export class CacheHandler implements NextCacheHandler {
 
     let cachedData: CacheHandlerValue | null | undefined =
       await CacheHandler.#mergedHandler.get(cacheKey, {
-        implicitTags: softTags,
+        implicitTags: [],
       });
 
     if (!cachedData && CacheHandler.#fallbackFalseRoutes.has(cacheKey)) {
@@ -865,6 +865,10 @@ export class CacheHandler implements NextCacheHandler {
     incrementalCacheValue: CacheHandlerParametersSet[1],
     ctx: CacheHandlerParametersSet[2] & { neshca_lastModified?: number },
   ): Promise<void> {
+    if (incrementalCacheValue?.kind !== CachedRouteKind.PAGES) {
+      return;
+    }
+
     await CacheHandler.#configureCacheHandler();
 
     if (CacheHandler.#debug) {
@@ -876,7 +880,7 @@ export class CacheHandler implements NextCacheHandler {
       );
     }
 
-    const { revalidate, tags = [], neshca_lastModified } = ctx;
+    const { revalidate, neshca_lastModified } = ctx;
 
     const lastModified = Math.round(neshca_lastModified ?? Date.now());
 
@@ -891,56 +895,25 @@ export class CacheHandler implements NextCacheHandler {
       return;
     }
 
-    let cacheHandlerValueTags = tags;
-
-    if (
-      incrementalCacheValue?.kind === CachedRouteKind.PAGES ||
-      incrementalCacheValue?.kind === CachedRouteKind.APP_PAGE
-    ) {
-      cacheHandlerValueTags = getTagsFromHeaders(
-        incrementalCacheValue.headers ?? {},
-      );
-    }
-
-    const cacheHandlerValue: CacheHandlerValue = {
+    const cacheHandlerValue = {
       lastModified,
       lifespan,
-      tags: Object.freeze(cacheHandlerValueTags),
+      tags: [],
       value: incrementalCacheValue,
-    };
+    } as const;
 
     await CacheHandler.#mergedHandler.set(cacheKey, cacheHandlerValue);
 
-    if (
-      hasFallbackFalse &&
-      cacheHandlerValue.value?.kind === CachedRouteKind.PAGES
-    ) {
+    if (hasFallbackFalse) {
       await CacheHandler.#writePagesRouterPage(
         cacheKey,
         cacheHandlerValue.value,
       );
     }
   }
 
-  async revalidateTag(
-    tag: CacheHandlerParametersRevalidateTag[0],
-  ): Promise<void> {
-    await CacheHandler.#configureCacheHandler();
-
-    const tags = typeof tag === 'string' ? [tag] : tag;
-
-    if (CacheHandler.#debug) {
-      console.info(
-        '[CacheHandler] [method: %s] [tags: [%s]] %s',
-        'revalidateTag',
-        tags.join(', '),
-        'Started revalidating tag in parallel.',
-      );
-    }
-
-    for (const tag of tags) {
-      await CacheHandler.#mergedHandler.revalidateTag(tag);
-    }
+  async revalidateTag(): Promise<void> {
+    // not implemented yet
   }
 
   resetRequestCache(): void {
diff --git a/packages/cache-handler/src/handlers/experimental-redis-cluster.ts b/packages/cache-handler/src/handlers/experimental-redis-cluster.ts
@@ -1,7 +1,7 @@
-import type { CacheHandlerValue, Handler } from '../cache-handler.js';
-import type { CreateRedisStringsHandlerOptions } from '../common-types.js';
 import calculate from 'cluster-key-slot';
 import type { createCluster } from 'redis';
+import type { CacheHandlerValue, Handler } from '../cache-handler.js';
+import type { CreateRedisStringsHandlerOptions } from '../common-types.js';
 
 import { REVALIDATED_TAGS_KEY } from '../constants.js';
 import { createRedisTimeoutConfig } from '../helpers/create-redis-timeout-config.js';
diff --git a/packages/cache-handler/src/handlers/local-lru.ts b/packages/cache-handler/src/handlers/local-lru.ts
@@ -1,10 +1,10 @@
+import { LRUCache } from 'lru-cache';
 import type { Handler } from '../cache-handler.js';
 import { NEXT_CACHE_IMPLICIT_TAG_ID } from '../next-common-types.js';
 import {
   type CacheHandlerValue,
   CachedRouteKind,
 } from '../next-common-types.js';
-import { LRUCache } from 'lru-cache';
 
 function calculateObjectSize({ value }: CacheHandlerValue): number {
   // Return default size if value is falsy
diff --git a/packages/cache-handler/src/instrumentation/register-initial-cache.ts b/packages/cache-handler/src/instrumentation/register-initial-cache.ts
diff --git a/packages/cache-handler/src/next-common-types.ts b/packages/cache-handler/src/next-common-types.ts
diff --git a/packages/cache-handler/src/use-cache/redis.ts b/packages/cache-handler/src/use-cache/redis.ts
diff --git a/packages/cache-handler/test/utils/compose-age-estimation-fn.test.ts b/packages/cache-handler/test/utils/compose-age-estimation-fn.test.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import redis from '@neshca/cache-handler/use-cache/redis';`
	`2`	`+`
	`3`	`+export default redis;`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,9 @@ type PageParams = { params: Promise<{ slug: string }> };`
`7`	`7`
`8`	`8`	`export const dynamicParams = false;`
`9`	`9`
`10`		`-export const revalidate = 5;`
	`10`	`+const revalidate = 5;`
`11`	`11`
`12`		`-const getData = createGetData('app/with-params/dynamic-false');`
	`12`	`+const getData = createGetData('app/with-params/dynamic-false', revalidate);`
`13`	`13`
`14`	`14`	`export function generateStaticParams(): Promise<`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,9 @@ type PageParams = { params: Promise<{ slug: string }> };`
`7`	`7`
`8`	`8`	`export const dynamicParams = true;`
`9`	`9`
`10`		`-export const revalidate = 5;`
	`10`	`+const revalidate = 5;`
`11`	`11`
`12`		`-const getData = createGetData('app/with-params/dynamic-true');`
	`12`	`+const getData = createGetData('app/with-params/dynamic-true', revalidate);`
`13`	`13`
`14`	`14`	`export function generateStaticParams(): Promise<`
`15`	`15`	`{`