feat: implement userpilot analytics plugin and remove segment plugin

Author: cannarocks

src/@types/analytics__segment/index.d.ts

@@ -1,6 +1,6 @@
-import Analytics from 'analytics';
 import googleTagManager from '@analytics/google-tag-manager';
-import segmentPlugin from '@analytics/segment';
+import Analytics from 'analytics';
+import userpilot from './common/analytics-plugins/userpilot';
 import { isDev } from './common/isDevEnvironment';
 
 const analytics = Analytics({
@@ -13,10 +13,8 @@ const analytics = Analytics({
         preview: 'env-4',
       }),
     }),
-    segmentPlugin({
-      writeKey: isDev()
-        ? 'AxHbacd31w50NwjDM8tadsP82hSwTz4Z'
-        : 'oxd3W7coKxDdzq99F88doV5VvQrESbJh',
+    userpilot({
+      token: isDev() ? 'STG-NX-54e88e10' : 'NX-54e88e10',
     }),
   ],
 });

src/analytics.ts

@@ -53,6 +53,7 @@ export const Track = ({
         name: userData.name,
         email: userData.email,
         company: activeWorkspace.company,
+        workspace: activeWorkspace,
       });
 
       track(
@@ -68,8 +69,8 @@ export const Track = ({
         },
         {
           plugins: {
-            // disable track event for segment
-            segment: false,
+            // disable userpilot for this event
+            userpilot: false,
           },
         }
       );

src/common/Track.tsx

@@ -0,0 +1,61 @@
+import { User } from 'src/features/api';
+import { Userpilot } from 'userpilot';
+
+declare global {
+  interface Window {
+    userpilot?: {
+      initialized: number;
+    };
+  }
+}
+
+interface UserpilotConfig {
+  token: string;
+  name?: string;
+}
+
+interface IPayload {
+  type: string;
+  userId: string;
+}
+
+interface IIdentifyPayload extends IPayload {
+  traits: User & { workspace: { id: number; company: string } };
+}
+
+export default function userpilotPlugin(pluginSettings: UserpilotConfig) {
+  return {
+    name: 'userpilot',
+    config: { ...pluginSettings },
+    initialize: ({ config }: { config: UserpilotConfig }) => {
+      Userpilot.initialize(config.token);
+    },
+    identify: ({ payload }: { payload: IIdentifyPayload }) => {
+      const { userId, traits } = payload;
+      const { workspace, ...basicTraits } = traits;
+
+      Userpilot.identify(userId, {
+        ...basicTraits,
+        company: {
+          id: workspace.id,
+          name: workspace.company,
+        },
+      });
+    },
+
+    page: () => {
+      Userpilot.reload();
+    },
+
+    track: ({
+      payload,
+    }: {
+      payload: IPayload & { event: string; properties: Record<string, any> };
+    }) => {
+      const { event, properties, userId } = payload;
+      Userpilot.track(event, { ...properties, userId });
+    },
+
+    loaded: () => !!window.userpilot,
+  };
+}