Rename measurement 'kind' to 'mode'

google · Jul 23, 2020 · 9d54ad3 · 9d54ad3
1 parent 0448e65
commit 9d54ad3
Show file tree

Hide file tree

Showing 15 changed files with 71 additions and 71 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,7 +19,7 @@ project adheres to [Semantic Versioning](http://semver.org/).
   "benchmarks": [
     {
       "measurement": {
-        "kind": "performance",
+        "mode": "performance",
         "entryName": "foo"
       }
     }
@@ -32,12 +32,12 @@ project adheres to [Semantic Versioning](http://semver.org/).
   "benchmarks": [
     {
       "measurement": {
-        "kind": "callback"
+        "mode": "callback"
       }
     },
     {
       "measurement": {
-        "kind": "expression",
+        "mode": "expression",
         "expression": "window.tachometerResult"
       }
     }

diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ confidence in them.
 
 ## Measurement modes
 
-Tachometer supports four kinds of time interval measurements, controlled with
+Tachometer supports four modes of time interval measurements, controlled with
 the `measurement` config file property, or the `--measure` flag.
 
 If `measurement` is an array, then all of the given measurements will be
@@ -111,7 +111,7 @@ And in your config file:
 "benchmarks": [
   {
     "measurement": {
-      "kind": "performance",
+      "mode": "performance",
       "entryName": "foo"
     }
   }

diff --git a/config.schema.json b/config.schema.json
@@ -5,15 +5,15 @@
         "CallbackMeasurement": {
             "additionalProperties": false,
             "properties": {
-                "kind": {
+                "mode": {
                     "enum": [
                         "callback"
                     ],
                     "type": "string"
                 }
             },
             "required": [
-                "kind"
+                "mode"
             ],
             "type": "object"
         },
@@ -207,7 +207,7 @@
                 "expression": {
                     "type": "string"
                 },
-                "kind": {
+                "mode": {
                     "enum": [
                         "expression"
                     ],
@@ -216,7 +216,7 @@
             },
             "required": [
                 "expression",
-                "kind"
+                "mode"
             ],
             "type": "object"
         },
@@ -307,7 +307,7 @@
                 "entryName": {
                     "type": "string"
                 },
-                "kind": {
+                "mode": {
                     "enum": [
                         "performance"
                     ],
@@ -316,7 +316,7 @@
             },
             "required": [
                 "entryName",
-                "kind"
+                "mode"
             ],
             "type": "object"
         },

diff --git a/src/config.ts b/src/config.ts
@@ -124,7 +124,7 @@ export async function makeConfig(opts: Opts): Promise<Config> {
 
   for (const spec of config.benchmarks) {
     for (const measurement of spec.measurement) {
-      if (measurement.kind === 'performance' &&
+      if (measurement.mode === 'performance' &&
           measurement.entryName === 'first-contentful-paint' &&
           !fcpBrowsers.has(spec.browser.name)) {
         throw new Error(

diff --git a/src/configfile.ts b/src/configfile.ts
@@ -343,16 +343,16 @@ async function parseBenchmark(benchmark: ConfigFileBenchmark, root: string):
 
   if (benchmark.measurement === 'callback') {
     spec.measurement = [{
-      kind: 'callback',
+      mode: 'callback',
     }];
   } else if (benchmark.measurement === 'fcp') {
     spec.measurement = [{
-      kind: 'performance',
+      mode: 'performance',
       entryName: 'first-contentful-paint',
     }];
   } else if (benchmark.measurement === 'global') {
     spec.measurement = [{
-      kind: 'expression',
+      mode: 'expression',
       expression:
           benchmark.measurementExpression || defaults.measurementExpression,
     }];

diff --git a/src/defaults.ts b/src/defaults.ts
@@ -28,9 +28,9 @@ export const measurementExpression = 'window.tachometerResult';
 export function measurement(url: LocalUrl|RemoteUrl): Measurement {
   if (url.kind === 'remote') {
     return {
-      kind: 'performance',
+      mode: 'performance',
       entryName: 'first-contentful-paint',
     };
   }
-  return {kind: 'callback'};
+  return {mode: 'callback'};
 }
diff --git a/src/measure.ts b/src/measure.ts
@@ -24,7 +24,7 @@ export async function measure(
     driver: webdriver.WebDriver,
     measurement: Measurement,
     server: Server|undefined): Promise<number|undefined> {
-  switch (measurement.kind) {
+  switch (measurement.mode) {
     case 'callback':
       if (server === undefined) {
         throw new Error('Internal error: no server for spec');
@@ -125,7 +125,7 @@ function escapeStringLiteral(unescaped: string): string {
  * where there are multiple measurements on the same page.
  */
 export function measurementName(measurement: Measurement): string {
-  switch (measurement.kind) {
+  switch (measurement.mode) {
     case 'callback':
       return 'callback';
     case 'expression':

diff --git a/src/specs.ts b/src/specs.ts
@@ -72,16 +72,16 @@ export async function specsFromOpts(opts: Opts): Promise<BenchmarkSpec[]> {
   let measurement: Measurement|undefined;
   if (opts.measure === 'callback') {
     measurement = {
-      kind: 'callback',
+      mode: 'callback',
     };
   } else if (opts.measure === 'fcp') {
     measurement = {
-      kind: 'performance',
+      mode: 'performance',
       entryName: 'first-contentful-paint',
     };
   } else if (opts.measure === 'global') {
     measurement = {
-      kind: 'expression',
+      mode: 'expression',
       expression:
           opts['measurement-expression'] || defaults.measurementExpression,
     };

diff --git a/src/test/config_test.ts b/src/test/config_test.ts
@@ -61,7 +61,7 @@ suite('makeConfig', function() {
             },
           },
           measurement: [{
-            kind: 'callback',
+            mode: 'callback',
           }],
           name: 'random-global.html',
           url: {
@@ -104,7 +104,7 @@ suite('makeConfig', function() {
             },
           },
           measurement: [{
-            kind: 'callback',
+            mode: 'callback',
           }],
           // TODO(aomarks) Why does this have a forward-slash?
           name: '/random-global.html',
@@ -147,7 +147,7 @@ suite('makeConfig', function() {
             },
           },
           measurement: [{
-            kind: 'callback',
+            mode: 'callback',
           }],
           // TODO(aomarks) Why does this have a forward-slash?
           name: '/random-global.html',
@@ -197,7 +197,7 @@ suite('makeConfig', function() {
             },
           },
           measurement: [{
-            kind: 'callback',
+            mode: 'callback',
           }],
           // TODO(aomarks) Why does this have a forward-slash?
           name: '/random-global.html',