Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 12 additions & 19 deletions src/main/browserbase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* @module main/browserbase
*/

import { safeError } from "./diagnostics";
import { BrowserbaseSession, BrowserbaseSessionStatus, SessionConfig } from "../shared/types";

/** Browserbase API base URL */
Expand Down Expand Up @@ -143,9 +144,9 @@ export class BrowserbaseClient {

return response;
} catch (error) {
lastError = error as Error;
lastError = safeError(error);
const delay = RETRY_DELAY_MS * Math.pow(2, attempt);
console.log(`Request failed: ${(error as Error).message}, retrying in ${delay}ms...`);
console.log(`Request failed: ${safeError(error).message}, retrying in ${delay}ms...`);
await this.sleep(delay);
}
}
Expand Down Expand Up @@ -195,8 +196,7 @@ export class BrowserbaseClient {
});

if (!response.ok) {
const error = await response.text();
throw new Error(`Failed to get Browserbase session: ${error}`);
throw new Error(`Failed to get Browserbase session (HTTP ${response.status})`);
}

return await response.json() as BrowserbaseApiSession;
Expand Down Expand Up @@ -224,8 +224,7 @@ export class BrowserbaseClient {
});

if (!response.ok) {
const error = await response.text();
throw new Error(`Failed to get Browserbase debug info: ${error}`);
throw new Error(`Failed to get Browserbase debug info (HTTP ${response.status})`);
}

return await response.json() as BrowserbaseDebugInfo;
Expand All @@ -240,7 +239,6 @@ export class BrowserbaseClient {

// Get the debug/live view URL from the debug endpoint once the browser is running.
const debugUrl = await this.getDebugUrl(session.id);
console.log("Using debugUrl:", debugUrl);

return {
id: session.id,
Expand Down Expand Up @@ -331,8 +329,7 @@ export class BrowserbaseClient {
}

if (!response.ok) {
const error = await response.text();
let errorMessage = `Failed to create Browserbase session: ${error}`;
let errorMessage = `Failed to create Browserbase session (HTTP ${response.status})`;
if (response.status === 401) {
errorMessage = "Authentication failed. Please check your BROWSERBASE_API_KEY.";
} else if (response.status === 403) {
Expand All @@ -344,7 +341,7 @@ export class BrowserbaseClient {
}

const session = (await response.json()) as BrowserbaseApiSession;
console.log("Browserbase session created:", JSON.stringify(session, null, 2));
console.log("Browserbase session created with status:", session.status);

if (session.status === "PENDING") {
console.log(`Browserbase session ${session.id} is pending; polling until RUNNING...`);
Expand All @@ -370,15 +367,14 @@ export class BrowserbaseClient {
async getDebugUrl(sessionId: string): Promise<string> {
try {
const debugInfo = await this.fetchDebugInfo(sessionId);
console.log("Debug info:", JSON.stringify(debugInfo, null, 2));

// Use debuggerFullscreenUrl for the embedded view, hide navbar since we have our own
const baseUrl = debugInfo.debuggerFullscreenUrl || debugInfo.debuggerUrl ||
this.fallbackDebugUrl(sessionId);

return this.appendNavbarParam(baseUrl);
} catch (error) {
console.error("Error getting debug URL:", error);
console.error("Error getting debug URL:", safeError(error).message);
return this.fallbackDebugUrl(sessionId);
}
}
Expand All @@ -401,8 +397,6 @@ export class BrowserbaseClient {
try {
const debugInfo = await this.fetchDebugInfo(sessionId);

console.log("Looking for page with URL:", pageUrl);
console.log("Available pages:", debugInfo.pages?.map(p => ({ id: p.id, url: p.url })));

// Find the page by URL match
if (debugInfo.pages) {
Expand All @@ -426,7 +420,7 @@ export class BrowserbaseClient {

return null;
} catch (error) {
console.error("Error getting debug URL for page:", error);
console.error("Error getting debug URL for page:", safeError(error).message);
return null;
}
}
Expand All @@ -453,7 +447,7 @@ export class BrowserbaseClient {
console.log("Found matching target:", targetId);
return this.getDebugUrlFromPage(matchingPage);
} catch (error) {
console.error("Error getting debug URL for target:", error);
console.error("Error getting debug URL for target:", safeError(error).message);
return null;
}
}
Expand Down Expand Up @@ -492,12 +486,11 @@ export class BrowserbaseClient {
});

if (!response.ok) {
const error = await response.text();
console.error(`Failed to stop Browserbase session: ${error}`);
console.error(`Failed to stop Browserbase session (HTTP ${response.status})`);
}
} catch (error) {
// Log but don't throw - this is cleanup code
console.error("Error stopping session:", error);
console.error("Error stopping session:", safeError(error).message);
}
}

Expand Down
12 changes: 12 additions & 0 deletions src/main/diagnostics.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/** Keep connection URLs and API credentials out of logs and renderer errors. */
export function safeError(error: unknown): Error {
let message = error instanceof Error ? error.message : "Unexpected error";
// Playwright includes the complete CDP endpoint in connection failure messages.
// Debug URLs may also carry signed access without an API key parameter.
message = message.replace(/(?:https?|wss?):\/\/[^\s<>"']+/gi, "[URL redacted]");
const apiKey = process.env.BROWSERBASE_API_KEY;
if (apiKey) {
message = message.split(apiKey).join("[credential redacted]");
}
return new Error(message);
}
48 changes: 24 additions & 24 deletions src/main/session.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* @module main/session
*/

import { safeError } from "./diagnostics";
import { chromium, Browser, CDPSession, Page, BrowserContext } from "playwright-core";
import { BrowserWindow } from "electron";
import { BrowserbaseSession, TabInfo, IPC_CHANNELS, DownloadInfo, ScrollInputEvent } from "../shared/types";
Expand Down Expand Up @@ -85,7 +86,7 @@ export class SessionManager {

const deviceScaleFactor = process.platform === "darwin" ? 2 : 1;

console.log(`[Viewport] Applying viewport ${width}x${height} (scale: ${deviceScaleFactor}) to page: ${page.url()}`);
console.log(`[Viewport] Applying viewport ${width}x${height} (scale: ${deviceScaleFactor})`);

await cdp.send("Emulation.setDeviceMetricsOverride", {
width,
Expand All @@ -96,7 +97,7 @@ export class SessionManager {

console.log("[Viewport] Viewport applied successfully");
} catch (error) {
console.error("[Viewport] Failed to apply viewport:", error);
console.error("[Viewport] Failed to apply viewport:", safeError(error).message);
}
}

Expand Down Expand Up @@ -161,9 +162,9 @@ export class SessionManager {

return this.session;
} catch (error) {
console.error("Failed to initialize session:", error);
this.notifyError(error as Error);
throw error;
console.error("Failed to initialize session:", safeError(error).message);
this.notifyError(safeError(error));
throw safeError(error);
}
}

Expand Down Expand Up @@ -202,7 +203,7 @@ export class SessionManager {
try {
this.cdpSession = await page.context().newCDPSession(page);
} catch (cdpError) {
console.warn("Could not create CDP session:", cdpError);
console.warn("Could not create CDP session:", safeError(cdpError).message);
// Continue without CDP session - basic functionality still works
}

Expand All @@ -221,8 +222,8 @@ export class SessionManager {
await this.applyViewportToAllPages();

} catch (error) {
console.error("Failed to connect to browser:", error);
throw error;
console.error("Failed to connect to browser:", safeError(error).message);
throw safeError(error);
} finally {
this.isConnecting = false;
}
Expand Down Expand Up @@ -321,7 +322,7 @@ export class SessionManager {

this.notifyTabsUpdated();
} catch (error) {
console.error("Failed to sync tabs:", error);
console.error("Failed to sync tabs:", safeError(error).message);
}
}

Expand Down Expand Up @@ -350,7 +351,7 @@ export class SessionManager {
const targetInfo = await cdp.send("Target.getTargetInfo") as { targetInfo?: { targetId?: string } };
return targetInfo.targetInfo?.targetId || null;
} catch (error) {
console.warn("Failed to read page target ID:", error);
console.warn("Failed to read page target ID:", safeError(error).message);
return null;
}
}
Expand Down Expand Up @@ -437,8 +438,8 @@ export class SessionManager {
await this.syncTabs();
}
} catch (error) {
console.error("Navigation failed:", error);
throw error;
console.error("Navigation failed:", safeError(error).message);
throw safeError(error);
}
}

Expand All @@ -450,7 +451,7 @@ export class SessionManager {
await activePage.goBack();
await this.syncTabs();
} catch (error) {
console.error("Go back failed:", error);
console.error("Go back failed:", safeError(error).message);
}
}

Expand All @@ -462,7 +463,7 @@ export class SessionManager {
await activePage.goForward();
await this.syncTabs();
} catch (error) {
console.error("Go forward failed:", error);
console.error("Go forward failed:", safeError(error).message);
}
}

Expand All @@ -474,7 +475,7 @@ export class SessionManager {
await activePage.reload();
await this.syncTabs();
} catch (error) {
console.error("Reload failed:", error);
console.error("Reload failed:", safeError(error).message);
}
}

Expand All @@ -493,7 +494,7 @@ export class SessionManager {
modifiers: this.getCdpModifierMask(scrollEvent.modifiers),
});
} catch (error) {
console.error("Scroll dispatch failed:", error);
console.error("Scroll dispatch failed:", safeError(error).message);
}
}

Expand Down Expand Up @@ -534,7 +535,7 @@ export class SessionManager {
}
}
} catch (error) {
console.error("New tab failed:", error);
console.error("New tab failed:", safeError(error).message);
}
}

Expand Down Expand Up @@ -569,14 +570,14 @@ export class SessionManager {
this.notifyDebugUrlChanged(newDebugUrl);
}
} catch (e) {
console.error("Failed to get debug URL after close:", e);
console.error("Failed to get debug URL after close:", safeError(e).message);
}
}, 300);
}
}
}
} catch (error) {
console.error("Close tab failed:", error);
console.error("Close tab failed:", safeError(error).message);
}
}

Expand Down Expand Up @@ -609,14 +610,14 @@ export class SessionManager {
this.notifyDebugUrlChanged(newDebugUrl);
}
} catch (e) {
console.error("Failed to get debug URL for page:", e);
console.error("Failed to get debug URL for page:", safeError(e).message);
}
}

await this.syncTabs();
}
} catch (error) {
console.error("Switch tab failed:", error);
console.error("Switch tab failed:", safeError(error).message);
}
}

Expand Down Expand Up @@ -661,7 +662,7 @@ export class SessionManager {
await this.connectToBrowser();
this.reconnectAttempts = 0;
} catch (error) {
console.error("Reconnection failed:", error);
console.error("Reconnection failed:", safeError(error).message);
this.handleDisconnect();
}
}, 2000);
Expand Down Expand Up @@ -697,7 +698,6 @@ export class SessionManager {

private notifyDebugUrlChanged(url: string): void {
if (this.mainWindow && !this.mainWindow.isDestroyed()) {
console.log("Notifying debug URL changed:", url);
this.mainWindow.webContents.send(IPC_CHANNELS.DEBUG_URL_CHANGED, url);
}
}
Expand All @@ -720,7 +720,7 @@ export class SessionManager {
this.session = null;
}
} catch (error) {
console.error("Cleanup failed:", error);
console.error("Cleanup failed:", safeError(error).message);
}
}
}
Expand Down
42 changes: 42 additions & 0 deletions tests/diagnostics.test.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
const { test, mock } = require('node:test');
const assert = require('node:assert/strict');
const { BrowserbaseClient } = require('../dist/main/browserbase');
const { safeError } = require('../dist/main/diagnostics');

test('session creation and debug lookup do not log access credentials', async (t) => {
const previous = process.env.BROWSERBASE_API_KEY;
process.env.BROWSERBASE_API_KEY = 'synthetic-api-secret';
t.after(() => { if (previous === undefined) delete process.env.BROWSERBASE_API_KEY; else process.env.BROWSERBASE_API_KEY = previous; });
const output = [];
t.mock.method(console, 'log', (...args) => output.push(args.join(' ')));
t.mock.method(console, 'error', (...args) => output.push(args.join(' ')));
t.mock.method(globalThis, 'fetch', async (url) => Response.json(url.endsWith('/debug') ? {
debuggerFullscreenUrl: 'https://example.com/live?token=synthetic-signed-secret',
pages: [{ url: 'https://example.com/private?query=synthetic-query-secret' }],
} : {
id: 'synthetic-session', status: 'RUNNING',
connectUrl: 'wss://example.com?apiKey=synthetic-api-secret',
signingKey: 'synthetic-signing-secret',
}));
const client = new BrowserbaseClient();
await client.createSession();
await client.getDebugUrlForPage('synthetic-session', 'https://example.com/private?query=synthetic-query-secret');
assert.doesNotMatch(output.join('\n'), /synthetic-(api|signed|signing|query)-secret/);
});

test('HTTP error bodies never become user-facing errors', async (t) => {
const previous = process.env.BROWSERBASE_API_KEY;
process.env.BROWSERBASE_API_KEY = 'synthetic-api-secret';
t.after(() => { if (previous === undefined) delete process.env.BROWSERBASE_API_KEY; else process.env.BROWSERBASE_API_KEY = previous; });
t.mock.method(globalThis, 'fetch', async () => new Response('synthetic-upstream-secret', { status: 422 }));
await assert.rejects(new BrowserbaseClient().createSession(), { message: 'Failed to create Browserbase session (HTTP 422)' });
});

test('connection errors redact URL credentials and unstructured API keys', (t) => {
const previous = process.env.BROWSERBASE_API_KEY;
process.env.BROWSERBASE_API_KEY = 'synthetic-api-secret';
t.after(() => { if (previous === undefined) delete process.env.BROWSERBASE_API_KEY; else process.env.BROWSERBASE_API_KEY = previous; });
const error = safeError(new Error('connect wss://example.com?apiKey=synthetic-api-secret and https://example.com/live/signed-value failed: synthetic-api-secret'));
assert.equal(error.message, 'connect [URL redacted] and [URL redacted] failed: [credential redacted]');
assert.doesNotMatch(error.stack, /synthetic-api-secret|signed-value/);
});