@tanstack/query-core 4.13.0 → 4.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.13.0",
+  "version": "4.14.0",
   "description": "The framework agnostic core that powers TanStack Query",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/index.ts

@@ -13,6 +13,7 @@ export { focusManager } from './focusManager'
 export { onlineManager } from './onlineManager'
 export {
   hashQueryKey,
+  replaceEqualDeep,
   isError,
   isServer,
   parseQueryArgs,

package/src/query.ts

@@ -600,16 +600,14 @@ function getDefaultState<
       ? (options.initialData as InitialDataFunction<TData>)()
       : options.initialData
 
-  const hasInitialData = typeof options.initialData !== 'undefined'
+  const hasData = typeof data !== 'undefined'
 
-  const initialDataUpdatedAt = hasInitialData
+  const initialDataUpdatedAt = hasData
     ? typeof options.initialDataUpdatedAt === 'function'
       ? (options.initialDataUpdatedAt as () => number | undefined)()
       : options.initialDataUpdatedAt
     : 0
 
-  const hasData = typeof data !== 'undefined'
-
   return {
     data,
     dataUpdateCount: 0,

package/src/queryClient.ts

@@ -71,6 +71,12 @@ export class QueryClient {
     this.defaultOptions = config.defaultOptions || {}
     this.queryDefaults = []
     this.mutationDefaults = []
+
+    if (process.env.NODE_ENV !== 'production' && config.logger) {
+      this.logger.error(
+        `Passing a custom logger has been deprecated and will be removed in the next major version.`,
+      )
+    }
   }
 
   mount(): void {

package/src/queryObserver.ts

@@ -155,6 +155,17 @@ export class QueryObserver<
 
     this.options = this.client.defaultQueryOptions(options)
 
+    if (
+      process.env.NODE_ENV !== 'production' &&
+      typeof options?.isDataEqual !== 'undefined'
+    ) {
+      this.client
+        .getLogger()
+        .error(
+          `The isDataEqual option has been deprecated and will be removed in the next major version. You can achieve the same functionality by passing a function as the structuralSharing option`,
+        )
+    }
+
     if (!shallowEqualObjects(prevOptions, this.options)) {
       this.client.getQueryCache().notify({
         type: 'observerOptionsUpdated',
@@ -457,7 +468,7 @@ export class QueryObserver<
     // Keep previous data if needed
     if (
       options.keepPreviousData &&
-      !state.dataUpdateCount &&
+      !state.dataUpdatedAt &&
       prevQueryResult?.isSuccess &&
       status !== 'error'
     ) {
@@ -517,11 +528,6 @@ export class QueryObserver<
         if (options.select && typeof placeholderData !== 'undefined') {
           try {
             placeholderData = options.select(placeholderData)
-            placeholderData = replaceData(
-              prevResult?.data,
-              placeholderData,
-              options,
-            )
             this.selectError = null
           } catch (selectError) {
             if (process.env.NODE_ENV !== 'production') {
@@ -534,7 +540,7 @@ export class QueryObserver<
 
       if (typeof placeholderData !== 'undefined') {
         status = 'success'
-        data = placeholderData as TData
+        data = replaceData(prevResult?.data, placeholderData, options) as TData
         isPlaceholderData = true
       }
     }

package/src/tests/queriesObserver.test.tsx

@@ -50,7 +50,13 @@ describe('queriesObserver', () => {
     unsubscribe()
     expect(observerResult).toMatchObject([{ data: 1 }, { data: 2 }])
 
-    expect(mockLogger.error).toHaveBeenCalledTimes(1)
+    expect(mockLogger.error).toHaveBeenCalledTimes(2)
+    expect(mockLogger.error).toHaveBeenCalledWith(
+      'Passing a custom logger has been deprecated and will be removed in the next major version.',
+    )
+    expect(mockLogger.error).toHaveBeenCalledWith(
+      'Passing a custom logger has been deprecated and will be removed in the next major version.',
+    )
   })
 
   test('should update when a query updates', async () => {

package/src/tests/queryClient.test.tsx

@@ -160,7 +160,7 @@ describe('queryClient', () => {
       // No defaults, no warning
       const noDefaults = queryClient.getQueryDefaults(keyABCD)
       expect(noDefaults).toBeUndefined()
-      expect(mockLogger.error).not.toHaveBeenCalled()
+      expect(mockLogger.error).toHaveBeenCalledTimes(1)
 
       // If defaults for key ABCD are registered **before** the ones of key ABC (more generic)…
       queryClient.setQueryDefaults(keyABCD, defaultsOfABCD)
@@ -169,7 +169,7 @@ describe('queryClient', () => {
       const goodDefaults = queryClient.getQueryDefaults(keyABCD)
       expect(goodDefaults).toBe(defaultsOfABCD)
       // The warning is still raised since several defaults are matching
-      expect(mockLogger.error).toHaveBeenCalledTimes(1)
+      expect(mockLogger.error).toHaveBeenCalledTimes(2)
 
       // Let's create another queryClient and change the order of registration
       const newQueryClient = createQueryClient()
@@ -180,7 +180,7 @@ describe('queryClient', () => {
       const badDefaults = newQueryClient.getQueryDefaults(keyABCD)
       expect(badDefaults).not.toBe(defaultsOfABCD)
       expect(badDefaults).toBe(defaultsOfABC)
-      expect(mockLogger.error).toHaveBeenCalledTimes(2)
+      expect(mockLogger.error).toHaveBeenCalledTimes(4)
     })
 
     test('should warn in dev if several mutation defaults match a given key', () => {
@@ -216,7 +216,10 @@ describe('queryClient', () => {
       // No defaults, no warning
       const noDefaults = queryClient.getMutationDefaults(keyABCD)
       expect(noDefaults).toBeUndefined()
-      expect(mockLogger.error).not.toHaveBeenCalled()
+      expect(mockLogger.error).toHaveBeenNthCalledWith(
+        1,
+        'Passing a custom logger has been deprecated and will be removed in the next major version.',
+      )
 
       // If defaults for key ABCD are registered **before** the ones of key ABC (more generic)…
       queryClient.setMutationDefaults(keyABCD, defaultsOfABCD)
@@ -225,7 +228,7 @@ describe('queryClient', () => {
       const goodDefaults = queryClient.getMutationDefaults(keyABCD)
       expect(goodDefaults).toBe(defaultsOfABCD)
       // The warning is still raised since several defaults are matching
-      expect(mockLogger.error).toHaveBeenCalledTimes(1)
+      expect(mockLogger.error).toHaveBeenCalledTimes(2)
 
       // Let's create another queryClient and change the order of registration
       const newQueryClient = createQueryClient()
@@ -236,7 +239,7 @@ describe('queryClient', () => {
       const badDefaults = newQueryClient.getMutationDefaults(keyABCD)
       expect(badDefaults).not.toBe(defaultsOfABCD)
       expect(badDefaults).toBe(defaultsOfABC)
-      expect(mockLogger.error).toHaveBeenCalledTimes(2)
+      expect(mockLogger.error).toHaveBeenCalledTimes(4)
     })
   })
 

package/src/tests/queryObserver.test.tsx

@@ -505,6 +505,24 @@ describe('queryObserver', () => {
     expect(results[1]).toMatchObject({ status: 'success', data: 'data' })
   })
 
+  test('should structurally share placeholder data', async () => {
+    const key = queryKey()
+    const observer = new QueryObserver(queryClient, {
+      queryKey: key,
+      enabled: false,
+      queryFn: () => 'data',
+      placeholderData: {},
+    })
+
+    const firstData = observer.getCurrentResult().data
+
+    observer.setOptions({ placeholderData: {} })
+
+    const secondData = observer.getCurrentResult().data
+
+    expect(firstData).toBe(secondData)
+  })
+
   test('the retrier should not throw an error when reject if the retrier is already resolved', async () => {
     const key = queryKey()
     let count = 0
@@ -672,7 +690,7 @@ describe('queryObserver', () => {
       },
     })
 
-    expect(mockLogger.error).toHaveBeenNthCalledWith(1, new Error('error'))
+    expect(mockLogger.error).toHaveBeenNthCalledWith(2, new Error('error'))
   })
 
   test('should not use replaceEqualDeep for select value when structuralSharing option is true and placeholderdata is defined', () => {