Skip to content

Commit 655d57e

Browse files
committed
fix(server): defer Tailscale endpoint discovery during startup
- Advertise bound endpoints immediately and publish Tailscale endpoints after validation completes - Fall back to available endpoints when discovery fails
1 parent d01b92c commit 655d57e

4 files changed

Lines changed: 173 additions & 20 deletions

File tree

‎apps/server/src/environment/DirectEndpoints.test.ts‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ import * as NodeServices from "@effect/platform-node/NodeServices";
22
import { it as effectIt } from "@effect/vitest";
33
import type * as NodeOS from "node:os";
44
import * as Effect from "effect/Effect";
5+
import * as Deferred from "effect/Deferred";
6+
import * as Fiber from "effect/Fiber";
7+
import * as Ref from "effect/Ref";
58
import * as Layer from "effect/Layer";
69
import * as Sink from "effect/Sink";
710
import * as Stream from "effect/Stream";
@@ -288,6 +291,48 @@ describe("DirectEndpoints Tailscale Serve", () => {
288291
}),
289292
);
290293

294+
effectIt.effect(
295+
"returns bound endpoints during validation and reuses only a completed Serve result",
296+
() =>
297+
Effect.gen(function* () {
298+
const status = yield* Ref.make(200);
299+
const finishProbe = yield* Deferred.make<void>();
300+
const probeStarted = yield* Deferred.make<void>();
301+
const service = yield* DirectEndpoints.make.pipe(
302+
Effect.provide(
303+
Layer.mergeAll(
304+
layerServeConfig,
305+
layerTailscaleUp,
306+
Layer.succeed(
307+
HttpClient.HttpClient,
308+
HttpClient.make((request) =>
309+
Deferred.succeed(probeStarted, undefined).pipe(
310+
Effect.andThen(Deferred.await(finishProbe)),
311+
Effect.andThen(Ref.get(status)),
312+
Effect.map((status) =>
313+
HttpClientResponse.fromWeb(request, new Response(null, { status })),
314+
),
315+
),
316+
),
317+
),
318+
),
319+
),
320+
);
321+
const resolving = yield* Effect.forkScoped(service.resolve());
322+
yield* Deferred.await(probeStarted);
323+
expect(yield* service.resolveAvailable()).toEqual([]);
324+
yield* Deferred.succeed(finishProbe, undefined);
325+
const validated = yield* Fiber.join(resolving);
326+
expect(validated).toEqual([
327+
{ kind: "tailnet", httpBaseUrl: "https://bb-1.tail1234.ts.net/" },
328+
]);
329+
expect(yield* service.resolveAvailable()).toEqual(validated);
330+
yield* Ref.set(status, 502);
331+
expect(yield* service.resolve()).toEqual([]);
332+
expect(yield* service.resolveAvailable()).toEqual([]);
333+
}).pipe(Effect.scoped),
334+
);
335+
291336
effectIt.effect("leaves the tailnet name out when Serve is not forwarding", () =>
292337
Effect.gen(function* () {
293338
expect(yield* resolveWithServe(502)).toEqual([]);

‎apps/server/src/environment/DirectEndpoints.ts‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import * as Duration from "effect/Duration";
99
import * as Effect from "effect/Effect";
1010
import * as Layer from "effect/Layer";
1111
import * as Option from "effect/Option";
12+
import * as Ref from "effect/Ref";
1213
import { HttpClient } from "effect/http";
1314
import * as ChildProcessSpawner from "effect/process/ChildProcessSpawner";
1415
import * as NodeNet from "node:net";
@@ -34,6 +35,7 @@ const TAILSCALE_ENDPOINT_TIMEOUT = Duration.seconds(3);
3435
export class DirectEndpoints extends Context.Service<
3536
DirectEndpoints,
3637
{
38+
readonly resolveAvailable: () => Effect.Effect<ReadonlyArray<ServerDirectEndpoint>>;
3739
readonly resolve: () => Effect.Effect<ReadonlyArray<ServerDirectEndpoint>>;
3840
}
3941
>()("t3/environment/DirectEndpoints") {}
@@ -128,7 +130,8 @@ export const make = Effect.gen(function* () {
128130
: Effect.succeed(false);
129131
yield* Effect.forkDetach(onCloudVm);
130132

131-
const resolve = Effect.gen(function* () {
133+
const servedEndpoint = yield* Ref.make<Option.Option<string>>(Option.none());
134+
const resolveAvailable = Effect.fn("DirectEndpoints.resolveAvailable")(function* () {
132135
const endpoints = [
133136
...resolveBoundEndpoints({
134137
platform,
@@ -138,6 +141,12 @@ export const make = Effect.gen(function* () {
138141
onCloudVm: yield* onCloudVm,
139142
}),
140143
];
144+
const servedUrl = yield* Ref.get(servedEndpoint);
145+
if (Option.isSome(servedUrl)) endpoints.push({ kind: "tailnet", httpBaseUrl: servedUrl.value });
146+
return endpoints;
147+
});
148+
149+
const resolve = Effect.gen(function* () {
141150
// Serve setup can fail without stopping startup; advertise only after it answers as this server.
142151
if (config.tailscaleServeEnabled) {
143152
const servedUrl = yield* readTailscaleStatus.pipe(
@@ -158,14 +167,13 @@ export const make = Effect.gen(function* () {
158167
Effect.provideService(ChildProcessSpawner.ChildProcessSpawner, spawner),
159168
Effect.provideService(HttpClient.HttpClient, httpClient),
160169
);
161-
if (Option.isSome(servedUrl)) {
162-
endpoints.push({ kind: "tailnet", httpBaseUrl: servedUrl.value });
163-
}
170+
yield* Ref.set(servedEndpoint, servedUrl);
164171
}
165-
return endpoints;
172+
return yield* resolveAvailable();
166173
});
167174

168175
return DirectEndpoints.of({
176+
resolveAvailable,
169177
resolve: Effect.fn("DirectEndpoints.resolve")(function () {
170178
return resolve;
171179
}),

‎apps/server/src/ws.test.ts‎

Lines changed: 76 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ it.effect("resends late editors without rolling back updates already sent", () =
154154
Deferred.await(settingsSent).pipe(Effect.as("file-explorer" as const)),
155155
},
156156
{ resolveTargets: () => Effect.succeed([]) },
157+
{ resolve: () => Effect.succeed([]) },
157158
).pipe(
158159
Stream.tap((event) =>
159160
event.type === "settingsUpdated" ? Deferred.succeed(settingsSent, undefined) : Effect.void,
@@ -185,6 +186,7 @@ it.effect("resends a reveal kind and remote targets that outlast the snapshot ti
185186
resolveFileManagerRevealKind: () => Effect.succeed("file-explorer"),
186187
},
187188
{ resolveTargets: () => Deferred.await(finishDiscovery) },
189+
{ resolve: () => Effect.succeed([]) },
188190
).pipe(Stream.runCollect, Effect.forkScoped({ startImmediately: true }));
189191
yield* TestClock.adjust("6 seconds");
190192
yield* Deferred.succeed(finishDiscovery, targets);
@@ -618,8 +620,15 @@ const layerConfigSources = Layer.mergeAll(
618620
Layer.provideMerge(NodeServices.layer),
619621
);
620622

621-
it.effect.each(["pending", "cached"] as const)(
622-
"%s remote discovery preserves initial config and updates through discovery and ACK",
623+
it.effect.each([
624+
"pending",
625+
"cached",
626+
"direct-pending",
627+
"direct-cached",
628+
"direct-failed",
629+
"direct-interrupted",
630+
] as const)(
631+
"%s endpoint discovery preserves initial config and updates through discovery and ACK",
623632
(discovery) =>
624633
Effect.gen(function* () {
625634
const keybindings = yield* Keybindings.Keybindings;
@@ -638,6 +647,15 @@ it.effect.each(["pending", "cached"] as const)(
638647
const remoteDiscoveryStarted = yield* Deferred.make<void>();
639648
const finishRemoteDiscovery = yield* Deferred.make<void>();
640649
const targets = [{ kind: "mdns" as const, host: "test.local" }];
650+
const direct = discovery.startsWith("direct-");
651+
const bound = [{ kind: "lan" as const, httpBaseUrl: "http://192.168.1.10:3773/" }];
652+
const endpoints = [
653+
...bound,
654+
{ kind: "tailnet" as const, httpBaseUrl: "https://test.ts.net/" },
655+
];
656+
const directStarted = yield* Deferred.make<void>();
657+
const finishDirect = yield* Deferred.make<void>();
658+
const directStopped = yield* Deferred.make<void>();
641659
const responses = yield* Queue.unbounded<ServerConfigStreamEvent>();
642660
const configRpcServices = Layer.mergeAll(
643661
layerUnusedConfigRpcServices,
@@ -659,12 +677,30 @@ it.effect.each(["pending", "cached"] as const)(
659677
resolveTargets: () =>
660678
Deferred.succeed(remoteDiscoveryStarted, undefined).pipe(
661679
Effect.andThen(
662-
discovery === "cached" ? Effect.void : Deferred.await(finishRemoteDiscovery),
680+
discovery === "cached" || direct
681+
? Effect.void
682+
: Deferred.await(finishRemoteDiscovery),
663683
),
664684
Effect.as(targets),
665685
),
666686
}),
667-
Layer.mock(DirectEndpoints.DirectEndpoints)({ resolve: () => Effect.succeed([]) }),
687+
Layer.mock(DirectEndpoints.DirectEndpoints)({
688+
resolveAvailable: () => Effect.succeed(discovery === "direct-cached" ? endpoints : bound),
689+
resolve: () =>
690+
direct
691+
? Deferred.succeed(directStarted, undefined).pipe(
692+
Effect.andThen(
693+
discovery === "direct-cached" ? Effect.void : Deferred.await(finishDirect),
694+
),
695+
Effect.andThen(
696+
discovery === "direct-failed"
697+
? Effect.die("probe failed")
698+
: Effect.succeed(endpoints),
699+
),
700+
Effect.onExit(() => Deferred.succeed(directStopped, undefined)),
701+
)
702+
: Effect.succeed(bound),
703+
}),
668704
Layer.mock(ManagedProjectFolders.ManagedProjectFolders)({
669705
scratchRoot: Effect.succeedNone,
670706
namedProjectsRoot: process.cwd(),
@@ -744,7 +780,14 @@ it.effect.each(["pending", "cached"] as const)(
744780
const snapshot = yield* Queue.take(responses);
745781
assert.equal(snapshot.type, "snapshot");
746782
if (snapshot.type !== "snapshot") return yield* Effect.die("Missing initial snapshot");
747-
assert.deepEqual(snapshot.config.remoteOpenTargets, discovery === "cached" ? targets : []);
783+
assert.deepEqual(
784+
snapshot.config.remoteOpenTargets,
785+
discovery === "cached" || direct ? targets : [],
786+
);
787+
assert.deepEqual(
788+
snapshot.config.directEndpoints,
789+
discovery === "direct-cached" ? endpoints : bound,
790+
);
748791
assert.isFalse(snapshot.config.settings.defaultAutoPull);
749792
assert.deepEqual(snapshot.config.keybindings, initialKeybindings);
750793
const duringAck = yield* keybindings.upsertKeybindingRule({
@@ -795,7 +838,31 @@ it.effect.each(["pending", "cached"] as const)(
795838
assert.deepEqual(resolved.config.keybindings, latestKeybindings.keybindings);
796839
yield* acknowledge;
797840
}
841+
if (direct) {
842+
yield* Deferred.await(directStarted);
843+
if (discovery === "direct-pending") {
844+
yield* Deferred.succeed(finishDirect, undefined);
845+
const resolved = yield* Queue.take(responses);
846+
assert.equal(resolved.type, "snapshot");
847+
if (resolved.type !== "snapshot") return yield* Effect.die("Missing direct endpoints");
848+
assert.deepEqual(resolved.config.directEndpoints, endpoints);
849+
assert.deepEqual(
850+
resolved.config.settings,
851+
ServerSettings.redactServerSettingsForClient(latestSettings),
852+
);
853+
assert.deepEqual(resolved.config.keybindings, latestKeybindings.keybindings);
854+
yield* acknowledge;
855+
} else if (discovery === "direct-failed") {
856+
yield* Deferred.succeed(finishDirect, undefined);
857+
yield* Deferred.await(directStopped);
858+
yield* settings.updateSettings({ defaultAutoPull: false });
859+
const event = yield* Queue.take(responses);
860+
assert.equal(event.type, "settingsUpdated");
861+
yield* acknowledge;
862+
}
863+
}
798864
yield* server.write(0, { _tag: "Interrupt", requestId, interruptors: [] });
865+
if (direct) yield* Deferred.await(directStopped);
799866
}).pipe(
800867
Effect.provide(
801868
Layer.mergeAll(
@@ -858,7 +925,10 @@ it.effect("on-demand clients get provider config without workspace snapshots", (
858925
Layer.mock(RemoteOpenTargets.RemoteOpenTargets)({
859926
resolveTargets: () => Effect.succeed([]),
860927
}),
861-
Layer.mock(DirectEndpoints.DirectEndpoints)({ resolve: () => Effect.succeed([]) }),
928+
Layer.mock(DirectEndpoints.DirectEndpoints)({
929+
resolve: () => Effect.succeed([]),
930+
resolveAvailable: () => Effect.succeed([]),
931+
}),
862932
Layer.mock(ManagedProjectFolders.ManagedProjectFolders)({
863933
scratchRoot: Effect.succeedNone,
864934
namedProjectsRoot: process.cwd(),

‎apps/server/src/ws.ts‎

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,7 @@ export const withLateConfigDiscovery = <E, R>(
320320
liveUpdates: Stream.Stream<ServerConfigStreamEvent, E, R>,
321321
launcher: EditorDiscovery,
322322
remoteOpenTargets: RemoteOpenTargets.RemoteOpenTargets["Service"],
323+
directEndpoints: Pick<DirectEndpoints.DirectEndpoints["Service"], "resolve">,
323324
) => {
324325
const lateEditorConfig = Stream.fromEffect(launcher.resolveAvailableEditors()).pipe(
325326
Stream.filter(
@@ -347,7 +348,15 @@ export const withLateConfigDiscovery = <E, R>(
347348
Stream.map((targets) => ({ type: "remoteOpenTargetsResolved" as const, targets })),
348349
);
349350

350-
return Stream.merge(liveUpdates, Stream.merge(lateEditorConfig, lateRemoteOpenTargets)).pipe(
351+
const lateDirectEndpoints = Stream.fromEffect(directEndpoints.resolve()).pipe(
352+
Stream.catchCause(() => Stream.empty),
353+
Stream.map((endpoints) => ({ type: "directEndpointsResolved" as const, endpoints })),
354+
);
355+
356+
return Stream.merge(
357+
liveUpdates,
358+
Stream.merge(lateEditorConfig, Stream.merge(lateRemoteOpenTargets, lateDirectEndpoints)),
359+
).pipe(
351360
Stream.mapAccum(
352361
(): ClientServerConfig => config,
353362
(current, event): readonly [ClientServerConfig, ReadonlyArray<ServerConfigStreamEvent>] => {
@@ -366,6 +375,13 @@ export const withLateConfigDiscovery = <E, R>(
366375
const next = { ...current, remoteOpenTargets: event.targets };
367376
return [next, [{ version: 1, type: "snapshot", config: next }]];
368377
}
378+
case "directEndpointsResolved": {
379+
if (JSON.stringify(current.directEndpoints ?? []) === JSON.stringify(event.endpoints)) {
380+
return [current, []];
381+
}
382+
const next = { ...current, directEndpoints: event.endpoints };
383+
return [next, [{ version: 1, type: "snapshot", config: next }]];
384+
}
369385
case "keybindingsUpdated":
370386
return [{ ...current, ...event.payload }, [event]];
371387
case "providerStatuses":
@@ -1769,7 +1785,7 @@ export const layerWsRpc = (
17691785
const loadServerConfig = Effect.fn("ws.loadServerConfig")(function* (options: {
17701786
readonly usageLimitsCommand: boolean;
17711787
readonly workspaceSnapshotsOnDemand: boolean;
1772-
readonly deferRemoteOpenTargets: boolean;
1788+
readonly deferNetworkDiscovery: boolean;
17731789
}) {
17741790
const keybindingsConfig = yield* keybindings.loadConfigState;
17751791
const currentProviders = yield* providerRegistry.getProviders;
@@ -1789,10 +1805,12 @@ export const layerWsRpc = (
17891805
const discovery = yield* resolveOpenDiscoveryForConfig({
17901806
editors: externalLauncher.resolveAvailableEditors(),
17911807
fileManagerRevealKind: externalLauncher.resolveFileManagerRevealKind(),
1792-
remoteOpenTargets: options.deferRemoteOpenTargets
1808+
remoteOpenTargets: options.deferNetworkDiscovery
17931809
? Effect.succeed([])
17941810
: remoteOpenTargets.resolveTargets(),
1795-
directEndpoints: directEndpoints.resolve(),
1811+
directEndpoints: options.deferNetworkDiscovery
1812+
? directEndpoints.resolveAvailable()
1813+
: directEndpoints.resolve(),
17961814
});
17971815

17981816
return {
@@ -2229,7 +2247,7 @@ export const layerWsRpc = (
22292247
loadServerConfig({
22302248
usageLimitsCommand: false,
22312249
workspaceSnapshotsOnDemand: false,
2232-
deferRemoteOpenTargets: false,
2250+
deferNetworkDiscovery: false,
22332251
}),
22342252
[WS_METHODS.serverSearchAcpRegistry]: (input) =>
22352253
acpRegistryCatalog
@@ -3154,10 +3172,16 @@ export const layerWsRpc = (
31543172
const remoteTargets = yield* Effect.forkScoped(remoteOpenTargets.resolveTargets(), {
31553173
startImmediately: true,
31563174
});
3175+
const directResult = yield* Effect.forkScoped(
3176+
directEndpoints
3177+
.resolve()
3178+
.pipe(Effect.catchCause(() => directEndpoints.resolveAvailable())),
3179+
{ startImmediately: true },
3180+
);
31573181
const config = yield* loadServerConfig({
31583182
usageLimitsCommand,
31593183
workspaceSnapshotsOnDemand,
3160-
deferRemoteOpenTargets: true,
3184+
deferNetworkDiscovery: true,
31613185
});
31623186
const keybindingsUpdates = keybindingsChanges.pipe(
31633187
Stream.map((event) => ({
@@ -3253,9 +3277,15 @@ export const layerWsRpc = (
32533277
rpcInitialItems([
32543278
{ version: 1 as const, type: "snapshot" as const, config: initialConfig },
32553279
]),
3256-
withLateConfigDiscovery(initialConfig, liveUpdates, externalLauncher, {
3257-
resolveTargets: () => Fiber.join(remoteTargets),
3258-
}),
3280+
withLateConfigDiscovery(
3281+
initialConfig,
3282+
liveUpdates,
3283+
externalLauncher,
3284+
{
3285+
resolveTargets: () => Fiber.join(remoteTargets),
3286+
},
3287+
{ resolve: () => Fiber.join(directResult) },
3288+
),
32593289
);
32603290
}),
32613291
),

0 commit comments

Comments
 (0)