refactor(app): improve the module setup readiness experience

This is a little nicer. Split up the getNewModules code to separate
modules between whether or not they need a pipette to be set up, so we
can prompt for modules that can be set up immediately.

Author: sfoster1

app/src/App/hooks.ts

@@ -1,4 +1,4 @@
-import { useCallback, useContext, useEffect, useRef } from 'react'
+import { useCallback, useContext, useEffect, useRef, useState } from 'react'
 import { useTranslation } from 'react-i18next'
 import { useQueryClient } from 'react-query'
 import { useDispatch } from 'react-redux'
@@ -135,7 +135,14 @@ export function useProtocolReceiptToast(): void {
   }, [protocolIds])
 }
 
-export function useGetNewModules(): AttachedModule[] {
+const MODULES_NOT_REQUIRING_PIPETTE_FOR_SETUP: ModuleType[] = [
+  ABSORBANCE_READER_TYPE,
+  FLEX_STACKER_MODULE_TYPE,
+]
+
+const MODULES_NOT_REQUIRING_CALIBRATION = MODULES_NOT_REQUIRING_PIPETTE_FOR_SETUP
+
+export function useGetUnlocatedModules(): AttachedModule[] {
   const attachedModules =
     useAttachedModules({
       refetchInterval: ATTACHED_MODULE_POLL_MS,
@@ -148,59 +155,54 @@ export function useGetNewModules(): AttachedModule[] {
     const modulesInDeckConfig = deckConfig
       ?.filter(c => c.opentronsModuleSerialNumber)
       .map(m => m.opentronsModuleSerialNumber)
-    const newModules = attachedModules.filter(
-      m =>
-        m.moduleOffset === undefined &&
-        !modulesInDeckConfig.includes(m.serialNumber)
+    return attachedModules.filter(
+      m => !modulesInDeckConfig.includes(m.serialNumber)
     )
-    return newModules
   }
   return []
 }
 
-const MODULES_NOT_REQUIRING_PIPETTE_FOR_SETUP: ModuleType[] = [
-  ABSORBANCE_READER_TYPE,
-  FLEX_STACKER_MODULE_TYPE,
-]
+export function useGetModulesNeedingSetup(): AttachedModule[] {
+  const allNewModules = useGetUnlocatedModules()
+  console.log(`ugmns: ${allNewModules}`)
+  return allNewModules.filter(
+    m =>
+      MODULES_NOT_REQUIRING_CALIBRATION.includes(m.moduleType) ||
+      m.moduleOffset === undefined
+  )
+}
+
+export function useGetModulesNeedingSetupThatCanCurrentlyBeSetUp(): AttachedModule[] {
+  const modulesRequiringSetup = useGetModulesNeedingSetup()
+  const attachedPipettes = useAttachedPipettes(modulesRequiringSetup.length > 0)
+  console.log(`ugmnstccbs: ${modulesRequiringSetup}`)
+  return modulesRequiringSetup.filter(
+    m =>
+      MODULES_NOT_REQUIRING_PIPETTE_FOR_SETUP.includes(m.moduleType) ||
+      attachedPipettes.left != null ||
+      attachedPipettes.right != null
+  )
+}
 
 export function useModuleAttachedToast(
   launchModuleSetupCallback: () => void
 ): void {
-  const newModules = useGetNewModules()
-  const currentRunId = useCurrentRunId({ refetchInterval: CURRENT_RUN_POLL })
-  const modulesNotRequiringPipette = newModules
-    .filter(thisModule =>
-      MODULES_NOT_REQUIRING_PIPETTE_FOR_SETUP.includes(thisModule.moduleType)
-    )
-    .map(thisModule => thisModule.serialNumber)
-  const moduleSerialsRequiringPipette = newModules
-    .map(thisModule => thisModule.serialNumber)
-    .filter(thisSerial => !modulesNotRequiringPipette.includes(thisSerial))
+  const currentlySetuppableModules = useGetModulesNeedingSetupThatCanCurrentlyBeSetUp()
+  console.log(`umat: ${currentlySetuppableModules}`)
 
-  const attachedPipettes = useAttachedPipettes(
-    moduleSerialsRequiringPipette.length > 0
-  )
+  const currentRunId = useCurrentRunId({ refetchInterval: CURRENT_RUN_POLL })
   const { t, i18n } = useTranslation(['module_wizard_flows', 'shared'])
   const { makeToast } = useToaster()
-  const moduleSerials = newModules.map(m => m.serialNumber)
+  const moduleSerials = currentlySetuppableModules.map(m => m.serialNumber)
   const moduleSerialsRef = useRef(moduleSerials)
   const runInProgress = currentRunId != null
 
+  const [firstRun, setFirstRun] = useState<boolean>(true)
+
   useEffect(() => {
     const newModuleSerials = difference(moduleSerials, moduleSerialsRef.current)
-    const newModulesRequiringPipette = newModuleSerials.filter(serial =>
-      moduleSerialsRequiringPipette.includes(serial)
-    )
-    const newModulesNotRequiringPipette = newModuleSerials.filter(
-      serial => !moduleSerialsRequiringPipette.includes(serial)
-    )
-    const hasPipette =
-      attachedPipettes.left != null || attachedPipettes.right != null
-    if (
-      !runInProgress &&
-      ((hasPipette && newModulesRequiringPipette.length > 0) ||
-        newModulesNotRequiringPipette.length > 0)
-    ) {
+    console.log(`umat effect: ${newModuleSerials}`)
+    if (!runInProgress && newModuleSerials.length > 0) {
       makeToast(t('module_added') as string, 'info', {
         buttonText: i18n.format(t('shared:close'), 'capitalize'),
         linkText: t('module_added_link'),
@@ -210,9 +212,10 @@ export function useModuleAttachedToast(
       })
     }
     moduleSerialsRef.current = moduleSerials
+    setFirstRun(false)
     // dont want this hook to rerun when other deps change
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [moduleSerials, runInProgress, moduleSerialsRequiringPipette])
+  }, [moduleSerials, runInProgress, firstRun])
 }
 
 export function useScrollRef(): {

app/src/organisms/ModuleWizardFlows/SelectModule.tsx

@@ -18,7 +18,7 @@ import {
   getModuleDisplayName,
 } from '@opentrons/shared-data'
 
-import { useGetNewModules } from '/app/App/hooks'
+import { useGetModulesNeedingSetupThatCanCurrentlyBeSetUp } from '/app/App/hooks'
 import { SmallButton } from '/app/atoms/buttons'
 import { i18n } from '/app/i18n'
 import { useModuleUSBPort } from '/app/local-resources/modules'
@@ -62,13 +62,13 @@ export function SelectModule(props: SelectModuleProps): JSX.Element | null {
   const { t } = useTranslation('module_wizard_flows')
 
   const { parseModuleUSBPort } = useModuleUSBPort()
-  const availableModules = useGetNewModules()
+  const availableModules = useGetModulesNeedingSetupThatCanCurrentlyBeSetUp()
+  const allSettupable = useGetModulesNeedingSetup()
   const allNewModules =
     attachedModuleOnLaunch !== null
       ? [attachedModuleOnLaunch]
       : availableModules
-
-  const modulesNotRequiringPipette = allNewModules.filter(thisModule =>
+  const modulesNotRequiringPipette = availableModules.filter(thisModule =>
     ([
       ABSORBANCE_READER_TYPE,
       FLEX_STACKER_MODULE_TYPE,

app/src/organisms/ModuleWizardFlows/Success.tsx

@@ -14,7 +14,7 @@ import {
 } from '@opentrons/components'
 import { getModuleDisplayName } from '@opentrons/shared-data'
 
-import { useGetNewModules } from '/app/App/hooks'
+import { useGetModulesNeedingSetupThatCanCurrentlyBeSetUp } from '/app/App/hooks'
 import { SmallButton } from '/app/atoms/buttons'
 import { SimpleWizardBody } from '/app/molecules/SimpleWizardBody'
 
@@ -50,7 +50,7 @@ export function Success(props: SuccessProps): JSX.Element {
   const { t } = useTranslation('module_wizard_flows')
   const sendIdentifyStacker = useSendIdentifyStacker()
   const moduleDisplayName = getModuleDisplayName(attachedModule.moduleModel)
-  const newModules = useGetNewModules()
+  const newModules = useGetModulesNeedingSetupThatCanCurrentlyBeSetUp()
 
   const handleOnClick = (restart: boolean): void => {
     if (restart) {

app/src/organisms/ModuleWizardFlows/index.tsx

@@ -63,7 +63,6 @@ export function ModuleWizardFlows(
     buildFlowForSelectedModule,
     patchModuleAfterUpdate,
     deckConfig,
-    requirePipette,
   } = useModuleSetupWizard({ closeFlow, attachedModuleOnLaunch, onComplete })
 
   // build out flow if there is a module passed in at launch
@@ -90,7 +89,6 @@ export function ModuleWizardFlows(
 
   const doorStatus = useIsDoorOpen(robotName).isDoorOpen
 
-  if (wizardFlowBaseProps.attachedPipette == null && requirePipette) return null
   if (showLaunchSetup || wizardFlowBaseProps.attachedModule == null) {
     return (
       <ModuleWizardScreen

app/src/organisms/ModuleWizardFlows/useModuleSetupWizard.ts

@@ -59,7 +59,6 @@ export interface UseModuleSetupWizardResult {
   buildFlowForSelectedModule: (module: AttachedModule) => void
   patchModuleAfterUpdate: (module: AttachedModule) => void
   deckConfig: DeckConfiguration
-  requirePipette: boolean
 }
 
 export interface UseModuleSetupWizardParams {
@@ -264,8 +263,6 @@ export function useModuleSetupWizard(
     deckConfig,
     buildFlowForSelectedModule,
     patchModuleAfterUpdate,
-    requirePipette:
-      attachedModuleOnLaunch?.moduleType === FLEX_STACKER_MODULE_TYPE,
   }
 }