All files / lib/internal/perf usertiming.js

93.46% Statements 143/153
77.5% Branches 31/40
100% Functions 7/7
93.46% Lines 143/153

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 31x 31x 31x 4x 4x 4x 4x 16x 16x 31x 12x 12x 31x 12x 31x 103x 103x 103x 24x 24x 24x 23x 23x 23x 23x 23x 23x 23x 24x 22x 22x 22x 24x 103x 103x 103x 103x 13x 13x 13x 103x 103x 24x 24x 24x 103x 13x 13x 13x 13x 13x 13x 13x 13x 5x 5x 5x 5x 5x 5x 5x       5x       5x         5x 5x 13x 8x 8x 13x 13x 7x 13x 13x 13x 13x 13x 13x 13x 13x 103x 13x 13x 13x 13x 13x 13x 13x 13x 13x 103x 7x 7x 3x 3x 3x 2x 2x 2x 4x 7x 103x 103x 103x 103x 103x 103x 103x  
'use strict';
 
const {
  ObjectKeys,
  SafeMap,
} = primordials;
 
const {
  InternalPerformanceEntry,
  kReadOnlyAttributes,
  now,
} = require('internal/perf/perf');
 
const { enqueue } = require('internal/perf/observe');
 
const nodeTiming = require('internal/perf/nodetiming');
 
const {
  validateNumber,
  validateObject,
  validateString,
} = require('internal/validators');
 
const {
  codes: {
    ERR_INVALID_ARG_VALUE,
    ERR_INVALID_PERFORMANCE_MARK,
    ERR_PERFORMANCE_INVALID_TIMESTAMP,
    ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS,
  },
} = require('internal/errors');
 
const marks = new SafeMap();
const nodeTimingReadOnlyAttributes =
  nodeTiming.constructor[kReadOnlyAttributes];
 
function getMark(name) {
  if (name === undefined) return;
  if (typeof name === 'number') {
    if (name < 0)
      throw new ERR_PERFORMANCE_INVALID_TIMESTAMP(name);
    return name;
  }
  name = `${name}`;
  if (nodeTimingReadOnlyAttributes.has(name))
    return nodeTiming[name];
  const ts = marks.get(name);
  if (ts === undefined)
    throw new ERR_INVALID_PERFORMANCE_MARK(name);
  return ts;
}
 
class PerformanceMark extends InternalPerformanceEntry {
  constructor(name, options = {}) {
    name = `${name}`;
    if (nodeTimingReadOnlyAttributes.has(name))
      throw new ERR_INVALID_ARG_VALUE('name', name);
    validateObject(options, 'options');
    const {
      detail,
      startTime = now(),
    } = options;
    validateNumber(startTime, 'startTime');
    if (startTime < 0)
      throw new ERR_PERFORMANCE_INVALID_TIMESTAMP(startTime);
    marks.set(name, startTime);
    super(name, 'mark', startTime, 0, detail);
    enqueue(this);
  }
}
 
class PerformanceMeasure extends InternalPerformanceEntry {
  constructor(name, start, duration, detail) {
    super(name, 'measure', start, duration, detail);
    enqueue(this);
  }
}
 
function mark(name, options = {}) {
  return new PerformanceMark(name, options);
}
 
function calculateStartDuration(startOrMeasureOptions, endMark) {
  startOrMeasureOptions ??= 0;
  let detail;
  let start;
  let end;
  let duration;
  if (typeof startOrMeasureOptions === 'object' &&
      ObjectKeys(startOrMeasureOptions).length) {
    ({
      start,
      end,
      duration,
      detail,
    } = startOrMeasureOptions);
    if (endMark !== undefined) {
      throw new ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS(
        'endMark must not be specified');
    }
    if (start === undefined && end === undefined) {
      throw new ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS(
        'One of options.start or options.end is required');
    }
    if (start !== undefined && end !== undefined && duration !== undefined) {
      throw new ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS(
        'Must not have options.start, options.end, and ' +
        'options.duration specified');
    }
    start = getMark(start);
    duration = getMark(duration);
  } else {
    start = getMark(startOrMeasureOptions);
  }
 
  end = getMark(endMark || end) ??
    ((start !== undefined && duration !== undefined) ?
      start + duration : now());
 
  start ??= (duration !== undefined) ? end - duration : 0;
 
  duration ??= end - start;
 
  return { start, duration, detail };
}
 
function measure(name, startOrMeasureOptions, endMark) {
  validateString(name, 'name');
  const {
    start,
    duration,
    detail
  } = calculateStartDuration(startOrMeasureOptions, endMark);
  return new PerformanceMeasure(name, start, duration, detail);
}
 
function clearMarks(name) {
  if (name !== undefined) {
    name = `${name}`;
    if (nodeTimingReadOnlyAttributes.has(name))
      throw new ERR_INVALID_ARG_VALUE('name', name);
    marks.delete(name);
    return;
  }
  marks.clear();
}
 
module.exports = {
  PerformanceMark,
  clearMarks,
  mark,
  measure,
};