playwriter 0.3.0 → 0.3.1

package/src/cdp-relay.ts

@@ -25,7 +25,7 @@ Buffer.prototype[util.inspect.custom] = function () {
 }
 
 import { EventEmitter } from 'node:events'
-import { VERSION, EXTENSION_IDS } from './utils.js'
+import { VERSION, EXTENSION_IDS, shouldAutoEnablePlaywriter } from './utils.js'
 import { createCdpLogger, type CdpLogEntry, type CdpLogger } from './cdp-log.js'
 import { RecordingRelay } from './recording-relay.js'
 import { appendSessionToWsUrl } from './chrome-discovery.js'
@@ -521,11 +521,10 @@ export async function startPlayWriterCDPRelayServer({
     return recordingRelays.get(connId) || null
   }
 
-  // Auto-create initial tab when PLAYWRITER_AUTO_ENABLE is set and no targets exist.
-  // This allows Playwright to connect and immediately have a page to work with.
-  async function maybeAutoCreateInitialTab(options: { extensionId: string; autoEnable: boolean }): Promise<void> {
-    const { extensionId, autoEnable } = options
-    if (!autoEnable && !process.env.PLAYWRITER_AUTO_ENABLE) {
+  // Auto-create an initial blank tab when no targets exist. Set
+  // PLAYWRITER_AUTO_ENABLE=false to require manually enabled tabs instead.
+  async function maybeAutoCreateInitialTab(extensionId: string): Promise<void> {
+    if (!shouldAutoEnablePlaywriter()) {
       return
     }
     const conn = getExtensionConnection(extensionId)
@@ -655,14 +654,12 @@ export async function startPlayWriterCDPRelayServer({
     params,
     sessionId,
     source,
-    autoEnable,
   }: {
     extensionId: string | null
     method: CDPCommand['method'] | (string & {})
     params: CDPCommand['params']
     sessionId?: CDPCommand['sessionId']
     source?: CDPCommand['source']
-    autoEnable: boolean
   }) {
     const conn = getExtensionConnection(extensionId)
     const connectedTargets = conn?.connectedTargets || new Map<string, relayState.ConnectedTarget>()
@@ -702,7 +699,7 @@ export async function startPlayWriterCDPRelayServer({
           break
         }
         if (conn) {
-          await maybeAutoCreateInitialTab({ extensionId: conn.id, autoEnable })
+          await maybeAutoCreateInitialTab(conn.id)
         }
         // Forward auto-attach so Chrome emits iframe Target.attachedToTarget events.
         // Playwright relies on these (with parentFrameId) when reconnecting over CDP.
@@ -1112,7 +1109,6 @@ export async function startPlayWriterCDPRelayServer({
       const clientId = c.req.param('clientId') || 'default'
       const url = new URL(c.req.url, 'http://localhost')
       const requestedExtensionId = url.searchParams.get('extensionId')
-      const autoEnable = url.searchParams.get('autoEnable') === '1'
       // When extensionId is explicit, resolve directly. Otherwise use fallback which
       // handles single-extension and uniquely-active-extension cases (#52).
       const resolvedExtension = requestedExtensionId
@@ -1204,7 +1200,6 @@ export async function startPlayWriterCDPRelayServer({
               params,
               sessionId,
               source,
-              autoEnable,
             })
 
             if (method === 'Target.setAutoAttach' && !sessionId) {
@@ -1983,7 +1978,6 @@ export async function startPlayWriterCDPRelayServer({
   app.post('/cli/session/new', async (c) => {
     const body = (await c.req.json().catch(() => ({}))) as {
       extensionId?: string | null
-      autoEnable?: boolean
       cwd?: string
       /** Direct CDP WebSocket URL — bypasses extension, connects straight to Chrome */
       cdpEndpoint?: string
@@ -2037,7 +2031,6 @@ export async function startPlayWriterCDPRelayServer({
     const executor = manager.getExecutor({
       sessionId,
       cwd,
-      cdpConfig: { host: '127.0.0.1', port, token, extensionId: conn.stableKey, autoEnable: body.autoEnable === true },
       sessionMetadata: {
         extensionId: conn.stableKey,
         browser: conn.info.browser || null,

package/src/cli.ts

@@ -27,8 +27,6 @@ import { discoverChromeInstances, resolveDirectInput, type DiscoveredInstance }
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
-const cliRelayEnv = { PLAYWRITER_AUTO_ENABLE: '1' }
-
 const cli = goke('playwriter')
 
 cli
@@ -53,7 +51,7 @@ cli
           import('./package-paths.js'),
         ])
 
-        await ensureRelayServer({ logger: console, env: cliRelayEnv })
+        await ensureRelayServer({ logger: console })
 
         const browserPath = resolveBrowserExecutablePath({ browserPath: binaryPath })
         const extensionPath = getBundledExtensionPath()
@@ -237,7 +235,7 @@ async function executeCode(options: {
 
   // Ensure relay server is running (only for local)
   if (!host && !process.env.PLAYWRITER_HOST) {
-    const restarted = await ensureRelayServer({ logger: console, env: cliRelayEnv })
+    const restarted = await ensureRelayServer({ logger: console })
     if (restarted) {
       const connectedExtensions = await waitForConnectedExtensions({
         logger: console,
@@ -445,7 +443,7 @@ cli
     let extensions: ExtensionStatus[] = []
 
     if (isLocal) {
-      await ensureRelayServer({ logger: console, env: cliRelayEnv })
+      await ensureRelayServer({ logger: console })
       extensions = await waitForConnectedExtensions({
         timeoutMs: 12000,
         pollIntervalMs: 250,
@@ -492,7 +490,7 @@ cli
         const response = await fetch(`${serverUrl}/cli/session/new`, {
           method: 'POST',
           headers: buildAuthHeaders({ token: options.token, json: true }),
-          body: JSON.stringify({ extensionId, cwd, autoEnable: true }),
+          body: JSON.stringify({ extensionId, cwd }),
         })
         if (!response.ok) {
           const text = await response.text()
@@ -551,7 +549,7 @@ cli
           const response = await fetch(`${serverUrl}/cli/session/new`, {
             method: 'POST',
             headers: buildAuthHeaders({ token: options.token, json: true }),
-            body: JSON.stringify({ extensionId: selected.extensionId, cwd, autoEnable: true }),
+            body: JSON.stringify({ extensionId: selected.extensionId, cwd }),
           })
           if (!response.ok) {
             const text = await response.text()
@@ -577,7 +575,7 @@ cli
 
 async function ensureRelayForSessionCreation(isLocal: boolean): Promise<void> {
   if (isLocal) {
-    await ensureRelayServer({ logger: console, env: cliRelayEnv })
+    await ensureRelayServer({ logger: console })
   }
 }
 
@@ -661,7 +659,7 @@ cli
   .option('--token <token>', 'Authentication token (or use PLAYWRITER_TOKEN env var)')
   .action(async (options) => {
     if (!options.host && !process.env.PLAYWRITER_HOST) {
-      await ensureRelayServer({ logger: console, env: cliRelayEnv })
+      await ensureRelayServer({ logger: console })
     }
 
     const serverUrl = await getServerUrl(options.host)
@@ -754,7 +752,7 @@ cli
     const serverUrl = await getServerUrl(options.host)
 
     if (!options.host && !process.env.PLAYWRITER_HOST) {
-      await ensureRelayServer({ logger: console, env: cliRelayEnv })
+      await ensureRelayServer({ logger: console })
     }
 
     try {
@@ -786,7 +784,7 @@ cli
     const serverUrl = await getServerUrl(options.host)
 
     if (!options.host && !process.env.PLAYWRITER_HOST) {
-      await ensureRelayServer({ logger: console, env: cliRelayEnv })
+      await ensureRelayServer({ logger: console })
     }
 
     try {
@@ -926,7 +924,7 @@ cli
 
     // Start relay if local so the extension can connect, then fetch in parallel
     if (isLocal) {
-      await ensureRelayServer({ logger: console, env: cliRelayEnv })
+      await ensureRelayServer({ logger: console })
     }
 
     const [extensions, directInstances] = await Promise.all([

package/src/executor.ts

@@ -14,7 +14,7 @@ import { fileURLToPath } from 'node:url'
 import vm from 'node:vm'
 import * as acorn from 'acorn'
 import { createSmartDiff } from './diff-utils.js'
-import { getCdpUrl, parseRelayHost } from './utils.js'
+import { getCdpUrl, parseRelayHost, shouldAutoEnablePlaywriter } from './utils.js'
 import { getExtensionOutdatedWarning } from './relay-client.js'
 import { waitForPageLoad, WaitForPageLoadOptions, WaitForPageLoadResult } from './wait-for-page-load.js'
 import { ICDPSession, getCDPSessionForPage } from './cdp-session.js'
@@ -150,7 +150,7 @@ const EXTENSION_NOT_CONNECTED_ERROR = `The Playwriter Chrome extension is not co
 2. Clicked the extension icon on a tab to enable it (or refreshed the page if just installed)`
 
 const NO_PAGES_AVAILABLE_ERROR =
-  'No Playwright pages are available. Enable Playwriter on a tab or set PLAYWRITER_AUTO_ENABLE=1 to auto-create one.'
+  'No Playwright pages are available. Enable Playwriter on a tab or unset PLAYWRITER_AUTO_ENABLE=false to auto-create one.'
 
 const MAX_LOGS_PER_PAGE = 5000
 
@@ -227,7 +227,6 @@ export interface CdpConfig {
   port?: number
   token?: string
   extensionId?: string | null
-  autoEnable?: boolean
   /** Direct CDP WebSocket URL — bypasses relay + extension, connects straight to Chrome */
   directCdpUrl?: string
 }
@@ -1418,7 +1417,7 @@ export class PlaywrightExecutor {
     }
   }
 
-  // When extension is connected but has no pages, auto-create only if PLAYWRITER_AUTO_ENABLE is set.
+  // When extension is connected but has no pages, auto-create unless PLAYWRITER_AUTO_ENABLE=false disables it.
   // In direct CDP mode, always create a page (no extension check needed).
   private async ensurePageForContext(options: { context: BrowserContext; timeout: number }): Promise<Page> {
     const { context, timeout } = options
@@ -1440,7 +1439,7 @@ export class PlaywrightExecutor {
       throw new Error(EXTENSION_NOT_CONNECTED_ERROR)
     }
 
-    if (!process.env.PLAYWRITER_AUTO_ENABLE) {
+    if (!shouldAutoEnablePlaywriter()) {
       const waitTimeoutMs = Math.min(timeout, 1000)
       const startTime = Date.now()
       while (Date.now() - startTime < waitTimeoutMs) {

package/src/relay-session.test.ts

@@ -1279,7 +1279,7 @@ describe('Auto-enable Tests', () => {
 
     const previousAutoEnable = process.env.PLAYWRITER_AUTO_ENABLE
     delete process.env.PLAYWRITER_AUTO_ENABLE
-    const browser = await chromium.connectOverCDP(getCdpUrl({ port: TEST_PORT, autoEnable: true })).finally(() => {
+    const browser = await chromium.connectOverCDP(getCdpUrl({ port: TEST_PORT })).finally(() => {
       if (previousAutoEnable === undefined) {
         delete process.env.PLAYWRITER_AUTO_ENABLE
         return

package/src/utils.ts

@@ -36,13 +36,11 @@ export function getCdpUrl({
   host = '127.0.0.1',
   token,
   extensionId,
-  autoEnable,
 }: {
   port?: number
   host?: string
   token?: string
   extensionId?: string | null
-  autoEnable?: boolean
 } = {}) {
   const id = `${Math.random().toString(36).substring(2, 15)}_${Date.now()}`
   const params = new URLSearchParams()
@@ -52,15 +50,16 @@ export function getCdpUrl({
   if (extensionId) {
     params.set('extensionId', extensionId)
   }
-  if (autoEnable) {
-    params.set('autoEnable', '1')
-  }
   const queryString = params.toString()
   const suffix = queryString ? `?${queryString}` : ''
   const { wsBaseUrl } = parseRelayHost(host, port)
   return `${wsBaseUrl}/cdp/${id}${suffix}`
 }
 
+export function shouldAutoEnablePlaywriter(): boolean {
+  return process.env.PLAYWRITER_AUTO_ENABLE?.toLowerCase() !== 'false'
+}
+
 // Use ~/.playwriter for logs so each OS user gets their own dir (avoids permission errors on shared machines, see #44)
 const LOG_BASE_DIR = path.join(os.homedir(), '.playwriter')
 export const LOG_FILE_PATH = process.env.PLAYWRITER_LOG_FILE_PATH || path.join(LOG_BASE_DIR, 'relay-server.log')