calibre/src/cli/test/download-artifacts.js

Calibre - Page speed performance testing with Google Lighthouse

import fs from 'node:fs'
import path from 'node:path'

import listr from 'listr'

import download from '../../utils/download.js'
import { fetchArtifacts } from '../../api/test.js'
import { humaniseError } from '../../utils/api-error.js'
import { options } from '../../utils/cli.js'

const main = async args => {
  try {
    const response = await fetchArtifacts(args.uuid)

    if (args.json) return console.log(JSON.stringify(response, null, 2))

    const directories = [process.cwd(), 'test-artifacts', args.uuid].join(
      path.sep
    )

    // eslint-disable-next-line security/detect-non-literal-fs-filename
    const directory = fs.mkdirSync(directories, { recursive: true })

    const tasks = new listr(
      [
        {
          title: 'Fetching test artifact URLs',
          task: () => Promise.resolve()
        },
        {
          title: 'Screenshot',
          task: () =>
            download(response.image, path.join(directory, 'image.jpg'))
        },
        {
          title: 'MP4 Video Render',
          task: () =>
            download(response.video, path.join(directory, 'render.mp4'))
        },
        {
          title: 'HAR',
          task: () =>
            download(response.har, path.join(directory, 'requests.har'))
        },
        {
          title: 'Lighthouse Report',
          task: () =>
            download(
              response.lighthouse,
              path.join(directory, 'lighthouse.json')
            )
        }
      ],
      {
        concurrent: true
      }
    )

    await tasks.run()

    console.log(`Saved artifacts to ${path.relative(process.cwd(), directory)}`)
  } catch (e) {
    throw new Error(humaniseError(e))
  }
}

const command = 'download-artifacts <uuid>'
const describe =
  'Download the artifacts of a test to ./test-artifacts/<uuid>. Includes: lighthouse.json, render progress screenshots, render progress MP4 video, HAR file (request log) and all other metrics and data available through the Calibre interface.'
const handler = main
const builder = {
  json: options.json
}

export { command, describe, builder, handler }