feat(utils): add assert helper

Author: Guillaume Labat

src/core/tests/utils.test.tsx

@@ -5,6 +5,7 @@ import {
   parseMutationArgs,
   matchMutation,
   scheduleMicrotask,
+  assert,
 } from '../utils'
 import { QueryClient, QueryCache, setLogger, Logger } from '../..'
 import { queryKey } from '../../reactjs/tests/utils'
@@ -389,4 +390,24 @@ describe('core/utils', () => {
       jest.useRealTimers()
     })
   })
+
+  describe('assert', () => {
+    it('should assert acccording to condition', () => {
+      const logger: Logger = {
+        error: jest.fn(),
+        log: jest.fn(),
+        warn: jest.fn(),
+      }
+      setLogger(logger)
+
+      assert(true, '')
+      expect(logger.warn).not.toHaveBeenCalled()
+      assert(false, '')
+      expect(logger.warn).toHaveBeenCalledTimes(1)
+      assert(false, '')
+      expect(logger.warn).toHaveBeenCalledTimes(2)
+
+      setLogger(console)
+    })
+  })
 })

src/core/utils.ts

@@ -1,3 +1,4 @@
+import { getLogger } from './logger'
 import type { Mutation } from './mutation'
 import type { Query } from './query'
 import type {
@@ -74,6 +75,15 @@ export function noop(): undefined {
   return undefined
 }
 
+/**
+ * Raise a dev warning message when the condition is not fulfilled
+ */
+export function assert(condition: boolean, message: string): void {
+  if (process.env.NODE_ENV !== 'production' && !condition) {
+    getLogger().warn(message)
+  }
+}
+
 export function functionalUpdate<TInput, TOutput>(
   updater: Updater<TInput, TOutput>,
   input: TInput