remove ANALYTICS_NAMESPACE as it's only usable at build time

and replace it with a runtime window.btrixEvent set that can be set in the extra.js config

Author: emma-sg

frontend/config/define.js

@@ -22,7 +22,4 @@ const WEBSOCKET_HOST =
 
 module.exports = {
   "window.process.env.WEBSOCKET_HOST": JSON.stringify(WEBSOCKET_HOST),
-  "window.process.env.ANALYTICS_NAMESPACE": JSON.stringify(
-    process.env.ANALYTICS_NAMESPACE || "",
-  ),
 };

frontend/docs/docs/deploy/customization.md

@@ -227,3 +227,21 @@ inject_extra: >
 ```
 
 Note that the script will only run when the web app loads, i.e. the first time the app is loaded in the browser and on hard refresh. The script will not run again upon clicking a link in the web app. This shouldn't be an issue with most analytics libraries, which should listen for changes to [window history](https://developer.mozilla.org/en-US/docs/Web/API/History). If you have a custom script that needs to re-run when the frontend URL changes, you'll need to add an event listener for the [`popstate` event](https://developer.mozilla.org/en-US/docs/Web/API/Window/popstate_event).
+
+### Tracking events
+
+Certain events, such as public collection views, link copies, and downloads, can be optionally tracked by setting `window.btrixEvent` in your `inject_extra` config. This should be a function that conforms to the following type:
+
+```ts
+type btrixEvent = (
+  event: string,
+  extra?: {
+    props?: {
+      org_slug: string | null;
+      collection_id?: string | null;
+      collection_name?: string | null;
+      logged_in?: boolean;
+    };
+  },
+) => void;
+```

frontend/sample.env.local

@@ -4,4 +4,3 @@ E2E_USER_EMAIL=
 E2E_USER_PASSWORD=
 GLITCHTIP_DSN=
 INJECT_EXTRA=
-ANALYTICS_NAMESPACE=

frontend/src/utils/analytics.ts

@@ -14,22 +14,25 @@ export type AnalyticsTrackProps = {
   logged_in?: boolean;
 };
 
+declare global {
+  interface Window {
+    btrixEvent?: (
+      event: string,
+      extra?: { props?: AnalyticsTrackProps },
+    ) => void;
+  }
+}
+
 export function track(
   event: `${AnalyticsTrackEvent}`,
   props?: AnalyticsTrackProps,
 ) {
-  // ANALYTICS_NAMESPACE is specified with webpack `DefinePlugin`
-  const analytics = window.process.env.ANALYTICS_NAMESPACE
-    ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      (window as any)[window.process.env.ANALYTICS_NAMESPACE]
-    : null;
-
-  if (!analytics) {
+  if (!window.btrixEvent) {
     return;
   }
 
   try {
-    analytics(event, { props });
+    window.btrixEvent(event, { props });
   } catch (err) {
     console.debug(err);
   }