@websolutespa/bom-next 4.0.0-next.13 → 4.0.0-next.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -3
- package/README.md +132 -118
- package/dist/cache-handler/redis.js.map +1 -1
- package/dist/cache-handlers/default.js.map +1 -1
- package/dist/client/client.js +5 -5
- package/dist/client/client.js.map +1 -1
- package/dist/client/extra.js.map +1 -1
- package/dist/client/label.js.map +1 -1
- package/dist/client/layout.js.map +1 -1
- package/dist/client/local.collection.js.map +1 -1
- package/dist/client/metadata.js.map +1 -1
- package/dist/client/page.d.ts.map +1 -1
- package/dist/client/page.js.map +1 -1
- package/dist/client/useApi.js.map +1 -1
- package/dist/client/useCollectionApi.js.map +1 -1
- package/dist/client/useExtra.js.map +1 -1
- package/dist/client/useHttp.js.map +1 -1
- package/dist/client/useLabel.js.map +1 -1
- package/dist/client/useLayout.js.map +1 -1
- package/dist/client/useLink.js.map +1 -1
- package/dist/client/useMetaData.js.map +1 -1
- package/dist/client/usePage.d.ts.map +1 -1
- package/dist/client/usePage.js.map +1 -1
- package/dist/client/useUser.js.map +1 -1
- package/dist/client/user.js.map +1 -1
- package/dist/config/with-bom.js.map +1 -1
- package/dist/exports/proxy.d.ts +4 -3
- package/dist/exports/proxy.js +4 -3
- package/dist/exports/server.d.ts +2 -1
- package/dist/exports/server.js +2 -1
- package/dist/index.d.ts +7 -3
- package/dist/index.js +5 -1
- package/dist/instrumentation/client.js.map +1 -1
- package/dist/instrumentation/sentry/capture.requestError.js.map +1 -1
- package/dist/instrumentation/sentry/capture.routerTransitionStart.js.map +1 -1
- package/dist/instrumentation/sentry/config.client.js.map +1 -1
- package/dist/instrumentation/sentry/config.edge.js.map +1 -1
- package/dist/instrumentation/sentry/config.server.js.map +1 -1
- package/dist/instrumentation/server.js.map +1 -1
- package/dist/lib/breadcrumb.js.map +1 -1
- package/dist/lib/const.js.map +1 -1
- package/dist/lib/cors.d.ts +25 -0
- package/dist/lib/cors.d.ts.map +1 -0
- package/dist/lib/cors.js +42 -0
- package/dist/lib/cors.js.map +1 -0
- package/dist/lib/debug.js.map +1 -1
- package/dist/lib/http.js.map +1 -1
- package/dist/lib/label.js.map +1 -1
- package/dist/lib/layout.defaults.js.map +1 -1
- package/dist/lib/link.js.map +1 -1
- package/dist/lib/page-metadata.js.map +1 -1
- package/dist/lib/pagination.js.map +1 -1
- package/dist/lib/route.js.map +1 -1
- package/dist/lib/seed-env.d.ts +13 -0
- package/dist/lib/seed-env.d.ts.map +1 -0
- package/dist/lib/seed-env.js +18 -0
- package/dist/lib/seed-env.js.map +1 -0
- package/dist/lib/spam.d.ts +38 -0
- package/dist/lib/spam.d.ts.map +1 -0
- package/dist/lib/spam.js +43 -0
- package/dist/lib/spam.js.map +1 -0
- package/dist/lib/store.js.map +1 -1
- package/dist/lib/ttl-cache.js.map +1 -1
- package/dist/lib/user.d.ts +16 -0
- package/dist/lib/user.d.ts.map +1 -0
- package/dist/lib/user.js +21 -0
- package/dist/lib/user.js.map +1 -0
- package/dist/lib/utils.js.map +1 -1
- package/dist/proxy/api-cors.d.ts +24 -0
- package/dist/proxy/api-cors.d.ts.map +1 -0
- package/dist/proxy/api-cors.js +35 -0
- package/dist/proxy/api-cors.js.map +1 -0
- package/dist/proxy/protected-route.js.map +1 -1
- package/dist/proxy/proxy.js.map +1 -1
- package/dist/proxy/route-auto-detection.d.ts +3 -1
- package/dist/proxy/route-auto-detection.d.ts.map +1 -1
- package/dist/proxy/route-auto-detection.js +20 -4
- package/dist/proxy/route-auto-detection.js.map +1 -1
- package/dist/proxy/route-proxy.d.ts +2 -1
- package/dist/proxy/route-proxy.d.ts.map +1 -1
- package/dist/proxy/route-proxy.js +8 -4
- package/dist/proxy/route-proxy.js.map +1 -1
- package/dist/server/cache/cached-types.js.map +1 -1
- package/dist/server/cache/cached.js.map +1 -1
- package/dist/server/cache/defaults.js.map +1 -1
- package/dist/server/cache/executor.js.map +1 -1
- package/dist/server/cache/handler.js.map +1 -1
- package/dist/server/cache/inspector/filesystem.js.map +1 -1
- package/dist/server/cache/inspector/index.js.map +1 -1
- package/dist/server/cache/inspector/redis.js.map +1 -1
- package/dist/server/cache/inspector/route-cache-key.js.map +1 -1
- package/dist/server/cache/inspector/types.js.map +1 -1
- package/dist/server/cache/local-executor.js.map +1 -1
- package/dist/server/cache/mode/classic.js.map +1 -1
- package/dist/server/cache/mode/components.js.map +1 -1
- package/dist/server/cache/profiles.js.map +1 -1
- package/dist/server/cache/registry.js.map +1 -1
- package/dist/server/cache/tag-page.js.map +1 -1
- package/dist/server/context.js.map +1 -1
- package/dist/server/handlers/auth.handler.d.ts.map +1 -1
- package/dist/server/handlers/auth.handler.js +6 -4
- package/dist/server/handlers/auth.handler.js.map +1 -1
- package/dist/server/handlers/captions.handler.js.map +1 -1
- package/dist/server/handlers/collection.handler.js.map +1 -1
- package/dist/server/handlers/error-response.js.map +1 -1
- package/dist/server/handlers/index.handler.js.map +1 -1
- package/dist/server/handlers/preview.handler.js.map +1 -1
- package/dist/server/handlers/registry.handler.js.map +1 -1
- package/dist/server/handlers/revalidate.handler.js.map +1 -1
- package/dist/server/handlers/route.handler.js.map +1 -1
- package/dist/server/handlers/sitemap.handler.js.map +1 -1
- package/dist/server/handlers/static-params.handler.js.map +1 -1
- package/dist/server/handlers/vars.handler.js.map +1 -1
- package/dist/server/helpers.js.map +1 -1
- package/dist/server/json-ld.js.map +1 -1
- package/dist/server/layout.js.map +1 -1
- package/dist/server/lazy.js.map +1 -1
- package/dist/server/local-api.js.map +1 -1
- package/dist/server/metadata.js.map +1 -1
- package/dist/server/mixer.js.map +1 -1
- package/dist/server/page.js.map +1 -1
- package/dist/server/rate-limit.d.ts +37 -0
- package/dist/server/rate-limit.d.ts.map +1 -0
- package/dist/server/rate-limit.js +55 -0
- package/dist/server/rate-limit.js.map +1 -0
- package/dist/server/utils.js.map +1 -1
- package/dist/server/utmz.js.map +1 -1
- package/package.json +1 -1
- package/src/cache-handler/redis.test.ts +230 -230
- package/src/cache-handler/redis.ts +344 -344
- package/src/cache-handlers/default.test.ts +125 -125
- package/src/cache-handlers/default.ts +246 -246
- package/src/client/client.tsx +20 -20
- package/src/client/extra.tsx +17 -17
- package/src/client/label.tsx +20 -20
- package/src/client/layout.tsx +18 -18
- package/src/client/local.collection.ts +72 -72
- package/src/client/metadata.tsx +187 -187
- package/src/client/page.tsx +18 -18
- package/src/client/useApi.test.tsx +212 -212
- package/src/client/useApi.ts +115 -115
- package/src/client/useCollectionApi.test.tsx +213 -213
- package/src/client/useCollectionApi.ts +135 -135
- package/src/client/useExtra.tsx +12 -12
- package/src/client/useHttp.ts +78 -78
- package/src/client/useLabel.test.tsx +82 -82
- package/src/client/useLabel.tsx +12 -12
- package/src/client/useLayout.tsx +13 -13
- package/src/client/useLink.tsx +16 -16
- package/src/client/useMetaData.tsx +12 -12
- package/src/client/usePage.tsx +12 -12
- package/src/client/useUser.tsx +12 -12
- package/src/client/user.test.tsx +63 -63
- package/src/client/user.tsx +73 -73
- package/src/config/with-bom.test.ts +61 -61
- package/src/config/with-bom.ts +68 -68
- package/src/exports/cache-handlers-default.ts +3 -3
- package/src/exports/cache-handlers-isr.ts +9 -9
- package/src/exports/client.ts +19 -19
- package/src/exports/config.ts +3 -3
- package/src/exports/instrumentation.ts +1 -1
- package/src/exports/proxy.ts +1 -0
- package/src/exports/server.ts +1 -0
- package/src/global.d.ts +6 -6
- package/src/index.ts +4 -0
- package/src/instrumentation/client.ts +18 -18
- package/src/instrumentation/sentry/capture.requestError.ts +9 -9
- package/src/instrumentation/sentry/capture.routerTransitionStart.ts +7 -7
- package/src/instrumentation/sentry/config.client.ts +9 -9
- package/src/instrumentation/sentry/config.edge.ts +9 -9
- package/src/instrumentation/sentry/config.server.ts +9 -9
- package/src/instrumentation/server.ts +39 -39
- package/src/instrumentation/types.ts +11 -11
- package/src/lib/breadcrumb.ts +25 -25
- package/src/lib/const.ts +28 -28
- package/src/lib/cors.test.ts +29 -0
- package/src/lib/cors.ts +55 -0
- package/src/lib/debug.ts +11 -11
- package/src/lib/http.test.ts +25 -25
- package/src/lib/http.ts +127 -127
- package/src/lib/label.ts +47 -47
- package/src/lib/layout.defaults.ts +167 -167
- package/src/lib/link.ts +19 -19
- package/src/lib/meta-data.ts +60 -60
- package/src/lib/open-graph.ts +165 -165
- package/src/lib/page-metadata.test.ts +192 -192
- package/src/lib/page-metadata.ts +296 -296
- package/src/lib/pagination.ts +80 -80
- package/src/lib/route.test.ts +62 -62
- package/src/lib/route.ts +117 -117
- package/src/lib/seed-env.ts +17 -0
- package/src/lib/spam.test.ts +39 -0
- package/src/lib/spam.ts +59 -0
- package/src/lib/store.ts +63 -63
- package/src/lib/structured-data.ts +24 -24
- package/src/lib/ttl-cache.ts +72 -72
- package/src/lib/twitter-card.ts +49 -49
- package/src/lib/user.test.ts +21 -0
- package/src/lib/user.ts +25 -0
- package/src/lib/utils.ts +44 -44
- package/src/mock.ts +292 -292
- package/src/proxy/api-cors.test.ts +30 -0
- package/src/proxy/api-cors.ts +42 -0
- package/src/proxy/protected-route.test.ts +75 -75
- package/src/proxy/protected-route.ts +68 -68
- package/src/proxy/proxy.test.ts +51 -51
- package/src/proxy/proxy.ts +81 -81
- package/src/proxy/route-auto-detection.test.ts +98 -55
- package/src/proxy/route-auto-detection.ts +247 -222
- package/src/proxy/route-proxy.test.ts +140 -104
- package/src/proxy/route-proxy.ts +295 -291
- package/src/server/cache/cached-types.ts +73 -73
- package/src/server/cache/cached.test.ts +115 -115
- package/src/server/cache/cached.ts +22 -22
- package/src/server/cache/defaults.ts +46 -46
- package/src/server/cache/executor.test.ts +134 -134
- package/src/server/cache/executor.ts +141 -141
- package/src/server/cache/handler.test.ts +122 -122
- package/src/server/cache/handler.ts +126 -126
- package/src/server/cache/index.ts +39 -39
- package/src/server/cache/inspector/filesystem.test.ts +142 -142
- package/src/server/cache/inspector/filesystem.ts +214 -214
- package/src/server/cache/inspector/index.ts +19 -19
- package/src/server/cache/inspector/redis.test.ts +97 -97
- package/src/server/cache/inspector/redis.ts +183 -183
- package/src/server/cache/inspector/route-cache-key.test.ts +31 -31
- package/src/server/cache/inspector/route-cache-key.ts +40 -40
- package/src/server/cache/inspector/types.ts +49 -49
- package/src/server/cache/local-executor.ts +39 -39
- package/src/server/cache/mode/classic.ts +59 -59
- package/src/server/cache/mode/components.test.ts +53 -53
- package/src/server/cache/mode/components.ts +64 -64
- package/src/server/cache/profiles.ts +41 -41
- package/src/server/cache/registry.test.ts +66 -66
- package/src/server/cache/registry.ts +82 -82
- package/src/server/cache/route-parity.test.ts +33 -33
- package/src/server/cache/tag-page.ts +23 -23
- package/src/server/context.cache.test.ts +79 -79
- package/src/server/context.test.ts +645 -645
- package/src/server/context.ts +488 -488
- package/src/server/context.type-test.ts +112 -112
- package/src/server/handlers/auth.handler.ts +31 -32
- package/src/server/handlers/captions.handler.ts +36 -36
- package/src/server/handlers/collection.handler.test.ts +63 -63
- package/src/server/handlers/collection.handler.ts +221 -221
- package/src/server/handlers/error-response.ts +50 -50
- package/src/server/handlers/index.handler.ts +153 -153
- package/src/server/handlers/preview.handler.test.ts +92 -92
- package/src/server/handlers/preview.handler.ts +95 -95
- package/src/server/handlers/registry.handler.test.ts +171 -171
- package/src/server/handlers/registry.handler.ts +514 -514
- package/src/server/handlers/revalidate.handler.ts +148 -148
- package/src/server/handlers/route.handler.test.ts +50 -50
- package/src/server/handlers/route.handler.ts +188 -188
- package/src/server/handlers/sitemap.handler.ts +432 -432
- package/src/server/handlers/static-params.cache.test.ts +81 -81
- package/src/server/handlers/static-params.handler.ts +123 -123
- package/src/server/handlers/vars.handler.ts +174 -174
- package/src/server/helpers.ts +97 -97
- package/src/server/json-ld.tsx +65 -65
- package/src/server/layout.ts +148 -148
- package/src/server/lazy.ts +41 -41
- package/src/server/local-api.ts +67 -67
- package/src/server/metadata.ts +79 -79
- package/src/server/mixer-payload.ts +115 -115
- package/src/server/mixer-payload.type-test.ts +27 -27
- package/src/server/mixer.ts +513 -513
- package/src/server/page.ts +148 -148
- package/src/server/rate-limit.test.ts +90 -0
- package/src/server/rate-limit.ts +95 -0
- package/src/server/request-data.test.ts +34 -34
- package/src/server/utils.ts +23 -23
- package/src/server/utmz.ts +11 -11
- package/src/types.ts +363 -363
package/dist/server/utmz.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utmz.js","names":[],"sources":["../../src/server/utmz.ts"],"sourcesContent":["import { NextApiRequest } from 'next';\n\nexport function getUtmz(request: NextApiRequest): string {\n let utmz = 'N/A';\n if (typeof request.cookies.__utmz === 'string') {\n utmz = request.cookies.__utmz;\n const i = utmz.indexOf('utmcsr');\n utmz = utmz.substring(i === -1 ? 0 : i);\n }\n return utmz;\n}\n"],"mappings":";AAEA,SAAgB,QAAQ,SAAiC;CACvD,IAAI,OAAO;AACX,KAAI,OAAO,QAAQ,QAAQ,WAAW,UAAU;AAC9C,SAAO,QAAQ,QAAQ;EACvB,MAAM,IAAI,KAAK,QAAQ,SAAS;AAChC,SAAO,KAAK,UAAU,MAAM,KAAK,IAAI,EAAE;;AAEzC,QAAO"}
|
|
1
|
+
{"version":3,"file":"utmz.js","names":[],"sources":["../../src/server/utmz.ts"],"sourcesContent":["import { NextApiRequest } from 'next';\r\n\r\nexport function getUtmz(request: NextApiRequest): string {\r\n let utmz = 'N/A';\r\n if (typeof request.cookies.__utmz === 'string') {\r\n utmz = request.cookies.__utmz;\r\n const i = utmz.indexOf('utmcsr');\r\n utmz = utmz.substring(i === -1 ? 0 : i);\r\n }\r\n return utmz;\r\n}\r\n"],"mappings":";AAEA,SAAgB,QAAQ,SAAiC;CACvD,IAAI,OAAO;AACX,KAAI,OAAO,QAAQ,QAAQ,WAAW,UAAU;AAC9C,SAAO,QAAQ,QAAQ;EACvB,MAAM,IAAI,KAAK,QAAQ,SAAS;AAChC,SAAO,KAAK,UAAU,MAAM,KAAK,IAAI,EAAE;;AAEzC,QAAO"}
|
package/package.json
CHANGED
|
@@ -1,230 +1,230 @@
|
|
|
1
|
-
// @vitest-environment node
|
|
2
|
-
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
3
|
-
import {
|
|
4
|
-
connectRedisClient,
|
|
5
|
-
createRedisCacheHandler,
|
|
6
|
-
decode,
|
|
7
|
-
encode,
|
|
8
|
-
getRedisClient,
|
|
9
|
-
type RedisLike,
|
|
10
|
-
} from './redis';
|
|
11
|
-
|
|
12
|
-
/** An in-memory stand-in for the redis client subset the handler uses. */
|
|
13
|
-
function fakeRedis(): RedisLike & {
|
|
14
|
-
store: Map<string, string>;
|
|
15
|
-
ttl: Map<string, number | undefined>;
|
|
16
|
-
} {
|
|
17
|
-
const store = new Map<string, string>();
|
|
18
|
-
const ttl = new Map<string, number | undefined>();
|
|
19
|
-
return {
|
|
20
|
-
isReady: true,
|
|
21
|
-
store,
|
|
22
|
-
ttl,
|
|
23
|
-
get: async (key) => store.get(key) ?? null,
|
|
24
|
-
mGet: async (keys) => keys.map((key) => store.get(key) ?? null),
|
|
25
|
-
set: async (key, value, options) => {
|
|
26
|
-
store.set(key, value);
|
|
27
|
-
ttl.set(key, options?.EX);
|
|
28
|
-
},
|
|
29
|
-
mSet: async (entries) => {
|
|
30
|
-
for (const [key, value] of entries) store.set(key, value);
|
|
31
|
-
},
|
|
32
|
-
del: async (keys) => {
|
|
33
|
-
for (const key of Array.isArray(keys) ? keys : [keys]) store.delete(key);
|
|
34
|
-
},
|
|
35
|
-
};
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
const page = (tags: string) => ({
|
|
39
|
-
kind: 'APP_PAGE',
|
|
40
|
-
html: '<html></html>',
|
|
41
|
-
headers: { 'x-next-cache-tags': tags },
|
|
42
|
-
status: 200,
|
|
43
|
-
});
|
|
44
|
-
const pageCtx = { cacheControl: { revalidate: 3600, expire: 31536000 } };
|
|
45
|
-
|
|
46
|
-
let redis: ReturnType<typeof fakeRedis>;
|
|
47
|
-
let Handler: ReturnType<typeof createRedisCacheHandler>;
|
|
48
|
-
|
|
49
|
-
beforeEach(() => {
|
|
50
|
-
vi.useFakeTimers();
|
|
51
|
-
vi.setSystemTime(new Date('2026-10-30T10:00:00Z'));
|
|
52
|
-
redis = fakeRedis();
|
|
53
|
-
Handler = createRedisCacheHandler(async () => redis, 'bom:');
|
|
54
|
-
});
|
|
55
|
-
|
|
56
|
-
afterEach(() => {
|
|
57
|
-
vi.useRealTimers();
|
|
58
|
-
});
|
|
59
|
-
|
|
60
|
-
describe('redis cache handler', () => {
|
|
61
|
-
it('round-trips Buffers and Maps of an APP_PAGE entry', () => {
|
|
62
|
-
const entry = {
|
|
63
|
-
lastModified: 1,
|
|
64
|
-
tags: ['a'],
|
|
65
|
-
value: {
|
|
66
|
-
kind: 'APP_PAGE',
|
|
67
|
-
rscData: Buffer.from('rsc payload'),
|
|
68
|
-
segmentData: new Map([['/_tree', Buffer.from('tree')]]),
|
|
69
|
-
},
|
|
70
|
-
};
|
|
71
|
-
const decoded = decode<{ value: { rscData: Buffer; segmentData: Map<string, Buffer> } }>(
|
|
72
|
-
encode(entry)
|
|
73
|
-
);
|
|
74
|
-
expect(Buffer.isBuffer(decoded.value.rscData)).toBe(true);
|
|
75
|
-
expect(decoded.value.rscData.toString()).toBe('rsc payload');
|
|
76
|
-
expect(decoded.value.segmentData.get('/_tree')!.toString()).toBe('tree');
|
|
77
|
-
});
|
|
78
|
-
|
|
79
|
-
it('stores the entry with its tags first, a small meta key and the route expiry as TTL', async () => {
|
|
80
|
-
const handler = new Handler();
|
|
81
|
-
await handler.set('/ww/en/page/1', page('bom:all,bom:doc:page:1'), pageCtx);
|
|
82
|
-
const raw = redis.store.get('bom:next:/ww/en/page/1')!;
|
|
83
|
-
expect(raw.startsWith('{"lastModified":')).toBe(true);
|
|
84
|
-
expect(raw.indexOf('"tags":')).toBeLessThan(raw.indexOf('"value":'));
|
|
85
|
-
expect(JSON.parse(redis.store.get('bom:next-meta:/ww/en/page/1')!)).toMatchObject({
|
|
86
|
-
tags: ['bom:all', 'bom:doc:page:1'],
|
|
87
|
-
revalidate: 3600,
|
|
88
|
-
kind: 'APP_PAGE',
|
|
89
|
-
status: 200,
|
|
90
|
-
});
|
|
91
|
-
expect(redis.ttl.get('bom:next:/ww/en/page/1')).toBe(31536000);
|
|
92
|
-
expect(await handler.get('/ww/en/page/1', {})).toMatchObject({ lastModified: Date.now() });
|
|
93
|
-
});
|
|
94
|
-
|
|
95
|
-
it('misses after an immediate tag expiry (invalidate, revalidatePath)', async () => {
|
|
96
|
-
const handler = new Handler();
|
|
97
|
-
await handler.set('/p', page('bom:doc:page:1'), pageCtx);
|
|
98
|
-
vi.advanceTimersByTime(1000);
|
|
99
|
-
await handler.revalidateTag(['bom:doc:page:1']);
|
|
100
|
-
expect(await handler.get('/p', {})).toBeNull();
|
|
101
|
-
// soft tags (revalidatePath) work the same way
|
|
102
|
-
await handler.set('/q', page('bom:all'), pageCtx);
|
|
103
|
-
vi.advanceTimersByTime(1000);
|
|
104
|
-
await handler.revalidateTag('_N_T_/q');
|
|
105
|
-
expect(await handler.get('/q', { softTags: ['_N_T_/q'] })).toBeNull();
|
|
106
|
-
});
|
|
107
|
-
|
|
108
|
-
it('serves a stale-tagged entry as past its revalidate time (stale-while-revalidate)', async () => {
|
|
109
|
-
const handler = new Handler();
|
|
110
|
-
await handler.set('/p', page('bom:coll:menu'), pageCtx);
|
|
111
|
-
vi.advanceTimersByTime(1000);
|
|
112
|
-
await handler.revalidateTag('bom:coll:menu', { expire: 31536000 });
|
|
113
|
-
const hit = await handler.get('/p', {});
|
|
114
|
-
expect(hit).not.toBeNull();
|
|
115
|
-
expect(Date.now() - hit!.lastModified).toBeGreaterThan(3600 * 1000);
|
|
116
|
-
// a regeneration after the stale mark is fresh again
|
|
117
|
-
vi.advanceTimersByTime(1000);
|
|
118
|
-
await handler.set('/p', page('bom:coll:menu'), pageCtx);
|
|
119
|
-
expect((await handler.get('/p', {}))!.lastModified).toBe(Date.now());
|
|
120
|
-
});
|
|
121
|
-
|
|
122
|
-
it('expires a stale tag once its expire window has passed', async () => {
|
|
123
|
-
const handler = new Handler();
|
|
124
|
-
await handler.set('/p', page('bom:coll:menu'), pageCtx);
|
|
125
|
-
vi.advanceTimersByTime(1000);
|
|
126
|
-
await handler.revalidateTag('bom:coll:menu', { expire: 60 });
|
|
127
|
-
expect(await handler.get('/p', {})).not.toBeNull();
|
|
128
|
-
vi.advanceTimersByTime(61_000);
|
|
129
|
-
expect(await handler.get('/p', {})).toBeNull();
|
|
130
|
-
});
|
|
131
|
-
|
|
132
|
-
it('ignores invalidations older than the entry', async () => {
|
|
133
|
-
const handler = new Handler();
|
|
134
|
-
await handler.revalidateTag('bom:all');
|
|
135
|
-
vi.advanceTimersByTime(1000);
|
|
136
|
-
await handler.set('/p', page('bom:all'), pageCtx);
|
|
137
|
-
expect(await handler.get('/p', {})).not.toBeNull();
|
|
138
|
-
});
|
|
139
|
-
|
|
140
|
-
it('treats an entry without a time-based revalidate as a miss when stale', async () => {
|
|
141
|
-
const handler = new Handler();
|
|
142
|
-
await handler.set('/p', page('bom:all'), { cacheControl: { revalidate: false } });
|
|
143
|
-
vi.advanceTimersByTime(1000);
|
|
144
|
-
await handler.revalidateTag('bom:all', {});
|
|
145
|
-
expect(await handler.get('/p', {})).toBeNull();
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
it('returns the stored lifetime, so another instance applies it instead of revalidating after 1 s', async () => {
|
|
149
|
-
const handler = new Handler();
|
|
150
|
-
await handler.set('/p', page('bom:all'), pageCtx);
|
|
151
|
-
expect(await handler.get('/p', {})).toMatchObject({
|
|
152
|
-
cacheControl: { revalidate: 3600, expire: 31536000 },
|
|
153
|
-
});
|
|
154
|
-
// the stale path keeps the lifetime: Next.js computes the stale time from it
|
|
155
|
-
vi.advanceTimersByTime(1000);
|
|
156
|
-
await handler.revalidateTag('bom:all', { expire: 31536000 });
|
|
157
|
-
const stale = await handler.get('/p', {});
|
|
158
|
-
expect(stale!.cacheControl).toEqual({ revalidate: 3600, expire: 31536000 });
|
|
159
|
-
expect(stale!.lastModified + 3600 * 1000).toBeLessThan(Date.now());
|
|
160
|
-
});
|
|
161
|
-
|
|
162
|
-
it('derives the lifetime of an entry written before cacheControl was stored', async () => {
|
|
163
|
-
const legacy = { lastModified: Date.now(), tags: [], revalidate: 900, value: page('') };
|
|
164
|
-
redis.store.set('bom:next:/old', encode(legacy));
|
|
165
|
-
expect((await new Handler().get('/old', {}))!.cacheControl).toEqual({
|
|
166
|
-
revalidate: 900,
|
|
167
|
-
expire: undefined,
|
|
168
|
-
});
|
|
169
|
-
redis.store.set('bom:next:/none', encode({ ...legacy, revalidate: null }));
|
|
170
|
-
expect((await new Handler().get('/none', {}))!.cacheControl).toBeUndefined();
|
|
171
|
-
});
|
|
172
|
-
|
|
173
|
-
it('deletes on null and never throws while Redis is not ready', async () => {
|
|
174
|
-
const handler = new Handler();
|
|
175
|
-
await handler.set('/p', page('bom:all'), pageCtx);
|
|
176
|
-
await handler.set('/p', null, pageCtx);
|
|
177
|
-
expect(redis.store.has('bom:next:/p')).toBe(false);
|
|
178
|
-
expect(redis.store.has('bom:next-meta:/p')).toBe(false);
|
|
179
|
-
const Offline = createRedisCacheHandler(async () => undefined, 'bom:');
|
|
180
|
-
const offline = new Offline();
|
|
181
|
-
expect(await offline.get('/p', {})).toBeNull();
|
|
182
|
-
await expect(offline.set('/p', page(''), pageCtx)).resolves.toBeUndefined();
|
|
183
|
-
await expect(offline.revalidateTag('x')).resolves.toBeUndefined();
|
|
184
|
-
});
|
|
185
|
-
});
|
|
186
|
-
|
|
187
|
-
describe('shared redis client', () => {
|
|
188
|
-
afterEach(() => {
|
|
189
|
-
delete process.env.REDIS_URL;
|
|
190
|
-
delete (globalThis as { __bomRedisClient?: unknown }).__bomRedisClient;
|
|
191
|
-
});
|
|
192
|
-
|
|
193
|
-
it('is undefined without REDIS_URL', async () => {
|
|
194
|
-
expect(await getRedisClient()).toBeUndefined();
|
|
195
|
-
expect(await connectRedisClient(10)).toBeUndefined();
|
|
196
|
-
});
|
|
197
|
-
|
|
198
|
-
it('is one client per process, shared through globalThis, and waits for it to be ready', async () => {
|
|
199
|
-
const listeners = new Map<string, () => void>();
|
|
200
|
-
const client = {
|
|
201
|
-
isReady: false,
|
|
202
|
-
on: () => client,
|
|
203
|
-
once: (event: string, listener: () => void) => listeners.set(event, listener),
|
|
204
|
-
off: (event: string) => listeners.delete(event),
|
|
205
|
-
};
|
|
206
|
-
(globalThis as { __bomRedisClient?: unknown }).__bomRedisClient = client;
|
|
207
|
-
process.env.REDIS_URL = 'redis://localhost:6379';
|
|
208
|
-
expect(await getRedisClient()).toBeUndefined();
|
|
209
|
-
const connecting = connectRedisClient(2000);
|
|
210
|
-
await vi.advanceTimersByTimeAsync(10);
|
|
211
|
-
client.isReady = true;
|
|
212
|
-
listeners.get('ready')!();
|
|
213
|
-
expect(await connecting).toBe(client);
|
|
214
|
-
});
|
|
215
|
-
|
|
216
|
-
it('gives up after the timeout and leaves no listener behind', async () => {
|
|
217
|
-
const listeners = new Map<string, () => void>();
|
|
218
|
-
const client = {
|
|
219
|
-
isReady: false,
|
|
220
|
-
once: (event: string, listener: () => void) => listeners.set(event, listener),
|
|
221
|
-
off: (event: string) => listeners.delete(event),
|
|
222
|
-
};
|
|
223
|
-
(globalThis as { __bomRedisClient?: unknown }).__bomRedisClient = client;
|
|
224
|
-
process.env.REDIS_URL = 'redis://localhost:6379';
|
|
225
|
-
const connecting = connectRedisClient(2000);
|
|
226
|
-
await vi.advanceTimersByTimeAsync(2001);
|
|
227
|
-
expect(await connecting).toBeUndefined();
|
|
228
|
-
expect(listeners.size).toBe(0);
|
|
229
|
-
});
|
|
230
|
-
});
|
|
1
|
+
// @vitest-environment node
|
|
2
|
+
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
3
|
+
import {
|
|
4
|
+
connectRedisClient,
|
|
5
|
+
createRedisCacheHandler,
|
|
6
|
+
decode,
|
|
7
|
+
encode,
|
|
8
|
+
getRedisClient,
|
|
9
|
+
type RedisLike,
|
|
10
|
+
} from './redis';
|
|
11
|
+
|
|
12
|
+
/** An in-memory stand-in for the redis client subset the handler uses. */
|
|
13
|
+
function fakeRedis(): RedisLike & {
|
|
14
|
+
store: Map<string, string>;
|
|
15
|
+
ttl: Map<string, number | undefined>;
|
|
16
|
+
} {
|
|
17
|
+
const store = new Map<string, string>();
|
|
18
|
+
const ttl = new Map<string, number | undefined>();
|
|
19
|
+
return {
|
|
20
|
+
isReady: true,
|
|
21
|
+
store,
|
|
22
|
+
ttl,
|
|
23
|
+
get: async (key) => store.get(key) ?? null,
|
|
24
|
+
mGet: async (keys) => keys.map((key) => store.get(key) ?? null),
|
|
25
|
+
set: async (key, value, options) => {
|
|
26
|
+
store.set(key, value);
|
|
27
|
+
ttl.set(key, options?.EX);
|
|
28
|
+
},
|
|
29
|
+
mSet: async (entries) => {
|
|
30
|
+
for (const [key, value] of entries) store.set(key, value);
|
|
31
|
+
},
|
|
32
|
+
del: async (keys) => {
|
|
33
|
+
for (const key of Array.isArray(keys) ? keys : [keys]) store.delete(key);
|
|
34
|
+
},
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
const page = (tags: string) => ({
|
|
39
|
+
kind: 'APP_PAGE',
|
|
40
|
+
html: '<html></html>',
|
|
41
|
+
headers: { 'x-next-cache-tags': tags },
|
|
42
|
+
status: 200,
|
|
43
|
+
});
|
|
44
|
+
const pageCtx = { cacheControl: { revalidate: 3600, expire: 31536000 } };
|
|
45
|
+
|
|
46
|
+
let redis: ReturnType<typeof fakeRedis>;
|
|
47
|
+
let Handler: ReturnType<typeof createRedisCacheHandler>;
|
|
48
|
+
|
|
49
|
+
beforeEach(() => {
|
|
50
|
+
vi.useFakeTimers();
|
|
51
|
+
vi.setSystemTime(new Date('2026-10-30T10:00:00Z'));
|
|
52
|
+
redis = fakeRedis();
|
|
53
|
+
Handler = createRedisCacheHandler(async () => redis, 'bom:');
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
afterEach(() => {
|
|
57
|
+
vi.useRealTimers();
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
describe('redis cache handler', () => {
|
|
61
|
+
it('round-trips Buffers and Maps of an APP_PAGE entry', () => {
|
|
62
|
+
const entry = {
|
|
63
|
+
lastModified: 1,
|
|
64
|
+
tags: ['a'],
|
|
65
|
+
value: {
|
|
66
|
+
kind: 'APP_PAGE',
|
|
67
|
+
rscData: Buffer.from('rsc payload'),
|
|
68
|
+
segmentData: new Map([['/_tree', Buffer.from('tree')]]),
|
|
69
|
+
},
|
|
70
|
+
};
|
|
71
|
+
const decoded = decode<{ value: { rscData: Buffer; segmentData: Map<string, Buffer> } }>(
|
|
72
|
+
encode(entry)
|
|
73
|
+
);
|
|
74
|
+
expect(Buffer.isBuffer(decoded.value.rscData)).toBe(true);
|
|
75
|
+
expect(decoded.value.rscData.toString()).toBe('rsc payload');
|
|
76
|
+
expect(decoded.value.segmentData.get('/_tree')!.toString()).toBe('tree');
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
it('stores the entry with its tags first, a small meta key and the route expiry as TTL', async () => {
|
|
80
|
+
const handler = new Handler();
|
|
81
|
+
await handler.set('/ww/en/page/1', page('bom:all,bom:doc:page:1'), pageCtx);
|
|
82
|
+
const raw = redis.store.get('bom:next:/ww/en/page/1')!;
|
|
83
|
+
expect(raw.startsWith('{"lastModified":')).toBe(true);
|
|
84
|
+
expect(raw.indexOf('"tags":')).toBeLessThan(raw.indexOf('"value":'));
|
|
85
|
+
expect(JSON.parse(redis.store.get('bom:next-meta:/ww/en/page/1')!)).toMatchObject({
|
|
86
|
+
tags: ['bom:all', 'bom:doc:page:1'],
|
|
87
|
+
revalidate: 3600,
|
|
88
|
+
kind: 'APP_PAGE',
|
|
89
|
+
status: 200,
|
|
90
|
+
});
|
|
91
|
+
expect(redis.ttl.get('bom:next:/ww/en/page/1')).toBe(31536000);
|
|
92
|
+
expect(await handler.get('/ww/en/page/1', {})).toMatchObject({ lastModified: Date.now() });
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
it('misses after an immediate tag expiry (invalidate, revalidatePath)', async () => {
|
|
96
|
+
const handler = new Handler();
|
|
97
|
+
await handler.set('/p', page('bom:doc:page:1'), pageCtx);
|
|
98
|
+
vi.advanceTimersByTime(1000);
|
|
99
|
+
await handler.revalidateTag(['bom:doc:page:1']);
|
|
100
|
+
expect(await handler.get('/p', {})).toBeNull();
|
|
101
|
+
// soft tags (revalidatePath) work the same way
|
|
102
|
+
await handler.set('/q', page('bom:all'), pageCtx);
|
|
103
|
+
vi.advanceTimersByTime(1000);
|
|
104
|
+
await handler.revalidateTag('_N_T_/q');
|
|
105
|
+
expect(await handler.get('/q', { softTags: ['_N_T_/q'] })).toBeNull();
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
it('serves a stale-tagged entry as past its revalidate time (stale-while-revalidate)', async () => {
|
|
109
|
+
const handler = new Handler();
|
|
110
|
+
await handler.set('/p', page('bom:coll:menu'), pageCtx);
|
|
111
|
+
vi.advanceTimersByTime(1000);
|
|
112
|
+
await handler.revalidateTag('bom:coll:menu', { expire: 31536000 });
|
|
113
|
+
const hit = await handler.get('/p', {});
|
|
114
|
+
expect(hit).not.toBeNull();
|
|
115
|
+
expect(Date.now() - hit!.lastModified).toBeGreaterThan(3600 * 1000);
|
|
116
|
+
// a regeneration after the stale mark is fresh again
|
|
117
|
+
vi.advanceTimersByTime(1000);
|
|
118
|
+
await handler.set('/p', page('bom:coll:menu'), pageCtx);
|
|
119
|
+
expect((await handler.get('/p', {}))!.lastModified).toBe(Date.now());
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
it('expires a stale tag once its expire window has passed', async () => {
|
|
123
|
+
const handler = new Handler();
|
|
124
|
+
await handler.set('/p', page('bom:coll:menu'), pageCtx);
|
|
125
|
+
vi.advanceTimersByTime(1000);
|
|
126
|
+
await handler.revalidateTag('bom:coll:menu', { expire: 60 });
|
|
127
|
+
expect(await handler.get('/p', {})).not.toBeNull();
|
|
128
|
+
vi.advanceTimersByTime(61_000);
|
|
129
|
+
expect(await handler.get('/p', {})).toBeNull();
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
it('ignores invalidations older than the entry', async () => {
|
|
133
|
+
const handler = new Handler();
|
|
134
|
+
await handler.revalidateTag('bom:all');
|
|
135
|
+
vi.advanceTimersByTime(1000);
|
|
136
|
+
await handler.set('/p', page('bom:all'), pageCtx);
|
|
137
|
+
expect(await handler.get('/p', {})).not.toBeNull();
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
it('treats an entry without a time-based revalidate as a miss when stale', async () => {
|
|
141
|
+
const handler = new Handler();
|
|
142
|
+
await handler.set('/p', page('bom:all'), { cacheControl: { revalidate: false } });
|
|
143
|
+
vi.advanceTimersByTime(1000);
|
|
144
|
+
await handler.revalidateTag('bom:all', {});
|
|
145
|
+
expect(await handler.get('/p', {})).toBeNull();
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
it('returns the stored lifetime, so another instance applies it instead of revalidating after 1 s', async () => {
|
|
149
|
+
const handler = new Handler();
|
|
150
|
+
await handler.set('/p', page('bom:all'), pageCtx);
|
|
151
|
+
expect(await handler.get('/p', {})).toMatchObject({
|
|
152
|
+
cacheControl: { revalidate: 3600, expire: 31536000 },
|
|
153
|
+
});
|
|
154
|
+
// the stale path keeps the lifetime: Next.js computes the stale time from it
|
|
155
|
+
vi.advanceTimersByTime(1000);
|
|
156
|
+
await handler.revalidateTag('bom:all', { expire: 31536000 });
|
|
157
|
+
const stale = await handler.get('/p', {});
|
|
158
|
+
expect(stale!.cacheControl).toEqual({ revalidate: 3600, expire: 31536000 });
|
|
159
|
+
expect(stale!.lastModified + 3600 * 1000).toBeLessThan(Date.now());
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
it('derives the lifetime of an entry written before cacheControl was stored', async () => {
|
|
163
|
+
const legacy = { lastModified: Date.now(), tags: [], revalidate: 900, value: page('') };
|
|
164
|
+
redis.store.set('bom:next:/old', encode(legacy));
|
|
165
|
+
expect((await new Handler().get('/old', {}))!.cacheControl).toEqual({
|
|
166
|
+
revalidate: 900,
|
|
167
|
+
expire: undefined,
|
|
168
|
+
});
|
|
169
|
+
redis.store.set('bom:next:/none', encode({ ...legacy, revalidate: null }));
|
|
170
|
+
expect((await new Handler().get('/none', {}))!.cacheControl).toBeUndefined();
|
|
171
|
+
});
|
|
172
|
+
|
|
173
|
+
it('deletes on null and never throws while Redis is not ready', async () => {
|
|
174
|
+
const handler = new Handler();
|
|
175
|
+
await handler.set('/p', page('bom:all'), pageCtx);
|
|
176
|
+
await handler.set('/p', null, pageCtx);
|
|
177
|
+
expect(redis.store.has('bom:next:/p')).toBe(false);
|
|
178
|
+
expect(redis.store.has('bom:next-meta:/p')).toBe(false);
|
|
179
|
+
const Offline = createRedisCacheHandler(async () => undefined, 'bom:');
|
|
180
|
+
const offline = new Offline();
|
|
181
|
+
expect(await offline.get('/p', {})).toBeNull();
|
|
182
|
+
await expect(offline.set('/p', page(''), pageCtx)).resolves.toBeUndefined();
|
|
183
|
+
await expect(offline.revalidateTag('x')).resolves.toBeUndefined();
|
|
184
|
+
});
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
describe('shared redis client', () => {
|
|
188
|
+
afterEach(() => {
|
|
189
|
+
delete process.env.REDIS_URL;
|
|
190
|
+
delete (globalThis as { __bomRedisClient?: unknown }).__bomRedisClient;
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
it('is undefined without REDIS_URL', async () => {
|
|
194
|
+
expect(await getRedisClient()).toBeUndefined();
|
|
195
|
+
expect(await connectRedisClient(10)).toBeUndefined();
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
it('is one client per process, shared through globalThis, and waits for it to be ready', async () => {
|
|
199
|
+
const listeners = new Map<string, () => void>();
|
|
200
|
+
const client = {
|
|
201
|
+
isReady: false,
|
|
202
|
+
on: () => client,
|
|
203
|
+
once: (event: string, listener: () => void) => listeners.set(event, listener),
|
|
204
|
+
off: (event: string) => listeners.delete(event),
|
|
205
|
+
};
|
|
206
|
+
(globalThis as { __bomRedisClient?: unknown }).__bomRedisClient = client;
|
|
207
|
+
process.env.REDIS_URL = 'redis://localhost:6379';
|
|
208
|
+
expect(await getRedisClient()).toBeUndefined();
|
|
209
|
+
const connecting = connectRedisClient(2000);
|
|
210
|
+
await vi.advanceTimersByTimeAsync(10);
|
|
211
|
+
client.isReady = true;
|
|
212
|
+
listeners.get('ready')!();
|
|
213
|
+
expect(await connecting).toBe(client);
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
it('gives up after the timeout and leaves no listener behind', async () => {
|
|
217
|
+
const listeners = new Map<string, () => void>();
|
|
218
|
+
const client = {
|
|
219
|
+
isReady: false,
|
|
220
|
+
once: (event: string, listener: () => void) => listeners.set(event, listener),
|
|
221
|
+
off: (event: string) => listeners.delete(event),
|
|
222
|
+
};
|
|
223
|
+
(globalThis as { __bomRedisClient?: unknown }).__bomRedisClient = client;
|
|
224
|
+
process.env.REDIS_URL = 'redis://localhost:6379';
|
|
225
|
+
const connecting = connectRedisClient(2000);
|
|
226
|
+
await vi.advanceTimersByTimeAsync(2001);
|
|
227
|
+
expect(await connecting).toBeUndefined();
|
|
228
|
+
expect(listeners.size).toBe(0);
|
|
229
|
+
});
|
|
230
|
+
});
|