Merge pull request #1023 from near/log_clientside_referrer

 listen to route change events to track the referring url for client side routing

src/pages/_app.tsx

@@ -20,7 +20,7 @@ import { useBosComponents } from '@/hooks/useBosComponents';
 import { useHashUrlBackwardsCompatibility } from '@/hooks/useHashUrlBackwardsCompatibility';
 import { usePageAnalytics } from '@/hooks/usePageAnalytics';
 import { useAuthStore } from '@/stores/auth';
-import { init as initializeAnalytics } from '@/utils/analytics';
+import { init as initializeAnalytics, setReferrer } from '@/utils/analytics';
 import { setNotificationsLocalStorage } from '@/utils/notificationsLocalStorage';
 import type { NextPageWithLayout } from '@/utils/types';
 import { styleZendesk } from '@/utils/zendesk';
@@ -54,6 +54,13 @@ export default function App({ Component, pageProps }: AppPropsWithLayout) {
     }
   }, [signedIn]);
 
+  useEffect(() => {
+    router.events.on('routeChangeStart', () => {
+      //save a reference to the currentl URL before the route change event completes
+      setReferrer(window.location.href);
+    });
+  });
+
   useEffect(() => {
     initializeAnalytics();
   }, []);

src/utils/analytics.ts

@@ -13,13 +13,18 @@ let hashId = '';
 let anonymousUserIdCreatedAt = '';
 let pendingEvents: any = [];
 let cookieOptOut = false;
+let clientsideReferrer = '';
 
 declare global {
   interface Window {
     rudderAnalytics: Analytics | undefined;
   }
 }
 
+export function setReferrer(referrer: string) {
+  clientsideReferrer = referrer;
+}
+
 export function setAccountIdHash(accountId: string) {
   const hash = createHash('sha512');
   hash.update(accountId);
@@ -115,6 +120,7 @@ export function recordPageView(pageName: string) {
       url: filterURL(window.location.href),
       userAgentDetail,
       ref: filterURL(document.referrer),
+      clientsideReferrer,
     });
   } catch (e) {
     console.error(e);
@@ -128,6 +134,7 @@ const record = (eventType: string, e: UIEvent | PointerEvent) => {
     url: e.target ? filterURL((e.target as HTMLElement).baseURI) : '',
     xPath: getXPath(e.target as HTMLElement),
     componentSrc: getComponentName(e.target as HTMLElement),
+    clientsideReferrer,
   });
 };
 export const recordClick = (e: UIEvent | PointerEvent) => record('click', e);
@@ -163,6 +170,7 @@ export function recordEventWithProps(eventLabel: string, properties: Record<stri
       userAgentDetail,
       hashId: localStorage.getItem('hashId'),
       anonymousUserIdCreatedAt,
+      clientsideReferrer,
     });
   } catch (e) {
     console.error(e);
@@ -181,6 +189,7 @@ export function recordEvent(eventLabel: string) {
       url: window.location.href,
       userAgentDetail,
       anonymousUserIdCreatedAt,
+      clientsideReferrer,
     });
   } catch (e) {
     console.error(e);