Receive notifications on the client.

Author: SyntaxColoring

app/src/organisms/LabwarePositionCheck/LPCFlows/hooks/useLPCLabwareInfo/index.ts

@@ -1,12 +1,12 @@
 import { useMemo } from 'react'
 
-import { useSearchLabwareOffsets } from '@opentrons/react-api-client'
 import { FLEX_ROBOT_TYPE, OT2_ROBOT_TYPE } from '@opentrons/shared-data'
 import { RUN_STATUS_IDLE } from '@opentrons/api-client'
 
 import { getUniqueValidLwLocationInfoByAnalysis } from './getUniqueValidLwLocationInfoByAnalysis'
 import { getLPCLabwareInfoFrom } from './getLPCLabwareInfoFrom'
 import { getLPCSearchParams } from './getLPCSearchParams'
+import { useNotifySearchLabwareOffsets } from '/app/resources/labware_offsets'
 import { useNotifyRunQuery, useRunStatus } from '/app/resources/runs'
 
 import type { LabwareOffset, StoredLabwareOffset } from '@opentrons/api-client'
@@ -66,11 +66,7 @@ function useFlexLPCLabwareInfo({
     [lwLocationCombos.length]
   )
 
-  // TODO(jh, 03-14-25): Add this search route to notifications.
-
-  // We have to poll, because it's possible for a user to update the
-  // offsets on a different app while a view utilizing this data is active.
-  const { data } = useSearchLabwareOffsets(searchLwOffsetsParams, {
+  const { data } = useNotifySearchLabwareOffsets(searchLwOffsetsParams, {
     enabled:
       searchLwOffsetsParams.filters.length > 0 &&
       robotType === FLEX_ROBOT_TYPE &&

app/src/redux/shell/types.ts

@@ -146,13 +146,14 @@ export interface RobotMassStorageDeviceRemoved {
 
 export type NotifyTopic =
   | 'ALL_TOPICS'
+  | `robot-server/clientData/${string}`
+  | 'robot-server/deck_configuration'
+  | 'robot-server/labwareOffsets'
   | 'robot-server/maintenance_runs/current_run'
   | 'robot-server/runs/commands_links'
   | 'robot-server/runs'
   | `robot-server/runs/${string}`
-  | 'robot-server/deck_configuration'
   | `robot-server/runs/pre_serialized_commands/${string}`
-  | `robot-server/clientData/${string}`
 
 export interface NotifySubscribeAction {
   type: 'shell:NOTIFY_SUBSCRIBE'

app/src/resources/labware_offsets/index.ts

@@ -0,0 +1 @@
+export * from './useNotifyLabwareOffsetsQuery'

app/src/resources/labware_offsets/useNotifyLabwareOffsetsQuery.ts

@@ -0,0 +1,32 @@
+import { useSearchLabwareOffsets } from '@opentrons/react-api-client'
+
+import { useNotifyDataReady } from '../useNotifyDataReady'
+
+import type {
+  SearchLabwareOffsetsRequest,
+  SearchLabwareOffsetsResponse,
+} from '@opentrons/api-client'
+import type { AxiosError } from 'axios'
+import type { UseQueryResult } from 'react-query'
+import type { QueryOptionsWithPolling } from '../useNotifyDataReady'
+
+export function useNotifySearchLabwareOffsets(
+  request: SearchLabwareOffsetsRequest,
+  options: QueryOptionsWithPolling<
+    SearchLabwareOffsetsResponse,
+    AxiosError
+  > = {}
+): UseQueryResult<SearchLabwareOffsetsResponse> {
+  const { shouldRefetch, queryOptionsNotify } = useNotifyDataReady({
+    topic: 'robot-server/labwareOffsets',
+    options,
+  })
+
+  const httpQueryResult = useSearchLabwareOffsets(request, queryOptionsNotify)
+
+  if (shouldRefetch) {
+    void httpQueryResult.refetch()
+  }
+
+  return httpQueryResult
+}