Telemetry update

Author: jeffwilcox

Diff for: .github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
     - name: "Build the site"
       run: |
         npm install
-        npm run build
+        NEXT_ENV_DESCRIPTOR=production NEXT_ONE_DS_INSTRUMENTATION_KEY=b341ec446e65436485df678003ce82f7 npm run build
     - name: "Stamp content.json"
       env:
         GITSHA: ${{ github.sha }}

Diff for: src/components/TelemetryScript.tsx

@@ -6,6 +6,38 @@
 import fs from 'fs';
 
 const telemetryJavaScript = fs.readFileSync('./src/components/telemetry.js', 'utf8');
+const REPLACEMENT_KEY_CONST = "const oneDsTelemetryInstrumentationKey = '';";
+const REPLACEMENT_ENV_CONST = "const oneDsEnvironmentDescriptor = '';";
+const REPLACEMENT_IS_DEBUGGING_CONST = "const isDebugging = false;";
+
+function get1dsInstrumentationKey() {
+  return process.env.NEXT_ONE_DS_INSTRUMENTATION_KEY;
+}
+
+function getIsDebugging() {
+  return process.env.NEXT_DEBUG === '1';
+}
+
+function getTelemetryEnvironmentDescriptor() {
+  return process.env.NEXT_ENV_DESCRIPTOR || 'unknown';
+}
+
+function getTelemetryScript() {
+  let script = telemetryJavaScript;
+  const instrumentationKey = get1dsInstrumentationKey();
+  const env = getTelemetryEnvironmentDescriptor();
+  const isDebugging = getIsDebugging();
+  if (isDebugging) {
+    script = script.replace(REPLACEMENT_IS_DEBUGGING_CONST, `const isDebugging = true;`);
+  }
+  if (instrumentationKey) {
+    script = script.replace(REPLACEMENT_KEY_CONST, `const oneDsTelemetryInstrumentationKey = '${instrumentationKey}';`);
+  }
+  if (env) {
+    script = script.replace(REPLACEMENT_ENV_CONST, `const oneDsEnvironmentDescriptor = '${env}';`);
+  }
+  return script;
+}
 
 export default function TelemetryScript() {
   return (
@@ -14,7 +46,7 @@ export default function TelemetryScript() {
       <script
         id="uhf-footer-ccpa"
         dangerouslySetInnerHTML={{
-          __html: telemetryJavaScript,
+          __html: getTelemetryScript(),
         }}
       />
     </>

Diff for: src/components/telemetry.js

@@ -1,6 +1,65 @@
 // Detect GPC
 const globalPrivacyControlEnabled = navigator.globalPrivacyControl;
 
+const isDebugging = false;
+const oneDsTelemetryInstrumentationKey = '';
+const oneDsEnvironmentDescriptor = '';
+
+// 1DS telemetry
+// ---
+function inject1ds() {
+  if (!oneDsTelemetryInstrumentationKey) {
+    return;
+  }
+  const script = document.createElement('script');
+  script.type = 'text/javascript';
+  script.src = 'https://js.monitor.azure.com/scripts/c/ms.analytics-web-3.min.js';
+  script.async = true;
+  script.onload = () => {
+    initialize1dsAnalytics(oneDsTelemetryInstrumentationKey);
+  };
+  document.head.appendChild(script);
+}
+
+function initialize1dsAnalytics(instrumentationKey) {
+  // Make sure the oneDS object is available
+  if (typeof window['oneDS'] === 'undefined') {
+    return;
+  }
+  const oneDS = window['oneDS'];
+  const ApplicationInsights = oneDS.ApplicationInsights;
+  if (!ApplicationInsights) {
+    return;
+  }
+
+  const analytics = new ApplicationInsights();
+  const env = oneDsEnvironmentDescriptor || 'unknown';
+  const config = {
+    instrumentationKey: instrumentationKey,
+    channelConfiguration: {
+      eventsLimitInMem: 50
+    },
+    propertyConfiguration: {
+      env,
+    },
+    webAnalyticsConfiguration: {
+      autoCapture: {
+        scroll: true,
+        pageView: true,
+        onLoad: true,
+        onUnload: true,
+        click: true,
+        resize: true,
+        jsError: true
+      }
+    }
+  };
+  analytics.initialize(config, []);
+}
+
+// Cookie consent management
+// ---
+
 // Set data sharing opt-in to false when GPC/AMC controls detected
 const GPC_DataSharingOptIn = (globalPrivacyControlEnabled) ? false : checkThirdPartyAdsOptOutCookie();
 
@@ -9,7 +68,7 @@ function checkThirdPartyAdsOptOutCookie() {
   try {
     const ThirdPartyAdsOptOutCookieName = '3PAdsOptOut';
     var cookieValue = getCookie(ThirdPartyAdsOptOutCookieName);
-        
+
     //for unauthenticated users
     return cookieValue != 1;
   } catch {
@@ -26,6 +85,10 @@ function enableAppInsights() {
   var appInsights=window.appInsights||function(config){function s(config){t[config]=function(){var i=arguments;t.queue.push(function(){t[config].apply(t,i)})}}var t={config:config},r=document,f=window,e="script",o=r.createElement(e),i,u;for(o.src=config.url||"//az416426.vo.msecnd.net/scripts/a/ai.0.js",r.getElementsByTagName(e)[0].parentNode.appendChild(o),t.cookie=r.cookie,t.queue=[],i=["Event","Exception","Metric","PageView","Trace"];i.length;)s("track"+i.pop());return config.disableExceptionTracking||(i="onerror",s("_"+i),u=f[i],f[i]=function(config,r,f,e,o){var s=u&&u(config,r,f,e,o);return s!==!0&&t["_"+i](config,r,f,e,o),s}),t}({instrumentationKey:"98f90d2e-54e0-4e9c-a919-deea70bad056"/*the telemetry instrumentation key is NOT a secret FYI */});window.appInsights=appInsights;appInsights.trackPageView();
 }
 
+function enable1ds() {
+  inject1ds();
+}
+
 var siteConsent = null;
 
 const currentUrl = window.location.href;
@@ -46,6 +109,7 @@ function enableAnalytics() {
 function addTelemetry() {
   enableAppInsights();
   enableAnalytics();
+  enable1ds();
 }
 function onConsentChanged(categoryPreferences) {
   showTelemetryDebug && console.log('onConsentChanged.');