refactor(google-analytics): rename {account => measurementId}

Author: caugner

Diff for: .env.testing

@@ -24,7 +24,7 @@ REACT_APP_AUTOCOMPLETE_SEARCH_WIDGET=true
 
 # These are set to fake values just to make sure the paths that
 # injects the relevant script tags actually run in end-to-end testing.
-BUILD_GOOGLE_ANALYTICS_ACCOUNT=UA-00000000-0
+BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID=UA-00000000-0
 
 # The functional tests are done in a production'y way as if it had
 # to go into full production mode.

Diff for: .github/workflows/dev-build.yml

@@ -125,7 +125,7 @@ jobs:
 
           # This just makes sure the Google Analytics script gets used even if
           # it goes nowhere.
-          BUILD_GOOGLE_ANALYTICS_ACCOUNT: UA-00000000-0
+          BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID: UA-00000000-0
 
           # This removes the ability to sign in
           REACT_APP_DISABLE_AUTH: true

Diff for: .github/workflows/performance.yml

@@ -50,7 +50,7 @@ jobs:
 
           # Make sure it's set to something so that the build uses the
           # Google Analytics tag which is most realistic.
-          BUILD_GOOGLE_ANALYTICS_ACCOUNT: UA-00000000-0
+          BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID: UA-00000000-0
         run: |
           yarn build:prepare
           # BUILD_FOLDERSEARCH=mdn/kitchensink yarn build

Diff for: .github/workflows/prod-build.yml

@@ -195,7 +195,7 @@ jobs:
           # If it's used on other domains (e.g. stage or dev builds), it's OK
           # because ultimately Google Analytics will filter it out since the
           # origin domain isn't what that account expects.
-          BUILD_GOOGLE_ANALYTICS_ACCOUNT: UA-36116321-5
+          BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID: UA-36116321-5
 
           # This enables the MDN Plus
           REACT_APP_ENABLE_PLUS: true

Diff for: .github/workflows/stage-build.yml

@@ -195,7 +195,7 @@ jobs:
           BUILD_FLAW_LEVELS: "*:ignore"
 
           # This is the Google Analytics measurement ID for developer.allizom.org.
-          BUILD_GOOGLE_ANALYTICS_ACCOUNT: G-ZG5HNVZRY0
+          BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID: G-ZG5HNVZRY0
 
           # This enables the Plus call-to-action banner and the Plus landing page
           REACT_APP_ENABLE_PLUS: true

Diff for: .github/workflows/xyz-build.yml

@@ -129,7 +129,7 @@ jobs:
           # If it's used on other domains (e.g. stage or dev builds), it's OK
           # because ultimately Google Analytics will filter it out since the
           # origin domain isn't what that account expects.
-          BUILD_GOOGLE_ANALYTICS_ACCOUNT: UA-36116321-5
+          BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID: UA-36116321-5
 
           # This enables the Plus call-to-action banner and the Plus landing page
           REACT_APP_ENABLE_PLUS: true

Diff for: docs/envvars.md

@@ -143,13 +143,13 @@ Used to serve legacy lives samples that do not support playground rendering.
 
 The base URL used in the Interactive Example iframes.
 
-### `BUILD_GOOGLE_ANALYTICS_ACCOUNT`
+### `BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID`
 
 **Default: `''`**
 
 If set, the rendered HTML will have a Google Analytics snippet. For example, to
-test use: `export BUILD_GOOGLE_ANALYTICS_ACCOUNT=UA-00000000-0`. By default it's
-disabled (empty string).
+test use: `export BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID=UA-00000000-0`. By
+default it's disabled (empty string).
 
 ### `BUILD_ALWAYS_ALLOW_ROBOTS`
 

Diff for: docs/google-analytics.md

@@ -5,7 +5,7 @@ from the client-side code. The way it works is that you have to send an
 environment variable, like:
 
 ```bash
-BUILD_GOOGLE_ANALYTICS_ACCOUNT=UA-1234678-0
+BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID=UA-1234678-0
 ```
 
 and that gets included in the build by more or less code-generating the snippet

Diff for: libs/env/index.d.ts

@@ -3,7 +3,7 @@ export const DEFAULT_FLAW_LEVELS: string;
 export const BASE_URL: string;
 export const FILES: string;
 export const FOLDERSEARCH: string;
-export const GOOGLE_ANALYTICS_ACCOUNT: string;
+export const GOOGLE_ANALYTICS_MEASUREMENT_ID: string;
 export const NO_PROGRESSBAR: boolean;
 export const FIX_FLAWS: boolean;
 export const FIX_FLAWS_DRY_RUN: boolean;

Diff for: libs/env/index.js

@@ -28,8 +28,8 @@ export const DEFAULT_FLAW_LEVELS = process.env.BUILD_FLAW_LEVELS || "*:warn";
 
 export const FILES = process.env.BUILD_FILES || "";
 export const FOLDERSEARCH = process.env.BUILD_FOLDERSEARCH || "";
-export const GOOGLE_ANALYTICS_ACCOUNT =
-  process.env.BUILD_GOOGLE_ANALYTICS_ACCOUNT || "";
+export const GOOGLE_ANALYTICS_MEASUREMENT_ID =
+  process.env.BUILD_GOOGLE_ANALYTICS_MEASUREMENT_ID || "";
 export const NO_PROGRESSBAR = Boolean(
   JSON.parse(process.env.BUILD_NO_PROGRESSBAR || process.env.CI || "false")
 );

Diff for: tool/cli.ts

@@ -28,7 +28,7 @@ import {
   BUILD_OUT_ROOT,
   CONTENT_ROOT,
   CONTENT_TRANSLATED_ROOT,
-  GOOGLE_ANALYTICS_ACCOUNT,
+  GOOGLE_ANALYTICS_MEASUREMENT_ID,
 } from "../libs/env/index.js";
 import { runMakePopularitiesFile } from "./popularities.js";
 import { runOptimizeClientBuild } from "./optimize-client-build.js";
@@ -180,7 +180,7 @@ interface PopularitiesActionParameters extends ActionParameters {
 
 interface GoogleAnalyticsCodeActionParameters extends ActionParameters {
   options: {
-    account: string;
+    measurementId: string;
     debug: boolean;
     outfile: string;
   };
@@ -867,25 +867,25 @@ program
     default: path.join(BUILD_OUT_ROOT, "static", "js", "gtag.js"),
   })
   .option(
-    "--account <id>",
-    "Google Analytics account ID (defaults to value of $GOOGLE_ANALYTICS_ACCOUNT)",
+    "--measurement-id <id>",
+    "Google Analytics measurement ID (defaults to value of $GOOGLE_ANALYTICS_MEASUREMENT_ID)",
     {
-      default: GOOGLE_ANALYTICS_ACCOUNT,
+      default: GOOGLE_ANALYTICS_MEASUREMENT_ID,
     }
   )
   .action(
     tryOrExit(
       async ({ options, logger }: GoogleAnalyticsCodeActionParameters) => {
-        const { outfile, account } = options;
-        if (account) {
+        const { outfile, measurementId } = options;
+        if (measurementId) {
           const dntHelperCode = fs
             .readFileSync(
               new URL("mozilla.dnthelper.min.js", import.meta.url),
               "utf-8"
             )
             .trim();
 
-          const gaScriptURL = `https://www.googletagmanager.com/gtag/js?id=${encodeURIComponent(account)}`;
+          const gaScriptURL = `https://www.googletagmanager.com/gtag/js?id=${encodeURIComponent(measurementId)}`;
 
           const code = `
 // Mozilla DNT Helper
@@ -895,7 +895,7 @@ if (Mozilla && !Mozilla.dntEnabled()) {
   window.dataLayer = window.dataLayer || [];
   function gtag(){dataLayer.push(arguments);}
   gtag('js', new Date());
-  gtag('config', '${account}', { 'anonymize_ip': true });
+  gtag('config', '${measurementId}', { 'anonymize_ip': true });
 
   var gaScript = document.createElement('script');
   gaScript.async = true;
@@ -905,7 +905,7 @@ if (Mozilla && !Mozilla.dntEnabled()) {
           fs.writeFileSync(outfile, `${code}\n`, "utf-8");
           logger.info(
             chalk.green(
-              `Generated ${outfile} for SSR rendering using ${account}.`
+              `Generated ${outfile} for SSR rendering using ${measurementId}.`
             )
           );
         } else {