feat(app): Use notifications for labware offsets instead of polling (#17832)

## Overview

The client-side half of EXEC-1342.

## Test Plan and Hands on Testing

* [x] I guess at this point we can turn on the feature flag and try this
out by entering LPC on one client and changing offsets on another?
  * Tested with a merge of this PR, #17853, #17817, and #17850.

## Changelog

The client was polling `POST /labwareOffsets/searches`. This switches it
to only happen when the client receives a notification from the server
that offsets have changed, with a polling fallback. I'm entirely
cargo-culting the patterns from the existing `useNotify___()` hooks.

## Risk assessment

Medium. I don't think we have a good way to integration-test this kind
of thing, so there are risks of things like missed updates, or
inadvertent polling.

Author: SyntaxColoring

.eslintrc.js

@@ -56,6 +56,7 @@ module.exports = {
               'useCurrentMaintenanceRun',
               'useDeckConfigurationQuery',
               'useAllCommandsAsPreSerializedList',
+              'useSearchLabwareOffsets',
             ],
             message:
               'HTTP hook deprecated. Use the equivalent notification wrapper (useNotifyXYZ).',

api-client/src/labwareOffsets/searchLabwareOffsets.ts

@@ -7,7 +7,7 @@ import type {
 } from '../types'
 import type { ANY_LOCATION, StoredLabwareOffset } from './types'
 
-export interface SearchLabwareOffsetsData {
+export interface SearchLabwareOffsetsRequest {
   /** Filters are ORed together. Within a single filter, criteria are ANDed together. */
   filters: Array<{
     id?: string
@@ -31,10 +31,10 @@ export interface SearchLabwareOffsetsResponse {
  */
 export function searchLabwareOffsets(
   config: HostConfig,
-  data: SearchLabwareOffsetsData
+  data: SearchLabwareOffsetsRequest
 ): ResponsePromise<SearchLabwareOffsetsResponse> {
   return request<
     SearchLabwareOffsetsResponse,
-    { data: SearchLabwareOffsetsData }
+    { data: SearchLabwareOffsetsRequest }
   >(POST, '/labwareOffsets/searches', { data }, config)
 }

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

@@ -1,13 +1,13 @@
 import { ANY_LOCATION } from '@opentrons/api-client'
 
-import type { SearchLabwareOffsetsData } from '@opentrons/api-client'
+import type { SearchLabwareOffsetsRequest } from '@opentrons/api-client'
 import type { LabwareLocationInfo } from '/app/redux/protocol-runs'
 
 // For location combos that require LPC consideration, prepare params for searching
 // for the existing offsets for those location combos.
 export function getLPCSearchParams(
   lwLocCombos: LabwareLocationInfo[]
-): SearchLabwareOffsetsData {
+): SearchLabwareOffsetsRequest {
   const locationSpecificOffsetSearchData = lwLocCombos.map(combo => ({
     definitionUri: combo.definitionUri,
     locationSequence: combo.lwOffsetLocSeq,

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'
@@ -65,11 +65,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: lwOffsetsData } = useSearchLabwareOffsets(
+  const { data: lwOffsetsData } = useNotifySearchLabwareOffsets(
     searchLwOffsetsParams,
     {
       enabled:

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 './useNotifySearchLabwareOffsets'

app/src/resources/labware_offsets/useNotifySearchLabwareOffsets.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
+}

react-api-client/src/labwareOffsets/useSearchLabwareOffsets.ts

@@ -8,12 +8,12 @@ import type { UseQueryOptions, UseQueryResult } from 'react-query'
 import type { AxiosError } from 'axios'
 import type {
   HostConfig,
-  SearchLabwareOffsetsData,
+  SearchLabwareOffsetsRequest,
   SearchLabwareOffsetsResponse,
 } from '@opentrons/api-client'
 
 export function useSearchLabwareOffsets(
-  data: SearchLabwareOffsetsData,
+  data: SearchLabwareOffsetsRequest,
   options: UseQueryOptions<SearchLabwareOffsetsResponse, AxiosError> = {}
 ): UseQueryResult<SearchLabwareOffsetsResponse, AxiosError> {
   const host = useHost()