Merge branch 'main' into bugs/8093-eslint-exhaustive-deps-rule-cant-r…

…ecognize-getter-in-queryKey
TanStack · Oct 9, 2024 · eb45788 · eb45788
2 parents d82a448 + f1f2529
commit eb45788
Show file tree

Hide file tree

Showing 31 changed files with 132 additions and 107 deletions.
diff --git a/examples/react/algolia/package.json b/examples/react/algolia/package.json
@@ -10,8 +10,8 @@
   },
   "dependencies": {
     "@algolia/client-search": "5.2.1",
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"
   },

diff --git a/examples/react/auto-refetching/package.json b/examples/react/auto-refetching/package.json
@@ -8,8 +8,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/basic-graphql-request/package.json b/examples/react/basic-graphql-request/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "graphql": "^16.9.0",
     "graphql-request": "^7.1.0",
     "react": "19.0.0-rc-4c2e457c7c-20240522",

diff --git a/examples/react/basic/package.json b/examples/react/basic/package.json
@@ -10,9 +10,9 @@
   },
   "dependencies": {
     "@tanstack/query-sync-storage-persister": "^5.59.0",
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
-    "@tanstack/react-query-persist-client": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
+    "@tanstack/react-query-persist-client": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"
   },

diff --git a/examples/react/default-query-function/package.json b/examples/react/default-query-function/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"
   },

diff --git a/examples/react/devtools-panel/package.json b/examples/react/devtools-panel/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"
   },

diff --git a/examples/react/infinite-query-with-max-pages/package.json b/examples/react/infinite-query-with-max-pages/package.json
@@ -8,8 +8,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/load-more-infinite-scroll/package.json b/examples/react/load-more-infinite-scroll/package.json
@@ -8,8 +8,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

diff --git a/examples/react/nextjs-app-prefetching/package.json b/examples/react/nextjs-app-prefetching/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^15.0.0-rc.0",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"

diff --git a/examples/react/nextjs-suspense-streaming/package.json b/examples/react/nextjs-suspense-streaming/package.json
@@ -9,9 +9,9 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
-    "@tanstack/react-query-next-experimental": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
+    "@tanstack/react-query-next-experimental": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/nextjs/package.json b/examples/react/nextjs/package.json
@@ -8,8 +8,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/offline/package.json b/examples/react/offline/package.json
@@ -10,9 +10,9 @@
   "dependencies": {
     "@tanstack/query-sync-storage-persister": "^5.59.0",
     "@tanstack/react-location": "^3.7.4",
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
-    "@tanstack/react-query-persist-client": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
+    "@tanstack/react-query-persist-client": "^5.59.3",
     "msw": "^2.3.4",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522",

diff --git a/examples/react/optimistic-updates-cache/package.json b/examples/react/optimistic-updates-cache/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/optimistic-updates-ui/package.json b/examples/react/optimistic-updates-ui/package.json
@@ -8,8 +8,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/pagination/package.json b/examples/react/pagination/package.json
@@ -8,8 +8,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/playground/package.json b/examples/react/playground/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"
   },

diff --git a/examples/react/prefetching/package.json b/examples/react/prefetching/package.json
@@ -8,8 +8,8 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "next": "^14.2.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/react/react-native/package.json b/examples/react/react-native/package.json
@@ -14,8 +14,8 @@
     "@react-native-community/netinfo": "^11.3.2",
     "@react-navigation/native": "^6.1.18",
     "@react-navigation/stack": "^6.4.1",
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "expo": "^51.0.22",
     "expo-constants": "^16.0.2",
     "expo-status-bar": "^1.12.1",

diff --git a/examples/react/react-router/package.json b/examples/react/react-router/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "localforage": "^1.10.0",
     "match-sorter": "^6.3.4",
     "react": "19.0.0-rc-4c2e457c7c-20240522",

diff --git a/examples/react/rick-morty/package.json b/examples/react/rick-morty/package.json
@@ -12,8 +12,8 @@
     "@emotion/styled": "^11.13.0",
     "@mui/material": "^6.0.0",
     "@mui/styles": "^6.0.0",
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522",
     "react-router": "^6.25.1",

diff --git a/examples/react/shadow-dom/package.json b/examples/react/shadow-dom/package.json
@@ -9,8 +9,8 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"
   },

diff --git a/examples/react/simple/package.json b/examples/react/simple/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522"
   },

diff --git a/examples/react/star-wars/package.json b/examples/react/star-wars/package.json
@@ -12,8 +12,8 @@
     "@emotion/styled": "^11.13.0",
     "@mui/material": "^6.0.0",
     "@mui/styles": "^6.0.0",
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522",
     "react-router": "^6.25.1",

diff --git a/examples/react/suspense/package.json b/examples/react/suspense/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.59.0",
-    "@tanstack/react-query-devtools": "^5.59.0",
+    "@tanstack/react-query": "^5.59.3",
+    "@tanstack/react-query-devtools": "^5.59.3",
     "font-awesome": "^4.7.0",
     "react": "19.0.0-rc-4c2e457c7c-20240522",
     "react-dom": "19.0.0-rc-4c2e457c7c-20240522",

diff --git a/packages/react-query-devtools/package.json b/packages/react-query-devtools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query-devtools",
-  "version": "5.59.0",
+  "version": "5.59.3",
   "description": "Developer tools to interact with and visualize the TanStack/react-query cache",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/react-query-next-experimental/package.json b/packages/react-query-next-experimental/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query-next-experimental",
-  "version": "5.59.0",
+  "version": "5.59.3",
   "description": "Hydration utils for React Query in the NextJs app directory",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/react-query-persist-client/package.json b/packages/react-query-persist-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query-persist-client",
-  "version": "5.59.0",
+  "version": "5.59.3",
   "description": "React bindings to work with persisters in TanStack/react-query",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/react-query/package.json b/packages/react-query/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query",
-  "version": "5.59.0",
+  "version": "5.59.3",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in React",
   "author": "tannerlinsley",
   "license": "MIT",

diff --git a/packages/react-query/src/__tests__/useQuery.test.tsx b/packages/react-query/src/__tests__/useQuery.test.tsx
@@ -4971,6 +4971,29 @@ describe('useQuery', () => {
     expect(renders).toBe(hashes)
   })
 
+  it('should hash query keys that contain bigints given a supported query hash function', async () => {
+    const key = [queryKey(), 1n]
+
+    function queryKeyHashFn(x: any) {
+      return JSON.stringify(x, (_, value) => {
+        if (typeof value === 'bigint') return value.toString()
+        return value
+      })
+    }
+
+    function Page() {
+      useQuery({ queryKey: key, queryFn: () => 'test', queryKeyHashFn })
+      return null
+    }
+
+    renderWithClient(queryClient, <Page />)
+
+    await sleep(10)
+
+    const query = queryClient.getQueryCache().get(queryKeyHashFn(key))
+    expect(query?.state.data).toBe('test')
+  })
+
   it('should refetch when changed enabled to true in error state', async () => {
     const queryFn = vi.fn<(...args: Array<unknown>) => unknown>()
     queryFn.mockImplementation(async () => {

diff --git a/packages/react-query/src/useBaseQuery.ts b/packages/react-query/src/useBaseQuery.ts
@@ -70,7 +70,9 @@ export function useBaseQuery<
   useClearResetErrorBoundary(errorResetBoundary)
 
   // this needs to be invoked before creating the Observer because that can create a cache entry
-  const isNewCacheEntry = !client.getQueryState(options.queryKey)
+  const isNewCacheEntry = !client
+    .getQueryCache()
+    .get(defaultedOptions.queryHash)
 
   const [observer] = React.useState(
     () =>