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
|
import { createCdpSession, type CdpSession } from "../../src/cdp/session";
import { createOwnershipRegistry, type OwnershipRegistry } from "../../src/cdp/ownership";
import { type CdpError, cdpError } from "../../src/cdp/errors";
import type { CdpTransport } from "../../src/cdp/types";
import type { CdpEvent } from "../../src/cdp/types";
import type { BrowserClient } from "../../src/client";
import { createMutex } from "../../src/util/mutex";
import { type Result, err, ok } from "../../src/util/result";
export type RecordedCall = {
readonly method: string;
readonly params: Record<string, unknown>;
readonly sessionId: string | null | undefined;
};
export type CannedResult = Result<unknown, CdpError>;
export type Canned = Record<string, CannedResult | ReadonlyArray<CannedResult>>;
export type StubTransport = {
readonly transport: CdpTransport;
readonly calls: RecordedCall[];
readonly emit: (event: CdpEvent) => void;
readonly closeQueue: () => void;
};
const DEFAULT_ATTACH: Canned = {
"Target.setDiscoverTargets": ok({}),
"Target.getTargets": ok({
targetInfos: [{ targetId: "t1", type: "page", title: "Fake", url: "https://example.test/" }],
}),
"Target.attachToTarget": ok({ sessionId: "s1" }),
"Browser.getWindowForTarget": ok({ windowId: 7 }),
};
export const createStubTransport = (canned: Canned = {}): StubTransport => {
const calls: RecordedCall[] = [];
const queues = new Map<string, CannedResult[]>();
for (const [method, value] of Object.entries(canned)) {
queues.set(method, Array.isArray(value) ? [...value] : [value]);
}
const buffered: CdpEvent[] = [];
const waiters: Array<(v: IteratorResult<CdpEvent, undefined>) => void> = [];
let ended = false;
const next = (method: string): CannedResult => {
const queue = queues.get(method);
if (queue === undefined || queue.length === 0) return ok({});
const head = queue.length === 1 ? queue[0] : queue.shift();
return head ?? ok({});
};
const transport: CdpTransport = {
connect: () => Promise.resolve(ok(undefined)),
close: () => Promise.resolve(),
request: (method, params, opts) => {
calls.push({ method, params, sessionId: opts?.sessionId });
return Promise.resolve(next(method));
},
events: (): AsyncIterable<CdpEvent> => ({
[Symbol.asyncIterator]: (): AsyncIterator<CdpEvent, undefined, undefined> => ({
next: (): Promise<IteratorResult<CdpEvent, undefined>> =>
new Promise((resolve) => {
const head = buffered.shift();
if (head !== undefined) resolve({ value: head, done: false });
else if (ended) resolve({ value: undefined, done: true });
else waiters.push(resolve);
}),
}),
}),
state: () => "open",
onClose: () => () => {},
};
return {
transport,
calls,
emit: (event) => {
const waiter = waiters.shift();
if (waiter) waiter({ value: event, done: false });
else buffered.push(event);
},
closeQueue: () => {
ended = true;
for (const w of waiters.splice(0)) w({ value: undefined, done: true });
},
};
};
export type FakeClientOptions = {
readonly canned?: Canned;
readonly evaluate?: (expression: string, sessionId?: string) => Result<unknown, CdpError>;
readonly refs?: ReadonlyArray<{ readonly ref: string; readonly backendId: number; readonly sig?: string }>;
readonly ownedTargetIds?: ReadonlyArray<string>;
};
export type FakeClient = {
readonly client: BrowserClient;
readonly session: CdpSession;
readonly ownership: OwnershipRegistry;
readonly calls: RecordedCall[];
readonly emit: (event: CdpEvent) => void;
readonly callsTo: (method: string) => ReadonlyArray<RecordedCall>;
readonly evaluated: string[];
};
const notConfigured = <T>(what: string): Result<T, CdpError> =>
err(cdpError("invalid_response", `fake client: ${what} was called but not configured`));
export const createFakeClient = async (opts: FakeClientOptions = {}): Promise<FakeClient> => {
const stub = createStubTransport({ ...DEFAULT_ATTACH, ...(opts.canned ?? {}) });
const ownership = createOwnershipRegistry({ ownedTargetIds: opts.ownedTargetIds ?? ["t1"] });
const session = createCdpSession(stub.transport, ownership);
const mutex = createMutex();
const evaluated: string[] = [];
const attached = await session.attachFirstPage();
if (!attached.success) throw new Error(`fake client could not attach: ${attached.error.message}`);
stub.calls.length = 0;
if (opts.refs !== undefined) {
const refMap = new Map<string, number>();
const refSig = new Map<string, string>();
for (const r of opts.refs) {
refMap.set(r.ref, r.backendId);
refSig.set(r.ref, r.sig ?? `textbox|${r.ref}||`);
}
session.setRefMap(refMap, refSig);
}
const client: BrowserClient = {
namespace: "fake",
ensureAlive: () => Promise.resolve(ok(undefined)),
status: () => ({ alive: true, sessionId: attached.data.sessionId, namespace: "fake" }),
start: () => Promise.resolve(ok(undefined)),
stop: () => Promise.resolve(),
detach: () => Promise.resolve(),
closeOwnedTabs: () => Promise.resolve(),
evaluateJs: (expression, sessionId) => {
evaluated.push(expression);
const run = opts.evaluate;
if (run === undefined) return Promise.resolve(notConfigured<unknown>("evaluateJs"));
return Promise.resolve(sessionId === undefined ? run(expression) : run(expression, sessionId));
},
pageInfo: () => Promise.resolve(notConfigured("pageInfo")),
takeDialog: () => session.takeDialog(),
listTabs: () => Promise.resolve(notConfigured("listTabs")),
switchTab: () => Promise.resolve(notConfigured("switchTab")),
newTab: () => Promise.resolve(notConfigured("newTab")),
closeTab: () => Promise.resolve(ok(undefined)),
owns: (id) => ownership.has(id),
ownership: () => ownership,
current: () => session.current(),
session: () => session,
transport: () => stub.transport,
userDataDir: () => undefined,
profilePin: () => null,
setProfilePin: () => {},
profileContextId: () => undefined,
setProfileContextId: () => {},
seedPinnedProfileWindow: () => Promise.resolve(notConfigured("seedPinnedProfileWindow")),
mutationMutex: () => mutex,
};
return {
client,
session,
ownership,
calls: stub.calls,
emit: stub.emit,
callsTo: (method) => stub.calls.filter((c) => c.method === method),
evaluated,
};
};
export const axNode = (
nodeId: string,
role: string,
name: string,
extra: Readonly<Record<string, unknown>> = {},
): Readonly<Record<string, unknown>> => ({
nodeId,
role: { value: role },
name: { value: name },
...extra,
});
|