Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: avoid redundant automation SDK version refetches (#16991)

workvahedi294905e44248
diff --git a/__tests__/hooks/query/use-automation-sdk-version.test.tsx b/__tests__/hooks/query/use-automation-sdk-version.test.tsx
index 3a12139894..5d96a9e7c7 100644
--- a/__tests__/hooks/query/use-automation-sdk-version.test.tsx
+++ b/__tests__/hooks/query/use-automation-sdk-version.test.tsx
@@ -3,8 +3,11 @@ import { QueryClient } from "@tanstack/react-query";
import { beforeEach, describe, expect, it, vi } from "vitest";
import AutomationService from "#/api/automation-service/automation-service.api";
import type { ResolvedActiveBackend } from "#/api/backend-registry/types";
-import { useAutomationSdkVersion } from "#/hooks/query/use-automation-sdk-version";
-import { setQueryClient } from "#/query-client-config";
+import {
+ AUTOMATION_SDK_VERSION_CACHE_NAMESPACE,
+ useAutomationSdkVersion,
+} from "#/hooks/query/use-automation-sdk-version";
+import { getQueryClient, setQueryClient } from "#/query-client-config";
vi.mock("#/api/automation-service/automation-service.api", () => ({
default: {
@@ -29,6 +32,14 @@ vi.mock("#/contexts/active-backend-context", () => ({
useActiveBackend: () => activeBackendMock.active,
}));
+const localSdkVersionQueryKey = [
+ AUTOMATION_SDK_VERSION_CACHE_NAMESPACE,
+ "local-1",
+ "local",
+ "http://localhost:8000",
+ "",
+];
+
describe("useAutomationSdkVersion", () => {
beforeEach(() => {
vi.clearAllMocks();
@@ -49,6 +60,61 @@ describe("useAutomationSdkVersion", () => {
};
});
+ it("settles lookup failures as a non-fatal null result", async () => {
+ vi.mocked(AutomationService.getSdkVersion).mockRejectedValue(
+ new Error("automation unavailable"),
+ );
+
+ const { result } = renderHook(() => useAutomationSdkVersion());
+
+ await waitFor(() =>
+ expect(getQueryClient().getQueryState(localSdkVersionQueryKey)).toEqual(
+ expect.objectContaining({ data: null, status: "success" }),
+ ),
+ );
+
+ expect(result.current).toBeNull();
+ expect(AutomationService.getSdkVersion).toHaveBeenCalledTimes(1);
+ });
+
+ it("does not start a query when SDK version support is unavailable", () => {
+ const getSdkVersion = vi.mocked(AutomationService.getSdkVersion);
+ const getSdkVersionDescriptor = Object.getOwnPropertyDescriptor(
+ AutomationService,
+ "getSdkVersion",
+ );
+ if (!getSdkVersionDescriptor) {
+ throw new Error("Expected getSdkVersion to be defined");
+ }
+
+ Object.defineProperty(AutomationService, "getSdkVersion", {
+ configurable: true,
+ value: undefined,
+ });
+
+ try {
+ const hook = renderHook(() => useAutomationSdkVersion());
+
+ expect(hook.result.current).toBeNull();
+ expect(getSdkVersion).not.toHaveBeenCalled();
+ expect(getQueryClient().getQueryState(localSdkVersionQueryKey)).toEqual(
+ expect.objectContaining({
+ data: null,
+ fetchStatus: "idle",
+ status: "success",
+ }),
+ );
+
+ hook.unmount();
+ } finally {
+ Object.defineProperty(
+ AutomationService,
+ "getSdkVersion",
+ getSdkVersionDescriptor,
+ );
+ }
+ });
+
it("shares one request across consumers without a QueryClientProvider", async () => {
vi.mocked(AutomationService.getSdkVersion).mockResolvedValue("1.36.3");
diff --git a/src/hooks/query/use-automation-sdk-version.ts b/src/hooks/query/use-automation-sdk-version.ts
index d17c4c6ded..0b95953f8c 100644
--- a/src/hooks/query/use-automation-sdk-version.ts
+++ b/src/hooks/query/use-automation-sdk-version.ts
@@ -41,6 +41,8 @@ export function useAutomationSdkVersion() {
initialData: canFetchSdkVersion ? undefined : null,
staleTime: AUTOMATION_SDK_VERSION_CACHE_TIME_MS,
gcTime: AUTOMATION_SDK_VERSION_CACHE_TIME_MS,
+ refetchOnWindowFocus: false,
+ refetchOnReconnect: false,
},
providerQueryClient ?? getQueryClient(),
);