fix(app): Allow starting protocols on robots with completed runs (#15839)

When you click the button to start protocol setup, we try to filter to
only robots that are currently capable of starting a protocol. We
implemented that as
- You can connect to the robot
- The robot doesn't have a current run

But, robots don't actually get rid of their current run until a user
either clicks the little X button in the run screen on the desktop or
goes back to the main screen of the ODD. That doesn't necessarily align
with a user's view of "this protocol is done", and so people would think
that the robot just disappeared from that little slideout.

To fix this, we should also consider robots that have a completed
protocol to be done. This is a small conceptual change and unfortunately
a huge pain to implement because data about whether a run is done has to
come from getting the state data for that run.

## Testing
- [x] The setup protocol slideout should show robots that have
completed, failed, or cancelled active runs
   - [x] If you start setup, it should work
- [x] The setup protocol slideout should show robots that do not have an
active run
- [x] The setup protocol slideout should not show robots that have an
active run that is not completed, failed, or canceled

Closes EXEC-519

Author: sfoster1

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

@@ -26,7 +26,7 @@ import {
 import { mockLeftProtoPipette } from '../../../redux/pipettes/__fixtures__'
 
 vi.mock('../../Devices/hooks')
-vi.mock('../../ProtocolUpload/hooks')
+vi.mock('../../../resources/runs')
 
 const render = (robotName: string = 'otie') => {
   return renderWithProviders(

app/src/organisms/CalibrationTaskList/index.tsx

@@ -25,7 +25,7 @@ import {
   useCalibrationTaskList,
   useRunHasStarted,
 } from '../Devices/hooks'
-import { useCurrentRunId } from '../ProtocolUpload/hooks'
+import { useCurrentRunId } from '../../resources/runs'
 
 import type { DashboardCalOffsetInvoker } from '../../pages/Devices/CalibrationDashboard/hooks/useDashboardCalibratePipOffset'
 import type { DashboardCalTipLengthInvoker } from '../../pages/Devices/CalibrationDashboard/hooks/useDashboardCalibrateTipLength'

app/src/organisms/ChooseRobotSlideout/AvailableRobotOption.tsx

@@ -22,7 +22,7 @@ import { getNetworkInterfaces, fetchStatus } from '../../redux/networking'
 import { appShellRequestor } from '../../redux/shell/remote'
 import OT2_PNG from '../../assets/images/OT2-R_HERO.png'
 import FLEX_PNG from '../../assets/images/FLEX.png'
-import { useNotifyAllRunsQuery } from '../../resources/runs'
+import { useCurrentRunId, useNotifyRunQuery } from '../../resources/runs'
 
 import type { IconName } from '@opentrons/components'
 import type { Runs } from '@opentrons/api-client'
@@ -59,14 +59,15 @@ export function AvailableRobotOption(
     getRobotModelByName(state, robotName)
   )
 
-  const { data: runsData } = useNotifyAllRunsQuery(
-    { pageLength: 0 },
+  const [isBusy, setIsBusy] = React.useState(true)
+
+  const currentRunId = useCurrentRunId(
     {
       onSuccess: data => {
-        if ((data as Runs)?.links?.current != null)
-          registerRobotBusyStatus({ type: 'robotIsBusy', robotName })
-        else {
+        const definitelyIdle = (data as Runs)?.links?.current == null
+        if (definitelyIdle) {
           registerRobotBusyStatus({ type: 'robotIsIdle', robotName })
+          setIsBusy(false)
         }
       },
     },
@@ -75,7 +76,28 @@ export function AvailableRobotOption(
       requestor: ip === OPENTRONS_USB ? appShellRequestor : undefined,
     }
   )
-  const robotHasCurrentRun = runsData?.links?.current != null
+
+  useNotifyRunQuery(
+    currentRunId,
+    {
+      onSuccess: data => {
+        const busy = data?.data != null && data.data.completedAt == null
+        registerRobotBusyStatus({
+          type: busy ? 'robotIsBusy' : 'robotIsIdle',
+          robotName,
+        })
+        setIsBusy(busy)
+      },
+      onError: () => {
+        registerRobotBusyStatus({ type: 'robotIsIdle', robotName })
+        setIsBusy(false)
+      },
+    },
+    {
+      hostname: ip,
+      requestor: ip === OPENTRONS_USB ? appShellRequestor : undefined,
+    }
+  )
 
   const { ethernet, wifi } = useSelector((state: State) =>
     getNetworkInterfaces(state, robotName)
@@ -95,7 +117,7 @@ export function AvailableRobotOption(
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [])
 
-  return showIdleOnly && robotHasCurrentRun ? null : (
+  return showIdleOnly && isBusy ? null : (
     <>
       <MiniCard
         onClick={onClick}

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

@@ -7,10 +7,7 @@ import { when } from 'vitest-when'
 import { renderWithProviders } from '../../../__testing-utils__'
 import { i18n } from '../../../i18n'
 import { useTrackCreateProtocolRunEvent } from '../../../organisms/Devices/hooks'
-import {
-  useCloseCurrentRun,
-  useCurrentRunId,
-} from '../../../organisms/ProtocolUpload/hooks'
+import { useCloseCurrentRun } from '../../../organisms/ProtocolUpload/hooks'
 import { useCurrentRunStatus } from '../../../organisms/RunTimeControl/hooks'
 import {
   getConnectableRobots,
@@ -34,6 +31,7 @@ import { useCreateRunFromProtocol } from '../useCreateRunFromProtocol'
 import { useOffsetCandidatesForAnalysis } from '../../ApplyHistoricOffsets/hooks/useOffsetCandidatesForAnalysis'
 import { ChooseRobotToRunProtocolSlideout } from '../'
 import { useNotifyDataReady } from '../../../resources/useNotifyDataReady'
+import { useCurrentRunId } from '../../../resources/runs'
 
 import type { State } from '../../../redux/types'
 
@@ -46,6 +44,7 @@ vi.mock('../../../redux/networking')
 vi.mock('../useCreateRunFromProtocol')
 vi.mock('../../ApplyHistoricOffsets/hooks/useOffsetCandidatesForAnalysis')
 vi.mock('../../../resources/useNotifyDataReady')
+vi.mock('../../../resources/runs')
 
 const render = (
   props: React.ComponentProps<typeof ChooseRobotToRunProtocolSlideout>
@@ -88,7 +87,7 @@ describe('ChooseRobotToRunProtocolSlideout', () => {
       isClosingCurrentRun: false,
       closeCurrentRun: mockCloseCurrentRun,
     })
-    vi.mocked(useCurrentRunId).mockReturnValue(null)
+    provideNullCurrentRunIdFor(mockConnectableRobot.ip)
     vi.mocked(useCurrentRunStatus).mockReturnValue(null)
     when(vi.mocked(useCreateRunFromProtocol))
       .calledWith(
@@ -191,6 +190,7 @@ describe('ChooseRobotToRunProtocolSlideout', () => {
       { ...mockConnectableRobot, name: 'otherRobot', ip: 'otherIp' },
       mockConnectableRobot,
     ])
+    provideNullCurrentRunIdFor('otherIp')
     render({
       storedProtocolData: storedProtocolDataFixture,
       onCloseClick: vi.fn(),
@@ -372,6 +372,7 @@ describe('ChooseRobotToRunProtocolSlideout', () => {
       mockConnectableRobot,
       { ...mockConnectableRobot, name: 'otherRobot', ip: 'otherIp' },
     ])
+    provideNullCurrentRunIdFor('otherIp')
     render({
       storedProtocolData: storedProtocolDataFixture,
       onCloseClick: vi.fn(),
@@ -387,7 +388,7 @@ describe('ChooseRobotToRunProtocolSlideout', () => {
     fireEvent.click(proceedButton)
     fireEvent.click(screen.getByRole('button', { name: 'Confirm values' }))
     expect(vi.mocked(useCreateRunFromProtocol)).nthCalledWith(
-      2,
+      3,
       expect.any(Object),
       { hostname: '127.0.0.1' },
       [
@@ -450,3 +451,21 @@ describe('ChooseRobotToRunProtocolSlideout', () => {
     )
   })
 })
+
+const provideNullCurrentRunIdFor = (hostname: string): void => {
+  let once = true
+  when(vi.mocked(useCurrentRunId))
+    .calledWith(expect.any(Object), {
+      hostname,
+      requestor: undefined,
+    })
+    .thenDo(options => {
+      void (options?.onSuccess != null && once
+        ? options.onSuccess({
+            links: { current: null },
+          } as any)
+        : {})
+      once = false
+      return null
+    })
+}

app/src/organisms/Devices/InstrumentsAndModules.tsx

@@ -22,7 +22,7 @@ import {
 
 import { Banner } from '../../atoms/Banner'
 import { PipetteRecalibrationWarning } from './PipetteCard/PipetteRecalibrationWarning'
-import { useCurrentRunId } from '../ProtocolUpload/hooks'
+import { useCurrentRunId } from '../../resources/runs'
 import { ModuleCard } from '../ModuleCard'
 import { useIsFlex, useIsRobotViewable, useRunStatuses } from './hooks'
 import { getShowPipetteCalibrationWarning } from './utils'

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

@@ -67,10 +67,7 @@ import {
 } from '../../../redux/analytics'
 import { getIsHeaterShakerAttached } from '../../../redux/config'
 import { Tooltip } from '../../../atoms/Tooltip'
-import {
-  useCloseCurrentRun,
-  useCurrentRunId,
-} from '../../../organisms/ProtocolUpload/hooks'
+import { useCloseCurrentRun } from '../../../organisms/ProtocolUpload/hooks'
 import { ConfirmCancelModal } from '../../../organisms/RunDetails/ConfirmCancelModal'
 import { HeaterShakerIsRunningModal } from '../HeaterShakerIsRunningModal'
 import {
@@ -103,7 +100,7 @@ import { getIsFixtureMismatch } from '../../../resources/deck_configuration/util
 import { useDeckConfigurationCompatibility } from '../../../resources/deck_configuration/hooks'
 import { useMostRecentCompletedAnalysis } from '../../LabwarePositionCheck/useMostRecentCompletedAnalysis'
 import { useMostRecentRunId } from '../../ProtocolUpload/hooks/useMostRecentRunId'
-import { useNotifyRunQuery } from '../../../resources/runs'
+import { useNotifyRunQuery, useCurrentRunId } from '../../../resources/runs'
 import {
   useErrorRecoveryFlows,
   ErrorRecoveryFlows,

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

@@ -34,10 +34,7 @@ import {
 
 import { renderWithProviders } from '../../../../__testing-utils__'
 import { i18n } from '../../../../i18n'
-import {
-  useCloseCurrentRun,
-  useCurrentRunId,
-} from '../../../../organisms/ProtocolUpload/hooks'
+import { useCloseCurrentRun } from '../../../../organisms/ProtocolUpload/hooks'
 import { ConfirmCancelModal } from '../../../../organisms/RunDetails/ConfirmCancelModal'
 import {
   useRunTimestamps,
@@ -87,7 +84,7 @@ import { getIsFixtureMismatch } from '../../../../resources/deck_configuration/u
 import { useDeckConfigurationCompatibility } from '../../../../resources/deck_configuration/hooks'
 import { useMostRecentCompletedAnalysis } from '../../../LabwarePositionCheck/useMostRecentCompletedAnalysis'
 import { useMostRecentRunId } from '../../../ProtocolUpload/hooks/useMostRecentRunId'
-import { useNotifyRunQuery } from '../../../../resources/runs'
+import { useNotifyRunQuery, useCurrentRunId } from '../../../../resources/runs'
 import {
   useDropTipWizardFlows,
   useTipAttachmentStatus,

app/src/organisms/Devices/RecentProtocolRuns.tsx

@@ -16,10 +16,9 @@ import {
   TYPOGRAPHY,
 } from '@opentrons/components'
 
-import { useCurrentRunId } from '../ProtocolUpload/hooks'
 import { HistoricalProtocolRun } from './HistoricalProtocolRun'
 import { useIsRobotViewable, useRunStatuses } from './hooks'
-import { useNotifyAllRunsQuery } from '../../resources/runs'
+import { useNotifyAllRunsQuery, useCurrentRunId } from '../../resources/runs'
 import { useFeatureFlag } from '../../redux/config'
 
 interface RecentProtocolRunsProps {

app/src/organisms/Devices/RobotOverflowMenu.tsx

@@ -24,7 +24,7 @@ import { Divider } from '../../atoms/structure'
 import { MenuItem } from '../../atoms/MenuList/MenuItem'
 import { getTopPortalEl } from '../../App/portal'
 import { ChooseProtocolSlideout } from '../ChooseProtocolSlideout'
-import { useCurrentRunId } from '../ProtocolUpload/hooks'
+import { useCurrentRunId } from '../../resources/runs'
 import { ConnectionTroubleshootingModal } from './ConnectionTroubleshootingModal'
 import { useMenuHandleClickOutside } from '../../atoms/MenuList/hooks'
 import { useIsRobotBusy } from './hooks'

app/src/organisms/Devices/RobotOverviewOverflowMenu.tsx

@@ -25,7 +25,6 @@ import { Tooltip } from '../../atoms/Tooltip'
 import { ChooseProtocolSlideout } from '../../organisms/ChooseProtocolSlideout'
 import { DisconnectModal } from '../../organisms/Devices/RobotSettings/ConnectNetwork/DisconnectModal'
 import { handleUpdateBuildroot } from '../../organisms/Devices/RobotSettings/UpdateBuildroot'
-import { useCurrentRunId } from '../../organisms/ProtocolUpload/hooks'
 import { getRobotUpdateDisplayInfo } from '../../redux/robot-update'
 import { UNREACHABLE, CONNECTABLE, REACHABLE } from '../../redux/discovery'
 import { checkShellUpdate } from '../../redux/shell'
@@ -34,7 +33,7 @@ import { home, ROBOT } from '../../redux/robot-controls'
 import { useIsRobotBusy } from './hooks'
 import { useCanDisconnect } from '../../resources/networking/hooks'
 import { useIsEstopNotDisengaged } from '../../resources/devices/hooks/useIsEstopNotDisengaged'
-
+import { useCurrentRunId } from '../../resources/runs'
 import type { DiscoveredRobot } from '../../redux/discovery/types'
 import type { Dispatch, State } from '../../redux/types'