browsertime/lib/video/screenRecording/desktop/desktopRecorder.js

Get performance metrics from your web page using Browsertime.

import { promisify } from 'node:util';
import { unlink as _unlink, rename as _rename } from 'node:fs';
import intel from 'intel';
import get from 'lodash.get';
import { start as _start, stop as _stop } from './ffmpegRecorder.js';
import { convert } from './convert.js';
import {
  xvfbDisplay,
  framerate as _framerate,
  crf as _crf,
  convert as _convert,
  threads as _threads
} from '../../defaults.js';
import { getViewPort } from '../../../support/getViewPort.js';
const unlink = promisify(_unlink);
const rename = promisify(_rename);
const log = intel.getLogger('browsertime.video');

export class DesktopRecorder {
  constructor(options) {
    this.display = get(options, 'xvfbParams.display', xvfbDisplay);
    this.framerate = get(options, 'videoParams.framerate', _framerate);
    this.nice = get(options, 'videoParams.nice', 0);
    this.crf = get(options, 'videoParams.crf', _crf);
    this.convert = get(options, 'videoParams.convert', _convert);
    this.threads = get(options, 'videoParams.threads', _threads);
    this.viewPort = getViewPort(options);
    this.taskset = get(options, 'videoParams.taskset');
    this.origin = '0,0';
    this.offset = { x: 0, y: 0 };
    this.options = options;
  }

  async start(file) {
    this.filePath = file;

    this.recording = _start({
      display: this.display,
      size: this.viewPort,
      filePath: this.filePath,
      origin: this.origin,
      offset: this.offset,
      framerate: this.framerate,
      crf: this.crf,
      nice: this.nice,
      threads: this.threads,
      taskset: this.taskset
    });

    return this.recording;
  }

  async stop(destination) {
    log.debug('Stop screen recording');
    await _stop(this.recording);

    // This was a test with and error and probably not a navigation
    // The user script use stopAsError
    if (!destination) {
      return;
    }
    // FIXME update to rename/move file
    // The destination file could exixt of we use --resultDir
    // so make sure we remove it first
    if (this.options.resultDir) {
      try {
        await unlink(destination);
      } catch {
        // Nothing to see here
      }
    }
    try {
      if (this.convert) {
        await convert(this.filePath, destination, this.crf, this.threads);
        await unlink(this.filePath);
      } else {
        await rename(this.filePath, destination);
      }
    } catch (error) {
      log.error(
        'Converting the video failed. Converting from ' +
          this.filePath +
          ' to ' +
          destination
      );
      throw error;
    }
    log.debug(`Writing to ${destination}`);
  }
}