📈 add appEnv parameter to logging events for environment tracking.

liam-hq · Dec 20, 2024 · 6392dc5 · 6392dc5
1 parent 5060068
commit 6392dc5
Show file tree

Hide file tree

Showing 18 changed files with 49 additions and 13 deletions.
diff --git a/frontend/.changeset/mean-eels-suffer.md b/frontend/.changeset/mean-eels-suffer.md
@@ -0,0 +1,6 @@
+---
+"@liam-hq/erd-core": patch
+"@liam-hq/cli": patch
+---
+
+📈 Add appEnv parameter to logging events for environment tracking
diff --git a/...end/packages/erd-core/src/components/ERDRenderer/AppBar/CopyLinkButton/CopyLinkButton.tsx b/...end/packages/erd-core/src/components/ERDRenderer/AppBar/CopyLinkButton/CopyLinkButton.tsx
@@ -34,8 +34,9 @@ export const CopyLinkButton: FC = () => {
     clickLogEvent({
       element: 'copyLinkButton',
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
-  }, [toast, cliVersion.version])
+  }, [toast, cliVersion.version, cliVersion.envName])
 
   return (
     <TooltipProvider>

diff --git a/frontend/packages/erd-core/src/components/ERDRenderer/ERDContent/ERDContent.tsx b/frontend/packages/erd-core/src/components/ERDRenderer/ERDContent/ERDContent.tsx
@@ -91,9 +91,10 @@ export const ERDContentInner: FC<Props> = ({
         ref: 'mainArea',
         tableId,
         cliVer: cliVersion.version,
+        appEnv: cliVersion.envName,
       })
     },
-    [cliVersion.version],
+    [cliVersion.version, cliVersion.envName],
   )
 
   const handlePaneClick = useCallback(() => {
@@ -137,10 +138,11 @@ export const ERDContentInner: FC<Props> = ({
           tableId,
           operationId,
           cliVer: cliVersion.version,
+          appEnv: cliVersion.envName,
         })
       }
     },
-    [cliVersion.version],
+    [cliVersion.version, cliVersion.envName],
   )
 
   const panOnDrag = [1, 2]

diff --git a/...c/components/ERDRenderer/ERDContent/TableNode/TableDetail/RelatedTables/RelatedTables.tsx b/...c/components/ERDRenderer/ERDContent/TableNode/TableDetail/RelatedTables/RelatedTables.tsx
@@ -39,8 +39,9 @@ export const RelatedTables: FC<Props> = ({ table }) => {
     openRelatedTablesLogEvent({
       tableId: table.name,
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
-  }, [nodes, getNodes, table.name, cliVersion.version])
+  }, [nodes, getNodes, table.name, cliVersion.version, cliVersion.envName])
 
   return (
     <div className={styles.wrapper}>

diff --git a/...ages/erd-core/src/components/ERDRenderer/ERDContent/TableNode/TableDetail/TableDetail.tsx b/...ages/erd-core/src/components/ERDRenderer/ERDContent/TableNode/TableDetail/TableDetail.tsx
@@ -20,6 +20,7 @@ export const TableDetail: FC<Props> = ({ table }) => {
     clickLogEvent({
       element: 'closeTableDetailButton',
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
   }
 

diff --git a/...es/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/FitviewButton/FitviewButton.tsx b/...es/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/FitviewButton/FitviewButton.tsx
@@ -16,9 +16,10 @@ export const FitviewButton: FC = () => {
       element: 'fitview',
       showMode,
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
     fitView()
-  }, [fitView, showMode, cliVersion.version])
+  }, [fitView, showMode, cliVersion.version, cliVersion.envName])
 
   return (
     <ToolbarButton asChild onClick={handleClick}>

diff --git a/...ages/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/ShowModeMenu/ShowModeMenu.tsx b/...ages/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/ShowModeMenu/ShowModeMenu.tsx
@@ -37,10 +37,11 @@ export const ShowModeMenu: FC = () => {
           element: 'changeShowMode',
           showMode: value,
           cliVer: cliVersion.version,
+          appEnv: cliVersion.envName,
         })
       }
     },
-    [cliVersion.version],
+    [cliVersion.version, cliVersion.envName],
   )
 
   return (

diff --git a/...ages/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/TidyUpButton/TidyUpButton.tsx b/...ages/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/TidyUpButton/TidyUpButton.tsx
@@ -17,9 +17,10 @@ export const TidyUpButton: FC = () => {
       element: 'tidyUp',
       showMode,
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
     handleLayout(getNodes())
-  }, [handleLayout, showMode, getNodes, cliVersion.version])
+  }, [handleLayout, showMode, getNodes, cliVersion.version, cliVersion.envName])
 
   return (
     <ToolbarButton asChild>

diff --git a/...ages/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/ZoomControls/ZoomControls.tsx b/...ages/erd-core/src/components/ERDRenderer/ERDContent/Toolbar/ZoomControls/ZoomControls.tsx
@@ -19,19 +19,21 @@ export const ZoomControls: FC = () => {
       zoomLevel: zoomLevel.toFixed(2),
       showMode,
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
     zoomOut()
-  }, [zoomOut, zoomLevel, showMode, cliVersion.version])
+  }, [zoomOut, zoomLevel, showMode, cliVersion.version, cliVersion.envName])
 
   const handleClickZoomIn = useCallback(() => {
     toolbarActionLogEvent({
       element: 'zoom',
       zoomLevel: zoomLevel.toFixed(2),
       showMode: showMode,
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
     zoomIn()
-  }, [zoomIn, zoomLevel, showMode, cliVersion.version])
+  }, [zoomIn, zoomLevel, showMode, cliVersion.version, cliVersion.envName])
 
   return (
     <div className={styles.wrapper}>

diff --git a/frontend/packages/erd-core/src/components/ERDRenderer/ERDRenderer.tsx b/frontend/packages/erd-core/src/components/ERDRenderer/ERDRenderer.tsx
@@ -39,9 +39,10 @@ export const ERDRenderer: FC = () => {
         element: 'leftPane',
         isShow: open,
         cliVer: cliVersion.version,
+        appEnv: cliVersion.envName,
       })
     },
-    [cliVersion.version],
+    [cliVersion.version, cliVersion.envName],
   )
 
   return (

diff --git a/.../erd-core/src/components/ERDRenderer/LeftPane/TableNameMenuButton/TableNameMenuButton.tsx b/.../erd-core/src/components/ERDRenderer/LeftPane/TableNameMenuButton/TableNameMenuButton.tsx
@@ -27,6 +27,7 @@ export const TableNameMenuButton: FC<Props> = ({ node }) => {
       ref: 'leftPane',
       tableId,
       cliVer: cliVersion.version,
+      appEnv: cliVersion.envName,
     })
   }
 

diff --git a/...ges/erd-core/src/components/ERDRenderer/LeftPane/TableNameMenuButton/VisibilityButton.tsx b/...ges/erd-core/src/components/ERDRenderer/LeftPane/TableNameMenuButton/VisibilityButton.tsx
@@ -21,9 +21,10 @@ export const VisibilityButton: FC<Props> = ({ tableName, hidden }) => {
         isShow: !!hidden,
         tableId: tableName,
         cliVer: cliVersion.version,
+        appEnv: cliVersion.envName,
       })
     },
-    [tableName, hidden, cliVersion.version],
+    [tableName, hidden, cliVersion.version, cliVersion.envName],
   )
 
   return (

diff --git a/frontend/packages/erd-core/src/features/gtm/utils/clickLogEvent.ts b/frontend/packages/erd-core/src/features/gtm/utils/clickLogEvent.ts
@@ -3,12 +3,14 @@ import { pushToDataLayer } from './pushToDataLayer'
 type ClickLogEvent = {
   element: string
   cliVer: string
+  appEnv: string
 }
 
-export const clickLogEvent = ({ element, cliVer }: ClickLogEvent) => {
+export const clickLogEvent = ({ element, cliVer, appEnv }: ClickLogEvent) => {
   pushToDataLayer({
     event: 'click',
     element,
     cliVer,
+    appEnv,
   })
 }
diff --git a/frontend/packages/erd-core/src/features/gtm/utils/openRelatedTablesLogEvent.ts b/frontend/packages/erd-core/src/features/gtm/utils/openRelatedTablesLogEvent.ts
@@ -3,15 +3,18 @@ import { pushToDataLayer } from './pushToDataLayer'
 type OpenRelatedTablesLogEvent = {
   tableId: string
   cliVer: string
+  appEnv: string
 }
 
 export const openRelatedTablesLogEvent = ({
   tableId,
   cliVer,
+  appEnv,
 }: OpenRelatedTablesLogEvent) => {
   pushToDataLayer({
     event: 'openRelatedTables',
     tableId,
     cliVer,
+    appEnv,
   })
 }
diff --git a/frontend/packages/erd-core/src/features/gtm/utils/repositionTableLogEvent.ts b/frontend/packages/erd-core/src/features/gtm/utils/repositionTableLogEvent.ts
@@ -4,17 +4,20 @@ type RepositionTable = {
   tableId: string
   operationId: string
   cliVer: string
+  appEnv: string
 }
 
 export const repositionTableLogEvent = ({
   tableId,
   operationId,
   cliVer,
+  appEnv,
 }: RepositionTable) => {
   pushToDataLayer({
     event: 'repositionTable',
     tableId,
     operationId,
     cliVer,
+    appEnv,
   })
 }
diff --git a/frontend/packages/erd-core/src/features/gtm/utils/selectTableLogEvent.ts b/frontend/packages/erd-core/src/features/gtm/utils/selectTableLogEvent.ts
@@ -4,13 +4,20 @@ type SelectTable = {
   ref: 'leftPane' | 'mainArea'
   tableId: string
   cliVer: string
+  appEnv: string
 }
 
-export const selectTableLogEvent = ({ ref, tableId, cliVer }: SelectTable) => {
+export const selectTableLogEvent = ({
+  ref,
+  tableId,
+  cliVer,
+  appEnv,
+}: SelectTable) => {
   pushToDataLayer({
     event: 'selectTable',
     ref,
     tableId,
     cliVer,
+    appEnv,
   })
 }
diff --git a/frontend/packages/erd-core/src/features/gtm/utils/toggleLogEvent.ts b/frontend/packages/erd-core/src/features/gtm/utils/toggleLogEvent.ts
@@ -5,6 +5,7 @@ type ToggleLogEvent = {
   isShow: boolean
   tableId?: string
   cliVer: string
+  appEnv: string
 }
 
 export const toggleLogEvent = (params: ToggleLogEvent) => {

diff --git a/frontend/packages/erd-core/src/features/gtm/utils/toolbarActionLogEvent.ts b/frontend/packages/erd-core/src/features/gtm/utils/toolbarActionLogEvent.ts
@@ -5,6 +5,7 @@ type ToolbarActionLogEvent = {
   zoomLevel?: string
   showMode?: string
   cliVer: string
+  appEnv: string
 }
 
 export const toolbarActionLogEvent = ({