|
| 1 | +/** |
| 2 | + * A managed browser session (PRD M3.4 / §15.1). `tron.launch()` starts a |
| 3 | + * `tron-session`, and each Browser owns that session's lifecycle: it hands out |
| 4 | + * Page objects (one CDP connection per tab) and tears the session down on close. |
| 5 | + */ |
| 6 | +import type { CdpConnection, CdpTarget, SessionDescriptor } from '@tronbrowser/browser-core'; |
| 7 | +import { defaultDeps, type SdkDeps } from './deps.js'; |
| 8 | +import { Page } from './page.js'; |
| 9 | +import { Tracer, tracerFromEnv } from './trace.js'; |
| 10 | + |
| 11 | +export interface LaunchOptions { |
| 12 | + headless?: boolean; |
| 13 | + profile?: string; |
| 14 | +} |
| 15 | + |
| 16 | +export class Browser { |
| 17 | + readonly #deps: SdkDeps; |
| 18 | + readonly #dataDir: string; |
| 19 | + readonly #descriptor: SessionDescriptor; |
| 20 | + readonly #pages: Page[] = []; |
| 21 | + readonly #usedTargets = new Set<string>(); |
| 22 | + readonly #tracer: Tracer | undefined; |
| 23 | + readonly #traceDir: string | undefined; |
| 24 | + #browserConn: CdpConnection | undefined; |
| 25 | + #closed = false; |
| 26 | + |
| 27 | + private constructor( |
| 28 | + deps: SdkDeps, |
| 29 | + dataDir: string, |
| 30 | + descriptor: SessionDescriptor, |
| 31 | + trace?: { tracer: Tracer; dir: string }, |
| 32 | + ) { |
| 33 | + this.#deps = deps; |
| 34 | + this.#dataDir = dataDir; |
| 35 | + this.#descriptor = descriptor; |
| 36 | + this.#tracer = trace?.tracer; |
| 37 | + this.#traceDir = trace?.dir; |
| 38 | + } |
| 39 | + |
| 40 | + /** Launch a managed session and return a Browser. */ |
| 41 | + static async launch(options: LaunchOptions = {}, deps: SdkDeps = defaultDeps): Promise<Browser> { |
| 42 | + // CLI flags from `tron run` arrive via env and win when the script is neutral. |
| 43 | + const headless = options.headless ?? process.env.TRON_RUN_HEADLESS === '1'; |
| 44 | + const profile = options.profile ?? process.env.TRON_RUN_PROFILE; |
| 45 | + const dataDir = await deps.makeDataDir(); |
| 46 | + try { |
| 47 | + await deps.launchSession(dataDir, { |
| 48 | + headless, |
| 49 | + ...(profile !== undefined ? { profile } : {}), |
| 50 | + }); |
| 51 | + const descriptor = await deps.loadDescriptor(dataDir); |
| 52 | + return new Browser(deps, dataDir, descriptor, tracerFromEnv(process.env)); |
| 53 | + } catch (err) { |
| 54 | + await deps.closeSession(dataDir).catch(() => {}); |
| 55 | + await deps.removeDataDir(dataDir).catch(() => {}); |
| 56 | + throw err; |
| 57 | + } |
| 58 | + } |
| 59 | + |
| 60 | + #targets(): Promise<CdpTarget[]> { |
| 61 | + return this.#deps.fetchTargets(this.#descriptor.host, this.#descriptor.port); |
| 62 | + } |
| 63 | + |
| 64 | + /** Open (or adopt the first free) page target and return a Page for it. */ |
| 65 | + async newPage(): Promise<Page> { |
| 66 | + if (this.#closed) throw new Error('Browser is closed'); |
| 67 | + |
| 68 | + let target = (await this.#targets()).find( |
| 69 | + (t) => t.type === 'page' && !this.#usedTargets.has(t.id), |
| 70 | + ); |
| 71 | + if (!target) target = await this.#createTarget(); |
| 72 | + if (!target.webSocketDebuggerUrl) { |
| 73 | + throw new Error(`Page target ${target.id} has no webSocketDebuggerUrl`); |
| 74 | + } |
| 75 | + |
| 76 | + const conn = await this.#deps.connect(target.webSocketDebuggerUrl); |
| 77 | + const page = await Page.attach(conn, target.id, this.#tracer); |
| 78 | + this.#usedTargets.add(target.id); |
| 79 | + this.#pages.push(page); |
| 80 | + return page; |
| 81 | + } |
| 82 | + |
| 83 | + async #createTarget(): Promise<CdpTarget> { |
| 84 | + if (!this.#descriptor.webSocketDebuggerUrl) { |
| 85 | + throw new Error('Cannot open another page: session has no browser WebSocket endpoint'); |
| 86 | + } |
| 87 | + this.#browserConn ??= await this.#deps.connect(this.#descriptor.webSocketDebuggerUrl); |
| 88 | + const { targetId } = await this.#browserConn.send<{ targetId: string }>('Target.createTarget', { |
| 89 | + url: 'about:blank', |
| 90 | + }); |
| 91 | + const created = (await this.#targets()).find((t) => t.id === targetId); |
| 92 | + if (!created) throw new Error('Newly created page target did not appear'); |
| 93 | + return created; |
| 94 | + } |
| 95 | + |
| 96 | + /** Pages opened so far. */ |
| 97 | + pages(): Page[] { |
| 98 | + return [...this.#pages]; |
| 99 | + } |
| 100 | + |
| 101 | + /** Close every page, stop the managed session, and remove its temp profile. */ |
| 102 | + async close(): Promise<void> { |
| 103 | + if (this.#closed) return; |
| 104 | + this.#closed = true; |
| 105 | + for (const page of this.#pages) page.close(); |
| 106 | + this.#browserConn?.close(); |
| 107 | + if (this.#tracer && this.#traceDir) { |
| 108 | + await this.#tracer |
| 109 | + .flush(this.#traceDir, { headless: this.#descriptor.headless, profile: this.#descriptor.profileName }) |
| 110 | + .catch(() => {}); |
| 111 | + } |
| 112 | + await this.#deps.closeSession(this.#dataDir).catch(() => {}); |
| 113 | + await this.#deps.removeDataDir(this.#dataDir).catch(() => {}); |
| 114 | + } |
| 115 | +} |
0 commit comments