feat(vue-query): support injectable contexts (#5886)

* feat(vue-query): support injectable contexts This feature requires Vue 3.3.0, which has been out for a while now. It allows using vue-query APIs in places where it is valid to use them but currently throws an error. - `hasInjectionContext()`: vuejs/core#8111 - `app.runWithContext()`: vuejs/core#7451 * refactor: add dev warning for effectScope * fix: add memory leak warnings, fix tests * chore: bump vue-demi * chore: bump vue version in integrations --------- Co-authored-by: Damian Osipiuk <[email protected]>
TanStack · Aug 30, 2023 · a0fae50 · a0fae50
1 parent a496b3d
commit a0fae50
Show file tree

Hide file tree

Showing 16 changed files with 581 additions and 243 deletions.
diff --git a/examples/vue/basic/package.json b/examples/vue/basic/package.json
@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@tanstack/vue-query": "^5.0.0-beta.0",
-    "vue": "^3.2.47"
+    "vue": "^3.3.0"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^4.2.3",

diff --git a/examples/vue/dependent-queries/package.json b/examples/vue/dependent-queries/package.json
@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@tanstack/vue-query": "^5.0.0-beta.0",
-    "vue": "^3.2.47"
+    "vue": "^3.3.0"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^4.2.3",

diff --git a/examples/vue/persister/package.json b/examples/vue/persister/package.json
@@ -11,7 +11,7 @@
     "@tanstack/query-persist-client-core": "^5.0.0-beta.0",
     "@tanstack/query-sync-storage-persister": "^5.0.0-beta.0",
     "@tanstack/vue-query": "^5.0.0-beta.0",
-    "vue": "^3.2.47"
+    "vue": "^3.3.0"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^4.2.3",

diff --git a/integrations/vue-vite/package.json b/integrations/vue-vite/package.json
@@ -8,7 +8,7 @@
   "dependencies": {
     "@tanstack/vue-query": "workspace:*",
     "@vitejs/plugin-vue": "^4.2.3",
-    "vue": "^3.2.47",
+    "vue": "^3.3.0",
     "vite": "^4.4.4"
   }
 }
diff --git a/package.json b/package.json
@@ -83,11 +83,12 @@
     "solid-js": "^1.7.8",
     "stream-to-array": "^2.3.0",
     "tsup": "^7.1.0",
+    "ts-node": "^10.7.0",
     "type-fest": "^3.13.0",
     "typescript": "^5.0.4",
     "vite": "^4.4.4",
     "vitest": "^0.33.0",
-    "vue": "^3.2.47"
+    "vue": "^3.3.0"
   },
   "pnpm": {
     "patchedDependencies": {

diff --git a/packages/vue-query/package.json b/packages/vue-query/package.json
@@ -61,17 +61,17 @@
     "@tanstack/match-sorter-utils": "^8.8.4",
     "@tanstack/query-core": "workspace:*",
     "@vue/devtools-api": "^6.5.0",
-    "vue-demi": "^0.13.11"
+    "vue-demi": "^0.14.6"
   },
   "devDependencies": {
-    "@vue/composition-api": "1.7.1",
-    "vue": "^3.2.47",
+    "@vue/composition-api": "1.7.2",
+    "vue": "^3.3.0",
     "vue2": "npm:[email protected]",
     "vue2.7": "npm:[email protected]"
   },
   "peerDependencies": {
     "@vue/composition-api": "^1.1.2",
-    "vue": "^2.5.0 || ^3.0.0"
+    "vue": "^2.6.0 || ^3.3.0"
   },
   "peerDependenciesMeta": {
     "@vue/composition-api": {

diff --git a/packages/vue-query/src/__tests__/useQueryClient.test.ts b/packages/vue-query/src/__tests__/useQueryClient.test.ts
@@ -1,12 +1,12 @@
-import { getCurrentInstance, inject } from 'vue-demi'
+import { hasInjectionContext, inject } from 'vue-demi'
 import { vi } from 'vitest'
 import { useQueryClient } from '../useQueryClient'
 import { VUE_QUERY_CLIENT } from '../utils'
 import type { Mock } from 'vitest'
 
 describe('useQueryClient', () => {
   const injectSpy = inject as Mock
-  const getCurrentInstanceSpy = getCurrentInstance as Mock
+  const hasInjectionContextSpy = hasInjectionContext as Mock
 
   beforeEach(() => {
     vi.restoreAllMocks()
@@ -32,10 +32,10 @@ describe('useQueryClient', () => {
   })
 
   test('should throw an error when used outside of setup function', () => {
-    getCurrentInstanceSpy.mockReturnValueOnce(undefined)
+    hasInjectionContextSpy.mockReturnValueOnce(false)
 
     expect(useQueryClient).toThrowError()
-    expect(getCurrentInstanceSpy).toHaveBeenCalledTimes(1)
+    expect(hasInjectionContextSpy).toHaveBeenCalledTimes(1)
   })
 
   test('should call inject with a custom key as a suffix', () => {

diff --git a/packages/vue-query/src/useBaseQuery.ts b/packages/vue-query/src/useBaseQuery.ts
@@ -1,5 +1,6 @@
 import {
   computed,
+  getCurrentScope,
   onScopeDispose,
   reactive,
   readonly,
@@ -64,6 +65,14 @@ export function useBaseQuery<
   >,
   queryClient?: QueryClient,
 ): UseBaseQueryReturnType<TData, TError> {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
+
   const client = queryClient || useQueryClient()
 
   const defaultedOptions = computed(() => {

diff --git a/packages/vue-query/src/useIsFetching.ts b/packages/vue-query/src/useIsFetching.ts
@@ -1,4 +1,4 @@
-import { onScopeDispose, ref, watchSyncEffect } from 'vue-demi'
+import { getCurrentScope, onScopeDispose, ref, watchSyncEffect } from 'vue-demi'
 import { useQueryClient } from './useQueryClient'
 import type { Ref } from 'vue-demi'
 import type { QueryFilters as QF } from '@tanstack/query-core'
@@ -11,6 +11,14 @@ export function useIsFetching(
   fetchingFilters: MaybeRefDeep<QF> = {},
   queryClient?: QueryClient,
 ): Ref<number> {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
+
   const client = queryClient || useQueryClient()
 
   const isFetching = ref()

diff --git a/packages/vue-query/src/useMutation.ts b/packages/vue-query/src/useMutation.ts
@@ -1,5 +1,6 @@
 import {
   computed,
+  getCurrentScope,
   onScopeDispose,
   reactive,
   readonly,
@@ -64,6 +65,14 @@ export function useMutation<
   >,
   queryClient?: QueryClient,
 ): UseMutationReturnType<TData, TError, TVariables, TContext> {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
+
   const client = queryClient || useQueryClient()
   const options = computed(() => {
     return client.defaultMutationOptions(cloneDeepUnref(mutationOptions))

diff --git a/packages/vue-query/src/useMutationState.ts b/packages/vue-query/src/useMutationState.ts
@@ -1,4 +1,11 @@
-import { computed, onScopeDispose, readonly, ref, watch } from 'vue-demi'
+import {
+  computed,
+  getCurrentScope,
+  onScopeDispose,
+  readonly,
+  ref,
+  watch,
+} from 'vue-demi'
 import { useQueryClient } from './useQueryClient'
 import { cloneDeepUnref } from './utils'
 import type { DeepReadonly, Ref } from 'vue-demi'
@@ -18,6 +25,14 @@ export function useIsMutating(
   filters: MutationFilters = {},
   queryClient?: QueryClient,
 ): Ref<number> {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
+
   const client = queryClient || useQueryClient()
   const unreffedFilters = computed(() => ({
     ...cloneDeepUnref(filters),

diff --git a/packages/vue-query/src/useQueries.ts b/packages/vue-query/src/useQueries.ts
@@ -1,6 +1,13 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { QueriesObserver } from '@tanstack/query-core'
-import { computed, onScopeDispose, readonly, ref, watch } from 'vue-demi'
+import {
+  computed,
+  getCurrentScope,
+  onScopeDispose,
+  readonly,
+  ref,
+  watch,
+} from 'vue-demi'
 
 import { useQueryClient } from './useQueryClient'
 import { cloneDeepUnref } from './utils'
@@ -167,6 +174,14 @@ export function useQueries<
   },
   queryClient?: QueryClient,
 ): Readonly<Ref<TCombinedResult>> {
+  if (process.env.NODE_ENV === 'development') {
+    if (!getCurrentScope()) {
+      console.warn(
+        'vue-query composables like "uesQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
+      )
+    }
+  }
+
   const client = queryClient || useQueryClient()
 
   const defaultedQueries = computed(() =>

diff --git a/packages/vue-query/src/useQueryClient.ts b/packages/vue-query/src/useQueryClient.ts
@@ -1,13 +1,14 @@
-import { getCurrentInstance, inject } from 'vue-demi'
+import { hasInjectionContext, inject } from 'vue-demi'
 
 import { getClientKey } from './utils'
 import type { QueryClient } from './queryClient'
 
 export function useQueryClient(id = ''): QueryClient {
-  const vm = getCurrentInstance()?.proxy
-
-  if (!vm) {
-    throw new Error('vue-query hooks can only be used inside setup() function.')
+  // ensures that `inject()` can be used
+  if (!hasInjectionContext()) {
+    throw new Error(
+      'vue-query hooks can only be used inside setup() function or functions that support injection context.',
+    )
   }
 
   const key = getClientKey(id)

diff --git a/packages/vue-query/test-setup.ts b/packages/vue-query/test-setup.ts
@@ -1,14 +1,5 @@
 import { vi } from 'vitest'
 
-import Vue from 'vue2'
-Vue.config.productionTip = false
-Vue.config.devtools = false
-
-// Hide annoying console warnings for Vue2
-import Vue27 from 'vue2.7'
-Vue27.config.productionTip = false
-Vue27.config.devtools = false
-
 vi.mock('vue-demi', async () => {
   const vue = await vi.importActual('vue-demi')
   return {
@@ -17,5 +8,6 @@ vi.mock('vue-demi', async () => {
     provide: vi.fn(),
     onScopeDispose: vi.fn(),
     getCurrentInstance: vi.fn(() => ({ proxy: {} })),
+    hasInjectionContext: vi.fn(() => true),
   }
 })
diff --git a/packages/vue-query/vitest.config.ts b/packages/vue-query/vitest.config.ts
@@ -9,5 +9,10 @@ export default defineConfig({
     globals: true,
     setupFiles: ['test-setup.ts'],
     coverage: { provider: 'istanbul' },
+    onConsoleLog: function (log) {
+      if (log.includes('Download the Vue Devtools extension')) {
+        return false
+      }
+    },
   },
 })