@decocms/blocks 8.0.0 → 8.1.0-next.1

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 (220) hide show
  1. package/bin/deco.js +13 -0
  2. package/package.json +32 -82
  3. package/src/index.ts +35 -8
  4. package/src/protocol/assets.ts +124 -0
  5. package/src/protocol/canonical.ts +7 -0
  6. package/src/protocol/ciphertext.ts +6 -0
  7. package/src/protocol/client.ts +170 -0
  8. package/src/protocol/conformance/cases/assets.ts +81 -0
  9. package/src/protocol/conformance/cases/guards.ts +314 -0
  10. package/src/protocol/conformance/cases/reads.ts +168 -0
  11. package/src/protocol/conformance/cases/types.ts +9 -0
  12. package/src/protocol/conformance/cases/wire.ts +138 -0
  13. package/src/protocol/conformance/cases/writes.ts +345 -0
  14. package/src/protocol/conformance/contentHashFixtures.ts +79 -0
  15. package/src/protocol/conformance/context.ts +222 -0
  16. package/src/protocol/conformance/index.ts +140 -0
  17. package/src/protocol/errors.ts +142 -0
  18. package/src/protocol/index.ts +39 -0
  19. package/src/protocol/keys.ts +279 -0
  20. package/src/protocol/params.ts +67 -0
  21. package/src/protocol/secrets.ts +231 -0
  22. package/src/protocol/server/assets.ts +119 -0
  23. package/src/protocol/server/auth.ts +49 -0
  24. package/src/protocol/server/bodyCache.ts +84 -0
  25. package/src/protocol/server/content.ts +175 -0
  26. package/src/protocol/server/core.ts +112 -0
  27. package/src/protocol/server/handler.ts +102 -0
  28. package/src/protocol/server/http.ts +139 -0
  29. package/src/protocol/server/index.ts +11 -0
  30. package/src/protocol/server/methods/apply.ts +341 -0
  31. package/src/protocol/server/methods/read.ts +156 -0
  32. package/src/protocol/server/rpc.ts +136 -0
  33. package/src/protocol/storage/fs/hash.ts +21 -0
  34. package/src/protocol/storage/fs/index.ts +338 -0
  35. package/src/protocol/storage/fs/lock.ts +68 -0
  36. package/src/protocol/storage/fs/transaction.ts +183 -0
  37. package/src/protocol/storage/fs/unsupported.ts +15 -0
  38. package/src/protocol/storage/memory.ts +238 -0
  39. package/src/protocol/storage.ts +182 -0
  40. package/src/protocol/types.ts +172 -0
  41. package/src/v8/analytics.ts +50 -0
  42. package/src/v8/background.ts +107 -0
  43. package/src/v8/builtins/data.ts +23 -0
  44. package/src/v8/builtins/index.ts +26 -0
  45. package/src/v8/builtins/lazy.ts +23 -0
  46. package/src/v8/builtins/legacy.ts +65 -0
  47. package/src/v8/builtins/matchers.ts +31 -0
  48. package/src/v8/builtins/multivariate.ts +25 -0
  49. package/src/v8/builtins/secret.ts +82 -0
  50. package/src/v8/canonical.ts +117 -0
  51. package/src/v8/ciphertext.ts +158 -0
  52. package/src/v8/cli/builtins.ts +20 -0
  53. package/src/v8/cli/check/index.ts +774 -0
  54. package/src/v8/cli/check/messages.ts +168 -0
  55. package/src/v8/cli/content.ts +287 -0
  56. package/src/v8/cli/index.ts +17 -0
  57. package/src/v8/cli/log.ts +18 -0
  58. package/src/v8/cli/main.ts +12 -0
  59. package/src/v8/cli/root.ts +66 -0
  60. package/src/v8/cli/run.ts +236 -0
  61. package/src/v8/cli/schema/builtinSchemas.ts +236 -0
  62. package/src/v8/cli/schema/generate.ts +507 -0
  63. package/src/v8/cli/schema/index.ts +63 -0
  64. package/src/v8/cli/schema/tsProgram.ts +497 -0
  65. package/src/v8/cli/schema/typeToSchema.ts +689 -0
  66. package/src/v8/cli/serve/server.ts +303 -0
  67. package/src/v8/cli/watch.ts +86 -0
  68. package/src/v8/client.ts +147 -0
  69. package/src/v8/cms.ts +237 -0
  70. package/src/v8/content.ts +195 -0
  71. package/src/v8/draft.ts +136 -0
  72. package/src/v8/errors.ts +59 -0
  73. package/src/v8/fetch.ts +133 -0
  74. package/src/v8/identity.ts +65 -0
  75. package/src/v8/index.ts +39 -0
  76. package/src/v8/json.ts +74 -0
  77. package/src/v8/matchRoute.ts +204 -0
  78. package/src/v8/remoteLoader.ts +282 -0
  79. package/src/v8/resolver.ts +278 -0
  80. package/src/v8/secrets.ts +17 -0
  81. package/src/v8/telemetry.ts +533 -0
  82. package/src/v8/types.ts +240 -0
  83. package/src/cms/applySectionConventions.ts +0 -124
  84. package/src/cms/blockSource.test.ts +0 -76
  85. package/src/cms/blockSource.ts +0 -191
  86. package/src/cms/client.browserBundle.test.ts +0 -44
  87. package/src/cms/client.ts +0 -80
  88. package/src/cms/draftSource.test.ts +0 -343
  89. package/src/cms/draftSource.ts +0 -362
  90. package/src/cms/index.ts +0 -151
  91. package/src/cms/layoutCacheRace.test.ts +0 -181
  92. package/src/cms/loadDecofileDirectory.test.ts +0 -109
  93. package/src/cms/loadDecofileDirectory.ts +0 -89
  94. package/src/cms/loader.test.ts +0 -200
  95. package/src/cms/loader.ts +0 -304
  96. package/src/cms/registry.test.ts +0 -110
  97. package/src/cms/registry.ts +0 -242
  98. package/src/cms/resolve.test.ts +0 -980
  99. package/src/cms/resolve.ts +0 -2282
  100. package/src/cms/schema.test.ts +0 -356
  101. package/src/cms/schema.ts +0 -1215
  102. package/src/cms/sectionLoaderContext.test.ts +0 -111
  103. package/src/cms/sectionLoaderContext.ts +0 -113
  104. package/src/cms/sectionLoaders.test.ts +0 -533
  105. package/src/cms/sectionLoaders.ts +0 -636
  106. package/src/cms/sectionMixins.test.ts +0 -167
  107. package/src/cms/sectionMixins.ts +0 -153
  108. package/src/cms/stickyFlags.test.ts +0 -117
  109. package/src/flags/audience.ts +0 -56
  110. package/src/flags/everyone.ts +0 -29
  111. package/src/flags/flag.ts +0 -15
  112. package/src/flags/flags.test.ts +0 -148
  113. package/src/flags/multivariate/image.ts +0 -11
  114. package/src/flags/multivariate/message.ts +0 -11
  115. package/src/flags/multivariate/page.ts +0 -16
  116. package/src/flags/multivariate/section.ts +0 -16
  117. package/src/flags/multivariate.ts +0 -1
  118. package/src/flags/types.ts +0 -59
  119. package/src/flags/utils/multivariate.ts +0 -20
  120. package/src/hooks/Image.test.ts +0 -100
  121. package/src/hooks/Image.tsx +0 -250
  122. package/src/hooks/JsonLd.tsx +0 -353
  123. package/src/hooks/LazySection.tsx +0 -121
  124. package/src/hooks/LiveControls.tsx +0 -122
  125. package/src/hooks/Picture.tsx +0 -127
  126. package/src/hooks/RenderSection.test.tsx +0 -81
  127. package/src/hooks/RenderSection.tsx +0 -91
  128. package/src/hooks/SectionErrorFallback.tsx +0 -97
  129. package/src/hooks/index.ts +0 -30
  130. package/src/matchers/builtins.test.ts +0 -318
  131. package/src/matchers/builtins.ts +0 -459
  132. package/src/matchers/countryNames.ts +0 -104
  133. package/src/matchers/override.test.ts +0 -205
  134. package/src/matchers/override.ts +0 -136
  135. package/src/matchers/posthog.ts +0 -154
  136. package/src/middleware/decoState.ts +0 -55
  137. package/src/middleware/healthMetrics.ts +0 -133
  138. package/src/middleware/hydrationContext.test.ts +0 -61
  139. package/src/middleware/hydrationContext.ts +0 -79
  140. package/src/middleware/index.ts +0 -88
  141. package/src/middleware/liveness.ts +0 -21
  142. package/src/middleware/observability.test.ts +0 -242
  143. package/src/middleware/observability.ts +0 -643
  144. package/src/middleware/validateSection.test.ts +0 -147
  145. package/src/middleware/validateSection.ts +0 -100
  146. package/src/sdk/abTesting.test.ts +0 -326
  147. package/src/sdk/abTesting.ts +0 -499
  148. package/src/sdk/analytics.ts +0 -77
  149. package/src/sdk/cacheHeaders.test.ts +0 -115
  150. package/src/sdk/cacheHeaders.ts +0 -433
  151. package/src/sdk/cachedLoader.test.ts +0 -122
  152. package/src/sdk/cachedLoader.ts +0 -503
  153. package/src/sdk/cachedLoaderModule.test.ts +0 -209
  154. package/src/sdk/clx.ts +0 -5
  155. package/src/sdk/cn.test.ts +0 -34
  156. package/src/sdk/cn.ts +0 -28
  157. package/src/sdk/composite.test.ts +0 -121
  158. package/src/sdk/composite.ts +0 -114
  159. package/src/sdk/cookie.test.ts +0 -108
  160. package/src/sdk/cookie.ts +0 -129
  161. package/src/sdk/crypto.ts +0 -185
  162. package/src/sdk/csp.ts +0 -59
  163. package/src/sdk/detectDevice.ts +0 -45
  164. package/src/sdk/djb2.ts +0 -20
  165. package/src/sdk/encoding.test.ts +0 -71
  166. package/src/sdk/encoding.ts +0 -47
  167. package/src/sdk/env.test.ts +0 -33
  168. package/src/sdk/env.ts +0 -54
  169. package/src/sdk/flags.test.ts +0 -91
  170. package/src/sdk/flags.ts +0 -108
  171. package/src/sdk/http.test.ts +0 -71
  172. package/src/sdk/http.ts +0 -124
  173. package/src/sdk/index.ts +0 -90
  174. package/src/sdk/inflightTimeout.test.ts +0 -35
  175. package/src/sdk/inflightTimeout.ts +0 -53
  176. package/src/sdk/instrumentedFetch.test.ts +0 -559
  177. package/src/sdk/instrumentedFetch.ts +0 -339
  178. package/src/sdk/invoke.test.ts +0 -115
  179. package/src/sdk/invoke.ts +0 -298
  180. package/src/sdk/logger.test.ts +0 -432
  181. package/src/sdk/logger.ts +0 -304
  182. package/src/sdk/mergeCacheControl.ts +0 -150
  183. package/src/sdk/normalizeUrls.ts +0 -91
  184. package/src/sdk/observability.ts +0 -109
  185. package/src/sdk/otel.test.ts +0 -526
  186. package/src/sdk/otel.ts +0 -1012
  187. package/src/sdk/otelAdapters/clickhouseCollector.ts +0 -65
  188. package/src/sdk/otelAdapters.test.ts +0 -89
  189. package/src/sdk/otelAdapters.ts +0 -144
  190. package/src/sdk/otelHttpLog.test.ts +0 -457
  191. package/src/sdk/otelHttpLog.ts +0 -419
  192. package/src/sdk/otelHttpMeter.test.ts +0 -292
  193. package/src/sdk/otelHttpMeter.ts +0 -506
  194. package/src/sdk/otelHttpTracer.test.ts +0 -474
  195. package/src/sdk/otelHttpTracer.ts +0 -543
  196. package/src/sdk/redirects.ts +0 -228
  197. package/src/sdk/requestContext.ts +0 -281
  198. package/src/sdk/requestContextStorage.browser.test.ts +0 -29
  199. package/src/sdk/requestContextStorage.browser.ts +0 -43
  200. package/src/sdk/requestContextStorage.ts +0 -35
  201. package/src/sdk/retry.ts +0 -45
  202. package/src/sdk/serverTimings.ts +0 -68
  203. package/src/sdk/signal.ts +0 -42
  204. package/src/sdk/sitemap.ts +0 -160
  205. package/src/sdk/urlRedaction.test.ts +0 -73
  206. package/src/sdk/urlRedaction.ts +0 -82
  207. package/src/sdk/urlUtils.ts +0 -134
  208. package/src/sdk/useDevice.test.ts +0 -130
  209. package/src/sdk/useDevice.ts +0 -89
  210. package/src/sdk/useDeviceContext.tsx +0 -108
  211. package/src/sdk/useId.ts +0 -7
  212. package/src/sdk/useScript.test.ts +0 -128
  213. package/src/sdk/useScript.ts +0 -210
  214. package/src/sdk/useSuggestions.test.ts +0 -230
  215. package/src/sdk/useSuggestions.ts +0 -188
  216. package/src/sdk/wrapCaughtErrors.ts +0 -107
  217. package/src/setup.ts +0 -120
  218. package/src/types/index.ts +0 -53
  219. package/src/types/widgets.ts +0 -14
  220. package/tsconfig.json +0 -7
@@ -1,432 +0,0 @@
1
- import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
2
- import {
3
- _getLoggerAttributeFloorForTests,
4
- configureLogger,
5
- defaultLoggerAdapter,
6
- getLoggerAdapter,
7
- getLogLevel,
8
- type LoggerAdapter,
9
- logger,
10
- serializeError,
11
- setLoggerAttributeFloor,
12
- setLogLevel,
13
- } from "./logger";
14
-
15
- describe("defaultLoggerAdapter", () => {
16
- let logSpy: ReturnType<typeof vi.spyOn>;
17
- let warnSpy: ReturnType<typeof vi.spyOn>;
18
- let errorSpy: ReturnType<typeof vi.spyOn>;
19
- let debugSpy: ReturnType<typeof vi.spyOn>;
20
-
21
- beforeEach(() => {
22
- logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
23
- warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
24
- errorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
25
- debugSpy = vi.spyOn(console, "debug").mockImplementation(() => {});
26
- });
27
-
28
- afterEach(() => {
29
- vi.restoreAllMocks();
30
- configureLogger(defaultLoggerAdapter);
31
- setLogLevel("debug"); // permissive default for the rest of the suite
32
- });
33
-
34
- it("emits one JSON line per call", () => {
35
- defaultLoggerAdapter.log("info", "hello", { foo: 1 });
36
- expect(logSpy).toHaveBeenCalledOnce();
37
- const arg = logSpy.mock.calls[0]?.[0] as string;
38
- const parsed = JSON.parse(arg);
39
- expect(parsed).toMatchObject({ level: "info", msg: "hello", foo: 1 });
40
- expect(typeof parsed.timestamp).toBe("string");
41
- });
42
-
43
- it("routes by level so CF Logs colorises correctly", () => {
44
- defaultLoggerAdapter.log("error", "boom");
45
- defaultLoggerAdapter.log("warn", "careful");
46
- defaultLoggerAdapter.log("debug", "details");
47
- expect(errorSpy).toHaveBeenCalledOnce();
48
- expect(warnSpy).toHaveBeenCalledOnce();
49
- expect(debugSpy).toHaveBeenCalledOnce();
50
- });
51
-
52
- it("never throws on circular refs (last-resort fallback)", () => {
53
- const circ: any = { name: "x" };
54
- circ.self = circ;
55
- expect(() => defaultLoggerAdapter.log("info", "circ", { circ })).not.toThrow();
56
- expect(logSpy).toHaveBeenCalledOnce();
57
- });
58
-
59
- it("does not let attrs override level/msg/timestamp keys", () => {
60
- defaultLoggerAdapter.log("info", "real-msg", {
61
- level: "tampered",
62
- msg: "tampered",
63
- timestamp: "tampered",
64
- });
65
- const parsed = JSON.parse(logSpy.mock.calls[0]?.[0] as string);
66
- expect(parsed.level).toBe("info");
67
- expect(parsed.msg).toBe("real-msg");
68
- expect(parsed.timestamp).not.toBe("tampered");
69
- });
70
- });
71
-
72
- describe("level filtering", () => {
73
- let logSpy: ReturnType<typeof vi.spyOn>;
74
- let warnSpy: ReturnType<typeof vi.spyOn>;
75
- let errorSpy: ReturnType<typeof vi.spyOn>;
76
- let debugSpy: ReturnType<typeof vi.spyOn>;
77
-
78
- beforeEach(() => {
79
- logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
80
- warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
81
- errorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
82
- debugSpy = vi.spyOn(console, "debug").mockImplementation(() => {});
83
- });
84
-
85
- afterEach(() => {
86
- vi.restoreAllMocks();
87
- configureLogger(defaultLoggerAdapter);
88
- setLogLevel("info");
89
- });
90
-
91
- it("drops calls below the active min level", () => {
92
- setLogLevel("warn");
93
- expect(getLogLevel()).toBe("warn");
94
- logger.debug("d");
95
- logger.info("i");
96
- logger.warn("w");
97
- logger.error("e");
98
- expect(debugSpy).not.toHaveBeenCalled();
99
- expect(logSpy).not.toHaveBeenCalled(); // info routes to console.log
100
- expect(warnSpy).toHaveBeenCalledOnce();
101
- expect(errorSpy).toHaveBeenCalledOnce();
102
- });
103
- });
104
-
105
- describe("configureLogger", () => {
106
- afterEach(() => {
107
- configureLogger(defaultLoggerAdapter);
108
- setLogLevel("info");
109
- });
110
-
111
- it("dispatches to the configured adapter", () => {
112
- const calls: Array<[string, string, unknown]> = [];
113
- const test: LoggerAdapter = {
114
- log(level, msg, attrs) {
115
- calls.push([level, msg, attrs]);
116
- },
117
- };
118
- configureLogger(test);
119
- expect(getLoggerAdapter()).toBe(test);
120
-
121
- logger.info("hello", { x: 1 });
122
- expect(calls).toEqual([["info", "hello", { x: 1 }]]);
123
- });
124
-
125
- it("falls back to default adapter if active adapter throws", () => {
126
- const logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
127
- const broken: LoggerAdapter = {
128
- log() {
129
- throw new Error("nope");
130
- },
131
- };
132
- configureLogger(broken);
133
- expect(() => logger.info("survives", { x: 1 })).not.toThrow();
134
- // Default adapter was invoked as the fallback
135
- expect(logSpy).toHaveBeenCalledOnce();
136
- logSpy.mockRestore();
137
- });
138
- });
139
-
140
- describe("setLoggerAttributeFloor", () => {
141
- afterEach(() => {
142
- setLoggerAttributeFloor({});
143
- configureLogger(defaultLoggerAdapter);
144
- setLogLevel("info");
145
- });
146
-
147
- it("starts empty so the floor is a no-op out of the box", () => {
148
- expect(_getLoggerAttributeFloorForTests()).toEqual({});
149
- });
150
-
151
- it("merges floor attrs into every log call", () => {
152
- setLoggerAttributeFloor({
153
- "deco.runtime.version": "4.4.0",
154
- "deployment.environment": "production",
155
- });
156
- const calls: Array<Record<string, unknown> | undefined> = [];
157
- configureLogger({
158
- log(_level, _msg, attrs) {
159
- calls.push(attrs);
160
- },
161
- });
162
-
163
- logger.info("ping", { route: "/" });
164
-
165
- expect(calls).toHaveLength(1);
166
- expect(calls[0]).toEqual({
167
- "deco.runtime.version": "4.4.0",
168
- "deployment.environment": "production",
169
- route: "/",
170
- });
171
- });
172
-
173
- it("lets caller attrs override the floor on key collision", () => {
174
- setLoggerAttributeFloor({ "deployment.environment": "production" });
175
- const calls: Array<Record<string, unknown> | undefined> = [];
176
- configureLogger({
177
- log(_level, _msg, attrs) {
178
- calls.push(attrs);
179
- },
180
- });
181
-
182
- logger.warn("override", { "deployment.environment": "staging" });
183
-
184
- expect(calls[0]?.["deployment.environment"]).toBe("staging");
185
- });
186
-
187
- it("applies the floor even when the caller passes no attrs", () => {
188
- setLoggerAttributeFloor({ tenant: "lebiscuit" });
189
- const calls: Array<Record<string, unknown> | undefined> = [];
190
- configureLogger({
191
- log(_level, _msg, attrs) {
192
- calls.push(attrs);
193
- },
194
- });
195
-
196
- logger.info("no-attrs");
197
-
198
- expect(calls[0]).toEqual({ tenant: "lebiscuit" });
199
- });
200
-
201
- it("clearing the floor restores the no-op fast path", () => {
202
- setLoggerAttributeFloor({ tenant: "lebiscuit" });
203
- setLoggerAttributeFloor({});
204
- const calls: Array<Record<string, unknown> | undefined> = [];
205
- configureLogger({
206
- log(_level, _msg, attrs) {
207
- calls.push(attrs);
208
- },
209
- });
210
-
211
- logger.info("clean", { x: 1 });
212
-
213
- expect(calls[0]).toEqual({ x: 1 });
214
- });
215
- });
216
-
217
- describe("serializeError", () => {
218
- it("flattens an Error into a JSON-safe shape with stack", () => {
219
- const err = new Error("boom");
220
- const out = serializeError(err);
221
- expect(out).toEqual({ name: "Error", message: "boom", stack: err.stack });
222
- });
223
-
224
- it("preserves subclass name (TypeError, RangeError, custom)", () => {
225
- expect(serializeError(new TypeError("bad type")).name).toBe("TypeError");
226
- class MyErr extends Error {
227
- override name = "MyErr";
228
- }
229
- expect(serializeError(new MyErr("custom")).name).toBe("MyErr");
230
- });
231
-
232
- it("survives JSON.stringify round-trip", () => {
233
- const err = new Error("round-trip");
234
- const out = serializeError(err);
235
- expect(() => JSON.parse(JSON.stringify(out))).not.toThrow();
236
- expect(JSON.parse(JSON.stringify(out)).message).toBe("round-trip");
237
- });
238
-
239
- it("captures plain objects as JSON in message, marking them as NonError", () => {
240
- const out = serializeError({ code: 500, body: "vtex down" });
241
- expect(out.name).toBe("NonError");
242
- expect(out.message).toBe('{"code":500,"body":"vtex down"}');
243
- expect(out.stack).toBeUndefined();
244
- });
245
-
246
- it("falls back to String() when an object has circular refs", () => {
247
- const circ: Record<string, unknown> = { a: 1 };
248
- circ.self = circ;
249
- const out = serializeError(circ);
250
- expect(out.name).toBe("NonError");
251
- expect(typeof out.message).toBe("string");
252
- expect(out.stack).toBeUndefined();
253
- });
254
-
255
- it("handles primitives (string, number, null, undefined)", () => {
256
- expect(serializeError("just a string")).toEqual({
257
- name: "NonError",
258
- message: "just a string",
259
- });
260
- expect(serializeError(42)).toEqual({ name: "NonError", message: "42" });
261
- expect(serializeError(null)).toEqual({ name: "NonError", message: "null" });
262
- expect(serializeError(undefined)).toEqual({
263
- name: "NonError",
264
- message: "undefined",
265
- });
266
- });
267
- });
268
-
269
- describe("request.id stamping (Phase 1, D-9)", () => {
270
- afterEach(() => {
271
- configureLogger(defaultLoggerAdapter);
272
- setLogLevel("info");
273
- });
274
-
275
- it("stamps request.id from RequestContext on every log line emitted inside a request scope", async () => {
276
- const { RequestContext } = await import("./requestContext");
277
-
278
- const seen: Array<Record<string, unknown> | undefined> = [];
279
- configureLogger({
280
- log(_l, _m, attrs) {
281
- seen.push(attrs);
282
- },
283
- });
284
-
285
- const reqWithId = new Request("https://example.com/", {
286
- headers: { "x-request-id": "client-supplied-uuid" },
287
- });
288
- await RequestContext.run(reqWithId, async () => {
289
- logger.info("inside-scope", { custom: "yes" });
290
- });
291
- // Outside the scope, no request.id is stamped — the fast path stays
292
- // fast (no allocation, no key) when RequestContext.requestId is null.
293
- logger.info("outside-scope", { custom: "no" });
294
-
295
- expect(seen[0]).toMatchObject({
296
- "request.id": "client-supplied-uuid",
297
- custom: "yes",
298
- });
299
- expect(seen[1]).toEqual({ custom: "no" });
300
- expect(seen[1]).not.toHaveProperty("request.id");
301
- });
302
-
303
- it("prefers caller-supplied request.id over the auto-generated one", async () => {
304
- const { RequestContext } = await import("./requestContext");
305
-
306
- const seen: Array<Record<string, unknown> | undefined> = [];
307
- configureLogger({
308
- log(_l, _m, attrs) {
309
- seen.push(attrs);
310
- },
311
- });
312
-
313
- const req = new Request("https://example.com/", {
314
- headers: { "x-request-id": "from-headers" },
315
- });
316
-
317
- await RequestContext.run(req, async () => {
318
- // Caller can still override by passing the key directly in attrs.
319
- logger.info("override", { "request.id": "explicit-from-caller" });
320
- });
321
-
322
- expect(seen[0]?.["request.id"]).toBe("explicit-from-caller");
323
- });
324
-
325
- it("falls back to cf-ray when x-request-id is absent", async () => {
326
- const { RequestContext } = await import("./requestContext");
327
-
328
- const seen: Array<Record<string, unknown> | undefined> = [];
329
- configureLogger({
330
- log(_l, _m, attrs) {
331
- seen.push(attrs);
332
- },
333
- });
334
-
335
- const req = new Request("https://example.com/", {
336
- headers: { "cf-ray": "8a1b2c3d4e5f6a7b" },
337
- });
338
-
339
- await RequestContext.run(req, async () => {
340
- logger.info("cf-ray-stamped");
341
- });
342
-
343
- expect(seen[0]?.["request.id"]).toBe("8a1b2c3d4e5f6a7b");
344
- });
345
-
346
- it("generates a fresh UUID when neither header is set", async () => {
347
- const { RequestContext } = await import("./requestContext");
348
-
349
- const seen: Array<Record<string, unknown> | undefined> = [];
350
- configureLogger({
351
- log(_l, _m, attrs) {
352
- seen.push(attrs);
353
- },
354
- });
355
-
356
- const req = new Request("https://example.com/");
357
-
358
- await RequestContext.run(req, async () => {
359
- logger.info("uuid-stamped");
360
- });
361
-
362
- const stamped = seen[0]?.["request.id"];
363
- expect(typeof stamped).toBe("string");
364
- expect((stamped as string).length).toBeGreaterThan(8);
365
- });
366
- });
367
-
368
- describe("trace correlation", () => {
369
- afterEach(() => {
370
- configureLogger(defaultLoggerAdapter);
371
- setLogLevel("info");
372
- });
373
-
374
- it("includes trace_id/span_id when emitted inside withTracing", async () => {
375
- const { configureTracer, setObservabilitySpanStore, withTracing } = await import(
376
- "./observability"
377
- );
378
-
379
- let current: unknown = null;
380
- setObservabilitySpanStore({
381
- get: () => current as never,
382
- run<R>(value: never, fn: () => R): R {
383
- const prev = current;
384
- current = value;
385
- try {
386
- const result = fn();
387
- if (result instanceof Promise) {
388
- return result.finally(() => {
389
- current = prev;
390
- }) as unknown as R;
391
- }
392
- current = prev;
393
- return result;
394
- } catch (err) {
395
- current = prev;
396
- throw err;
397
- }
398
- },
399
- });
400
- configureTracer({
401
- startSpan: () => ({
402
- end: () => {},
403
- spanContext: () => ({
404
- traceId: "deadbeefdeadbeefdeadbeefdeadbeef",
405
- spanId: "1234567890abcdef",
406
- traceFlags: 1,
407
- }),
408
- }),
409
- });
410
-
411
- const seen: Array<Record<string, unknown> | undefined> = [];
412
- configureLogger({
413
- log(_l, _m, attrs) {
414
- seen.push(attrs);
415
- },
416
- });
417
-
418
- await withTracing("t", async () => {
419
- logger.info("inside-span", { custom: "yes" });
420
- });
421
- logger.info("outside-span", { custom: "no" });
422
-
423
- expect(seen[0]).toMatchObject({
424
- trace_id: "deadbeefdeadbeefdeadbeefdeadbeef",
425
- span_id: "1234567890abcdef",
426
- custom: "yes",
427
- });
428
- expect(seen[1]).toEqual({ custom: "no" });
429
-
430
- setObservabilitySpanStore(undefined);
431
- });
432
- });