@browserless/capture 10.11.1 → 10.11.3

package/README.md

@@ -23,18 +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: [
-    `--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', {
@@ -42,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

@@ -2,7 +2,7 @@
   "name": "@browserless/capture",
   "description": "Record a Puppeteer page using tabCapture API",
   "homepage": "https://browserless.js.org/#/?id=capturepage-options",
-  "version": "10.11.1",
+  "version": "10.11.3",
   "main": "src/index.js",
   "author": {
     "email": "hello@microlink.io",
@@ -30,7 +30,7 @@
     "webm"
   ],
   "dependencies": {
-    "@browserless/goto": "^10.11.1",
+    "@browserless/goto": "^10.11.3",
     "debug-logfmt": "~1.4.8",
     "ws": "~8.19.0"
   },
@@ -38,7 +38,7 @@
     "ava": "5"
   },
   "engines": {
-    "node": ">= 12"
+    "node": ">= 24"
   },
   "files": [
     "extension",
@@ -55,5 +55,5 @@
     "timeout": "2m",
     "workerThreads": false
   },
-  "gitHead": "2a4bbeeadfb7f010d57a8806f706de2bc48f936e"
+  "gitHead": "2f86ba8d35c9b92c3c19e310282a3d24d0e0c7e0"
 }

package/src/capture.js

@@ -7,7 +7,7 @@ const debug = require('debug-logfmt')('browserless:capture')
 const { closeServer, createWebSocketServer } = require('./util')
 const extension = require('./extension')
 
-const { INTERNAL_FRAME_SIZE, NOOP } = require('./constants')
+const { DEFAULT, INTERNAL_FRAME_SIZE, NOOP } = require('./constants')
 
 let currentIndex = 0
 
@@ -78,7 +78,7 @@ const SUPPORTED_TYPES = Object.freeze(Object.keys(MIME_TYPES_BY_TYPE))
 const getMimeType = ({ type, audio, video }) => {
   const normalizedType =
     type === undefined || type === null
-      ? 'webm'
+      ? DEFAULT.type
       : String(type).trim().toLowerCase().replace(/^\./, '')
 
   const mimeTypes = MIME_TYPES_BY_TYPE[normalizedType]
@@ -160,7 +160,7 @@ const getTargetId = async page => {
 }
 
 module.exports = async (page, opts, viewport) => {
-  const { path: outputPath, duration = 3000, audio, video, type } = opts
+  const { path: outputPath, duration = DEFAULT.duration, audio, video, type } = opts
 
   const audioOpts = getOpts(audio, false, 'audio')
   const videoOpts = getOpts(video, true, 'video')

package/src/constants.js

@@ -2,18 +2,11 @@
 
 const path = require('path')
 
-const EXTENSION_ID = 'jjndjgheafjngoipoacpjgeicjeomjli'
-
-const EXTENSION_PATH = path.join(__dirname, '..', 'extension')
-
-const TYPES = Object.freeze(['webm', 'mp4'])
-const INTERNAL_FRAME_SIZE = 250
-const NOOP = () => {}
-
 module.exports = {
-  EXTENSION_ID,
-  EXTENSION_PATH,
-  TYPES,
-  INTERNAL_FRAME_SIZE,
-  NOOP
+  DEFAULT: Object.freeze({ duration: 3000, type: 'webm' }),
+  EXTENSION_ID: 'jjndjgheafjngoipoacpjgeicjeomjli',
+  EXTENSION_PATH: path.join(__dirname, '..', 'extension'),
+  TYPES: Object.freeze(['webm', 'mp4']),
+  INTERNAL_FRAME_SIZE: 250,
+  NOOP: () => {}
 }

package/src/index.js

@@ -3,15 +3,15 @@
 const debug = require('debug-logfmt')('browserless:capture')
 const createGoto = require('@browserless/goto')
 
-const { EXTENSION_ID, EXTENSION_PATH, TYPES } = require('./constants')
+const { DEFAULT, EXTENSION_ID, EXTENSION_PATH, TYPES } = require('./constants')
 const runCapture = require('./capture')
 
 module.exports = ({ goto, ...gotoOpts } = {}) => {
   goto = goto || createGoto(gotoOpts)
   return function capture (page) {
     return async (url, opts = {}) => {
-      const duration = debug.duration({ url }, opts)
-      const { device } = await goto(page, { ...opts, url })
+      const duration = debug.duration({ url })
+      const { device } = await goto(page, { ...opts, url, animations: true })
       const result = await runCapture(page, opts, device.viewport)
       duration.info()
       return result
@@ -22,3 +22,4 @@ module.exports = ({ goto, ...gotoOpts } = {}) => {
 module.exports.extensionPath = EXTENSION_PATH
 module.exports.extensionId = EXTENSION_ID
 module.exports.types = TYPES
+module.exports.DEFAULT = DEFAULT