Add queryHash to QueryFunctionContext

docs/framework/react/guides/query-functions.md

@@ -100,6 +100,7 @@ function fetchTodoList({ queryKey }) {
 The `QueryFunctionContext` is the object passed to each query function. It consists of:
 
 - `queryKey: QueryKey`: [Query Keys](../query-keys.md)
+- `queryHash: string`: The hash of the query key, used as a unique identifier for the query
 - `client: QueryClient`: [QueryClient](../../../../reference/QueryClient.md)
 - `signal?: AbortSignal`
   - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) instance provided by TanStack Query

packages/query-core/src/__tests__/infiniteQueryBehavior.test.tsx

@@ -1,6 +1,7 @@
 import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
 import { queryKey, sleep } from '@tanstack/query-test-utils'
 import { CancelledError, InfiniteQueryObserver, QueryClient } from '..'
+import { hashQueryKeyByOptions } from '../utils'
 import type { InfiniteData, InfiniteQueryObserverResult, QueryCache } from '..'
 
 describe('InfiniteQueryBehavior', () => {
@@ -82,6 +83,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 1,
       meta: undefined,
@@ -96,6 +98,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 2,
       direction: 'forward',
@@ -115,6 +118,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 0,
       direction: 'backward',
@@ -135,6 +139,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: -1,
       meta: undefined,
@@ -154,6 +159,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 1,
       meta: undefined,
@@ -176,6 +182,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 0,
       meta: undefined,
@@ -185,6 +192,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(2, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 1,
       meta: undefined,
@@ -237,6 +245,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 1,
       meta: undefined,
@@ -293,6 +302,7 @@ describe('InfiniteQueryBehavior', () => {
 
     expect(queryFnSpy).toHaveBeenNthCalledWith(1, {
       queryKey: key,
+      queryHash: hashQueryKeyByOptions(key),
       client: queryClient,
       pageParam: 2,
       meta: undefined,

packages/query-core/src/__tests__/query.test.tsx

@@ -254,6 +254,7 @@ describe('query', () => {
     expect(args).toBeDefined()
     expect(args.pageParam).toBeUndefined()
     expect(args.queryKey).toEqual(key)
+    expect(args.queryHash).toBe(hashQueryKeyByOptions(key))
     expect(args.signal).toBeInstanceOf(AbortSignal)
     expect(args.client).toEqual(queryClient)
   })

packages/query-core/src/__tests__/queryClient.test-d.tsx

@@ -203,6 +203,7 @@ describe('defaultOptions', () => {
             expectTypeOf(context).toEqualTypeOf<{
               client: QueryClient
               queryKey: QueryKey
+              queryHash: string
               meta: Record<string, unknown> | undefined
               signal: AbortSignal
               pageParam?: unknown

packages/query-core/src/infiniteQueryBehavior.ts

@@ -61,6 +61,7 @@ export function infiniteQueryBehavior<TQueryFnData, TError, TData, TPageParam>(
             > = {
               client: context.client,
               queryKey: context.queryKey,
+              queryHash: query.queryHash,
               pageParam: param,
               direction: previous ? 'backward' : 'forward',
               meta: context.options.meta,
@@ -119,6 +120,7 @@ export function infiniteQueryBehavior<TQueryFnData, TError, TData, TPageParam>(
             {
               client: context.client,
               queryKey: context.queryKey,
+              queryHash: query.queryHash,
               meta: context.options.meta,
               signal: context.signal,
             },

packages/query-core/src/query.ts

@@ -455,6 +455,7 @@ export class Query<
         > = {
           client: this.#client,
           queryKey: this.queryKey,
+          queryHash: this.queryHash,
           meta: this.meta,
         }
         addSignalProperty(queryFnContext)