Skip to content

Commit abc8a9e

Browse files
committed
fix(connections): show Tailscale HTTPS setup failures
1 parent cefb544 commit abc8a9e

9 files changed

Lines changed: 236 additions & 31 deletions

File tree

‎apps/mobile/src/features/connection/ConnectionEnvironmentRow.tsx‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@ import { ConnectionTraceId } from "./ConnectionTraceId";
33
import { SymbolView } from "../../components/ui/AppSymbol";
44
import { hasSavedBearerRoute, hostFreezeNotice } from "@t3tools/client-runtime/connection";
55
import type { AtomCommandResult } from "@t3tools/client-runtime/state/runtime";
6-
import { type EnvironmentId, resolveEnvironmentMachineKind } from "@t3tools/contracts";
6+
import {
7+
type EnvironmentId,
8+
resolveEnvironmentMachineKind,
9+
tailscaleServeFailureMessage,
10+
} from "@t3tools/contracts";
711
import { useAtomValue } from "@effect/atom-react";
812
import * as Cause from "effect/Cause";
913
import { AsyncResult } from "effect/reactivity";
@@ -67,6 +71,9 @@ export function ConnectionEnvironmentRow(props: {
6771
const statusLabel = connectionStatusLabel(props.environment);
6872
const statusTraceId = enabled ? props.environment.connectionErrorTraceId : null;
6973
const hasConnectionFailure = enabled && props.environment.connectionError !== null;
74+
const tailscaleFailure = enabled
75+
? tailscaleServeFailureMessage(serverConfig?.tailscaleServeFailure)
76+
: null;
7077
const freeze = enabled
7178
? hostFreezeNotice(props.environment.environmentLabel, serverConfig?.lastEventLoopStall)
7279
: null;
@@ -154,6 +161,11 @@ export function ConnectionEnvironmentRow(props: {
154161
) : null}
155162
</Text>
156163
) : null}
164+
{tailscaleFailure ? (
165+
<Text className="text-xs text-warning-foreground" selectable>
166+
{tailscaleFailure}
167+
</Text>
168+
) : null}
157169
{freeze ? (
158170
<Text
159171
className="text-xs text-warning-foreground"

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,70 @@ const resolveWithServe = (probeStatus: number) =>
285285
);
286286

287287
describe("DirectEndpoints Tailscale Serve", () => {
288+
effectIt.effect("reports safe Serve setup failures and clears them after recovery", () =>
289+
Effect.gen(function* () {
290+
const failure = yield* Ref.make<string | null>(
291+
"Access denied: serve config denied tskey-secret",
292+
);
293+
const probeStatus = yield* Ref.make(502);
294+
const spawner = ChildProcessSpawner.make((command) =>
295+
Ref.get(failure).pipe(
296+
Effect.map((failureStderr) => {
297+
const status = command._tag === "StandardCommand" && command.args[0] === "status";
298+
const stderr = status ? null : failureStderr;
299+
return ChildProcessSpawner.makeHandle({
300+
pid: ChildProcessSpawner.ProcessId(1),
301+
exitCode: Effect.succeed(ChildProcessSpawner.ExitCode(stderr ? 1 : 0)),
302+
isRunning: Effect.succeed(false),
303+
kill: () => Effect.void,
304+
unref: Effect.succeed(Effect.void),
305+
stdin: Sink.drain,
306+
stdout: Stream.make(new TextEncoder().encode(status ? TAILSCALE_STATUS_JSON : "")),
307+
stderr: Stream.make(new TextEncoder().encode(stderr ?? "")),
308+
all: Stream.empty,
309+
getInputFd: () => Sink.drain,
310+
getOutputFd: () => Stream.empty,
311+
});
312+
}),
313+
),
314+
);
315+
const service = yield* DirectEndpoints.make.pipe(
316+
Effect.provide(
317+
Layer.mergeAll(
318+
layerServeConfig(),
319+
Layer.succeed(ChildProcessSpawner.ChildProcessSpawner, spawner),
320+
Layer.succeed(
321+
HttpClient.HttpClient,
322+
HttpClient.make((request) =>
323+
Ref.get(probeStatus).pipe(
324+
Effect.map((status) =>
325+
HttpClientResponse.fromWeb(request, new Response(null, { status })),
326+
),
327+
),
328+
),
329+
),
330+
),
331+
),
332+
);
333+
const configure = service.configureTailscaleServe({ localPort: 3773 }).pipe(Effect.result);
334+
expect((yield* configure)._tag).toBe("Failure");
335+
expect(yield* service.tailscaleServeFailure).toBe("permission-denied");
336+
expect(yield* service.resolve()).toEqual([]);
337+
expect(yield* service.tailscaleServeFailure).toBe("permission-denied");
338+
yield* Ref.set(probeStatus, 200);
339+
expect(yield* service.resolve()).toEqual([
340+
{ kind: "tailnet", httpBaseUrl: "https://bb-1.tail1234.ts.net/" },
341+
]);
342+
expect(yield* service.tailscaleServeFailure).toBeNull();
343+
yield* Ref.set(failure, "unrecognized failure tskey-secret private-device");
344+
expect((yield* configure)._tag).toBe("Failure");
345+
expect(yield* service.tailscaleServeFailure).toBe("unknown");
346+
yield* Ref.set(failure, null);
347+
expect((yield* configure)._tag).toBe("Success");
348+
expect(yield* service.tailscaleServeFailure).toBeNull();
349+
}),
350+
);
351+
288352
effectIt.effect("lists the tailnet name once Serve answers for this server", () =>
289353
Effect.gen(function* () {
290354
expect(yield* resolveWithServe(200)).toEqual([

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

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
import type { ServerDirectEndpoint } from "@t3tools/contracts";
1+
import type { ServerDirectEndpoint, TailscaleServeFailure } from "@t3tools/contracts";
22
import {
33
buildTailscaleHttpsBaseUrl,
4+
ensureTailscaleServe,
5+
type TailscaleCommandError,
46
probeTailscaleHttpsEndpoint,
57
readTailscaleStatus,
68
} from "@t3tools/tailscale";
@@ -10,6 +12,8 @@ import * as Effect from "effect/Effect";
1012
import * as Layer from "effect/Layer";
1113
import * as Option from "effect/Option";
1214
import * as Ref from "effect/Ref";
15+
import * as Stream from "effect/Stream";
16+
import * as SubscriptionRef from "effect/SubscriptionRef";
1317
import { HttpClient } from "effect/http";
1418
import * as ChildProcessSpawner from "effect/process/ChildProcessSpawner";
1519
import * as NodeNet from "node:net";
@@ -35,6 +39,13 @@ const TAILSCALE_ENDPOINT_TIMEOUT = Duration.seconds(3);
3539
export class DirectEndpoints extends Context.Service<
3640
DirectEndpoints,
3741
{
42+
readonly configureTailscaleServe: (input: {
43+
readonly localPort: number;
44+
readonly servePort?: number;
45+
readonly localHost?: string;
46+
}) => Effect.Effect<void, TailscaleCommandError>;
47+
readonly tailscaleServeFailure: Effect.Effect<TailscaleServeFailure | null>;
48+
readonly tailscaleServeFailureChanges: Stream.Stream<TailscaleServeFailure | null>;
3849
readonly resolveAvailable: () => Effect.Effect<ReadonlyArray<ServerDirectEndpoint>>;
3950
readonly resolve: () => Effect.Effect<ReadonlyArray<ServerDirectEndpoint>>;
4051
}
@@ -130,6 +141,24 @@ export const make = Effect.gen(function* () {
130141
: Effect.succeed(false);
131142
yield* Effect.forkDetach(onCloudVm);
132143

144+
const failure = yield* SubscriptionRef.make<TailscaleServeFailure | null>(null);
145+
const configureTailscaleServe = Effect.fn("DirectEndpoints.configureTailscaleServe")(
146+
(input: Parameters<typeof ensureTailscaleServe>[0]) =>
147+
ensureTailscaleServe(input).pipe(
148+
Effect.provideService(ChildProcessSpawner.ChildProcessSpawner, spawner),
149+
Effect.tap(() => SubscriptionRef.set(failure, null)),
150+
Effect.tapError((error) =>
151+
SubscriptionRef.set(
152+
failure,
153+
error._tag === "TailscaleCommandExitError" &&
154+
error.stderrDiagnostic === "permission-denied"
155+
? "permission-denied"
156+
: "unknown",
157+
),
158+
),
159+
),
160+
);
161+
133162
const servedEndpoint = yield* Ref.make<Option.Option<string>>(Option.none());
134163
const resolveAvailable = Effect.fn("DirectEndpoints.resolveAvailable")(function* () {
135164
const endpoints = [
@@ -168,11 +197,15 @@ export const make = Effect.gen(function* () {
168197
Effect.provideService(HttpClient.HttpClient, httpClient),
169198
);
170199
yield* Ref.set(servedEndpoint, servedUrl);
200+
if (Option.isSome(servedUrl)) yield* SubscriptionRef.set(failure, null);
171201
}
172202
return yield* resolveAvailable();
173203
});
174204

175205
return DirectEndpoints.of({
206+
configureTailscaleServe,
207+
tailscaleServeFailure: SubscriptionRef.get(failure),
208+
tailscaleServeFailureChanges: SubscriptionRef.changes(failure).pipe(Stream.changes),
176209
resolveAvailable,
177210
resolve: Effect.fn("DirectEndpoints.resolve")(function () {
178211
return resolve;

‎apps/server/src/server.ts‎

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import * as HttpApiBuilder from "effect/http-api/HttpApiBuilder";
2626

2727
import * as BackgroundPolicy from "./background/BackgroundPolicy.ts";
2828
import * as HostPowerMonitor from "./background/HostPowerMonitor.ts";
29+
import { tailscaleServeFailureMessage } from "@t3tools/contracts";
2930
import * as ServerConfig from "./config.ts";
3031
import { withUntracedRequests } from "./http.ts";
3132
import * as ServerHttp from "./http.ts";
@@ -209,7 +210,6 @@ import * as NetService from "@t3tools/shared/Net";
209210
import * as RelayClient from "@t3tools/shared/relayClient";
210211
import {
211212
disableTailscaleServe,
212-
ensureTailscaleServe,
213213
readTailscaleServeRoutesTo,
214214
readTailscaleStatus,
215215
} from "@t3tools/tailscale";
@@ -884,30 +884,41 @@ const layerMakeServer = Layer.unwrap(
884884

885885
const localPort = address.port;
886886
const localHost = loopbackUrlHostForAddress(address);
887-
return yield* ensureTailscaleServe({
888-
localPort,
889-
servePort: config.tailscaleServePort,
890-
localHost,
891-
}).pipe(
892-
Effect.as({
887+
const directEndpoints = yield* DirectEndpoints.DirectEndpoints;
888+
return yield* directEndpoints
889+
.configureTailscaleServe({
893890
localPort,
894-
localHost: localHost.replace(/^\[|\]$/gu, ""),
895891
servePort: config.tailscaleServePort,
896-
}),
897-
Effect.tap(() =>
898-
Effect.logInfo("Tailscale Serve configured", {
892+
localHost,
893+
})
894+
.pipe(
895+
Effect.as({
899896
localPort,
897+
localHost: localHost.replace(/^\[|\]$/gu, ""),
900898
servePort: config.tailscaleServePort,
901899
}),
902-
),
903-
Effect.catch((cause) =>
904-
Effect.logWarning("Failed to configure Tailscale Serve", {
905-
cause,
906-
localPort,
907-
servePort: config.tailscaleServePort,
908-
}).pipe(Effect.as(null)),
909-
),
910-
);
900+
Effect.tap(() =>
901+
Effect.logInfo("Tailscale Serve configured", {
902+
localPort,
903+
servePort: config.tailscaleServePort,
904+
}),
905+
),
906+
Effect.catch((cause) =>
907+
Effect.logWarning(
908+
tailscaleServeFailureMessage(
909+
cause._tag === "TailscaleCommandExitError" &&
910+
cause.stderrDiagnostic === "permission-denied"
911+
? "permission-denied"
912+
: "unknown",
913+
),
914+
{
915+
cause,
916+
localPort,
917+
servePort: config.tailscaleServePort,
918+
},
919+
).pipe(Effect.as(null)),
920+
),
921+
);
911922
}),
912923
(configured) =>
913924
configured

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,38 @@ const settingsUpdated = (settings: object): ServerConfigStreamEvent => ({
143143
payload: { settings: settings as ServerConfig["settings"] },
144144
});
145145

146+
it.effect("streams Serve failure and recovery without rolling back settings", () =>
147+
Effect.gen(function* () {
148+
const settingsSent = yield* Deferred.make<void>();
149+
const events = yield* withLateConfigDiscovery(
150+
snapshotConfig({ tailscaleServeFailure: null }),
151+
Stream.make(settingsUpdated({ enableProviderUpdateChecks: false })),
152+
{
153+
resolveAvailableEditors: () => Effect.succeed([]),
154+
resolveFileManagerRevealKind: () => Effect.succeed("file-explorer" as const),
155+
},
156+
{ resolveTargets: () => Effect.succeed([]) },
157+
{ resolve: () => Effect.succeed([]) },
158+
Stream.fromEffect(Deferred.await(settingsSent)).pipe(
159+
Stream.flatMap(() => Stream.make("permission-denied" as const, null)),
160+
),
161+
).pipe(
162+
Stream.tap((event) =>
163+
event.type === "settingsUpdated" ? Deferred.succeed(settingsSent, undefined) : Effect.void,
164+
),
165+
Stream.runCollect,
166+
);
167+
const snapshots = events.filter((event) => event.type === "snapshot");
168+
assert.deepEqual(
169+
snapshots.map((event) => event.config.tailscaleServeFailure),
170+
["permission-denied", null],
171+
);
172+
for (const snapshot of snapshots) {
173+
assert.deepEqual(snapshot.config.settings, { enableProviderUpdateChecks: false } as never);
174+
}
175+
}),
176+
);
177+
146178
it.effect("resends late editors without rolling back updates already sent", () =>
147179
Effect.gen(function* () {
148180
const settingsSent = yield* Deferred.make<void>();
@@ -811,6 +843,8 @@ it.effect.each([
811843
),
812844
}),
813845
Layer.mock(DirectEndpoints.DirectEndpoints)({
846+
tailscaleServeFailure: Effect.succeed(null),
847+
tailscaleServeFailureChanges: Stream.empty,
814848
resolveAvailable: () => Effect.succeed(discovery === "direct-cached" ? endpoints : bound),
815849
resolve: () =>
816850
direct
@@ -1052,6 +1086,8 @@ it.effect("on-demand clients get provider config without workspace snapshots", (
10521086
resolveTargets: () => Effect.succeed([]),
10531087
}),
10541088
Layer.mock(DirectEndpoints.DirectEndpoints)({
1089+
tailscaleServeFailure: Effect.succeed(null),
1090+
tailscaleServeFailureChanges: Stream.empty,
10551091
resolve: () => Effect.succeed([]),
10561092
resolveAvailable: () => Effect.succeed([]),
10571093
}),

‎apps/server/src/ws.ts‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,7 @@ export const withLateConfigDiscovery = <E, R>(
319319
launcher: EditorDiscovery,
320320
remoteOpenTargets: RemoteOpenTargets.RemoteOpenTargets["Service"],
321321
directEndpoints: Pick<DirectEndpoints.DirectEndpoints["Service"], "resolve">,
322+
tailscaleServeFailureChanges: DirectEndpoints.DirectEndpoints["Service"]["tailscaleServeFailureChanges"] = Stream.empty,
322323
) => {
323324
const lateEditorConfig = Stream.fromEffect(launcher.resolveAvailableEditors()).pipe(
324325
Stream.filter(
@@ -353,7 +354,18 @@ export const withLateConfigDiscovery = <E, R>(
353354

354355
return Stream.merge(
355356
liveUpdates,
356-
Stream.merge(lateEditorConfig, Stream.merge(lateRemoteOpenTargets, lateDirectEndpoints)),
357+
Stream.merge(
358+
lateEditorConfig,
359+
Stream.merge(
360+
lateRemoteOpenTargets,
361+
Stream.merge(
362+
lateDirectEndpoints,
363+
tailscaleServeFailureChanges.pipe(
364+
Stream.map((failure) => ({ type: "tailscaleServeFailure" as const, failure })),
365+
),
366+
),
367+
),
368+
),
357369
).pipe(
358370
Stream.mapAccum(
359371
(): ClientServerConfig => config,
@@ -380,6 +392,11 @@ export const withLateConfigDiscovery = <E, R>(
380392
const next = { ...current, directEndpoints: event.endpoints };
381393
return [next, [{ version: 1, type: "snapshot", config: next }]];
382394
}
395+
case "tailscaleServeFailure": {
396+
if (current.tailscaleServeFailure === event.failure) return [current, []];
397+
const next = { ...current, tailscaleServeFailure: event.failure };
398+
return [next, [{ version: 1, type: "snapshot", config: next }]];
399+
}
383400
case "keybindingsUpdated":
384401
return [{ ...current, ...event.payload }, [event]];
385402
case "providerStatuses":
@@ -1841,6 +1858,7 @@ export const layerWsRpc = (
18411858
issues: keybindingsConfig.issues,
18421859
providers,
18431860
...discovery,
1861+
tailscaleServeFailure: yield* directEndpoints.tailscaleServeFailure,
18441862
observability: {
18451863
logsDirectoryPath: config.logsDir,
18461864
localTracingEnabled: true,
@@ -3286,6 +3304,7 @@ export const layerWsRpc = (
32863304
resolveTargets: () => Fiber.join(remoteTargets),
32873305
},
32883306
{ resolve: () => Fiber.join(directResult) },
3307+
directEndpoints.tailscaleServeFailureChanges,
32893308
),
32903309
);
32913310
}),

0 commit comments

Comments
 (0)