@browserless/capture 10.11.0 → 10.11.2

package/README.md

@@ -9,7 +9,7 @@
   <br><br>
 </div>
 
-> @browserless/capture: Record a Puppeteer page using the extension + `tabCapture` approach.
+> @browserless/capture: Record a Puppeteer page using tabCapture API.
 
 ## Install
 
@@ -23,19 +23,34 @@ npm install @browserless/capture --save
 const createBrowser = require('browserless')
 const createCapture = require('@browserless/capture')
 
-const browser = createBrowser({
-  headless: 'new',
-  ignoreDefaultArgs: ['--disable-extensions'],
-  args: [
-    '--screen-info={2560x1600 devicePixelRatio=2}',
-    `--allowlisted-extension-id=${createCapture.extensionId}`,
-    `--disable-extensions-except=${createCapture.extensionPath}`,
-    `--load-extension=${createCapture.extensionPath}`
-  ]
-})
+const withCaptureExtension = (launchOpts = {}) => {
+  const ignoreDefaultArgs = launchOpts.ignoreDefaultArgs
+
+  return {
+    ...launchOpts,
+    args: [
+      ...(launchOpts.args || []),
+      `--allowlisted-extension-id=${createCapture.extensionId}`,
+      `--disable-extensions-except=${createCapture.extensionPath}`,
+      `--load-extension=${createCapture.extensionPath}`
+    ],
+    ignoreDefaultArgs:
+      ignoreDefaultArgs === true
+        ? true
+        : [
+            ...new Set([
+              ...(Array.isArray(ignoreDefaultArgs) ? ignoreDefaultArgs : []),
+              '--disable-extensions'
+            ])
+          ]
+  }
+}
+
+const browser = createBrowser(withCaptureExtension({ headless: 'new' }))
 
 const browserless = await browser.createContext()
-const page = await browserless.page()
+const puppeteerBrowser = await browserless.browser()
+const page = await puppeteerBrowser.defaultBrowserContext().newPage()
 const capture = createCapture({ goto: browserless.goto })
 
 const video = await capture(page)('https://example.com', {
@@ -43,8 +58,19 @@ const video = await capture(page)('https://example.com', {
   type: 'mp4',
   path: '/tmp/demo.mp4'
 })
+
+await page.close()
+await browserless.destroyContext()
+await browser.close()
 ```
 
+`browserless` core does not inject capture extension flags automatically.
+`@browserless/capture` requires:
+
+- Loading the bundled extension using `--allowlisted-extension-id`, `--disable-extensions-except`, and `--load-extension`.
+- Ensuring Chromium default arg `--disable-extensions` is ignored.
+- Creating the captured page from `defaultBrowserContext()` (not an incognito context).
+
 API shape is intentionally simple, similar to `page.screenshot()`/`page.pdf()`:
 
 ```js

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@browserless/capture",
-  "description": "Record browser pages as videos with browserless-style API: createCapture({ goto })(page)(url, opts).",
+  "description": "Record a Puppeteer page using tabCapture API",
   "homepage": "https://browserless.js.org/#/?id=capturepage-options",
-  "version": "10.11.0",
+  "version": "10.11.2",
   "main": "src/index.js",
   "author": {
     "email": "hello@microlink.io",
@@ -18,21 +18,21 @@
     "url": "https://github.com/microlinkhq/browserless/issues"
   },
   "keywords": [
+    "automation",
     "browserless",
     "capture",
-    "video",
-    "recording",
-    "webm",
-    "mp4",
-    "headless",
     "chrome",
+    "headless",
+    "mp4",
     "puppeteer",
-    "automation"
+    "recording",
+    "video",
+    "webm"
   ],
   "dependencies": {
-    "@browserless/goto": "^10.11.0",
+    "@browserless/goto": "^10.11.1",
     "debug-logfmt": "~1.4.8",
-    "ws": "~8.18.3"
+    "ws": "~8.19.0"
   },
   "devDependencies": {
     "ava": "5"
@@ -44,15 +44,16 @@
     "extension",
     "src"
   ],
+  "scripts": {
+    "bench:runtime": "node benchmarks/runtime-startup.js",
+    "coverage": "exit 0",
+    "test": "ava"
+  },
   "license": "MIT",
   "ava": {
     "serial": true,
     "timeout": "2m",
     "workerThreads": false
   },
-  "scripts": {
-    "bench:runtime": "node benchmarks/runtime-startup.js",
-    "coverage": "exit 0",
-    "test": "ava"
-  }
-}
+  "gitHead": "efe1f5047f7fbb4f4fef20ed0c11dcb978070fc9"
+}

package/src/index.js

@@ -10,7 +10,7 @@ module.exports = ({ goto, ...gotoOpts } = {}) => {
   goto = goto || createGoto(gotoOpts)
   return function capture (page) {
     return async (url, opts = {}) => {
-      const duration = debug.duration({ url }, opts)
+      const duration = debug.duration({ url })
       const { device } = await goto(page, { ...opts, url })
       const result = await runCapture(page, opts, device.viewport)
       duration.info()