Skip to content

feature(angular-query): support providing QueryClient via InjectionToken #9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { TestBed } from '@angular/core/testing'
import { describe, expect, test } from 'vitest'
import {
InjectionToken,
provideExperimentalZonelessChangeDetection,
} from '@angular/core'
import { QueryClient } from '@tanstack/query-core'
import { provideQueryClient } from '../providers'

describe('provideQueryClient', () => {
test('should provide a QueryClient instance directly', () => {
const queryClient = new QueryClient()

TestBed.configureTestingModule({
providers: [
provideExperimentalZonelessChangeDetection(),
provideQueryClient(queryClient),
],
})

const providedQueryClient = TestBed.inject(QueryClient)
expect(providedQueryClient).toBe(queryClient)
})

test('should provide a QueryClient instance using an InjectionToken', () => {
const queryClient = new QueryClient()
const CUSTOM_QUERY_CLIENT = new InjectionToken<QueryClient>('', {
factory: () => queryClient,
})

TestBed.configureTestingModule({
providers: [
provideExperimentalZonelessChangeDetection(),
provideQueryClient(CUSTOM_QUERY_CLIENT),
],
})

const providedQueryClient = TestBed.inject(QueryClient)
expect(providedQueryClient).toBe(queryClient)
})
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { TestBed } from '@angular/core/testing'
import { describe, expect, test } from 'vitest'
import {
InjectionToken,
provideExperimentalZonelessChangeDetection,
} from '@angular/core'
import { QueryClient } from '@tanstack/query-core'
import { provideTanStackQuery } from '../providers'

describe('provideTanStackQuery', () => {
test('should provide a QueryClient instance directly', () => {
const queryClient = new QueryClient()

TestBed.configureTestingModule({
providers: [
provideExperimentalZonelessChangeDetection(),
provideTanStackQuery(queryClient),
],
})

const providedQueryClient = TestBed.inject(QueryClient)
expect(providedQueryClient).toBe(queryClient)
})

test('should provide a QueryClient instance using an InjectionToken', () => {
const queryClient = new QueryClient()
const CUSTOM_QUERY_CLIENT = new InjectionToken<QueryClient>('', {
factory: () => queryClient,
})

TestBed.configureTestingModule({
providers: [
provideExperimentalZonelessChangeDetection(),
provideTanStackQuery(CUSTOM_QUERY_CLIENT),
],
})

const providedQueryClient = TestBed.inject(QueryClient)
expect(providedQueryClient).toBe(queryClient)
})
})
35 changes: 25 additions & 10 deletions packages/angular-query-experimental/src/providers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {
DestroyRef,
ENVIRONMENT_INITIALIZER,
InjectionToken,
PLATFORM_ID,
computed,
effect,
Expand All @@ -25,10 +26,19 @@ import type {
* for the entire application. You can use `provideQueryClient` to provide a
* different `QueryClient` instance for a part of the application.
* @param queryClient - the `QueryClient` instance to provide.
* @public
* @returns a provider object that can be used to provide the `QueryClient` instance.
*/
export function provideQueryClient(queryClient: QueryClient) {
return { provide: QueryClient, useValue: queryClient }
export function provideQueryClient(
queryClient: QueryClient | InjectionToken<QueryClient>,
): Provider {
return {
provide: QueryClient,
useFactory: () => {
return queryClient instanceof InjectionToken
? inject(queryClient)
: queryClient
},
}
}

/**
Expand Down Expand Up @@ -83,15 +93,14 @@ export function provideQueryClient(queryClient: QueryClient) {
* }
* )
* ```
* @param queryClient - A `QueryClient` instance.
* @param queryClient - A `QueryClient` instance, or an `InjectionToken` which provides a `QueryClient`.
* @param features - Optional features to configure additional Query functionality.
* @returns A set of providers to set up TanStack Query.
* @public
* @see https://tanstack.com/query/v5/docs/framework/angular/quick-start
* @see withDevtools
*/
export function provideTanStackQuery(
queryClient: QueryClient,
queryClient: QueryClient | InjectionToken<QueryClient>,
...features: Array<QueryFeatures>
): EnvironmentProviders {
return makeEnvironmentProviders([
Expand All @@ -100,10 +109,16 @@ export function provideTanStackQuery(
// Do not use provideEnvironmentInitializer while Angular < v19 is supported
provide: ENVIRONMENT_INITIALIZER,
multi: true,
useValue: () => {
queryClient.mount()
// Unmount the query client on application destroy
inject(DestroyRef).onDestroy(() => queryClient.unmount())
useFactory: () => {
const client =
queryClient instanceof InjectionToken
? inject(queryClient)
: queryClient
return () => {
client.mount()
// Unmount the query client on application destroy
inject(DestroyRef).onDestroy(() => client.unmount())
}
},
},
features.map((feature) => feature.ɵproviders),
Expand Down
Loading