feat(core): add queryKey to QueryObserverResult

Author: TkDodo

packages/query-core/src/queryObserver.ts

@@ -586,6 +586,7 @@ export class QueryObserver<
       refetch: this.refetch,
       promise: this.#currentThenable,
       isEnabled: resolveEnabled(options.enabled, query) !== false,
+      queryKey: query.queryKey,
     }
 
     const nextResult = result as QueryObserverResult<TData, TError>

packages/query-core/src/types.ts

@@ -625,6 +625,10 @@ export interface QueryObserverBaseResult<
   TData = unknown,
   TError = DefaultError,
 > {
+  /**
+   * The query key used by the query.
+   */
+  queryKey: QueryKey
   /**
    * The last successfully resolved data for the query.
    */

packages/react-query/src/__tests__/useQuery.test.tsx

@@ -100,6 +100,7 @@ describe('useQuery', () => {
     expect(states.length).toEqual(2)
 
     expect(states[0]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: null,
@@ -129,6 +130,7 @@ describe('useQuery', () => {
     })
 
     expect(states[1]).toEqual({
+      queryKey: key,
       data: 'test',
       dataUpdatedAt: expect.any(Number),
       error: null,
@@ -192,6 +194,7 @@ describe('useQuery', () => {
     rendered.getByText('Status: error')
 
     expect(states[0]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: null,
@@ -221,6 +224,7 @@ describe('useQuery', () => {
     })
 
     expect(states[1]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: null,
@@ -250,6 +254,7 @@ describe('useQuery', () => {
     })
 
     expect(states[2]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: new Error('rejected #2'),
@@ -6788,7 +6793,6 @@ describe('useQuery', () => {
     let fetchCount = 0
     const queryFn = vi.fn().mockImplementation(() => {
       fetchCount++
-      console.log(`Fetching... (attempt ${fetchCount})`)
       return Promise.reject(new Error('Simulated 500 error'))
     })
 
@@ -6906,7 +6910,6 @@ describe('useQuery', () => {
     let fetchCount = 0
     const queryFn = vi.fn().mockImplementation(() => {
       fetchCount++
-      console.log(`Fetching... (attempt ${fetchCount})`)
       return Promise.reject(new Error('Simulated 500 error'))
     })
 

packages/solid-query/src/__tests__/useQuery.test.tsx

@@ -289,6 +289,7 @@ describe('useQuery', () => {
     expect(states.length).toEqual(2)
 
     expect(states[0]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: null,
@@ -318,6 +319,7 @@ describe('useQuery', () => {
     })
 
     expect(states[1]).toEqual({
+      queryKey: key,
       data: 'test',
       dataUpdatedAt: expect.any(Number),
       error: null,
@@ -384,6 +386,7 @@ describe('useQuery', () => {
     expect(rendered.getByText('Status: error')).toBeInTheDocument()
 
     expect(states[0]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: null,
@@ -413,6 +416,7 @@ describe('useQuery', () => {
     })
 
     expect(states[1]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: null,
@@ -442,6 +446,7 @@ describe('useQuery', () => {
     })
 
     expect(states[2]).toEqual({
+      queryKey: key,
       data: undefined,
       dataUpdatedAt: 0,
       error: new Error('rejected'),