177 lines
5.3 KiB
TypeScript
177 lines
5.3 KiB
TypeScript
import type { BrowserObservationEndpoint } from "../domain/browserObservation.js";
|
|
import { BrowserObservationError } from "../domain/browserObservationError.js";
|
|
import type { BrowserObservationOperation } from "../domain/browserObservationErrors.js";
|
|
import { CdpConnection } from "./CdpConnection.js";
|
|
import {
|
|
cdpTargetWebSocket,
|
|
discoverCdpBrowserSocket,
|
|
discoverCdpEndpoint,
|
|
withCdpDiscoveryDeadline,
|
|
type CdpEndpointDiscovery,
|
|
type CdpEndpointTarget,
|
|
} from "./CdpEndpoint.js";
|
|
|
|
/** One CDP connection scoped either by a flat browser session or page socket. */
|
|
export interface CdpTargetSession {
|
|
readonly connection: CdpConnection;
|
|
readonly sessionId: string | undefined;
|
|
}
|
|
|
|
/** Discovery for one caller-selected endpoint and the browser socket that read it. */
|
|
export interface CdpOpenedEndpoint {
|
|
readonly discovery: CdpEndpointDiscovery;
|
|
/**
|
|
* Browser socket kept for the target session, because a browser may ask
|
|
* the user to approve each socket. HTTP discovery opens no socket.
|
|
*/
|
|
readonly connection: CdpConnection | undefined;
|
|
}
|
|
|
|
/**
|
|
* Discover one passive browser endpoint through its selected transport. A
|
|
* browser socket's handshake and discovery share one discovery deadline.
|
|
*/
|
|
export const openCdpEndpoint = async (
|
|
endpoint: BrowserObservationEndpoint,
|
|
operation: BrowserObservationOperation,
|
|
signal?: AbortSignal,
|
|
timeoutMs?: number,
|
|
): Promise<CdpOpenedEndpoint> => {
|
|
if (endpoint.transport === "http_discovery")
|
|
return {
|
|
discovery: await discoverCdpEndpoint(endpoint.url, operation, signal),
|
|
connection: undefined,
|
|
};
|
|
return await withCdpDiscoveryDeadline(
|
|
operation,
|
|
signal,
|
|
async (deadlineSignal) => {
|
|
const connection = await CdpConnection.connect(
|
|
endpoint.url,
|
|
operation,
|
|
deadlineSignal,
|
|
);
|
|
try {
|
|
return {
|
|
discovery: await discoverCdpBrowserSocket(
|
|
connection,
|
|
endpoint.url,
|
|
operation,
|
|
deadlineSignal,
|
|
),
|
|
connection,
|
|
};
|
|
} catch (cause: unknown) {
|
|
await connection.close();
|
|
throw cause;
|
|
}
|
|
},
|
|
timeoutMs,
|
|
);
|
|
};
|
|
|
|
/** Open one authorized target through its supported browser or page transport. */
|
|
export const openCdpTargetSession = async (
|
|
discovery: CdpEndpointDiscovery,
|
|
target: CdpEndpointTarget,
|
|
operation: BrowserObservationOperation,
|
|
signal?: AbortSignal,
|
|
limits?: { readonly maxPayloadBytes: number },
|
|
): Promise<CdpTargetSession> => {
|
|
const webSocket = cdpTargetWebSocket(discovery, target, operation);
|
|
const connection = await CdpConnection.connect(
|
|
webSocket.url,
|
|
operation,
|
|
signal,
|
|
limits,
|
|
);
|
|
if (webSocket.scope === "page") return { connection, sessionId: undefined };
|
|
return await attachCdpTargetSession(connection, target, operation, signal);
|
|
};
|
|
|
|
/** Attach one target through an open browser socket, which the session then owns. */
|
|
export const attachCdpTargetSession = async (
|
|
connection: CdpConnection,
|
|
target: CdpEndpointTarget,
|
|
operation: BrowserObservationOperation,
|
|
signal?: AbortSignal,
|
|
): Promise<CdpTargetSession> => {
|
|
try {
|
|
const attached = await connection.send(
|
|
"Target.attachToTarget",
|
|
{ targetId: target.id, flatten: true },
|
|
undefined,
|
|
signal,
|
|
);
|
|
return { connection, sessionId: attachedSessionId(attached, operation) };
|
|
} catch (cause: unknown) {
|
|
await connection.close();
|
|
throw cause;
|
|
}
|
|
};
|
|
|
|
/** Disable enabled domains, detach browser sessions, and close REA's socket. */
|
|
export const closeCdpTargetSession = async (
|
|
targetSession: CdpTargetSession,
|
|
enabledDomains: readonly string[],
|
|
signal?: AbortSignal,
|
|
): Promise<void> => {
|
|
const { connection, sessionId } = targetSession;
|
|
const cleanup = new AbortController();
|
|
const domainSignal =
|
|
signal === undefined
|
|
? cleanup.signal
|
|
: AbortSignal.any([cleanup.signal, signal]);
|
|
const timeout = setTimeout(() => cleanup.abort(), 1_000);
|
|
timeout.unref();
|
|
try {
|
|
if (signal?.aborted !== true) {
|
|
for (const domain of enabledDomains) {
|
|
if (domainSignal.aborted) break;
|
|
try {
|
|
await connection.send(
|
|
`${domain}.disable`,
|
|
{},
|
|
sessionId,
|
|
domainSignal,
|
|
);
|
|
} catch {
|
|
// Best-effort domain cleanup; transport close is the definitive boundary.
|
|
}
|
|
}
|
|
}
|
|
// Cancellation skips optional domain shutdown but still releases the
|
|
// attached session using its independent, bounded cleanup signal.
|
|
if (!cleanup.signal.aborted && sessionId !== undefined)
|
|
try {
|
|
await connection.send(
|
|
"Target.detachFromTarget",
|
|
{ sessionId },
|
|
undefined,
|
|
cleanup.signal,
|
|
);
|
|
} catch {
|
|
// Best-effort detach; transport close is the definitive boundary.
|
|
}
|
|
} finally {
|
|
clearTimeout(timeout);
|
|
cleanup.abort();
|
|
await connection.close();
|
|
}
|
|
};
|
|
|
|
const attachedSessionId = (
|
|
value: unknown,
|
|
operation: BrowserObservationOperation,
|
|
): string => {
|
|
if (
|
|
typeof value !== "object" ||
|
|
value === null ||
|
|
!("sessionId" in value) ||
|
|
typeof value.sessionId !== "string" ||
|
|
value.sessionId.length === 0
|
|
)
|
|
throw new BrowserObservationError(operation, "protocol_error");
|
|
return value.sessionId;
|
|
};
|