refactor(app): z-home pipette after a failed recovery action (#16026)

Closes RQA-2999 If a recovery action fails, we don't z-home the pipettes. This can get annoying, especially if the user wants to move labware on the deck. Let's z-home the pipette after a recovery action fails.
Opentrons · Aug 15, 2024 · b48a96c · b48a96c
1 parent 038abba
commit b48a96c
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 15 deletions.
diff --git a/app/src/organisms/ErrorRecoveryFlows/RecoveryError.tsx b/app/src/organisms/ErrorRecoveryFlows/RecoveryError.tsx
@@ -54,16 +54,21 @@ export function ErrorRecoveryFlowError({
   getRecoveryOptionCopy,
   currentRecoveryOptionUtils,
   routeUpdateActions,
+  recoveryCommands,
 }: RecoveryContentProps): JSX.Element {
   const { OPTION_SELECTION } = RECOVERY_MAP
   const { t } = useTranslation('error_recovery')
   const { selectedRecoveryOption } = currentRecoveryOptionUtils
-  const { proceedToRouteAndStep } = routeUpdateActions
+  const { proceedToRouteAndStep, setRobotInMotion } = routeUpdateActions
+  const { homePipetteZAxes } = recoveryCommands
 
   const userRecoveryOptionCopy = getRecoveryOptionCopy(selectedRecoveryOption)
 
   const onPrimaryClick = (): void => {
-    void proceedToRouteAndStep(OPTION_SELECTION.ROUTE)
+    void setRobotInMotion(true)
+      .then(() => homePipetteZAxes())
+      .finally(() => setRobotInMotion(false))
+      .then(() => proceedToRouteAndStep(OPTION_SELECTION.ROUTE))
   }
 
   return (

diff --git a/app/src/organisms/ErrorRecoveryFlows/__tests__/RecoveryError.test.tsx b/app/src/organisms/ErrorRecoveryFlows/__tests__/RecoveryError.test.tsx
@@ -1,7 +1,7 @@
 /* eslint-disable testing-library/prefer-presence-queries */
 import * as React from 'react'
 import { describe, it, vi, expect, beforeEach } from 'vitest'
-import { screen, fireEvent } from '@testing-library/react'
+import { screen, fireEvent, waitFor } from '@testing-library/react'
 
 import { mockRecoveryContentProps } from '../__fixtures__'
 import { renderWithProviders } from '../../../__testing-utils__'
@@ -23,16 +23,25 @@ describe('RecoveryError', () => {
   let props: React.ComponentProps<typeof RecoveryError>
   let proceedToRouteAndStepMock: Mock
   let getRecoverOptionCopyMock: Mock
+  let setRobotInMotionMock: Mock
+  let homePipetteZAxesMock: Mock
 
   beforeEach(() => {
     proceedToRouteAndStepMock = vi.fn()
     getRecoverOptionCopyMock = vi.fn()
+    setRobotInMotionMock = vi.fn().mockResolvedValue(undefined)
+    homePipetteZAxesMock = vi.fn().mockResolvedValue(undefined)
 
     props = {
       ...mockRecoveryContentProps,
       routeUpdateActions: {
         ...mockRecoveryContentProps.routeUpdateActions,
         proceedToRouteAndStep: proceedToRouteAndStepMock,
+        setRobotInMotion: setRobotInMotionMock,
+      },
+      recoveryCommands: {
+        ...mockRecoveryContentProps.recoveryCommands,
+        homePipetteZAxes: homePipetteZAxesMock,
       },
       getRecoveryOptionCopy: getRecoverOptionCopyMock,
       recoveryMap: {
@@ -100,18 +109,6 @@ describe('RecoveryError', () => {
     expect(screen.queryAllByText('Return to menu')[0]).toBeInTheDocument()
   })
 
-  it(`calls proceedToRouteAndStep with ${RECOVERY_MAP.OPTION_SELECTION.ROUTE} when the "Back to menu" button is clicked in ErrorRecoveryFlowError`, () => {
-    props.recoveryMap.step =
-      RECOVERY_MAP.ERROR_WHILE_RECOVERING.STEPS.RECOVERY_ACTION_FAILED
-    render(props)
-
-    fireEvent.click(screen.queryAllByText('Back to menu')[0])
-
-    expect(proceedToRouteAndStepMock).toHaveBeenCalledWith(
-      RECOVERY_MAP.OPTION_SELECTION.ROUTE
-    )
-  })
-
   it(`calls proceedToRouteAndStep with ${RECOVERY_MAP.OPTION_SELECTION.ROUTE} when the "Return to menu" button is clicked in RecoveryDropTipFlowErrors with step ${ERROR_WHILE_RECOVERING.STEPS.DROP_TIP_GENERAL_ERROR}`, () => {
     props.recoveryMap.step =
       RECOVERY_MAP.ERROR_WHILE_RECOVERING.STEPS.DROP_TIP_GENERAL_ERROR
@@ -148,4 +145,40 @@ describe('RecoveryError', () => {
       RECOVERY_MAP.DROP_TIP_FLOWS.STEPS.CHOOSE_TIP_DROP
     )
   })
+
+  it(`calls a z-home and proceedToRouteAndStep with ${RECOVERY_MAP.OPTION_SELECTION.ROUTE} in the correct order when "Back to menu" is clicked`, async () => {
+    render(props)
+
+    fireEvent.click(screen.queryAllByText('Back to menu')[0])
+
+    expect(setRobotInMotionMock).toHaveBeenCalledWith(true)
+
+    await waitFor(() => {
+      expect(homePipetteZAxesMock).toHaveBeenCalled()
+    })
+
+    await waitFor(() => {
+      expect(setRobotInMotionMock).toHaveBeenCalledWith(false)
+    })
+
+    await waitFor(() => {
+      expect(proceedToRouteAndStepMock).toHaveBeenCalledWith(
+        RECOVERY_MAP.OPTION_SELECTION.ROUTE
+      )
+    })
+
+    expect(setRobotInMotionMock).toHaveBeenCalledTimes(2)
+    expect(homePipetteZAxesMock).toHaveBeenCalledTimes(1)
+    expect(proceedToRouteAndStepMock).toHaveBeenCalledTimes(1)
+
+    expect(setRobotInMotionMock.mock.invocationCallOrder[0]).toBeLessThan(
+      homePipetteZAxesMock.mock.invocationCallOrder[0]
+    )
+    expect(homePipetteZAxesMock.mock.invocationCallOrder[0]).toBeLessThan(
+      setRobotInMotionMock.mock.invocationCallOrder[1]
+    )
+    expect(setRobotInMotionMock.mock.invocationCallOrder[1]).toBeLessThan(
+      proceedToRouteAndStepMock.mock.invocationCallOrder[0]
+    )
+  })
 })