Switch to allow list

sitespeedio · Nov 23, 2023 · 241b264 · 241b264
1 parent a5d031d
commit 241b264
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/lib/core/engine/command/measure.js b/lib/core/engine/command/measure.js
@@ -6,7 +6,7 @@ import { timestamp as _timestamp } from '../../../support/engineUtils.js';
 import { Video } from '../../../video/video.js';
 import { pathToFolder } from '../../../support/pathToFolder.js';
 import { setOrangeBackground } from '../../../video/screenRecording/setOrangeBackground.js';
-import { filterWhitelisted } from '../../../support/userTiming.js';
+import { filterAllowlisted } from '../../../support/userTiming.js';
 import { isAndroidConfigured, Android } from '../../../android/index.js';
 import { TCPDump } from '../../../support/tcpdump.js';
 import { lcpHighlightScript as highlightLargestContentfulPaint } from './util/lcpHighlightScript.js';
@@ -487,11 +487,11 @@ export class Measure {
 
     // Some sites has crazy amount of user timings:
     // strip them if you want
-    if (this.options.userTimingWhitelist) {
-      filterWhitelisted(
+    if (this.options.userTimingAllowList) {
+      filterAllowlisted(
         this.result[this.numberOfMeasuredPages].browserScripts.timings
           .userTimings,
-        this.options.userTimingWhitelist
+        this.options.userTimingAllowList
       );
     }
 

diff --git a/lib/support/cli.js b/lib/support/cli.js
@@ -757,7 +757,7 @@ export function parseCommandLine() {
       choices: ['min', 'middle', 'max'],
       default: 'min',
       describe:
-        'Using a Samsung A51 or Moto G5 you can choose how to pin the CPU to better align the speed with your users. This only works on rooted phones and together with --android.rooted',
+        'Using a Samsung A51 or Moto G5 you can choose how to pin the CPU to better align the speed with your users. This only works on rooted phones and together with --android.root5ed',
       group: 'android'
     })
     .option('android.batteryTemperatureLimit', {
@@ -1211,9 +1211,9 @@ export function parseCommandLine() {
       type: 'integer',
       default: 1500
     })
-    .option('userTimingWhitelist', {
+    .option('userTimingAllowList', {
       describe:
-        'All userTimings are captured by default this option takes a regex that will whitelist which userTimings to capture in the results.'
+        'All userTimings are captured by default this option takes a regex that will allow which userTimings to capture in the results.'
     })
     .option('headless', {
       type: 'boolean',

diff --git a/lib/support/userTiming.js b/lib/support/userTiming.js
@@ -1,5 +1,5 @@
-export function filterWhitelisted(userTimings, whitelistRegex) {
-  const allowed = new RegExp(whitelistRegex);
+export function filterAllowlisted(userTimings, allowlistRegex) {
+  const allowed = new RegExp(allowlistRegex);
   userTimings.marks = userTimings.marks.filter(mark => allowed.test(mark.name));
   userTimings.measures = userTimings.measures.filter(measure =>
     allowed.test(measure.name)

diff --git a/test/unittests/userTimingTest.js b/test/unittests/userTimingTest.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 import { resolve } from 'node:path';
-import { filterWhitelisted } from '../../lib/support/userTiming.js';
+import { filterAllowlisted } from '../../lib/support/userTiming.js';
 import { readFileSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import path from 'node:path';
@@ -11,7 +11,7 @@ const timingsFile = resolve(__dirname, '..', 'data', 'timings.json');
 test(`Filter white listed user timings`, async t => {
   const userTimings = JSON.parse(readFileSync(timingsFile, 'utf8')).timings
     .userTimings;
-  filterWhitelisted(userTimings, 'foo_');
+  filterAllowlisted(userTimings, 'foo_');
   t.deepEqual(
     JSON.stringify(userTimings.marks),
     '[{"name":"foo_test","startTime":"1500.111"},{"name":"foo_test2","startTime":"1100.111"}]'