@browserless/capture 10.11.4 → 10.11.6

package/README.md

@@ -57,7 +57,6 @@ const video = await capture(page)('https://example.com', {
   duration: 5000,
   type: 'mp4',
   codec: 'avc1.4D401F',
-  quality: 'high',
   path: '/tmp/demo.mp4'
 })
 
@@ -88,7 +87,6 @@ Returns a `Buffer` and writes to `opts.path` when provided.
 | --- | --- | --- | --- |
 | `type` | `'webm' \| 'mp4'` | `'mp4'` | Output type selector mapped to MediaRecorder mime type. |
 | `codec` | `string` | Depends on `type` | MediaRecorder codec override. Defaults: `webm -> vp9`, `mp4 -> avc1.4D401F`. |
-| `quality` | `'extra-high' \| 'high' \| 'medium' \| 'low' \| 'extra-low'` | `'high'` | Video quality hint mapped to `MediaRecorder.videoBitsPerSecond`. |
 | `path` | `string` | `undefined` | Write the captured media to disk. |
 | `duration` | `number` | `3000` | Capture duration in milliseconds. |
 | `audio` | `boolean \| object` | `false` | Capture audio. When object, it is used as audio track constraints. |
@@ -99,16 +97,11 @@ Returns a `Buffer` and writes to `opts.path` when provided.
 - `capture.extensionPath`: Absolute path to the bundled extension.
 - `capture.extensionId`: Extension ID used by the package.
 - `capture.types`: Supported values for `type`.
-- `capture.qualities`: Supported values for `quality`.
-
 `capture` uses `goto(...).device.viewport` as the capture viewport source.
 When `video` is `true` or omitted, video constraints are inferred from that viewport to keep capture framing aligned with screenshot/pdf rendering.
 When `video` is an object, that object is used as the video constraints.
 When `audio` is an object, that object is used as the audio constraints.
 The inferred constraints also account for `deviceScaleFactor`, so output video pixels match screenshot pixel density.
-Capture always enforces `videoConstraints.mandatory.maxFrameRate = 120`.
-`quality` maps to bitrate presets (`extra-high`: 20Mbps, `high`: 8Mbps, `medium`: 5Mbps, `low`: 2.5Mbps, `extra-low`: 1Mbps).
-MediaRecorder chunk size is internal and fixed at `250ms`.
 `type` is mapped internally to the MediaRecorder mime type, and `codec` is appended as `;codecs=...`.
 Default codecs are `vp9` for `webm` and `avc1.4D401F` for `mp4`.
 You can override codec per request using `opts.codec`.

package/extension/offscreen.js

@@ -76,11 +76,10 @@ const START_RECORDING = async ({
   streamId,
   video,
   audio,
-  frameSize,
   mimeType,
-  recorderOptions,
   videoConstraints,
-  audioConstraints
+  audioConstraints,
+  duration = 0
 }) => {
   if (!port) throw new Error('Missing websocket port for recording session.')
   if (!streamId) throw new Error('Missing tab media stream id for recording session.')
@@ -125,7 +124,7 @@ const START_RECORDING = async ({
     throw error
   }
 
-  const recorder = new MediaRecorder(stream, { mimeType, ...recorderOptions })
+  const recorder = new MediaRecorder(stream, { mimeType })
 
   const pending = new Set()
 
@@ -157,12 +156,19 @@ const START_RECORDING = async ({
   }
 
   recorders[index] = recorder
-  recorder.start(frameSize)
+  recorder.start()
+
+  if (duration > 0) {
+    recorder.__autoStopTimer = setTimeout(() => {
+      if (recorder.state !== 'inactive') recorder.stop()
+    }, duration)
+  }
 }
 
 const STOP_RECORDING = index => {
   const recorder = recorders[index]
   if (!recorder || recorder.state === 'inactive') return
+  clearTimeout(recorder.__autoStopTimer)
   recorder.stop()
 }
 

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.4",
+  "version": "10.11.6",
   "main": "src/index.js",
   "author": {
     "email": "hello@microlink.io",
@@ -54,5 +54,5 @@
     "timeout": "2m",
     "workerThreads": false
   },
-  "gitHead": "9ff2a0f0dad20d64a5c47a04a989ee77d1ee5ae8"
+  "gitHead": "5f07174e086cac8bd67e22ad0f5ff89326dc39a8"
 }

package/src/capture.js

@@ -7,15 +7,7 @@ const debug = require('debug-logfmt')('browserless:capture')
 const { closeServer, createWebSocketServer } = require('./util')
 const extension = require('./extension')
 
-const {
-  DEFAULT,
-  DEFAULT_CODEC_BY_TYPE,
-  INTERNAL_FRAME_SIZE,
-  MAX_FRAME_RATE,
-  NOOP,
-  QUALITIES,
-  VIDEO_BITS_PER_SECOND_BY_QUALITY
-} = require('./constants')
+const { DEFAULT, DEFAULT_CODEC_BY_TYPE, NOOP } = require('./constants')
 
 let currentIndex = 0
 
@@ -77,24 +69,6 @@ const MIME_TYPES_BY_TYPE = Object.freeze({
 
 const SUPPORTED_TYPES = Object.freeze(Object.keys(MIME_TYPES_BY_TYPE))
 
-const getQuality = quality => {
-  const normalizedQuality =
-    quality === undefined || quality === null
-      ? DEFAULT.quality
-      : String(quality)
-        .trim()
-        .toLowerCase()
-        .replace(/[\s_]+/g, '-')
-
-  if (!QUALITIES.includes(normalizedQuality)) {
-    throw new TypeError(
-      `Unsupported \`quality\` "${quality}". Supported qualities: ${QUALITIES.join(', ')}.`
-    )
-  }
-
-  return normalizedQuality
-}
-
 const getCodec = ({ codec, type, video }) => {
   if (codec === undefined || codec === null) {
     return video ? DEFAULT_CODEC_BY_TYPE[type] : undefined
@@ -133,35 +107,20 @@ const getMimeType = ({ type, audio, video, codec }) => {
 }
 
 const getVideoConstraints = (videoConstraints, viewport) => {
-  const withMaxFrameRate = constraints => {
-    const source = constraints && typeof constraints === 'object' ? constraints : {}
-    const mandatory =
-      source.mandatory && typeof source.mandatory === 'object' ? source.mandatory : {}
-    const { mandatory: _mandatory, ...rest } = source
-
-    return {
-      ...rest,
-      mandatory: {
-        ...mandatory,
-        maxFrameRate: MAX_FRAME_RATE
-      }
-    }
-  }
-
-  if (videoConstraints) return withMaxFrameRate(videoConstraints)
+  if (videoConstraints) return videoConstraints
 
   const dpr = Math.max(Number(viewport.deviceScaleFactor) || 1, 1)
   const width = Math.round(viewport.width * dpr)
   const height = Math.round(viewport.height * dpr)
 
-  return withMaxFrameRate({
+  return {
     mandatory: {
       minWidth: width,
       minHeight: height,
       maxWidth: width,
       maxHeight: height
     }
-  })
+  }
 }
 
 const isTrackObject = value => value && typeof value === 'object' && !Array.isArray(value)
@@ -215,7 +174,7 @@ const getTargetId = async page => {
 }
 
 module.exports = async (page, opts, viewport) => {
-  const { path: outputPath, duration = DEFAULT.duration, audio, video, type, quality, codec } = opts
+  const { path: outputPath, duration = DEFAULT.duration, audio, video, type, codec } = opts
 
   const audioOpts = getOpts(audio, false, 'audio')
   const videoOpts = getOpts(video, true, 'video')
@@ -234,11 +193,6 @@ module.exports = async (page, opts, viewport) => {
     video: videoOpts.enabled
   })
 
-  const resolvedQuality = getQuality(quality)
-  const recorderOptions = videoOpts.enabled
-    ? { videoBitsPerSecond: VIDEO_BITS_PER_SECOND_BY_QUALITY[resolvedQuality] }
-    : undefined
-
   const resolvedVideoConstraints = getVideoConstraints(videoOpts.constraints, viewport)
 
   let worker
@@ -292,11 +246,10 @@ module.exports = async (page, opts, viewport) => {
             index,
             port,
             tabId,
+            duration,
             video: videoOpts.enabled,
             audio: audioOpts.enabled,
-            frameSize: INTERNAL_FRAME_SIZE,
             mimeType: streamMimeType,
-            recorderOptions,
             videoConstraints: resolvedVideoConstraints,
             audioConstraints: audioOpts.constraints
           }
@@ -304,7 +257,6 @@ module.exports = async (page, opts, viewport) => {
       { index, tabId }
     )
     isRecordingStarted = true
-    await runWithDuration('durationwait', () => setTimeout(duration), { duration })
   } catch (error) {
     if (!worker && workerPromise) {
       worker = await runWithDuration('awaitWorkerAfterError', () => workerPromise.catch(NOOP))
@@ -317,33 +269,33 @@ module.exports = async (page, opts, viewport) => {
     }
     captureError = error
   } finally {
-    const stopPromise = worker
-      ? runWithDuration(
-        'extension.stopRecording',
-        () => extension.stopRecording({ extension: worker, index }).catch(NOOP),
-        { index }
-      )
-      : Promise.resolve()
-
-    if (recordingPromise) {
-      if (isRecordingStarted) {
+    try {
+      if (recordingPromise && isRecordingStarted) {
         const recordingResultPromise = recordingPromise.catch(error => {
           if (!captureError) throw error
           return Buffer.alloc(0)
         })
-        const [, recordingResult] = await runWithDuration('stop+recordingPromise', () =>
-          Promise.all([stopPromise, recordingResultPromise])
-        )
-        buffer = recordingResult
-      } else {
+        const safetyTimeoutMs = Math.ceil(duration * 1.5)
+        const recordingWithTimeout = Promise.race([
+          recordingResultPromise,
+          setTimeout(safetyTimeoutMs).then(() => {
+            throw new Error('Recording timed out')
+          })
+        ])
+        buffer = await runWithDuration('recordingPromise', () => recordingWithTimeout)
+      } else if (recordingPromise) {
         recordingPromise.catch(NOOP)
-        await runWithDuration('stopWithoutRecording', () => stopPromise)
       }
-    } else {
-      await runWithDuration('stopWithoutPromise', () => stopPromise)
+    } finally {
+      if (worker) {
+        await runWithDuration(
+          'extension.stopRecording',
+          () => extension.stopRecording({ extension: worker, index }).catch(NOOP),
+          { index }
+        )
+      }
+      await runWithDuration('closeServer', () => closeServer(wss))
     }
-
-    await runWithDuration('closeServer', () => closeServer(wss))
   }
 
   if (captureError) throw captureError

package/src/constants.js

@@ -3,23 +3,13 @@
 const path = require('path')
 
 module.exports = {
-  MAX_FRAME_RATE: 120,
-  DEFAULT: Object.freeze({ duration: 3000, type: 'mp4', quality: 'high' }),
+  DEFAULT: Object.freeze({ duration: 3000, type: 'mp4' }),
   DEFAULT_CODEC_BY_TYPE: Object.freeze({
     webm: 'vp9',
-    mp4: 'avc1.4D401F'
+    mp4: 'avc1.640028'
   }),
   EXTENSION_ID: 'jjndjgheafjngoipoacpjgeicjeomjli',
   EXTENSION_PATH: path.join(__dirname, '..', 'extension'),
   TYPES: Object.freeze(['webm', 'mp4']),
-  QUALITIES: Object.freeze(['extra-high', 'high', 'medium', 'low', 'extra-low']),
-  VIDEO_BITS_PER_SECOND_BY_QUALITY: Object.freeze({
-    'extra-high': 20_000_000,
-    high: 8_000_000,
-    medium: 5_000_000,
-    low: 2_500_000,
-    'extra-low': 1_000_000
-  }),
-  INTERNAL_FRAME_SIZE: 250,
   NOOP: () => {}
 }

package/src/index.js

@@ -3,7 +3,13 @@
 const debug = require('debug-logfmt')('browserless:capture')
 const createGoto = require('@browserless/goto')
 
-const { DEFAULT, EXTENSION_ID, EXTENSION_PATH, QUALITIES, TYPES } = require('./constants')
+const {
+  DEFAULT,
+  DEFAULT_CODEC_BY_TYPE,
+  EXTENSION_ID,
+  EXTENSION_PATH,
+  TYPES
+} = require('./constants')
 const runCapture = require('./capture')
 
 module.exports = ({ goto, ...gotoOpts } = {}) => {
@@ -21,6 +27,6 @@ module.exports = ({ goto, ...gotoOpts } = {}) => {
 
 module.exports.extensionPath = EXTENSION_PATH
 module.exports.extensionId = EXTENSION_ID
-module.exports.types = TYPES
-module.exports.qualities = QUALITIES
+module.exports.TYPES = TYPES
 module.exports.DEFAULT = DEFAULT
+module.exports.DEFAULT_CODEC_BY_TYPE = DEFAULT_CODEC_BY_TYPE