feat(protocol-designer): add 8.5.0 migration modal (#18673)

This PR adds copy for 8.5.0 migration modal and wires it up. It also
updates the copy for import confirmation from "Confirm" to "Import", and
updates tests accordingly.

Closes AUTH-1975

Author: ncdiehl11

protocol-designer/cypress/e2e/migrations.cy.ts

@@ -23,65 +23,65 @@ describe('Protocol fixtures migrate and match snapshots', () => {
       title: 'example_1_1_0 (schema 1, PD version 1.1.1) -> PD 8.5.x, schema 8',
       importTestFile: TestFilePath.Example_1_1_0,
       expectedTestFile: TestFilePath.Example_1_1_0V8,
-      migrationModal: 'newLabwareDefs',
+      showMigrationModal: true,
     },
     {
       title: 'doItAllV3 (schema 3, PD version 4.0.0) -> PD 8.5.x, schema 8',
       importTestFile: TestFilePath.DoItAllV3V4,
       expectedTestFile: TestFilePath.DoItAllV3MigratedToV8,
-      migrationModal: 'v8.1',
+      showMigrationModal: true,
     },
     {
       title: 'doItAllV4 (schema 4, PD version 4.0.0) -> PD 8.5.x, schema 8',
       importTestFile: TestFilePath.DoItAllV4V4,
       expectedTestFile: TestFilePath.DoItAllV4MigratedToV8,
-      migrationModal: 'v8.1',
+      showMigrationModal: true,
     },
     {
       title:
         'doItAllv7MigratedToV8 (schema 7, PD version 8.0.0) -> should migrate to 8.5.x, schema 8',
       importTestFile: TestFilePath.DoItAllV7,
       expectedTestFile: TestFilePath.DoItAllV7MigratedToV8,
-      migrationModal: 'v8.1',
+      showMigrationModal: true,
     },
     {
       title:
         '96-channel full and column schema 8 -> should migrate to 8.5.x, schema 8',
       importTestFile: TestFilePath.NinetySixChannelFullAndColumn,
       expectedTestFile: TestFilePath.NinetySixChannelFullAndColumn,
-      migrationModal: null,
+      showMigrationModal: false,
     },
     {
       title:
         'doItAllV8 flex robot -> reimported, should migrate to 8.5.x, schema 8',
       importTestFile: TestFilePath.DoItAllV8,
       expectedTestFile: TestFilePath.DoItAllV8,
-      migrationModal: null,
+      showMigrationModal: false,
     },
     {
       title:
         'new advanced settings with multi temp => reimported, should not migrate and stay at 8.5.x, schema 8',
       importTestFile: TestFilePath.NewAdvancedSettingsAndMultiTemp,
       expectedTestFile: TestFilePath.NewAdvancedSettingsAndMultiTemp,
-      migrationModal: null,
+      showMigrationModal: false,
     },
     {
       title:
         'thermocycler on Ot2 (schema 7, PD version 7.0.0) -> should migrate to 8.5.x, schema 8',
       importTestFile: TestFilePath.ThermocyclerOnOt2V7,
       expectedTestFile: TestFilePath.ThermocyclerOnOt2V7MigratedToV8,
-      migrationModal: 'v8.1',
+      showMigrationModal: true,
     },
   ]
 
   testCases.forEach(
-    ({ title, importTestFile, expectedTestFile, migrationModal }) => {
+    ({ title, importTestFile, expectedTestFile, showMigrationModal }) => {
       it(title, () => {
         migrateAndMatchSnapshot({
           title,
           importTestFile,
           expectedTestFile,
-          migrationModal,
+          showMigrationModal,
         })
       })
     }

protocol-designer/cypress/support/Import.ts

@@ -11,12 +11,14 @@ export interface MigrateTestCase {
   title: string
   importTestFile: TestFilePath
   expectedTestFile: TestFilePath
-  migrationModal: 'newLabwareDefs' | 'v8.1' | 'noBehaviorChange' | null
+  showMigrationModal: boolean
 }
 
 export const ContentStrings = {
   newLabwareDefs: 'Update protocol to use new labware definitions',
   v8_1: 'The default dispense height is now 1 mm from the bottom of the well',
+  v8_5:
+    'Your protocol will be automatically updated to the latest version. We recommend making a separate copy of your file before importing.',
   noBehaviorChange:
     'We have added new features since the last time this protocol was updated, but have not made any changes to existing protocol behavior',
   exportButton: 'Export JSON',
@@ -26,6 +28,7 @@ export const ContentStrings = {
     'Your protocol was made in an older version of Protocol Designer',
   confirmButton: 'Confirm',
   cancelButton: 'Cancel',
+  importButton: 'Import',
   protocolMetadata: 'Protocol Metadata',
   instruments: 'Instruments',
   liquidDefinitions: 'Liquid Definitions',
@@ -46,9 +49,9 @@ export const verifyOldProtocolModal = (): void => {
       cy.contains(ContentStrings.migrationModal)
         .should('exist')
         .and('be.visible')
-      cy.contains(ContentStrings.confirmButton).should('be.visible')
+      cy.contains(ContentStrings.importButton).should('be.visible')
       cy.contains(ContentStrings.cancelButton).should('be.visible')
-      cy.contains(ContentStrings.confirmButton).click({ force: true })
+      cy.contains(ContentStrings.importButton).click({ force: true })
     })
 }
 
@@ -70,21 +73,14 @@ export const verifyImportProtocolPage = (protocol: TestFile): void => {
 export const migrateAndMatchSnapshot = ({
   importTestFile,
   expectedTestFile,
-  migrationModal,
+  showMigrationModal,
 }: MigrateTestCase): void => {
   const uploadProtocol: TestFile = getTestFile(importTestFile)
   cy.importProtocol(uploadProtocol.path)
 
-  if (migrationModal !== null) {
-    if (migrationModal === 'v8.1') {
-      cy.get('div').contains(ContentStrings.v8_1).should('exist')
-    } else if (migrationModal === 'newLabwareDefs') {
-      cy.get('div').contains(ContentStrings.newLabwareDefs).should('exist')
-    } else if (migrationModal === 'noBehaviorChange') {
-      cy.get('div').contains(ContentStrings.noBehaviorChange).should('exist')
-    }
+  if (showMigrationModal) {
     cy.get('button')
-      .contains(ContentStrings.confirmButton, { matchCase: false })
+      .contains(ContentStrings.importButton, { matchCase: false })
       .click({ force: true })
   }
 

protocol-designer/src/assets/localization/en/shared.json

@@ -63,35 +63,8 @@
   "magneticmoduletype": "Magnetic Module",
   "migration_header": "Your protocol was made in an older version of Protocol Designer",
   "migrations": {
-    "noBehaviorChange": {
-      "body1": "Your protocol will be automatically updated to the latest version.",
-      "body2": "We have added new features since the last time this protocol was updated, but have not made any changes to existing protocol behavior. Because of this we do not expect any changes in how the robot will execute this protocol. To be safe we will still recommend keeping a separate copy of the file you just imported.",
-      "body3": "As always, please contact us with any questions or feedback."
-    },
-    "toV8_1Migration": {
-      "body1": "Your protocol will be automatically updated to the latest version.",
-      "body2": "The default dispense height is now 1 mm from the bottom of the well, instead of 0.5 mm. All dispense commands without a custom height will change to use the new default height.",
-      "body3": "Additionally, blowout actions now precede touch tip actions. The new order affects all dispenses that include both actions."
-    },
-    "toV8Migration": {
-      "body1": "Your protocol will be automatically updated to the latest version.",
-      "body2": "Protocol Designer no longer supports aspirate or mix actions in a trash bin. If your protocol contains these actions, an error icon will appear next to them in the Protocol Timeline. To resolve the error, choose another location for aspirating or mixing.",
-      "body3": "Additionally, we have addressed a bug where blow out speeds were slower than expected. Your protocol will automatically update the flow rates unless they were specifically initialized.",
-      "body4": "As always, please contact us with any questions or feedback."
-    },
     "generic": {
-      "body1": "Your protocol will be automatically updated to the latest version. Please note that the updated file will be incompatible with older versions of the Protocol Designer. We recommend making a separate copy of the file that you just imported before continuing.",
-      "body2": "Updating the file may make changes to liquid handling actions. Please review your file in the Protocol Designer",
-      "body3": "As always, please contact us with any questions or feedback."
-    },
-    "toV3Migration": {
-      "title": "Update protocol to use new labware definitions",
-      "body1": "<strong>To import your file successfully, you must update your protocol to use the new labware definitions. </strong>Your protocol was made using an older version of Protocol Designer. Since then, Protocol Designer has been improved to include new labware definitions which are more accurate and reliable.",
-      "body2": "What this means for you protocol",
-      "body3": "Updating your protocol to use the new labware definitions will consequently require you to re-calibrate all labware in your protocol prior to running it on your robot. We recommend you try a dry run or one with water to ensure everything is working as expected.",
-      "body4": "What happens if you don't update",
-      "body5": "If you choose not to update, you will still be able to run your protocol as usual with older labware, however you will not be able to make further updates to this protocol using the Protocol Designer.",
-      "body6": "Please note that in order to run the updated protocol on your robot successfully, the OT-2 App and robot are required to be updated to version 3.10.0 or higher."
+      "body1": "Your protocol will be automatically updated to the latest version. We recommend making a separate copy of your file before importing."
     }
   },
   "magneticBlockAndStagingArea": "{{module}} with Staging Area",

protocol-designer/src/components/organisms/FileUploadMessagesModal/__tests__/FileUploadMessagesModal.test.tsx

@@ -38,16 +38,16 @@ describe('FileUploadMessagesModal', () => {
     vi.mocked(getFileUploadMessages).mockReturnValue({
       isError: false,
       messageKey: 'DID_MIGRATE',
-      migrationsRan: ['8.1.0'],
+      migrationsRan: ['8.5.0'],
     })
     render()
     screen.getByText(
       'Your protocol was made in an older version of Protocol Designer'
     )
     screen.getByText(
-      'Your protocol will be automatically updated to the latest version.'
+      'Your protocol will be automatically updated to the latest version. We recommend making a separate copy of your file before importing.'
     )
-    fireEvent.click(screen.getByRole('button', { name: 'Confirm' }))
+    fireEvent.click(screen.getByRole('button', { name: 'Import' }))
     expect(vi.mocked(dismissFileUploadMessage)).toHaveBeenCalled()
     fireEvent.click(screen.getByRole('button', { name: 'Cancel' }))
     expect(vi.mocked(undoLoadFile)).toHaveBeenCalled()

protocol-designer/src/components/organisms/FileUploadMessagesModal/__tests__/utils.test.ts

@@ -4,53 +4,10 @@ import { getMigrationMessage } from '../utils'
 
 const tMock = (key: string) => key
 
-describe('modalContents', () => {
-  describe('getMigrationMessage', () => {
-    it('should return the v3 migration message when migrating to v3', () => {
-      const migrationsList = [
-        ['3.0.0'],
-        ['3.0.0', '4.0.0'],
-        ['3.0.0', '4.0.0', '5.0.0'],
-        ['3.0.0', '4.0.0', '5.0.0', '5.1.0'],
-        ['3.0.0', '4.0.0', '5.0.0', '5.1.0, 5.2.0'],
-      ]
-      migrationsList.forEach(migrations => {
-        expect(
-          JSON.stringify(
-            getMigrationMessage({ migrationsRan: migrations, t: tMock })
-          )
-        ).toEqual(expect.stringContaining('migrations.toV3Migration.title'))
-      })
-    })
-    it('should return the "no behavior change message" when migrating from v5.x to 6', () => {
-      const migrationsList = [
-        ['5.0.0'],
-        ['5.0.0', '5.1.0'],
-        ['5.0.0', '5.1.0', '5.2.0'],
-      ]
-      migrationsList.forEach(migrations => {
-        expect(
-          JSON.stringify(
-            getMigrationMessage({ migrationsRan: migrations, t: tMock })
-          )
-        ).toEqual(expect.stringContaining('migrations.noBehaviorChange.body1'))
-      })
-    })
-    it('should return the generic migration modal when a v4 migration or v7 migration is required', () => {
-      const migrationsList = [
-        ['4.0.0'],
-        ['4.0.0', '5.0.0'],
-        ['4.0.0', '5.0.0', '5.1.0'],
-        ['4.0.0', '5.0.0', '5.1.0, 5.2.0'],
-        ['6.0.0', '6.1.0', '6.2.0', '6.2.1', '6.2.2'],
-      ]
-      migrationsList.forEach(migrations => {
-        expect(
-          JSON.stringify(
-            getMigrationMessage({ migrationsRan: migrations, t: tMock })
-          )
-        ).toEqual(expect.stringContaining('migrations.generic.body1'))
-      })
-    })
+describe('getMigrationMessage', () => {
+  it('should return the generic migration message when migrating', () => {
+    expect(JSON.stringify(getMigrationMessage({ t: tMock }))).toEqual(
+      expect.stringContaining('migrations.generic.body1')
+    )
   })
 })

protocol-designer/src/components/organisms/FileUploadMessagesModal/index.tsx

@@ -33,18 +33,29 @@ export function FileUploadMessagesModal(): JSX.Element | null {
   }
 
   const { title, body } = modalContents
+
+  const isMigration = title === t('migration_header')
+
   const showButtons =
     title !== t('invalid_json_file') &&
     title !== t('incorrect_file_header') &&
     title !== t('incorrect_python_file_header')
 
+  const handleClose = (): void => {
+    if (isMigration) {
+      dispatch(undoLoadFile())
+    } else {
+      dismissModal()
+    }
+  }
+
   return (
     <Modal
       marginLeft="0"
       type={message?.isError ? 'error' : 'info'}
       title={title}
       closeOnOutsideClick
-      onClose={dismissModal}
+      onClose={handleClose}
       footer={
         showButtons && (
           <Flex
@@ -59,7 +70,9 @@ export function FileUploadMessagesModal(): JSX.Element | null {
             >
               {t('cancel')}
             </SecondaryButton>
-            <PrimaryButton onClick={dismissModal}>{t('confirm')}</PrimaryButton>
+            <PrimaryButton onClick={dismissModal}>
+              {isMigration ? t('import') : t('confirm')}
+            </PrimaryButton>
           </Flex>
         )
       }