Skip to content
Source
Sign inSign up
Open History to see the last commit

dev-share.test.ts

134 lines4.8 KB

1import { assert, describe, it } from "@effect/vitest";
2import * as Effect from "effect/Effect";
3import * as Layer from "effect/Layer";
4import * as Sink from "effect/Sink";
5import * as Stream from "effect/Stream";
6import { ChildProcessSpawner } from "effect/process";
7​
8import {
9 type DevShareError,
10 DevServeFailedError,
11 shareDevServer,
12 unshareDevServer,
13} from "./dev-share.ts";
14​
15const TAILNET_STATUS = JSON.stringify({ Self: { DNSName: "host.example.ts.net." } });
16const NO_HANDLER_STDERR = "error: failed to remove web serve: handler does not exist";
17​
18interface CallResult {
19 readonly exitCode: number;
20 readonly stderr?: string;
22​
23const encode = (value: string) => Stream.make(new TextEncoder().encode(value));
24​
25const spawnerLayer = (input: {
26 readonly off?: CallResult;
27 readonly serve?: CallResult;
28 readonly calls?: Array<ReadonlyArray<string>>;
29}) =>
30 Layer.succeed(
31 ChildProcessSpawner.ChildProcessSpawner,
32 ChildProcessSpawner.make((command) => {
33 const args = "args" in command ? (command.args as ReadonlyArray<string>) : [];
34 input.calls?.push(args);
35 const result: CallResult = args.includes("status")
36 ? { exitCode: 0 }
37 : args.includes("off")
38 ? (input.off ?? { exitCode: 0 })
39 : (input.serve ?? { exitCode: 0 });
40​
41 return Effect.succeed(
42 ChildProcessSpawner.makeHandle({
43 pid: ChildProcessSpawner.ProcessId(1),
44 exitCode: Effect.succeed(ChildProcessSpawner.ExitCode(result.exitCode)),
45 isRunning: Effect.succeed(false),
46 kill: () => Effect.void,
47 unref: Effect.succeed(Effect.void),
48 stdin: Sink.drain,
49 stdout: args.includes("status") ? encode(TAILNET_STATUS) : Stream.empty,
50 stderr: result.stderr ? encode(result.stderr) : Stream.empty,
51 all: Stream.empty,
52 getInputFd: () => Sink.drain,
53 getOutputFd: () => Stream.empty,
54 }),
55 );
56 }),
57 );
58​
59describe("unshareDevServer", () => {
60 // `tailscale serve … off` exits 1 when the port had no mapping, which is the
61 // normal first-share case — the port is clear, so this must not be an error.
62 it.effect("treats a missing handler as cleared", () =>
63 Effect.gen(function* () {
64 const result = yield* unshareDevServer(5788).pipe(
65 Effect.provide(spawnerLayer({ off: { exitCode: 1, stderr: NO_HANDLER_STDERR } })),
66 );
67 assert.isTrue(result.cleared);
68 }),
69 );
70​
71 it.effect("reports a genuine removal failure as not cleared", () =>
72 Effect.gen(function* () {
73 const result = yield* unshareDevServer(5788).pipe(
74 Effect.provide(spawnerLayer({ off: { exitCode: 1, stderr: "permission denied" } })),
75 );
76 assert.isFalse(result.cleared);
77 assert.include(result.explanation, "permission denied");
78 assert.equal(result.cause?._tag, "TailscaleCommandExitError");
79 }),
80 );
81});
82​
83describe("shareDevServer", () => {
84 // Vite binds `localhost`, which modern Node resolves to `::1` first, so a
85 // 127.0.0.1 target would proxy to a loopback nothing listens on.
86 it.effect("proxies to the localhost name Vite binds, not 127.0.0.1", () =>
87 Effect.gen(function* () {
88 const calls: Array<ReadonlyArray<string>> = [];
89 yield* shareDevServer({ webPort: 5788 }).pipe(
90 Effect.provide(spawnerLayer({ off: { exitCode: 0 }, calls })),
91 );
92​
93 const serveCall = calls.find((args) => args.includes("--bg"));
94 assert.deepEqual(serveCall, ["serve", "--bg", "--https=5788", "http://localhost:5788"]);
95 }),
96 );
97​
98 it.effect("explains a recognized serve failure without quoting stderr", () =>
99 Effect.gen(function* () {
100 const error: DevShareError = yield* shareDevServer({ webPort: 5788 }).pipe(
101 Effect.provide(
102 spawnerLayer({
103 off: { exitCode: 0 },
104 serve: {
105 exitCode: 1,
106 stderr: "permission denied for tskey-auth-secret-token-value",
107 },
108 }),
109 ),
110 Effect.flip,
111 );
112​
113 assert.instanceOf(error, DevServeFailedError);
114 assert.equal(error.stage, "serve");
115 assert.include(error.message, "permission denied");
116 assert.include(error.message, "elevated privileges");
117 assert.notInclude(error.message, "tskey-auth-secret-token-value");
118 }),
119 );
120​
121 it.effect("refuses to serve when the existing mapping could not be cleared", () =>
122 Effect.gen(function* () {
123 const error: DevShareError = yield* shareDevServer({ webPort: 5788 }).pipe(
124 Effect.provide(spawnerLayer({ off: { exitCode: 1, stderr: "permission denied" } })),
125 Effect.flip,
126 );
127​
128 assert.instanceOf(error, DevServeFailedError);
129 assert.equal(error.stage, "clear-existing");
130 assert.include(error.message, "could not clear the existing mapping");
131 assert.include(error.message, "permission denied");
132 }),
133 );
134});