fix(app): Delineate failed command source

app/src/molecules/Command/hooks/useCommandTextString/utils/getPipettingCommandText.ts

@@ -48,6 +48,7 @@ export const getPipettingCommandText = ({
           robotType
         )
       : ''
+
   switch (command?.commandType) {
     case 'aspirate': {
       const { volume, flowRate } = command.params

app/src/molecules/InterventionModal/CategorizedStepContent.tsx

@@ -111,35 +111,42 @@ export function CategorizedStepContent(
         justifyContent={JUSTIFY_FLEX_START}
         gap={SPACING.spacing4}
       >
-        <StyledText oddStyle="bodyTextSemiBold" desktopStyle="captionSemiBold">
-          {props.bottomCategoryHeadline}
-        </StyledText>
-        {props.bottomCategoryCommands.map((command, idx) => (
-          <Flex
-            gap={SPACING.spacing8}
-            key={`${props.bottomCategory}${
-              command?.command?.commandType ?? 'unknown'
-            }${idx}`}
-            css={idx > 0 ? HIDE_ON_TOUCHSCREEN_STYLE : undefined}
+        {props.bottomCategoryCommands[0] != null ? (
+          <StyledText
+            oddStyle="bodyTextSemiBold"
+            desktopStyle="captionSemiBold"
           >
-            <CommandIndex
-              index={`${
-                command?.index == null ? '' : command.index.toString()
-              }`}
-              allowSpaceForNDigits={maxIndexLength}
-            />
-            <Command
-              {...commandAndState(
-                command,
-                props.bottomCategory,
-                props.commandTextData
-              )}
-              robotType={props.robotType}
-              aligned="left"
-              forceTwoLineClip
-            />
-          </Flex>
-        ))}
+            {props.bottomCategoryHeadline}
+          </StyledText>
+        ) : null}
+        {props.bottomCategoryCommands.map((command, idx) => {
+          return command != null ? (
+            <Flex
+              gap={SPACING.spacing8}
+              key={`${props.bottomCategory}${
+                command?.command?.commandType ?? 'unknown'
+              }${idx}`}
+              css={idx > 0 ? HIDE_ON_TOUCHSCREEN_STYLE : undefined}
+            >
+              <CommandIndex
+                index={`${
+                  command?.index == null ? '' : command.index.toString()
+                }`}
+                allowSpaceForNDigits={maxIndexLength}
+              />
+              <Command
+                {...commandAndState(
+                  command,
+                  props.bottomCategory,
+                  props.commandTextData
+                )}
+                robotType={props.robotType}
+                aligned="left"
+                forceTwoLineClip
+              />
+            </Flex>
+          ) : null
+        })}
       </Flex>
     </Flex>
   )

app/src/organisms/Devices/ProtocolRun/ProtocolRunHeader.tsx

@@ -320,7 +320,7 @@ export function ProtocolRunHeader({
         <ErrorRecoveryFlows
           runStatus={runStatus}
           runId={runId}
-          failedCommand={failedCommand}
+          failedCommandByRunRecord={failedCommand}
           protocolAnalysis={robotProtocolAnalysis}
         />
       ) : null}

app/src/organisms/ErrorRecoveryFlows/ErrorRecoveryWizard.tsx

@@ -29,7 +29,11 @@ import { RECOVERY_MAP } from './constants'
 
 import type { RobotType } from '@opentrons/shared-data'
 import type { RecoveryContentProps } from './types'
-import type { ERUtilsResults, UseRecoveryAnalyticsResult } from './hooks'
+import type {
+  ERUtilsResults,
+  UseRecoveryAnalyticsResult,
+  useRetainedFailedCommandBySource,
+} from './hooks'
 import type { ErrorRecoveryFlowsProps } from '.'
 
 export interface UseERWizardResult {
@@ -65,6 +69,7 @@ export type ErrorRecoveryWizardProps = ErrorRecoveryFlowsProps &
     isOnDevice: boolean
     isDoorOpen: boolean
     analytics: UseRecoveryAnalyticsResult
+    failedCommand: ReturnType<typeof useRetainedFailedCommandBySource>
   }
 
 export function ErrorRecoveryWizard(
@@ -76,7 +81,7 @@ export function ErrorRecoveryWizard(
     recoveryCommands,
     routeUpdateActions,
   } = props
-  const errorKind = getErrorKind(failedCommand)
+  const errorKind = getErrorKind(failedCommand?.byRunRecord ?? null)
 
   useInitialPipetteHome({
     hasLaunchedRecovery,

app/src/organisms/ErrorRecoveryFlows/RecoveryOptions/ManageTips.tsx

@@ -213,7 +213,7 @@ export function useDropTipFlowUtils({
   const { selectedRecoveryOption } = currentRecoveryOptionUtils
   const { proceedToRouteAndStep } = routeUpdateActions
   const { updateSubMap, subMap } = subMapUtils
-  const failedCommandId = failedCommand?.id ?? '' // We should have a failed command here unless the run is not in AWAITING_RECOVERY.
+  const failedCommandId = failedCommand?.byRunRecord.id ?? '' // We should have a failed command here unless the run is not in AWAITING_RECOVERY.
 
   const buildTipDropCompleteBtn = (): string => {
     switch (selectedRecoveryOption) {

app/src/organisms/ErrorRecoveryFlows/RecoveryOptions/__tests__/ManageTips.test.tsx

@@ -210,7 +210,11 @@ describe('useDropTipFlowUtils', () => {
     const { result } = renderHook(() =>
       useDropTipFlowUtils({
         ...mockProps,
-        failedCommand: { id: 'MOCK_COMMAND_ID' },
+        failedCommand: {
+          byRunRecord: {
+            id: 'MOCK_COMMAND_ID',
+          },
+        },
       } as any)
     )
 

app/src/organisms/ErrorRecoveryFlows/RunPausedSplash.tsx

@@ -37,6 +37,7 @@ import type {
   ERUtilsResults,
   UseRecoveryAnalyticsResult,
   UseRecoveryTakeoverResult,
+  useRetainedFailedCommandBySource,
 } from './hooks'
 
 export function useRunPausedSplash(
@@ -54,7 +55,7 @@ export function useRunPausedSplash(
 
 type RunPausedSplashProps = ERUtilsResults & {
   isOnDevice: boolean
-  failedCommand: ErrorRecoveryFlowsProps['failedCommand']
+  failedCommand: ReturnType<typeof useRetainedFailedCommandBySource>
   protocolAnalysis: ErrorRecoveryFlowsProps['protocolAnalysis']
   robotType: RobotType
   robotName: string
@@ -73,7 +74,7 @@ export function RunPausedSplash(
     robotName,
   } = props
   const { t } = useTranslation('error_recovery')
-  const errorKind = getErrorKind(failedCommand)
+  const errorKind = getErrorKind(failedCommand?.byRunRecord ?? null)
   const title = useErrorName(errorKind)
 
   const { proceedToRouteAndStep } = routeUpdateActions

app/src/organisms/ErrorRecoveryFlows/__fixtures__/index.ts

@@ -51,9 +51,13 @@ export const mockPickUpTipLabware: LoadedLabware = {
   displayName: 'MOCK_PickUpTipLabware_NAME',
 }
 
-// TOME: Add the mock labware and pipette, etc. as you end up using it elsewhere to here.
+// TODO: jh(08-07-24): update the "byAnalysis" mockFailedCommand.
 export const mockRecoveryContentProps: RecoveryContentProps = {
-  failedCommand: mockFailedCommand,
+  failedCommandByRunRecord: mockFailedCommand,
+  failedCommand: {
+    byRunRecord: mockFailedCommand,
+    byAnalysis: mockFailedCommand,
+  },
   errorKind: 'GENERAL_ERROR',
   robotType: FLEX_ROBOT_TYPE,
   runId: 'MOCK_RUN_ID',

app/src/organisms/ErrorRecoveryFlows/__tests__/ErrorRecoveryFlows.test.tsx

@@ -138,7 +138,7 @@ describe('ErrorRecoveryFlows', () => {
   beforeEach(() => {
     props = {
       runStatus: RUN_STATUS_AWAITING_RECOVERY,
-      failedCommand: mockFailedCommand,
+      failedCommandByRunRecord: mockFailedCommand,
       runId: 'MOCK_RUN_ID',
       protocolAnalysis: {} as any,
     }
@@ -218,9 +218,11 @@ describe('ErrorRecoveryFlows', () => {
 
     const newProps = {
       ...props,
-      failedCommand: null,
+      failedCommandByRunRecord: null,
     }
     rerender(<ErrorRecoveryFlows {...newProps} />)
-    expect(mockReportErrorEvent).toHaveBeenCalledWith(newProps.failedCommand)
+    expect(mockReportErrorEvent).toHaveBeenCalledWith(
+      newProps.failedCommandByRunRecord
+    )
   })
 })

app/src/organisms/ErrorRecoveryFlows/__tests__/RunPausedSplash.test.tsx

@@ -100,9 +100,11 @@ describe('RunPausedSplash', () => {
     props = {
       ...props,
       failedCommand: {
-        ...props.failedCommand,
-        commandType: 'aspirate',
-        error: { isDefined: true, errorType: 'overpressure' },
+        byRunRecord: {
+          ...props.failedCommand?.byRunRecord,
+          commandType: 'aspirate',
+          error: { isDefined: true, errorType: 'overpressure' },
+        },
       } as any,
     }
     render(props)

app/src/organisms/ErrorRecoveryFlows/hooks/__tests__/useFailedLabwareUtils.test.ts

@@ -85,7 +85,7 @@ describe('getRelevantFailedLabwareCmdFrom', () => {
       },
     }
     const result = getRelevantFailedLabwareCmdFrom({
-      failedCommand: failedLiquidProbeCommand,
+      failedCommandByRunRecord: failedLiquidProbeCommand,
     })
     expect(result).toEqual(failedLiquidProbeCommand)
   })
@@ -110,7 +110,7 @@ describe('getRelevantFailedLabwareCmdFrom', () => {
 
     overpressureErrorKinds.forEach(([commandType, errorType]) => {
       const result = getRelevantFailedLabwareCmdFrom({
-        failedCommand: {
+        failedCommandByRunRecord: {
           ...failedCommand,
           commandType,
           error: { isDefined: true, errorType },
@@ -122,7 +122,7 @@ describe('getRelevantFailedLabwareCmdFrom', () => {
   })
   it('should return null for GENERAL_ERROR error kind', () => {
     const result = getRelevantFailedLabwareCmdFrom({
-      failedCommand: {
+      failedCommandByRunRecord: {
         ...failedCommand,
         error: { errorType: 'literally anything else' },
       },
@@ -132,7 +132,7 @@ describe('getRelevantFailedLabwareCmdFrom', () => {
 
   it('should return null for unhandled error kinds', () => {
     const result = getRelevantFailedLabwareCmdFrom({
-      failedCommand: {
+      failedCommandByRunRecord: {
         ...failedCommand,
         error: { errorType: 'SOME_UNHANDLED_ERROR' },
       },

app/src/organisms/ErrorRecoveryFlows/hooks/__tests__/useRecoveryCommands.test.ts

@@ -46,7 +46,7 @@ describe('useRecoveryCommands', () => {
 
   const props = {
     runId: mockRunId,
-    failedCommand: mockFailedCommand,
+    failedCommandByRunRecord: mockFailedCommand,
     failedLabwareUtils: mockFailedLabwareUtils,
     routeUpdateActions: mockRouteUpdateActions,
     recoveryToastUtils: { makeSuccessToast: mockMakeSuccessToast } as any,
@@ -132,7 +132,7 @@ describe('useRecoveryCommands', () => {
       const { result } = renderHook(() =>
         useRecoveryCommands({
           runId: mockRunId,
-          failedCommand: {
+          failedCommandByRunRecord: {
             ...mockFailedCommand,
             commandType: inPlaceCommandType,
             params: {
@@ -230,7 +230,7 @@ describe('useRecoveryCommands', () => {
 
     const testProps = {
       ...props,
-      failedCommand: mockFailedCmdWithPipetteId,
+      failedCommandByRunRecord: mockFailedCmdWithPipetteId,
       failedLabwareUtils: {
         ...mockFailedLabwareUtils,
         failedLabware: mockFailedLabware,
@@ -271,7 +271,7 @@ describe('useRecoveryCommands', () => {
 
     const testProps = {
       ...props,
-      failedCommand: mockFailedCommandWithError,
+      failedCommandByRunRecord: mockFailedCommandWithError,
     }
 
     const { result } = renderHook(() => useRecoveryCommands(testProps))

app/src/organisms/ErrorRecoveryFlows/hooks/index.ts

@@ -7,6 +7,7 @@ export { useRouteUpdateActions } from './useRouteUpdateActions'
 export { useERUtils } from './useERUtils'
 export { useRecoveryAnalytics } from './useRecoveryAnalytics'
 export { useRecoveryTakeover } from './useRecoveryTakeover'
+export { useRetainedFailedCommandBySource } from './useRetainedFailedCommandBySource'
 
 export type { UseRouteUpdateActionsResult } from './useRouteUpdateActions'
 export type { UseRecoveryCommandsResult } from './useRecoveryCommands'
@@ -15,3 +16,4 @@ export type { ERUtilsResults } from './useERUtils'
 export type { UseFailedLabwareUtilsResult } from './useFailedLabwareUtils'
 export type { UseRecoveryAnalyticsResult } from './useRecoveryAnalytics'
 export type { UseRecoveryTakeoverResult } from './useRecoveryTakeover'
+export type { FailedCommandBySource } from './useRetainedFailedCommandBySource'

app/src/organisms/ErrorRecoveryFlows/hooks/useCurrentlyRecoveringFrom.ts

@@ -12,6 +12,13 @@ import type { FailedCommand } from '../types'
 
 const ALL_COMMANDS_POLL_MS = 5000
 
+// TODO(jh, 08-06-24): See EXEC-656.
+const VALID_RECOVERY_FETCH_STATUSES = [
+  RUN_STATUS_AWAITING_RECOVERY,
+  RUN_STATUS_AWAITING_RECOVERY_BLOCKED_BY_OPEN_DOOR,
+  RUN_STATUS_AWAITING_RECOVERY_PAUSED,
+] as Array<RunStatus | null>
+
 // Return the `currentlyRecoveringFrom` command returned by the server, if any.
 // Otherwise, returns null.
 export function useCurrentlyRecoveringFrom(
@@ -20,11 +27,7 @@ export function useCurrentlyRecoveringFrom(
 ): FailedCommand | null {
   // There can only be a currentlyRecoveringFrom command when the run is in recovery mode.
   // In case we're falling back to polling, only enable queries when that is the case.
-  const isRunInRecoveryMode = ([
-    RUN_STATUS_AWAITING_RECOVERY,
-    RUN_STATUS_AWAITING_RECOVERY_BLOCKED_BY_OPEN_DOOR,
-    RUN_STATUS_AWAITING_RECOVERY_PAUSED,
-  ] as Array<RunStatus | null>).includes(runStatus)
+  const isRunInRecoveryMode = VALID_RECOVERY_FETCH_STATUSES.includes(runStatus)
 
   const { data: allCommandsQueryData } = useNotifyAllCommandsQuery(
     runId,

app/src/organisms/ErrorRecoveryFlows/hooks/useERUtils.ts

@@ -34,13 +34,15 @@ import type { RecoveryActionMutationResult } from './useRecoveryActionMutation'
 import type { StepCounts } from '../../../resources/protocols/hooks'
 import type { UseRecoveryAnalyticsResult } from './useRecoveryAnalytics'
 import type { UseRecoveryTakeoverResult } from './useRecoveryTakeover'
+import type { useRetainedFailedCommandBySource } from './useRetainedFailedCommandBySource'
 
-type ERUtilsProps = ErrorRecoveryFlowsProps & {
+export type ERUtilsProps = Omit<ErrorRecoveryFlowsProps, 'failedCommand'> & {
   toggleERWizAsActiveUser: UseRecoveryTakeoverResult['toggleERWizAsActiveUser']
   hasLaunchedRecovery: boolean
   isOnDevice: boolean
   robotType: RobotType
   analytics: UseRecoveryAnalyticsResult
+  failedCommand: ReturnType<typeof useRetainedFailedCommandBySource>
 }
 
 export interface ERUtilsResults {
@@ -83,6 +85,7 @@ export function useERUtils({
     cursor: 0,
     pageLength: 999,
   })
+  const failedCommandByRunRecord = failedCommand?.byRunRecord ?? null
 
   const stepCounts = useRunningStepCounts(runId, runCommands)
 
@@ -116,13 +119,13 @@ export function useERUtils({
   })
 
   const failedPipetteInfo = getFailedCommandPipetteInfo({
-    failedCommand,
+    failedCommandByRunRecord,
     runRecord,
     attachedInstruments,
   })
 
   const failedLabwareUtils = useFailedLabwareUtils({
-    failedCommand,
+    failedCommandByRunRecord,
     protocolAnalysis,
     failedPipetteInfo,
     runRecord,
@@ -131,7 +134,7 @@ export function useERUtils({
 
   const recoveryCommands = useRecoveryCommands({
     runId,
-    failedCommand,
+    failedCommandByRunRecord,
     failedLabwareUtils,
     routeUpdateActions,
     recoveryToastUtils,