feat: Capture user agent and referrer analytics (#2349)

* feat: Capture user agent analytics

* feat: Add referrer to analytics

* fix: GraphQL types

editor.planx.uk/package.json

@@ -40,6 +40,7 @@
     "@turf/helpers": "^6.5.0",
     "array-move": "^4.0.0",
     "axios": "0.27.2",
+    "bowser": "^2.11.0",
     "camelcase-keys": "^9.0.0",
     "classnames": "^2.3.2",
     "core-js": "^3.31.0",

editor.planx.uk/src/pages/FlowEditor/lib/analyticsProvider.tsx

@@ -5,6 +5,7 @@ import {
   FlagSet,
 } from "@opensystemslab/planx-core/types";
 import { TYPES } from "@planx/components/types";
+import Bowser from "bowser";
 import { publicClient } from "lib/graphql";
 import React, { createContext, useContext, useEffect, useState } from "react";
 
@@ -129,7 +130,7 @@ export const AnalyticsProvider: React.FC<{ children: React.ReactNode }> = ({
 
   async function track(direction: AnalyticsLogDirection, analyticsId: number) {
     const metadata = getNodeMetadata();
-    const node_title =
+    const nodeTitle =
       node?.type === TYPES.Content
         ? getContentTitle(node)
         : node?.data?.title ?? node?.data?.text ?? node?.data?.flagSet;
@@ -138,7 +139,7 @@ export const AnalyticsProvider: React.FC<{ children: React.ReactNode }> = ({
       direction,
       analyticsId,
       metadata,
-      node_title,
+      nodeTitle,
     );
     const id = result?.data.insert_analytics_logs_one?.id;
     const newLogCreatedAt = result?.data.insert_analytics_logs_one?.created_at;
@@ -156,7 +157,7 @@ export const AnalyticsProvider: React.FC<{ children: React.ReactNode }> = ({
     direction: AnalyticsLogDirection,
     analyticsId: number,
     metadata: NodeMetadata,
-    node_title: string,
+    nodeTitle: string,
   ) {
     const result = await publicClient.mutate({
       mutation: gql`
@@ -166,6 +167,7 @@ export const AnalyticsProvider: React.FC<{ children: React.ReactNode }> = ({
           $metadata: jsonb
           $node_type: Int
           $node_title: String
+          $user_agent: jsonb
         ) {
           insert_analytics_logs_one(
             object: {
@@ -187,7 +189,7 @@ export const AnalyticsProvider: React.FC<{ children: React.ReactNode }> = ({
         analytics_id: analyticsId,
         metadata: metadata,
         node_type: node?.type,
-        node_title: node_title,
+        node_title: nodeTitle,
       },
     });
     return result;
@@ -287,17 +289,34 @@ export const AnalyticsProvider: React.FC<{ children: React.ReactNode }> = ({
 
   async function createAnalytics(type: AnalyticsType) {
     if (shouldTrackAnalytics) {
+      const userAgent = Bowser.parse(window.navigator.userAgent);
+      const referrer = document.referrer || null;
+
       const response = await publicClient.mutate({
         mutation: gql`
-          mutation InsertNewAnalytics($type: String, $flow_id: uuid) {
-            insert_analytics_one(object: { type: $type, flow_id: $flow_id }) {
+          mutation InsertNewAnalytics(
+            $type: String
+            $flow_id: uuid
+            $user_agent: jsonb
+            $referrer: String
+          ) {
+            insert_analytics_one(
+              object: {
+                type: $type
+                flow_id: $flow_id
+                user_agent: $user_agent
+                referrer: $referrer
+              }
+            ) {
               id
             }
           }
         `,
         variables: {
           type,
           flow_id: flowId,
+          user_agent: userAgent,
+          referrer,
         },
       });
       const id = response.data.insert_analytics_one.id;

hasura.planx.uk/metadata/tables.yaml

@@ -9,7 +9,9 @@
           - created_at
           - flow_id
           - id
+          - referrer
           - type
+          - user_agent
   select_permissions:
     - role: public
       permission:

hasura.planx.uk/migrations/1698350858952_alter_table_public_analytics_logs_add_column_user_agent/down.sql

@@ -0,0 +1,3 @@
+ALTER TABLE "public"."analytics" DROP COLUMN "referrer"
+
+ALTER TABLE "public"."analytics" DROP COLUMN "user_agent"

hasura.planx.uk/migrations/1698350858952_alter_table_public_analytics_logs_add_column_user_agent/up.sql

@@ -0,0 +1,5 @@
+alter table "public"."analytics" add column "user_agent" jsonb
+ null default '{}';
+
+alter table "public"."analytics" add column "referrer" text
+ null;