perf(app,robot-server): Download analyses as raw JSON documents (#13425)

Co-authored-by: Brian Cooper <[email protected]>
Opentrons · Sep 1, 2023 · 32e90d7 · 32e90d7
1 parent 2a502b1
commit 32e90d7
Show file tree

Hide file tree

Showing 40 changed files with 910 additions and 324 deletions.
diff --git a/api-client/src/protocols/getProtocolAnalysisAsDocument.ts b/api-client/src/protocols/getProtocolAnalysisAsDocument.ts
@@ -0,0 +1,18 @@
+import { GET, request } from '../request'
+
+import type { ResponsePromise } from '../request'
+import type { HostConfig } from '../types'
+import type { CompletedProtocolAnalysis } from '@opentrons/shared-data'
+
+export function getProtocolAnalysisAsDocument(
+  config: HostConfig,
+  protocolId: string,
+  analysisId: string
+): ResponsePromise<CompletedProtocolAnalysis> {
+  return request<CompletedProtocolAnalysis>(
+    GET,
+    `/protocols/${protocolId}/analyses/${analysisId}/asDocument`,
+    null,
+    config
+  )
+}
diff --git a/api-client/src/protocols/index.ts b/api-client/src/protocols/index.ts
@@ -1,5 +1,6 @@
 export { getProtocol } from './getProtocol'
 export { getProtocolAnalyses } from './getProtocolAnalyses'
+export { getProtocolAnalysisAsDocument } from './getProtocolAnalysisAsDocument'
 export { deleteProtocol } from './deleteProtocol'
 export { createProtocol } from './createProtocol'
 export { getProtocols } from './getProtocols'

diff --git a/app/src/assets/localization/en/device_details.json b/app/src/assets/localization/en/device_details.json
@@ -118,6 +118,7 @@
   "run_again": "Run again",
   "run_duration": "Run duration",
   "serial_number": "Serial Number",
+  "robot_initializing": "Initializing...",
   "set_block_temp": "Set temperature",
   "set_block_temperature": "Set block temperature",
   "set_engage_height": "Set Engage Height",

diff --git a/app/src/atoms/buttons/__tests__/FloatingActionButton.test.tsx b/app/src/atoms/buttons/__tests__/FloatingActionButton.test.tsx
@@ -8,9 +8,12 @@ import {
 } from '@opentrons/components'
 
 import { FloatingActionButton } from '..'
+import { i18n } from '../../../i18n'
 
 const render = (props: React.ComponentProps<typeof FloatingActionButton>) => {
-  return renderWithProviders(<FloatingActionButton {...props} />)[0]
+  return renderWithProviders(<FloatingActionButton {...props} />, {
+    i18nInstance: i18n,
+  })[0]
 }
 
 describe('FloatingActionButton', () => {

diff --git a/app/src/organisms/Devices/hooks/__tests__/useProtocolAnalysisErrors.test.tsx b/app/src/organisms/Devices/hooks/__tests__/useProtocolAnalysisErrors.test.tsx
@@ -3,15 +3,16 @@ import { UseQueryResult } from 'react-query'
 import { renderHook } from '@testing-library/react-hooks'
 
 import {
-  useProtocolAnalysesQuery,
+  useProtocolAnalysisAsDocumentQuery,
+  useProtocolQuery,
   useRunQuery,
 } from '@opentrons/react-api-client'
 
 import { useProtocolAnalysisErrors } from '..'
 
 import { RUN_ID_2 } from '../../../../organisms/RunTimeControl/__fixtures__'
 
-import type { Run, ProtocolAnalyses } from '@opentrons/api-client'
+import type { Run, Protocol } from '@opentrons/api-client'
 import type {
   CompletedProtocolAnalysis,
   PendingProtocolAnalysis,
@@ -20,20 +21,27 @@ import type {
 jest.mock('@opentrons/react-api-client')
 
 const mockUseRunQuery = useRunQuery as jest.MockedFunction<typeof useRunQuery>
-const mockUseProtocolAnalysesQuery = useProtocolAnalysesQuery as jest.MockedFunction<
-  typeof useProtocolAnalysesQuery
+
+const mockUseProtocolQuery = useProtocolQuery as jest.MockedFunction<
+  typeof useProtocolQuery
+>
+const mockUseProtocolAnalysisAsDocumentQuery = useProtocolAnalysisAsDocumentQuery as jest.MockedFunction<
+  typeof useProtocolAnalysisAsDocumentQuery
 >
 
 describe('useProtocolAnalysisErrors hook', () => {
   beforeEach(() => {
     when(mockUseRunQuery)
       .calledWith(null, { staleTime: Infinity })
       .mockReturnValue({} as UseQueryResult<Run>)
-    when(mockUseProtocolAnalysesQuery)
-      .calledWith(null, { staleTime: Infinity })
+    when(mockUseProtocolQuery)
+      .calledWith(null)
+      .mockReturnValue({} as UseQueryResult<Protocol>)
+    when(mockUseProtocolAnalysisAsDocumentQuery)
+      .calledWith(null, null, { enabled: false })
       .mockReturnValue({
-        data: { data: [] } as any,
-      } as UseQueryResult<ProtocolAnalyses>)
+        data: null,
+      } as UseQueryResult<CompletedProtocolAnalysis | null>)
   })
 
   afterEach(() => {
@@ -63,12 +71,18 @@ describe('useProtocolAnalysisErrors hook', () => {
       .mockReturnValue({
         data: { data: { protocolId: PROTOCOL_ID } } as any,
       } as UseQueryResult<Run>)
-    when(mockUseProtocolAnalysesQuery)
-      .calledWith(PROTOCOL_ID, { staleTime: Infinity })
+    when(mockUseProtocolQuery)
+      .calledWith(PROTOCOL_ID)
       .mockReturnValue({
-        data: { data: [PROTOCOL_ANALYSIS as any] },
-      } as UseQueryResult<ProtocolAnalyses>)
-
+        data: {
+          data: { analysisSummaries: [{ id: PROTOCOL_ANALYSIS.id }] },
+        } as any,
+      } as UseQueryResult<Protocol>)
+    when(mockUseProtocolAnalysisAsDocumentQuery)
+      .calledWith(PROTOCOL_ID, PROTOCOL_ANALYSIS.id, { enabled: true })
+      .mockReturnValue({
+        data: PROTOCOL_ANALYSIS,
+      } as UseQueryResult<CompletedProtocolAnalysis>)
     const { result } = renderHook(() => useProtocolAnalysisErrors(RUN_ID_2))
     expect(result.current).toStrictEqual({
       analysisErrors: null,
@@ -86,12 +100,18 @@ describe('useProtocolAnalysisErrors hook', () => {
       .mockReturnValue({
         data: { data: { protocolId: PROTOCOL_ID } } as any,
       } as UseQueryResult<Run>)
-    when(mockUseProtocolAnalysesQuery)
-      .calledWith(PROTOCOL_ID, { staleTime: Infinity })
+    when(mockUseProtocolQuery)
+      .calledWith(PROTOCOL_ID)
       .mockReturnValue({
-        data: { data: [PROTOCOL_ANALYSIS as any] },
-      } as UseQueryResult<ProtocolAnalyses>)
-
+        data: {
+          data: { analysisSummaries: [{ id: PROTOCOL_ANALYSIS.id }] },
+        } as any,
+      } as UseQueryResult<Protocol>)
+    when(mockUseProtocolAnalysisAsDocumentQuery)
+      .calledWith(PROTOCOL_ID, PROTOCOL_ANALYSIS.id, { enabled: true })
+      .mockReturnValue({
+        data: PROTOCOL_ANALYSIS,
+      } as UseQueryResult<CompletedProtocolAnalysis>)
     const { result } = renderHook(() => useProtocolAnalysisErrors(RUN_ID_2))
     expect(result.current).toStrictEqual({
       analysisErrors: null,
@@ -110,12 +130,22 @@ describe('useProtocolAnalysisErrors hook', () => {
       .mockReturnValue({
         data: { data: { protocolId: PROTOCOL_ID } } as any,
       } as UseQueryResult<Run>)
-    when(mockUseProtocolAnalysesQuery)
-      .calledWith(PROTOCOL_ID, { staleTime: Infinity })
+    when(mockUseProtocolQuery)
+      .calledWith(PROTOCOL_ID)
       .mockReturnValue({
-        data: { data: [PROTOCOL_ANALYSIS_WITH_ERRORS as any] },
-      } as UseQueryResult<ProtocolAnalyses>)
-
+        data: {
+          data: {
+            analysisSummaries: [{ id: PROTOCOL_ANALYSIS_WITH_ERRORS.id }],
+          },
+        } as any,
+      } as UseQueryResult<Protocol>)
+    when(mockUseProtocolAnalysisAsDocumentQuery)
+      .calledWith(PROTOCOL_ID, PROTOCOL_ANALYSIS_WITH_ERRORS.id, {
+        enabled: true,
+      })
+      .mockReturnValue({
+        data: PROTOCOL_ANALYSIS_WITH_ERRORS,
+      } as UseQueryResult<CompletedProtocolAnalysis>)
     const { result } = renderHook(() => useProtocolAnalysisErrors(RUN_ID_2))
     expect(result.current).toStrictEqual({
       analysisErrors: [{ detail: 'fake error' }],

diff --git a/app/src/organisms/Devices/hooks/__tests__/useProtocolDetailsForRun.test.tsx b/app/src/organisms/Devices/hooks/__tests__/useProtocolDetailsForRun.test.tsx
@@ -3,7 +3,7 @@ import { UseQueryResult } from 'react-query'
 import { renderHook } from '@testing-library/react-hooks'
 
 import {
-  useProtocolAnalysesQuery,
+  useProtocolAnalysisAsDocumentQuery,
   useProtocolQuery,
   useRunQuery,
 } from '@opentrons/react-api-client'
@@ -12,25 +12,32 @@ import { useProtocolDetailsForRun } from '..'
 
 import { RUN_ID_2 } from '../../../../organisms/RunTimeControl/__fixtures__'
 
-import type { Protocol, Run, ProtocolAnalyses } from '@opentrons/api-client'
+import type { Protocol, Run } from '@opentrons/api-client'
+import { CompletedProtocolAnalysis } from '@opentrons/shared-data'
 
 jest.mock('@opentrons/react-api-client')
 
 const mockUseProtocolQuery = useProtocolQuery as jest.MockedFunction<
   typeof useProtocolQuery
 >
-const mockUseProtocolAnalysesQuery = useProtocolAnalysesQuery as jest.MockedFunction<
-  typeof useProtocolAnalysesQuery
+const mockUseProtocolAnalysisAsDocumentQuery = useProtocolAnalysisAsDocumentQuery as jest.MockedFunction<
+  typeof useProtocolAnalysisAsDocumentQuery
 >
 const mockUseRunQuery = useRunQuery as jest.MockedFunction<typeof useRunQuery>
 
+const PROTOCOL_ID = 'fake_protocol_id'
+const PROTOCOL_ANALYSIS = {
+  id: 'fake analysis',
+  status: 'completed',
+  labware: [],
+} as any
 const PROTOCOL_RESPONSE = {
   data: {
     protocolType: 'json',
     createdAt: 'now',
-    id: '1',
+    id: PROTOCOL_ID,
     metadata: { protocolName: 'fake protocol' },
-    analysisSummaries: [{ id: 'fake analysis', status: 'completed' }],
+    analysisSummaries: [{ id: PROTOCOL_ANALYSIS.id, status: 'completed' }],
     key: 'fakeProtocolKey',
   },
 } as Protocol
@@ -43,11 +50,11 @@ describe('useProtocolDetailsForRun hook', () => {
     when(mockUseProtocolQuery)
       .calledWith(null, { staleTime: Infinity })
       .mockReturnValue({} as UseQueryResult<Protocol>)
-    when(mockUseProtocolAnalysesQuery)
-      .calledWith(null, { staleTime: Infinity }, true)
+    when(mockUseProtocolAnalysisAsDocumentQuery)
+      .calledWith(null, null, { enabled: false, refetchInterval: 5000 })
       .mockReturnValue({
-        data: { data: [] } as any,
-      } as UseQueryResult<ProtocolAnalyses>)
+        data: null,
+      } as UseQueryResult<CompletedProtocolAnalysis | null>)
   })
 
   afterEach(() => {
@@ -66,12 +73,6 @@ describe('useProtocolDetailsForRun hook', () => {
   })
 
   it('returns the protocol file when given a run id', async () => {
-    const PROTOCOL_ID = 'fake_protocol_id'
-    const PROTOCOL_ANALYSIS = {
-      id: 'fake analysis',
-      status: 'completed',
-      labware: [],
-    } as any
     when(mockUseRunQuery)
       .calledWith(RUN_ID_2, { staleTime: Infinity })
       .mockReturnValue({
@@ -80,11 +81,22 @@ describe('useProtocolDetailsForRun hook', () => {
     when(mockUseProtocolQuery)
       .calledWith(PROTOCOL_ID, { staleTime: Infinity })
       .mockReturnValue({ data: PROTOCOL_RESPONSE } as UseQueryResult<Protocol>)
-    when(mockUseProtocolAnalysesQuery)
-      .calledWith(PROTOCOL_ID, { staleTime: Infinity }, expect.any(Boolean))
+    when(mockUseProtocolAnalysisAsDocumentQuery)
+      .calledWith(PROTOCOL_ID, 'fake analysis', {
+        enabled: true,
+        refetchInterval: 5000,
+      })
       .mockReturnValue({
-        data: { data: [PROTOCOL_ANALYSIS as any] },
-      } as UseQueryResult<ProtocolAnalyses>)
+        data: PROTOCOL_ANALYSIS,
+      } as UseQueryResult<CompletedProtocolAnalysis | null>)
+    when(mockUseProtocolAnalysisAsDocumentQuery)
+      .calledWith(PROTOCOL_ID, 'fake analysis', {
+        enabled: false,
+        refetchInterval: 5000,
+      })
+      .mockReturnValue({
+        data: PROTOCOL_ANALYSIS,
+      } as UseQueryResult<CompletedProtocolAnalysis | null>)
 
     const { result } = renderHook(() => useProtocolDetailsForRun(RUN_ID_2))
 

diff --git a/app/src/organisms/Devices/hooks/useProtocolAnalysisErrors.ts b/app/src/organisms/Devices/hooks/useProtocolAnalysisErrors.ts
@@ -1,6 +1,7 @@
 import last from 'lodash/last'
 import {
-  useProtocolAnalysesQuery,
+  useProtocolAnalysisAsDocumentQuery,
+  useProtocolQuery,
   useRunQuery,
 } from '@opentrons/react-api-client'
 
@@ -15,16 +16,19 @@ export function useProtocolAnalysisErrors(
 ): ProtocolAnalysisErrors {
   const { data: runRecord } = useRunQuery(runId, { staleTime: Infinity })
   const protocolId = runRecord?.data?.protocolId ?? null
-  const { data: protocolAnalyses } = useProtocolAnalysesQuery(protocolId, {
-    staleTime: Infinity,
-  })
+  const { data: protocolData } = useProtocolQuery(protocolId)
+  const {
+    data: mostRecentAnalysis,
+  } = useProtocolAnalysisAsDocumentQuery(
+    protocolId,
+    last(protocolData?.data.analysisSummaries)?.id ?? null,
+    { enabled: protocolData != null }
+  )
 
   if (protocolId === null || runRecord?.data?.current === false) {
     return { analysisErrors: null }
   }
 
-  const mostRecentAnalysis = last(protocolAnalyses?.data ?? []) ?? null
-
   if (mostRecentAnalysis?.status !== 'completed') {
     return { analysisErrors: null }
   }

diff --git a/app/src/organisms/Devices/hooks/useProtocolDetailsForRun.ts b/app/src/organisms/Devices/hooks/useProtocolDetailsForRun.ts
@@ -3,8 +3,8 @@ import last from 'lodash/last'
 import { getRobotTypeFromLoadedLabware } from '@opentrons/shared-data'
 import {
   useProtocolQuery,
-  useProtocolAnalysesQuery,
   useRunQuery,
+  useProtocolAnalysisAsDocumentQuery,
 } from '@opentrons/react-api-client'
 
 import type {
@@ -13,6 +13,7 @@ import type {
   PendingProtocolAnalysis,
 } from '@opentrons/shared-data'
 
+const ANALYSIS_POLL_MS = 5000
 export interface ProtocolDetails {
   displayName: string | null
   protocolData: CompletedProtocolAnalysis | PendingProtocolAnalysis | null
@@ -34,17 +35,15 @@ export function useProtocolDetailsForRun(
   const { data: protocolRecord } = useProtocolQuery(protocolId, {
     staleTime: Infinity,
   })
-
-  const { data: protocolAnalyses } = useProtocolAnalysesQuery(
+  const { data: mostRecentAnalysis } = useProtocolAnalysisAsDocumentQuery(
     protocolId,
+    last(protocolRecord?.data.analysisSummaries)?.id ?? null,
     {
-      staleTime: Infinity,
-    },
-    isPollingProtocolAnalyses
+      enabled: protocolRecord != null && isPollingProtocolAnalyses,
+      refetchInterval: ANALYSIS_POLL_MS,
+    }
   )
 
-  const mostRecentAnalysis = last(protocolAnalyses?.data ?? []) ?? null
-
   React.useEffect(() => {
     if (mostRecentAnalysis?.status === 'completed') {
       setIsPollingProtocolAnalyses(false)
@@ -61,8 +60,7 @@ export function useProtocolDetailsForRun(
     displayName: displayName ?? null,
     protocolData: mostRecentAnalysis ?? null,
     protocolKey: protocolRecord?.data.key ?? null,
-    isProtocolAnalyzing:
-      mostRecentAnalysis != null && mostRecentAnalysis?.status === 'pending',
+    isProtocolAnalyzing: protocolRecord != null && mostRecentAnalysis == null,
     // this should be deleted as soon as analysis tells us intended robot type
     robotType:
       mostRecentAnalysis?.status === 'completed'

diff --git a/app/src/organisms/LabwarePositionCheck/useMostRecentCompletedAnalysis.ts b/app/src/organisms/LabwarePositionCheck/useMostRecentCompletedAnalysis.ts
@@ -1,5 +1,7 @@
+import last from 'lodash/last'
 import {
-  useProtocolAnalysesQuery,
+  useProtocolAnalysisAsDocumentQuery,
+  useProtocolQuery,
   useRunQuery,
 } from '@opentrons/react-api-client'
 import { CompletedProtocolAnalysis } from '@opentrons/shared-data'
@@ -9,14 +11,14 @@ export function useMostRecentCompletedAnalysis(
 ): CompletedProtocolAnalysis | null {
   const { data: runRecord } = useRunQuery(runId)
   const protocolId = runRecord?.data?.protocolId ?? null
-  const { data: protocolAnalyses } = useProtocolAnalysesQuery(protocolId)
-
-  return (
-    (protocolAnalyses?.data ?? [])
-      .reverse()
-      .find(
-        (analysis): analysis is CompletedProtocolAnalysis =>
-          analysis.status === 'completed'
-      ) ?? null
+  const { data: protocolData } = useProtocolQuery(protocolId, {
+    enabled: protocolId != null,
+  })
+  const { data: analysis } = useProtocolAnalysisAsDocumentQuery(
+    protocolId,
+    last(protocolData?.data.analysisSummaries)?.id ?? null,
+    { enabled: protocolData != null }
   )
+
+  return analysis ?? null
 }