Cleanup metadata handling

wxt-dev · Oct 22, 2024 · 0416ff7 · 0416ff7
1 parent 26cbef5
commit 0416ff7
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 70 deletions.
diff --git a/packages/analytics/modules/analytics/client.ts b/packages/analytics/modules/analytics/client.ts
@@ -6,6 +6,7 @@ import type {
   AnalyticsStorageItem,
   AnalyticsTrackEvent,
   BaseAnalyticsEvent,
+  AnalyticsEventMetadata,
 } from './types';
 
 const ANALYTICS_PORT = '@wxt-dev/analytics';
@@ -26,7 +27,7 @@ export function createAnalytics(config?: AnalyticsConfig): Analytics {
   if (location.pathname === '/background.js')
     return createBackgroundAnalytics(config);
 
-  return createFrontendAnalytics(config);
+  return createFrontendAnalytics();
 }
 
 /**
@@ -57,29 +58,24 @@ function createBackgroundAnalytics(
   let userProperties = userPropertiesStorage.getValue();
   const manifest = chrome.runtime.getManifest();
 
+  const getBackgroundMeta = () => ({
+    timestamp: Date.now(),
+    // Don't track sessions for the background, it can be running
+    // indefinitely, and will inflate session duration stats.
+    sessionId: undefined,
+    language: navigator.language,
+    referrer: undefined,
+    screen: undefined,
+    url: location.href,
+    title: undefined,
+  });
+
   const getBaseEvent = async (
-    meta: ForwardMetadata = {
-      timestamp: Date.now(),
-      // Don't track sessions for the background, it can be running
-      // indefinitely, and will inflate session duration stats.
-      sessionId: undefined,
-      language: navigator.language,
-      referrer: undefined,
-      screen: undefined,
-      url: location.href,
-      title: undefined,
-    },
+    meta: AnalyticsEventMetadata,
   ): Promise<BaseAnalyticsEvent> => {
     const platform = await platformInfo;
     return {
-      meta: {
-        sessionId: meta.sessionId,
-        timestamp: meta.timestamp,
-        screen: meta.screen,
-        referrer: meta.referrer,
-        language: meta.language,
-        url: meta.url,
-      },
+      meta,
       user: {
         id: await userId,
         properties: {
@@ -100,7 +96,7 @@ function createBackgroundAnalytics(
     identify: async (
       newUserId: string,
       newUserProperties: Record<string, string> = {},
-      forwardMeta?: ForwardMetadata,
+      meta: AnalyticsEventMetadata = getBackgroundMeta(),
     ) => {
       // Update in-memory cache for all providers
       userId = Promise.resolve(newUserId);
@@ -111,7 +107,7 @@ function createBackgroundAnalytics(
         userPropertiesStorage.setValue?.(newUserProperties),
       ]);
       // Notify providers
-      const event = await getBaseEvent(forwardMeta);
+      const event = await getBaseEvent(meta);
       if (config?.debug) console.debug('[analytics] identify', event);
       if (await enabled.getValue()) {
         await Promise.allSettled(
@@ -123,14 +119,17 @@ function createBackgroundAnalytics(
         );
       }
     },
-    page: async (location: string, forwardMeta?: ForwardMetadata) => {
-      const baseEvent = await getBaseEvent(forwardMeta);
+    page: async (
+      location: string,
+      meta: AnalyticsEventMetadata = getBackgroundMeta(),
+    ) => {
+      const baseEvent = await getBaseEvent(meta);
       const event: AnalyticsPageViewEvent = {
         ...baseEvent,
         page: {
-          url: forwardMeta?.url ?? globalThis.location?.href,
+          url: meta?.url ?? globalThis.location?.href,
           location,
-          title: forwardMeta?.title ?? globalThis.document?.title,
+          title: meta?.title ?? globalThis.document?.title,
         },
       };
       if (config?.debug) console.debug('[analytics] page', event);
@@ -145,9 +144,9 @@ function createBackgroundAnalytics(
     track: async (
       eventName: string,
       eventProperties?: Record<string, string>,
-      forwardMeta?: ForwardMetadata,
+      meta: AnalyticsEventMetadata = getBackgroundMeta(),
     ) => {
-      const baseEvent = await getBaseEvent(forwardMeta);
+      const baseEvent = await getBaseEvent(meta);
       const event: AnalyticsTrackEvent = {
         ...baseEvent,
         event: { name: eventName, properties: eventProperties },
@@ -189,12 +188,10 @@ function createBackgroundAnalytics(
 /**
  * Creates an analytics client for non-background contexts.
  */
-function createFrontendAnalytics(
-  config: AnalyticsConfig | undefined,
-): Analytics {
+function createFrontendAnalytics(): Analytics {
   const port = chrome.runtime.connect({ name: ANALYTICS_PORT });
   const sessionId = Date.now();
-  const getMetadata = (): ForwardMetadata => ({
+  const getFrontendMetadata = (): AnalyticsEventMetadata => ({
     sessionId,
     timestamp: Date.now(),
     language: navigator.language,
@@ -209,13 +206,7 @@ function createFrontendAnalytics(
   const methodForwarder =
     (fn: string) =>
     (...args: any[]) => {
-      if (config?.debug) {
-        console.debug(
-          `[analytics] Sending ${fn} to background for upload`,
-          ...args,
-        );
-      }
-      port.postMessage({ fn, args: [...args, getMetadata()] });
+      port.postMessage({ fn, args: [...args, getFrontendMetadata()] });
     };
 
   const analytics: Analytics = {
@@ -224,14 +215,8 @@ function createFrontendAnalytics(
     track: methodForwarder('track'),
     setEnabled: methodForwarder('setEnabled'),
     autoTrack: (root) => {
-      if (config?.debug) {
-        console.debug('[analytics] autoTrack() called!');
-      }
       const onClick = (event: Event) => {
         const element = event.target as any;
-        if (config?.debug) {
-          console.debug('[analytics] autoTrack() element clicked', element);
-        }
         if (
           !element ||
           (!INTERACTIVE_TAGS.has(element.tagName) &&
@@ -256,16 +241,6 @@ function createFrontendAnalytics(
   return analytics;
 }
 
-interface ForwardMetadata {
-  sessionId: number | undefined;
-  timestamp: number;
-  screen: string | undefined;
-  language: string | undefined;
-  referrer: string | undefined;
-  url: string | undefined;
-  title: string | undefined;
-}
-
 function defineStorageItem<T>(
   key: string,
   defaultValue?: NonNullable<T>,

diff --git a/packages/analytics/modules/analytics/types.ts b/packages/analytics/modules/analytics/types.ts
@@ -56,26 +56,30 @@ export type AnalyticsProvider = (
 };
 
 export interface BaseAnalyticsEvent {
-  meta: {
-    /** Identifier of the session the event was fired from */
-    sessionId: number | undefined;
-    /** `Date.now()` of when the event was reported */
-    timestamp: number;
-    /** `"1920x1080"` */
-    screen: string | undefined;
-    /** `document.referrer` */
-    referrer: string | undefined;
-    /** `navigator.language` */
-    language: string | undefined;
-    /** `location.href` */
-    url: string | undefined;
-  };
+  meta: EventMetadata;
   user: {
     id: string;
     properties: Record<string, string | undefined>;
   };
 }
 
+export interface AnalyticsEventMetadata {
+  /** Identifier of the session the event was fired from */
+  sessionId: number | undefined;
+  /** `Date.now()` of when the event was reported */
+  timestamp: number;
+  /** `"1920x1080"` */
+  screen: string | undefined;
+  /** `document.referrer` */
+  referrer: string | undefined;
+  /** `navigator.language` */
+  language: string | undefined;
+  /** `location.href` */
+  url: string | undefined;
+  /** `document.title` */
+  title: string | undefined;
+}
+
 export interface AnalyticsPageInfo {
   url: string;
   title: string | undefined;

diff --git a/packages/analytics/package.json b/packages/analytics/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@wxt-dev/analytics",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "Add analytics to your web extension",
   "repository": {
     "type": "git",