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

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
+  )
+}

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'

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",

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
 }

app/src/organisms/OnDeviceDisplay/RobotDashboard/RecentRunProtocolCard.tsx

@@ -23,7 +23,6 @@ import { useTrackEvent } from '../../../redux/analytics'
 import { Skeleton } from '../../../atoms/Skeleton'
 import { useMissingProtocolHardware } from '../../../pages/Protocols/hooks'
 import { useCloneRun } from '../../ProtocolUpload/hooks'
-import { useTrackProtocolRunEvent } from '../../Devices/hooks'
 import { useMissingHardwareText } from './hooks'
 import {
   RUN_STATUS_FAILED,
@@ -74,7 +73,8 @@ export function ProtocolWithLastRun({
   const isReadyToBeReRun = missingProtocolHardware.length === 0
   const chipText = useMissingHardwareText(missingProtocolHardware)
   const trackEvent = useTrackEvent()
-  const { trackProtocolRunEvent } = useTrackProtocolRunEvent(runData.id)
+  // TODO(BC, 08/29/23): reintroduce this analytics event when we refactor the hook to fetch data lazily (performance concern)
+  // const { trackProtocolRunEvent } = useTrackProtocolRunEvent(runData.id)
   const onResetSuccess = (createRunResponse: Run): void =>
     history.push(`runs/${createRunResponse.data.id}/setup`)
   const { cloneRun } = useCloneRun(runData.id, onResetSuccess)
@@ -121,7 +121,8 @@ export function ProtocolWithLastRun({
       name: 'proceedToRun',
       properties: { sourceLocation: 'RecentRunProtocolCard' },
     })
-    trackProtocolRunEvent({ name: 'runAgain' })
+    // TODO(BC, 08/29/23): reintroduce this analytics event when we refactor the hook to fetch data lazily (performance concern)
+    // trackProtocolRunEvent({ name: 'runAgain' })
   }
 
   const terminationTypeMap: { [runStatus in RunStatus]?: string } = {

app/src/organisms/OnDeviceDisplay/RobotDashboard/ServerInitializing.tsx

@@ -0,0 +1,40 @@
+import * as React from 'react'
+import { useTranslation } from 'react-i18next'
+
+import {
+  Flex,
+  DIRECTION_COLUMN,
+  ALIGN_CENTER,
+  COLORS,
+  JUSTIFY_CENTER,
+  TYPOGRAPHY,
+  BORDERS,
+  Icon,
+  SPACING,
+} from '@opentrons/components'
+
+import { StyledText } from '../../../atoms/text'
+
+export function ServerInitializing(): JSX.Element {
+  const { t } = useTranslation('device_details')
+  return (
+    <Flex
+      alignItems={ALIGN_CENTER}
+      backgroundColor={COLORS.darkBlack20}
+      flexDirection={DIRECTION_COLUMN}
+      height="27.25rem"
+      justifyContent={JUSTIFY_CENTER}
+      borderRadius={BORDERS.borderRadiusSize3}
+      gridGap={SPACING.spacing32}
+    >
+      <Icon name="ot-spinner" spin size="6rem" color={COLORS.darkBlack70} />
+      <StyledText
+        as="h4"
+        fontWeight={TYPOGRAPHY.fontWeightRegular}
+        color={COLORS.darkBlack70}
+      >
+        {t('robot_initializing')}
+      </StyledText>
+    </Flex>
+  )
+}

app/src/organisms/TakeoverModal/MaintenanceRunTakeover.tsx

@@ -6,6 +6,7 @@ import {
 import { TakeoverModal } from './TakeoverModal'
 import { TakeoverModalContext } from './TakeoverModalContext'
 
+const MAINTENANCE_RUN_POLL_MS = 10000
 interface MaintenanceRunTakeoverProps {
   children: React.ReactNode
 }
@@ -17,7 +18,7 @@ export function MaintenanceRunTakeover(
     setIsODDMaintenanceInProgress,
   ] = React.useState<boolean>(false)
   const maintenanceRunId = useCurrentMaintenanceRun({
-    refetchInterval: 5000,
+    refetchInterval: MAINTENANCE_RUN_POLL_MS,
   }).data?.data.id
   const isMaintenanceRunCurrent = maintenanceRunId != null
 

app/src/pages/OnDeviceDisplay/ProtocolSetup/index.tsx

@@ -3,6 +3,7 @@ import { useSelector } from 'react-redux'
 import { useTranslation } from 'react-i18next'
 import { useHistory, useParams } from 'react-router-dom'
 import first from 'lodash/first'
+import last from 'lodash/last'
 import { css } from 'styled-components'
 
 import { RUN_STATUS_IDLE, RUN_STATUS_STOPPED } from '@opentrons/api-client'
@@ -29,6 +30,7 @@ import {
   useProtocolQuery,
   useRunQuery,
   useInstrumentsQuery,
+  useProtocolAnalysisAsDocumentQuery,
 } from '@opentrons/react-api-client'
 import {
   getDeckDefFromRobotType,
@@ -46,7 +48,6 @@ import {
   useAttachedModules,
   useLPCDisabledReason,
 } from '../../../organisms/Devices/hooks'
-import { useMostRecentCompletedAnalysis } from '../../../organisms/LabwarePositionCheck/useMostRecentCompletedAnalysis'
 import { getProtocolModulesInfo } from '../../../organisms/Devices/ProtocolRun/utils/getProtocolModulesInfo'
 import { ProtocolSetupLabware } from '../../../organisms/ProtocolSetupLabware'
 import { ProtocolSetupModules } from '../../../organisms/ProtocolSetupModules'
@@ -339,7 +340,13 @@ function PrepareToRun({
     protocolRecord?.data.metadata.protocolName ??
     protocolRecord?.data.files[0].name ??
     ''
-  const mostRecentAnalysis = useMostRecentCompletedAnalysis(runId)
+  const {
+    data: mostRecentAnalysis,
+  } = useProtocolAnalysisAsDocumentQuery(
+    protocolId,
+    last(protocolRecord?.data.analysisSummaries)?.id ?? null,
+    { enabled: protocolRecord != null }
+  )
   const { launchLPC, LPCWizard } = useLaunchLPC(runId)
   const { setODDMaintenanceFlowInProgress } = useMaintenanceRunTakeover()
 
@@ -391,7 +398,7 @@ function PrepareToRun({
     (protocolHasModules && attachedModules == null)
 
   const speccedInstrumentCount =
-    mostRecentAnalysis !== null
+    mostRecentAnalysis != null
       ? mostRecentAnalysis.pipettes.length +
         (getProtocolUsesGripper(mostRecentAnalysis) ? 1 : 0)
       : 0

app/src/pages/OnDeviceDisplay/RobotDashboard/index.tsx

@@ -21,12 +21,13 @@ import {
 import { getOnDeviceDisplaySettings } from '../../../redux/config'
 import { WelcomedModal } from './WelcomeModal'
 import { RunData } from '@opentrons/api-client'
+import { ServerInitializing } from '../../../organisms/OnDeviceDisplay/RobotDashboard/ServerInitializing'
 
 export const MAXIMUM_RECENT_RUN_PROTOCOLS = 8
 
 export function RobotDashboard(): JSX.Element {
   const { t } = useTranslation('device_details')
-  const allRuns = useAllRunsQuery().data?.data ?? []
+  const { data: allRunsQueryData, error: allRunsQueryError } = useAllRunsQuery()
 
   const { unfinishedUnboxingFlowRoute } = useSelector(
     getOnDeviceDisplaySettings
@@ -35,7 +36,7 @@ export function RobotDashboard(): JSX.Element {
     unfinishedUnboxingFlowRoute !== null
   )
 
-  const recentRunsOfUniqueProtocols = allRuns
+  const recentRunsOfUniqueProtocols = (allRunsQueryData?.data ?? [])
     .reverse() // newest runs first
     .reduce<RunData[]>((acc, run) => {
       if (
@@ -48,6 +49,29 @@ export function RobotDashboard(): JSX.Element {
     }, [])
     .slice(0, MAXIMUM_RECENT_RUN_PROTOCOLS)
 
+  let contents: JSX.Element = <EmptyRecentRun />
+  // GET runs query will error with 503 if database is initializing
+  // this should be momentary, and the type of error to come from this endpoint
+  // so, all errors will be mapped to an initializing spinner
+  if (allRunsQueryError != null) {
+    contents = <ServerInitializing />
+  } else if (recentRunsOfUniqueProtocols.length > 0) {
+    contents = (
+      <>
+        <StyledText
+          as="p"
+          fontWeight={TYPOGRAPHY.fontWeightSemiBold}
+          color={COLORS.darkBlack70}
+        >
+          {t('run_again')}
+        </StyledText>
+        <RecentRunProtocolCarousel
+          recentRunsOfUniqueProtocols={recentRunsOfUniqueProtocols}
+        />
+      </>
+    )
+  }
+
   return (
     <Flex flexDirection={DIRECTION_COLUMN}>
       <Navigation routes={onDeviceDisplayRoutes} />
@@ -59,22 +83,7 @@ export function RobotDashboard(): JSX.Element {
         {showWelcomeModal ? (
           <WelcomedModal setShowWelcomeModal={setShowWelcomeModal} />
         ) : null}
-        {recentRunsOfUniqueProtocols.length === 0 ? (
-          <EmptyRecentRun />
-        ) : (
-          <>
-            <StyledText
-              as="p"
-              fontWeight={TYPOGRAPHY.fontWeightSemiBold}
-              color={COLORS.darkBlack70}
-            >
-              {t('run_again')}
-            </StyledText>
-            <RecentRunProtocolCarousel
-              recentRunsOfUniqueProtocols={recentRunsOfUniqueProtocols}
-            />
-          </>
-        )}
+        {contents}
       </Flex>
     </Flex>
   )

app/src/pages/Protocols/hooks/index.ts

@@ -3,6 +3,8 @@ import {
   useInstrumentsQuery,
   useModulesQuery,
   useProtocolAnalysesQuery,
+  useProtocolAnalysisAsDocumentQuery,
+  useProtocolQuery,
 } from '@opentrons/react-api-client'
 import { getLabwareSetupItemGroups } from '../utils'
 
@@ -50,10 +52,12 @@ export type ProtocolHardware =
 export const useRequiredProtocolHardware = (
   protocolId: string
 ): { requiredProtocolHardware: ProtocolHardware[]; isLoading: boolean } => {
-  const { data: protocolAnalyses } = useProtocolAnalysesQuery(protocolId, {
-    staleTime: Infinity,
-  })
-  const mostRecentAnalysis = last(protocolAnalyses?.data ?? []) ?? null
+  const { data: protocolData } = useProtocolQuery(protocolId)
+  const { data: analysis } = useProtocolAnalysisAsDocumentQuery(
+    protocolId,
+    last(protocolData?.data.analysisSummaries)?.id ?? null,
+    { enabled: protocolData != null }
+  )
 
   const {
     data: attachedModulesData,
@@ -67,16 +71,11 @@ export const useRequiredProtocolHardware = (
   } = useInstrumentsQuery()
   const attachedInstruments = attachedInstrumentsData?.data ?? []
 
-  if (
-    mostRecentAnalysis == null ||
-    mostRecentAnalysis?.status !== 'completed'
-  ) {
+  if (analysis == null || analysis?.status !== 'completed') {
     return { requiredProtocolHardware: [], isLoading: true }
   }
 
-  const requiredGripper: ProtocolGripper[] = getProtocolUsesGripper(
-    mostRecentAnalysis
-  )
+  const requiredGripper: ProtocolGripper[] = getProtocolUsesGripper(analysis)
     ? [
         {
           hardwareType: 'gripper',
@@ -87,7 +86,7 @@ export const useRequiredProtocolHardware = (
       ]
     : []
 
-  const requiredModules: ProtocolModule[] = mostRecentAnalysis.modules.map(
+  const requiredModules: ProtocolModule[] = analysis.modules.map(
     ({ location, model }) => {
       return {
         hardwareType: 'module',
@@ -99,7 +98,7 @@ export const useRequiredProtocolHardware = (
     }
   )
 
-  const requiredPipettes: ProtocolPipette[] = mostRecentAnalysis.pipettes.map(
+  const requiredPipettes: ProtocolPipette[] = analysis.pipettes.map(
     ({ mount, pipetteName }) => ({
       hardwareType: 'pipette',
       pipetteName: pipetteName,

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

@@ -2,5 +2,6 @@ export { useAllProtocolsQuery } from './useAllProtocolsQuery'
 export { useAllProtocolIdsQuery } from './useAllProtocolIdsQuery'
 export { useProtocolQuery } from './useProtocolQuery'
 export { useProtocolAnalysesQuery } from './useProtocolAnalysesQuery'
+export { useProtocolAnalysisAsDocumentQuery } from './useProtocolAnalysisAsDocumentQuery'
 export { useCreateProtocolMutation } from './useCreateProtocolMutation'
 export { useDeleteProtocolMutation } from './useDeleteProtocolMutation'

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

@@ -0,0 +1,26 @@
+import { UseQueryResult, useQuery } from 'react-query'
+import { getProtocolAnalysisAsDocument } from '@opentrons/api-client'
+import { useHost } from '../api'
+import type { HostConfig } from '@opentrons/api-client'
+import type { UseQueryOptions } from 'react-query'
+import { CompletedProtocolAnalysis } from '@opentrons/shared-data'
+
+export function useProtocolAnalysisAsDocumentQuery(
+  protocolId: string | null,
+  analysisId: string | null,
+  options?: UseQueryOptions<CompletedProtocolAnalysis>
+): UseQueryResult<CompletedProtocolAnalysis | null> {
+  const host = useHost()
+  const query = useQuery<CompletedProtocolAnalysis>(
+    [host, 'protocols', protocolId, 'analyses', analysisId],
+    () =>
+      getProtocolAnalysisAsDocument(
+        host as HostConfig,
+        protocolId as string,
+        analysisId as string
+      ).then(response => response.data),
+    options
+  )
+
+  return query
+}