Skip to content

Commit 249b6ae

Browse files
t3dotggLukeCommitsclaude
authored
feat(server): devices on the same network reach background services over LAN (pingdotgg#24588)
Co-authored-by: LukeCommits <[email protected]> Co-authored-by: Claude Opus 5.5 <[email protected]>
1 parent 0840bb2 commit 249b6ae

15 files changed

Lines changed: 546 additions & 63 deletions

File tree

‎apps/server/src/cli/config.test.ts‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ import * as NetService from "@t3tools/shared/Net";
2323
import { DEFAULT_SIGNAL_EXPORT } from "@t3tools/shared/observability";
2424
import * as OtelEnvironment from "@t3tools/shared/otelEnvironment";
2525
import * as NodeServices from "@effect/platform-node/NodeServices";
26+
import * as HostProcess from "@t3tools/shared/HostProcess";
27+
import packageJson from "../../package.json" with { type: "json" };
28+
import { ServiceLauncherHostProcess } from "../cloud/serviceLauncherClient.ts";
29+
import {
30+
SERVICE_LAUNCHER_CONTEXT_ENV,
31+
SERVICE_LAUNCHER_PROTOCOL,
32+
} from "../cloud/serviceProtocol.ts";
2633
import { deriveServerPaths } from "../config.ts";
2734
import { resolveServerConfig } from "./config.ts";
2835

@@ -856,4 +863,52 @@ it.layer(NodeServices.layer)("cli config resolution", (it) => {
856863
expect(resolved.otlpLogsUrl).toBeUndefined();
857864
}),
858865
);
866+
867+
it.effect("listens on private networks only under the service launcher with no host set", () =>
868+
Effect.gen(function* () {
869+
const { join } = yield* Path.Path;
870+
const baseDir = join(NodeOS.tmpdir(), "t3-cli-config-service-host");
871+
const resolveHost = (input: {
872+
readonly connected: boolean;
873+
readonly env?: Record<string, string>;
874+
}) =>
875+
resolveServerConfig(minimalWebFlags(baseDir), Option.none()).pipe(
876+
Effect.map(({ host, privateNetworkOnly }) => ({ host, privateNetworkOnly })),
877+
Effect.provide(
878+
Layer.mergeAll(
879+
ConfigProvider.layer(ConfigProvider.fromEnv({ env: input.env ?? {} })),
880+
NetService.layer,
881+
),
882+
),
883+
Effect.provideService(HostProcess.Environment, {
884+
[SERVICE_LAUNCHER_CONTEXT_ENV]: JSON.stringify({
885+
protocol: SERVICE_LAUNCHER_PROTOCOL,
886+
childVersion: packageJson.version,
887+
}),
888+
}),
889+
Effect.provideService(ServiceLauncherHostProcess, {
890+
connected: input.connected,
891+
send: () => false,
892+
on: () => undefined,
893+
off: () => undefined,
894+
}),
895+
);
896+
897+
expect(yield* resolveHost({ connected: true })).toEqual({
898+
host: "0.0.0.0",
899+
privateNetworkOnly: true,
900+
});
901+
// `service.env` reaches the server as its environment.
902+
expect(yield* resolveHost({ connected: true, env: { T3CODE_HOST: "127.0.0.1" } })).toEqual({
903+
host: "127.0.0.1",
904+
privateNetworkOnly: undefined,
905+
});
906+
// Without the launcher's IPC channel the context was inherited, e.g. by
907+
// `t3 serve` started from an agent inside the service.
908+
expect(yield* resolveHost({ connected: false })).toEqual({
909+
host: undefined,
910+
privateNetworkOnly: undefined,
911+
});
912+
}),
913+
);
859914
});

‎apps/server/src/cli/config.ts‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { Argument, Flag } from "effect/cli";
2222
import * as CliError from "effect/cli/CliError";
2323

2424
import { readBootstrapEnvelope } from "../bootstrap.ts";
25+
import { resolveServiceLauncherMode } from "../cloud/serviceLauncherClient.ts";
2526
import * as ServerConfig from "../config.ts";
2627
import { expandHomePath, resolveBaseDir } from "../os-jank.ts";
2728
import { isProcessAlive, readPersistedServerRuntimeState } from "../serverRuntimeState.ts";
@@ -403,13 +404,23 @@ export const resolveServerConfig = Effect.fn("config.resolveServerConfig")(funct
403404
() => 443,
404405
);
405406
const staticDir = devUrl ? undefined : yield* ServerConfig.resolveStaticDir();
406-
const host = Option.getOrElse(
407-
resolveOptionPrecedence(
408-
normalizedFlags.host,
409-
Option.fromUndefinedOr(env.host),
410-
Option.fromUndefinedOr(bootstrap?.host),
411-
),
412-
() => (mode === "desktop" ? "127.0.0.1" : undefined),
407+
const explicitHost = resolveOptionPrecedence(
408+
normalizedFlags.host,
409+
Option.fromUndefinedOr(env.host),
410+
Option.fromUndefinedOr(bootstrap?.host),
411+
);
412+
// A background service exists to be reached from other devices, so it
413+
// listens on private networks unless `service.env` sets `T3CODE_HOST`.
414+
// Clients then learn its LAN address and prefer it over T3 Connect.
415+
const privateNetworkOnly =
416+
Option.isNone(explicitHost) &&
417+
mode === "web" &&
418+
(yield* resolveServiceLauncherMode().pipe(
419+
Effect.map((launcher) => launcher.managed),
420+
Effect.orElseSucceed(() => false),
421+
));
422+
const host = Option.getOrElse(explicitHost, () =>
423+
privateNetworkOnly ? "0.0.0.0" : mode === "desktop" ? "127.0.0.1" : undefined,
413424
);
414425
const logLevel = Option.getOrElse(cliLogLevel, () => env.logLevel);
415426

@@ -475,6 +486,7 @@ export const resolveServerConfig = Effect.fn("config.resolveServerConfig")(funct
475486
...derivedPaths,
476487
serverTracePath,
477488
host,
489+
...(privateNetworkOnly ? { privateNetworkOnly } : {}),
478490
staticDir,
479491
devUrl,
480492
...(devAuthToken === undefined ? {} : { devAuthToken }),

‎apps/server/src/cli/pair.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,10 @@ export class ServePortOccupiedError extends Schema.TaggedError<ServePortOccupied
145145
}
146146

147147
const resolveDirectPairingBaseUrl = (state: PersistedServerRuntimeState): string =>
148-
state.devUrl ?? resolveHeadlessConnectionString(state.host, state.port);
148+
state.devUrl ??
149+
resolveHeadlessConnectionString(state.host, state.port, {
150+
privateNetworkOnly: state.privateNetworkOnly,
151+
});
149152

150153
export class DevServerNotProxiableError extends Schema.TaggedError<DevServerNotProxiableError>()(
151154
"DevServerNotProxiableError",
@@ -532,6 +535,10 @@ export const pairCommand = Command.make("pair", {
532535
notes.push(
533536
"This URL is only reachable from this machine. Re-run with --tailscale, or restart the server with a reachable --host.",
534537
);
538+
} else if (target.state.privateNetworkOnly) {
539+
notes.push(
540+
"This URL works only from this machine's local network. From elsewhere, re-run with --tailscale or use T3 Connect.",
541+
);
535542
}
536543
if (target.variant === "dev" && target.state.devUrl === undefined) {
537544
notes.push(

‎apps/server/src/config.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ export class ServerConfig extends Context.Service<
7272
readonly mode: RuntimeMode;
7373
readonly port: number;
7474
readonly host: string | undefined;
75+
/** Set when the host was defaulted to a private-network listener for the service. */
76+
readonly privateNetworkOnly?: boolean | undefined;
7577
readonly cwd: string;
7678
readonly baseDir: string;
7779
readonly staticDir: string | undefined;

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,23 @@ describe("resolveBoundEndpoints", () => {
148148
resolveBoundEndpoints({ host: "203.0.113.20", port: 3773, interfaces: INTERFACES }),
149149
).toEqual([]);
150150
});
151+
152+
it("reports only the tailnet address on a cloud VM, whose private network no client shares", () => {
153+
expect(
154+
resolveBoundEndpoints({
155+
host: "0.0.0.0",
156+
port: 3773,
157+
interfaces: INTERFACES,
158+
onCloudVm: true,
159+
}),
160+
).toEqual([{ kind: "tailnet", httpBaseUrl: "http://100.101.102.103:3773/" }]);
161+
});
162+
163+
it("never reports an IPv4-mapped host, which can name the client's own loopback", () => {
164+
expect(
165+
resolveBoundEndpoints({ host: "::ffff:127.0.0.1", port: 3773, interfaces: INTERFACES }),
166+
).toEqual([]);
167+
});
151168
});
152169

153170
const TAILSCALE_STATUS_JSON = JSON.stringify({

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

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@ import * as ChildProcessSpawner from "effect/process/ChildProcessSpawner";
1414
import * as NodeNet from "node:net";
1515
import * as NodeOS from "node:os";
1616

17-
import { isPrivateNetworkHost, isTailnetHost } from "@t3tools/shared/hostClassification";
17+
import { isTailnetHost } from "@t3tools/shared/hostClassification";
1818

1919
import * as ServerConfig from "../config.ts";
20-
import { formatHostForUrl, isLoopbackHost, isWildcardHost } from "../startupAccess.ts";
20+
import {
21+
formatHostForUrl,
22+
isLoopbackHost,
23+
isPrivateNetworkAddress,
24+
isWildcardHost,
25+
VIRTUAL_INTERFACE,
26+
} from "../startupAccess.ts";
2127

2228
type NetworkInterfacesMap = ReturnType<typeof NodeOS.networkInterfaces>;
2329

@@ -40,19 +46,7 @@ export class DirectEndpoints extends Context.Service<
4046
* (`server.local`) can resolve to a different machine on each client's network.
4147
*/
4248
const isAdvertisableAddress = (address: string): boolean =>
43-
NodeNet.isIPv4(address) &&
44-
!address.startsWith("127.") &&
45-
!address.startsWith("169.254.") &&
46-
isPrivateNetworkHost(address);
47-
48-
/**
49-
* Container and VM networks (Docker, libvirt, VMware, VirtualBox, Hyper-V, and
50-
* macOS's `bridge100`+) have private addresses only this machine reaches. A
51-
* host bridge such as `br0` or Proxmox's `vmbr0` carries the LAN address, so
52-
* it stays listed.
53-
*/
54-
const VIRTUAL_INTERFACE =
55-
/^(docker|br-|veth|virbr|vmnet|vboxnet|vEthernet|podman|cni|flannel|cali|lxcbr|lxdbr|bridge1\d\d)/;
49+
NodeNet.isIPv4(address) && !address.startsWith("127.") && isPrivateNetworkAddress(address);
5650

5751
/**
5852
* Tailscale's own interface: `tailscale0` on Linux, "Tailscale" on Windows.
@@ -71,6 +65,8 @@ export function resolveBoundEndpoints(input: {
7165
readonly host: string | undefined;
7266
readonly port: number;
7367
readonly interfaces: NetworkInterfacesMap;
68+
/** A cloud VM's private network is its provider's, which no client shares. */
69+
readonly onCloudVm?: boolean;
7470
}): ReadonlyArray<ServerDirectEndpoint> {
7571
if (isLoopbackHost(input.host)) return [];
7672
const tailscaleAddresses = new Set(
@@ -87,24 +83,61 @@ export function resolveBoundEndpoints(input: {
8783
)
8884
.map((entry) => entry.address)
8985
: [input.host!].filter(isAdvertisableAddress);
90-
return [...new Set(addresses)].map((address) => ({
91-
kind: tailscaleAddresses.has(address) ? "tailnet" : "lan",
92-
httpBaseUrl: `http://${formatHostForUrl(address)}:${input.port}/`,
93-
}));
86+
return [...new Set(addresses)]
87+
.filter((address) => !input.onCloudVm || tailscaleAddresses.has(address))
88+
.map((address) => ({
89+
kind: tailscaleAddresses.has(address) ? "tailnet" : "lan",
90+
httpBaseUrl: `http://${formatHostForUrl(address)}:${input.port}/`,
91+
}));
9492
}
9593

94+
/**
95+
* AWS, GCP, Azure, DigitalOcean, Hetzner, Linode, Vultr, and Oracle all serve
96+
* instance metadata at this address. A plain TCP connect skips HTTP proxies,
97+
* which would otherwise answer for a machine that is not in a cloud.
98+
*/
99+
const CLOUD_METADATA_ADDRESS = "169.254.169.254";
100+
const CLOUD_METADATA_TIMEOUT_MS = 300;
101+
102+
const probeCloudMetadata = Effect.callback<boolean>((resume) => {
103+
const socket = NodeNet.connect({
104+
host: CLOUD_METADATA_ADDRESS,
105+
port: 80,
106+
timeout: CLOUD_METADATA_TIMEOUT_MS,
107+
});
108+
let settled = false;
109+
const settle = (found: boolean) => {
110+
if (settled) return;
111+
settled = true;
112+
socket.destroy();
113+
resume(Effect.succeed(found));
114+
};
115+
socket.once("connect", () => settle(true));
116+
socket.once("timeout", () => settle(false));
117+
socket.once("error", () => settle(false));
118+
return Effect.sync(() => socket.destroy());
119+
});
120+
96121
/** @public Service construction is part of the canonical Effect module API. */
97122
export const make = Effect.gen(function* () {
98123
const config = yield* ServerConfig.ServerConfig;
99124
const spawner = yield* ChildProcessSpawner.ChildProcessSpawner;
100125
const httpClient = yield* HttpClient.HttpClient;
126+
// Only the service default listens on every interface without being asked,
127+
// so only it checks once whether it runs in a cloud. The check starts now so
128+
// the first client does not wait for its timeout.
129+
const onCloudVm = config.privateNetworkOnly
130+
? yield* Effect.cached(probeCloudMetadata)
131+
: Effect.succeed(false);
132+
yield* Effect.forkDetach(onCloudVm);
101133

102134
const resolve = Effect.gen(function* () {
103135
const endpoints = [
104136
...resolveBoundEndpoints({
105137
host: config.host,
106138
port: config.port,
107139
interfaces: NodeOS.networkInterfaces(),
140+
onCloudVm: yield* onCloudVm,
108141
}),
109142
];
110143
// Tailscale Serve terminates HTTPS on the tailnet name and forwards to

‎apps/server/src/server.ts‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ import * as EventStoreV2 from "./orchestration-v2/EventStore.ts";
186186
import * as ProjectionMaintenance from "./orchestration-v2/ProjectionMaintenance.ts";
187187
import * as ProjectionStoreV2 from "./orchestration-v2/ProjectionStore.ts";
188188
import { makePersistedServerRuntimeState } from "./serverRuntimeState.ts";
189-
import { loopbackUrlHostForAddress } from "./startupAccess.ts";
189+
import { acceptsPrivateNetworkConnection, loopbackUrlHostForAddress } from "./startupAccess.ts";
190190
import * as OrchestrationHttp from "./orchestration-v2/http.ts";
191191
import * as ProjectHttp from "./project/http.ts";
192192
import * as NetService from "@t3tools/shared/Net";
@@ -300,7 +300,19 @@ const layerHttpServer = Layer.unwrap(
300300
Effect.gen(function* () {
301301
const config = yield* ServerConfig.ServerConfig;
302302
return NodeHttpServer.layer(
303-
() => rejectRequestsUntilServing(guardHttpResponseWriteErrors(NodeHttp.createServer())),
303+
() => {
304+
const server = rejectRequestsUntilServing(
305+
guardHttpResponseWriteErrors(NodeHttp.createServer()),
306+
);
307+
if (config.privateNetworkOnly) {
308+
server.on("connection", (socket) => {
309+
if (!acceptsPrivateNetworkConnection(socket)) {
310+
socket.destroy();
311+
}
312+
});
313+
}
314+
return server;
315+
},
304316
{
305317
host: config.host ?? "127.0.0.1",
306318
port: config.port,

‎apps/server/src/serverRuntimeState.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export const PersistedServerRuntimeState = Schema.Struct({
1414
pid: Schema.Int,
1515
ownerId: Schema.optional(Schema.String),
1616
host: Schema.optional(Schema.String),
17+
privateNetworkOnly: Schema.optional(Schema.Boolean),
1718
port: Schema.Int,
1819
origin: Schema.String,
1920
// Dev is single-origin: browsers must pair through this URL, not `origin`.
@@ -51,14 +52,18 @@ const runtimeOriginForConfig = (
5152
};
5253

5354
export const makePersistedServerRuntimeState = (input: {
54-
readonly config: Pick<ServerConfig.ServerConfig["Service"], "host" | "devUrl">;
55+
readonly config: Pick<
56+
ServerConfig.ServerConfig["Service"],
57+
"host" | "privateNetworkOnly" | "devUrl"
58+
>;
5559
readonly port: number;
5660
readonly serviceManaged?: boolean;
5761
}): Effect.Effect<PersistedServerRuntimeState> =>
5862
Effect.map(DateTime.now, (now) => ({
5963
version: 1,
6064
pid: process.pid,
6165
...(input.config.host ? { host: input.config.host } : {}),
66+
...(input.config.privateNetworkOnly ? { privateNetworkOnly: true } : {}),
6267
port: input.port,
6368
origin: runtimeOriginForConfig(input.config, input.port),
6469
...(input.config.devUrl ? { devUrl: input.config.devUrl.toString() } : {}),

0 commit comments

Comments
 (0)