fix: interactions now send array of paths

aidenybai · Dec 12, 2024 · a454649 · a454649
1 parent d9cd5c2
commit a454649
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/packages/scan/src/core/monitor/index.ts b/packages/scan/src/core/monitor/index.ts
@@ -36,8 +36,10 @@ export interface MonitoringProps {
   branch?: string | null;
 }
 
-export interface MonitoringWithoutRouteProps
-  extends Omit<MonitoringProps, 'route' | 'path'> {}
+export type MonitoringWithoutRouteProps = Omit<
+  MonitoringProps,
+  'route' | 'path'
+>;
 
 export const Monitoring = ({
   url,

diff --git a/packages/scan/src/core/monitor/network.ts b/packages/scan/src/core/monitor/network.ts
@@ -9,7 +9,7 @@ import { getSession } from './utils';
 import type { Interaction, IngestRequest, InternalInteraction } from './types';
 
 const getInteractionId = (interaction: InternalInteraction) =>
-  `${interaction.performanceEntry.type}::${interaction.componentPath}::${interaction.url}`;
+  `${interaction.performanceEntry.type}::<REPLACED_PATH>::${interaction.url}`; // We replace the path with <REPLACED_PATH> in production
 
 const INTERACTION_TIME_TILL_COMPLETED = 4000;
 
@@ -71,6 +71,7 @@ const toPayloadInteraction = (interactions: Array<InternalInteraction>) =>
     (interaction) =>
       ({
         id: getInteractionId(interaction),
+        path: interaction.componentPath,
         name: interaction.componentName,
         time: interaction.performanceEntry.duration,
         timestamp: interaction.performanceEntry.timestamp,

diff --git a/packages/scan/src/core/monitor/performance.ts b/packages/scan/src/core/monitor/performance.ts
@@ -98,8 +98,8 @@ const isMinified = (name: string): boolean => {
 export function getInteractionPath(
   fiber: Fiber | null,
   filters: PathFilters = DEFAULT_FILTERS,
-): string {
-  if (!fiber) return '';
+): Array<string> {
+  if (!fiber) return [];
 
   const fullPath: Array<string> = [];
 
@@ -119,8 +119,7 @@ export function getInteractionPath(
     current = current.return;
   }
 
-  const normalized = normalizePath(fullPath);
-  return normalized;
+  return fullPath;
 }
 
 let currentMouseOver: Element;
@@ -132,7 +131,7 @@ function getCleanComponentName(component: any): string {
   return name.replace(/^(Memo|Forward(Ref)?|With.*?)\((.*?)\)$/, '$3');
 }
 
-function normalizePath(path: Array<string>): string {
+export function normalizePath(path: Array<string>): string {
   const cleaned = path.filter(Boolean);
 
   const deduped = cleaned.filter((name, i) => name !== cleaned[i - 1]);

diff --git a/packages/scan/src/core/monitor/types.ts b/packages/scan/src/core/monitor/types.ts
@@ -23,6 +23,7 @@ export interface Session {
 
 export interface Interaction {
   id: string; // a hashed unique id for interaction (groupable across sessions)
+  path: Array<string>; // the path of the interaction
   name: string; // name of interaction (i.e nav#top-menu.sc-601d0142-19.gHiJkL) or something useful
   type: string; // type of interaction i.e pointer
   time: number; // time of interaction in ms
@@ -63,7 +64,7 @@ export interface InternalInteraction {
   commit: string | null;
   branch: string | null;
   uniqueInteractionId: string;
-  componentPath: string;
+  componentPath: Array<string>;
   performanceEntry: PerformanceInteraction;
   components: Map<string, InternalComponentCollection>;
 }