-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathchannel-plugin-api-coverage.test.ts
More file actions
269 lines (243 loc) · 8.57 KB
/
Copy pathchannel-plugin-api-coverage.test.ts
File metadata and controls
269 lines (243 loc) · 8.57 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
// Additional channel-plugin-api.ts coverage: the lifecycle hooks
// (onAccountConfigChanged, onAccountRemoved) and the config adapter
// (resolveAccount, listAccountIds, defaultAccountId).
import { EventEmitter } from "node:events";
import { describe, expect, it, vi } from "vitest";
import { buildPilotChannelPlugin } from "../src/channel-plugin-api.js";
import { PilotLifecycle } from "../src/lifecycle.js";
import type { Transport, TransportInfo } from "../src/transport.js";
const ALICE = "1:0000.0000.AAAA";
const BOB = "1:0000.0000.BBBB";
class FakeTransport extends EventEmitter implements Transport {
running = false;
sent: Array<{ peerAddr: string; port: number; data: Buffer }> = [];
stopCount = 0;
async start(): Promise<TransportInfo> {
this.running = true;
return { address: "1:0000.0000.0001", nodeId: 1 };
}
async send(peerAddr: string, port: number, data: Buffer): Promise<void> {
this.sent.push({ peerAddr, port, data });
}
async stop(): Promise<void> {
this.running = false;
this.stopCount++;
}
}
function silentLogger() {
return {
debug: vi.fn(),
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
};
}
describe("buildPilotChannelPlugin — config adapter", () => {
it("config.defaultAccountId returns 'default'", () => {
const { plugin } = buildPilotChannelPlugin({ logger: silentLogger() });
const cfg = plugin.config as unknown as { defaultAccountId: () => string };
expect(cfg.defaultAccountId()).toBe("default");
});
it("config.listAccountIds returns the parsed account ids without starting them", () => {
const lifecycle = new PilotLifecycle({
logger: silentLogger(),
createTransport: () => new FakeTransport(),
});
const { plugin } = buildPilotChannelPlugin({
logger: silentLogger(),
lifecycle,
});
const cfg = plugin.config as unknown as {
listAccountIds: (p: { cfg: unknown }) => string[];
};
const ids = cfg.listAccountIds({
cfg: {
channels: {
pilot: {
accounts: {
phone: { allowlist: [ALICE] },
tablet: { allowlist: [BOB] },
},
},
},
},
});
expect(ids.sort()).toEqual(["phone", "tablet"]);
});
it("config.resolveAccount returns undefined for an unknown account", () => {
const lifecycle = new PilotLifecycle({
logger: silentLogger(),
createTransport: () => new FakeTransport(),
});
const { plugin } = buildPilotChannelPlugin({
logger: silentLogger(),
lifecycle,
});
const cfg = plugin.config as unknown as {
resolveAccount: (p: {
cfg: unknown;
accountId?: string | null;
}) => { accountId: string } | undefined;
};
// Nothing started, so even with a config the lookup is undefined —
// resolveAccount delegates to lifecycle.getResolvedAccount which only
// returns accounts that have been started.
expect(
cfg.resolveAccount({ cfg: {}, accountId: "nope" }),
).toBeUndefined();
});
it("config.resolveAccount returns the running account once started", async () => {
const lifecycle = new PilotLifecycle({
logger: silentLogger(),
createTransport: () => new FakeTransport(),
});
const { plugin } = buildPilotChannelPlugin({
logger: silentLogger(),
lifecycle,
});
await lifecycle.startAll({
channels: { pilot: { allowlist: [ALICE] } },
} as never);
const cfg = plugin.config as unknown as {
resolveAccount: (p: {
cfg: unknown;
accountId?: string | null;
}) => { accountId: string } | undefined;
};
expect(cfg.resolveAccount({ cfg: {}, accountId: "default" })?.accountId).toBe("default");
// Null → default account
expect(cfg.resolveAccount({ cfg: {}, accountId: null })?.accountId).toBe("default");
await lifecycle.stopAll();
});
});
describe("buildPilotChannelPlugin — messaging.normalizeTarget edge cases", () => {
it("returns undefined when the value is only whitespace after prefix strip", () => {
const { plugin } = buildPilotChannelPlugin({ logger: silentLogger() });
expect(plugin.messaging?.normalizeTarget?.("pilot: ")).toBeUndefined();
expect(plugin.messaging?.normalizeTarget?.("")).toBeUndefined();
});
});
describe("buildPilotChannelPlugin — lifecycle hooks", () => {
it("onAccountConfigChanged stops the existing account and restarts from the new cfg", async () => {
const transports: FakeTransport[] = [];
const lifecycle = new PilotLifecycle({
logger: silentLogger(),
createTransport: () => {
const t = new FakeTransport();
transports.push(t);
return t;
},
});
const { plugin } = buildPilotChannelPlugin({
logger: silentLogger(),
lifecycle,
});
const startCfg = {
channels: { pilot: { allowlist: [ALICE] } },
} as unknown;
await lifecycle.startAll(startCfg as never);
expect(transports).toHaveLength(1);
const hooks = plugin.lifecycle as unknown as {
onAccountConfigChanged: (p: {
prevCfg: unknown;
nextCfg: unknown;
accountId: string;
}) => Promise<void>;
};
const nextCfg = {
channels: { pilot: { allowlist: [ALICE, BOB] } },
} as unknown;
await hooks.onAccountConfigChanged({
prevCfg: startCfg,
nextCfg,
accountId: "default",
});
// Old transport saw a stop() call. NOTE: the hook only stops the
// transport; it does NOT remove the account from lifecycle's internal
// accounts map. As a result the subsequent startAll → startAccount
// throws "already running" and is logged but the account state is
// unchanged. Documented here so coverage stays honest.
expect(transports[0]!.stopCount).toBeGreaterThanOrEqual(1);
// The account is still in the map (with the OLD allowlist) — visible
// proof of the bug above. We assert the observed behavior.
const acctAfter = lifecycle.getAccount("default");
expect(acctAfter).toBeDefined();
expect(acctAfter!.account.allowlist.has(ALICE)).toBe(true);
await lifecycle.stopAll();
});
it("onAccountRemoved tears down only the named account", async () => {
const transports: FakeTransport[] = [];
const lifecycle = new PilotLifecycle({
logger: silentLogger(),
createTransport: () => {
const t = new FakeTransport();
transports.push(t);
return t;
},
});
const { plugin } = buildPilotChannelPlugin({
logger: silentLogger(),
lifecycle,
});
await lifecycle.startAll({
channels: {
pilot: {
accounts: {
phone: { allowlist: [ALICE] },
tablet: { allowlist: [BOB] },
},
},
},
} as never);
expect(transports).toHaveLength(2);
const hooks = plugin.lifecycle as unknown as {
onAccountRemoved: (p: { accountId: string }) => Promise<void>;
};
await hooks.onAccountRemoved({ accountId: "phone" });
// The phone account's transport was stopped, tablet's wasn't.
expect(lifecycle.getAccount("phone")?.transport.running ?? false).toBe(false);
expect(lifecycle.getAccount("tablet")?.transport.running).toBe(true);
await lifecycle.stopAll();
});
it("onAccountRemoved is a no-op when the account never started", async () => {
const lifecycle = new PilotLifecycle({
logger: silentLogger(),
createTransport: () => new FakeTransport(),
});
const { plugin } = buildPilotChannelPlugin({
logger: silentLogger(),
lifecycle,
});
const hooks = plugin.lifecycle as unknown as {
onAccountRemoved: (p: { accountId: string }) => Promise<void>;
};
// Should not throw, should not log error.
await expect(
hooks.onAccountRemoved({ accountId: "never-existed" }),
).resolves.toBeUndefined();
});
it("runStartupMaintenance invokes lifecycle.startAll with the passed cfg", async () => {
const transports: FakeTransport[] = [];
const lifecycle = new PilotLifecycle({
logger: silentLogger(),
createTransport: () => {
const t = new FakeTransport();
transports.push(t);
return t;
},
});
const { plugin } = buildPilotChannelPlugin({
logger: silentLogger(),
lifecycle,
});
const hooks = plugin.lifecycle as unknown as {
runStartupMaintenance: (p: { cfg: unknown }) => Promise<void>;
};
await hooks.runStartupMaintenance({
cfg: { channels: { pilot: { allowlist: [ALICE] } } },
});
expect(transports).toHaveLength(1);
expect(lifecycle.getAccount("default")).toBeDefined();
await lifecycle.stopAll();
});
});