mirror of
https://github.com/nodejs/node.git
synced 2025-05-06 21:35:34 +00:00

All API introduced in this PR are compliant with web [performance-timeline](https://w3c.github.io/performance-timeline) spec. "performance-timeline" is listed as supported web spec in the doc https://nodejs.org/docs/latest/api/perf_hooks.html#perf_hooks_performance_measurement_apis. Changes summary: 1. Add new supported wpt test subsets: user-timing and performance-timeline. 2. Add support for `Performance.getEntries`, `Performance.getEntriesByName` and `Performance.getEntriesByType` to synchronously fetch buffered performance entries. This means the user should invoke `Performance.clearMarks` and `Performance.clearMeasures` to clear buffered entries to prevent from those entries been kept alive forever. 3. Add support (again after https://github.com/nodejs/node/pull/37136) for `buffered` flags for `PerformanceObserver`. 3. Fixes `PerformanceMark` and `PerformanceMeasure` wpt compliance issues. 4. Only user-created performance entries will be buffered globally. This behavior should be compliant with https://w3c.github.io/timing-entrytypes-registry/#registry. With the new ability to fetch user-created performance entries synchronously, the issues raised in https://github.com/nodejs/diagnostics/issues/464#issuecomment-861920116 could also be fixed. PR-URL: https://github.com/nodejs/node/pull/39297 Reviewed-By: James M Snell <jasnell@gmail.com>
86 lines
1.8 KiB
JavaScript
86 lines
1.8 KiB
JavaScript
'use strict';
|
|
|
|
const {
|
|
ObjectSetPrototypeOf,
|
|
Symbol,
|
|
TypeError,
|
|
} = primordials;
|
|
|
|
const {
|
|
customInspectSymbol: kInspect,
|
|
} = require('internal/util');
|
|
|
|
const { inspect } = require('util');
|
|
|
|
const kName = Symbol('kName');
|
|
const kType = Symbol('kType');
|
|
const kStart = Symbol('kStart');
|
|
const kDuration = Symbol('kDuration');
|
|
const kDetail = Symbol('kDetail');
|
|
const kBufferNext = Symbol('kBufferNext');
|
|
|
|
function isPerformanceEntry(obj) {
|
|
return obj?.[kName] !== undefined;
|
|
}
|
|
|
|
class PerformanceEntry {
|
|
constructor() {
|
|
// eslint-disable-next-line no-restricted-syntax
|
|
throw new TypeError('illegal constructor');
|
|
}
|
|
|
|
get name() { return this[kName]; }
|
|
|
|
get entryType() { return this[kType]; }
|
|
|
|
get startTime() { return this[kStart]; }
|
|
|
|
get duration() { return this[kDuration]; }
|
|
|
|
get detail() { return this[kDetail]; }
|
|
|
|
[kInspect](depth, options) {
|
|
if (depth < 0) return this;
|
|
|
|
const opts = {
|
|
...options,
|
|
depth: options.depth == null ? null : options.depth - 1
|
|
};
|
|
|
|
return `${this.constructor.name} ${inspect(this.toJSON(), opts)}`;
|
|
}
|
|
|
|
toJSON() {
|
|
return {
|
|
name: this.name,
|
|
entryType: this.entryType,
|
|
startTime: this.startTime,
|
|
duration: this.duration,
|
|
detail: this.detail,
|
|
};
|
|
}
|
|
}
|
|
|
|
class InternalPerformanceEntry {
|
|
constructor(name, type, start, duration, detail) {
|
|
this[kName] = name;
|
|
this[kType] = type;
|
|
this[kStart] = start;
|
|
this[kDuration] = duration;
|
|
this[kDetail] = detail;
|
|
this[kBufferNext] = null;
|
|
}
|
|
}
|
|
|
|
InternalPerformanceEntry.prototype.constructor = PerformanceEntry;
|
|
ObjectSetPrototypeOf(
|
|
InternalPerformanceEntry.prototype,
|
|
PerformanceEntry.prototype);
|
|
|
|
module.exports = {
|
|
InternalPerformanceEntry,
|
|
PerformanceEntry,
|
|
isPerformanceEntry,
|
|
kBufferNext,
|
|
};
|