-
Notifications
You must be signed in to change notification settings - Fork 176
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(app): implement useCalibrationTaskList hook (#11894)
* WIP: some scaffolding of files and refactoring of reused types * fix some pipette model type discrepancies, refactor some task list related types to be reusable * feat(app): implement useGenerateTaskList hook useGenerateTaskList is a hook that aggregates deck calibrations and tip length and offset calibrations for attached pipettes then builds the taskList object that is passed to the TaskList component as props closes RAUT-291 * use i18n for task text * add namespace prefixes to i18 translations * fix an active index bug, simplify some logic * typo and linting fixes * add tests for useGenerateTaskList hook * increase patch code coverage numbers * add test coverage for tip length calibration active index * adjust mock pipette name in device utils test to satisfy typechecker * update get offsetcalibrationForMount mock pipette model * rename hook to useCalibrationTaskList * fix type errors in pipette wizard flows tests
- Loading branch information
Showing
12 changed files
with
782 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
242 changes: 242 additions & 0 deletions
242
app/src/organisms/Devices/hooks/__fixtures__/taskListFixtures.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| import { formatTimestamp } from '../../utils' | ||
|
|
||
| import { PipetteModelSpecs } from '@opentrons/shared-data' | ||
| import { | ||
| DeckCalibrationInfo, | ||
| TipLengthCalibration, | ||
| PipetteOffsetCalibration, | ||
| } from '../../../../redux/calibration/api-types' | ||
| import { AttachedPipettesByMount } from '../../../../redux/pipettes/types' | ||
| import { TaskListProps } from '../../../TaskList/types' | ||
|
|
||
| export const TASK_COUNT = 3 | ||
|
|
||
| export const mockAttachedPipettesResponse: AttachedPipettesByMount = { | ||
| left: { | ||
| id: 'test-left', | ||
| name: 'test-left-name', | ||
| tip_length: 0, | ||
| mount_axis: 'x', | ||
| plunger_axis: 'z', | ||
| model: 'p1000_single_v1', | ||
| modelSpecs: { | ||
| displayName: 'Test Left Display Name', | ||
| } as PipetteModelSpecs, | ||
| }, | ||
| right: { | ||
| id: 'test-right', | ||
| name: 'test-right-name', | ||
| tip_length: 0, | ||
| mount_axis: 'x', | ||
| plunger_axis: 'z', | ||
| model: 'p1000_single_v1', | ||
| modelSpecs: { | ||
| displayName: 'Test Right Display Name', | ||
| } as PipetteModelSpecs, | ||
| }, | ||
| } | ||
|
|
||
| export const mockSingleAttachedPipetteResponse: AttachedPipettesByMount = { | ||
| left: { | ||
| id: 'test-left', | ||
| name: 'test-left-name', | ||
| tip_length: 0, | ||
| mount_axis: 'x', | ||
| plunger_axis: 'z', | ||
| model: 'p1000_single_v1', | ||
| modelSpecs: { | ||
| displayName: 'Test Left Display Name', | ||
| } as PipetteModelSpecs, | ||
| }, | ||
| right: null, | ||
| } | ||
|
|
||
| export const mockCompleteDeckCalibration = { | ||
| isDeckCalibrated: true, | ||
| deckCalibrationData: { | ||
| lastModified: '2022-01-01T12:00:00.000000+00:00', | ||
| } as DeckCalibrationInfo, | ||
| } | ||
|
|
||
| export const mockIncompleteDeckCalibration = { | ||
| isDeckCalibrated: false, | ||
| deckCalibrationData: null, | ||
| } | ||
|
|
||
| export const mockCompleteTipLengthCalibrations: TipLengthCalibration[] = [ | ||
| { | ||
| tipLength: 0, | ||
| lastModified: '2022-01-02T12:00:00.000000+00:00', | ||
| tiprack: 'test_tip_rack', | ||
| pipette: 'test-left', | ||
| source: 'user', | ||
| status: { markedBad: false, source: null, markedAt: null }, | ||
| id: 'test-tip-length-id-1', | ||
| }, | ||
| { | ||
| tipLength: 0, | ||
| lastModified: '2022-01-03T12:00:00.000000+00:00', | ||
| tiprack: 'test_tip_rack', | ||
| pipette: 'test-right', | ||
| source: 'user', | ||
| status: { markedBad: false, source: null, markedAt: null }, | ||
| id: 'test-tip-length-id-2', | ||
| }, | ||
| ] | ||
|
|
||
| export const mockIncompleteTipLengthCalibrations: TipLengthCalibration[] = [ | ||
| { | ||
| tipLength: 0, | ||
| lastModified: '2022-01-03T12:00:00.000000+00:00', | ||
| tiprack: 'test_tip_rack', | ||
| pipette: 'test-right', | ||
| source: 'user', | ||
| status: { markedBad: false, source: null, markedAt: null }, | ||
| id: 'test-tip-length-id-2', | ||
| }, | ||
| ] | ||
|
|
||
| export const mockCompletePipetteOffsetCalibrations: PipetteOffsetCalibration[] = [ | ||
| { | ||
| pipette: 'test-left', | ||
| mount: 'left', | ||
| offset: [0, 0, 0], | ||
| tiprack: 'test-tip-rack', | ||
| tiprackUri: 'test/tiprack/uri', | ||
| lastModified: '2022-01-04T12:00:00,000000+00:00', | ||
| source: 'user', | ||
| status: { markedBad: false, markedAt: null, source: null }, | ||
| id: 'test-offset-id-1', | ||
| }, | ||
| { | ||
| pipette: 'test-right', | ||
| mount: 'right', | ||
| offset: [0, 0, 0], | ||
| tiprack: 'test-tip-rack', | ||
| tiprackUri: 'test/tiprack/uri', | ||
| lastModified: '2022-01-05T12:00:00,000000+00:00', | ||
| source: 'user', | ||
| status: { markedBad: false, markedAt: null, source: null }, | ||
| id: 'test-offset-id-2', | ||
| }, | ||
| ] | ||
|
|
||
| export const mockIncompletePipetteOffsetCalibrations: PipetteOffsetCalibration[] = [ | ||
| { | ||
| pipette: 'test-left', | ||
| mount: 'left', | ||
| offset: [0, 0, 0], | ||
| tiprack: 'test-tip-rack', | ||
| tiprackUri: 'test/tiprack/uri', | ||
| lastModified: '2022-01-04T12:00:00,000000+00:00', | ||
| source: 'user', | ||
| status: { markedBad: false, markedAt: null, source: null }, | ||
| id: 'test-offset-id-1', | ||
| }, | ||
| { | ||
| pipette: 'test-right', | ||
| mount: 'right', | ||
| offset: [0, 0, 0], | ||
| tiprack: 'test-tip-rack', | ||
| tiprackUri: 'test/tiprack/uri', | ||
| lastModified: '2022-01-05T12:00:00,000000+00:00', | ||
| source: 'user', | ||
| status: { markedBad: true, markedAt: null, source: null }, | ||
| id: 'test-offset-id-2', | ||
| }, | ||
| ] | ||
|
|
||
| export const expectedTaskList: TaskListProps = { | ||
| activeIndex: null, | ||
| taskList: [ | ||
| // deck calibration task | ||
| { | ||
| subTasks: [], | ||
| taskListLength: TASK_COUNT, | ||
| activeIndex: null, | ||
| description: '', | ||
| title: 'Deck Calibration', | ||
| footer: `Last completed ${formatTimestamp( | ||
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
| mockCompleteDeckCalibration.deckCalibrationData.lastModified! | ||
| )}`, | ||
| cta: { label: 'Recalibrate', onClick: () => {} }, | ||
| isComplete: true, | ||
| taskIndex: 0, | ||
| }, | ||
| // left mount calibration task | ||
| { | ||
| subTasks: [ | ||
| // tip length calibration subtask | ||
| { | ||
| activeIndex: null, | ||
| description: '', | ||
| title: 'Tip Length Calibration', | ||
| footer: `Last completed ${formatTimestamp( | ||
| mockCompleteTipLengthCalibrations[0].lastModified | ||
| )}`, | ||
| cta: { label: 'Recalibrate', onClick: () => {} }, | ||
| isComplete: true, | ||
| taskIndex: 1, | ||
| subTaskIndex: 0, | ||
| }, | ||
| // offset calibration subtask | ||
| { | ||
| activeIndex: null, | ||
| description: '', | ||
| title: 'Pipette Offset Calibration', | ||
| footer: `Last completed ${formatTimestamp( | ||
| mockCompletePipetteOffsetCalibrations[0].lastModified | ||
| )}`, | ||
| cta: { label: 'Recalibrate', onClick: () => {} }, | ||
| isComplete: true, | ||
| taskIndex: 1, | ||
| subTaskIndex: 1, | ||
| }, | ||
| ], | ||
| isComplete: true, | ||
| taskListLength: TASK_COUNT, | ||
| activeIndex: null, | ||
| description: 'Test Left Display Name, test-left', | ||
| title: 'Left Mount', | ||
| taskIndex: 1, | ||
| }, | ||
| // right mount calibration task | ||
| { | ||
| subTasks: [ | ||
| // tip length calibration subtask | ||
| { | ||
| activeIndex: null, | ||
| description: '', | ||
| title: 'Tip Length Calibration', | ||
| footer: `Last completed ${formatTimestamp( | ||
| mockCompleteTipLengthCalibrations[1].lastModified | ||
| )}`, | ||
| cta: { label: 'Recalibrate', onClick: () => {} }, | ||
| isComplete: true, | ||
| taskIndex: 2, | ||
| subTaskIndex: 0, | ||
| }, | ||
| // offset calibration subtask | ||
| { | ||
| activeIndex: null, | ||
| description: '', | ||
| title: 'Pipette Offset Calibration', | ||
| footer: `Last completed ${formatTimestamp( | ||
| mockCompletePipetteOffsetCalibrations[1].lastModified | ||
| )}`, | ||
| cta: { label: 'Recalibrate', onClick: () => {} }, | ||
| isComplete: true, | ||
| taskIndex: 2, | ||
| subTaskIndex: 1, | ||
| }, | ||
| ], | ||
| isComplete: true, | ||
| taskListLength: TASK_COUNT, | ||
| activeIndex: null, | ||
| description: 'Test Right Display Name, test-right', | ||
| title: 'Right Mount', | ||
| taskIndex: 2, | ||
| }, | ||
| ], | ||
| } |
Oops, something went wrong.