The best way to control Claude Code, Codex and more from any computer or phone
Mirrored from https://github.com/Camo67/t3code.git
Synced Nov 21, 09:45 UTC
fix(desktop): relay tracing honors a telemetry opt-out from the login shell (#37792)
Julius Marminge committed
Nov 16, 2026 at 14:53 UTC
6794d5646ca62520176a9fed2faae0855d24ef26
13 files changed
+133
-33
apps/desktop/src/app/DesktopApp.test.ts
+1
@@ -120,6 +120,7 @@ const runStubbedDesktop = (stub: StubbedDesktop) =>
120
installIntoProcess: Effect.succeed(true),
121
awaitDiscovery: Effect.succeed(true),
122
awaitUserShellDiscovery: Effect.succeed(true),
123
+ discoveryFinished: Effect.succeed(true),
124
updates: Stream.empty,
125
}),
126
Effect.provideService(DesktopAppSettings.DesktopAppSettings, {
apps/desktop/src/backend/DesktopBackendConfiguration.test.ts
+1
@@ -29,6 +29,7 @@ const layerShellEnvironment = (prepared = true) =>
29
installIntoProcess: Effect.succeed(prepared),
30
awaitDiscovery: Effect.succeed(prepared),
31
awaitUserShellDiscovery: Effect.succeed(prepared),
32
+ discoveryFinished: Effect.succeed(true),
33
updates: Stream.empty,
34
});
35
apps/desktop/src/ipc/methods/window.test.ts
+40
-11
@@ -10,6 +10,7 @@ import * as Path from "effect/Path";
10
import * as Effect from "effect/Effect";
11
import * as Layer from "effect/Layer";
12
import * as Option from "effect/Option";
13
+import * as Stream from "effect/Stream";
14
import { vi } from "vite-plus/test";
15
import type * as Electron from "electron";
16
@@ -26,6 +27,7 @@ import * as DesktopBackendConfiguration from "../../backend/DesktopBackendConfig
27
import * as DesktopBackendManager from "../../backend/DesktopBackendManager.ts";
28
import * as DesktopBackendPool from "../../backend/DesktopBackendPool.ts";
29
import * as DesktopAppSettings from "../../settings/DesktopAppSettings.ts";
30
+import * as DesktopShellEnvironment from "../../shell/DesktopShellEnvironment.ts";
31
import * as DesktopManagedPolicy from "../../app/DesktopManagedPolicy.ts";
32
import * as DesktopWslEnvironment from "../../wsl/DesktopWslEnvironment.ts";
33
import * as ElectronDialog from "../../electron/ElectronDialog.ts";
@@ -235,6 +237,7 @@ describe("installRelayTelemetryEnabled", () => {
237
const relayTelemetryEnabled = (
238
env: NodeJS.ProcessEnv,
239
policy?: Parameters<typeof DesktopManagedPolicy.layerTest>[0],
240
+ loginShellEnv: NodeJS.ProcessEnv = {},
241
) =>
242
Effect.gen(function* () {
243
const listeners = new Map<string, DesktopIpc.DesktopIpcSyncListener>();
@@ -244,21 +247,47 @@ describe("installRelayTelemetryEnabled", () => {
247
removeAllListeners: (channel) => void listeners.delete(channel),
248
on: (channel, listener) => void listeners.set(channel, listener),
249
};
250
+ let discoveryFinished = false;
251
+ const ask = () => {
252
+ const event = { returnValue: undefined as unknown };
253
+ listeners.get(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL)?.(event as never);
254
+ return event.returnValue;
255
+ };
256
yield* installRelayTelemetryEnabled().pipe(
257
Effect.provideService(HostProcess.Environment, env),
258
+ Effect.provideService(DesktopShellEnvironment.DesktopShellEnvironment, {
259
+ installIntoProcess: Effect.succeed(true),
260
+ awaitDiscovery: Effect.succeed(true),
261
+ awaitUserShellDiscovery: Effect.succeed(true),
262
+ discoveryFinished: Effect.sync(() => discoveryFinished),
263
+ updates: Stream.empty,
264
+ }),
265
Effect.provide(
266
Layer.mergeAll(DesktopIpc.layerTest(ipcMain), DesktopManagedPolicy.layerTest(policy)),
267
),
268
);
253
- const event = { returnValue: undefined as unknown };
254
- listeners.get(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL)?.(event as never);
255
- return event.returnValue;
269
+ const beforeDiscovery = ask();
270
+ // The login shell's values land in the process env after startup has installed handlers.
271
+ Object.assign(env, loginShellEnv);
272
+ discoveryFinished = true;
273
+ return { beforeDiscovery, afterDiscovery: ask() };
274
}).pipe(Effect.scoped);
275
276
it.effect("reads the desktop host opt-out before returning the renderer policy", () =>
277
Effect.gen(function* () {
260
- assert.isFalse(yield* relayTelemetryEnabled({ T3CODE_TELEMETRY_ENABLED: "false" }));
261
- assert.isTrue(yield* relayTelemetryEnabled({}));
278
+ assert.deepEqual(yield* relayTelemetryEnabled({ T3CODE_TELEMETRY_ENABLED: "false" }), {
279
+ beforeDiscovery: false,
280
+ afterDiscovery: false,
281
+ });
282
+ // Undecided until the login shell is read, so the renderer asks again instead of opting out.
283
+ assert.deepEqual(yield* relayTelemetryEnabled({}), {
284
+ beforeDiscovery: null,
285
+ afterDiscovery: true,
286
+ });
287
+ assert.deepEqual(
288
+ yield* relayTelemetryEnabled({}, undefined, { T3CODE_TELEMETRY_ENABLED: "false" }),
289
+ { beforeDiscovery: null, afterDiscovery: false },
290
+ );
291
}),
292
);
293
@@ -269,14 +298,14 @@ describe("installRelayTelemetryEnabled", () => {
298
organization: "Example Corp",
299
limits,
300
});
272
- assert.isFalse(yield* relayTelemetryEnabled({}, policy({ telemetry: false })));
273
- assert.isTrue(yield* relayTelemetryEnabled({}, policy({ webhookTasks: false })));
301
+ const after = function* (...args: Parameters<typeof relayTelemetryEnabled>) {
302
+ return (yield* relayTelemetryEnabled(...args)).afterDiscovery;
303
+ };
304
+ assert.isFalse(yield* after({}, policy({ telemetry: false })));
305
+ assert.isTrue(yield* after({}, policy({ webhookTasks: false })));
306
// A policy that cannot be read fails closed.
307
assert.isFalse(
276
- yield* relayTelemetryEnabled(
277
- {},
278
- new ManagedPolicyFileError({ path: "/test", reason: "bad JSON" }),
279
- ),
308
+ yield* after({}, new ManagedPolicyFileError({ path: "/test", reason: "bad JSON" })),
309
);
310
}),
311
);
apps/desktop/src/ipc/methods/window.ts
+16
-9
@@ -34,6 +34,7 @@ import * as DesktopEnvironment from "../../app/DesktopEnvironment.ts";
34
import * as DesktopManagedPolicy from "../../app/DesktopManagedPolicy.ts";
35
import * as DesktopPrimaryPaste from "../../app/DesktopPrimaryPaste.ts";
36
import * as DesktopAppSettings from "../../settings/DesktopAppSettings.ts";
37
+import * as DesktopShellEnvironment from "../../shell/DesktopShellEnvironment.ts";
38
import * as DesktopWslBackend from "../../wsl/DesktopWslBackend.ts";
39
import * as DesktopWslEnvironment from "../../wsl/DesktopWslEnvironment.ts";
40
import * as ElectronApp from "../../electron/ElectronApp.ts";
@@ -82,22 +83,28 @@ export const getAppBranding = DesktopIpc.makeSyncIpcMethod({
83
84
/**
85
* Relay traces leave the machine, so a policy with `telemetry: false`, or one that cannot be read,
85
- * stops them. Read once here: a sync IPC handler cannot wait on the filesystem.
86
+ * stops them. Read once here: a sync IPC handler cannot wait on the filesystem. Until the login
87
+ * shell's environment (which may opt out) is known, answer null so the renderer asks again.
88
*/
89
export const installRelayTelemetryEnabled = Effect.fn("desktop.ipc.window.installRelayTelemetry")(
90
function* () {
91
const ipc = yield* DesktopIpc.DesktopIpc;
90
- const enabled =
91
- isRelayTracingEnabled(yield* HostProcess.Environment) &&
92
- (yield* (yield* DesktopManagedPolicy.DesktopManagedPolicy).read.pipe(
93
- Effect.map((found) => found?.document.limits?.telemetry !== false),
94
- Effect.orElseSucceed(() => false),
95
- ));
92
+ const env = yield* HostProcess.Environment;
93
+ const policyAllows = yield* (yield* DesktopManagedPolicy.DesktopManagedPolicy).read.pipe(
94
+ Effect.map((found) => found?.document.limits?.telemetry !== false),
95
+ Effect.orElseSucceed(() => false),
96
+ );
97
+ const shellEnvironment = yield* DesktopShellEnvironment.DesktopShellEnvironment;
98
yield* ipc.handleSync(
99
DesktopIpc.makeSyncIpcMethod({
100
channel: IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL,
99
- result: Schema.Boolean,
100
- handler: () => Effect.succeed(enabled),
101
+ result: Schema.NullOr(Schema.Boolean),
102
+ handler: () =>
103
+ shellEnvironment.discoveryFinished.pipe(
104
+ Effect.map((known) =>
105
+ !policyAllows || !isRelayTracingEnabled(env) ? false : known ? true : null,
106
+ ),
107
+ ),
108
}),
109
);
110
},
apps/desktop/src/preload.ts
+4
-2
@@ -111,8 +111,10 @@ contextBridge.exposeInMainWorld("desktopBridge", {
111
}
112
return result as ReturnType<DesktopBridge["getAppBranding"]>;
113
},
114
- getRelayTelemetryEnabled: () =>
115
- ipcRenderer.sendSync(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL) === true,
114
+ getRelayTelemetryEnabled: () => {
115
+ const enabled = ipcRenderer.sendSync(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL);
116
+ return enabled === null ? null : enabled === true;
117
+ },
118
getPathForFile: (file: File) => webUtils.getPathForFile(file),
119
getClientPlatform: () => clientPlatform,
120
restartAudioService: () => ipcRenderer.invoke(IpcChannels.RESTART_AUDIO_SERVICE_CHANNEL),
apps/desktop/src/shell/DesktopShellEnvironment.test.ts
+4
@@ -355,6 +355,7 @@ describe("DesktopShellEnvironment", () => {
355
NODE_EXTRA_CA_CERTS: "/cached/ca.pem",
356
SSL_CERT_FILE: "/cached/cert.pem",
357
SSL_CERT_DIR: "/cached/certs",
358
+ T3CODE_TELEMETRY_ENABLED: "false",
359
SSH_AUTH_SOCK: "/stale.sock",
360
NODE_OPTIONS: "--bad",
361
},
@@ -394,6 +395,7 @@ describe("DesktopShellEnvironment", () => {
395
assert.equal(env.NODE_EXTRA_CA_CERTS, "/launcher/ca.pem");
396
assert.equal(env.SSL_CERT_FILE, "");
397
assert.equal(env.SSL_CERT_DIR, "/cached/certs");
398
+ assert.equal(env.T3CODE_TELEMETRY_ENABLED, "false");
399
assert.equal(env.SSH_AUTH_SOCK, "/current.sock");
400
assert.isUndefined(env.NODE_OPTIONS);
401
assert.equal(yield* fs.readFileString(cachePath), contents);
@@ -711,6 +713,8 @@ describe("DesktopShellEnvironment", () => {
713
Effect.gen(function* () {
714
assert.isTrue(yield* service.awaitDiscovery);
715
assert.equal(env.PATH, "/usr/bin");
716
+ // The user's shell may still opt out of telemetry, so discovery has not settled.
717
+ assert.isFalse(yield* service.discoveryFinished);
718
// The Linux probe checks the D-Bus socket on the real filesystem, which the clock does not await.
719
const published = yield* service.updates.pipe(
720
Stream.filter((snapshot) => snapshot.environment.PATH === "/fish/bin:/usr/bin"),
apps/desktop/src/shell/DesktopShellEnvironment.ts
+6
@@ -93,6 +93,8 @@ export class DesktopShellEnvironment extends Context.Service<
93
readonly awaitDiscovery: Effect.Effect<boolean>;
94
/** Whether the user's own login shell, not a fallback, gave the PATH a new terminal gets. */
95
readonly awaitUserShellDiscovery: Effect.Effect<boolean>;
96
+ /** Whether discovery has settled (the user's shell answered or retries ran out), without waiting. */
97
+ readonly discoveryFinished: Effect.Effect<boolean>;
98
readonly updates: Stream.Stream<DesktopShellEnvironmentSnapshot>;
99
}
100
>()("@t3tools/desktop/shell/DesktopShellEnvironment") {}
@@ -651,6 +653,7 @@ const CACHED_ENV_NAMES = [
653
"SSL_CERT_FILE",
654
"SSL_CERT_DIR",
655
"NODE_EXTRA_CA_CERTS",
656
+ "T3CODE_TELEMETRY_ENABLED",
657
] as const;
658
659
/** @public */
@@ -672,6 +675,7 @@ export const make = Effect.gen(function* () {
675
const changes = yield* PubSub.unbounded<DesktopShellEnvironmentSnapshot>();
676
const latest = yield* Ref.make<Option.Option<DesktopShellEnvironmentSnapshot>>(Option.none());
677
const discovered = yield* Deferred.make<ShellDiscovery>();
678
+ const settledDiscovery = yield* Deferred.make<void>();
679
const publish = Effect.fn("desktop.shellEnvironment.publish")(function* (
680
patch: ShellEnvironmentPatch,
681
discovered = false,
@@ -741,6 +745,7 @@ export const make = Effect.gen(function* () {
745
),
746
),
747
),
748
+ Effect.onExit(() => Deferred.succeed(settledDiscovery, undefined)),
749
);
750
const installIntoProcess = yield* Effect.cached(
751
Effect.gen(function* () {
@@ -796,6 +801,7 @@ export const make = Effect.gen(function* () {
801
Effect.andThen(Deferred.await(discovered)),
802
Effect.map(({ fromUserShell }) => fromUserShell),
803
),
804
+ discoveryFinished: Deferred.isDone(settledDiscovery),
805
updates,
806
});
807
});
apps/desktop/src/telemetry/DesktopTelemetryPublisher.test.ts
+1
@@ -93,6 +93,7 @@ describe("DesktopTelemetryPublisher", () => {
93
installIntoProcess: Effect.succeed(true),
94
awaitDiscovery: Effect.succeed(true),
95
awaitUserShellDiscovery: Effect.succeed(true),
96
+ discoveryFinished: Effect.succeed(true),
97
updates: Stream.make({
98
version: 1,
99
type: "shellEnvironment",
apps/web/src/cloud/publicConfig.ts
+10
-1
@@ -61,9 +61,18 @@ export function resolveCloudPublicConfig(): CloudPublicConfig {
61
};
62
}
63
64
+let desktopRelayTelemetry: boolean | null = null;
65
+
66
+/** Whether relay spans may be exported now; the desktop host may not know yet at startup. */
67
+export function relayTelemetryEnabled(): boolean | null {
68
+ if (typeof window === "undefined" || !window.desktopBridge) return true;
69
+ desktopRelayTelemetry ??= window.desktopBridge.getRelayTelemetryEnabled();
70
+ return desktopRelayTelemetry;
71
+}
72
+
73
export function resolveRelayTracingConfig() {
74
// The relay exporter is created during module initialization, so this must be synchronous.
66
- if (typeof window !== "undefined" && window.desktopBridge?.getRelayTelemetryEnabled() === false) {
75
+ if (relayTelemetryEnabled() === false) {
76
return null;
77
}
78
const { relayTracing } = resolveCloudPublicConfig();
apps/web/src/lib/runtime.test.ts
+16
@@ -8,6 +8,11 @@ afterEach(() => {
8
vi.unstubAllGlobals();
9
});
10
11
+const answers = (...values: Array<boolean | null>) => {
12
+ let call = 0;
13
+ return () => values[Math.min(call++, values.length - 1)] ?? null;
14
+};
15
+
16
describe("web runtime relay telemetry policy", () => {
17
it.each([
18
{
@@ -20,6 +25,17 @@ describe("web runtime relay telemetry policy", () => {
25
desktopBridge: { getRelayTelemetryEnabled: () => true },
26
exports: true,
27
},
28
+ {
29
+ // The desktop host reads the login shell after the renderer has started.
30
+ surface: "desktop enabled once the login shell is read",
31
+ desktopBridge: { getRelayTelemetryEnabled: answers(null, true) },
32
+ exports: true,
33
+ },
34
+ {
35
+ surface: "desktop opt-out found in the login shell",
36
+ desktopBridge: { getRelayTelemetryEnabled: answers(null, false, true) },
37
+ exports: false,
38
+ },
39
{
40
surface: "ordinary browser ignores host opt-out",
41
desktopBridge: undefined,
apps/web/src/lib/runtime.ts
+16
-8
@@ -10,7 +10,11 @@ import * as PrimaryEnvironmentHttpLayer from "../environments/primary/httpLayer"
10
11
import * as Dpop from "../cloud/dpop";
12
import * as ManagedRelayLayer from "../cloud/managedRelayLayer";
13
-import { resolveCloudPublicConfig, resolveRelayTracingConfig } from "../cloud/publicConfig";
13
+import {
14
+ relayTelemetryEnabled,
15
+ resolveCloudPublicConfig,
16
+ resolveRelayTracingConfig,
17
+} from "../cloud/publicConfig";
18
import * as ClientTracer from "../observability/clientTracer";
19
20
function configuredRelayUrl(): string {
@@ -18,13 +22,17 @@ function configuredRelayUrl(): string {
22
}
23
24
const layerHttpClient = layerRemoteHttpClient((input, init) => globalThis.fetch(input, init));
21
-const layerRelayTracing = RelayTracing.layer(resolveRelayTracingConfig(), {
22
- serviceName: "t3code-web",
23
- serviceVersion: import.meta.env.APP_VERSION,
24
- runtime: "browser",
25
- serviceInstanceId: ClientTracer.serviceInstanceId,
26
- client: typeof window !== "undefined" && window.desktopBridge ? "desktop" : "web",
27
-}).pipe(Layer.provide(layerHttpClient));
25
+const layerRelayTracing = RelayTracing.layer(
26
+ resolveRelayTracingConfig(),
27
+ {
28
+ serviceName: "t3code-web",
29
+ serviceVersion: import.meta.env.APP_VERSION,
30
+ runtime: "browser",
31
+ serviceInstanceId: ClientTracer.serviceInstanceId,
32
+ client: typeof window !== "undefined" && window.desktopBridge ? "desktop" : "web",
33
+ },
34
+ { isEnabled: () => relayTelemetryEnabled() === true },
35
+).pipe(Layer.provide(layerHttpClient));
36
37
type RuntimeLayerSource =
38
| typeof layerHttpClient
packages/contracts/src/ipc.ts
+2
-1
@@ -1058,7 +1058,8 @@ export type SystemSettingsPane = typeof SystemSettingsPaneSchema.Type;
1058
1059
export interface DesktopBridge {
1060
getAppBranding: () => DesktopAppBranding | null;
1061
- getRelayTelemetryEnabled: () => boolean;
1061
+ /** `null` until the desktop host has read the login shell's environment; ask again later. */
1062
+ getRelayTelemetryEnabled: () => boolean | null;
1063
getPathForFile: (file: File) => string;
1064
getClientPlatform: () => string;
1065
restartAudioService?: () => Promise<boolean>;
packages/shared/src/relayTracing.ts
+16
-1
@@ -139,9 +139,18 @@ export function nonInterferingTracer(delegate: Tracer.Tracer): Tracer.Tracer {
139
});
140
}
141
142
+/** Spans started while `isEnabled` says no stay local instead of being exported. */
143
+function gatedTracer(delegate: Tracer.Tracer, isEnabled: () => boolean): Tracer.Tracer {
144
+ return Tracer.make({
145
+ span: (options) => (isEnabled() ? delegate.span(options) : Tracer.nativeTracer.span(options)),
146
+ ...(delegate.context ? { context: delegate.context } : {}),
147
+ });
148
+}
149
+
150
export function layer(
151
config: RelayClientTracingConfig | null,
152
resource: RelayClientTracingResource,
153
+ options?: { readonly isEnabled?: () => boolean },
154
): Layer.Layer<never, never, HttpClient.HttpClient> {
155
if (config === null) {
156
return Layer.succeed(RelayClientTracer, Option.none());
@@ -169,6 +178,12 @@ export function layer(
178
179
return Layer.effect(
180
RelayClientTracer,
172
- Tracer.Tracer.pipe(Effect.map(nonInterferingTracer), Effect.asSome),
181
+ Tracer.Tracer.pipe(
182
+ Effect.map(nonInterferingTracer),
183
+ Effect.map((tracer) =>
184
+ options?.isEnabled ? gatedTracer(tracer, options.isEnabled) : tracer,
185
+ ),
186
+ Effect.asSome,
187
+ ),
188
).pipe(Layer.provide(layerTracer));
189
}