fix(core): keep query context signal lazy when merging meta

Author: Dailin521

packages/core/src/definitions/helpers/prepare-query-context/index.spec.ts

@@ -0,0 +1,23 @@
+import { prepareQueryContext } from ".";
+
+describe("prepareQueryContext", () => {
+  it("should keep signal lazy when merging it into meta", () => {
+    const signal = new AbortController().signal;
+    const signalGetter = vi.fn(() => signal);
+    const context = {
+      queryKey: ["posts", "list"],
+      get signal() {
+        return signalGetter();
+      },
+    } as any;
+
+    const meta = prepareQueryContext(context, { foo: "bar" });
+
+    expect(meta.foo).toBe("bar");
+    expect(meta.queryKey).toEqual(["posts", "list"]);
+    expect(signalGetter).not.toHaveBeenCalled();
+
+    expect(meta.signal).toBe(signal);
+    expect(signalGetter).toHaveBeenCalledTimes(1);
+  });
+});

packages/core/src/definitions/helpers/prepare-query-context/index.ts

@@ -4,13 +4,19 @@ type Context =
   | QueryFunctionContext<QueryKey, any>
   | QueryFunctionContext<QueryKey, never>;
 
+type QueryContextMeta<TMeta extends Record<string, unknown> | undefined> = (
+  TMeta extends Record<string, unknown> ? TMeta : Record<string, never>
+) &
+  Pick<Context, "queryKey" | "signal">;
+
 export const prepareQueryContext = (
   context: Context,
-): Pick<Context, "queryKey" | "signal"> => {
-  const queryContext: Pick<Context, "queryKey" | "signal"> = {
+  meta?: Record<string, unknown>,
+): QueryContextMeta<typeof meta> => {
+  const queryContext = {
+    ...(meta ?? {}),
     queryKey: context.queryKey,
-    signal: undefined as any,
-  };
+  } as QueryContextMeta<typeof meta>;
 
   Object.defineProperty(queryContext, "signal", {
     enumerable: true,

packages/core/src/hooks/data/useCustom.ts

@@ -173,10 +173,7 @@ export const useCustom = <
           url,
           method,
           ...config,
-          meta: {
-            ...combinedMeta,
-            ...prepareQueryContext(context as any),
-          },
+          meta: prepareQueryContext(context as any, combinedMeta),
         }),
       ...queryOptions,
       meta: {

packages/core/src/hooks/data/useInfiniteList.ts

@@ -254,10 +254,7 @@ export const useInfiniteList = <
           (context.pageParam as number) ?? prefferedPagination.currentPage,
       };
 
-      const meta = {
-        ...combinedMeta,
-        ...prepareQueryContext(context),
-      };
+      const meta = prepareQueryContext(context, combinedMeta);
 
       return getList<TQueryFnData>({
         resource: resource?.name || "",

packages/core/src/hooks/data/useList.ts

@@ -254,10 +254,7 @@ export const useList = <
       })
       .get(),
     queryFn: (context) => {
-      const meta = {
-        ...combinedMeta,
-        ...prepareQueryContext(context),
-      };
+      const meta = prepareQueryContext(context, combinedMeta);
       return getList<TQueryFnData>({
         resource: resource?.name ?? "",
         pagination: prefferedPagination,

packages/core/src/hooks/data/useMany.ts

@@ -188,10 +188,7 @@ export const useMany = <
       })
       .get(),
     queryFn: (context) => {
-      const meta = {
-        ...combinedMeta,
-        ...prepareQueryContext(context as any),
-      };
+      const meta = prepareQueryContext(context as any, combinedMeta);
 
       if (getMany) {
         return getMany({

packages/core/src/hooks/data/useOne.ts

@@ -185,10 +185,7 @@ export const useOne = <
       getOne<TQueryFnData>({
         resource: resource?.name ?? "",
         id: id!,
-        meta: {
-          ...combinedMeta,
-          ...prepareQueryContext(context as any),
-        },
+        meta: prepareQueryContext(context as any, combinedMeta),
       }),
     ...queryOptions,
     enabled: isEnabled,