fix(app): clone run with RTPs from HistoricalProtocolRun (#14959)

closes RQA-2601

Author: ncdiehl11

api-client/src/runs/constants.ts

@@ -0,0 +1,11 @@
+import {
+  RUN_STATUS_FAILED,
+  RUN_STATUS_STOPPED,
+  RUN_STATUS_SUCCEEDED,
+} from './types'
+
+export const RUN_STATUSES_TERMINAL = [
+  RUN_STATUS_SUCCEEDED,
+  RUN_STATUS_FAILED,
+  RUN_STATUS_STOPPED,
+]

api-client/src/runs/index.ts

@@ -10,6 +10,6 @@ export { getCommands } from './commands/getCommands'
 export { createRunAction } from './createRunAction'
 export * from './createLabwareOffset'
 export * from './createLabwareDefinition'
-
+export * from './constants'
 export * from './types'
 export type { CreateRunData } from './createRun'

api-client/src/runs/types.ts

@@ -4,6 +4,7 @@ import type {
   LoadedPipette,
   ModuleModel,
   RunTimeCommand,
+  RunTimeParameter,
 } from '@opentrons/shared-data'
 import type { ResourceLink, ErrorDetails } from '../types'
 export * from './commands/types'
@@ -47,7 +48,7 @@ export interface LegacyGoodRunData {
   modules: LoadedModule[]
   protocolId?: string
   labwareOffsets?: LabwareOffset[]
-  runTimeParameterValues?: RunTimeParameterCreateData
+  runTimeParameters: RunTimeParameter[]
 }
 
 export interface KnownGoodRunData extends LegacyGoodRunData {

app/src/assets/localization/en/protocol_setup.json

@@ -48,6 +48,7 @@
   "confirm_values": "Confirm values",
   "connect_all_hardware": "Connect and calibrate all hardware first",
   "connect_all_mod": "Connect all modules first",
+  "connect_modules_for_controls": "Connect modules to see controls",
   "connection_info_not_available": "Connection info not available once run has started",
   "connection_status": "Connection Status",
   "currently_configured": "Currently configured",
@@ -236,6 +237,7 @@
   "run_disabled_modules_and_calibration_not_complete": "Make sure robot calibration is complete and all modules are connected before proceeding to run",
   "run_disabled_modules_not_connected": "Make sure all modules are connected before proceeding to run",
   "run_labware_position_check": "run labware position check",
+  "run_never_started": "Run was never started",
   "run": "Run",
   "secure_labware_instructions": "Secure labware instructions",
   "secure_labware_modal": "Securing labware to the {{name}}",

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

@@ -15,6 +15,7 @@ import {
   RUN_STATUS_SUCCEEDED,
   RUN_STATUS_BLOCKED_BY_OPEN_DOOR,
   RUN_STATUS_AWAITING_RECOVERY,
+  RUN_STATUSES_TERMINAL,
 } from '@opentrons/api-client'
 import {
   useModulesQuery,
@@ -128,11 +129,6 @@ const CANCELLABLE_STATUSES = [
   RUN_STATUS_IDLE,
   RUN_STATUS_AWAITING_RECOVERY,
 ]
-const RUN_OVER_STATUSES: RunStatus[] = [
-  RUN_STATUS_FAILED,
-  RUN_STATUS_STOPPED,
-  RUN_STATUS_SUCCEEDED,
-]
 
 interface ProtocolRunHeaderProps {
   protocolRunHeaderRef: React.RefObject<HTMLDivElement> | null
@@ -214,7 +210,11 @@ export function ProtocolRunHeader({
       if (runStatus === RUN_STATUS_IDLE) {
         setShowDropTipBanner(true)
         setPipettesWithTip([])
-      } else if (runStatus != null && RUN_OVER_STATUSES.includes(runStatus)) {
+      } else if (
+        runStatus != null &&
+        // @ts-expect-error runStatus expected to possibly not be terminal
+        RUN_STATUSES_TERMINAL.includes(runStatus)
+      ) {
         getPipettesWithTipAttached({
           host,
           runId,

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

@@ -1,6 +1,11 @@
 import * as React from 'react'
 import { useTranslation } from 'react-i18next'
 import styled, { css } from 'styled-components'
+import {
+  RUN_ACTION_TYPE_PLAY,
+  RUN_STATUS_STOPPED,
+  RUN_STATUSES_TERMINAL,
+} from '@opentrons/api-client'
 import { formatRunTimeParameterValue } from '@opentrons/shared-data'
 import {
   ALIGN_CENTER,
@@ -23,8 +28,11 @@ import { Banner } from '../../../atoms/Banner'
 import { Divider } from '../../../atoms/structure'
 import { Tooltip } from '../../../atoms/Tooltip'
 import { useMostRecentCompletedAnalysis } from '../../LabwarePositionCheck/useMostRecentCompletedAnalysis'
+import { useRunStatus } from '../../RunTimeControl/hooks'
+import { useNotifyRunQuery } from '../../../resources/runs'
 
 import type { RunTimeParameter } from '@opentrons/shared-data'
+import type { RunStatus } from '@opentrons/api-client'
 
 interface ProtocolRunRuntimeParametersProps {
   runId: string
@@ -34,13 +42,31 @@ export function ProtocolRunRuntimeParameters({
 }: ProtocolRunRuntimeParametersProps): JSX.Element {
   const { t } = useTranslation('protocol_setup')
   const mostRecentAnalysis = useMostRecentCompletedAnalysis(runId)
-  const runTimeParameters = mostRecentAnalysis?.runTimeParameters ?? []
-  const hasParameter = runTimeParameters.length > 0
-
-  const hasCustomValues = runTimeParameters.some(
+  const runStatus = useRunStatus(runId)
+  const isRunTerminal =
+    runStatus == null
+      ? false
+      : (RUN_STATUSES_TERMINAL as RunStatus[]).includes(runStatus)
+  // we access runTimeParameters from the run record rather than the most recent analysis
+  // because the most recent analysis may not reflect the selected run (e.g. cloning a run
+  // from a historical protocol run from the device details page)
+  const run = useNotifyRunQuery(runId).data
+  const runTimeParameters =
+    (isRunTerminal
+      ? run?.data?.runTimeParameters
+      : mostRecentAnalysis?.runTimeParameters) ?? []
+  const hasRunTimeParameters = runTimeParameters.length > 0
+  const hasCustomRunTimeParameterValues = runTimeParameters.some(
     parameter => parameter.value !== parameter.default
   )
 
+  const runActions = run?.data.actions
+  const hasRunStarted = runActions?.some(
+    action => action.actionType === RUN_ACTION_TYPE_PLAY
+  )
+  const isRunCancelledWithoutStarting =
+    !hasRunStarted && runStatus === RUN_STATUS_STOPPED
+
   return (
     <>
       <Flex
@@ -56,13 +82,15 @@ export function ProtocolRunRuntimeParameters({
           <StyledText as="h3" fontWeight={TYPOGRAPHY.fontWeightSemiBold}>
             {t('parameters')}
           </StyledText>
-          {hasParameter ? (
+          {hasRunTimeParameters ? (
             <StyledText as="label" color={COLORS.grey60}>
-              {hasCustomValues ? t('custom_values') : t('default_values')}
+              {hasCustomRunTimeParameterValues
+                ? t('custom_values')
+                : t('default_values')}
             </StyledText>
           ) : null}
         </Flex>
-        {hasParameter ? (
+        {hasRunTimeParameters ? (
           <Banner
             type="informing"
             width="100%"
@@ -77,9 +105,14 @@ export function ProtocolRunRuntimeParameters({
           </Banner>
         ) : null}
       </Flex>
-      {!hasParameter ? (
+      {!hasRunTimeParameters ? (
         <Flex padding={SPACING.spacing16}>
-          <InfoScreen contentType="parameters" />
+          <InfoScreen
+            contentType={
+              isRunCancelledWithoutStarting ? 'runNotStarted' : 'parameters'
+            }
+            t={t}
+          />
         </Flex>
       ) : (
         <>

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

@@ -1,12 +1,17 @@
 import * as React from 'react'
+import { UseQueryResult } from 'react-query'
 import { describe, it, vi, beforeEach, afterEach, expect } from 'vitest'
 import { screen } from '@testing-library/react'
 import { when } from 'vitest-when'
 
+import { Run } from '@opentrons/api-client'
 import { InfoScreen } from '@opentrons/components'
 import { renderWithProviders } from '../../../../__testing-utils__'
 import { i18n } from '../../../../i18n'
 import { useMostRecentCompletedAnalysis } from '../../../LabwarePositionCheck/useMostRecentCompletedAnalysis'
+import { useRunStatus } from '../../../RunTimeControl/hooks'
+import { useNotifyRunQuery } from '../../../../resources/runs'
+import { mockSucceededRun } from '../../../RunTimeControl/__fixtures__'
 
 import { ProtocolRunRuntimeParameters } from '../ProtocolRunRunTimeParameters'
 
@@ -23,6 +28,8 @@ vi.mock('@opentrons/components', async importOriginal => {
   }
 })
 vi.mock('../../../LabwarePositionCheck/useMostRecentCompletedAnalysis')
+vi.mock('../../../RunTimeControl/hooks')
+vi.mock('../../../../resources/runs')
 
 const RUN_ID = 'mockId'
 
@@ -100,13 +107,17 @@ describe('ProtocolRunRuntimeParameters', () => {
       .thenReturn({
         runTimeParameters: mockRunTimeParameterData,
       } as CompletedProtocolAnalysis)
+    vi.mocked(useRunStatus).mockReturnValue('running')
+    vi.mocked(useNotifyRunQuery).mockReturnValue(({
+      data: { data: mockSucceededRun },
+    } as unknown) as UseQueryResult<Run>)
   })
 
   afterEach(() => {
     vi.resetAllMocks()
   })
 
-  it('should render title, and banner when RunTimeParameters are note empty and all values are default', () => {
+  it('should render title, and banner when RunTimeParameters are not empty and all values are default', () => {
     render(props)
     screen.getByText('Parameters')
     screen.getByText('Default values')
@@ -116,7 +127,7 @@ describe('ProtocolRunRuntimeParameters', () => {
     screen.getByText('Value')
   })
 
-  it('should render title, and banner when RunTimeParameters are note empty and some value is changed', () => {
+  it('should render title, and banner when RunTimeParameters are not empty and some value is changed', () => {
     vi.mocked(useMostRecentCompletedAnalysis).mockReturnValue({
       runTimeParameters: [
         ...mockRunTimeParameterData,
@@ -139,7 +150,7 @@ describe('ProtocolRunRuntimeParameters', () => {
     screen.getByText('Value')
   })
 
-  it('should render RunTimeParameters when RunTimeParameters are note empty', () => {
+  it('should render RunTimeParameters when RunTimeParameters are not empty', () => {
     render(props)
     screen.getByText('Dry Run')
     screen.getByText('Off')

app/src/organisms/Devices/hooks/useRunStatuses.ts

@@ -1,15 +1,15 @@
 import {
+  RUN_STATUSES_TERMINAL,
   RUN_STATUS_AWAITING_RECOVERY,
-  RUN_STATUS_FAILED,
   RUN_STATUS_IDLE,
   RUN_STATUS_PAUSED,
   RUN_STATUS_RUNNING,
-  RUN_STATUS_STOPPED,
-  RUN_STATUS_SUCCEEDED,
 } from '@opentrons/api-client'
 import { useCurrentRunId } from '../../ProtocolUpload/hooks'
 import { useRunStatus } from '../../RunTimeControl/hooks'
 
+import type { RunStatus } from '@opentrons/api-client'
+
 interface RunStatusesInfo {
   isRunStill: boolean
   isRunTerminal: boolean
@@ -29,9 +29,9 @@ export function useRunStatuses(): RunStatusesInfo {
     runStatus === RUN_STATUS_RUNNING ||
     runStatus === RUN_STATUS_AWAITING_RECOVERY
   const isRunTerminal =
-    runStatus === RUN_STATUS_SUCCEEDED ||
-    runStatus === RUN_STATUS_STOPPED ||
-    runStatus === RUN_STATUS_FAILED
+    runStatus != null
+      ? (RUN_STATUSES_TERMINAL as RunStatus[]).includes(runStatus)
+      : false
   const isRunStill = isRunTerminal || isRunIdle
 
   return { isRunStill, isRunTerminal, isRunIdle, isRunRunning }

app/src/organisms/InterventionModal/__fixtures__/index.ts

@@ -188,6 +188,7 @@ export const mockRunData: RunData = {
   pipettes: [],
   labware: [mockLabwareOnModule, mockLabwareOnSlot, mockLabwareOffDeck],
   modules: [mockModule],
+  runTimeParameters: [],
 }
 
 export const mockLabwareRenderInfo = [

app/src/organisms/OnDeviceDisplay/RobotDashboard/__tests__/RecentRunProtocolCarousel.test.tsx

@@ -26,6 +26,7 @@ const mockRun = {
   pipettes: [],
   protocolId: 'mockSortedProtocolID',
   status: 'stopped',
+  runTimeParameters: [],
 }
 
 const render = (