reworked RecordModuleCommand function and started runningprotocolcommand

Opentrons · Mar 4, 2025 · b8beb0e · b8beb0e
1 parent 755839b
commit b8beb0e
Showing 8 changed files with 204 additions and 133 deletions.
diff --git a/app/src/organisms/ModuleCard/HeaterShakerSlideout.tsx b/app/src/organisms/ModuleCard/HeaterShakerSlideout.tsx
@@ -41,9 +41,7 @@ export const HeaterShakerSlideout = (
   const { createLiveCommand } = useCreateLiveCommandMutation()
   const moduleName = getModuleDisplayName(module.moduleModel)
   const modulePart = t('temperature')
-  const {
-    reportModuleCommandCompleted,
-    reportModuleCommandError} = useModuleCommandAnalytics()
+  const { reportModuleCommand} = useModuleCommandAnalytics()
   const serialNumber = module.serialNumber
 
   const sendSetTemperatureCommand: MouseEventHandler<HTMLInputElement> = e => {
@@ -60,17 +58,33 @@ export const HeaterShakerSlideout = (
       }
       createLiveCommand({
         command: setTempCommand,
-      }).then((result)=> {reportModuleCommandCompleted('heaterShaker', 'set-heatershaker-temperature', {status: 'succeeded', data: result}, serialNumber, hsValue)}).catch((e: Error) => {
-        reportModuleCommandError('heatershaker', 'set-heatershaker-temperature', serialNumber, e.message, hsValue)
-        console.error(
-          `error setting module status with command type ${setTempCommand.commandType}: ${e.message}`
-        )
+      }).then((result)=> {
+        reportModuleCommand({
+          moduleType: module.moduleModel,
+          action:'set-heatershaker-temperature',
+          result: {status: 'succeeded', data: result},
+          serialNumber: serialNumber ?? module.serialNumber,
+          temperature: hsValue,
+        });
       })
-    }
+      .catch((e: Error) => {
+        reportModuleCommand({
+          moduleType: module.moduleModel,
+          action: 'set-heatershaker-temperature', 
+          errorDetails: e.message,
+          serialNumber: serialNumber ?? module.serialNumber,
+          temperature: hsValue,
+      });
+
+      console.error(
+        `error setting module status with command type ${setTempCommand.commandType}: ${e.message}`
+      );
+    });
+
     setHsValue(null)
     onCloseClick()
   }
-
+  }
   const errorMessage =
     hsValue != null && (hsValue < HS_TEMP_MIN || hsValue > HS_TEMP_MAX)
       ? t('input_out_of_range')

diff --git a/app/src/organisms/ModuleCard/TemperatureModuleSlideout.tsx b/app/src/organisms/ModuleCard/TemperatureModuleSlideout.tsx
@@ -41,9 +41,7 @@ export const TemperatureModuleSlideout = (
   const name = getModuleDisplayName(module.moduleModel)
   const [temperatureValue, setTemperatureValue] = useState<number | null>(null)
   const handleSubmitTemperature = (): void => {
-  const {
-      reportModuleCommandCompleted,
-      reportModuleCommandError} = useModuleCommandAnalytics()
+  const { reportModuleCommand } = useModuleCommandAnalytics();
   const serialNumber = module.serialNumber
 
     if (temperatureValue != null) {
@@ -56,18 +54,33 @@ export const TemperatureModuleSlideout = (
       }
       createLiveCommand({
         command: saveTempCommand,
-      }).then(result=>reportModuleCommandCompleted('temperatureModule', 'set-temperature-module-temperature', {status:'succeeded', data: result}, serialNumber, temperatureValue)
-      ).catch((e: Error) => {
-        reportModuleCommandError('temperatureModule', 'set-temperature-module-temperature', e.message, serialNumber, temperatureValue)
-        console.error(
-          `error setting module status with command type ${saveTempCommand.commandType}: ${e.message}`
-        )
-      })
-    }
+        })
+        .then((result) => {
+          reportModuleCommand({
+              moduleType: module.moduleModel,
+              action: 'set-temperature-module-temperature',
+              result: {status: 'succeeded', data: result},
+              serialNumber: serialNumber ?? module.serialNumber,
+              temperature: temperatureValue
+            });
+        })
+        .catch((e: Error) => {
+          reportModuleCommand({
+            moduleType: module.moduleModel,
+            action: 'set-temperature-module-temperature', 
+            errorDetails: e.message, 
+            serialNumber: serialNumber ?? module.serialNumber,
+            temperature: temperatureValue
+          });
+
+          console.error(
+            `error setting module status with command type ${saveTempCommand.commandType}: ${e.message}`
+          );
+        });
     setTemperatureValue(null)
     onCloseClick()
-  }
-
+      }
+    }
   const valueOutOfRange =
     temperatureValue != null &&
     (temperatureValue < TEMP_MIN || temperatureValue > TEMP_MAX)

diff --git a/app/src/organisms/ModuleCard/ThermocyclerModuleSlideout.tsx b/app/src/organisms/ModuleCard/ThermocyclerModuleSlideout.tsx
@@ -21,7 +21,6 @@ import {
 
 import { Slideout } from '/app/atoms/Slideout'
 import { SubmitPrimaryButton } from '/app/atoms/buttons'
-
 import type {
   TCSetTargetBlockTemperatureCreateCommand,
   TCSetTargetLidTemperatureCreateCommand,
@@ -46,10 +45,9 @@ export const ThermocyclerModuleSlideout = (
   const moduleName = getModuleDisplayName(module.moduleModel)
   const modulePart = isSecondaryTemp ? 'Lid' : 'Block'
   const tempRanges = getTCTempRange(isSecondaryTemp)
-  const {
-    reportModuleCommandCompleted,
-    reportModuleCommandError} = useModuleCommandAnalytics()
   const serialNumber = module.serialNumber
+  const { reportModuleCommand } = useModuleCommandAnalytics();
+
   let errorMessage
   if (isSecondaryTemp) {
     errorMessage =
@@ -85,61 +83,44 @@ export const ThermocyclerModuleSlideout = (
         command: isSecondaryTemp ? saveLidCommand : saveBlockCommand,
         })
         .then((result) => {
-            if (modulePart === 'Lid') {
-                reportModuleCommandCompleted(
-                    {moduleType: module.moduleModel,
-                    action: 'set-thermocycler-lid-temperature',
-                    result: { status: 'succeeded', data: result },
-                    serialNumber: serialNumber,
-                    temperature: tempValue}
-                );
-            } else if (modulePart === 'Block') {
-                reportModuleCommandCompleted(
-                    {moduleType: module.moduleModel,
-                    action:'set-thermocycler-block-temperature',
-                    result: { status: 'succeeded', data: result },
-                    serialNumber: serialNumber,
-                    temperature: tempValue}
-                );
-            }
-        })
-        .catch((e: Error) => {
-            if (modulePart === 'Lid') {
-                reportModuleCommandError(
-                    {moduleType: module.moduleModel,
-                    action: 'set-thermocycler-lid-temperature',
-                    errorDetails: e.message,
-                    serialNumber: serialNumber,
-                    temperature: tempValue}
-                );
-            } else if (modulePart === 'Block') {
-                reportModuleCommandError(
-                    {module.moduleModel,
-                    'set-thermocycler-block-temperature',
-                    e.message,
-                    serialNumber,
-                    tempValue}
-                );
-            }
+          reportModuleCommand({
+              moduleType: module.moduleModel,
+              action: modulePart === 'Lid'
+                  ? 'set-thermocycler-lid-temperature'
+                  : 'set-thermocycler-block-temperature',
+              result: { status: 'succeeded', data: result },
+              serialNumber: serialNumber ?? module.serialNumber, // Fallback applied
+              temperature: tempValue,
+          });
+      })
+      .catch((e: Error) => {
+          reportModuleCommand({
+              moduleType: module.moduleModel,
+              action: modulePart === 'Lid'
+                  ? 'set-thermocycler-lid-temperature'
+                  : 'set-thermocycler-block-temperature',
+              errorDetails: e.message, // Indicates an error
+              serialNumber: serialNumber ?? module.serialNumber, // Fallback applied
+              temperature: tempValue,
+          });
+
+          console.error(
+              `Error setting module status with command type ${
+                  isSecondaryTemp ? saveLidCommand.commandType : saveBlockCommand.commandType
+              }: ${e.message}`
+          );
+      });
 
-            console.error(
-                `error setting module status with command type ${
-                    isSecondaryTemp ? saveLidCommand.commandType : saveBlockCommand.commandType
-                }: ${e.message}`
-            );
-        });
-    }
-    };
     setTempValue(null)
     onCloseClick()
   }
-
+  }
   const handleCloseSlideout = (): void => {
     setTempValue(null)
     onCloseClick()
   }
 
-  return (
+return (
     <Slideout
       title={t('tc_set_temperature', { part: modulePart, name: moduleName })}
       onCloseClick={handleCloseSlideout}

diff --git a/app/src/organisms/ModuleCard/hooks.tsx b/app/src/organisms/ModuleCard/hooks.tsx
@@ -65,19 +65,33 @@ export function useLatchControls(module: AttachedModule): LatchControls {
       moduleId: module.id,
     },
   }
-  const {reportModuleCommandCompleted, reportModuleCommandError} = useModuleCommandAnalytics()
+  const {reportModuleCommand} = useModuleCommandAnalytics()
   const serialNumber = module.serialNumber
   const toggleLatch = (): void => {
     createLiveCommand({
       command: latchCommand,
-    }).then(result=>reportModuleCommandCompleted(module.moduleModel, 'toggle-hs-latch', {status: "succeeded", data: result},serialNumber, null)).catch((e: Error) => {
-      reportModuleCommandError(module.moduleModel, 'toggle-hs-latch', serialNumber, e.message, null)
+    }).then((result)=> {
+      reportModuleCommand({
+        moduleType: module.moduleModel, 
+        action: 'toggle-hs-latch', 
+        result: {status: "succeeded", data: result},
+        serialNumber: serialNumber ?? module.serialNumber, 
+        temperature: null,
+      });
+    })
+    .catch((e: Error) => {
+      reportModuleCommand({
+        moduleType: module.moduleModel, 
+        action: 'toggle-hs-latch', 
+        errorDetails: e.message,
+        serialNumber: serialNumber ?? module.serialNumber,
+        temperature: null,
+      });
       console.error(
         `error setting module status with command type ${latchCommand.commandType}: ${e.message}`
-      )
-    })
+      );
+    });
   }
-
   return { toggleLatch, isLatchClosed }
 }
 export type MenuItemsByModuleType = {
@@ -210,19 +224,32 @@ export function useModuleOverflowMenu(
         moduleId: module.id,
       },
     }
-    const {reportModuleCommandCompleted, reportModuleCommandError} = useModuleCommandAnalytics()
+    const {reportModuleCommand} = useModuleCommandAnalytics()
     const serialNumber = module.serialNumber
     createLiveCommand({
       command: deactivateCommand,
-    }).then(result=>reportModuleCommandCompleted(module.moduleModel, 'deactivate', {status: 'succeeded', data: result}, serialNumber, null)
-    ).catch((e: Error) => {
-      reportModuleCommandError(module.moduleModel, 'deactivate', e.message, serialNumber,null)
+    }).then((result)=>{
+      reportModuleCommand({
+        moduleType: module.moduleType,
+        action: 'deactivate',
+        result: {status: 'succeeded', data: result},
+        serialNumber: serialNumber ?? module.serialNumber,
+        temperature: null
+      });
+    })
+    .catch((e: Error) => {
+      reportModuleCommand({
+        moduleType: module.moduleModel, 
+        action: 'deactivate',
+        errorDetails: e.message, 
+        serialNumber:  serialNumber ?? module.serialNumber,
+        temperature: null
+      });
       console.error(
         `error setting module status with command type ${deactivateCommand.commandType}: ${e.message}`
-      )
-    })
+      );
+    });
   }
-
   const lidCommand: TCOpenLidCreateCommand | TCCloseLidCreateCommand = {
     commandType:
       module.moduleType === THERMOCYCLER_MODULE_TYPE &&
@@ -233,13 +260,28 @@ export function useModuleOverflowMenu(
       moduleId: module.id,
     },
   }
-  const {reportModuleCommandCompleted, reportModuleCommandError} = useModuleCommandAnalytics()
+  const {reportModuleCommand} = useModuleCommandAnalytics()
   const serialNumber = module.serialNumber
   const controlTCLid = (): void => {
     createLiveCommand({
       command: lidCommand,
-    }).then(result=> reportModuleCommandCompleted(module.moduleModel, 'toggle-tc-lid', {status: "succeeded", data:result}, serialNumber, null)).catch((e: Error) => {
-      reportModuleCommandError(module.moduleModel, 'toggle-tc-lid', serialNumber, e.message, null)
+    }).then((result)=> {
+      reportModuleCommand({
+        moduleType: module.moduleModel,
+        action: 'toggle-tc-lid',
+        result: {status: 'suceeded', data: result},
+        serialNumber: serialNumber ?? module.serialNumber,
+        temperature: null
+      });
+    })
+    .catch((e: Error) => {
+      reportModuleCommand({
+        moduleType: module.moduleModel,
+        action: 'toggle-tc-lid',
+        errorDetails: e.message,
+        serialNumber: serialNumber ?? module.serialNumber,
+        temperature: null,
+      });
       console.error(
         `error setting thermocycler module status with command type ${lidCommand.commandType}: ${e.message}`
       )

diff --git a/app/src/organisms/ODD/ProtocolSetup/ProtocolSetupLabware/index.tsx b/app/src/organisms/ODD/ProtocolSetup/ProtocolSetupLabware/index.tsx
@@ -313,19 +313,23 @@ function LabwareLatch({
     params: { moduleId: matchedHeaterShaker.id },
 
   }
-
+  
   const toggleLatch = (): void => {
     // Record latch toggle to analytics
-    const {
-          reportModuleCommandCompleted,
-          reportModuleCommandError} = useModuleCommandAnalytics()
+    const {reportModuleCommand} = useModuleCommandAnalytics()
     const serialNumber = matchedHeaterShaker.serialNumber
       createLiveCommand({
       command: latchCommand,
       waitUntilComplete: true,
     })
-      .then(result => {
-        reportModuleCommandCompleted('heatershaker', 'toggle-hs-latch', {status:'succeeded', data: result}, serialNumber, null)
+      .then((result) => {
+        reportModuleCommand({
+          moduleType: matchedHeaterShaker.moduleModel, 
+          action:'toggle-hs-latch',
+          result:{status:'succeeded', data: result}, 
+          serialNumber: serialNumber ?? matchedHeaterShaker.serialNumber,
+          temperature: null
+        });
         setIsRefetchingModules(true)
         refetchModules()
           .then(() => {
@@ -339,7 +343,12 @@ function LabwareLatch({
           })
       })
       .catch((e: Error) => {
-        reportModuleCommandError('heatershaker', 'toggle-hs-latch', e.message, serialNumber, null)
+        reportModuleCommand({
+          moduleType: matchedHeaterShaker.moduleType,
+          action: 'toggle-hs-latch',
+          errorDetails: e.message,
+          serialNumber: serialNumber ?? matchedHeaterShaker.serialNumber, 
+          temperature: null});
         console.error(
           `error setting module status with command type ${latchCommand.commandType}: ${e.message}`
         )