Add todo comments for remaining <Labware>/<LabwareRender> call sites.

SyntaxColoring · SyntaxColoring · commit 7a0b26b7ca83 · 2025-06-26T11:27:56.000-04:00
diff --git a/app/src/organisms/ErrorRecoveryFlows/shared/TwoColLwInfoAndDeck.tsx b/app/src/organisms/ErrorRecoveryFlows/shared/TwoColLwInfoAndDeck.tsx
@@ -232,10 +232,12 @@ export function TwoColLwInfoAndDeck(
                       def={moduleDef}
                       x={x}
                       y={y}
+                      // TODO BEFORE MERGE: Unrelated bug, but should this have been passed to LabwareRender too?
                       orientation={inferModuleOrientationFromXCoordinate(x)}
                     >
                       {nestedLabwareDef != null &&
                       nestedLabwareId !== failedLwId ? (
+                        // TODO BEFORE MERGE
                         <LabwareRender definition={nestedLabwareDef} />
                       ) : null}
                     </Module>
@@ -244,6 +246,7 @@ export function TwoColLwInfoAndDeck(
                 {labwareRenderInfo
                   .filter(l => l.labwareId !== failedLwId)
                   .map(({ x, y, labwareDef, labwareId }) => (
+                    // TODO BEFORE MERGE
                     <g key={labwareId} transform={`translate(${x},${y})`}>
                       {labwareDef != null && labwareId !== failedLwId ? (
                         <LabwareRender definition={labwareDef} />
diff --git a/app/src/organisms/InterventionModal/MoveLabwareInterventionContent.tsx b/app/src/organisms/InterventionModal/MoveLabwareInterventionContent.tsx
@@ -216,10 +216,12 @@ export function MoveLabwareInterventionContent({
                         def={moduleDef}
                         x={x}
                         y={y}
+                        // TODO BEFORE MERGE: Same thing, should this have been passed to LabwareRender
                         orientation={inferModuleOrientationFromXCoordinate(x)}
                       >
                         {nestedLabwareDef != null &&
                         nestedLabwareId !== command.params.labwareId ? (
+                          // TODO BEFORE MERGE: Needs-to-labware coords, I think
                           <LabwareRender definition={nestedLabwareDef} />
                         ) : null}
                       </Module>
@@ -228,6 +230,7 @@ export function MoveLabwareInterventionContent({
                   {labwareRenderInfo
                     .filter(l => l.labwareId !== command.params.labwareId)
                     .map(({ x, y, labwareDef, labwareId }) => (
+                      // TODO BEFORE MERGE
                       <g key={labwareId} transform={`translate(${x},${y})`}>
                         {labwareDef != null &&
                         labwareId !== command.params.labwareId ? (
diff --git a/app/src/organisms/LabwarePositionCheck/steps/HandleLabware/EditOffset/CheckLabware/LPCLabwareJogRender.tsx b/app/src/organisms/LabwarePositionCheck/steps/HandleLabware/EditOffset/CheckLabware/LPCLabwareJogRender.tsx
@@ -40,6 +40,7 @@ export function LPCLabwareJogRender({
 
   return (
     <Flex css={RENDER_CONTAINER_STYLE}>
+      {/* TODO BEFORE MERGE: Is this right? This seems too small to be a deck map viewbox. Is this actually supposed to be a bounding box around the labware? If so, it needs updates for schema 3. */}
       <RobotWorkSpace viewBox={DECK_MAP_VIEWBOX}>
         {() => (
           <>
diff --git a/app/src/organisms/LegacyLabwarePositionCheck/JogToWell.tsx b/app/src/organisms/LegacyLabwarePositionCheck/JogToWell.tsx
@@ -147,6 +147,7 @@ export const JogToWell = (props: JogToWellProps): JSX.Element | null => {
           <LiveOffsetValue {...liveOffset} />
         </Flex>
         <Flex flex="1" alignItems={ALIGN_CENTER} gridGap={SPACING.spacing20}>
+          {/* TODO BEFORE MERGE: Same questions about DECK_MAP_VIEWBOX */}
           <RobotWorkSpace viewBox={DECK_MAP_VIEWBOX}>
             {() => (
               <>
diff --git a/app/src/organisms/ODD/ProtocolSetup/ProtocolSetupLabware/SetupLabwareStackView.tsx b/app/src/organisms/ODD/ProtocolSetup/ProtocolSetupLabware/SetupLabwareStackView.tsx
@@ -182,6 +182,7 @@ export function SetupLabwareStackView({
             </StyledText>
           ) : null}
           <LabwareThumbnail
+            // TODO BEFORE MERGE
             viewBox={`${labwareCornerOffsetFromSlot.x} ${labwareCornerOffsetFromSlot.y} ${labwareDimensions.xDimension} ${labwareDimensions.yDimension}`}
           >
             <g
diff --git a/app/src/organisms/WellSelection/Selection384Wells.tsx b/app/src/organisms/WellSelection/Selection384Wells.tsx
@@ -129,6 +129,7 @@ export function Selection384Wells({
   }
   return (
     <Flex width="100%">
+      {/* TODO BEFORE MERGE: Not sure how this is working without a parent <svg>. */}
       {labwareRender}
       <Flex
         flex="1 0 0"
diff --git a/components/src/hardware-sim/BaseDeck/BaseDeck.tsx b/components/src/hardware-sim/BaseDeck/BaseDeck.tsx
@@ -306,10 +306,12 @@ export function BaseDeck(props: BaseDeckProps): JSX.Element {
               >
                 {nestedLabwareDef != null ? (
                   <g cursor={onLabwareClick != null ? 'pointer' : ''}>
+                    {/* TODO BEFORE MERGE: Deal with labware-on-module positioning somehow */}
                     <LabwareRender
                       definition={nestedLabwareDef}
                       onLabwareClick={onLabwareClick}
                       wellFill={nestedLabwareWellFill}
+                      // TODO BEFORE MERGE: Deal with rotation here somehow
                       shouldRotateAdapterOrientation={
                         inferModuleOrientationFromXCoordinate(
                           slotPosition[0]
@@ -367,10 +369,12 @@ export function BaseDeck(props: BaseDeckProps): JSX.Element {
                       cursor={onLabwareClick != null ? 'pointer' : ''}
                       transform={`translate(${STACKER_HOPPER_LABWARE_X_OFFSET}, ${STACKER_HOPPER_LABWARE_Y_OFFSET})`}
                     >
+                      {/* TODO BEFORE MERGE: Deal with labware-on-stacker (???) positioning here somehow */}
                       <LabwareRender
                         definition={nestedLabwareDef}
                         onLabwareClick={onLabwareClick}
                         wellFill={nestedLabwareWellFill}
+                        // TODO BEFORE MERGE: Deal with rotation here somehow
                         shouldRotateAdapterOrientation={
                           inferModuleOrientationFromXCoordinate(
                             slotPosition[0]
@@ -417,6 +421,8 @@ export function BaseDeck(props: BaseDeckProps): JSX.Element {
 
             return slotPosition != null ? (
               <g
+                // TODO BEFORE MERGE: Flesh out labware-in-deck-slot positioning.
+                // But also, where in this file are we handling labware-on-adapter-on-*?
                 key={labwareLocation.slotName}
                 transform={`translate(${slotPosition[0].toString()},${slotPosition[1].toString()})`}
                 cursor={onLabwareClick != null ? 'pointer' : ''}
diff --git a/components/src/hardware-sim/Deck/MoveLabwareOnDeck.tsx b/components/src/hardware-sim/Deck/MoveLabwareOnDeck.tsx
@@ -236,6 +236,7 @@ export function MoveLabwareOnDeck(
       {backgroundItems}
       <AnimatedG style={{ x: springProps.x, y: springProps.y }}>
         <g
+          // TODO BEFORE MERGE
           transform={`translate(${cornerOffsetFromSlot.x}, ${cornerOffsetFromSlot.y})`}
         >
           <LabwareRender definition={movedLabwareDef} highlight={true} />
diff --git a/components/src/hardware-sim/Labware/LabwareRender.stories.tsx b/components/src/hardware-sim/Labware/LabwareRender.stories.tsx
@@ -39,6 +39,7 @@ export default {
   decorators: [
     Story => (
       <RobotWorkSpace
+        // TODO BEFORE MERGE
         viewBox={`0 0 ${fixture96Plate.dimensions.xDimension} ${fixture96Plate.dimensions.yDimension}`}
       >
         {() => <Story />}
diff --git a/components/src/hardware-sim/Labware/labwareInternals/LabwareWellLabels.tsx b/components/src/hardware-sim/Labware/labwareInternals/LabwareWellLabels.tsx
@@ -19,6 +19,7 @@ interface LabwareWellLabelsProps {
   wellLabelColor?: string
 }
 
+// TODO BEFORE MERGE: Go through all this (and other labwareInternals files) and make sure it's still OK with labware schema 3
 const Labels = (props: {
   definition: LabwareDefinition
   wells: string[]
diff --git a/components/src/hardware-sim/Labware/labwareInternals/WellLabels.tsx b/components/src/hardware-sim/Labware/labwareInternals/WellLabels.tsx
@@ -26,6 +26,7 @@ export interface WellLabelsProps {
   wellLabelColor?: string
 }
 
+// TODO BEFORE MERGE: Go through all this and make sure it's still OK with schema 3
 const Labels = (props: {
   definition: LabwareDefinition
   wells: string[]
diff --git a/components/src/hardware-sim/Module/Module.stories.tsx b/components/src/hardware-sim/Module/Module.stories.tsx
@@ -40,6 +40,7 @@ const Template: Story<{
   innerProps: {}
 }> = args => {
   return (
+    // TODO BEFORE MERGE, maybe
     <RobotCoordinateSpace height="100vh" width="100vw" viewBox="0 -50 200 320">
       <ModuleComponent
         def={getModuleDef2(args.model)}
diff --git a/components/src/hardware-sim/Module/index.tsx b/components/src/hardware-sim/Module/index.tsx
@@ -84,6 +84,7 @@ export const Module = (props: Props): JSX.Element => {
   } = props
   const moduleType = getModuleType(def.model)
 
+  // TODO BEFORE MERGE
   const { x: labwareOffsetX, y: labwareOffsetY } = def.labwareOffset
   const {
     x: translateX,
diff --git a/components/src/hardware-sim/Pipette/PipetteRender.stories.tsx b/components/src/hardware-sim/Pipette/PipetteRender.stories.tsx
@@ -38,6 +38,7 @@ const Template: Story<{
 }> = args => {
   const labwareDef = labwareDefMap[args.labwareName]
   return (
+    // TODO BEFORE MERGE
     <RobotWorkSpace viewBox={DECK_MAP_VIEWBOX}>
       {() => (
         <Fragment>
diff --git a/components/src/hardware-sim/Pipette/PipetteRender.tsx b/components/src/hardware-sim/Pipette/PipetteRender.tsx
@@ -52,6 +52,8 @@ export const PipetteRender = (props: PipetteRenderProps): JSX.Element => {
   }
 
   return (
+    // TODO BEFORE MERGE: Understand what how these foreign div things work and figure out if they
+    // need to be updated for schema 3.
     <RobotCoordsForeignDiv
       width={boxWidth}
       height={
diff --git a/components/src/hardware-sim/RobotCoordinateSpace/RobotCoordinateSpace.tsx b/components/src/hardware-sim/RobotCoordinateSpace/RobotCoordinateSpace.tsx
@@ -8,6 +8,8 @@ import type { ComponentProps } from 'react'
 interface RobotCoordinateSpaceProps extends ComponentProps<typeof Svg> {
   animated?: boolean
 }
+// TODO BEFORE MERGE: What is the difference between RobotWorkSpace and RobotCoordinateSpace these days?
+// Do we still need them both? Also why does it seem like RobotWorkSpace is doing more math?
 export function RobotCoordinateSpace(
   props: RobotCoordinateSpaceProps
 ): JSX.Element {
diff --git a/labware-designer/src/organisms/CreateLabwareSandbox/index.tsx b/labware-designer/src/organisms/CreateLabwareSandbox/index.tsx
@@ -204,6 +204,7 @@ export function CreateLabwareSandbox(): JSX.Element {
                     (ot2StandardDeckV4 as unknown) as DeckDefinition
                   )
                   return (
+                    // TODO BEFORE MERGE
                     <g
                       transform={`translate(${lwPosition?.[0] ?? 0}, ${
                         lwPosition?.[1] ?? 0
@@ -222,6 +223,7 @@ export function CreateLabwareSandbox(): JSX.Element {
               <svg
                 data-testid="lw_by_itself"
                 width="100%"
+                // TODO BEFORE MERGE
                 viewBox={`0 0 ${labwareToRender.dimensions.xDimension} ${labwareToRender.dimensions.yDimension}`}
                 style={{ transform: 'scale(1, -1)' }}
               >
diff --git a/protocol-designer/src/components/organisms/Labware/SingleLabware.tsx b/protocol-designer/src/components/organisms/Labware/SingleLabware.tsx
@@ -16,6 +16,7 @@ type Props = Omit<ComponentProps<typeof LabwareRender>, 'definition'> & {
 export function SingleLabware(props: Props): JSX.Element {
   return (
     <RobotWorkSpace
+      // TODO BEFORE MERGE
       viewBox={`0 0 ${props.definition.dimensions.xDimension} ${props.definition.dimensions.yDimension}`}
     >
       {() => <LabwareRender {...props} />}
diff --git a/protocol-designer/src/components/organisms/LabwareOnDeck/index.tsx b/protocol-designer/src/components/organisms/LabwareOnDeck/index.tsx
@@ -37,6 +37,8 @@ export function LabwareOnDeck(props: LabwareOnDeckProps): JSX.Element {
     : null
 
   return (
+    // TODO BEFORE MERGE: This seems OK on its own but we need to audit LabwareOnDeck call sites
+    // to make sure they're passing in the correct schema-agnostic thing for x and y
     <g transform={`translate(${x}, ${y})`}>
       <LabwareRender
         definition={labwareOnDeck.def}
diff --git a/protocol-designer/src/components/organisms/SlotDetailModal/index.tsx b/protocol-designer/src/components/organisms/SlotDetailModal/index.tsx
@@ -139,6 +139,7 @@ export const SlotDetailModal = (
             </Flex>
             <RobotWorkSpace
               key={labwareOnDeck.def.parameters.loadName}
+              // TODO BEFORE MERGE
               viewBox={`0 0 ${labwareOnDeck.def.dimensions.xDimension} ${labwareOnDeck.def.dimensions.yDimension}`}
             >
               {() => (
diff --git a/protocol-designer/src/pages/Designer/DeckSetup/LabwareRenderOnDeck.tsx b/protocol-designer/src/pages/Designer/DeckSetup/LabwareRenderOnDeck.tsx
@@ -12,6 +12,8 @@ export function LabwareRenderOnDeck(
 ): JSX.Element {
   const { x, y, labwareDef } = props
   return (
+    // TODO BEFORE MERGE: How is this different from LabwareOnDeck
+    // TODO BEFORE MERGE: Same comment as LabwareOnDeck: This seems fine in isolation but we need to audit usages of LabwareRenderOnDeck to make sure they're passing in the correct thing for x/y
     <g transform={`translate(${x}, ${y})`}>
       <LabwareRender definition={labwareDef} />
     </g>
diff --git a/protocol-designer/src/pages/Designer/DeckSetup/SelectedItems.tsx b/protocol-designer/src/pages/Designer/DeckSetup/SelectedItems.tsx
@@ -112,6 +112,7 @@ export const SelectedItems = (props: SelectedItemsProps): JSX.Element => {
           >
             <>
               <SelectedModuleLabwareRender
+                // TODO BEFORE MERGE: Uhhh I dunno, I'm running out of steam here. Maybe this is fine but look into it.
                 topLabwareOnDeck={matchingSelectedTopLabwareOnDeck}
                 adapterDef={selectedAdapterDef}
                 moduleModel={selectedModuleModel}
@@ -132,6 +133,7 @@ export const SelectedItems = (props: SelectedItemsProps): JSX.Element => {
         </>
       ) : null}
       <SelectedLabwareRender
+        // TODO BEFORE MERGE: Uhhh I dunno, I'm running out of steam here. Maybe this is fine but look into it.
         showModuleIcon={selectedTopLabware.amount > 1}
         labwareOnDeck={matchingSelectedTopLabwareOnDeck}
         labwareDef={selectedTopLabwareDef ?? selectedAdapterDef}
diff --git a/protocol-designer/src/pages/Designer/DeckSetup/SelectedLabwareRender.tsx b/protocol-designer/src/pages/Designer/DeckSetup/SelectedLabwareRender.tsx
@@ -38,13 +38,16 @@ export function SelectedLabwareRender(
     <>
       {labwareDef != null ? (
         <LabwareRenderOnDeck
+          // TODO BEFORE MERGE: passing in these slot positions on their own is probably wrong if x/y are the labware render origin.
           labwareDef={labwareDef}
           x={slotPosition[0]}
           y={slotPosition[1]}
         />
       ) : null}
       {labwareOnDeck != null ? (
         <LabwareOnDeckComponent
+          // TODO BEFORE MERGE: Oh God. What is the difference between LabwareOnDeckComponent and LabwareRenderOnDeck.
+          // Also passing in these slot positions on their own is probably wrong if x/y are the labware render origin.
           x={slotPosition[0]}
           y={slotPosition[1]}
           labwareOnDeck={labwareOnDeck}
diff --git a/protocol-designer/src/pages/Designer/DeckSetup/SelectedModuleLabwareRender.tsx b/protocol-designer/src/pages/Designer/DeckSetup/SelectedModuleLabwareRender.tsx
@@ -17,10 +17,12 @@ export function SelectedModuleLabwareRender(
   return (
     <>
       {adapterDef != null && moduleModel != null ? (
+        // TODO BEFORE MERGE: No idea what's going on here but it is probably wrong?
         <LabwareRenderOnDeck labwareDef={adapterDef} x={0} y={0} />
       ) : null}
 
       {topLabwareOnDeck != null && moduleModel != null ? (
+        // TODO BEFORE MERGE: No idea what's going on here but it is probably wrong?
         <LabwareOnDeckComponent labwareOnDeck={topLabwareOnDeck} x={0} y={0} />
       ) : null}
     </>
diff --git a/protocol-designer/src/pages/Designer/OffDeck/OffDeckDetails.tsx b/protocol-designer/src/pages/Designer/OffDeck/OffDeckDetails.tsx
@@ -125,7 +125,9 @@ export function OffDeckDetails(props: OffDeckDetailsProps): JSX.Element {
                 >
                   <RobotWorkSpace
                     key={lw.id}
+                    // TODO BEFORE MERGE
                     viewBox={`${definition.cornerOffsetFromSlot.x} ${definition.cornerOffsetFromSlot.y} ${dimensions.xDimension} ${dimensions.yDimension}`}
+                    // Also TODO BEFORE MERGE, what happens if you set width+height in addition to viewBox? It doesn't get stretched?
                     width="9.5625rem"
                     height="6.375rem"
                   >
diff --git a/protocol-designer/src/pages/ProtocolOverview/OffdeckThumbnail.tsx b/protocol-designer/src/pages/ProtocolOverview/OffdeckThumbnail.tsx
@@ -111,6 +111,7 @@ export function OffDeckThumbnail(props: OffDeckThumbnailProps): JSX.Element {
                   <Flex flexDirection={DIRECTION_COLUMN} key={lw.id}>
                     <RobotWorkSpace
                       key={lw.id}
+                      // TODO BEFORE MERGE
                       viewBox={`${definition.cornerOffsetFromSlot.x} ${definition.cornerOffsetFromSlot.y} ${dimensions.xDimension} ${dimensions.yDimension}`}
                       width="6.875rem"
                       height="3.75rem"

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,7 @@ export function SetupLabwareStackView({`
`182`	`182`	`</StyledText>`
`183`	`183`	`) : null}`
`184`	`184`	`<LabwareThumbnail`
	`185`	`+ // TODO BEFORE MERGE`
`185`	`186`	viewBox={`${labwareCornerOffsetFromSlot.x} ${labwareCornerOffsetFromSlot.y} ${labwareDimensions.xDimension} ${labwareDimensions.yDimension}`}
`186`	`187`	`>`
`187`	`188`	`<g`
Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@ export function Selection384Wells({`
`129`	`129`	`}`
`130`	`130`	`return (`
`131`	`131`	`<Flex width="100%">`
	`132`	`+ {/* TODO BEFORE MERGE: Not sure how this is working without a parent <svg>. */}`
`132`	`133`	`{labwareRender}`
`133`	`134`	`<Flex`
`134`	`135`	`flex="1 0 0"`
Original file line number	Diff line number	Diff line change
`@@ -236,6 +236,7 @@ export function MoveLabwareOnDeck(`
`236`	`236`	`{backgroundItems}`
`237`	`237`	`<AnimatedG style={{ x: springProps.x, y: springProps.y }}>`
`238`	`238`	`<g`
	`239`	`+ // TODO BEFORE MERGE`
`239`	`240`	transform={`translate(${cornerOffsetFromSlot.x}, ${cornerOffsetFromSlot.y})`}
`240`	`241`	`>`
`241`	`242`	`<LabwareRender definition={movedLabwareDef} highlight={true} />`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ export default {`
`39`	`39`	`decorators: [`
`40`	`40`	`Story => (`
`41`	`41`	`<RobotWorkSpace`
	`42`	`+ // TODO BEFORE MERGE`
`42`	`43`	viewBox={`0 0 ${fixture96Plate.dimensions.xDimension} ${fixture96Plate.dimensions.yDimension}`}
`43`	`44`	`>`
`44`	`45`	`{() => <Story />}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ interface LabwareWellLabelsProps {`
`19`	`19`	`wellLabelColor?: string`
`20`	`20`	`}`
`21`	`21`
	`22`	`+// TODO BEFORE MERGE: Go through all this (and other labwareInternals files) and make sure it's still OK with labware schema 3`
`22`	`23`	`const Labels = (props: {`
`23`	`24`	`definition: LabwareDefinition`
`24`	`25`	`wells: string[]`