@clinic/heap-profiler/test/basic.test.js

Programmable interface to Clinic.js Heap Profiler

'use strict'

const { spawn } = require('child_process')
const fs = require('fs')
const path = require('path')
const { test } = require('tap')
const ClinicHeapProfiler = require('../src/index.js')

test('cmd - test collect - data exists, html generated', t => {
  const tool = new ClinicHeapProfiler()

  function cleanup (err, filename) {
    let count = 0

    function callback (err) {
      t.error(err)

      if (++count === 2) {
        t.end()
      }
    }

    t.error(err)

    t.match(filename, /[0-9]+\.clinic-heapprofiler$/)

    fs.unlink(filename, callback)
    fs.unlink(filename + '.html', callback)
  }

  tool.collect([process.execPath, path.join('test', 'fixtures', 'randomHashes.js')], (err, filename) => {
    if (err) {
      cleanup(err, filename)
      return
    }

    let fileSizeDebug = 0
    const htmlName = filename + '.html'
    tool.debug = true

    // Test that calling stopViaIPC is safe when no IPC is present
    tool.stopViaIPC()

    tool.visualize(filename, htmlName, err => {
      if (err) {
        cleanup(err, filename)
        return
      }

      fileSizeDebug = fs.statSync(htmlName).size

      fs.readFile(htmlName, (err, content) => {
        if (err) {
          cleanup(err, filename)
          return
        }

        t.ok(content.length > 5000)

        /*
          Redo the html without debug setting
          Check that disabling debug mode results in a smaller file
        */
        fs.unlinkSync(htmlName)
        tool.debug = false

        tool.visualize(filename, htmlName, () => {
          //
          t.ok(fs.statSync(htmlName).size < fileSizeDebug)
          cleanup(null, filename)
        })
      })
    })
  })
})

test('child_process - test spawn - filepath with spaces should be preloaded', t => {
  const env = process.env

  // double quotes are required for paths with spaces
  env.NODE_OPTIONS = `-r "${path.join(__dirname, 'fixtures', 'file with space.js')}"`
  if (process.platform === 'win32') {
    env.NODE_OPTIONS = env.NODE_OPTIONS.replace(/\\/g, '\\\\')
  }

  this.process = spawn(
    process.execPath,
    [path.join('test', 'fixtures', 'randomHashes.js')],
    { stdio: ['ignore', 'inherit', 'inherit'], env }
  )

  this.process.once('exit', (code) => {
    t.equal(code, 0)
    t.end()
  })
})

test('cmd - test visualization - missing data', t => {
  const tool = new ClinicHeapProfiler({ debug: true })

  tool.visualize('missing.clinic-flame', 'missing.clinic-flame.html', err => {
    t.match(err.message, /ENOENT: no such file or directory/)
    t.end()
  })
})