feat(app): App support for downloading plate reader CSV files (#16551)

fix PLAT-480, PLAT-485
Opentrons · Oct 21, 2024 · 0961a8b · 0961a8b
1 parent 0fc0db9
commit 0961a8b
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 3 deletions.
diff --git a/api-client/src/runs/types.ts b/api-client/src/runs/types.ts
@@ -60,6 +60,7 @@ export interface LegacyGoodRunData {
 export interface KnownGoodRunData extends LegacyGoodRunData {
   ok: true
   runTimeParameters: RunTimeParameter[]
+  outputFileIds: string[]
 }
 
 export interface KnownInvalidRunData extends LegacyGoodRunData {

diff --git a/app/src/assets/localization/en/run_details.json b/app/src/assets/localization/en/run_details.json
@@ -31,9 +31,11 @@
   "custom_values": "Custom values",
   "data_out_of_date": "This data is likely out of date",
   "date": "Date",
+  "device_details": "Device details",
   "door_is_open": "Robot door is open",
   "door_open_pause": "Current Step - Paused - Door Open",
   "download": "Download",
+  "download_files": "Download files",
   "download_run_log": "Download run log",
   "downloading_run_log": "Downloading run log",
   "drop_tip": "Dropping tip in {{well_name}} of {{labware}} in {{labware_location}}",
@@ -45,6 +47,7 @@
   "error_info": "Error {{errorCode}}: {{errorType}}",
   "error_type": "Error: {{errorType}}",
   "failed_step": "Failed step",
+  "files_available_robot_details": "All files associated with the protocol run are available on the robot detail screen.",
   "final_step": "Final Step",
   "ignore_stored_data": "Ignore stored data",
   "labware": "labware",

diff --git a/app/src/organisms/Desktop/Devices/HistoricalProtocolRunDrawer.tsx b/app/src/organisms/Desktop/Devices/HistoricalProtocolRunDrawer.tsx
@@ -56,6 +56,10 @@ export function HistoricalProtocolRunDrawer(
           return acc
         }, [])
       : []
+  if ('outputFileIds' in run && run.outputFileIds.length > 0) {
+    runDataFileIds.push(...run.outputFileIds)
+  }
+
   const uniqueLabwareOffsets = allLabwareOffsets?.filter(
     (offset, index, array) => {
       return (

diff --git a/...rganisms/Desktop/Devices/ProtocolRun/ProtocolRunHeader/RunHeaderBannerContainer/index.tsx b/...rganisms/Desktop/Devices/ProtocolRun/ProtocolRunHeader/RunHeaderBannerContainer/index.tsx
@@ -1,6 +1,19 @@
 import { useTranslation } from 'react-i18next'
+import { useNavigate } from 'react-router-dom'
 
-import { Box, SPACING, Banner } from '@opentrons/components'
+import {
+  Box,
+  StyledText,
+  Link,
+  SPACING,
+  Banner,
+  Flex,
+  DIRECTION_COLUMN,
+  JUSTIFY_SPACE_BETWEEN,
+  DIRECTION_ROW,
+  ALIGN_CENTER,
+  TEXT_DECORATION_UNDERLINE,
+} from '@opentrons/components'
 
 import { ProtocolAnalysisErrorBanner } from './ProtocolAnalysisErrorBanner'
 import {
@@ -21,17 +34,25 @@ export type RunHeaderBannerContainerProps = ProtocolRunHeaderProps & {
   isResetRunLoading: boolean
   runErrors: UseRunErrorsResult
   runHeaderModalContainerUtils: UseRunHeaderModalContainerResult
+  hasDownloadableFiles: boolean
 }
 
 // Holds all the various banners that render in ProtocolRunHeader.
 export function RunHeaderBannerContainer(
   props: RunHeaderBannerContainerProps
 ): JSX.Element | null {
-  const { runStatus, enteredER, runHeaderModalContainerUtils } = props
+  const navigate = useNavigate()
+  const {
+    runStatus,
+    enteredER,
+    runHeaderModalContainerUtils,
+    hasDownloadableFiles,
+    robotName,
+  } = props
   const { analysisErrorModalUtils } = runHeaderModalContainerUtils
 
   const { t } = useTranslation(['run_details', 'shared'])
-  const isDoorOpen = useIsDoorOpen(props.robotName)
+  const isDoorOpen = useIsDoorOpen(robotName)
 
   const {
     showRunCanceledBanner,
@@ -73,6 +94,36 @@ export function RunHeaderBannerContainer(
           {...props}
         />
       ) : null}
+      {hasDownloadableFiles ? (
+        <Banner type="informing" marginTop={SPACING.spacing16}>
+          <Flex
+            width="100%"
+            flexDirection={DIRECTION_ROW}
+            justifyContent={JUSTIFY_SPACE_BETWEEN}
+            alignItems={ALIGN_CENTER}
+          >
+            <Flex flexDirection={DIRECTION_COLUMN}>
+              <StyledText
+                desktopStyle="captionSemiBold"
+                marginBottom={SPACING.spacing4}
+              >
+                {t('download_files')}
+              </StyledText>
+              <StyledText desktopStyle="captionRegular">
+                {t('files_available_robot_details')}
+              </StyledText>
+            </Flex>
+            <Link
+              textDecoration={TEXT_DECORATION_UNDERLINE}
+              onClick={() => {
+                navigate(`/devices/${robotName}`)
+              }}
+            >
+              {t('device_details')}
+            </Link>
+          </Flex>
+        </Banner>
+      ) : null}
     </Box>
   )
 }
diff --git a/app/src/organisms/Desktop/Devices/ProtocolRun/ProtocolRunHeader/index.tsx b/app/src/organisms/Desktop/Devices/ProtocolRun/ProtocolRunHeader/index.tsx
@@ -103,6 +103,11 @@ export function ProtocolRunHeader(
           isResetRunLoading={isResetRunLoadingRef.current}
           runErrors={runErrors}
           runHeaderModalContainerUtils={runHeaderModalContainerUtils}
+          hasDownloadableFiles={
+            runRecord?.data != null &&
+            'outputFileIds' in runRecord.data &&
+            runRecord.data.outputFileIds.length > 0
+          }
           {...props}
         />
         <RunHeaderContent