pw-repl 0.2.0 → 0.2.1

package/bin/pw-repl.js

@@ -67,9 +67,13 @@ function parseSendArgs(args, allowCommand) {
   }
   const words = args.slice(i);
   if (!allowCommand && words.length) usage();
-  // A word the shell kept whole (fill "text=Your name" Ada) is quoted again, so
-  // it stays one word; a command given as a single word is sent as it is.
-  const quoted = words.length > 1 ? words.map(w => (/[\s"']/.test(w) ? JSON.stringify(w) : w)) : words;
+  // For a command that reads a quoted selector (fill "text=Your name" Ada), a
+  // word the shell kept whole is quoted again so it stays one word. Any other
+  // command takes the rest of its line as it is (eval, route's JSON), so its
+  // words are joined as they are.
+  const { SELECTOR_FIRST } = require('../lib/syntax');
+  const requote = words.length > 1 && SELECTOR_FIRST.has(words[0]);
+  const quoted = requote ? words.map(w => (/[\s"']/.test(w) ? JSON.stringify(w) : w)) : words;
   options.command = quoted.join(' ').trim();
   return options;
 }

package/lib/commands.js

@@ -3,6 +3,7 @@ const fs = require('fs');
 const { state, withTimeout, onShutdown, shutdown } = require('./state');
 const out = require('./output');
 const HELP = require('./help');
+const { toSelector, unquote, splitSelector } = require('./syntax');
 
 const { printOutput, OUTPUT_LIMIT } = out;
 const SCREENSHOT_DIR = process.env.PW_SCREENSHOT_DIR || '/tmp';
@@ -666,28 +667,6 @@ async function allModesOff() {
   if (!any) out.log('No modes were on.');
 }
 
-// A snapshot ref (e5, or f1e5 in newer Playwright) stands for aria-ref=e5.
-const REF = /^(?:f\d+)?e\d+$/;
-
-function toSelector(word) {
-  return REF.test(word) ? `aria-ref=${word}` : word;
-}
-
-// Quotes around the whole of a value are removed; \" inside double quotes is a quote.
-function unquote(text) {
-  const match = /^"((?:[^"\\]|\\.)*)"$|^'([^']*)'$/.exec(text);
-  if (!match) return text;
-  return match[1] !== undefined ? match[1].replace(/\\(.)/g, '$1') : match[2];
-}
-
-// The first word of args, or a quoted selector with spaces in it, and the rest of the line.
-function splitSelector(args) {
-  const match = /^(?:"((?:[^"\\]|\\.)*)"|'([^']*)'|(\S+))(?:\s+([\s\S]*))?$/.exec((args || '').trim());
-  if (!match) return null;
-  const word = match[1] !== undefined ? match[1].replace(/\\(.)/g, '$1') : match[2] !== undefined ? match[2] : match[3];
-  return { word, selector: toSelector(word), rest: match[4] };
-}
-
 // Commands that take only a selector take the whole line, spaces and all.
 function soleSelector(args, usage) {
   const text = unquote((args || '').trim());
@@ -703,14 +682,19 @@ function selectorAndValue(args, usage, example) {
   return { selector: parsed.selector, value: unquote(parsed.rest), shown: parsed.word };
 }
 
-// A ref that no longer matches usually means the page changed since the snapshot.
+// An element that never appeared is said plainly, not as Playwright's call
+// log. A ref that no longer matches usually means the page changed since the
+// snapshot it came from.
 async function onElement(selector, action) {
   try {
     return await action();
   } catch (error) {
-    if (selector.startsWith('aria-ref=') && !/resolved to/.test(error.message)) {
-      error.message += `\n${selector.slice(9)} is a snapshot ref; if the page changed since that snapshot, take a new one.`;
-    }
+    if (/resolved to/.test(error.message)) throw error;
+    const ref = selector.startsWith('aria-ref=') ? selector.slice(9) : null;
+    const staleRef = ref ? `\n${ref} is a snapshot ref; if the page changed since that snapshot, take a new one.` : '';
+    const waited = /Timeout (\d+)ms exceeded[\s\S]*waiting for locator/.exec(error.message);
+    if (waited) throw new Error(`No element matches ${ref || selector} (waited ${waited[1] / 1000}s)${staleRef}`);
+    error.message += staleRef;
     throw error;
   }
 }
@@ -802,13 +786,56 @@ function discardCapture() {
   cap = null;
 }
 
-// A tab of the REPL's own: closing it can go back to the tab before.
+// A tab of the REPL's own: closing it can go back to the tab before. It opens
+// in the background, so it does not take the front of the window from the
+// person using the browser; Playwright's newPage would bring it to the front.
+const OPEN_TIMEOUT = 10000;
+
 async function openTab() {
-  const opened = await state.browser.contexts()[0].newPage();
+  const ctx = state.browser.contexts()[0];
+  let opened = null;
+  const session = await state.browser.newBrowserCDPSession().catch(() => null);
+  if (session) {
+    try {
+      const { targetId } = await session.send('Target.createTarget', { url: 'about:blank', background: true });
+      opened = await pageForTarget(ctx, targetId);
+    } catch {} finally {
+      await session.detach().catch(() => {});
+    }
+  }
+  // A browser that cannot open one in the background (e.g. some headless ones) opens it as usual.
+  if (!opened) opened = await ctx.newPage();
   openedTabs.add(opened);
   return opened;
 }
 
+// page -> its CDP target id, asked for once per page.
+const targetIds = new WeakMap();
+
+async function targetIdOf(ctx, p) {
+  if (!targetIds.has(p)) {
+    const cdp = await ctx.newCDPSession(p).catch(() => null);
+    if (!cdp) return null;
+    const info = await cdp.send('Target.getTargetInfo').catch(() => null);
+    await cdp.detach().catch(() => {});
+    if (!info) return null;
+    targetIds.set(p, info.targetInfo.targetId);
+  }
+  return targetIds.get(p);
+}
+
+async function pageForTarget(ctx, targetId) {
+  const deadline = Date.now() + OPEN_TIMEOUT;
+  while (Date.now() < deadline) {
+    for (const p of ctx.pages()) {
+      if (openedTabs.has(p)) continue;
+      if (await targetIdOf(ctx, p) === targetId) return p;
+    }
+    await new Promise(resolve => setTimeout(resolve, 50));
+  }
+  return null;
+}
+
 // Every tab, URL first, with * on the selected one. The numbers are what tab <index> uses.
 async function listTabs() {
   const all = state.browser.contexts().flatMap(c => c.pages());
@@ -1073,6 +1100,9 @@ const commands = {
     }
     // Named after the countdown so a default filename timestamps the capture.
     const filepath = nextScreenshotPath(name);
+    // Chrome does not draw a tab that is not in front, and tabs open in the
+    // background, so the tab is brought to the front for the shot.
+    await state.page.bringToFront();
     const image = await state.page.screenshot({ fullPage: full });
     try {
       fs.writeFileSync(filepath, image, { flag: 'wx', mode: 0o600 });
@@ -1226,7 +1256,8 @@ const commands = {
     // The numbers skip what is hidden; say so, or they look like requests went missing.
     const first = matches[0].id;
     const last = matches[matches.length - 1].id;
-    const hidden = everything ? 0 : log.filter(e => e.id > first && e.id < last && !shown.includes(e)).length;
+    // With a filter, the numbers skip what does not match too, so the count would mislead.
+    const hidden = everything || filter ? 0 : log.filter(e => e.id > first && e.id < last && !shown.includes(e)).length;
     if (hidden) out.log(`(${hidden} hidden between these: images, fonts, stylesheets, media and extension requests; requests --all shows them)`);
   },
 
@@ -1247,7 +1278,8 @@ const commands = {
     const late = new Promise((_, reject) => { timer = setTimeout(() => reject(new Error(`did not arrive within ${BODY_TIMEOUT / 1000}s`)), BODY_TIMEOUT); });
     let buffer;
     try { buffer = await Promise.race([entry.response.body(), late]); }
-    catch (error) { throw new Error(`The body of #${id} is not available: ${error.message}`); }
+    // Playwright's reason ends in advice for its own API ("Read response.body() before..."), so only its first line is kept.
+    catch (error) { throw new Error(`The body of #${id} is not available: ${String(error.message).split('\n')[0]} (the browser drops bodies, e.g. after the tab navigates)`); }
     finally { clearTimeout(timer); }
     const type = entry.response.headers()['content-type'] || '';
     out.log(`#${id} ${entry.method} ${entry.status} ${entry.url} (${type || 'no content type'}, ${buffer.length} bytes)`);

package/lib/help.js

@@ -72,7 +72,7 @@ const COMMANDS = {
   tab: {
     usage: 'tab [<index>|<url-part>|new [url]|close [url-part]]',
     summary: 'list tabs (* is selected); select, open or close one',
-    detail: 'tab <index> uses the numbers from the latest tab listing; they change when tabs open or close.\n\ntab <url-part> selects the one tab whose URL contains it, and refuses if none or several do.\n\ntab new opens and selects a tab. tab close closes the selected tab, or the one matching url-part.\n\nClosing the selected tab goes back to the previous tab if tab new opened it; otherwise no tab is\nselected, and commands that need one refuse until one is.',
+    detail: 'tab <index> uses the numbers from the latest tab listing; they change when tabs open or close.\n\ntab <url-part> selects the one tab whose URL contains it, and refuses if none or several do.\n\ntab new opens a tab behind the one in front, so it does not take the window from whoever is using it,\nand selects it. tab close closes the selected tab, or the one matching url-part.\n\nClosing the selected tab goes back to the previous tab if tab new opened it; otherwise no tab is\nselected, and commands that need one refuse until one is.',
   },
   goto: { usage: 'goto <url>', summary: 'navigate the selected tab; https:// is assumed' },
   back: { usage: 'back', summary: 'go back one history entry' },
@@ -112,7 +112,7 @@ const COMMANDS = {
   screenshot: {
     usage: 'screenshot [--full] [--delay|-d <seconds>] [name]',
     summary: 'save a PNG of the viewport (or --full page)',
-    detail: 'Saved as screenshot-<name or timestamp>.png in $PW_SCREENSHOT_DIR (default /tmp).\n\n--delay counts down out loud first (maximum 60s), so someone can hold a hover or open a menu.',
+    detail: 'Saved as screenshot-<name or timestamp>.png in $PW_SCREENSHOT_DIR (default /tmp). It brings the tab to\nthe front of its window first: Chrome draws only the tab in front.\n\n--delay counts down out loud first (maximum 60s), so someone can hold a hover or open a menu.',
   },
   viewport: { usage: 'viewport [WxH]', summary: 'show or set the viewport size' },
   wait: {
@@ -139,7 +139,7 @@ const COMMANDS = {
   capture: {
     usage: 'capture on [requests|console] [secs] | off',
     summary: 'record requests and console together, in time order',
-    detail: 'capture on records both until capture off, which prints them; requests or console records only one.\nWith secs (1-3600 seconds) it records that long, then prints; the REPL waits meanwhile.\n\nOne capture runs at a time, on the tab selected when it started. Unlike requests and console it\nkeeps more than the last 200 and lists both together.\n\ncapture on its own says whether one is running, or shows the last one.',
+    detail: 'capture on records both until capture off, which prints them; requests or console records only one.\nWith secs (1-3600 seconds) it records that long, then prints. Other commands wait until a timed\ncapture ends, so it suits recording what someone does in the browser; around your own commands, use\ncapture on and capture off.\n\nOne capture runs at a time, on the tab selected when it started. Unlike requests and console it\nkeeps more than the last 200 and lists both together.\n\ncapture on its own says whether one is running, or shows the last one.',
   },
   route: {
     usage: 'route <glob> <status> <json> | off <glob>|--all',
@@ -166,7 +166,7 @@ const COMMANDS = {
   modes: {
     usage: 'modes [off]',
     summary: 'the modes on in every tab; modes off turns them all off',
-    detail: 'The modes are watch, network off, route and capture. Each is turned on and off with its own command:\nwatch on|off, network off|on, route <glob> ... | route off, capture on|off.\n\nmodes off turns off every one in every tab; a capture it stops is kept for capture to show.',
+    detail: 'The modes are watch, network off, route and capture. Each is turned on and off with its own command:\nwatch on|off, network off|on, route <glob> ... | route off <glob>|--all, capture on|off.\n\nmodes off turns off every one in every tab; a capture it stops is kept for capture to show.',
   },
   help: { usage: 'help [topic | command | --all]', summary: 'this help; --all prints every topic and command in full' },
   quit: {

package/lib/runner.js

@@ -72,6 +72,8 @@ async function executeCommand(text) {
   try {
     await commands[cmd](args, all);
   } catch (e) {
+    // Playwright colours its call log; the codes are noise anywhere but a terminal.
+    e.message = String(e.message || '').replace(/\x1b\[[0-9;]*m/g, '');
     out.error(`Error: ${e.message}`);
     const uncertain = !READ_ONLY.has(cmd) && isUncertain(e);
     if (uncertain) out.error('Outcome unknown: it timed out after it began acting on the page. Check the page before trying again.');

package/lib/send.js

@@ -122,10 +122,15 @@ async function where(options) {
     if (way.explicit) return 64;
   }
   const session = options.session || process.env.PW_TMUX_SESSION || 'playwright-repl';
-  if (!hasSession(session)) { console.error(`tmux: no session '${session}'`); return 64; }
+  if (!hasSession(session)) {
+    console.error(`tmux: no session '${session}'`);
+    console.error('A REPL on a socket of its own is found with -e <socket> or PW_SOCKET.');
+    return 64;
+  }
   const running = tmux('display-message', '-p', '-t', session, '#{pane_current_command}').trim();
   if (running === 'node') { console.log(`tmux: session '${session}' (the REPL was started with pw-repl run; no server)`); return 0; }
   console.error(`tmux: session '${session}' is running '${running}', not the REPL`);
+  console.error('A REPL on a socket of its own is found with -e <socket> or PW_SOCKET.');
   return 64;
 }
 

package/lib/syntax.js

@@ -0,0 +1,29 @@
+// How a command line's words are read, shared by the REPL and pw-repl send.
+
+// Commands whose first word is a selector, quoted if it has spaces, and whose
+// value is the rest of the line. Other commands take the rest of the line as it is.
+const SELECTOR_FIRST = new Set(['fill', 'type', 'select', 'press']);
+
+// A snapshot ref (e5, or f1e5 in newer Playwright) stands for aria-ref=e5.
+const REF = /^(?:f\d+)?e\d+$/;
+
+function toSelector(word) {
+  return REF.test(word) ? `aria-ref=${word}` : word;
+}
+
+// Quotes around the whole of a value are removed; \" inside double quotes is a quote.
+function unquote(text) {
+  const match = /^"((?:[^"\\]|\\.)*)"$|^'([^']*)'$/.exec(text);
+  if (!match) return text;
+  return match[1] !== undefined ? match[1].replace(/\\(.)/g, '$1') : match[2];
+}
+
+// The first word of args, or a quoted selector with spaces in it, and the rest of the line.
+function splitSelector(args) {
+  const match = /^(?:"((?:[^"\\]|\\.)*)"|'([^']*)'|(\S+))(?:\s+([\s\S]*))?$/.exec((args || '').trim());
+  if (!match) return null;
+  const word = match[1] !== undefined ? match[1].replace(/\\(.)/g, '$1') : match[2] !== undefined ? match[2] : match[3];
+  return { word, selector: toSelector(word), rest: match[4] };
+}
+
+module.exports = { SELECTOR_FIRST, toSelector, unquote, splitSelector };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pw-repl",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Text REPL for driving an existing Chromium through Playwright over CDP",
   "keywords": [
     "playwright",

package/skill/SKILL.md

@@ -11,6 +11,12 @@ shared session: a person can have their own tabs open in it and be using it whil
 `pw-repl` below is the command the `pw-repl` npm package installs. Without a global install,
 `npx pw-repl` works the same; from a clone, `<clone>/bin/pw-repl.js`.
 
+## Arguments
+
+Freeform args describe what to do in the browser: a page to look at, a flow to try, a failure to
+reproduce (e.g. `pw-repl find out why the cart total shows 0 after adding an item`). They are the task;
+the sections below are how to carry it out. With no args, get a REPL running and ask what to do.
+
 ## Start it
 
 `pw-repl where` says whether a REPL is running and how `send` reaches it. There are three ways to run
@@ -29,8 +35,18 @@ one; each takes an optional start URL, which opens in a new tab.
   tmux send-keys -t playwright-repl Enter
   ```
 
-`serve <port>` listens on TCP 127.0.0.1 instead of the socket, with no access control. A REPL in a
-terminal stops at its prompt (`quit`, or Ctrl-C); `send quit` is refused.
+`serve` and `serve --background` take a socket path of your own instead of the default
+(`pw-repl serve --background /tmp/mine.sock`); `send`, `attach`, `stop` and `where` then need
+`-e /tmp/mine.sock`, or `PW_SOCKET=/tmp/mine.sock`. The log of a background REPL is next to its socket
+(`/tmp/mine.log`); `tail -f` on it follows along without a terminal to attach from. `serve <port>`
+listens on TCP 127.0.0.1 instead of a socket, with no access control.
+
+Several REPLs can run at once, each on its own socket, e.g. one per agent. Each has its own selected tab,
+command queue and modes, so they do not wait on or select for each other. They share the browser,
+though: each sees every tab, `modes` lists only its own REPL's modes, and two REPLs acting on the same
+tab can undo each other's routes or network setting.
+
+A REPL in a terminal stops at its prompt (`quit`, or Ctrl-C); `send quit` is refused.
 
 ## Send commands
 
@@ -40,8 +56,9 @@ pw-repl send -t 90 'screenshot -d 60'   # wait longer than the 20s default
 ```
 
 Always send commands with `pw-repl send`; don't type into the pane yourself. The words after `send`
-are the command, and a word quoted in your shell stays one word:
-`pw-repl send fill "text=Your name" Ada`. It works however the REPL was started:
+are the command. For `fill`, `type`, `select` and `press`, a word quoted in your shell stays one word
+(`pw-repl send fill "text=Your name" Ada`); other commands get the words as they are
+(`pw-repl send eval "document.title + ' x'"`). It works however the REPL was started:
 
 - `run` (in tmux): `send` types the command into the tmux pane and reads the result back off the screen.
   It types only when the pane's last line is a bare prompt, so nothing lands in a shell or in the middle