@heystack/otel 0.3.3 → 0.3.5

package/README.md

@@ -157,6 +157,9 @@ As belt-and-suspenders the exporter also drops any span whose HTTP target points
 
 ## Migration / versioning
 
+- **`0.3.5`** — **type-constraint fix (Workers).** A Worker whose `queue` consumer is typed with a concrete message body — `queue(batch: MessageBatch<MyJob>, …)`, the normal case — failed to compile against `instrument()` in 0.3.4 (`TS2345`: `MessageBatch<unknown>` not assignable to `MessageBatch<MyJob>`). The `WorkerHandler` constraint declared its entrypoints as arrow properties, whose parameters are checked **contravariantly** under `strictFunctionTypes`, so a narrowed handler wasn't assignable. 0.3.5 declares them with **method syntax** (bivariant parameters) and widens the batch to `MessageBatch<any>`, mirroring Cloudflare's own `ExportedHandler` — a typed-queue Worker now type-checks with a bare `instrument(handler, cfg)`. Runtime behaviour unchanged. Also adds a **consumer type-check gate** (`pnpm consumer-typecheck`, run in `check` and `prepublishOnly`) that compiles a fully-typed Worker against the built `dist` through the public `exports` map and asserts `satisfies ExportedHandler<Env>` — the regression that escaped in 0.3.3/0.3.4 now fails the build before publish.
+- **`0.3.4`** — **type-inference fix (Workers).** Restores `instrument()`'s ability to infer the handler's concrete `Env` type. In 0.3.3 the signature was `instrument<E = unknown, H extends WorkerHandler<E>>`, so `E` defaulted to `unknown` and was never recovered from the handler — under `strictFunctionTypes` a Worker typed `fetch(req, env: Env, ctx)` then failed to compile (`TS2345: 'Env' is not assignable to 'unknown'`) unless the caller passed `instrument<Env>(...)` explicitly. 0.3.4 infers `E` from the handler argument (`instrument<H extends WorkerHandler<any>>(...): Instrumented<EnvOf<H>, H>`), so a bare `instrument(handler, cfg)` type-checks again. Runtime behaviour is unchanged; no `0.3.3` consumer needs the explicit type arg after upgrading.
+- **`0.3.3`** — `/next` uses bare, exports-mapped dynamic imports so the OpenNext (Cloudflare Pages) build resolves the workers entry correctly (fixes a build break). Workers/Node paths unchanged.
 - **`0.3.2`** — runtime-correctness fixes:
   - **ContextManager registered (CRITICAL).** 0.3.1's `suppressTracing` was a no-op because no ContextManager was registered, so the exporter's ingest POST could still be re-traced into a feedback loop. 0.3.2 registers an `AsyncLocalStorageContextManager` (Node + workerd under `nodejs_compat`; sync stack-manager fallback otherwise) so suppression works — and as a bonus you get cross-`await` span parenting + per-request context isolation. **Workers now require `nodejs_compat`.** New dependency: `@opentelemetry/context-async-hooks`.
   - **Hostname-accurate self-span filter** (no sibling-domain false positives; `host:port` now matched; more host-only attrs covered).

package/dist/workers.d.ts

@@ -197,9 +197,9 @@ export declare function __resetWarnings(): void;
  * a Worker never drops a handler Cloudflare requires for deploy.
  */
 interface WorkerHandler<E> {
-    fetch?: (req: Request, env: E, ctx: ExecutionContext) => Promise<Response> | Response;
-    queue?: (batch: MessageBatch, env: E, ctx: ExecutionContext) => Promise<void> | void;
-    scheduled?: (controller: ScheduledController, env: E, ctx: ExecutionContext) => Promise<void> | void;
+    fetch?(req: Request, env: E, ctx: ExecutionContext): Promise<Response> | Response;
+    queue?(batch: MessageBatch<any>, env: E, ctx: ExecutionContext): Promise<void> | void;
+    scheduled?(controller: ScheduledController, env: E, ctx: ExecutionContext): Promise<void> | void;
     [key: string]: unknown;
 }
 /**
@@ -253,5 +253,20 @@ type Instrumented<E, H> = Omit<H, "fetch" | "queue" | "scheduled"> & (H extends
 } ? {
     scheduled: (controller: ScheduledController, env: E, ctx: ExecutionContext) => Promise<void>;
 } : unknown);
-export declare function instrument<E = unknown, H extends WorkerHandler<E> = WorkerHandler<E>>(handler: H, config: WorkersConfig): Instrumented<E, H>;
+/**
+ * Recover a handler's concrete env type from whichever traced entrypoint it
+ * declares (`fetch`, else `queue`, else `scheduled`). This lets `instrument()`
+ * infer the env from the handler argument itself rather than requiring the
+ * caller to pass it explicitly — a Worker typed `fetch(req, env: Env, ctx)`
+ * type-checks with a bare `instrument(handler, cfg)` call. Falls back to
+ * `unknown` for a handler with no recognised entrypoint.
+ */
+type EnvOf<H> = H extends {
+    fetch: (req: Request, env: infer E, ctx: ExecutionContext) => unknown;
+} ? E : H extends {
+    queue: (batch: MessageBatch, env: infer E, ctx: ExecutionContext) => unknown;
+} ? E : H extends {
+    scheduled: (controller: ScheduledController, env: infer E, ctx: ExecutionContext) => unknown;
+} ? E : unknown;
+export declare function instrument<H extends WorkerHandler<any>>(handler: H, config: WorkersConfig): Instrumented<EnvOf<H>, H>;
 export type { Span };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heystack/otel",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Runtime-aware OpenTelemetry tracing that exports to Heystack (Node, Next.js, Workers).",
   "license": "MIT",
   "type": "module",
@@ -19,8 +19,9 @@
     "test": "vitest run",
     "typecheck": "tsc --noEmit",
     "validate": "node scripts/validate-entries.mjs",
-    "check": "pnpm typecheck && pnpm build && pnpm validate && pnpm test",
-    "prepublishOnly": "pnpm build && pnpm validate"
+    "consumer-typecheck": "node scripts/consumer-typecheck.mjs",
+    "check": "pnpm typecheck && pnpm build && pnpm validate && pnpm consumer-typecheck && pnpm test",
+    "prepublishOnly": "pnpm build && pnpm validate && pnpm consumer-typecheck"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",