@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,61 +0,0 @@
1
- import { describe, expect, it } from "vitest";
2
- import { buildHydrationContext } from "./hydrationContext";
3
-
4
- function makeRequest(headers: Record<string, string> = {}): Request {
5
- return new Request("https://store.com/", { headers });
6
- }
7
-
8
- describe("buildHydrationContext", () => {
9
- it("extracts locale and timezone from cookies", () => {
10
- const req = makeRequest({ cookie: "locale=pt-BR; tz=America/Sao_Paulo" });
11
- const ctx = buildHydrationContext(req);
12
- expect(ctx.locale).toBe("pt-BR");
13
- expect(ctx.timeZone).toBe("America/Sao_Paulo");
14
- });
15
-
16
- it("falls back to Accept-Language when no locale cookie", () => {
17
- const req = makeRequest({ "accept-language": "pt-BR,pt;q=0.9,en;q=0.8" });
18
- const ctx = buildHydrationContext(req);
19
- expect(ctx.locale).toBe("pt-BR");
20
- });
21
-
22
- it("defaults to en-US and UTC when no headers or cookies", () => {
23
- const req = makeRequest();
24
- const ctx = buildHydrationContext(req);
25
- expect(ctx.locale).toBe("en-US");
26
- expect(ctx.timeZone).toBe("UTC");
27
- });
28
-
29
- it("extracts country from cf-ipcountry header", () => {
30
- const req = makeRequest({ "cf-ipcountry": "BR" });
31
- const ctx = buildHydrationContext(req);
32
- expect(ctx.country).toBe("BR");
33
- });
34
-
35
- it("extracts country from cookie when no cf header", () => {
36
- const req = makeRequest({ cookie: "country=US" });
37
- const ctx = buildHydrationContext(req);
38
- expect(ctx.country).toBe("US");
39
- });
40
-
41
- it("country is undefined when not available", () => {
42
- const req = makeRequest();
43
- const ctx = buildHydrationContext(req);
44
- expect(ctx.country).toBeUndefined();
45
- });
46
-
47
- it("cf-ipcountry takes precedence over cookie", () => {
48
- const req = makeRequest({
49
- "cf-ipcountry": "BR",
50
- cookie: "country=US",
51
- });
52
- const ctx = buildHydrationContext(req);
53
- expect(ctx.country).toBe("BR");
54
- });
55
-
56
- it("handles cookies with = in values", () => {
57
- const req = makeRequest({ cookie: "locale=en-US; token=abc=def=ghi" });
58
- const ctx = buildHydrationContext(req);
59
- expect(ctx.locale).toBe("en-US");
60
- });
61
- });
@@ -1,79 +0,0 @@
1
- /**
2
- * Hydration context utilities for consistent SSR/client rendering.
3
- *
4
- * Provides patterns for extracting locale, timezone, and other
5
- * request-specific data that must be consistent between server
6
- * and client to avoid hydration mismatches.
7
- *
8
- * @example
9
- * ```tsx
10
- * // In your storefront's middleware.ts:
11
- * import { createMiddleware } from "@tanstack/react-start";
12
- * import { buildHydrationContext } from "@decocms/start/middleware/hydrationContext";
13
- *
14
- * export const hydrationMiddleware = createMiddleware().server(async ({ request, next }) => {
15
- * const hydrationCtx = buildHydrationContext(request);
16
- * return next({ context: { hydration: hydrationCtx } });
17
- * });
18
- * ```
19
- *
20
- * Then in components:
21
- * ```tsx
22
- * // Use the cookie-based values for deterministic SSR rendering
23
- * const locale = hydrationCtx.locale; // same on server and client
24
- * ```
25
- */
26
-
27
- export interface HydrationContext {
28
- /** Locale from cookie or Accept-Language header. */
29
- locale: string;
30
- /** Timezone from cookie. Falls back to "UTC" for deterministic SSR. */
31
- timeZone: string;
32
- /** Country code from Cloudflare headers or cookie. */
33
- country?: string;
34
- }
35
-
36
- /**
37
- * Build hydration context from a request.
38
- *
39
- * Values are extracted from cookies first (set by the client on first visit),
40
- * then from headers. Cookie-based values are deterministic because the same
41
- * cookie is sent on both SSR and client-side navigations.
42
- *
43
- * Recommended: set these cookies on first client render:
44
- * ```tsx
45
- * useEffect(() => {
46
- * const tz = Intl.DateTimeFormat().resolvedOptions().timeZone;
47
- * document.cookie = `tz=${tz}; path=/; max-age=31536000; SameSite=Lax`;
48
- * document.cookie = `locale=${navigator.language}; path=/; max-age=31536000; SameSite=Lax`;
49
- * }, []);
50
- * ```
51
- */
52
- export function buildHydrationContext(request: Request): HydrationContext {
53
- const cookies = parseCookies(request.headers.get("cookie") ?? "");
54
-
55
- // Locale: cookie → Accept-Language → fallback
56
- const locale =
57
- cookies.locale ||
58
- request.headers.get("accept-language")?.split(",")[0]?.split(";")[0]?.trim() ||
59
- "en-US";
60
-
61
- // Timezone: cookie → UTC fallback (never guess — causes hydration mismatch)
62
- const timeZone = cookies.tz || "UTC";
63
-
64
- // Country: Cloudflare header → cookie
65
- const country =
66
- request.headers.get("cf-ipcountry") || cookies.country || undefined;
67
-
68
- return { locale, timeZone, country };
69
- }
70
-
71
- function parseCookies(cookieHeader: string): Record<string, string> {
72
- const cookies: Record<string, string> = {};
73
- for (const part of cookieHeader.split(";")) {
74
- const [key, ...rest] = part.split("=");
75
- const k = key?.trim();
76
- if (k) cookies[k] = rest.join("=").trim();
77
- }
78
- return cookies;
79
- }
@@ -1,88 +0,0 @@
1
- /**
2
- * Deco middleware utilities for TanStack Start.
3
- *
4
- * These are NOT TanStack `createMiddleware()` instances because
5
- * `@decocms/start` doesn't depend on `@tanstack/react-start`.
6
- * Instead, they export composable handler functions that storefronts
7
- * wire into their own `createMiddleware()` chain.
8
- *
9
- * @example
10
- * ```ts
11
- * // In your storefront's middleware.ts
12
- * import { createMiddleware } from "@tanstack/react-start";
13
- * import { buildDecoState, handleLiveness, applyServerTiming, applyCorsHeaders } from "@decocms/start/middleware";
14
- *
15
- * export const decoMiddleware = createMiddleware().server(async ({ request, next }) => {
16
- * const liveness = handleLiveness(request);
17
- * if (liveness) return { result: undefined, response: liveness };
18
- *
19
- * const state = buildDecoState(request, "my-site");
20
- * const endTotal = state.timings.start("total");
21
- *
22
- * const result = await next();
23
- *
24
- * endTotal();
25
- * applyServerTiming(result.response, state);
26
- * if (state.isAdmin) applyCorsHeaders(result.response, request);
27
- *
28
- * return result;
29
- * });
30
- * ```
31
- */
32
-
33
- export {
34
- type CacheDecision,
35
- configureMeter,
36
- configureTracer,
37
- getActiveSpan,
38
- getMeter,
39
- getTracer,
40
- injectTraceContext,
41
- logRequest,
42
- type MeterAdapter,
43
- MetricNames,
44
- recordCacheMetric,
45
- recordRequestMetric,
46
- type Span,
47
- setSpanAttribute,
48
- type TracerAdapter,
49
- withTracing,
50
- } from "../sdk/observability";
51
- export { buildDecoState, type DecoState } from "./decoState";
52
- export {
53
- getHealthMetrics,
54
- type HealthMetrics,
55
- handleHealthCheck,
56
- trackRequest,
57
- } from "./healthMetrics";
58
- export { buildHydrationContext, type HydrationContext } from "./hydrationContext";
59
- export { handleLiveness } from "./liveness";
60
- export {
61
- createSectionValidator,
62
- type DeferredSectionInput,
63
- validateDeferredSectionInput,
64
- } from "./validateSection";
65
-
66
- /**
67
- * Appends Server-Timing header to a response from the accumulated timings.
68
- */
69
- export function applyServerTiming(response: Response, state: { timings: { toHeader(): string } }) {
70
- const header = state.timings.toHeader();
71
- if (header) {
72
- response.headers.append("Server-Timing", header);
73
- }
74
- }
75
-
76
- /**
77
- * Applies CORS headers for deco admin origins to a response.
78
- */
79
- export function applyCorsHeaders(response: Response, request: Request) {
80
- const origin = request.headers.get("origin") || "*";
81
- response.headers.set("Access-Control-Allow-Origin", origin);
82
- response.headers.set("Access-Control-Allow-Methods", "GET, POST, OPTIONS");
83
- response.headers.set(
84
- "Access-Control-Allow-Headers",
85
- "Content-Type, Authorization, If-None-Match",
86
- );
87
- response.headers.set("Access-Control-Allow-Credentials", "true");
88
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * Liveness and readiness probe handlers.
3
- *
4
- * - `/_liveness` — simple 200 OK for load balancers (K8s, Cloudflare)
5
- * - `/deco/_health` — detailed JSON health metrics (delegated to healthMetrics)
6
- */
7
-
8
- import { handleHealthCheck } from "./healthMetrics";
9
-
10
- export function handleLiveness(request: Request): Response | null {
11
- const url = new URL(request.url);
12
-
13
- if (url.pathname === "/_liveness" || url.pathname === "/deco/_liveness") {
14
- return new Response("OK", {
15
- status: 200,
16
- headers: { "Content-Type": "text/plain", "Cache-Control": "no-store" },
17
- });
18
- }
19
-
20
- return handleHealthCheck(request);
21
- }
@@ -1,242 +0,0 @@
1
- /**
2
- * Phase 2 (D-11) coverage for the metric surface — canonical label set,
3
- * cache_layer, commerce_request_duration_ms. The Phase 1 logger/trace
4
- * tests live under `src/sdk/logger.test.ts` and `src/sdk/otel.test.ts`;
5
- * this file focuses on the middleware-level helpers.
6
- */
7
- import { afterEach, beforeEach, describe, expect, it } from "vitest";
8
- import {
9
- configureMeter,
10
- type MeterAdapter,
11
- MetricNames,
12
- recordCacheMetric,
13
- recordCommerceMetric,
14
- recordRequestMetric,
15
- statusClassFor,
16
- } from "./observability";
17
-
18
- interface Counter {
19
- name: string;
20
- value: number;
21
- labels?: Record<string, unknown>;
22
- }
23
- interface Histogram {
24
- name: string;
25
- value: number;
26
- labels?: Record<string, unknown>;
27
- }
28
-
29
- function captureMeter(): {
30
- adapter: MeterAdapter;
31
- counters: Counter[];
32
- histograms: Histogram[];
33
- } {
34
- const counters: Counter[] = [];
35
- const histograms: Histogram[] = [];
36
- const adapter: MeterAdapter = {
37
- counterInc(name, value, labels) {
38
- counters.push({ name, value: value ?? 1, labels });
39
- },
40
- histogramRecord(name, value, labels) {
41
- histograms.push({ name, value, labels });
42
- },
43
- };
44
- return { adapter, counters, histograms };
45
- }
46
-
47
- describe("statusClassFor", () => {
48
- it("maps 2xx / 3xx / 4xx / 5xx to canonical class labels", () => {
49
- expect(statusClassFor(200)).toBe("2xx");
50
- expect(statusClassFor(204)).toBe("2xx");
51
- expect(statusClassFor(301)).toBe("3xx");
52
- expect(statusClassFor(404)).toBe("4xx");
53
- expect(statusClassFor(500)).toBe("5xx");
54
- expect(statusClassFor(503)).toBe("5xx");
55
- });
56
-
57
- it("returns 'unknown' for out-of-range / NaN / non-numeric inputs", () => {
58
- expect(statusClassFor(-1)).toBe("unknown");
59
- expect(statusClassFor(99)).toBe("unknown");
60
- expect(statusClassFor(600)).toBe("unknown");
61
- expect(statusClassFor(Number.NaN)).toBe("unknown");
62
- expect(statusClassFor(Infinity)).toBe("unknown");
63
- });
64
- });
65
-
66
- describe("recordRequestMetric — canonical labels (D-11)", () => {
67
- afterEach(() => {
68
- // Reset meter so other tests start clean.
69
- configureMeter({ counterInc: () => {} });
70
- });
71
-
72
- it("stamps method + route_pattern + status + status_class by default", () => {
73
- const { adapter, counters, histograms } = captureMeter();
74
- configureMeter(adapter);
75
-
76
- recordRequestMetric("GET", "/products/abc123/p", 200, 42);
77
-
78
- // Canonical OTel HTTP server metric is histogram-only; the count
79
- // dimension is derived from the histogram's bucket counts at query
80
- // time, so we no longer emit a parallel `_total` counter.
81
- expect(counters).toHaveLength(0);
82
- expect(histograms).toHaveLength(1);
83
- expect(histograms[0]?.name).toBe(MetricNames.HTTP_SERVER_REQUEST_DURATION);
84
- expect(histograms[0]?.value).toBe(0.042); // seconds (semconv)
85
- expect(histograms[0]?.labels).toMatchObject({
86
- "http.request.method": "GET",
87
- // Default normalization: dynamic segments collapsed.
88
- "http.route": "/products/:slug/p",
89
- "http.response.status_code": 200,
90
- "deco.http.status_class": "2xx",
91
- });
92
- });
93
-
94
- it("prefers caller-supplied route_pattern over normalized path", () => {
95
- const { adapter, histograms } = captureMeter();
96
- configureMeter(adapter);
97
-
98
- recordRequestMetric("GET", "/anything/random/123", 200, 5, {
99
- route_pattern: "/_products/$slug/p",
100
- });
101
-
102
- expect(histograms[0]?.labels?.["http.route"]).toBe("/_products/$slug/p");
103
- });
104
-
105
- it("tags 5xx requests with status_class=5xx for downstream error filtering", () => {
106
- const { adapter, histograms } = captureMeter();
107
- configureMeter(adapter);
108
-
109
- recordRequestMetric("POST", "/checkout", 503, 120);
110
-
111
- expect(histograms[0]?.labels?.["deco.http.status_class"]).toBe("5xx");
112
- expect(histograms[0]?.labels?.["http.response.status_code"]).toBe(503);
113
- });
114
-
115
- it("propagates optional labels (outcome, cache_decision, cache_layer, region, extra)", () => {
116
- const { adapter, histograms } = captureMeter();
117
- configureMeter(adapter);
118
-
119
- recordRequestMetric("GET", "/", 200, 10, {
120
- outcome: "ok",
121
- cache_decision: "STALE-HIT",
122
- cache_layer: "edge",
123
- region: "GRU",
124
- extra: { ab_variant: "B" },
125
- });
126
-
127
- expect(histograms[0]?.labels).toMatchObject({
128
- "deco.http.outcome": "ok",
129
- "deco.cache.decision": "STALE-HIT",
130
- "deco.cache.layer": "edge",
131
- "deco.http.region": "GRU",
132
- ab_variant: "B",
133
- });
134
- });
135
-
136
- it("is a no-op when no meter is configured", () => {
137
- // We can't easily prove a no-op other than verifying no throw —
138
- // safer than calling configureMeter(null), which would mask real
139
- // bugs. The previous test's `afterEach` reset already gives us a
140
- // bare meter; this test confirms the call is benign.
141
- expect(() => recordRequestMetric("GET", "/", 200, 1)).not.toThrow();
142
- });
143
- });
144
-
145
- describe("recordCacheMetric — cache_layer label", () => {
146
- beforeEach(() => {
147
- configureMeter({ counterInc: () => {} });
148
- });
149
-
150
- it("stamps profile + decision + layer when all are provided", () => {
151
- const { adapter, counters } = captureMeter();
152
- configureMeter(adapter);
153
-
154
- recordCacheMetric(true, "product", "HIT", "edge");
155
-
156
- expect(counters).toHaveLength(1);
157
- expect(counters[0]?.name).toBe(MetricNames.CACHE_REQUESTS);
158
- expect(counters[0]?.labels).toMatchObject({
159
- "deco.cache.profile": "product",
160
- "deco.cache.status": "HIT",
161
- "deco.cache.layer": "edge",
162
- });
163
- });
164
-
165
- it("records status=MISS when hit=false", () => {
166
- const { adapter, counters } = captureMeter();
167
- configureMeter(adapter);
168
-
169
- recordCacheMetric(false, "search", "MISS", "edge");
170
-
171
- expect(counters[0]?.name).toBe(MetricNames.CACHE_REQUESTS);
172
- expect(counters[0]?.labels?.["deco.cache.status"]).toBe("MISS");
173
- });
174
-
175
- it("supports the legacy 3-arg signature for backward compat", () => {
176
- const { adapter, counters } = captureMeter();
177
- configureMeter(adapter);
178
-
179
- recordCacheMetric(true, "static");
180
-
181
- expect(counters[0]?.labels).toEqual({
182
- "deco.cache.status": "HIT",
183
- "deco.cache.profile": "static",
184
- });
185
- });
186
-
187
- it("distinguishes cachedLoader vs edge vs vtex-swr layers", () => {
188
- const { adapter, counters } = captureMeter();
189
- configureMeter(adapter);
190
-
191
- recordCacheMetric(true, "loader-x", "HIT", "cachedLoader");
192
- recordCacheMetric(true, "vtex-product", "HIT", "vtex-swr");
193
-
194
- expect(counters[0]?.labels?.["deco.cache.layer"]).toBe("cachedLoader");
195
- expect(counters[1]?.labels?.["deco.cache.layer"]).toBe("vtex-swr");
196
- });
197
- });
198
-
199
- describe("recordCommerceMetric (D-11)", () => {
200
- beforeEach(() => {
201
- configureMeter({ counterInc: () => {} });
202
- });
203
-
204
- it("emits http.client.request.duration with provider + operation labels", () => {
205
- const { adapter, histograms } = captureMeter();
206
- configureMeter(adapter);
207
-
208
- recordCommerceMetric(123, {
209
- provider: "vtex",
210
- operation: "intelligent-search.product_search",
211
- status_class: "2xx",
212
- });
213
-
214
- expect(histograms).toHaveLength(1);
215
- expect(histograms[0]?.name).toBe(MetricNames.HTTP_CLIENT_REQUEST_DURATION);
216
- expect(histograms[0]?.value).toBe(0.123); // seconds (semconv)
217
- expect(histograms[0]?.labels).toMatchObject({
218
- provider: "vtex",
219
- operation: "intelligent-search.product_search",
220
- status_class: "2xx",
221
- });
222
- });
223
-
224
- it("includes the cached boolean when provided", () => {
225
- const { adapter, histograms } = captureMeter();
226
- configureMeter(adapter);
227
-
228
- recordCommerceMetric(5, {
229
- provider: "shopify",
230
- operation: "graphql.cart_query",
231
- cached: true,
232
- });
233
-
234
- expect(histograms[0]?.labels?.cached).toBe(true);
235
- });
236
-
237
- it("is a no-op when no meter is configured", () => {
238
- expect(() =>
239
- recordCommerceMetric(1, { provider: "vtex", operation: "test" }),
240
- ).not.toThrow();
241
- });
242
- });