Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/desktop/src/app/DesktopApp.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ const runStubbedDesktop = (stub: StubbedDesktop) =>
installIntoProcess: Effect.succeed(true),
awaitDiscovery: Effect.succeed(true),
awaitUserShellDiscovery: Effect.succeed(true),
discoveryFinished: Effect.succeed(true),
updates: Stream.empty,
}),
Effect.provideService(DesktopAppSettings.DesktopAppSettings, {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ const layerShellEnvironment = (prepared = true) =>
installIntoProcess: Effect.succeed(prepared),
awaitDiscovery: Effect.succeed(prepared),
awaitUserShellDiscovery: Effect.succeed(prepared),
discoveryFinished: Effect.succeed(true),
updates: Stream.empty,
});

Expand Down
51 changes: 40 additions & 11 deletions apps/desktop/src/ipc/methods/window.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import * as Path from "effect/Path";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";
import * as Option from "effect/Option";
import * as Stream from "effect/Stream";
import { vi } from "vite-plus/test";
import type * as Electron from "electron";

Expand All @@ -26,6 +27,7 @@ import * as DesktopBackendConfiguration from "../../backend/DesktopBackendConfig
import * as DesktopBackendManager from "../../backend/DesktopBackendManager.ts";
import * as DesktopBackendPool from "../../backend/DesktopBackendPool.ts";
import * as DesktopAppSettings from "../../settings/DesktopAppSettings.ts";
import * as DesktopShellEnvironment from "../../shell/DesktopShellEnvironment.ts";
import * as DesktopManagedPolicy from "../../app/DesktopManagedPolicy.ts";
import * as DesktopWslEnvironment from "../../wsl/DesktopWslEnvironment.ts";
import * as ElectronDialog from "../../electron/ElectronDialog.ts";
Expand Down Expand Up @@ -235,6 +237,7 @@ describe("installRelayTelemetryEnabled", () => {
const relayTelemetryEnabled = (
env: NodeJS.ProcessEnv,
policy?: Parameters<typeof DesktopManagedPolicy.layerTest>[0],
loginShellEnv: NodeJS.ProcessEnv = {},
) =>
Effect.gen(function* () {
const listeners = new Map<string, DesktopIpc.DesktopIpcSyncListener>();
Expand All @@ -244,21 +247,47 @@ describe("installRelayTelemetryEnabled", () => {
removeAllListeners: (channel) => void listeners.delete(channel),
on: (channel, listener) => void listeners.set(channel, listener),
};
let discoveryFinished = false;
const ask = () => {
const event = { returnValue: undefined as unknown };
listeners.get(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL)?.(event as never);
return event.returnValue;
};
yield* installRelayTelemetryEnabled().pipe(
Effect.provideService(HostProcess.Environment, env),
Effect.provideService(DesktopShellEnvironment.DesktopShellEnvironment, {
installIntoProcess: Effect.succeed(true),
awaitDiscovery: Effect.succeed(true),
awaitUserShellDiscovery: Effect.succeed(true),
discoveryFinished: Effect.sync(() => discoveryFinished),
updates: Stream.empty,
}),
Effect.provide(
Layer.mergeAll(DesktopIpc.layerTest(ipcMain), DesktopManagedPolicy.layerTest(policy)),
),
);
const event = { returnValue: undefined as unknown };
listeners.get(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL)?.(event as never);
return event.returnValue;
const beforeDiscovery = ask();
// The login shell's values land in the process env after startup has installed handlers.
Object.assign(env, loginShellEnv);
discoveryFinished = true;
return { beforeDiscovery, afterDiscovery: ask() };
}).pipe(Effect.scoped);

it.effect("reads the desktop host opt-out before returning the renderer policy", () =>
Effect.gen(function* () {
assert.isFalse(yield* relayTelemetryEnabled({ T3CODE_TELEMETRY_ENABLED: "false" }));
assert.isTrue(yield* relayTelemetryEnabled({}));
assert.deepEqual(yield* relayTelemetryEnabled({ T3CODE_TELEMETRY_ENABLED: "false" }), {
beforeDiscovery: false,
afterDiscovery: false,
});
// Undecided until the login shell is read, so the renderer asks again instead of opting out.
assert.deepEqual(yield* relayTelemetryEnabled({}), {
beforeDiscovery: null,
afterDiscovery: true,
});
assert.deepEqual(
yield* relayTelemetryEnabled({}, undefined, { T3CODE_TELEMETRY_ENABLED: "false" }),
{ beforeDiscovery: null, afterDiscovery: false },
);
}),
);

Expand All @@ -269,14 +298,14 @@ describe("installRelayTelemetryEnabled", () => {
organization: "Example Corp",
limits,
});
assert.isFalse(yield* relayTelemetryEnabled({}, policy({ telemetry: false })));
assert.isTrue(yield* relayTelemetryEnabled({}, policy({ webhookTasks: false })));
const after = function* (...args: Parameters<typeof relayTelemetryEnabled>) {
return (yield* relayTelemetryEnabled(...args)).afterDiscovery;
};
assert.isFalse(yield* after({}, policy({ telemetry: false })));
assert.isTrue(yield* after({}, policy({ webhookTasks: false })));
// A policy that cannot be read fails closed.
assert.isFalse(
yield* relayTelemetryEnabled(
{},
new ManagedPolicyFileError({ path: "/test", reason: "bad JSON" }),
),
yield* after({}, new ManagedPolicyFileError({ path: "/test", reason: "bad JSON" })),
);
}),
);
Expand Down
25 changes: 16 additions & 9 deletions apps/desktop/src/ipc/methods/window.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import * as DesktopEnvironment from "../../app/DesktopEnvironment.ts";
import * as DesktopManagedPolicy from "../../app/DesktopManagedPolicy.ts";
import * as DesktopPrimaryPaste from "../../app/DesktopPrimaryPaste.ts";
import * as DesktopAppSettings from "../../settings/DesktopAppSettings.ts";
import * as DesktopShellEnvironment from "../../shell/DesktopShellEnvironment.ts";
import * as DesktopWslBackend from "../../wsl/DesktopWslBackend.ts";
import * as DesktopWslEnvironment from "../../wsl/DesktopWslEnvironment.ts";
import * as ElectronApp from "../../electron/ElectronApp.ts";
Expand Down Expand Up @@ -82,22 +83,28 @@ export const getAppBranding = DesktopIpc.makeSyncIpcMethod({

/**
* Relay traces leave the machine, so a policy with `telemetry: false`, or one that cannot be read,
* stops them. Read once here: a sync IPC handler cannot wait on the filesystem.
* stops them. Read once here: a sync IPC handler cannot wait on the filesystem. Until the login
* shell's environment (which may opt out) is known, answer null so the renderer asks again.
*/
export const installRelayTelemetryEnabled = Effect.fn("desktop.ipc.window.installRelayTelemetry")(
function* () {
const ipc = yield* DesktopIpc.DesktopIpc;
const enabled =
isRelayTracingEnabled(yield* HostProcess.Environment) &&
(yield* (yield* DesktopManagedPolicy.DesktopManagedPolicy).read.pipe(
Effect.map((found) => found?.document.limits?.telemetry !== false),
Effect.orElseSucceed(() => false),
));
const env = yield* HostProcess.Environment;
const policyAllows = yield* (yield* DesktopManagedPolicy.DesktopManagedPolicy).read.pipe(
Effect.map((found) => found?.document.limits?.telemetry !== false),
Effect.orElseSucceed(() => false),
);
const shellEnvironment = yield* DesktopShellEnvironment.DesktopShellEnvironment;
yield* ipc.handleSync(
DesktopIpc.makeSyncIpcMethod({
channel: IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL,
result: Schema.Boolean,
handler: () => Effect.succeed(enabled),
result: Schema.NullOr(Schema.Boolean),
handler: () =>
shellEnvironment.discoveryFinished.pipe(
Effect.map((known) =>
!policyAllows || !isRelayTracingEnabled(env) ? false : known ? true : null,
),
),
}),
);
},
Expand Down
6 changes: 4 additions & 2 deletions apps/desktop/src/preload.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,10 @@ contextBridge.exposeInMainWorld("desktopBridge", {
}
return result as ReturnType<DesktopBridge["getAppBranding"]>;
},
getRelayTelemetryEnabled: () =>
ipcRenderer.sendSync(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL) === true,
getRelayTelemetryEnabled: () => {
const enabled = ipcRenderer.sendSync(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL);
return enabled === null ? null : enabled === true;
},
getPathForFile: (file: File) => webUtils.getPathForFile(file),
getClientPlatform: () => clientPlatform,
restartAudioService: () => ipcRenderer.invoke(IpcChannels.RESTART_AUDIO_SERVICE_CHANNEL),
Expand Down
4 changes: 4 additions & 0 deletions apps/desktop/src/shell/DesktopShellEnvironment.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,7 @@ describe("DesktopShellEnvironment", () => {
NODE_EXTRA_CA_CERTS: "/cached/ca.pem",
SSL_CERT_FILE: "/cached/cert.pem",
SSL_CERT_DIR: "/cached/certs",
T3CODE_TELEMETRY_ENABLED: "false",
SSH_AUTH_SOCK: "/stale.sock",
NODE_OPTIONS: "--bad",
},
Expand Down Expand Up @@ -394,6 +395,7 @@ describe("DesktopShellEnvironment", () => {
assert.equal(env.NODE_EXTRA_CA_CERTS, "/launcher/ca.pem");
assert.equal(env.SSL_CERT_FILE, "");
assert.equal(env.SSL_CERT_DIR, "/cached/certs");
assert.equal(env.T3CODE_TELEMETRY_ENABLED, "false");
assert.equal(env.SSH_AUTH_SOCK, "/current.sock");
assert.isUndefined(env.NODE_OPTIONS);
assert.equal(yield* fs.readFileString(cachePath), contents);
Expand Down Expand Up @@ -711,6 +713,8 @@ describe("DesktopShellEnvironment", () => {
Effect.gen(function* () {
assert.isTrue(yield* service.awaitDiscovery);
assert.equal(env.PATH, "/usr/bin");
// The user's shell may still opt out of telemetry, so discovery has not settled.
assert.isFalse(yield* service.discoveryFinished);
// The Linux probe checks the D-Bus socket on the real filesystem, which the clock does not await.
const published = yield* service.updates.pipe(
Stream.filter((snapshot) => snapshot.environment.PATH === "/fish/bin:/usr/bin"),
Expand Down
6 changes: 6 additions & 0 deletions apps/desktop/src/shell/DesktopShellEnvironment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ export class DesktopShellEnvironment extends Context.Service<
readonly awaitDiscovery: Effect.Effect<boolean>;
/** Whether the user's own login shell, not a fallback, gave the PATH a new terminal gets. */
readonly awaitUserShellDiscovery: Effect.Effect<boolean>;
/** Whether discovery has settled (the user's shell answered or retries ran out), without waiting. */
readonly discoveryFinished: Effect.Effect<boolean>;
readonly updates: Stream.Stream<DesktopShellEnvironmentSnapshot>;
}
>()("@t3tools/desktop/shell/DesktopShellEnvironment") {}
Expand Down Expand Up @@ -651,6 +653,7 @@ const CACHED_ENV_NAMES = [
"SSL_CERT_FILE",
"SSL_CERT_DIR",
"NODE_EXTRA_CA_CERTS",
"T3CODE_TELEMETRY_ENABLED",
] as const;

/** @public */
Expand All @@ -672,6 +675,7 @@ export const make = Effect.gen(function* () {
const changes = yield* PubSub.unbounded<DesktopShellEnvironmentSnapshot>();
const latest = yield* Ref.make<Option.Option<DesktopShellEnvironmentSnapshot>>(Option.none());
const discovered = yield* Deferred.make<ShellDiscovery>();
const settledDiscovery = yield* Deferred.make<void>();
const publish = Effect.fn("desktop.shellEnvironment.publish")(function* (
patch: ShellEnvironmentPatch,
discovered = false,
Expand Down Expand Up @@ -741,6 +745,7 @@ export const make = Effect.gen(function* () {
),
),
),
Effect.onExit(() => Deferred.succeed(settledDiscovery, undefined)),
);
const installIntoProcess = yield* Effect.cached(
Effect.gen(function* () {
Expand Down Expand Up @@ -796,6 +801,7 @@ export const make = Effect.gen(function* () {
Effect.andThen(Deferred.await(discovered)),
Effect.map(({ fromUserShell }) => fromUserShell),
),
discoveryFinished: Deferred.isDone(settledDiscovery),
updates,
});
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ describe("DesktopTelemetryPublisher", () => {
installIntoProcess: Effect.succeed(true),
awaitDiscovery: Effect.succeed(true),
awaitUserShellDiscovery: Effect.succeed(true),
discoveryFinished: Effect.succeed(true),
updates: Stream.make({
version: 1,
type: "shellEnvironment",
Expand Down
11 changes: 10 additions & 1 deletion apps/web/src/cloud/publicConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,18 @@ export function resolveCloudPublicConfig(): CloudPublicConfig {
};
}

let desktopRelayTelemetry: boolean | null = null;

/** Whether relay spans may be exported now; the desktop host may not know yet at startup. */
export function relayTelemetryEnabled(): boolean | null {
if (typeof window === "undefined" || !window.desktopBridge) return true;
desktopRelayTelemetry ??= window.desktopBridge.getRelayTelemetryEnabled();
return desktopRelayTelemetry;
}

export function resolveRelayTracingConfig() {
// The relay exporter is created during module initialization, so this must be synchronous.
if (typeof window !== "undefined" && window.desktopBridge?.getRelayTelemetryEnabled() === false) {
if (relayTelemetryEnabled() === false) {
return null;
}
const { relayTracing } = resolveCloudPublicConfig();
Expand Down
16 changes: 16 additions & 0 deletions apps/web/src/lib/runtime.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ afterEach(() => {
vi.unstubAllGlobals();
});

const answers = (...values: Array<boolean | null>) => {
let call = 0;
return () => values[Math.min(call++, values.length - 1)] ?? null;
};

describe("web runtime relay telemetry policy", () => {
it.each([
{
Expand All @@ -20,6 +25,17 @@ describe("web runtime relay telemetry policy", () => {
desktopBridge: { getRelayTelemetryEnabled: () => true },
exports: true,
},
{
// The desktop host reads the login shell after the renderer has started.
surface: "desktop enabled once the login shell is read",
desktopBridge: { getRelayTelemetryEnabled: answers(null, true) },
exports: true,
},
{
surface: "desktop opt-out found in the login shell",
desktopBridge: { getRelayTelemetryEnabled: answers(null, false, true) },
exports: false,
},
{
surface: "ordinary browser ignores host opt-out",
desktopBridge: undefined,
Expand Down
24 changes: 16 additions & 8 deletions apps/web/src/lib/runtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,29 @@ import * as PrimaryEnvironmentHttpLayer from "../environments/primary/httpLayer"

import * as Dpop from "../cloud/dpop";
import * as ManagedRelayLayer from "../cloud/managedRelayLayer";
import { resolveCloudPublicConfig, resolveRelayTracingConfig } from "../cloud/publicConfig";
import {
relayTelemetryEnabled,
resolveCloudPublicConfig,
resolveRelayTracingConfig,
} from "../cloud/publicConfig";
import * as ClientTracer from "../observability/clientTracer";

function configuredRelayUrl(): string {
return resolveCloudPublicConfig().relayUrl ?? "http://relay.invalid";
}

const layerHttpClient = layerRemoteHttpClient((input, init) => globalThis.fetch(input, init));
const layerRelayTracing = RelayTracing.layer(resolveRelayTracingConfig(), {
serviceName: "t3code-web",
serviceVersion: import.meta.env.APP_VERSION,
runtime: "browser",
serviceInstanceId: ClientTracer.serviceInstanceId,
client: typeof window !== "undefined" && window.desktopBridge ? "desktop" : "web",
}).pipe(Layer.provide(layerHttpClient));
const layerRelayTracing = RelayTracing.layer(
resolveRelayTracingConfig(),
{
serviceName: "t3code-web",
serviceVersion: import.meta.env.APP_VERSION,
runtime: "browser",
serviceInstanceId: ClientTracer.serviceInstanceId,
client: typeof window !== "undefined" && window.desktopBridge ? "desktop" : "web",
},
{ isEnabled: () => relayTelemetryEnabled() === true },
).pipe(Layer.provide(layerHttpClient));

type RuntimeLayerSource =
| typeof layerHttpClient
Expand Down
3 changes: 2 additions & 1 deletion packages/contracts/src/ipc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1058,7 +1058,8 @@ export type SystemSettingsPane = typeof SystemSettingsPaneSchema.Type;

export interface DesktopBridge {
getAppBranding: () => DesktopAppBranding | null;
getRelayTelemetryEnabled: () => boolean;
/** `null` until the desktop host has read the login shell's environment; ask again later. */
getRelayTelemetryEnabled: () => boolean | null;
getPathForFile: (file: File) => string;
getClientPlatform: () => string;
restartAudioService?: () => Promise<boolean>;
Expand Down
17 changes: 16 additions & 1 deletion packages/shared/src/relayTracing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,18 @@ export function nonInterferingTracer(delegate: Tracer.Tracer): Tracer.Tracer {
});
}

/** Spans started while `isEnabled` says no stay local instead of being exported. */
function gatedTracer(delegate: Tracer.Tracer, isEnabled: () => boolean): Tracer.Tracer {
return Tracer.make({
span: (options) => (isEnabled() ? delegate.span(options) : Tracer.nativeTracer.span(options)),
...(delegate.context ? { context: delegate.context } : {}),
});
}

export function layer(
config: RelayClientTracingConfig | null,
resource: RelayClientTracingResource,
options?: { readonly isEnabled?: () => boolean },
): Layer.Layer<never, never, HttpClient.HttpClient> {
if (config === null) {
return Layer.succeed(RelayClientTracer, Option.none());
Expand Down Expand Up @@ -169,6 +178,12 @@ export function layer(

return Layer.effect(
RelayClientTracer,
Tracer.Tracer.pipe(Effect.map(nonInterferingTracer), Effect.asSome),
Tracer.Tracer.pipe(
Effect.map(nonInterferingTracer),
Effect.map((tracer) =>
options?.isEnabled ? gatedTracer(tracer, options.isEnabled) : tracer,
),
Effect.asSome,
),
).pipe(Layer.provide(layerTracer));
}
Loading