Core: Make PerfReporter compatible with Node.js

Switch from hardcoded `window.performance` to `performance` as global
more generally, so it works in Node.js as well.

Note by default this remains only enabled in browsers, as controlled
by `src/core/start.js` where we check:

```
if (config.reporters.perf || (config.reporters.perf === undefined && window && document)) {
```

So this change does not start enabling it in Node.js. But, you can now
enable it on Node.js via `qunit_config_reporters_perf=true` or by
invoking `QUnit.reporters.perf.init(QUnit)`, which previously did not
do anything on Node.js.

Author: Krinkle

Gruntfile.js

@@ -91,7 +91,8 @@ module.exports = function (grunt) {
         'test/module-todo.html',
         'test/only-each.html',
         'test/overload.html',
-        'test/performance-mark.html',
+        'test/perf-clear-marks.html',
+        'test/perf-mark.html',
         'test/preconfig-flat-reporters.html',
         'test/preconfig-flat-testId.html',
         'test/preconfig-flat.html',

docs/api/reporters/perf.md

@@ -19,8 +19,8 @@ This uses the [performance.measure()](https://developer.mozilla.org/en-US/docs/W
 QUnit enables the perf reporter by default in [Browser](../../browser.md) environments. The measures are automatically included in Firefox Profiler and Chrome DevTools (Safari is pending [WebKit #213870](https://bugs.webkit.org/show_bug.cgi?id=213870)).
 
 ```
-QUnit Test Run
-└── QUnit Test Suite: Example
+QUnit Run
+└── QUnit Module: Example
     ├── QUnit Test: apple
     ├── QUnit Test: banana
     └── QUnit Test: citron

src/core/reporters/PerfReporter.js

@@ -1,19 +1,15 @@
-import { window } from '../globals.js';
+import { globalThis } from '../globals.js';
 import { prioritySymbol } from '../events.js';
 import Logger from '../logger.js';
 
-// TODO: Change from window to globalThis in QUnit 3.0, so that the reporter
-// works for Node.js as well. As this can add overhead, we should keep
-// this opt-in on the CLI.
 const nativePerf = (
-  window
-    && typeof window.performance !== 'undefined'
+  typeof globalThis.performance !== 'undefined'
     // eslint-disable-next-line compat/compat -- Checked
-    && typeof window.performance.mark === 'function'
+    && typeof globalThis.performance.mark === 'function'
     // eslint-disable-next-line compat/compat -- Checked
-    && typeof window.performance.measure === 'function'
+    && typeof globalThis.performance.measure === 'function'
 )
-  ? window.performance
+  ? globalThis.performance
   : undefined;
 
 const perf = {
@@ -61,7 +57,7 @@ export default class PerfReporter {
     const suiteName = suiteEnd.fullName.join(' – ');
 
     this.perf.mark(`qunit_suite_${suiteLevel}_end`);
-    this.perf.measure(`QUnit Test Suite: ${suiteName}`,
+    this.perf.measure(`QUnit Module: ${suiteName}`,
         `qunit_suite_${suiteLevel}_start`,
         `qunit_suite_${suiteLevel}_end`
     );
@@ -83,6 +79,6 @@ export default class PerfReporter {
 
   onRunEnd () {
     this.perf.mark('qunit_suite_0_end');
-    this.perf.measure('QUnit Test Run', 'qunit_suite_0_start', 'qunit_suite_0_end');
+    this.perf.measure('QUnit Run', 'qunit_suite_0_start', 'qunit_suite_0_end');
   }
 }

test/cli/fixtures/perf-mark.js

@@ -0,0 +1,27 @@
+/* eslint-env browser */
+
+QUnit.config.reorder = false;
+
+QUnit.test('foo', function (assert) {
+  assert.true(true);
+});
+
+QUnit.test('bar', function (assert) {
+  assert.true(true);
+});
+
+QUnit.test('getEntries', function (assert) {
+  // eslint-disable-next-line compat/compat - Only for IE 10+ and Safari 10+
+  const entries = performance.getEntriesByType('measure')
+    .filter(function (entry) {
+      return entry.name.indexOf('QUnit') === 0;
+    })
+    .map(function (entry) {
+      return entry.toJSON();
+    });
+
+  assert.propContains(entries, [
+    { name: 'QUnit Test: foo' },
+    { name: 'QUnit Test: bar' }
+  ]);
+});

test/cli/fixtures/perf-mark.tap.txt

@@ -0,0 +1,12 @@
+# command: ["qunit", "perf-mark.js"]
+# env: { "qunit_config_reporters_perf": true }
+
+TAP version 13
+ok 1 foo
+ok 2 bar
+ok 3 getEntries
+1..3
+# pass 3
+# skip 0
+# todo 0
+# fail 0

test/perf-clear-marks.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="UTF-8">
+	<title>perf-clear-marks</title>
+	<link rel="stylesheet" href="../src/core/qunit.css">
+	<script src="../qunit/qunit.js"></script>
+	<script src="perf-clear-marks.js"></script>
+</head>
+<body>
+	<div id="qunit"></div>
+</body>
+</html>

test/performance-mark.js renamed to test/perf-clear-marks.js

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="UTF-8">
+	<title>perf-mark</title>
+	<link rel="stylesheet" href="../src/core/qunit.css">
+	<script src="../qunit/qunit.js"></script>
+	<script src="perf-mark.js"></script>
+</head>
+<body>
+	<div id="qunit"></div>
+</body>
+</html>

test/perf-mark.html

@@ -0,0 +1,26 @@
+/* eslint-env browser */
+
+QUnit.config.reorder = false;
+
+QUnit.test('foo', function (assert) {
+  assert.true(true);
+});
+
+QUnit.test('bar', function (assert) {
+  assert.true(true);
+});
+
+QUnit.test('getEntries', function (assert) {
+  var entries = performance.getEntriesByType('measure')
+    .filter(function (entry) {
+      return entry.name.indexOf('QUnit') === 0;
+    })
+    .map(function (entry) {
+      return entry.toJSON();
+    });
+
+  assert.propContains(entries, [
+    { name: 'QUnit Test: foo' },
+    { name: 'QUnit Test: bar' }
+  ]);
+});