@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,65 +0,0 @@
1
- /**
2
- * Placeholder for a future OTel-collector based exporter that ships
3
- * logs / metrics / traces from this Worker to a co-deployed OTel Collector
4
- * gateway, which in turn batches into ClickHouse.
5
- *
6
- * **NOT IMPLEMENTED in 5.0.0.** The framework today defaults to CF-native
7
- * observability: logs and traces appear in the Cloudflare dashboard
8
- * (`observability.{logs,traces}` in `wrangler.jsonc`), and metrics go to
9
- * Workers Analytics Engine. When the platform-side ClickHouse + collector
10
- * deployment lands, this file gets the real OTLP/HTTP exporter wiring back
11
- * — mirror the implementation that lived in `src/sdk/otelAdapters.ts` and
12
- * `src/sdk/sampler.ts` at the pre-5.0.0 git tag.
13
- *
14
- * The expected shape (`endpoint`, optional `headers`, optional `resource`,
15
- * `exportIntervalMillis`) is recorded here so site-side bootstrapping code
16
- * can compile against the future surface today and we don't churn the
17
- * `OtelOptions` type when the implementation lands.
18
- *
19
- * Reference: https://clickhouse.com/docs/observability/integrating-opentelemetry
20
- *
21
- * Expected wiring once implemented:
22
- * - Worker → OTLP/HTTP → OTel Collector (gateway, per region)
23
- * - Collector pipelines:
24
- * receivers[otlp] → processors[batch, memory_limiter] → exporters[clickhouse]
25
- * - The Worker uses the collector URL as `endpoint`, NOT a direct
26
- * ClickHouse URL. The collector owns the credentials, retry policy,
27
- * and schema mapping.
28
- */
29
-
30
- export interface ClickhouseCollectorOptions {
31
- /**
32
- * OTel Collector OTLP/HTTP endpoint, e.g. `https://otel-collector.internal`.
33
- * The Worker never talks to ClickHouse directly — it talks to the collector.
34
- */
35
- endpoint: string;
36
- /** Optional bearer token / mTLS identity headers — collector-defined. */
37
- headers?: Record<string, string>;
38
- /**
39
- * Resource attributes to stamp on every emitted record. Keep narrow
40
- * (`service.name`, `deco.runtime.version`, `deployment.environment`) —
41
- * higher-cardinality attributes belong on individual spans / log records.
42
- */
43
- resource?: Record<string, string>;
44
- /** Periodic metric reader push interval in ms. Defaults to 60_000 once wired. */
45
- exportIntervalMillis?: number;
46
- }
47
-
48
- /**
49
- * Returns nothing today — throws to make accidental usage loud and obvious.
50
- *
51
- * The intended return shape is `{ logger: LoggerAdapter, meter: MeterAdapter,
52
- * tracer: TracerAdapter, flush: () => Promise<void> }` so the wiring inside
53
- * `instrumentWorker` can compose this with the AE meter (dual-emit) and the
54
- * default console logger. None of that ships in 5.0.0.
55
- */
56
- export function createClickhouseCollectorAdapter(_options: ClickhouseCollectorOptions): never {
57
- throw new Error(
58
- "createClickhouseCollectorAdapter is not implemented in @decocms/start@5.x. " +
59
- "ClickHouse + OTel-collector integration is on the roadmap. " +
60
- "Until then, use Cloudflare-native observability " +
61
- "(observability.{logs,traces} in wrangler.jsonc) plus the Workers " +
62
- "Analytics Engine meter wired by instrumentWorker(). Track progress " +
63
- "at https://github.com/decocms/blocks/issues.",
64
- );
65
- }
@@ -1,89 +0,0 @@
1
- /**
2
- * Coverage for `createAnalyticsEngineMeterAdapter` and the
3
- * `setRuntimeEnv` / `getRuntimeEnv` helpers.
4
- *
5
- * As of 5.0.0 this file no longer covers `createOtelLoggerAdapter` /
6
- * `createOtelMeterAdapter` / `flushOtelProviders` — those exporters were
7
- * removed when the framework converged on Cloudflare-native log + trace
8
- * capture. AE remains the in-Worker metrics path.
9
- */
10
- import { afterEach, describe, expect, it, vi } from "vitest";
11
- import { createAnalyticsEngineMeterAdapter, setRuntimeEnv } from "./otelAdapters";
12
- import { RequestContext } from "./requestContext";
13
-
14
- describe("createAnalyticsEngineMeterAdapter", () => {
15
- afterEach(() => vi.restoreAllMocks());
16
-
17
- it("no-ops when binding is missing (does not throw)", () => {
18
- const meter = createAnalyticsEngineMeterAdapter({ bindingName: "MISSING" });
19
- expect(() => meter.counterInc("foo", 1)).not.toThrow();
20
- expect(() => meter.gaugeSet?.("bar", 5)).not.toThrow();
21
- expect(() => meter.histogramRecord?.("baz", 100)).not.toThrow();
22
- });
23
-
24
- it("writes one data point per call to the resolved binding", () => {
25
- const writeDataPoint = vi.fn();
26
- const binding = { writeDataPoint };
27
-
28
- const meter = createAnalyticsEngineMeterAdapter({ binding });
29
-
30
- meter.counterInc("deco.cache.hits", 1, { profile: "product" });
31
- meter.histogramRecord?.("http.server.request.duration", 150, {
32
- method: "GET",
33
- path: "/",
34
- status: 200,
35
- });
36
- meter.gaugeSet?.("custom_gauge", 7, { region: "gru" });
37
-
38
- expect(writeDataPoint).toHaveBeenCalledTimes(3);
39
-
40
- // Non-HTTP counter falls back to the metric name as the index.
41
- expect(writeDataPoint.mock.calls[0]?.[0].indexes).toEqual(["deco.cache.hits"]);
42
- expect(writeDataPoint.mock.calls[0]?.[0].doubles).toEqual([1]);
43
- expect(writeDataPoint.mock.calls[0]?.[0].blobs?.[0]).toBe("deco.cache.hits");
44
-
45
- // For canonical HTTP server histogram, indexes[0] must be the path.
46
- expect(writeDataPoint.mock.calls[1]?.[0].indexes).toEqual(["/"]);
47
- expect(writeDataPoint.mock.calls[1]?.[0].doubles).toEqual([150]);
48
-
49
- // Non-HTTP metrics fall back to the metric name as the index.
50
- expect(writeDataPoint.mock.calls[2]?.[0].indexes).toEqual(["custom_gauge"]);
51
- expect(writeDataPoint.mock.calls[2]?.[0].doubles).toEqual([7]);
52
- });
53
-
54
- it("resolves binding via RequestContext when not provided directly", () => {
55
- const writeDataPoint = vi.fn();
56
- const env = { DECO_METRICS: { writeDataPoint } };
57
-
58
- RequestContext.run(new Request("https://x.example/"), () => {
59
- setRuntimeEnv(env);
60
- const meter = createAnalyticsEngineMeterAdapter();
61
- // Canonical HTTP server histogram → path is promoted to index[0].
62
- meter.histogramRecord?.("http.server.request.duration", 1, { path: "/x" });
63
- expect(writeDataPoint).toHaveBeenCalledOnce();
64
- expect(writeDataPoint.mock.calls[0]?.[0].indexes).toEqual(["/x"]);
65
- });
66
- });
67
-
68
- it("never throws when binding throws", () => {
69
- const binding = {
70
- writeDataPoint: () => {
71
- throw new Error("AE down");
72
- },
73
- };
74
- const meter = createAnalyticsEngineMeterAdapter({ binding });
75
- expect(() => meter.counterInc("x", 1)).not.toThrow();
76
- });
77
-
78
- it("orders blob columns deterministically by sorted label keys", () => {
79
- const writeDataPoint = vi.fn();
80
- const binding = { writeDataPoint };
81
- const meter = createAnalyticsEngineMeterAdapter({ binding });
82
-
83
- meter.counterInc("metric", 1, { z: "last", a: "first", m: "mid" });
84
-
85
- const blobs = writeDataPoint.mock.calls[0]?.[0].blobs as string[];
86
- // blobs[0] is metric name; remaining must follow sorted label-key order: a, m, z
87
- expect(blobs).toEqual(["metric", "first", "mid", "last"]);
88
- });
89
- });
@@ -1,144 +0,0 @@
1
- /**
2
- * Metric adapters for `@decocms/start`.
3
- *
4
- * The OTLP logger and OTLP meter adapters that lived here through 4.x were
5
- * removed in 5.0.0. The framework now relies on:
6
- * - Cloudflare's platform-managed log capture (`console.*` → CF dashboard
7
- * via `observability.logs`) for log shipping
8
- * - Cloudflare's auto-instrumented + global-tracer-bridged trace export
9
- * (`observability.traces`) for trace shipping
10
- * - Workers Analytics Engine — implemented in this file — for metrics
11
- *
12
- * Forwarding to a co-deployed OTel collector (the path to ClickHouse)
13
- * lives in `./otelAdapters/clickhouseCollector.ts`. That file is a
14
- * documented stub today; the implementation will reintroduce a thin
15
- * OTLP/HTTP exporter aimed at the collector — never directly at a
16
- * destination — when the collector is deployed.
17
- *
18
- * The `setRuntimeEnv` / `getRuntimeEnv` helpers stay here because
19
- * `workerEntry.ts` and the AE adapter both depend on them.
20
- */
21
-
22
- import type { MeterAdapter } from "../middleware/observability";
23
- import { MetricNames } from "../middleware/observability";
24
- import { RequestContext } from "./requestContext";
25
-
26
- // ---------------------------------------------------------------------------
27
- // Env / binding access
28
- // ---------------------------------------------------------------------------
29
-
30
- /**
31
- * Per-request access to the Cloudflare Worker `env` bag. Stashed by
32
- * `workerEntry.ts` at the top of every request via
33
- * `RequestContext.setBag("__deco_env", env)`.
34
- *
35
- * Adapters use this to look up the AE binding (or any future binding-driven
36
- * destination) without forcing site code to thread `env` through every
37
- * call site.
38
- */
39
- const ENV_BAG_KEY = "__deco_env";
40
-
41
- export function setRuntimeEnv(env: Record<string, unknown>): void {
42
- RequestContext.setBag(ENV_BAG_KEY, env);
43
- }
44
-
45
- export function getRuntimeEnv(): Record<string, unknown> | undefined {
46
- return RequestContext.getBag<Record<string, unknown>>(ENV_BAG_KEY);
47
- }
48
-
49
- // ---------------------------------------------------------------------------
50
- // AnalyticsEngineMeterAdapter
51
- // ---------------------------------------------------------------------------
52
-
53
- /**
54
- * Workers Analytics Engine binding shape. Defined here so we don't need
55
- * `@cloudflare/workers-types` as a dep.
56
- */
57
- export interface AnalyticsEngineDataset {
58
- writeDataPoint(point: { indexes?: string[]; blobs?: string[]; doubles?: number[] }): void;
59
- }
60
-
61
- export interface AnalyticsEngineMeterAdapterOptions {
62
- /** Env var name holding the AE binding. Defaults to "DECO_METRICS". */
63
- bindingName?: string;
64
- /** Pre-resolved binding (mainly for tests). Bypasses RequestContext lookup. */
65
- binding?: AnalyticsEngineDataset;
66
- }
67
-
68
- /**
69
- * Writes one Analytics Engine data point per metric call.
70
- *
71
- * Schema (must stay stable — dashboards and SQL queries depend on it):
72
- * - `indexes[0]`: a low-cardinality dimension. For request metrics that's
73
- * the normalized URL path; for cache/resolve metrics that's the metric
74
- * name itself.
75
- * - `blobs[0]`: metric name (so a single dataset can hold many metrics).
76
- * - `blobs[1..]`: stringified label values, in stable label-name order.
77
- * - `doubles[0]`: the metric value (count, ms, gauge value).
78
- *
79
- * AE truncates / charges per data point, so this adapter is intentionally
80
- * coarse: one point per `counterInc` / `histogramRecord` / `gaugeSet`.
81
- */
82
- export function createAnalyticsEngineMeterAdapter(
83
- options: AnalyticsEngineMeterAdapterOptions = {},
84
- ): MeterAdapter {
85
- const bindingName = options.bindingName ?? "DECO_METRICS";
86
-
87
- function resolveBinding(): AnalyticsEngineDataset | null {
88
- if (options.binding) return options.binding;
89
- const env = getRuntimeEnv();
90
- const b = env?.[bindingName] as AnalyticsEngineDataset | undefined;
91
- return b ?? null;
92
- }
93
-
94
- function write(name: string, value: number, labels?: Record<string, unknown>): void {
95
- const binding = resolveBinding();
96
- if (!binding) return; // No-op when binding is missing — never throw.
97
-
98
- const indexValue = pickIndex(name, labels);
99
- const blobs: string[] = [name];
100
- if (labels) {
101
- // Stable order — sort keys so the same blob index always means the
102
- // same label across requests. AE has no schema; we enforce one here.
103
- const keys = Object.keys(labels).sort();
104
- for (const k of keys) {
105
- const v = labels[k];
106
- if (v !== undefined && v !== null) blobs.push(String(v));
107
- }
108
- }
109
-
110
- try {
111
- binding.writeDataPoint({
112
- indexes: indexValue ? [indexValue] : undefined,
113
- blobs,
114
- doubles: [value],
115
- });
116
- } catch {
117
- /* AE write failed — never fail the request */
118
- }
119
- }
120
-
121
- return {
122
- counterInc(name, value, labels) {
123
- write(name, value ?? 1, labels);
124
- },
125
- histogramRecord(name, value, labels) {
126
- write(name, value, labels);
127
- },
128
- gaugeSet(name, value, labels) {
129
- write(name, value, labels);
130
- },
131
- };
132
- }
133
-
134
- function pickIndex(metricName: string, labels?: Record<string, unknown>): string | undefined {
135
- if (!labels) return metricName;
136
- // For HTTP request metrics the natural index is the path (matches the
137
- // schema: `indexes[0]=path`). For other metrics, fall back to the metric
138
- // name so the dataset is always queryable by index.
139
- if (metricName === MetricNames.HTTP_SERVER_REQUEST_DURATION) {
140
- const p = labels.path;
141
- if (typeof p === "string" && p.length > 0) return p;
142
- }
143
- return metricName;
144
- }