Merge pull request #56 from viamrobotics/add-pause-queries-hook

Add pause queries hook

Author: DTCurrie

.changeset/small-cases-greet.md

@@ -0,0 +1,5 @@
+---
+'@viamrobotics/svelte-sdk': minor
+---
+
+Add enable queries hook

src/lib/hooks/create-resource-query.svelte.ts

@@ -7,6 +7,7 @@ import type { Resource } from '@viamrobotics/sdk';
 import { toStore, fromStore } from 'svelte/store';
 import { usePolling } from './use-polling.svelte';
 import { useQueryLogger } from '../query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
@@ -36,6 +37,7 @@ export const createResourceQuery = <T extends Resource, K extends keyof T>(
     | [options?: (() => QueryOptions) | QueryOptions]
 ): { current: QueryObserverResult<ResolvedReturnType<T[K]>> } => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
 
   let [args, options] = additional;
 
@@ -62,7 +64,10 @@ export const createResourceQuery = <T extends Resource, K extends keyof T>(
         methodName,
         ...(_args ? [_args] : []),
       ],
-      enabled: client.current !== undefined && _options?.enabled !== false,
+      enabled:
+        client.current !== undefined &&
+        _options?.enabled !== false &&
+        enabledQueries.resourceQueries,
       retry: false,
       queryFn: async () => {
         const clientFunc = client.current?.[method];

src/lib/hooks/create-resource-stream.svelte.ts

@@ -7,6 +7,7 @@ import {
 import type { Resource } from '@viamrobotics/sdk';
 import { toStore, fromStore } from 'svelte/store';
 import { useQueryLogger } from '../query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
@@ -54,6 +55,7 @@ export const createResourceStream = <T extends Resource, K extends keyof T>(
     | [options?: (() => QueryOptions) | QueryOptions]
 ): { current: QueryResult<StreamItemType<T[K]>> } => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
 
   let [args, options] = additional;
 
@@ -103,7 +105,10 @@ export const createResourceStream = <T extends Resource, K extends keyof T>(
   const queryOptions = $derived(
     createQueryOptions({
       queryKey,
-      enabled: client.current !== undefined && _options?.enabled !== false,
+      enabled:
+        client.current !== undefined &&
+        _options?.enabled !== false &&
+        enabledQueries.resourceQueries,
       queryFn: streamedQuery<StreamItemType<T[K]>>({
         streamFn: processStream,
         refetchMode,

src/lib/hooks/create-robot-query.svelte.ts

@@ -8,6 +8,7 @@ import type { RobotClient } from '@viamrobotics/sdk';
 import { toStore, fromStore } from 'svelte/store';
 import { usePolling } from './use-polling.svelte';
 import { useQueryLogger } from '$lib/query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
@@ -37,6 +38,7 @@ export const createRobotQuery = <T extends RobotClient, K extends keyof T>(
     | [options?: (() => QueryOptions) | QueryOptions]
 ): { current: QueryObserverResult<ResolvedReturnType<T[K]>> } => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
   let [args, options] = additional;
 
   if (options === undefined && args !== undefined) {
@@ -60,7 +62,10 @@ export const createRobotQuery = <T extends RobotClient, K extends keyof T>(
         methodName,
         ...(_args ? [_args] : []),
       ],
-      enabled: client.current !== undefined && _options?.enabled !== false,
+      enabled:
+        client.current !== undefined &&
+        _options?.enabled !== false &&
+        enabledQueries.robotQueries,
       retry: false,
       queryFn: async () => {
         const clientFunc = client.current?.[method];

src/lib/hooks/create-stream-client.svelte.ts

@@ -8,12 +8,14 @@ import {
 } from '@tanstack/svelte-query';
 import { fromStore, toStore } from 'svelte/store';
 import { useQueryLogger } from '../query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 export const createStreamClient = (
   partID: () => string,
   resourceName: () => string
 ) => {
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
   let mediaStream = $state.raw<MediaStream | null>(null);
 
   const client = useRobotClient(partID);
@@ -55,7 +57,7 @@ export const createStreamClient = (
         'stream',
         'getOptions',
       ],
-      enabled: streamClient !== undefined,
+      enabled: streamClient !== undefined && enabledQueries.streams,
       retry: false,
       refetchOnWindowFocus: false,
       queryFn: async () => {

src/lib/hooks/machine-status.svelte.ts

@@ -10,6 +10,7 @@ import type { PartID } from '$lib/part';
 import type { RobotClient } from '@viamrobotics/sdk';
 import { usePolling } from './use-polling.svelte';
 import { useQueryLogger } from '$lib/query-logger';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 const key = Symbol('machine-status-context');
 
@@ -23,11 +24,12 @@ interface Context {
 export const provideMachineStatusContext = (refetchInterval: () => number) => {
   const clients = useRobotClients();
   const debug = useQueryLogger();
+  const enabledQueries = useEnabledQueries();
 
   const options = $derived(
     Object.entries(clients.current).map(([partID, client]) => {
       return queryOptions({
-        enabled: client !== undefined,
+        enabled: client !== undefined && enabledQueries.machineStatus,
         queryKey: [
           'viam-svelte-sdk',
           'partID',

src/lib/hooks/resource-names.svelte.ts

@@ -11,6 +11,7 @@ import type { PartID } from '../part';
 import { useMachineStatuses } from './machine-status.svelte';
 import { useQueryLogger } from '$lib/query-logger';
 import { useDebounce } from 'runed';
+import { useEnabledQueries } from './use-enabled-queries.svelte';
 
 const key = Symbol('resources-context');
 
@@ -85,7 +86,7 @@ export const provideResourceNamesContext = () => {
   const machineStatuses = useMachineStatuses();
   const clients = useRobotClients();
   const debug = useQueryLogger();
-
+  const enabledQueries = useEnabledQueries();
   const partIDs = $derived(Object.keys(clients.current));
   const options = $derived.by(() => {
     const results = [];
@@ -96,7 +97,9 @@ export const provideResourceNamesContext = () => {
       const options = queryOptions({
         refetchOnMount: false,
         enabled:
-          client !== undefined && machineStatus?.state === MachineState.Running,
+          client !== undefined &&
+          machineStatus?.state === MachineState.Running &&
+          enabledQueries.resourceNames,
         queryKey: [
           'viam-svelte-sdk',
           'partID',

src/lib/hooks/use-enabled-queries.svelte.ts

@@ -0,0 +1,51 @@
+export const useEnabledQueries = () => {
+  let machineStatus = $state(true);
+  let resourceNames = $state(true);
+  let resourceQueries = $state(true);
+  let robotQueries = $state(true);
+  let streams = $state(true);
+
+  const enableResourceQueries = () => (resourceQueries = true);
+  const disableResourceQueries = () => (resourceQueries = false);
+
+  const enableMachineStatus = () => (machineStatus = true);
+  const disableMachineStatus = () => (machineStatus = false);
+
+  const enableResourceNames = () => (resourceNames = true);
+  const disableResourceNames = () => (resourceNames = false);
+
+  const enableRobotQueries = () => (robotQueries = true);
+  const disableRobotQueries = () => (robotQueries = false);
+
+  const enableStreams = () => (streams = true);
+  const disableStreams = () => (streams = false);
+
+  return {
+    get resourceQueries() {
+      return resourceQueries;
+    },
+    get machineStatus() {
+      return machineStatus;
+    },
+    get resourceNames() {
+      return resourceNames;
+    },
+    get robotQueries() {
+      return robotQueries;
+    },
+    get streams() {
+      return streams;
+    },
+
+    enableResourceQueries,
+    disableResourceQueries,
+    enableMachineStatus,
+    disableMachineStatus,
+    enableResourceNames,
+    disableResourceNames,
+    enableRobotQueries,
+    disableRobotQueries,
+    enableStreams,
+    disableStreams,
+  };
+};