@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.
Files changed (274) hide show
  1. package/CHANGELOG.md +17 -3
  2. package/README.md +132 -118
  3. package/dist/cache-handler/redis.js.map +1 -1
  4. package/dist/cache-handlers/default.js.map +1 -1
  5. package/dist/client/client.js +5 -5
  6. package/dist/client/client.js.map +1 -1
  7. package/dist/client/extra.js.map +1 -1
  8. package/dist/client/label.js.map +1 -1
  9. package/dist/client/layout.js.map +1 -1
  10. package/dist/client/local.collection.js.map +1 -1
  11. package/dist/client/metadata.js.map +1 -1
  12. package/dist/client/page.d.ts.map +1 -1
  13. package/dist/client/page.js.map +1 -1
  14. package/dist/client/useApi.js.map +1 -1
  15. package/dist/client/useCollectionApi.js.map +1 -1
  16. package/dist/client/useExtra.js.map +1 -1
  17. package/dist/client/useHttp.js.map +1 -1
  18. package/dist/client/useLabel.js.map +1 -1
  19. package/dist/client/useLayout.js.map +1 -1
  20. package/dist/client/useLink.js.map +1 -1
  21. package/dist/client/useMetaData.js.map +1 -1
  22. package/dist/client/usePage.d.ts.map +1 -1
  23. package/dist/client/usePage.js.map +1 -1
  24. package/dist/client/useUser.js.map +1 -1
  25. package/dist/client/user.js.map +1 -1
  26. package/dist/config/with-bom.js.map +1 -1
  27. package/dist/exports/proxy.d.ts +4 -3
  28. package/dist/exports/proxy.js +4 -3
  29. package/dist/exports/server.d.ts +2 -1
  30. package/dist/exports/server.js +2 -1
  31. package/dist/index.d.ts +7 -3
  32. package/dist/index.js +5 -1
  33. package/dist/instrumentation/client.js.map +1 -1
  34. package/dist/instrumentation/sentry/capture.requestError.js.map +1 -1
  35. package/dist/instrumentation/sentry/capture.routerTransitionStart.js.map +1 -1
  36. package/dist/instrumentation/sentry/config.client.js.map +1 -1
  37. package/dist/instrumentation/sentry/config.edge.js.map +1 -1
  38. package/dist/instrumentation/sentry/config.server.js.map +1 -1
  39. package/dist/instrumentation/server.js.map +1 -1
  40. package/dist/lib/breadcrumb.js.map +1 -1
  41. package/dist/lib/const.js.map +1 -1
  42. package/dist/lib/cors.d.ts +25 -0
  43. package/dist/lib/cors.d.ts.map +1 -0
  44. package/dist/lib/cors.js +42 -0
  45. package/dist/lib/cors.js.map +1 -0
  46. package/dist/lib/debug.js.map +1 -1
  47. package/dist/lib/http.js.map +1 -1
  48. package/dist/lib/label.js.map +1 -1
  49. package/dist/lib/layout.defaults.js.map +1 -1
  50. package/dist/lib/link.js.map +1 -1
  51. package/dist/lib/page-metadata.js.map +1 -1
  52. package/dist/lib/pagination.js.map +1 -1
  53. package/dist/lib/route.js.map +1 -1
  54. package/dist/lib/seed-env.d.ts +13 -0
  55. package/dist/lib/seed-env.d.ts.map +1 -0
  56. package/dist/lib/seed-env.js +18 -0
  57. package/dist/lib/seed-env.js.map +1 -0
  58. package/dist/lib/spam.d.ts +38 -0
  59. package/dist/lib/spam.d.ts.map +1 -0
  60. package/dist/lib/spam.js +43 -0
  61. package/dist/lib/spam.js.map +1 -0
  62. package/dist/lib/store.js.map +1 -1
  63. package/dist/lib/ttl-cache.js.map +1 -1
  64. package/dist/lib/user.d.ts +16 -0
  65. package/dist/lib/user.d.ts.map +1 -0
  66. package/dist/lib/user.js +21 -0
  67. package/dist/lib/user.js.map +1 -0
  68. package/dist/lib/utils.js.map +1 -1
  69. package/dist/proxy/api-cors.d.ts +24 -0
  70. package/dist/proxy/api-cors.d.ts.map +1 -0
  71. package/dist/proxy/api-cors.js +35 -0
  72. package/dist/proxy/api-cors.js.map +1 -0
  73. package/dist/proxy/protected-route.js.map +1 -1
  74. package/dist/proxy/proxy.js.map +1 -1
  75. package/dist/proxy/route-auto-detection.d.ts +3 -1
  76. package/dist/proxy/route-auto-detection.d.ts.map +1 -1
  77. package/dist/proxy/route-auto-detection.js +20 -4
  78. package/dist/proxy/route-auto-detection.js.map +1 -1
  79. package/dist/proxy/route-proxy.d.ts +2 -1
  80. package/dist/proxy/route-proxy.d.ts.map +1 -1
  81. package/dist/proxy/route-proxy.js +8 -4
  82. package/dist/proxy/route-proxy.js.map +1 -1
  83. package/dist/server/cache/cached-types.js.map +1 -1
  84. package/dist/server/cache/cached.js.map +1 -1
  85. package/dist/server/cache/defaults.js.map +1 -1
  86. package/dist/server/cache/executor.js.map +1 -1
  87. package/dist/server/cache/handler.js.map +1 -1
  88. package/dist/server/cache/inspector/filesystem.js.map +1 -1
  89. package/dist/server/cache/inspector/index.js.map +1 -1
  90. package/dist/server/cache/inspector/redis.js.map +1 -1
  91. package/dist/server/cache/inspector/route-cache-key.js.map +1 -1
  92. package/dist/server/cache/inspector/types.js.map +1 -1
  93. package/dist/server/cache/local-executor.js.map +1 -1
  94. package/dist/server/cache/mode/classic.js.map +1 -1
  95. package/dist/server/cache/mode/components.js.map +1 -1
  96. package/dist/server/cache/profiles.js.map +1 -1
  97. package/dist/server/cache/registry.js.map +1 -1
  98. package/dist/server/cache/tag-page.js.map +1 -1
  99. package/dist/server/context.js.map +1 -1
  100. package/dist/server/handlers/auth.handler.d.ts.map +1 -1
  101. package/dist/server/handlers/auth.handler.js +6 -4
  102. package/dist/server/handlers/auth.handler.js.map +1 -1
  103. package/dist/server/handlers/captions.handler.js.map +1 -1
  104. package/dist/server/handlers/collection.handler.js.map +1 -1
  105. package/dist/server/handlers/error-response.js.map +1 -1
  106. package/dist/server/handlers/index.handler.js.map +1 -1
  107. package/dist/server/handlers/preview.handler.js.map +1 -1
  108. package/dist/server/handlers/registry.handler.js.map +1 -1
  109. package/dist/server/handlers/revalidate.handler.js.map +1 -1
  110. package/dist/server/handlers/route.handler.js.map +1 -1
  111. package/dist/server/handlers/sitemap.handler.js.map +1 -1
  112. package/dist/server/handlers/static-params.handler.js.map +1 -1
  113. package/dist/server/handlers/vars.handler.js.map +1 -1
  114. package/dist/server/helpers.js.map +1 -1
  115. package/dist/server/json-ld.js.map +1 -1
  116. package/dist/server/layout.js.map +1 -1
  117. package/dist/server/lazy.js.map +1 -1
  118. package/dist/server/local-api.js.map +1 -1
  119. package/dist/server/metadata.js.map +1 -1
  120. package/dist/server/mixer.js.map +1 -1
  121. package/dist/server/page.js.map +1 -1
  122. package/dist/server/rate-limit.d.ts +37 -0
  123. package/dist/server/rate-limit.d.ts.map +1 -0
  124. package/dist/server/rate-limit.js +55 -0
  125. package/dist/server/rate-limit.js.map +1 -0
  126. package/dist/server/utils.js.map +1 -1
  127. package/dist/server/utmz.js.map +1 -1
  128. package/package.json +1 -1
  129. package/src/cache-handler/redis.test.ts +230 -230
  130. package/src/cache-handler/redis.ts +344 -344
  131. package/src/cache-handlers/default.test.ts +125 -125
  132. package/src/cache-handlers/default.ts +246 -246
  133. package/src/client/client.tsx +20 -20
  134. package/src/client/extra.tsx +17 -17
  135. package/src/client/label.tsx +20 -20
  136. package/src/client/layout.tsx +18 -18
  137. package/src/client/local.collection.ts +72 -72
  138. package/src/client/metadata.tsx +187 -187
  139. package/src/client/page.tsx +18 -18
  140. package/src/client/useApi.test.tsx +212 -212
  141. package/src/client/useApi.ts +115 -115
  142. package/src/client/useCollectionApi.test.tsx +213 -213
  143. package/src/client/useCollectionApi.ts +135 -135
  144. package/src/client/useExtra.tsx +12 -12
  145. package/src/client/useHttp.ts +78 -78
  146. package/src/client/useLabel.test.tsx +82 -82
  147. package/src/client/useLabel.tsx +12 -12
  148. package/src/client/useLayout.tsx +13 -13
  149. package/src/client/useLink.tsx +16 -16
  150. package/src/client/useMetaData.tsx +12 -12
  151. package/src/client/usePage.tsx +12 -12
  152. package/src/client/useUser.tsx +12 -12
  153. package/src/client/user.test.tsx +63 -63
  154. package/src/client/user.tsx +73 -73
  155. package/src/config/with-bom.test.ts +61 -61
  156. package/src/config/with-bom.ts +68 -68
  157. package/src/exports/cache-handlers-default.ts +3 -3
  158. package/src/exports/cache-handlers-isr.ts +9 -9
  159. package/src/exports/client.ts +19 -19
  160. package/src/exports/config.ts +3 -3
  161. package/src/exports/instrumentation.ts +1 -1
  162. package/src/exports/proxy.ts +1 -0
  163. package/src/exports/server.ts +1 -0
  164. package/src/global.d.ts +6 -6
  165. package/src/index.ts +4 -0
  166. package/src/instrumentation/client.ts +18 -18
  167. package/src/instrumentation/sentry/capture.requestError.ts +9 -9
  168. package/src/instrumentation/sentry/capture.routerTransitionStart.ts +7 -7
  169. package/src/instrumentation/sentry/config.client.ts +9 -9
  170. package/src/instrumentation/sentry/config.edge.ts +9 -9
  171. package/src/instrumentation/sentry/config.server.ts +9 -9
  172. package/src/instrumentation/server.ts +39 -39
  173. package/src/instrumentation/types.ts +11 -11
  174. package/src/lib/breadcrumb.ts +25 -25
  175. package/src/lib/const.ts +28 -28
  176. package/src/lib/cors.test.ts +29 -0
  177. package/src/lib/cors.ts +55 -0
  178. package/src/lib/debug.ts +11 -11
  179. package/src/lib/http.test.ts +25 -25
  180. package/src/lib/http.ts +127 -127
  181. package/src/lib/label.ts +47 -47
  182. package/src/lib/layout.defaults.ts +167 -167
  183. package/src/lib/link.ts +19 -19
  184. package/src/lib/meta-data.ts +60 -60
  185. package/src/lib/open-graph.ts +165 -165
  186. package/src/lib/page-metadata.test.ts +192 -192
  187. package/src/lib/page-metadata.ts +296 -296
  188. package/src/lib/pagination.ts +80 -80
  189. package/src/lib/route.test.ts +62 -62
  190. package/src/lib/route.ts +117 -117
  191. package/src/lib/seed-env.ts +17 -0
  192. package/src/lib/spam.test.ts +39 -0
  193. package/src/lib/spam.ts +59 -0
  194. package/src/lib/store.ts +63 -63
  195. package/src/lib/structured-data.ts +24 -24
  196. package/src/lib/ttl-cache.ts +72 -72
  197. package/src/lib/twitter-card.ts +49 -49
  198. package/src/lib/user.test.ts +21 -0
  199. package/src/lib/user.ts +25 -0
  200. package/src/lib/utils.ts +44 -44
  201. package/src/mock.ts +292 -292
  202. package/src/proxy/api-cors.test.ts +30 -0
  203. package/src/proxy/api-cors.ts +42 -0
  204. package/src/proxy/protected-route.test.ts +75 -75
  205. package/src/proxy/protected-route.ts +68 -68
  206. package/src/proxy/proxy.test.ts +51 -51
  207. package/src/proxy/proxy.ts +81 -81
  208. package/src/proxy/route-auto-detection.test.ts +98 -55
  209. package/src/proxy/route-auto-detection.ts +247 -222
  210. package/src/proxy/route-proxy.test.ts +140 -104
  211. package/src/proxy/route-proxy.ts +295 -291
  212. package/src/server/cache/cached-types.ts +73 -73
  213. package/src/server/cache/cached.test.ts +115 -115
  214. package/src/server/cache/cached.ts +22 -22
  215. package/src/server/cache/defaults.ts +46 -46
  216. package/src/server/cache/executor.test.ts +134 -134
  217. package/src/server/cache/executor.ts +141 -141
  218. package/src/server/cache/handler.test.ts +122 -122
  219. package/src/server/cache/handler.ts +126 -126
  220. package/src/server/cache/index.ts +39 -39
  221. package/src/server/cache/inspector/filesystem.test.ts +142 -142
  222. package/src/server/cache/inspector/filesystem.ts +214 -214
  223. package/src/server/cache/inspector/index.ts +19 -19
  224. package/src/server/cache/inspector/redis.test.ts +97 -97
  225. package/src/server/cache/inspector/redis.ts +183 -183
  226. package/src/server/cache/inspector/route-cache-key.test.ts +31 -31
  227. package/src/server/cache/inspector/route-cache-key.ts +40 -40
  228. package/src/server/cache/inspector/types.ts +49 -49
  229. package/src/server/cache/local-executor.ts +39 -39
  230. package/src/server/cache/mode/classic.ts +59 -59
  231. package/src/server/cache/mode/components.test.ts +53 -53
  232. package/src/server/cache/mode/components.ts +64 -64
  233. package/src/server/cache/profiles.ts +41 -41
  234. package/src/server/cache/registry.test.ts +66 -66
  235. package/src/server/cache/registry.ts +82 -82
  236. package/src/server/cache/route-parity.test.ts +33 -33
  237. package/src/server/cache/tag-page.ts +23 -23
  238. package/src/server/context.cache.test.ts +79 -79
  239. package/src/server/context.test.ts +645 -645
  240. package/src/server/context.ts +488 -488
  241. package/src/server/context.type-test.ts +112 -112
  242. package/src/server/handlers/auth.handler.ts +31 -32
  243. package/src/server/handlers/captions.handler.ts +36 -36
  244. package/src/server/handlers/collection.handler.test.ts +63 -63
  245. package/src/server/handlers/collection.handler.ts +221 -221
  246. package/src/server/handlers/error-response.ts +50 -50
  247. package/src/server/handlers/index.handler.ts +153 -153
  248. package/src/server/handlers/preview.handler.test.ts +92 -92
  249. package/src/server/handlers/preview.handler.ts +95 -95
  250. package/src/server/handlers/registry.handler.test.ts +171 -171
  251. package/src/server/handlers/registry.handler.ts +514 -514
  252. package/src/server/handlers/revalidate.handler.ts +148 -148
  253. package/src/server/handlers/route.handler.test.ts +50 -50
  254. package/src/server/handlers/route.handler.ts +188 -188
  255. package/src/server/handlers/sitemap.handler.ts +432 -432
  256. package/src/server/handlers/static-params.cache.test.ts +81 -81
  257. package/src/server/handlers/static-params.handler.ts +123 -123
  258. package/src/server/handlers/vars.handler.ts +174 -174
  259. package/src/server/helpers.ts +97 -97
  260. package/src/server/json-ld.tsx +65 -65
  261. package/src/server/layout.ts +148 -148
  262. package/src/server/lazy.ts +41 -41
  263. package/src/server/local-api.ts +67 -67
  264. package/src/server/metadata.ts +79 -79
  265. package/src/server/mixer-payload.ts +115 -115
  266. package/src/server/mixer-payload.type-test.ts +27 -27
  267. package/src/server/mixer.ts +513 -513
  268. package/src/server/page.ts +148 -148
  269. package/src/server/rate-limit.test.ts +90 -0
  270. package/src/server/rate-limit.ts +95 -0
  271. package/src/server/request-data.test.ts +34 -34
  272. package/src/server/utils.ts +23 -23
  273. package/src/server/utmz.ts +11 -11
  274. package/src/types.ts +363 -363
@@ -1,142 +1,142 @@
1
- import { mkdir, mkdtemp, rm, utimes, writeFile } from 'node:fs/promises';
2
- import { tmpdir } from 'node:os';
3
- import { join } from 'node:path';
4
- import { afterAll, beforeAll, describe, expect, it } from 'vitest';
5
- import { createFilesystemInspector, readIsrTemplates } from './filesystem';
6
-
7
- let nextDirectory: string;
8
-
9
- const pageHash = '690f09303d80f1187a61dd333b6b8f5c709af0c6e8d5977c080e96527cbb9b39';
10
-
11
- async function page(
12
- path: string,
13
- meta: object,
14
- body = '<html></html>',
15
- extension = '.html',
16
- root = ['app']
17
- ) {
18
- const file = join(nextDirectory, 'server', ...root, ...path.split('/').filter(Boolean));
19
- await mkdir(join(file, '..'), { recursive: true });
20
- await writeFile(`${file}.meta`, JSON.stringify(meta));
21
- await writeFile(`${file}${extension}`, body);
22
- return `${file}${extension}`;
23
- }
24
-
25
- beforeAll(async () => {
26
- nextDirectory = await mkdtemp(join(tmpdir(), 'bom-cache-fs-'));
27
- const html = await page('/ww/en/page/home', {
28
- status: 200,
29
- headers: {
30
- 'x-next-cache-tags': 'bom:all,bom:doc:page:home,_N_T_/layout,_N_T_/ww/en/page/home',
31
- },
32
- });
33
- await utimes(html, new Date(1_000_000), new Date(1_000_000));
34
- await page('/ww/en/post_detail/missing', { status: 404, headers: {} });
35
- // runtime entry (Next.js 16.4 route cache) with its own cache control
36
- await page(
37
- '/ww/it/page/home',
38
- {
39
- status: 200,
40
- headers: { 'x-next-cache-tags': '_N_T_/layout,bom:l:ww:it' },
41
- cacheControl: { revalidate: 60 },
42
- },
43
- '<html>it</html>',
44
- '.html',
45
- ['route-cache', 'APP_PAGE', pageHash, '$']
46
- );
47
- await page('/sitemap.xml', { status: 200, headers: {} }, '<xml/>', '.body');
48
- await page('/_not-found', { status: 404, headers: {} });
49
- await mkdir(join(nextDirectory, 'server', 'app', 'ww', 'en', 'page', 'home.segments'), {
50
- recursive: true,
51
- });
52
- await writeFile(
53
- join(nextDirectory, 'server', 'app', 'ww', 'en', 'page', 'home.segments', 'x.meta'),
54
- '{}'
55
- );
56
- await writeFile(
57
- join(nextDirectory, 'prerender-manifest.json'),
58
- JSON.stringify({
59
- routes: { '/sitemap.xml': { initialRevalidateSeconds: 600 } },
60
- dynamicRoutes: {
61
- '/[market]/[locale]/page/[id]': {},
62
- '/[market]/[locale]/post_detail/[id]': {},
63
- '/[slug]': {},
64
- },
65
- })
66
- );
67
- });
68
-
69
- afterAll(async () => {
70
- await rm(nextDirectory, { recursive: true, force: true });
71
- });
72
-
73
- describe('filesystem inspector', () => {
74
- it('lists cached pages with explicit tags, status, size and age', async () => {
75
- const pages = await createFilesystemInspector({
76
- nextDirectory,
77
- defaultRevalidate: 3600,
78
- }).pages();
79
- const byPath = new Map(pages.map((entry) => [entry.internalPath, entry]));
80
- expect([...byPath.keys()].sort()).toEqual([
81
- '/sitemap.xml',
82
- '/ww/en/page/home',
83
- '/ww/en/post_detail/missing',
84
- '/ww/it/page/home',
85
- ]);
86
- expect(byPath.get('/ww/it/page/home')).toMatchObject({
87
- tags: ['bom:l:ww:it'],
88
- revalidateSeconds: 60,
89
- sourceHash: pageHash,
90
- });
91
- expect(byPath.get('/ww/en/page/home')).toMatchObject({
92
- tags: ['bom:all', 'bom:doc:page:home'],
93
- status: 200,
94
- sizeBytes: 13,
95
- generatedAt: 1_000_000,
96
- revalidateSeconds: 3600,
97
- });
98
- expect(byPath.get('/ww/en/post_detail/missing')?.status).toBe(404);
99
- expect(byPath.get('/sitemap.xml')?.revalidateSeconds).toBe(600);
100
- });
101
-
102
- it('returns nothing when there is no cache directory', async () => {
103
- const pages = await createFilesystemInspector({
104
- nextDirectory: join(nextDirectory, 'missing'),
105
- }).pages();
106
- expect(pages).toEqual([]);
107
- });
108
-
109
- it('lists named function results from the data cache, without parsing their body', async () => {
110
- const fetchCache = join(nextDirectory, 'cache', 'fetch-cache');
111
- await mkdir(fetchCache, { recursive: true });
112
- const body = 'x'.repeat(20_000);
113
- await writeFile(
114
- join(fetchCache, 'a1'),
115
- `{"kind":"FETCH","data":{"body":"${body}"},"revalidate":86400,"tags":["bom:fn:menus","bom:coll:menu"]}`
116
- );
117
- // a tagPage marker and a plain fetch entry are not functions
118
- await writeFile(
119
- join(fetchCache, 'b2'),
120
- '{"kind":"FETCH","data":{"body":"true"},"revalidate":31536000,"tags":["bom:all"]}'
121
- );
122
- await writeFile(
123
- join(fetchCache, 'c3'),
124
- '{"kind":"FETCH","data":{"body":"{}"},"revalidate":600,"tags":[]}'
125
- );
126
- const functions = await createFilesystemInspector({ nextDirectory }).functions();
127
- expect(functions).toEqual([
128
- expect.objectContaining({
129
- key: 'a1',
130
- name: 'menus',
131
- tags: ['bom:fn:menus', 'bom:coll:menu'],
132
- revalidateSeconds: 86400,
133
- }),
134
- ]);
135
- expect(functions[0]!.sizeBytes).toBeGreaterThan(20_000);
136
- });
137
-
138
- it('reads the template folders rendered with ISR', async () => {
139
- expect(await readIsrTemplates(nextDirectory)).toEqual(['page', 'post_detail']);
140
- expect(await readIsrTemplates(join(nextDirectory, 'missing'))).toBeUndefined();
141
- });
142
- });
1
+ import { mkdir, mkdtemp, rm, utimes, writeFile } from 'node:fs/promises';
2
+ import { tmpdir } from 'node:os';
3
+ import { join } from 'node:path';
4
+ import { afterAll, beforeAll, describe, expect, it } from 'vitest';
5
+ import { createFilesystemInspector, readIsrTemplates } from './filesystem';
6
+
7
+ let nextDirectory: string;
8
+
9
+ const pageHash = '690f09303d80f1187a61dd333b6b8f5c709af0c6e8d5977c080e96527cbb9b39';
10
+
11
+ async function page(
12
+ path: string,
13
+ meta: object,
14
+ body = '<html></html>',
15
+ extension = '.html',
16
+ root = ['app']
17
+ ) {
18
+ const file = join(nextDirectory, 'server', ...root, ...path.split('/').filter(Boolean));
19
+ await mkdir(join(file, '..'), { recursive: true });
20
+ await writeFile(`${file}.meta`, JSON.stringify(meta));
21
+ await writeFile(`${file}${extension}`, body);
22
+ return `${file}${extension}`;
23
+ }
24
+
25
+ beforeAll(async () => {
26
+ nextDirectory = await mkdtemp(join(tmpdir(), 'bom-cache-fs-'));
27
+ const html = await page('/ww/en/page/home', {
28
+ status: 200,
29
+ headers: {
30
+ 'x-next-cache-tags': 'bom:all,bom:doc:page:home,_N_T_/layout,_N_T_/ww/en/page/home',
31
+ },
32
+ });
33
+ await utimes(html, new Date(1_000_000), new Date(1_000_000));
34
+ await page('/ww/en/post_detail/missing', { status: 404, headers: {} });
35
+ // runtime entry (Next.js 16.4 route cache) with its own cache control
36
+ await page(
37
+ '/ww/it/page/home',
38
+ {
39
+ status: 200,
40
+ headers: { 'x-next-cache-tags': '_N_T_/layout,bom:l:ww:it' },
41
+ cacheControl: { revalidate: 60 },
42
+ },
43
+ '<html>it</html>',
44
+ '.html',
45
+ ['route-cache', 'APP_PAGE', pageHash, '$']
46
+ );
47
+ await page('/sitemap.xml', { status: 200, headers: {} }, '<xml/>', '.body');
48
+ await page('/_not-found', { status: 404, headers: {} });
49
+ await mkdir(join(nextDirectory, 'server', 'app', 'ww', 'en', 'page', 'home.segments'), {
50
+ recursive: true,
51
+ });
52
+ await writeFile(
53
+ join(nextDirectory, 'server', 'app', 'ww', 'en', 'page', 'home.segments', 'x.meta'),
54
+ '{}'
55
+ );
56
+ await writeFile(
57
+ join(nextDirectory, 'prerender-manifest.json'),
58
+ JSON.stringify({
59
+ routes: { '/sitemap.xml': { initialRevalidateSeconds: 600 } },
60
+ dynamicRoutes: {
61
+ '/[market]/[locale]/page/[id]': {},
62
+ '/[market]/[locale]/post_detail/[id]': {},
63
+ '/[slug]': {},
64
+ },
65
+ })
66
+ );
67
+ });
68
+
69
+ afterAll(async () => {
70
+ await rm(nextDirectory, { recursive: true, force: true });
71
+ });
72
+
73
+ describe('filesystem inspector', () => {
74
+ it('lists cached pages with explicit tags, status, size and age', async () => {
75
+ const pages = await createFilesystemInspector({
76
+ nextDirectory,
77
+ defaultRevalidate: 3600,
78
+ }).pages();
79
+ const byPath = new Map(pages.map((entry) => [entry.internalPath, entry]));
80
+ expect([...byPath.keys()].sort()).toEqual([
81
+ '/sitemap.xml',
82
+ '/ww/en/page/home',
83
+ '/ww/en/post_detail/missing',
84
+ '/ww/it/page/home',
85
+ ]);
86
+ expect(byPath.get('/ww/it/page/home')).toMatchObject({
87
+ tags: ['bom:l:ww:it'],
88
+ revalidateSeconds: 60,
89
+ sourceHash: pageHash,
90
+ });
91
+ expect(byPath.get('/ww/en/page/home')).toMatchObject({
92
+ tags: ['bom:all', 'bom:doc:page:home'],
93
+ status: 200,
94
+ sizeBytes: 13,
95
+ generatedAt: 1_000_000,
96
+ revalidateSeconds: 3600,
97
+ });
98
+ expect(byPath.get('/ww/en/post_detail/missing')?.status).toBe(404);
99
+ expect(byPath.get('/sitemap.xml')?.revalidateSeconds).toBe(600);
100
+ });
101
+
102
+ it('returns nothing when there is no cache directory', async () => {
103
+ const pages = await createFilesystemInspector({
104
+ nextDirectory: join(nextDirectory, 'missing'),
105
+ }).pages();
106
+ expect(pages).toEqual([]);
107
+ });
108
+
109
+ it('lists named function results from the data cache, without parsing their body', async () => {
110
+ const fetchCache = join(nextDirectory, 'cache', 'fetch-cache');
111
+ await mkdir(fetchCache, { recursive: true });
112
+ const body = 'x'.repeat(20_000);
113
+ await writeFile(
114
+ join(fetchCache, 'a1'),
115
+ `{"kind":"FETCH","data":{"body":"${body}"},"revalidate":86400,"tags":["bom:fn:menus","bom:coll:menu"]}`
116
+ );
117
+ // a tagPage marker and a plain fetch entry are not functions
118
+ await writeFile(
119
+ join(fetchCache, 'b2'),
120
+ '{"kind":"FETCH","data":{"body":"true"},"revalidate":31536000,"tags":["bom:all"]}'
121
+ );
122
+ await writeFile(
123
+ join(fetchCache, 'c3'),
124
+ '{"kind":"FETCH","data":{"body":"{}"},"revalidate":600,"tags":[]}'
125
+ );
126
+ const functions = await createFilesystemInspector({ nextDirectory }).functions();
127
+ expect(functions).toEqual([
128
+ expect.objectContaining({
129
+ key: 'a1',
130
+ name: 'menus',
131
+ tags: ['bom:fn:menus', 'bom:coll:menu'],
132
+ revalidateSeconds: 86400,
133
+ }),
134
+ ]);
135
+ expect(functions[0]!.sizeBytes).toBeGreaterThan(20_000);
136
+ });
137
+
138
+ it('reads the template folders rendered with ISR', async () => {
139
+ expect(await readIsrTemplates(nextDirectory)).toEqual(['page', 'post_detail']);
140
+ expect(await readIsrTemplates(join(nextDirectory, 'missing'))).toBeUndefined();
141
+ });
142
+ });