Files

216 lines
7.7 KiB
TypeScript

import { assert, describe, it } from "@effect/vitest";
import * as NetService from "@hanzodev/shared/Net";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";
import * as Sink from "effect/Sink";
import * as Stream from "effect/Stream";
import { ChildProcessSpawner } from "effect/process";
import {
type DevShareError,
DevServeFailedError,
DevServePortTakenError,
shareDevServer,
unshareDevServer,
} from "./dev-share.ts";
const TAILNET_STATUS = JSON.stringify({ Self: { DNSName: "host.example.ts.net." } });
const NO_HANDLER_STDERR = "error: failed to remove web serve: handler does not exist";
interface CallResult {
readonly exitCode: number;
readonly stderr?: string;
}
const encode = (value: string) => Stream.make(new TextEncoder().encode(value));
const serveStatusWithRoot = (webPort: number, proxy: string) =>
JSON.stringify({
Web: { [`host.example.ts.net:${String(webPort)}`]: { Handlers: { "/": { Proxy: proxy } } } },
});
const spawnerLayer = (input: {
readonly off?: CallResult;
readonly serve?: CallResult;
readonly serveStatus?: CallResult & { readonly stdout?: string };
readonly liveLoopbackPorts?: ReadonlyArray<number>;
readonly calls?: Array<ReadonlyArray<string>>;
}) => {
const live = new Set(input.liveLoopbackPorts ?? []);
const unused = Effect.die("unused in dev-share tests");
const net = Layer.succeed(NetService.NetService, {
hasListenerOnHost: (port: number) => Effect.succeed(live.has(port)),
canListenOnHost: () => unused,
isPortAvailableOnLoopback: () => unused,
reserveLoopbackPort: () => unused,
findAvailablePort: () => unused,
});
const spawner = Layer.succeed(
ChildProcessSpawner.ChildProcessSpawner,
ChildProcessSpawner.make((command) => {
const args = "args" in command ? (command.args as ReadonlyArray<string>) : [];
input.calls?.push(args);
const isServeStatus = args[0] === "serve" && args.includes("status");
const result: CallResult & { readonly stdout?: string } = isServeStatus
? (input.serveStatus ?? { exitCode: 0, stdout: "{}" })
: args.includes("status")
? { exitCode: 0, stdout: TAILNET_STATUS }
: args.includes("off")
? (input.off ?? { exitCode: 0 })
: (input.serve ?? { exitCode: 0 });
return Effect.succeed(
ChildProcessSpawner.makeHandle({
pid: ChildProcessSpawner.ProcessId(1),
exitCode: Effect.succeed(ChildProcessSpawner.ExitCode(result.exitCode)),
isRunning: Effect.succeed(false),
kill: () => Effect.void,
unref: Effect.succeed(Effect.void),
stdin: Sink.drain,
stdout: result.stdout !== undefined ? encode(result.stdout) : Stream.empty,
stderr: result.stderr ? encode(result.stderr) : Stream.empty,
all: Stream.empty,
getInputFd: () => Sink.drain,
getOutputFd: () => Stream.empty,
}),
);
}),
);
return Layer.merge(spawner, net);
};
describe("unshareDevServer", () => {
// `tailscale serve … off` exits 1 when the port had no mapping, which is the
// normal first-share case — the port is clear, so this must not be an error.
it.effect("treats a missing handler as cleared", () =>
Effect.gen(function* () {
const result = yield* unshareDevServer(5788).pipe(
Effect.provide(spawnerLayer({ off: { exitCode: 1, stderr: NO_HANDLER_STDERR } })),
);
assert.isTrue(result.cleared);
}),
);
it.effect("reports a genuine removal failure as not cleared", () =>
Effect.gen(function* () {
const result = yield* unshareDevServer(5788).pipe(
Effect.provide(spawnerLayer({ off: { exitCode: 1, stderr: "permission denied" } })),
);
assert.isFalse(result.cleared);
assert.include(result.explanation, "permission denied");
assert.equal(result.cause?._tag, "TailscaleCommandExitError");
}),
);
});
describe("shareDevServer", () => {
// Vite binds `localhost`, which modern Node resolves to `::1` first, so a
// 127.0.0.1 target would proxy to a loopback nothing listens on.
it.effect("proxies to the localhost name Vite binds, not 127.0.0.1", () =>
Effect.gen(function* () {
const calls: Array<ReadonlyArray<string>> = [];
yield* shareDevServer({ webPort: 5788 }).pipe(
Effect.provide(spawnerLayer({ off: { exitCode: 0 }, calls })),
);
const serveCall = calls.find((args) => args.includes("--bg"));
assert.deepEqual(serveCall, ["serve", "--bg", "--https=5788", "http://localhost:5788"]);
}),
);
it.effect("explains a recognized serve failure without quoting stderr", () =>
Effect.gen(function* () {
const error: DevShareError = yield* shareDevServer({ webPort: 5788 }).pipe(
Effect.provide(
spawnerLayer({
off: { exitCode: 0 },
serve: {
exitCode: 1,
stderr: "permission denied for tskey-auth-secret-token-value",
},
}),
),
Effect.flip,
);
assert.instanceOf(error, DevServeFailedError);
assert.equal(error.stage, "serve");
assert.include(error.message, "permission denied");
assert.include(error.message, "elevated privileges");
assert.notInclude(error.message, "tskey-auth-secret-token-value");
}),
);
it.effect("refuses to serve when the existing mapping could not be cleared", () =>
Effect.gen(function* () {
const error: DevShareError = yield* shareDevServer({ webPort: 5788 }).pipe(
Effect.provide(spawnerLayer({ off: { exitCode: 1, stderr: "permission denied" } })),
Effect.flip,
);
assert.instanceOf(error, DevServeFailedError);
assert.equal(error.stage, "clear-existing");
assert.include(error.message, "could not clear the existing mapping");
assert.include(error.message, "permission denied");
}),
);
it.effect("leaves a mapping that another running server holds alone", () =>
Effect.gen(function* () {
const calls: Array<ReadonlyArray<string>> = [];
const error: DevShareError = yield* shareDevServer({ webPort: 5788 }).pipe(
Effect.provide(
spawnerLayer({
serveStatus: {
exitCode: 0,
stdout: serveStatusWithRoot(5788, "http://127.0.0.1:9555"),
},
liveLoopbackPorts: [9555],
calls,
}),
),
Effect.flip,
);
assert.instanceOf(error, DevServePortTakenError);
assert.isUndefined(calls.find((args) => args.includes("off") || args.includes("--bg")));
}),
);
it.effect("replaces a mapping that dials a port nothing listens on", () =>
Effect.gen(function* () {
const calls: Array<ReadonlyArray<string>> = [];
yield* shareDevServer({ webPort: 5788 }).pipe(
Effect.provide(
spawnerLayer({
serveStatus: {
exitCode: 0,
stdout: serveStatusWithRoot(5788, "http://127.0.0.1:9555"),
},
calls,
}),
),
);
assert.isDefined(calls.find((args) => args.includes("off")));
assert.isDefined(calls.find((args) => args.includes("--bg")));
}),
);
it.effect("leaves the port alone when its mapping cannot be read", () =>
Effect.gen(function* () {
const calls: Array<ReadonlyArray<string>> = [];
const error: DevShareError = yield* shareDevServer({ webPort: 5788 }).pipe(
Effect.provide(
spawnerLayer({ serveStatus: { exitCode: 1, stderr: "permission denied" }, calls }),
),
Effect.flip,
);
assert.instanceOf(error, DevServeFailedError);
assert.equal(error.stage, "read-existing");
assert.isUndefined(calls.find((args) => args.includes("off") || args.includes("--bg")));
}),
);
});