@codecademy/tracking 1.0.32-alpha.dcd01566d8.0 → 1.0.32

package/README.md

@@ -80,20 +80,15 @@ Integrations are loaded in an intentionally layered manner for CCPA/GDPR complia
 
 1. Wait 1000ms to allow any other post-hydration logic to run first
 2. Load in OneTrust's banner and wait for its `OptanonWrapper` callback
-3. [Segment's copy-and-paste snippet](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet) is run to load the Segment global library
-4. Destination integrations for Segment are fetched
-5. Those integrations are compared against the user's consent decisions into a list of allowed destinations
-6. We load only those allowed destinations using Segment's `analytics.load`
+3. Load GTM
 
 ```ts
 import { initializeTrackingIntegrations } from '@codecademy/tracking';
 
 setTimeout(() => {
   initializeTrackingIntegrations({
-    onError: logError,
-    production: true,
+    environment: process.env.NODE_ENV,
     scope: window,
-    writeKey: 'my-segment-write-key',
   });
 }, 1000);
 ```

package/dist/integrations/gtm.d.ts

@@ -0,0 +1,8 @@
+import { TrackingWindow } from './types';
+export type GTMSettings = {
+    environment: string;
+    scope: TrackingWindow;
+    optedOutExternalTracking?: boolean;
+};
+export declare const OPT_OUT_DATALAYER_VAR = "user_opted_out_external_tracking";
+export declare const initializeGTM: ({ scope, environment, optedOutExternalTracking, }: GTMSettings) => void;

package/dist/integrations/gtm.js

@@ -0,0 +1,27 @@
+export const OPT_OUT_DATALAYER_VAR = 'user_opted_out_external_tracking';
+export const initializeGTM = _ref => {
+  var _scope$dataLayer;
+  let scope = _ref.scope,
+    environment = _ref.environment,
+    optedOutExternalTracking = _ref.optedOutExternalTracking;
+  (_scope$dataLayer = scope.dataLayer) !== null && _scope$dataLayer !== void 0 ? _scope$dataLayer : scope.dataLayer = [];
+  scope.dataLayer.push({
+    'gtm.start': new Date().getTime(),
+    event: 'gtm.js'
+  });
+  if (optedOutExternalTracking) {
+    scope.dataLayer.push({
+      [OPT_OUT_DATALAYER_VAR]: true
+    });
+  }
+  let preview_env = '';
+  if (environment === 'development') {
+    preview_env = '&gtm_auth=DoN0WSxjuUkImaph8PYXmA&gtm_preview=env-233';
+  } else if (environment === 'staging') {
+    preview_env = '&gtm_auth=VrQuCDuWXkLlTwNHJYEKTg&gtm_preview=env-232';
+  }
+  const gtm = document.createElement('script');
+  gtm.async = true;
+  gtm.src = "https://www.googletagmanager.com/gtm.js?id=GTM-KTLK85W".concat(preview_env);
+  document.getElementsByTagName('head')[0].appendChild(gtm);
+};

package/dist/integrations/index.d.ts

@@ -1,13 +1,9 @@
 import { TrackingWindow } from './types';
 export type TrackingIntegrationsSettings = {
     /**
-     * Called whenever a network request fails.
+     * Current environment.
      */
-    onError: (message: string) => void;
-    /**
-     * Whether this is running in a production environment.
-     */
-    production: boolean;
+    environment: string;
     /**
      * Global scope (often the window) where globals such as analytics are stored.
      */
@@ -16,12 +12,8 @@ export type TrackingIntegrationsSettings = {
      * Whether user has opted out or is excluded from external tracking
      */
     optedOutExternalTracking?: boolean;
-    /**
-     * Segment write key.
-     */
-    writeKey: string;
 };
 /**
  * @see README.md for details and usage.
  */
-export declare const initializeTrackingIntegrations: ({ onError, production, scope, optedOutExternalTracking, writeKey, }: TrackingIntegrationsSettings) => Promise<void>;
+export declare const initializeTrackingIntegrations: ({ environment, scope, optedOutExternalTracking, }: TrackingIntegrationsSettings) => Promise<void>;

package/dist/integrations/index.js

@@ -1,54 +1,25 @@
-import { conditionallyLoadAnalytics } from './conditionallyLoadAnalytics';
-import { fetchDestinationsForWriteKey } from './fetchDestinationsForWriteKey';
-import { getConsentDecision } from './getConsentDecision';
-import { mapDestinations } from './mapDestinations';
+import { initializeGTM } from './gtm';
 import { initializeOneTrust } from './onetrust';
-import { runSegmentSnippet } from './runSegmentSnippet';
 /**
  * @see README.md for details and usage.
  */
 export const initializeTrackingIntegrations = async _ref => {
-  let onError = _ref.onError,
-    production = _ref.production,
+  let environment = _ref.environment,
     scope = _ref.scope,
-    optedOutExternalTracking = _ref.optedOutExternalTracking,
-    writeKey = _ref.writeKey;
+    optedOutExternalTracking = _ref.optedOutExternalTracking;
   // 1. Wait 1000ms to allow any other post-hydration logic to run first
   await new Promise(resolve => setTimeout(resolve, 1000));
 
   // 2. Load in OneTrust's banner and wait for its `OptanonWrapper` callback
   await initializeOneTrust({
     scope,
-    production
+    environment
   });
 
-  // 3. Segment's copy-and-paste snippet is run to load the Segment global library
-  runSegmentSnippet();
-
-  // 4. Destination integrations for Segment are fetched
-  const destinations = await fetchDestinationsForWriteKey({
-    onError,
-    writeKey
-  });
-  if (!destinations) {
-    return;
-  }
-  const consentDecision = getConsentDecision({
+  // 3. Load GTM
+  initializeGTM({
     scope,
+    environment,
     optedOutExternalTracking
   });
-
-  // 5. Those integrations are compared against the user's consent decisions into a list of allowed destinations
-  const _mapDestinations = mapDestinations({
-      consentDecision,
-      destinations
-    }),
-    destinationPreferences = _mapDestinations.destinationPreferences;
-
-  // 6. We load only those allowed destinations using Segment's `analytics.load`
-  conditionallyLoadAnalytics({
-    analytics: scope.analytics,
-    destinationPreferences,
-    writeKey
-  });
 };

package/dist/integrations/onetrust.d.ts

@@ -1,6 +1,6 @@
 import { TrackingWindow } from './types';
 export type OneTrustSettings = {
-    production: boolean;
+    environment: string;
     scope: TrackingWindow;
 };
-export declare const initializeOneTrust: ({ production, scope, }: OneTrustSettings) => Promise<void>;
+export declare const initializeOneTrust: ({ environment, scope, }: OneTrustSettings) => Promise<void>;

package/dist/integrations/onetrust.js

@@ -1,11 +1,11 @@
 export const initializeOneTrust = async _ref => {
-  let production = _ref.production,
+  let environment = _ref.environment,
     scope = _ref.scope;
   const script = document.createElement('script');
   script.setAttribute('async', 'true');
   script.setAttribute('src', 'https://cdn.cookielaw.org/scripttemplates/otSDKStub.js');
   script.setAttribute('type', 'text/javascript');
-  script.setAttribute('data-domain-script', "cfa7b129-f37b-4f5a-9991-3f75ba7b85fb".concat(production ? '' : '-test'));
+  script.setAttribute('data-domain-script', "cfa7b129-f37b-4f5a-9991-3f75ba7b85fb".concat(environment === 'production' ? '' : '-test'));
   document.body.appendChild(script);
   const style = document.createElement('style');
   style.textContent = rawStyles;

package/dist/integrations/types.d.ts

@@ -1,18 +1,5 @@
 import { Consent } from './consent';
-export interface SegmentAnalytics {
-    initialize?: boolean;
-    load(writeKey: string, options: SegmentAnalyticsOptions): void;
-    page(): void;
-}
-export interface SegmentDestination {
-    category: string;
-    id: string;
-}
-export interface SegmentAnalyticsOptions {
-    integrations: Record<string, boolean>;
-}
 export interface TrackingWindow {
-    analytics?: SegmentAnalytics;
     dataLayer?: unknown[];
     OnetrustActiveGroups?: Consent[] | string;
     OptanonWrapper?: () => void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/tracking",
   "description": "Tracking library for Codecademy",
-  "version": "1.0.32-alpha.dcd01566d8.0",
+  "version": "1.0.32",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "files": [
     "dist/**"
@@ -13,5 +13,5 @@
     "access": "public"
   },
   "repository": "git@github.com:codecademy-engineering/mono.git",
-  "gitHead": "f7712ac5159433c4d3c0a5459cb464a8b224e802"
+  "gitHead": "389b25c0b3df30f006b82c5151799d1747ea6778"
 }

package/dist/integrations/conditionallyLoadAnalytics.d.ts

@@ -1,7 +0,0 @@
-import { SegmentAnalytics } from './types';
-export type AnalyticsLoadOptions = {
-    analytics: SegmentAnalytics;
-    destinationPreferences: Record<string, boolean>;
-    writeKey: string;
-};
-export declare const conditionallyLoadAnalytics: ({ analytics, destinationPreferences, writeKey, }: AnalyticsLoadOptions) => void;

package/dist/integrations/conditionallyLoadAnalytics.js

@@ -1,11 +0,0 @@
-export const conditionallyLoadAnalytics = _ref => {
-  let analytics = _ref.analytics,
-    destinationPreferences = _ref.destinationPreferences,
-    writeKey = _ref.writeKey;
-  if (analytics.initialize) {
-    return;
-  }
-  analytics.load(writeKey, {
-    integrations: destinationPreferences
-  });
-};

package/dist/integrations/fetchDestinationsForWriteKey.d.ts

@@ -1,6 +0,0 @@
-import { SegmentDestination } from './types';
-export type FetchDestinationsSettings = {
-    onError: (message: string) => void;
-    writeKey: string;
-};
-export declare const fetchDestinationsForWriteKey: ({ writeKey, onError, }: FetchDestinationsSettings) => Promise<SegmentDestination[] | undefined>;

package/dist/integrations/fetchDestinationsForWriteKey.js

@@ -1,26 +0,0 @@
-const knownFetchFailures = ['Failed to fetch', 'Load failed', 'NetworkError when attempting to fetch resource', 'Resource blocked by content blocker'];
-export const fetchDestinationsForWriteKey = async _ref => {
-  let writeKey = _ref.writeKey,
-    onError = _ref.onError;
-  const filteredOnError = error => {
-    if (!knownFetchFailures.some(failure => error.includes(failure))) {
-      onError(error);
-    }
-  };
-  try {
-    const response = await fetch("https://cdn.segment.com/v1/projects/".concat(writeKey, "/integrations"));
-    if (!response.ok) {
-      filteredOnError("Failed to fetch integrations for write key ".concat(writeKey, ": HTTP ").concat(response.status, " ").concat(response.statusText));
-      return [];
-    }
-    const destinations = await response.json();
-    for (const destination of destinations) {
-      destination.id = destination.creationName;
-      delete destination.creationName;
-    }
-    return destinations;
-  } catch (error) {
-    filteredOnError("Unknown error fetching Segment destinations for write key ".concat(writeKey, ": ").concat(error));
-    return [];
-  }
-};

package/dist/integrations/getConsentDecision.d.ts

@@ -1,8 +0,0 @@
-import { Consent } from './consent';
-import { TrackingWindow } from './types';
-export interface ConsentDecisionOptions {
-    scope: TrackingWindow;
-    optedOutExternalTracking?: boolean;
-}
-export declare const OPT_OUT_DATALAYER_VAR = "user_opted_out_external_tracking";
-export declare const getConsentDecision: ({ scope, optedOutExternalTracking, }: ConsentDecisionOptions) => Consent[];

package/dist/integrations/getConsentDecision.js

@@ -1,27 +0,0 @@
-import { Consent } from './consent';
-export const OPT_OUT_DATALAYER_VAR = 'user_opted_out_external_tracking';
-export const getConsentDecision = _ref => {
-  let scope = _ref.scope,
-    optedOutExternalTracking = _ref.optedOutExternalTracking;
-  let consentDecision = [];
-  if (typeof scope.OnetrustActiveGroups === 'string') {
-    consentDecision = scope.OnetrustActiveGroups.split(',').filter(Boolean);
-  } else if (scope.OnetrustActiveGroups) {
-    consentDecision = scope.OnetrustActiveGroups;
-  }
-  if (optedOutExternalTracking) {
-    var _scope$dataLayer;
-    /**
-     * If user has already opted out of everything but the essentials
-     * don't force them to consent to Functional & Performance trackers
-     */
-    if (consentDecision.length > 2) {
-      consentDecision = [Consent.StrictlyNecessary, Consent.Functional, Consent.Performance];
-    }
-    (_scope$dataLayer = scope.dataLayer) !== null && _scope$dataLayer !== void 0 ? _scope$dataLayer : scope.dataLayer = [];
-    scope.dataLayer.push({
-      [OPT_OUT_DATALAYER_VAR]: true
-    });
-  }
-  return consentDecision;
-};

package/dist/integrations/mapDestinations.d.ts

@@ -1,12 +0,0 @@
-import { Consent } from './consent';
-import { SegmentDestination } from './types';
-export type DestinationMapOptions = {
-    consentDecision?: Consent[];
-    destinations: SegmentDestination[];
-};
-/**
- * @see https://www.notion.so/codecademy/GDPR-Compliance-141ebcc7ffa542daa0da56e35f482b41
- */
-export declare const mapDestinations: ({ consentDecision, destinations, }: DestinationMapOptions) => {
-    destinationPreferences: Record<string, boolean>;
-};

package/dist/integrations/mapDestinations.js

@@ -1,39 +0,0 @@
-import { Consent } from './consent';
-// The Functional category may need to be added here in the future.
-const targetingCategories = ['Advertising', 'Attribution', 'Email Marketing'];
-const performanceCategories = ['Analytics', 'Customer Success', 'Surveys', 'Heatmaps & Recording'];
-const functionalCategories = ['SMS & Push Notifications'];
-
-/**
- * @see https://www.notion.so/codecademy/GDPR-Compliance-141ebcc7ffa542daa0da56e35f482b41
- */
-export const mapDestinations = _ref => {
-  let _ref$consentDecision = _ref.consentDecision,
-    consentDecision = _ref$consentDecision === void 0 ? [Consent.StrictlyNecessary] : _ref$consentDecision,
-    destinations = _ref.destinations;
-  const destinationPreferences = Object.assign({
-    'Segment.io': consentDecision.includes(Consent.Functional)
-  }, ...destinations.map(dest => {
-    if (targetingCategories.includes(dest.category)) {
-      return {
-        [dest.id]: consentDecision.includes(Consent.Targeting)
-      };
-    }
-    if (performanceCategories.includes(dest.category)) {
-      return {
-        [dest.id]: consentDecision.includes(Consent.Performance)
-      };
-    }
-    if (functionalCategories.includes(dest.category)) {
-      return {
-        [dest.id]: consentDecision.includes(Consent.Functional)
-      };
-    }
-    return {
-      [dest.id]: true
-    };
-  }));
-  return {
-    destinationPreferences
-  };
-};

package/dist/integrations/runSegmentSnippet.d.ts

@@ -1,7 +0,0 @@
-/**
- * This code is copypasta from the Segment documentation.
- * It creates the global analytics object and loads the Segment Analytics API that uses it.
- *
- * @see https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet
- */
-export declare const runSegmentSnippet: () => void;

package/dist/integrations/runSegmentSnippet.js

@@ -1,69 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-nocheck
-
-/**
- * This code is copypasta from the Segment documentation.
- * It creates the global analytics object and loads the Segment Analytics API that uses it.
- *
- * @see https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet
- */
-export const runSegmentSnippet = () => {
-  var _window;
-  // Create a queue, but don't obliterate an existing one!
-  (_window = window).analytics || (_window.analytics = []);
-  const _window2 = window,
-    analytics = _window2.analytics;
-
-  // If the real analytics.js is already on the page return.
-  if (analytics.initialize) return;
-
-  // If the snippet was invoked already show an error.
-  if (analytics.invoked) {
-    console.error('Segment snippet included twice.');
-    return;
-  }
-
-  // Invoked flag, to make sure the snippet
-  // is never invoked twice.
-  analytics.invoked = true;
-
-  // A list of the methods in Analytics.js to stub.
-  analytics.methods = ['trackSubmit', 'trackClick', 'trackLink', 'trackForm', 'pageview', 'identify', 'reset', 'group', 'track', 'ready', 'alias', 'debug', 'page', 'once', 'off', 'on', 'addSourceMiddleware', 'addIntegrationMiddleware', 'setAnonymousId', 'addDestinationMiddleware'];
-
-  // Define a factory to create stubs. These are placeholders
-  // for methods in Analytics.js so that you never have to wait
-  // for it to load to actually record data. The `method` is
-  // stored as the first argument, so we can replay the data.
-  analytics.factory = function (method) {
-    return function () {
-      const args = Array.prototype.slice.call(arguments);
-      args.unshift(method);
-      analytics.push(args);
-      return analytics;
-    };
-  };
-
-  // For each of our methods, generate a queueing stub.
-  for (let i = 0; i < analytics.methods.length; i += 1) {
-    const key = analytics.methods[i];
-    analytics[key] = analytics.factory(key);
-  }
-
-  // Define a method to load Analytics.js from our CDN,
-  // and that will be sure to only ever load it once.
-  analytics.load = function (key, options) {
-    // Create an async script element based on your key.
-    const script = document.createElement('script');
-    script.type = 'text/javascript';
-    script.async = true;
-    script.src = 'https://cdn.segment.com/analytics.js/v1/' + key + '/analytics.min.js';
-
-    // Insert our script next to the first script element.
-    const first = document.getElementsByTagName('script')[0];
-    first.parentNode.insertBefore(script, first);
-    analytics._loadOptions = options;
-  };
-
-  // Add a version to keep track of what's in the wild.
-  analytics.SNIPPET_VERSION = '4.1.0';
-};