refactor(app, shared-data, api-client, react-api-client): cleanup LPC flows (#17879)

Closes EXEC-1359

Author: mjhuff

api-client/src/protocols/createProtocolAnalysis.ts

@@ -8,26 +8,30 @@ import type {
   RunTimeParameterValuesCreateData,
 } from '../runs'
 
-interface CreateProtocolAnalysisData {
+export interface CreateProtocolAnalysisData {
   runTimeParameterValues: RunTimeParameterValuesCreateData
   runTimeParameterFiles: RunTimeParameterFilesCreateData
   forceReAnalyze: boolean
 }
 
+export interface ProtocolAnalysisSummaryResult {
+  data: ProtocolAnalysisSummary[]
+}
+
 export function createProtocolAnalysis(
   config: HostConfig,
   protocolKey: string,
   runTimeParameterValues?: RunTimeParameterValuesCreateData,
   runTimeParameterFiles?: RunTimeParameterFilesCreateData,
   forceReAnalyze?: boolean
-): ResponsePromise<ProtocolAnalysisSummary[]> {
+): ResponsePromise<ProtocolAnalysisSummaryResult> {
   const data = {
     runTimeParameterValues: runTimeParameterValues ?? {},
     runTimeParameterFiles: runTimeParameterFiles ?? {},
     forceReAnalyze: forceReAnalyze ?? false,
   }
   const response = request<
-    ProtocolAnalysisSummary[],
+    ProtocolAnalysisSummaryResult,
     { data: CreateProtocolAnalysisData }
   >(POST, `/protocols/${protocolKey}/analyses`, { data }, config)
   return response

api-client/src/protocols/index.ts

@@ -1,5 +1,5 @@
 export { createProtocol } from './createProtocol'
-export { createProtocolAnalysis } from './createProtocolAnalysis'
+export * from './createProtocolAnalysis'
 export { deleteProtocol } from './deleteProtocol'
 export { getCsvFiles } from './getCsvFiles'
 export { getProtocol } from './getProtocol'

app/src/molecules/OffsetVector/__tests__/OffsetVector.test.tsx app/src/molecules/LegacyOffsetVector/__tests__/LegacyOffsetVector.test.tsx

@@ -4,16 +4,16 @@ import { describe, it, expect, beforeEach } from 'vitest'
 import { SPACING, TYPOGRAPHY } from '@opentrons/components'
 import { renderWithProviders } from '/app/__testing-utils__'
 
-import { OffsetVector } from '../'
+import { LegacyOffsetVector } from '../'
 
 import type { ComponentProps } from 'react'
 
-const render = (props: ComponentProps<typeof OffsetVector>) => {
-  return renderWithProviders(<OffsetVector {...props} />)[0]
+const render = (props: ComponentProps<typeof LegacyOffsetVector>) => {
+  return renderWithProviders(<LegacyOffsetVector {...props} />)[0]
 }
 
 describe('OffsetVector', () => {
-  let props: ComponentProps<typeof OffsetVector>
+  let props: ComponentProps<typeof LegacyOffsetVector>
 
   beforeEach(() => {
     props = {

app/src/molecules/OffsetVector/index.tsx app/src/molecules/LegacyOffsetVector/index.tsx

@@ -8,14 +8,16 @@ import {
 import type { ComponentProps } from 'react'
 import type { StyleProps } from '@opentrons/components'
 
-interface OffsetVectorProps extends StyleProps {
+interface LegacyOffsetVectorProps extends StyleProps {
   x: number
   y: number
   z: number
   as?: ComponentProps<typeof LegacyStyledText>['as']
 }
 
-export function OffsetVector(props: OffsetVectorProps): JSX.Element {
+export function LegacyOffsetVector(
+  props: LegacyOffsetVectorProps
+): JSX.Element {
   const { x, y, z, as = 'h6', ...styleProps } = props
   return (
     <Flex {...styleProps}>

app/src/organisms/Desktop/Devices/HistoricalProtocolRunDrawer.tsx

@@ -31,7 +31,7 @@ import { useCsvFileQuery } from '@opentrons/react-api-client'
 import { DownloadCsvFileLink } from './DownloadCsvFileLink'
 import { useMostRecentCompletedAnalysis } from '/app/resources/runs'
 import { useDeckCalibrationData } from './hooks'
-import { OffsetVector } from '/app/molecules/OffsetVector'
+import { LegacyOffsetVector } from '/app/molecules/LegacyOffsetVector'
 import type { LabwareOffset, RunData } from '@opentrons/api-client'
 
 interface HistoricalProtocolRunDrawerProps {
@@ -261,7 +261,7 @@ export function HistoricalProtocolRunDrawer(
                   </LegacyStyledText>
                 </Box>
                 <Box width="34%">
-                  <OffsetVector
+                  <LegacyOffsetVector
                     {...offset.vector}
                     fontSize={TYPOGRAPHY.fontSizeLabel}
                     as="p"

app/src/organisms/Desktop/Devices/ProtocolRun/LabwareInfoOverlay.tsx

@@ -17,7 +17,7 @@ import {
   LegacyStyledText,
   TYPOGRAPHY,
 } from '@opentrons/components'
-import { OffsetVector } from '/app/molecules/OffsetVector'
+import { LegacyOffsetVector } from '/app/molecules/LegacyOffsetVector'
 
 import type { LabwareDefinition2 } from '@opentrons/shared-data'
 import { useLabwareOffsetForLabware } from './useLabwareOffsetForLabware'
@@ -79,7 +79,7 @@ const LabwareInfo = (props: LabwareInfoProps): JSX.Element | null => {
           >
             {t('offset_data')}
           </LegacyStyledText>
-          <OffsetVector {...vector} />
+          <LegacyOffsetVector {...vector} />
         </>
       )}
     </Box>

app/src/organisms/Desktop/Devices/ProtocolRun/SetupLabware/__tests__/SetupLabware.test.tsx

@@ -7,7 +7,6 @@ import { useHoverTooltip } from '@opentrons/components'
 
 import { renderWithProviders } from '/app/__testing-utils__'
 import { i18n } from '/app/i18n'
-import { LegacyLabwarePositionCheck } from '/app/organisms/LegacyLabwarePositionCheck'
 import { getModuleTypesThatRequireExtraAttention } from '../../utils/getModuleTypesThatRequireExtraAttention'
 import { getIsLabwareOffsetCodeSnippetsOn } from '/app/redux/config'
 import { SetupLabwareList } from '../SetupLabwareList'
@@ -66,9 +65,6 @@ describe('SetupLabware', () => {
       .calledWith(expect.anything())
       .thenReturn([])
 
-    vi.mocked(LegacyLabwarePositionCheck).mockReturnValue(
-      <div>mock Labware Position Check</div>
-    )
     when(vi.mocked(useUnmatchedModulesForProtocol))
       .calledWith(ROBOT_NAME, RUN_ID)
       .thenReturn({

app/src/organisms/Desktop/Devices/ProtocolRun/SetupLabwarePositionCheck/CurrentOffsetsTable.tsx app/src/organisms/Desktop/Devices/ProtocolRun/SetupLabwarePositionCheck/OT2SetupLPC/LegacyCurrentOffsetsTable.tsx

@@ -21,8 +21,8 @@ import {
 } from '@opentrons/components'
 
 import { getIsLabwareOffsetCodeSnippetsOn } from '/app/redux/config'
-import { LabwareOffsetTabs } from '/app/organisms/LabwareOffsetTabs'
-import { OffsetVector } from '/app/molecules/OffsetVector'
+import { LegacyLabwareOffsetTabs } from '/app/organisms/LegacyLabwareOffsetTabs'
+import { LegacyOffsetVector } from '/app/molecules/LegacyOffsetVector'
 import { LabwareOffsetSnippet } from '/app/molecules/LabwareOffsetSnippet'
 import { getDisplayLocation } from '/app/organisms/LegacyLabwarePositionCheck/utils/getDisplayLocation'
 import type { LabwareOffset } from '@opentrons/api-client'
@@ -57,14 +57,14 @@ const OffsetTableDatum = styled('td')`
   text-overflow: wrap;
 `
 
-interface CurrentOffsetsTableProps {
+interface LegacyCurrentOffsetsTableProps {
   currentOffsets: LabwareOffset[]
   commands: RunTimeCommand[]
   labware: LoadedLabware[]
   modules: LoadedModule[]
 }
-export function CurrentOffsetsTable(
-  props: CurrentOffsetsTableProps
+export function LegacyCurrentOffsetsTable(
+  props: LegacyCurrentOffsetsTableProps
 ): JSX.Element {
   const { currentOffsets, commands, labware, modules } = props
   const { t, i18n } = useTranslation(['labware_position_check', 'shared'])
@@ -112,7 +112,7 @@ export function CurrentOffsetsTable(
                     ${BORDERS.borderRadius8} 0;
                 `}
               >
-                <OffsetVector {...offset.vector} />
+                <LegacyOffsetVector {...offset.vector} />
               </OffsetTableDatum>
             </OffsetTableRow>
           )
@@ -154,7 +154,7 @@ export function CurrentOffsetsTable(
         {i18n.format(t('applied_offset_data'), 'upperCase')}
       </LegacyStyledText>
       {isLabwareOffsetCodeSnippetsOn ? (
-        <LabwareOffsetTabs
+        <LegacyLabwareOffsetTabs
           TableComponent={TableComponent}
           JupyterComponent={JupyterSnippet}
           CommandLineComponent={CommandLineSnippet}

app/src/organisms/Desktop/Devices/ProtocolRun/SetupLabwarePositionCheck/OT2SetupLPC.tsx app/src/organisms/Desktop/Devices/ProtocolRun/SetupLabwarePositionCheck/OT2SetupLPC/index.tsx

@@ -19,7 +19,7 @@ import {
 import { useProtocolQuery } from '@opentrons/react-api-client'
 
 import { useStoredProtocolAnalysis } from '/app/resources/analysis'
-import { CurrentOffsetsTable } from './CurrentOffsetsTable'
+import { LegacyCurrentOffsetsTable } from './LegacyCurrentOffsetsTable'
 import { getLatestCurrentOffsets } from '/app/transformations/runs'
 import {
   useNotifyRunQuery,
@@ -29,7 +29,7 @@ import {
 import { useRobotType } from '/app/redux-resources/robots'
 import { useLPCFlows, LPCFlows } from '/app/organisms/LabwarePositionCheck'
 
-import type { SetupLabwarePositionCheckProps } from '.'
+import type { SetupLabwarePositionCheckProps } from '..'
 import type { LabwareOffset } from '@opentrons/api-client'
 
 export function OT2SetupLPC(
@@ -95,7 +95,7 @@ export function OT2SetupLPC(
       gridGap={SPACING.spacing16}
     >
       {nonIdentityOffsets.length > 0 ? (
-        <CurrentOffsetsTable
+        <LegacyCurrentOffsetsTable
           currentOffsets={nonIdentityOffsets}
           commands={protocolData?.commands ?? []}
           labware={protocolData?.labware ?? []}

app/src/organisms/LabwarePositionCheck/LPCContentContainer.tsx

@@ -23,7 +23,6 @@ import {
 } from '@opentrons/components'
 
 import { StepMeter } from '/app/atoms/StepMeter'
-// TODO(jh, 02-05-25): Move ChildNavigation to molecules.
 // eslint-disable-next-line opentrons/no-imports-across-applications
 import { ChildNavigation } from '/app/organisms/ODD/ChildNavigation'
 import {
@@ -181,7 +180,6 @@ function DesktopFooterContent({
   )
 }
 
-// TODO(jh, 03-11-25): Update the link/styling after Product/Design provide input.
 function NeedHelpLink(): JSX.Element {
   const { t } = useTranslation('labware_position_check')
 

app/src/organisms/LabwarePositionCheck/LPCFlows/hooks/useCompatibleAnalysis.ts

@@ -13,12 +13,9 @@ import {
 import type { Run } from '@opentrons/api-client'
 import type {
   CompletedProtocolAnalysis,
-  ProtocolAnalysisSummary,
   RunTimeCommand,
 } from '@opentrons/shared-data'
 
-// TODO(jh, 03-17-25): Add testing here.
-
 // TODO(jh, 03-14-25): Remove this adapter logic and Mixpanel event once analytics
 //  indicate that users no longer run old analyses.
 
@@ -74,10 +71,9 @@ export function useCompatibleAnalysis(
           {
             onSuccess: res => {
               if (res != null) {
-                // @ts-expect-error TODO(jh, 03-17-25): Something is wrong with the typing here.
-                const data = res.data as ProtocolAnalysisSummary[]
+                const data = res.data
                 // The last analysis is the most recent.
-                setCompatibleAnalysisId(data[data.length - 1].id)
+                setCompatibleAnalysisId(data[data.length - 1].id as string)
               }
             },
           }

app/src/organisms/LabwarePositionCheck/LPCFlows/useLPCFlows.ts

@@ -121,8 +121,6 @@ export function useLPCFlows({
     createLabwareDefinition,
   } = useCreateMaintenanceRunLabwareDefinitionMutation()
   const { deleteMaintenanceRun } = useDeleteMaintenanceRunMutation()
-  // TODO(jh, 01-14-25): There's no external error handing if LPC fails this series of POST requests.
-  // If the server doesn't absorb this functionality for the redesign, add error handling.
   useRunLoadedLabwareDefinitions(runId ?? null, {
     onSuccess: res => {
       void Promise.all(

app/src/organisms/LabwarePositionCheck/hooks/useLPCCommands/index.ts

@@ -45,8 +45,6 @@ export type UseLPCCommandsResult = UseHandleJogResult &
     home: () => Promise<void>
   }
 
-// TODO(jh, 03-14-25): Add testing here!
-
 // Consolidates all command handlers and handler state for injection into LPC.
 export function useLPCCommands(
   props: UseLPCCommandsProps

app/src/organisms/LabwarePositionCheck/hooks/useLPCCommands/utils.ts

@@ -1,10 +1,6 @@
-import type { RunTimeCommand } from '@opentrons/shared-data'
+import { splitLabwareDefURI } from '@opentrons/shared-data'
 
-interface URIDetails {
-  loadName: string
-  namespace: string
-  version: number
-}
+import type { RunTimeCommand } from '@opentrons/shared-data'
 
 export interface StackerLwDetails {
   labwareId: string
@@ -21,7 +17,7 @@ export function mapFlexStackerLabware(
     if (command.commandType === 'flexStacker/retrieve' && command.result) {
       // Primary labware case.
       if (command.result.labwareId) {
-        const { version, namespace, loadName } = splitLabwareDefUri(
+        const { version, namespace, loadName } = splitLabwareDefURI(
           command.result.primaryLabwareURI
         )
 
@@ -35,7 +31,7 @@ export function mapFlexStackerLabware(
 
       // Adapter labware case (if present).
       if (command.result.adapterId) {
-        const { version, namespace, loadName } = splitLabwareDefUri(
+        const { version, namespace, loadName } = splitLabwareDefURI(
           command.result.adapterLabwareURI
         )
 
@@ -50,24 +46,3 @@ export function mapFlexStackerLabware(
     return acc
   }, [])
 }
-
-// TODO(jh, 03-14-25): This util should live in shared-data with getLabwareDefURI.
-
-function splitLabwareDefUri(uri: string): URIDetails {
-  const parts = uri.split('/')
-
-  if (parts.length !== 3) {
-    console.error(
-      `Error: Invalid URI format. Expected 3 parts, got ${parts.length}`
-    )
-    return { loadName: '', namespace: '', version: -1 }
-  } else {
-    const [namespace, loadName, versionStr] = parts
-
-    return {
-      namespace,
-      loadName,
-      version: Number(versionStr),
-    }
-  }
-}

app/src/organisms/LabwarePositionCheck/steps/HandleLabware/EditOffset/PrepareLabware/LPCDeck.tsx

@@ -15,6 +15,7 @@ import {
 
 import {
   OFFSET_KIND_DEFAULT,
+  selectSelectedLwAdapterDef,
   selectSelectedLwDef,
   selectSelectedLwOverview,
 } from '/app/redux/protocol-runs'
@@ -29,10 +30,8 @@ import type {
   SelectedLwOverview,
 } from '/app/redux/protocol-runs'
 
-// TODO(jh, 03-14-25): Current designs/behavior do not include rendering the
-//  adapter beneath the labware if present, but let's add this!
-
-/** On the LPC deck, the only visible labware should be the labware with an actively edited offset.
+/** On the LPC deck, the only visible labware should be the labware with an actively edited offset (the topmost)
+ * and the labware immediately beneath the topmost labware.
  * Modules are always visible if they are not in the actively utilized deck slot.
  * If modules are in the actively utilized deck slot:
  *  If LPCing the default offset, ensure the module is always cleared.
@@ -48,6 +47,7 @@ export function LPCDeck({ runId }: EditOffsetContentProps): JSX.Element {
   const labwareDef = useSelector(
     selectSelectedLwDef(runId)
   ) as LabwareDefinition2
+  const adapterLwDef = useSelector(selectSelectedLwAdapterDef(runId))
 
   const offsetLocationDetails = selectedLwInfo.offsetLocationDetails as OffsetLocationDetails
   const { closestBeneathModuleModel, kind: offsetKind } = offsetLocationDetails
@@ -80,15 +80,29 @@ export function LPCDeck({ runId }: EditOffsetContentProps): JSX.Element {
     }
   }
 
-  const buildLabwareOnDeck = (): LabwareOnDeck[] => [
-    {
+  const buildLabwareOnDeck = (): LabwareOnDeck[] => {
+    const lpcLabwareOnDeck = {
       labwareLocation: {
         ...offsetLocationDetails,
         slotName: offsetLocationDetails.addressableAreaName,
       },
       definition: labwareDef,
-    },
-  ]
+    }
+    const adapterLwOnDeck =
+      adapterLwDef != null
+        ? {
+            labwareLocation: {
+              ...offsetLocationDetails,
+              slotName: offsetLocationDetails.addressableAreaName,
+            },
+            definition: adapterLwDef,
+          }
+        : null
+
+    return adapterLwOnDeck != null
+      ? [adapterLwOnDeck, lpcLabwareOnDeck]
+      : [lpcLabwareOnDeck]
+  }
 
   return (
     <Flex css={DECK_CONTAINER_STYLE}>

app/src/organisms/LabwarePositionCheck/steps/HandleLabware/LPCLabwareDetails/index.tsx

@@ -57,7 +57,6 @@ export function LPCLabwareDetails(props: LPCWizardContentProps): JSX.Element {
     }
   }
 
-  // TODO(jh, 03-14-25): Add a save state spinner.
   const onHeaderSave = (): void => {
     if (doWorkingOffsetsExist && !isSavingWorkingOffsetsLoading) {
       void saveWorkingOffsets().then(updatedOffsetData => {