Skip to content

Feature: Allow passing managed client and session to HyperbrowserProvider #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imsahsol wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Feature: Allow passing managed client and session to HyperbrowserProvider #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions src/browser-providers/hyperbrowser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,57 @@ export class HyperbrowserProvider extends BrowserProvider<SessionDetail> {
session: SessionDetail | undefined;
hbClient: Hyperbrowser | undefined;
debug: boolean;
keepBrowserOpen: boolean;
externallyManaged: boolean;

constructor(params?: {
debug?: boolean;
browserConfig?: Omit<ConnectOverCDPOptions, "endpointURL">;
sessionConfig?: CreateSessionParams;
config?: HyperbrowserConfig;
client?: Hyperbrowser;
session?: SessionDetail;
keepBrowserOpen?: boolean;
}) {
super();
this.debug = params?.debug ?? false;
this.browserConfig = params?.browserConfig;
this.sessionConfig = params?.sessionConfig;
this.config = params?.config;
this.keepBrowserOpen = params?.keepBrowserOpen ?? false;
if (params?.client && params?.session) {
this.hbClient = params.client;
this.session = params.session;
this.externallyManaged = true;
} else this.externallyManaged = false;
}

async start(): Promise<Browser> {
const client = new Hyperbrowser(this.config);
const session = await client.sessions.create(this.sessionConfig);
this.hbClient = client;
this.session = session;
if (!this.externallyManaged) {
this.hbClient = new Hyperbrowser(this.config);
this.session = await this.hbClient.sessions.create(this.sessionConfig);
}

if (!this.session) {
throw new Error("Failed to initialize or acquire a Hyperbrowser session");
}

const wsEndpoint = this.keepBrowserOpen
? this.session.wsEndpoint + (this.session.wsEndpoint.includes('?') ? '&' : '?') + 'keepAlive=true'
: this.session.wsEndpoint;

this.browser = await chromium.connectOverCDP(
session.wsEndpoint,
wsEndpoint,
this.browserConfig
);

if (this.debug) {
console.log(
"\nHyperbrowser session info:",
{
liveUrl: session.liveUrl,
sessionID: session.id,
infoUrl: session.sessionUrl,
liveUrl: this.session.liveUrl,
sessionID: this.session.id,
infoUrl: this.session.sessionUrl,
},
"\n"
);
Expand All @@ -57,7 +77,8 @@ export class HyperbrowserProvider extends BrowserProvider<SessionDetail> {

async close(): Promise<void> {
await this.browser?.close();
if (this.session) {
// Only stop the session if it's internally managed
if (!this.externallyManaged && this.session) {
await this.hbClient?.sessions.stop(this.session.id);
}
}
Expand Down