Skip to content

Commit 2581244

Browse files
juliusmarmingecodex
andcommitted
refactor: structure loopback port errors
Co-authored-by: codex <[email protected]>
1 parent 8f51b24 commit 2581244

2 files changed

Lines changed: 107 additions & 25 deletions

File tree

‎packages/shared/src/Net.test.ts‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@ import * as NodeNet from "node:net";
22

33
import { assert, describe, it } from "@effect/vitest";
44
import * as Effect from "effect/Effect";
5+
import * as Schema from "effect/Schema";
56

67
import * as NetService from "./Net.ts";
78

9+
const isLoopbackPortListenError = Schema.is(NetService.LoopbackPortListenError);
10+
811
const closeServer = (server: NodeNet.Server) =>
912
Effect.sync(() => {
1013
try {
@@ -19,19 +22,19 @@ const getPort = (server: NodeNet.Server): number => {
1922
return typeof address === "object" && address !== null ? address.port : 0;
2023
};
2124

22-
const openServer = (host?: string): Effect.Effect<NodeNet.Server, NetService.NetError> =>
23-
Effect.callback<NodeNet.Server, NetService.NetError>((resume) => {
25+
const openServer = (host?: string): Effect.Effect<NodeNet.Server, Error> =>
26+
Effect.callback<NodeNet.Server, Error>((resume) => {
2427
const server = NodeNet.createServer();
2528
let settled = false;
2629

27-
const settle = (effect: Effect.Effect<NodeNet.Server, NetService.NetError>) => {
30+
const settle = (effect: Effect.Effect<NodeNet.Server, Error>) => {
2831
if (settled) return;
2932
settled = true;
3033
resume(effect);
3134
};
3235

3336
server.once("error", (cause) => {
34-
settle(Effect.fail(new NetService.NetError({ host: host ?? "localhost", cause })));
37+
settle(Effect.fail(cause));
3538
});
3639

3740
if (host) {
@@ -45,11 +48,6 @@ const openServer = (host?: string): Effect.Effect<NodeNet.Server, NetService.Net
4548

4649
it.layer(NetService.layer)("NetService", (it) => {
4750
describe("Net helpers", () => {
48-
it("preserves the loopback reservation error message", () => {
49-
const error = new NetService.NetError({ host: "127.0.0.1" });
50-
assert.equal(error.message, "Failed to reserve loopback port");
51-
});
52-
5351
it.effect("reserveLoopbackPort returns a positive loopback port", () =>
5452
Effect.gen(function* () {
5553
const net = yield* NetService.NetService;
@@ -59,6 +57,18 @@ it.layer(NetService.layer)("NetService", (it) => {
5957
}),
6058
);
6159

60+
it.effect("retains the host and listen cause when reservation fails", () =>
61+
Effect.gen(function* () {
62+
const net = yield* NetService.NetService;
63+
const error = yield* net.reserveLoopbackPort("256.256.256.256").pipe(Effect.flip);
64+
65+
assert(isLoopbackPortListenError(error));
66+
assert.equal(error.host, "256.256.256.256");
67+
assert.match(error.message, /256\.256\.256\.256/u);
68+
assert.equal((error.cause as NodeJS.ErrnoException).code, "ENOTFOUND");
69+
}),
70+
);
71+
6272
it.effect("isPortAvailableOnLoopback reports false for an occupied port", () =>
6373
Effect.acquireUseRelease(
6474
openServer("127.0.0.1"),

‎packages/shared/src/Net.ts‎

Lines changed: 88 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,52 @@ import * as Layer from "effect/Layer";
66
import * as Predicate from "effect/Predicate";
77
import * as Schema from "effect/Schema";
88

9-
export class NetError extends Schema.TaggedErrorClass<NetError>()("NetError", {
10-
host: Schema.String,
11-
cause: Schema.optional(Schema.Defect()),
12-
}) {
9+
export class LoopbackPortListenError extends Schema.TaggedErrorClass<LoopbackPortListenError>()(
10+
"LoopbackPortListenError",
11+
{
12+
host: Schema.String,
13+
cause: Schema.Defect(),
14+
},
15+
) {
16+
override get message(): string {
17+
return `Failed to listen for an ephemeral loopback port on ${this.host}.`;
18+
}
19+
}
20+
21+
export class LoopbackPortAddressUnavailableError extends Schema.TaggedErrorClass<LoopbackPortAddressUnavailableError>()(
22+
"LoopbackPortAddressUnavailableError",
23+
{
24+
host: Schema.String,
25+
address: Schema.NullOr(Schema.String),
26+
family: Schema.NullOr(Schema.String),
27+
port: Schema.NullOr(Schema.Number),
28+
},
29+
) {
1330
override get message(): string {
14-
return "Failed to reserve loopback port";
31+
return `Failed to read a usable ephemeral loopback port for ${this.host} (address ${this.address ?? "unavailable"}, family ${this.family ?? "unavailable"}, port ${this.port ?? "unavailable"}).`;
1532
}
1633
}
1734

35+
export class LoopbackPortReleaseError extends Schema.TaggedErrorClass<LoopbackPortReleaseError>()(
36+
"LoopbackPortReleaseError",
37+
{
38+
host: Schema.String,
39+
port: Schema.Number,
40+
cause: Schema.Defect(),
41+
},
42+
) {
43+
override get message(): string {
44+
return `Failed to release ephemeral loopback port ${this.port} on ${this.host}.`;
45+
}
46+
}
47+
48+
export const NetError = Schema.Union([
49+
LoopbackPortListenError,
50+
LoopbackPortAddressUnavailableError,
51+
LoopbackPortReleaseError,
52+
]);
53+
export type NetError = typeof NetError.Type;
54+
1855
const isErrnoExceptionWithCode = (
1956
cause: unknown,
2057
): cause is {
@@ -163,20 +200,55 @@ export const make = () => {
163200
};
164201

165202
probe.once("error", (cause) => {
166-
settle(Effect.fail(new NetError({ host, cause })));
203+
settle(Effect.fail(new LoopbackPortListenError({ host, cause })));
167204
});
168205

169-
probe.listen(0, host, () => {
170-
const address = probe.address();
171-
const port = typeof address === "object" && address !== null ? address.port : 0;
172-
probe.close(() => {
173-
if (port > 0) {
174-
settle(Effect.succeed(port));
175-
return;
176-
}
177-
settle(Effect.fail(new NetError({ host })));
206+
try {
207+
probe.listen(0, host, () => {
208+
const address = probe.address();
209+
const addressDetails =
210+
typeof address === "object" && address !== null
211+
? {
212+
address: address.address,
213+
family: address.family,
214+
port: address.port,
215+
}
216+
: {
217+
address,
218+
family: null,
219+
port: null,
220+
};
221+
222+
probe.close((cause) => {
223+
if (cause) {
224+
settle(
225+
Effect.fail(
226+
new LoopbackPortReleaseError({
227+
host,
228+
port: addressDetails.port ?? 0,
229+
cause,
230+
}),
231+
),
232+
);
233+
return;
234+
}
235+
if (addressDetails.port !== null && addressDetails.port > 0) {
236+
settle(Effect.succeed(addressDetails.port));
237+
return;
238+
}
239+
settle(
240+
Effect.fail(
241+
new LoopbackPortAddressUnavailableError({
242+
host,
243+
...addressDetails,
244+
}),
245+
),
246+
);
247+
});
178248
});
179-
});
249+
} catch (cause) {
250+
settle(Effect.fail(new LoopbackPortListenError({ host, cause })));
251+
}
180252

181253
return Effect.sync(() => {
182254
closeServer(probe);

0 commit comments

Comments
 (0)