-
Notifications
You must be signed in to change notification settings - Fork 175
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(app,shared-data): add useRunningStepCounts hook (#15438)
Works towards EXEC-550 and closes EXEC-510 Since we'll be showing step counts in a few more places, during ER and also on the RunningProtocol page, let's go ahead and create a hook for getting the step count and whether or not a run is deterministic (since this helps clarify certain rendering behavior). This hook is added to the one place it's used, RunProgressMeter.
- Loading branch information
Showing
9 changed files
with
254 additions
and
54 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
Empty file.
62 changes: 62 additions & 0 deletions
62
app/src/resources/protocols/hooks/__tests__/useLastRunProtocolCommand.test.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,62 @@ | ||
| import { renderHook } from '@testing-library/react' | ||
| import { describe, expect, it, vi } from 'vitest' | ||
|
|
||
| import { useCommandQuery } from '@opentrons/react-api-client' | ||
|
|
||
| import { useLastRunProtocolCommand } from '../useLastRunProtocolCommand' | ||
|
|
||
| vi.mock('@opentrons/react-api-client') | ||
|
|
||
| const mockRunId = 'mock-run-id' | ||
| const mockCommandsData = { | ||
| data: [ | ||
| { id: 'cmd1', key: 'key1', intent: 'protocol' }, | ||
| { id: 'cmd2', key: 'key2', intent: 'protocol' }, | ||
| ], | ||
| meta: { totalLength: 2 }, | ||
| } as any | ||
|
|
||
| describe('useLastRunCommandNoFixit', () => { | ||
| it('returns the last run command when it is not a fixit command', () => { | ||
| vi.mocked(useCommandQuery).mockReturnValue({ data: null } as any) | ||
|
|
||
| const { result } = renderHook(() => | ||
| useLastRunProtocolCommand(mockRunId, mockCommandsData) | ||
| ) | ||
|
|
||
| expect(result.current).toEqual({ | ||
| id: 'cmd2', | ||
| key: 'key2', | ||
| intent: 'protocol', | ||
| }) | ||
| }) | ||
|
|
||
| it('returns the failed command when the last run command is a fixit command', () => { | ||
| const mockFixitCommand = { | ||
| id: 'fixit-cmd', | ||
| intent: 'fixit', | ||
| failedCommandId: 'failed-cmd-id', | ||
| } | ||
| const mockFailedCommand = { id: 'failed-cmd-id', key: 'failed-key' } | ||
| vi.mocked(useCommandQuery).mockReturnValue({ | ||
| data: { data: mockFailedCommand }, | ||
| } as any) | ||
|
|
||
| const { result } = renderHook(() => | ||
| useLastRunProtocolCommand(mockRunId, { | ||
| data: [mockFixitCommand], | ||
| meta: { totalLength: 1 }, | ||
| } as any) | ||
| ) | ||
|
|
||
| expect(result.current).toEqual(mockFailedCommand) | ||
| }) | ||
|
|
||
| it('returns null when there are no run commands', () => { | ||
| const { result } = renderHook(() => | ||
| useLastRunProtocolCommand(mockRunId, null) | ||
| ) | ||
|
|
||
| expect(result.current).toBeNull() | ||
| }) | ||
| }) |
70 changes: 70 additions & 0 deletions
70
app/src/resources/protocols/hooks/__tests__/useRunningStepCount.test.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,70 @@ | ||
| import { describe, it, expect, vi } from 'vitest' | ||
| import { renderHook } from '@testing-library/react' | ||
|
|
||
| import { useMostRecentCompletedAnalysis } from '../../../../organisms/LabwarePositionCheck/useMostRecentCompletedAnalysis' | ||
| import { useRunningStepCounts } from '../useRunningStepCounts' | ||
| import { useLastRunProtocolCommand } from '../useLastRunProtocolCommand' | ||
|
|
||
| vi.mock('../useLastRunProtocolCommand') | ||
| vi.mock( | ||
| '../../../../organisms/LabwarePositionCheck/useMostRecentCompletedAnalysis' | ||
| ) | ||
|
|
||
| const mockRunId = 'mock-run-id' | ||
| const mockCommandsData = { | ||
| data: [ | ||
| { id: 'cmd1', key: 'key1' }, | ||
| { id: 'cmd2', key: 'key2' }, | ||
| ], | ||
| meta: { totalLength: 2 }, | ||
| } as any | ||
|
|
||
| describe('useRunningStepCounts', () => { | ||
| it('returns current step number and total step count for a deterministic run', () => { | ||
| const mockAnalysis = { | ||
| commands: [{ key: 'key1' }, { key: 'key2' }, { key: 'key3' }], | ||
| } as any | ||
| vi.mocked(useMostRecentCompletedAnalysis).mockReturnValue(mockAnalysis) | ||
| vi.mocked(useLastRunProtocolCommand).mockReturnValue({ key: 'key2' } as any) | ||
|
|
||
| const { result } = renderHook(() => | ||
| useRunningStepCounts(mockRunId, mockCommandsData) | ||
| ) | ||
|
|
||
| expect(result.current).toEqual({ | ||
| currentStepNumber: 2, | ||
| totalStepCount: 3, | ||
| hasRunDiverged: false, | ||
| }) | ||
| }) | ||
|
|
||
| it('returns current step number and null total step count for a non-deterministic run', () => { | ||
| vi.mocked(useMostRecentCompletedAnalysis).mockReturnValue(null) | ||
| vi.mocked(useLastRunProtocolCommand).mockReturnValue(null) | ||
|
|
||
| const { result } = renderHook(() => | ||
| useRunningStepCounts(mockRunId, mockCommandsData) | ||
| ) | ||
|
|
||
| expect(result.current).toEqual({ | ||
| currentStepNumber: 2, | ||
| totalStepCount: null, | ||
| hasRunDiverged: true, | ||
| }) | ||
| }) | ||
|
|
||
| it('returns null current step number and total step count when analysis and run command data are not available', () => { | ||
| vi.mocked(useMostRecentCompletedAnalysis).mockReturnValue(null) | ||
| vi.mocked(useLastRunProtocolCommand).mockReturnValue(null) | ||
|
|
||
| const { result } = renderHook(() => | ||
| useRunningStepCounts(mockRunId, undefined) | ||
| ) | ||
|
|
||
| expect(result.current).toEqual({ | ||
| currentStepNumber: null, | ||
| totalStepCount: null, | ||
| hasRunDiverged: true, | ||
| }) | ||
| }) | ||
| }) |
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,4 @@ | ||
| export { useLastRunProtocolCommand } from './useLastRunProtocolCommand' | ||
| export { useRunningStepCounts } from './useRunningStepCounts' | ||
|
|
||
| export type { StepCounts } from './useRunningStepCounts' |
29 changes: 29 additions & 0 deletions
29
app/src/resources/protocols/hooks/useLastRunProtocolCommand.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,29 @@ | ||
| import last from 'lodash/last' | ||
|
|
||
| import { useCommandQuery } from '@opentrons/react-api-client' | ||
|
|
||
| import type { CommandsData, RunCommandSummary } from '@opentrons/api-client' | ||
|
|
||
| // Return the last command with a "protocol" intent. If the command does not have "protocol" intent, | ||
| // return the last command with "protocol" intent. | ||
| export function useLastRunProtocolCommand( | ||
| runId: string, | ||
| commandsData: CommandsData | null | ||
| ): RunCommandSummary | null { | ||
| const lastRunCommand = last(commandsData?.data) ?? null | ||
|
|
||
| const isProtocolIntent = lastRunCommand?.intent === 'protocol' | ||
|
|
||
| // Get the failed command from the fixit command. | ||
| const lastRunCommandActual = useCommandQuery( | ||
| runId, | ||
| lastRunCommand?.failedCommandId ?? null, | ||
| { | ||
| enabled: !isProtocolIntent && lastRunCommand != null, | ||
| } | ||
| ) | ||
|
|
||
| return !isProtocolIntent && lastRunCommand != null | ||
| ? lastRunCommandActual.data?.data ?? null | ||
| : lastRunCommand ?? null | ||
| } |
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,60 @@ | ||
| import { useMostRecentCompletedAnalysis } from '../../../organisms/LabwarePositionCheck/useMostRecentCompletedAnalysis' | ||
|
|
||
| import { useLastRunProtocolCommand } from './useLastRunProtocolCommand' | ||
|
|
||
| import type { CommandsData } from '@opentrons/api-client' | ||
|
|
||
| export interface StepCounts { | ||
| /* Excludes "fixit" commands. Returns null if the step is not found. */ | ||
| currentStepNumber: number | null | ||
| /* Returns null if the run has diverged or the total command count is not found. */ | ||
| totalStepCount: number | null | ||
| /* Returns whether the run has diverged from analysis. */ | ||
| hasRunDiverged: boolean | ||
| } | ||
|
|
||
| /** | ||
| * Find the index of the analysis command within the analysis | ||
| * that has the same commandKey as the most recent | ||
| * command from the run record. | ||
| * In the case of a non-deterministic protocol, | ||
| * source from the run rather than the analysis. | ||
| * NOTE: The most recent | ||
| * command may not always be "current", for instance if | ||
| * the run has completed/failed. | ||
| * NOTE #2: "Fixit" commands are excluded from the step count. | ||
| * */ | ||
| export function useRunningStepCounts( | ||
| runId: string, | ||
| commandsData: CommandsData | undefined | ||
| ): StepCounts { | ||
| const analysis = useMostRecentCompletedAnalysis(runId) | ||
| const analysisCommands = analysis?.commands ?? [] | ||
| const lastRunCommandNoFixit = useLastRunProtocolCommand( | ||
| runId, | ||
| commandsData ?? null | ||
| ) | ||
|
|
||
| const lastRunAnalysisCommandIndex = analysisCommands.findIndex( | ||
| c => c.key === lastRunCommandNoFixit?.key | ||
| ) | ||
|
|
||
| const currentStepNumberByAnalysis = | ||
| lastRunAnalysisCommandIndex === -1 ? null : lastRunAnalysisCommandIndex + 1 | ||
| const currentStepNumberByRun = commandsData?.meta.totalLength ?? null | ||
|
|
||
| const hasRunDiverged = | ||
| lastRunCommandNoFixit?.key == null || currentStepNumberByAnalysis == null | ||
|
|
||
| const currentStepNumber = !hasRunDiverged | ||
| ? currentStepNumberByAnalysis | ||
| : currentStepNumberByRun | ||
|
|
||
| const totalStepCount = !hasRunDiverged ? analysisCommands.length : null | ||
|
|
||
| return { | ||
| currentStepNumber, | ||
| totalStepCount, | ||
| hasRunDiverged, | ||
| } | ||
| } |
Oops, something went wrong.