fix(app, react-api-client): handle failed analysis for RTP protocol o…

…n ODD (#15101)

closes RQA-2673

app/src/organisms/ProtocolSetupParameters/AnalysisFailedModal.tsx

@@ -17,7 +17,7 @@ import type { ModalHeaderBaseProps } from '../../molecules/Modal/types'
 
 interface AnalysisFailedModalProps {
   errors: string[]
-  protocolId: string
+  protocolId: string | null
   setShowAnalysisFailedModal: (showAnalysisFailedModal: boolean) => void
 }
 
@@ -36,7 +36,7 @@ export function AnalysisFailedModal({
   }
 
   const handleRestartSetup = (): void => {
-    history.push(`/protocols/${protocolId}`)
+    history.push(protocolId != null ? `/protocols/${protocolId}` : '/protocols')
   }
 
   return (

app/src/organisms/ProtocolSetupParameters/__tests__/AnalysisFailedModal.test.tsx

@@ -60,4 +60,10 @@ describe('AnalysisFailedModal', () => {
     fireEvent.click(screen.getByText('Restart setup'))
     expect(mockPush).toHaveBeenCalledWith(`/protocols/${PROTOCOL_ID}`)
   })
+
+  it('should push to protocols dashboard when tapping restart setup button and protocol ID is null', () => {
+    render({ ...props, protocolId: null })
+    fireEvent.click(screen.getByText('Restart setup'))
+    expect(mockPush).toHaveBeenCalledWith('/protocols')
+  })
 })

app/src/organisms/ProtocolSetupParameters/index.tsx

@@ -174,6 +174,7 @@ export function ProtocolSetupParameters({
                 detail={formatRunTimeParameterValue(parameter, t)}
                 description={parameter.description}
                 fontSize="h4"
+                disabled={startSetup}
               />
             </React.Fragment>
           )

app/src/pages/ProtocolDashboard/ProtocolCard.tsx

@@ -25,6 +25,7 @@ import {
 } from '@opentrons/components'
 import {
   useHost,
+  useMostRecentSuccessfulAnalysisAsDocumentQuery,
   useProtocolAnalysisAsDocumentQuery,
 } from '@opentrons/react-api-client'
 import { deleteProtocol, deleteRun, getProtocol } from '@opentrons/api-client'
@@ -66,8 +67,20 @@ export function ProtocolCard(props: {
   const queryClient = useQueryClient()
   const host = useHost()
 
+  const { id: protocolId, analysisSummaries } = protocol
+  const {
+    data: mostRecentSuccessfulAnalysis,
+  } = useMostRecentSuccessfulAnalysisAsDocumentQuery(
+    protocolId,
+    analysisSummaries,
+    {
+      enabled: protocol != null,
+      refetchInterval: analysisData =>
+        analysisData == null ? REFETCH_INTERVAL : false,
+    }
+  )
   const { data: mostRecentAnalysis } = useProtocolAnalysisAsDocumentQuery(
-    protocol.id,
+    protocolId,
     last(protocol.analysisSummaries)?.id ?? null,
     {
       enabled: protocol != null,
@@ -76,14 +89,18 @@ export function ProtocolCard(props: {
     }
   )
 
+  const analysisForProtocolCard =
+    mostRecentSuccessfulAnalysis == null
+      ? mostRecentAnalysis
+      : mostRecentSuccessfulAnalysis
   const isFailedAnalysis =
-    (mostRecentAnalysis != null &&
-      'result' in mostRecentAnalysis &&
-      (mostRecentAnalysis.result === 'error' ||
-        mostRecentAnalysis.result === 'not-ok')) ??
+    (analysisForProtocolCard != null &&
+      'result' in analysisForProtocolCard &&
+      (analysisForProtocolCard.result === 'error' ||
+        analysisForProtocolCard.result === 'not-ok')) ??
     false
 
-  const isPendingAnalysis = mostRecentAnalysis == null
+  const isPendingAnalysis = analysisForProtocolCard == null
 
   const handleProtocolClick = (
     longpress: UseLongPressResult,

app/src/pages/ProtocolDashboard/__tests__/ProtocolCard.test.tsx

@@ -3,7 +3,10 @@ import { vi, it, describe, expect, beforeEach } from 'vitest'
 import { act, fireEvent, screen } from '@testing-library/react'
 import { MemoryRouter } from 'react-router-dom'
 import { UseQueryResult } from 'react-query'
-import { useProtocolAnalysisAsDocumentQuery } from '@opentrons/react-api-client'
+import {
+  useMostRecentSuccessfulAnalysisAsDocumentQuery,
+  useProtocolAnalysisAsDocumentQuery,
+} from '@opentrons/react-api-client'
 
 import { renderWithProviders } from '../../../__testing-utils__'
 import { i18n } from '../../../i18n'
@@ -69,6 +72,9 @@ describe('ProtocolCard', () => {
     vi.mocked(useProtocolAnalysisAsDocumentQuery).mockReturnValue({
       data: { result: 'ok' } as any,
     } as UseQueryResult<CompletedProtocolAnalysis>)
+    vi.mocked(useMostRecentSuccessfulAnalysisAsDocumentQuery).mockReturnValue({
+      data: { result: 'ok' } as any,
+    } as UseQueryResult<CompletedProtocolAnalysis>)
   })
   it('should redirect to protocol details after short click', () => {
     render()
@@ -81,6 +87,9 @@ describe('ProtocolCard', () => {
     vi.mocked(useProtocolAnalysisAsDocumentQuery).mockReturnValue({
       data: { result: 'error' } as any,
     } as UseQueryResult<CompletedProtocolAnalysis>)
+    vi.mocked(useMostRecentSuccessfulAnalysisAsDocumentQuery).mockReturnValue({
+      data: { result: 'not-ok', errors: ['some analysis error'] } as any,
+    } as UseQueryResult<CompletedProtocolAnalysis>)
     render()
     screen.getByLabelText('failedAnalysis_icon')
     screen.getByText('Failed analysis')
@@ -115,6 +124,9 @@ describe('ProtocolCard', () => {
     vi.mocked(useProtocolAnalysisAsDocumentQuery).mockReturnValue({
       data: { result: 'error' } as any,
     } as UseQueryResult<CompletedProtocolAnalysis>)
+    vi.mocked(useMostRecentSuccessfulAnalysisAsDocumentQuery).mockReturnValue({
+      data: { result: 'not-ok', errors: ['some analysis error'] } as any,
+    } as UseQueryResult<CompletedProtocolAnalysis>)
     render()
     const name = screen.getByText('yay mock protocol')
     fireEvent.mouseDown(name)
@@ -136,6 +148,9 @@ describe('ProtocolCard', () => {
     vi.mocked(useProtocolAnalysisAsDocumentQuery).mockReturnValue({
       data: null as any,
     } as UseQueryResult<CompletedProtocolAnalysis>)
+    vi.mocked(useMostRecentSuccessfulAnalysisAsDocumentQuery).mockReturnValue({
+      data: null as any,
+    } as UseQueryResult<CompletedProtocolAnalysis>)
     render()
     const name = screen.getByText('yay mock protocol')
     fireEvent.mouseDown(name)

app/src/pages/ProtocolSetup/__tests__/ProtocolSetup.test.tsx

@@ -29,6 +29,7 @@ import {
   useAttachedModules,
   useLPCDisabledReason,
   useModuleCalibrationStatus,
+  useProtocolAnalysisErrors,
   useRobotType,
   useRunCreatedAtTimestamp,
   useTrackProtocolRunEvent,
@@ -248,6 +249,9 @@ describe('ProtocolSetup', () => {
           },
         },
       } as any)
+    when(vi.mocked(useProtocolAnalysisErrors))
+      .calledWith(RUN_ID)
+      .thenReturn({ analysisErrors: null })
     when(vi.mocked(useProtocolQuery))
       .calledWith(PROTOCOL_ID, { staleTime: Infinity })
       .thenReturn({

app/src/pages/ProtocolSetup/index.tsx

@@ -47,6 +47,7 @@ import {
   useAttachedModules,
   useLPCDisabledReason,
   useModuleCalibrationStatus,
+  useProtocolAnalysisErrors,
   useRobotAnalyticsData,
   useRobotType,
   useTrackProtocolRunEvent,
@@ -64,6 +65,7 @@ import { ProtocolSetupDeckConfiguration } from '../../organisms/ProtocolSetupDec
 import { useLaunchLPC } from '../../organisms/LabwarePositionCheck/useLaunchLPC'
 import { getUnmatchedModulesForProtocol } from '../../organisms/ProtocolSetupModulesAndDeck/utils'
 import { ConfirmCancelRunModal } from '../../organisms/OnDeviceDisplay/RunningProtocol'
+import { AnalysisFailedModal } from '../../organisms/ProtocolSetupParameters/AnalysisFailedModal'
 import {
   getIncompleteInstrumentCount,
   getProtocolUsesGripper,
@@ -90,6 +92,7 @@ import { getRequiredDeckConfig } from '../../resources/deck_configuration/utils'
 import { useNotifyRunQuery } from '../../resources/runs'
 import { ViewOnlyParameters } from '../../organisms/ProtocolSetupParameters/ViewOnlyParameters'
 
+import type { Run } from '@opentrons/api-client'
 import type { CutoutFixtureId, CutoutId } from '@opentrons/shared-data'
 import type { OnDeviceRouteParams } from '../../App/types'
 import type {
@@ -251,6 +254,7 @@ interface PrepareToRunProps {
   confirmAttachment: () => void
   play: () => void
   robotName: string
+  runRecord: Run | null
 }
 
 function PrepareToRun({
@@ -259,6 +263,7 @@ function PrepareToRun({
   confirmAttachment,
   play,
   robotName,
+  runRecord,
 }: PrepareToRunProps): JSX.Element {
   const { t, i18n } = useTranslation(['protocol_setup', 'shared'])
   const history = useHistory()
@@ -272,7 +277,6 @@ function PrepareToRun({
     observer.observe(scrollRef.current)
   }
 
-  const { data: runRecord } = useNotifyRunQuery(runId, { staleTime: Infinity })
   const protocolId = runRecord?.data?.protocolId ?? null
   const { data: protocolRecord } = useProtocolQuery(protocolId, {
     staleTime: Infinity,
@@ -797,11 +801,17 @@ export type SetupScreens =
 
 export function ProtocolSetup(): JSX.Element {
   const { runId } = useParams<OnDeviceRouteParams>()
+  const { data: runRecord } = useNotifyRunQuery(runId, { staleTime: Infinity })
+  const { analysisErrors } = useProtocolAnalysisErrors(runId)
   const localRobot = useSelector(getLocalRobot)
   const robotSerialNumber =
     localRobot?.status != null ? getRobotSerialNumber(localRobot) : null
   const trackEvent = useTrackEvent()
   const { play } = useRunControls(runId)
+  const [
+    showAnalysisFailedModal,
+    setShowAnalysisFailedModal,
+  ] = React.useState<boolean>(true)
 
   const handleProceedToRunClick = (): void => {
     trackEvent({
@@ -838,6 +848,7 @@ export function ProtocolSetup(): JSX.Element {
         confirmAttachment={confirmAttachment}
         play={play}
         robotName={localRobot?.name != null ? localRobot.name : 'no name'}
+        runRecord={runRecord ?? null}
       />
     ),
     instruments: (
@@ -872,6 +883,15 @@ export function ProtocolSetup(): JSX.Element {
 
   return (
     <>
+      {showAnalysisFailedModal &&
+      analysisErrors != null &&
+      analysisErrors?.length > 0 ? (
+        <AnalysisFailedModal
+          setShowAnalysisFailedModal={setShowAnalysisFailedModal}
+          protocolId={runRecord?.data.protocolId ?? null}
+          errors={analysisErrors.map(error => error.detail)}
+        />
+      ) : null}
       {showConfirmationModal ? (
         <ConfirmAttachedModal
           onCloseClick={cancelExit}

react-api-client/src/protocols/index.ts

@@ -2,6 +2,7 @@ export { useAllProtocolsQuery } from './useAllProtocolsQuery'
 export { useAllProtocolIdsQuery } from './useAllProtocolIdsQuery'
 export { useProtocolQuery } from './useProtocolQuery'
 export { useProtocolAnalysesQuery } from './useProtocolAnalysesQuery'
+export { useMostRecentSuccessfulAnalysisAsDocumentQuery } from './useMostRecentSuccessfulAnalysisAsDocumentQuery'
 export { useProtocolAnalysisAsDocumentQuery } from './useProtocolAnalysisAsDocumentQuery'
 export { useCreateProtocolMutation } from './useCreateProtocolMutation'
 export { useCreateProtocolAnalysisMutation } from './useCreateProtocolAnalysisMutation'

react-api-client/src/protocols/useMostRecentSuccessfulAnalysisAsDocumentQuery.ts

@@ -0,0 +1,54 @@
+import { useQuery } from 'react-query'
+import { getProtocolAnalysisAsDocument } from '@opentrons/api-client'
+import { useHost } from '../api'
+
+import type { UseQueryResult, UseQueryOptions } from 'react-query'
+import type { HostConfig } from '@opentrons/api-client'
+import type {
+  CompletedProtocolAnalysis,
+  ProtocolAnalysisSummary,
+} from '@opentrons/shared-data'
+
+const getMostRecentSuccessfulAnalysisId = async (
+  analysisSummaryIds: string[],
+  host: HostConfig | null,
+  protocolId: string
+): Promise<CompletedProtocolAnalysis | null> => {
+  for (const analysisId of analysisSummaryIds) {
+    const { data: analysis } = await getProtocolAnalysisAsDocument(
+      host as HostConfig,
+      protocolId,
+      analysisId
+    )
+    if (analysis.errors.length === 0) {
+      return analysis
+    }
+  }
+  return null
+}
+
+export function useMostRecentSuccessfulAnalysisAsDocumentQuery<TError = Error>(
+  protocolId: string,
+  analysisSummaries: ProtocolAnalysisSummary[],
+  options: UseQueryOptions<CompletedProtocolAnalysis | null, TError> = {}
+): UseQueryResult<CompletedProtocolAnalysis | null, TError> {
+  const host = useHost()
+
+  const query = useQuery<CompletedProtocolAnalysis | null, TError>(
+    [host, 'protocols', protocolId, 'analyses', 'mostRecentSuccessful'],
+    async () => {
+      const analysisIds = analysisSummaries.map(summary => summary.id)
+
+      const mostRecentSuccessfulAnalysis = await getMostRecentSuccessfulAnalysisId(
+        analysisIds,
+        host,
+        protocolId
+      )
+
+      return mostRecentSuccessfulAnalysis
+    },
+    options
+  )
+
+  return query
+}