@devries-cameron20 / t3code-1 / commits / ec844a3995
Fork 0

The best way to control Claude Code, Codex and more from any computer or phone

fix(client-runtime): omit machine labels from relay spans (#30940)

Co-authored-by: Julius Marminge <julius0216@outlook.com>

hari committed Nov 15, 2026 at 06:30 UTC ec844a39951cd1cf1d5fbafe5d3f242dae490c3e
4 files changed +90 -32
packages/client-runtime/src/connection/supervisor.test.ts
+21 -1
@@ -5,6 +5,7 @@ import {
5 type ServerConfigStreamEvent,
6 } from "@t3tools/contracts";
7 import { describe, expect, it } from "@effect/vitest";
8 +import { RelayClientTracer } from "@t3tools/shared/relayTracing";
9 import * as Deferred from "effect/Deferred";
10 import * as Effect from "effect/Effect";
11 import * as Fiber from "effect/Fiber";
@@ -17,6 +18,7 @@ import * as Stream from "effect/Stream";
18 import * as SubscriptionRef from "effect/SubscriptionRef";
19 import * as Clock from "effect/Clock";
20 import * as TestClock from "effect/testing/TestClock";
21 +import * as Tracer from "effect/Tracer";
22
23 import * as RemoteEnvironmentAuthorization from "../authorization/service.ts";
24 import * as TokenStore from "../authorization/tokenStore.ts";
@@ -1561,12 +1563,23 @@ describe("EnvironmentSupervisor", () => {
1563
1564 it.effect("releases and reconnects a relay session when credentials change", () =>
1565 Effect.gen(function* () {
1566 + const relaySpans: Array<Tracer.NativeSpan> = [];
1567 + const relayTracer = Tracer.make({
1568 + span(options) {
1569 + const span = new Tracer.NativeSpan(options);
1570 + relaySpans.push(span);
1571 + return span;
1572 + },
1573 + });
1574 const harness = yield* makeHarness({
1575 prepare: () => Effect.succeed(preparedFor(RELAY_TARGET)),
1576 });
1577 const supervisor = yield* EnvironmentSupervisor.make(RELAY_ENTRY, {
1578 initiallyDesired: true,
1569 - }).pipe(Effect.provide(harness.dependencies));
1579 + }).pipe(
1580 + Effect.provide(harness.dependencies),
1581 + Effect.provideService(RelayClientTracer, Option.some(relayTracer)),
1582 + );
1583
1584 yield* awaitState(supervisor.state, (state) => state.phase === "connected");
1585 yield* harness.wake("credentials-changed");
@@ -1577,6 +1590,13 @@ describe("EnvironmentSupervisor", () => {
1590
1591 expect(yield* Ref.get(harness.sessionCount)).toBe(2);
1592 expect(yield* Ref.get(harness.releaseCount)).toBe(1);
1593 + const attempts = relaySpans.filter((span) => span.name === "relay.connection.attempt");
1594 + expect(attempts).toHaveLength(2);
1595 + for (const span of attempts) {
1596 + expect(span.attributes.get("environment.id")).toBe(RELAY_TARGET.environmentId);
1597 + expect(span.attributes.get("environment.target.kind")).toBe(RELAY_TARGET._tag);
1598 + expect(span.attributes.has("environment.label")).toBe(false);
1599 + }
1600 }),
1601 );
1602
packages/client-runtime/src/connection/supervisor.ts
+2 -1
@@ -528,8 +528,9 @@ export const make = Effect.fn("EnvironmentSupervisor.make")(function* (
528 let attemptSpan = Option.none<Tracer.Span>();
529 const traced = Effect.gen(function* () {
530 attemptSpan = Option.some(yield* Effect.currentSpan.pipe(Effect.orDie));
531 - yield* annotateTarget(target);
531 yield* Effect.annotateCurrentSpan({
532 + "environment.id": target.environmentId,
533 + "environment.target.kind": target._tag,
534 "connection.attempt": attempt,
535 "connection.generation": generation,
536 "connection.retry.failure_count": Option.match(pendingRetry, {
packages/shared/src/relayTracing.test.ts
+47 -1
@@ -1,9 +1,16 @@
1 import { describe, expect, it } from "@effect/vitest";
2 +import * as Cause from "effect/Cause";
3 import * as Effect from "effect/Effect";
4 +import * as Exit from "effect/Exit";
5 import * as Option from "effect/Option";
6 import * as Tracer from "effect/Tracer";
7
6 -import { RelayClientTracer, withLocalTracing, withRelayClientTracing } from "./relayTracing.ts";
8 +import {
9 + nonInterferingTracer,
10 + RelayClientTracer,
11 + withLocalTracing,
12 + withRelayClientTracing,
13 +} from "./relayTracing.ts";
14
15 function collectingTracer(spans: Array<string>): Tracer.Tracer {
16 return Tracer.make({
@@ -41,6 +48,45 @@ describe("withRelayClientTracing", () => {
48 );
49 });
50
51 +describe("nonInterferingTracer", () => {
52 + it.effect("exports failures without their messages", () =>
53 + Effect.gen(function* () {
54 + const exits: Array<Exit.Exit<unknown, unknown>> = [];
55 + const delegate = Tracer.make({
56 + span: (options) => {
57 + const span = new Tracer.NativeSpan(options);
58 + const end = span.end.bind(span);
59 + span.end = (endTime, exit) => {
60 + end(endTime, exit);
61 + exits.push(exit);
62 + };
63 + return span;
64 + },
65 + });
66 + const failure = Object.assign(
67 + new Error("studio-mac could not establish a WebSocket connection.", {
68 + cause: new Error("connect ECONNREFUSED studio-mac.local"),
69 + }),
70 + { name: "ConnectionTransientError" },
71 + );
72 +
73 + yield* Effect.fail(failure).pipe(
74 + Effect.withSpan("relay.connection.attempt"),
75 + Effect.withTracer(nonInterferingTracer(delegate)),
76 + Effect.ignore,
77 + );
78 +
79 + const exit = exits[0];
80 + if (exit === undefined || !Exit.isFailure(exit)) throw new Error("expected a failed span");
81 + const exported = Cause.prettyErrors(exit.cause);
82 + expect(exported.map((error) => error.name)).toEqual(["ConnectionTransientError"]);
83 + const text = exported.map((error) => `${error.message}\n${error.stack}`).join("\n");
84 + expect(text).toContain("Caused by: Error");
85 + expect(text).not.toContain("studio-mac");
86 + }),
87 + );
88 +});
89 +
90 describe("withLocalTracing", () => {
91 it.effect("keeps local work inside a relay span off the product tracer", () =>
92 Effect.gen(function* () {
packages/shared/src/relayTracing.ts
+20 -29
@@ -67,25 +67,25 @@ export const withLocalTracing = <A, E, R>(effect: Effect.Effect<A, E, R>): Effec
67 ),
68 );
69
70 -function cleanTraceStack(error: Error): string {
71 - const stack = error.stack ?? `${error.name}: ${error.message}`;
72 - const lines = stack.split("\n");
73 - const effectFrameIndex = lines.findIndex(
74 - (line, index) => index > 0 && /(?:Generator\.next|~effect\/Effect)/.test(line),
70 +// Error messages can carry machine names (environment labels) and paths, so
71 +// relay spans export only the error name and its stack frames.
72 +function traceFrames(error: Error): Array<string> {
73 + const lines = (error.stack ?? "").split("\n");
74 + const headerLines = error.message.split("\n").length;
75 + const frames = lines.slice(0, headerLines).join("\n").endsWith(error.message)
76 + ? lines.slice(headerLines)
77 + : lines;
78 + const effectFrameIndex = frames.findIndex((line) =>
79 + /(?:Generator\.next|~effect\/Effect)/.test(line),
80 );
76 - return effectFrameIndex < 0 ? stack : lines.slice(0, effectFrameIndex).join("\n");
81 + return effectFrameIndex < 0 ? frames : frames.slice(0, effectFrameIndex);
82 }
83
84 function traceSafeError(value: unknown, seen = new WeakSet<object>()): Error {
80 - const message =
81 - value instanceof Error
82 - ? value.message
83 - : typeof value === "object" &&
84 - value !== null &&
85 - "message" in value &&
86 - typeof value.message === "string"
87 - ? value.message
88 - : String(value);
85 + const name =
86 + typeof value === "object" && value !== null && "name" in value && typeof value.name === "string"
87 + ? value.name
88 + : "Error";
89
90 let cause: Error | undefined;
91 if (typeof value === "object" && value !== null && !seen.has(value)) {
@@ -95,20 +95,11 @@ function traceSafeError(value: unknown, seen = new WeakSet<object>()): Error {
95 }
96 }
97
98 - const error = new Error(message, cause ? { cause } : undefined);
99 - if (value instanceof Error) {
100 - error.name = value.name;
101 - error.stack = cleanTraceStack(value);
102 - } else if (
103 - typeof value === "object" &&
104 - value !== null &&
105 - "name" in value &&
106 - typeof value.name === "string"
107 - ) {
108 - error.name = value.name;
109 - }
98 + const error = new Error(name, cause ? { cause } : undefined);
99 + error.name = name;
100 + error.stack = [name, ...(value instanceof Error ? traceFrames(value) : [])].join("\n");
101 if (cause) {
111 - error.stack = `${error.stack ?? `${error.name}: ${error.message}`}\nCaused by: ${cause.stack ?? `${cause.name}: ${cause.message}`}`;
102 + error.stack = `${error.stack}\nCaused by: ${cause.stack}`;
103 }
104 return error;
105 }
@@ -132,7 +123,7 @@ function traceSafeExit(exit: Exit.Exit<unknown, unknown>): Exit.Exit<unknown, un
123 );
124 }
125
135 -function nonInterferingTracer(delegate: Tracer.Tracer): Tracer.Tracer {
126 +export function nonInterferingTracer(delegate: Tracer.Tracer): Tracer.Tracer {
127 return Tracer.make({
128 span(options) {
129 const span = delegate.span(options);