Skip to content

Commit 00327aa

Browse files
Merge remote-tracking branch 'origin/main' into fix/issue-28852
2 parents a2149de + d897d3f commit 00327aa

193 files changed

Lines changed: 9048 additions & 543 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/**
2+
* DesktopManagedPolicy - the administrator's managed policy as the desktop app reads it, at most
3+
* once: every desktop check needs the same answer.
4+
*
5+
* @module DesktopManagedPolicy
6+
*/
7+
import type { ManagedPolicyDocument } from "@t3tools/contracts";
8+
import {
9+
layerWindowsRegistry,
10+
ManagedPolicyFileError,
11+
readManagedPolicy,
12+
WindowsRegistry,
13+
} from "@t3tools/shared/managedPolicyFile";
14+
import * as Context from "effect/Context";
15+
import * as Effect from "effect/Effect";
16+
import * as FileSystem from "effect/FileSystem";
17+
import * as Layer from "effect/Layer";
18+
import * as Schema from "effect/Schema";
19+
import { ChildProcessSpawner } from "effect/process";
20+
21+
import * as DesktopEnvironment from "./DesktopEnvironment.ts";
22+
23+
type FoundPolicy = Effect.Success<ReturnType<typeof readManagedPolicy>>;
24+
const isManagedPolicyFileError = Schema.is(ManagedPolicyFileError);
25+
26+
export class DesktopManagedPolicy extends Context.Service<
27+
DesktopManagedPolicy,
28+
{
29+
/** The policy on this machine, undefined without one; fails when it cannot be used. */
30+
readonly read: Effect.Effect<FoundPolicy, ManagedPolicyFileError>;
31+
}
32+
>()("@t3tools/desktop/app/DesktopManagedPolicy") {}
33+
34+
export const layer = Layer.effect(
35+
DesktopManagedPolicy,
36+
Effect.gen(function* () {
37+
const { platform } = yield* DesktopEnvironment.DesktopEnvironment;
38+
const read = yield* Effect.cached(
39+
readManagedPolicy(platform).pipe(
40+
Effect.provideService(FileSystem.FileSystem, yield* FileSystem.FileSystem),
41+
Effect.provideService(
42+
ChildProcessSpawner.ChildProcessSpawner,
43+
yield* ChildProcessSpawner.ChildProcessSpawner,
44+
),
45+
Effect.provideService(WindowsRegistry, yield* WindowsRegistry),
46+
),
47+
);
48+
return DesktopManagedPolicy.of({ read });
49+
}),
50+
).pipe(Layer.provide(layerWindowsRegistry(() => import("ffi-rs"))));
51+
52+
/** A machine with `policy` deployed, one whose policy cannot be used, or none. */
53+
export const layerTest = (policy?: ManagedPolicyDocument | ManagedPolicyFileError) =>
54+
Layer.succeed(
55+
DesktopManagedPolicy,
56+
DesktopManagedPolicy.of({
57+
read:
58+
policy === undefined
59+
? // @effect-diagnostics-next-line effectSucceedWithVoid:off - No policy is undefined, not void.
60+
Effect.succeed(undefined)
61+
: isManagedPolicyFileError(policy)
62+
? Effect.fail(policy)
63+
: Effect.succeed({ source: "/test/policy.json", document: policy }),
64+
}),
65+
);

‎apps/desktop/src/backend/DesktopBackendConfiguration.test.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import * as Stream from "effect/Stream";
1212
import { ChildProcessSpawner } from "effect/process";
1313

1414
import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";
15+
import * as DesktopManagedPolicy from "../app/DesktopManagedPolicy.ts";
1516
import * as DesktopBackendConfiguration from "./DesktopBackendConfiguration.ts";
1617
import * as DesktopShellEnvironment from "../shell/DesktopShellEnvironment.ts";
1718
import * as DesktopConfig from "../app/DesktopConfig.ts";
@@ -972,6 +973,7 @@ describe("DesktopBackendConfiguration", () => {
972973
Layer.provideMerge(DesktopAppSettings.layerTest()),
973974
Layer.provideMerge(DesktopWslServerTree.layerTest()),
974975
Layer.provideMerge(DesktopWslEnvironment.layer),
976+
Layer.provideMerge(DesktopManagedPolicy.layerTest()),
975977
Layer.provideMerge(
976978
Layer.succeed(
977979
ChildProcessSpawner.ChildProcessSpawner,

‎apps/desktop/src/backend/DesktopServerExposure.test.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ import * as Effect from "effect/Effect";
77
import * as Fiber from "effect/Fiber";
88
import * as FileSystem from "effect/FileSystem";
99
import * as Layer from "effect/Layer";
10+
import * as Option from "effect/Option";
1011
import * as Sink from "effect/Sink";
1112
import * as Stream from "effect/Stream";
1213
import * as ChildProcessSpawner from "effect/process/ChildProcessSpawner";
1314

1415
import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";
1516
import * as DesktopConfig from "../app/DesktopConfig.ts";
17+
import * as DesktopManagedPolicy from "../app/DesktopManagedPolicy.ts";
1618
import * as DesktopNetworkInterfaces from "./DesktopNetworkInterfaces.ts";
1719
import * as DesktopServerExposure from "./DesktopServerExposure.ts";
1820
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
@@ -90,6 +92,7 @@ function layer(input: {
9092
readonly env?: Record<string, string | undefined>;
9193
readonly spawnerLayer?: Layer.Layer<ChildProcessSpawner.ChildProcessSpawner>;
9294
readonly desktopSettingsLayer?: Layer.Layer<DesktopAppSettings.DesktopAppSettings>;
95+
readonly managedPolicyLayer?: Layer.Layer<DesktopManagedPolicy.DesktopManagedPolicy>;
9396
}) {
9497
const env = { T3CODE_HOME: input.baseDir, ...input.env };
9598
const layerEnvironment = layerEnvironmentFor(input.baseDir, env);
@@ -99,6 +102,7 @@ function layer(input: {
99102

100103
return DesktopServerExposure.layer.pipe(
101104
Layer.provideMerge(input.desktopSettingsLayer ?? DesktopAppSettings.layer),
105+
Layer.provideMerge(input.managedPolicyLayer ?? DesktopManagedPolicy.layerTest()),
102106
Layer.provideMerge(NodeFileSystem.layer),
103107
Layer.provideMerge(NodeHttpClient.layerUndici),
104108
Layer.provideMerge(input.spawnerLayer ?? layerMockSpawner()),
@@ -122,6 +126,7 @@ const withHarness = <A, E, R>(
122126
env: Record<string, string | undefined> = {},
123127
spawnerLayer?: Layer.Layer<ChildProcessSpawner.ChildProcessSpawner>,
124128
desktopSettingsLayer?: Layer.Layer<DesktopAppSettings.DesktopAppSettings>,
129+
managedPolicyLayer?: Layer.Layer<DesktopManagedPolicy.DesktopManagedPolicy>,
125130
) =>
126131
Effect.gen(function* () {
127132
const fileSystem = yield* FileSystem.FileSystem;
@@ -136,6 +141,7 @@ const withHarness = <A, E, R>(
136141
env,
137142
...(spawnerLayer ? { spawnerLayer } : {}),
138143
...(desktopSettingsLayer ? { desktopSettingsLayer } : {}),
144+
...(managedPolicyLayer ? { managedPolicyLayer } : {}),
139145
}),
140146
),
141147
);
@@ -191,6 +197,41 @@ describe("DesktopServerExposure", () => {
191197
),
192198
);
193199

200+
it.effect("starts local-only, Serve off, when a managed policy keeps clients local", () =>
201+
withHarness(
202+
lanNetworkInterfaces,
203+
Effect.gen(function* () {
204+
const serverExposure = yield* DesktopServerExposure.DesktopServerExposure;
205+
const settings = yield* DesktopAppSettings.DesktopAppSettings;
206+
yield* settings.setServerExposureMode("network-accessible");
207+
yield* settings.setTailscaleServe({ enabled: true, port: Option.none() });
208+
209+
const state = yield* serverExposure.configureFromSettings({ port: 4173 });
210+
assert.equal(state.mode, "local-only");
211+
const backendConfig = yield* serverExposure.backendConfig;
212+
assert.equal(backendConfig.bindHost, "127.0.0.1");
213+
assert.isFalse(backendConfig.tailscaleServeEnabled);
214+
// Choosing them again while the policy applies does not widen the backend either.
215+
yield* serverExposure.setMode("network-accessible");
216+
yield* serverExposure.setTailscaleServeEnabled({ enabled: true });
217+
assert.equal((yield* serverExposure.backendConfig).bindHost, "127.0.0.1");
218+
assert.isFalse((yield* serverExposure.backendConfig).tailscaleServeEnabled);
219+
// The saved choice returns once the policy allows it.
220+
const saved = yield* settings.get;
221+
assert.equal(saved.serverExposureMode, "network-accessible");
222+
assert.isTrue(saved.tailscaleServeEnabled);
223+
}),
224+
{},
225+
undefined,
226+
undefined,
227+
DesktopManagedPolicy.layerTest({
228+
schemaVersion: 1,
229+
organization: "Example Corp",
230+
limits: { clients: ["desktop"] },
231+
}),
232+
),
233+
);
234+
194235
it.effect("persists network-accessible mode and updates backend binding state", () =>
195236
withHarness(
196237
lanNetworkInterfaces,

‎apps/desktop/src/backend/DesktopServerExposure.ts‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import * as Semaphore from "effect/Semaphore";
2222
import * as HttpClient from "effect/http/HttpClient";
2323
import * as ChildProcessSpawner from "effect/process/ChildProcessSpawner";
2424

25+
import * as DesktopManagedPolicy from "../app/DesktopManagedPolicy.ts";
2526
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
2627
import * as DesktopConfig from "../app/DesktopConfig.ts";
2728
import * as DesktopNetworkInterfaces from "./DesktopNetworkInterfaces.ts";
@@ -482,6 +483,18 @@ export const make = Effect.gen(function* () {
482483

483484
const readNetworkInterfaces = networkInterfaces.read;
484485

486+
// The server refuses to bind wider than the policy's clients allow, so network access or Serve
487+
// saved before the policy would keep the backend from starting. The backend runs without them;
488+
// the saved choice stays for when the policy allows it.
489+
const remoteAllowed = yield* (yield* DesktopManagedPolicy.DesktopManagedPolicy).read.pipe(
490+
Effect.map((found) => found?.document.limits?.clients?.includes("remote") ?? true),
491+
Effect.orElseSucceed(() => false),
492+
);
493+
const withinPolicy = (settings: DesktopAppSettings.DesktopSettings) =>
494+
remoteAllowed
495+
? settings
496+
: { ...settings, serverExposureMode: "local-only" as const, tailscaleServeEnabled: false };
497+
485498
const readCurrentState = (currentNetworkInterfaces: DesktopNetworkInterfaces.NetworkInterfaces) =>
486499
Ref.get(stateRef).pipe(
487500
Effect.map((state) =>
@@ -501,8 +514,8 @@ export const make = Effect.gen(function* () {
501514
const settings = yield* desktopSettings.get;
502515
const currentNetworkInterfaces = yield* readNetworkInterfaces;
503516
const resolved = resolveRuntimeState({
504-
requestedMode: settings.serverExposureMode,
505-
settings,
517+
requestedMode: withinPolicy(settings).serverExposureMode,
518+
settings: withinPolicy(settings),
506519
port,
507520
networkInterfaces: currentNetworkInterfaces,
508521
advertisedHostOverride: config.desktopLanHostOverride,
@@ -524,8 +537,8 @@ export const make = Effect.gen(function* () {
524537
};
525538
const currentNetworkInterfaces = yield* readNetworkInterfaces;
526539
const resolved = resolveRuntimeState({
527-
requestedMode: mode,
528-
settings: nextSettings,
540+
requestedMode: withinPolicy(nextSettings).serverExposureMode,
541+
settings: withinPolicy(nextSettings),
529542
port: previous.port,
530543
networkInterfaces: currentNetworkInterfaces,
531544
advertisedHostOverride: config.desktopLanHostOverride,
@@ -576,7 +589,7 @@ export const make = Effect.gen(function* () {
576589

577590
const nextState = yield* Ref.updateAndGet(stateRef, (current) => ({
578591
...current,
579-
tailscaleServeEnabled: result.settings.tailscaleServeEnabled,
592+
tailscaleServeEnabled: withinPolicy(result.settings).tailscaleServeEnabled,
580593
tailscaleServePort: result.settings.tailscaleServePort,
581594
}));
582595

‎apps/desktop/src/ipc/DesktopIpcHandlers.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import {
3636
getAppBranding,
3737
getLocalEnvironmentBootstraps,
3838
getLocalEnvironmentBearerToken,
39-
getRelayTelemetryEnabled,
39+
installRelayTelemetryEnabled,
4040
getSystemLocale,
4141
getWindowFullscreenState,
4242
openExternal,
@@ -91,7 +91,7 @@ export const installDesktopIpcHandlers = Effect.fn("desktop.ipc.installHandlers"
9191
yield* ipc.handleSync(takeLegacyLocalStorage);
9292
yield* ipc.handle(completeLegacyLocalStorage);
9393
yield* ipc.handleSync(getAppBranding);
94-
yield* ipc.handleSync(getRelayTelemetryEnabled);
94+
yield* installRelayTelemetryEnabled();
9595
yield* ipc.handleSync(getSystemLocale);
9696
yield* ipc.handleSync(getWindowFullscreenState);
9797
yield* ipc.handleSync(getLocalEnvironmentBootstraps);

‎apps/desktop/src/ipc/methods/window.test.ts‎

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
import { assert, describe, it } from "@effect/vitest";
22
import * as NodeServices from "@effect/platform-node/NodeServices";
3+
import type { ManagedPolicyLimits } from "@t3tools/contracts";
34
import * as HostProcess from "@t3tools/shared/HostProcess";
5+
import { ManagedPolicyFileError } from "@t3tools/shared/managedPolicyFile";
46
import * as FileSystem from "effect/FileSystem";
57
import * as Path from "effect/Path";
68
import * as Effect from "effect/Effect";
@@ -21,11 +23,14 @@ import * as DesktopBackendConfiguration from "../../backend/DesktopBackendConfig
2123
import * as DesktopBackendManager from "../../backend/DesktopBackendManager.ts";
2224
import * as DesktopBackendPool from "../../backend/DesktopBackendPool.ts";
2325
import * as DesktopAppSettings from "../../settings/DesktopAppSettings.ts";
26+
import * as DesktopManagedPolicy from "../../app/DesktopManagedPolicy.ts";
2427
import * as ElectronDialog from "../../electron/ElectronDialog.ts";
2528
import * as ElectronWindow from "../../electron/ElectronWindow.ts";
29+
import * as IpcChannels from "../channels.ts";
30+
import * as DesktopIpc from "../DesktopIpc.ts";
2631
import {
2732
getLocalEnvironmentBootstraps,
28-
getRelayTelemetryEnabled,
33+
installRelayTelemetryEnabled,
2934
pickProjectFavicon,
3035
probeRemoteEditors,
3136
} from "./window.ts";
@@ -177,21 +182,54 @@ describe("getLocalEnvironmentBootstraps", () => {
177182
});
178183
});
179184

180-
describe("getRelayTelemetryEnabled", () => {
185+
describe("installRelayTelemetryEnabled", () => {
186+
// The renderer reads this over sync IPC, so the answer must not wait on the filesystem.
187+
const relayTelemetryEnabled = (
188+
env: NodeJS.ProcessEnv,
189+
policy?: Parameters<typeof DesktopManagedPolicy.layerTest>[0],
190+
) =>
191+
Effect.gen(function* () {
192+
const listeners = new Map<string, DesktopIpc.DesktopIpcSyncListener>();
193+
const ipcMain: DesktopIpc.DesktopIpcMain = {
194+
removeHandler: () => undefined,
195+
handle: () => undefined,
196+
removeAllListeners: (channel) => void listeners.delete(channel),
197+
on: (channel, listener) => void listeners.set(channel, listener),
198+
};
199+
yield* installRelayTelemetryEnabled().pipe(
200+
Effect.provideService(HostProcess.Environment, env),
201+
Effect.provide(
202+
Layer.mergeAll(DesktopIpc.layer(ipcMain), DesktopManagedPolicy.layerTest(policy)),
203+
),
204+
);
205+
const event = { returnValue: undefined as unknown };
206+
listeners.get(IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL)?.(event as never);
207+
return event.returnValue;
208+
}).pipe(Effect.scoped);
209+
181210
it.effect("reads the desktop host opt-out before returning the renderer policy", () =>
182211
Effect.gen(function* () {
212+
assert.isFalse(yield* relayTelemetryEnabled({ T3CODE_TELEMETRY_ENABLED: "false" }));
213+
assert.isTrue(yield* relayTelemetryEnabled({}));
214+
}),
215+
);
216+
217+
it.effect("turns relay tracing off when the managed policy turns telemetry off", () =>
218+
Effect.gen(function* () {
219+
const policy = (limits: ManagedPolicyLimits) => ({
220+
schemaVersion: 1 as const,
221+
organization: "Example Corp",
222+
limits,
223+
});
224+
assert.isFalse(yield* relayTelemetryEnabled({}, policy({ telemetry: false })));
225+
assert.isTrue(yield* relayTelemetryEnabled({}, policy({ webhookTasks: false })));
226+
// A policy that cannot be read fails closed.
183227
assert.isFalse(
184-
yield* getRelayTelemetryEnabled.handler().pipe(
185-
Effect.provideService(HostProcess.Environment, {
186-
T3CODE_TELEMETRY_ENABLED: "false",
187-
}),
228+
yield* relayTelemetryEnabled(
229+
{},
230+
new ManagedPolicyFileError({ path: "/test", reason: "bad JSON" }),
188231
),
189232
);
190-
assert.isTrue(
191-
yield* getRelayTelemetryEnabled
192-
.handler()
193-
.pipe(Effect.provideService(HostProcess.Environment, {})),
194-
);
195233
}),
196234
);
197235
});

‎apps/desktop/src/ipc/methods/window.ts‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import * as DesktopBackendConfiguration from "../../backend/DesktopBackendConfig
2727
import * as DesktopBackendPool from "../../backend/DesktopBackendPool.ts";
2828
import * as DesktopLocalEnvironmentAuth from "../../backend/DesktopLocalEnvironmentAuth.ts";
2929
import * as DesktopEnvironment from "../../app/DesktopEnvironment.ts";
30+
import * as DesktopManagedPolicy from "../../app/DesktopManagedPolicy.ts";
3031
import * as DesktopAppSettings from "../../settings/DesktopAppSettings.ts";
3132
import * as DesktopWslBackend from "../../wsl/DesktopWslBackend.ts";
3233
import * as DesktopWslEnvironment from "../../wsl/DesktopWslEnvironment.ts";
@@ -72,13 +73,28 @@ export const getAppBranding = DesktopIpc.makeSyncIpcMethod({
7273
}),
7374
});
7475

75-
export const getRelayTelemetryEnabled = DesktopIpc.makeSyncIpcMethod({
76-
channel: IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL,
77-
result: Schema.Boolean,
78-
handler: Effect.fn("desktop.ipc.window.getRelayTelemetryEnabled")(function* () {
79-
return isRelayTracingEnabled(yield* HostProcess.Environment);
80-
}),
81-
});
76+
/**
77+
* Relay traces leave the machine, so a policy with `telemetry: false`, or one that cannot be read,
78+
* stops them. Read once here: a sync IPC handler cannot wait on the filesystem.
79+
*/
80+
export const installRelayTelemetryEnabled = Effect.fn("desktop.ipc.window.installRelayTelemetry")(
81+
function* () {
82+
const ipc = yield* DesktopIpc.DesktopIpc;
83+
const enabled =
84+
isRelayTracingEnabled(yield* HostProcess.Environment) &&
85+
(yield* (yield* DesktopManagedPolicy.DesktopManagedPolicy).read.pipe(
86+
Effect.map((found) => found?.document.limits?.telemetry !== false),
87+
Effect.orElseSucceed(() => false),
88+
));
89+
yield* ipc.handleSync(
90+
DesktopIpc.makeSyncIpcMethod({
91+
channel: IpcChannels.GET_RELAY_TELEMETRY_ENABLED_CHANNEL,
92+
result: Schema.Boolean,
93+
handler: () => Effect.succeed(enabled),
94+
}),
95+
);
96+
},
97+
);
8298

8399
export const getSystemLocale = DesktopIpc.makeSyncIpcMethod({
84100
channel: IpcChannels.GET_SYSTEM_LOCALE_CHANNEL,

0 commit comments

Comments
 (0)