fix(analytics): rename useAnalytics to useTrackFeature

Author: asbjornhaland

cookbooks/portal-analytics/src/components/LogReader.tsx

@@ -6,19 +6,16 @@ import { SideSheet } from '@equinor/fusion-react-side-sheet';
 import { Button, Icon } from '@equinor/eds-core-react';
 import { info_circle } from '@equinor/eds-icons';
 import { DateRange } from '@equinor/fusion-react-date';
-import { useAnalytics } from '@equinor/fusion-framework-react-app/analytics';
+import { useTrackFeature } from '@equinor/fusion-framework-react-app/analytics';
 
 export const LogReader = () => {
   const [activeLogEntry, setActiveLogEntry] = useState<LogEntry | null>(null);
   const [entries, setEntries] = useState<LogEntry[]>([]);
   const [error, setError] = useState<string | null>(null);
-  const analytics = useAnalytics();
+  const trackFeature = useTrackFeature();
 
   const fetchLogs = useCallback(async () => {
-    analytics?.trackAnalytic({
-      name: 'cookbook:portal-analytics:logs:fetch',
-      value: undefined,
-    });
+    trackFeature('cookbook:portal-analytics:logs:fetch');
 
     try {
       const response = await fetch('/@fusion-api/logs');
@@ -34,16 +31,13 @@ export const LogReader = () => {
     } catch (err) {
       setError(`Failed to fetch logs. ${err}`);
     }
-  }, [analytics]);
+  }, [trackFeature]);
 
   const clearLogs = useCallback(async () => {
-    analytics?.trackAnalytic({
-      name: 'cookbook:portal-analytics:logs:clear',
-      value: undefined,
-    });
+    trackFeature('cookbook:portal-analytics:logs:clear');
     await fetch('/@fusion-api/api/clearlogs');
     fetchLogs();
-  }, [fetchLogs, analytics]);
+  }, [fetchLogs, trackFeature]);
 
   // biome-ignore lint/correctness/useExhaustiveDependencies: only run on mount
   useEffect(() => {

packages/react/app/src/analytics/README.md

@@ -1,17 +1,11 @@
 ## Analytics
 
-### useAnalytics
+### useTrackFeature
 
-A hook to send analytic events.
+A hook to send feature used.
 
 ```typescript
-const { trackAnalytic } = useAnalytics();
+const trackFeature = useTrackFeature();
 
-trackAnalytic({
-  name: 'foo',
-  value: 'bar',
-  attributes: {
-    extra: 'data',
-  }
-});
+trackFeature('foo');
 ```

packages/react/app/src/analytics/index.ts

@@ -1 +1 @@
-export { useAnalytics } from './useAnalytics';
+export { useTrackFeature } from './useTrackFeature';

packages/react/app/src/analytics/useAnalytics.ts

@@ -0,0 +1,52 @@
+import { useFrameworkModule } from '@equinor/fusion-framework-react';
+import type { AppModule } from '@equinor/fusion-framework-module-app';
+import type { AnalyticsModule } from '@equinor/fusion-framework-module-analytics';
+import { useCallback } from 'react';
+
+/**
+ * Hook for using analytics module configured in the framework.
+ */
+export const useTrackFeature = () => {
+  const analyticsProvider = useFrameworkModule<AnalyticsModule>('analytics');
+  const appProvider = useFrameworkModule<AppModule>('app');
+  const contextProvider = useFrameworkModule('context');
+  const telemetryProvider = useFrameworkModule('telemetry');
+
+  /**
+   * Tracks a analytics event.
+   *
+   * @param name - The feature to track
+   */
+  const trackFeature = useCallback(
+    (name: string) => {
+      if (!analyticsProvider) {
+        telemetryProvider?.trackException({
+          name: 'AnalyticsProviderNotFound',
+          exception: new Error(`Analytics provider not found`),
+        });
+      }
+
+      analyticsProvider?.trackAnalytic({
+        name: 'app-feature',
+        value: {
+          feature: name,
+        },
+        attributes: {
+          appKey: appProvider?.current?.appKey,
+          context: contextProvider?.currentContext
+            ? {
+                id: contextProvider.currentContext.id,
+                externalId: contextProvider.currentContext.externalId,
+                title: contextProvider.currentContext.title,
+                type: contextProvider.currentContext.type.id,
+                source: contextProvider.currentContext.source,
+              }
+            : undefined,
+        },
+      });
+    },
+    [analyticsProvider, appProvider, contextProvider, telemetryProvider],
+  );
+
+  return trackFeature;
+};