Skip to content
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

fix(core): make sure mutations get updated options #5085

Merged
merged 1 commit into from
Mar 6, 2023
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
18 changes: 12 additions & 6 deletions packages/query-core/src/mutation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,31 +89,37 @@ export class Mutation<
TContext = unknown,
> extends Removable {
state: MutationState<TData, TError, TVariables, TContext>
options: MutationOptions<TData, TError, TVariables, TContext>
options!: MutationOptions<TData, TError, TVariables, TContext>
mutationId: number

private observers: MutationObserver<TData, TError, TVariables, TContext>[]
private defaultOptions?: MutationOptions<TData, TError, TVariables, TContext>
private mutationCache: MutationCache
private logger: Logger
private retryer?: Retryer<TData>

constructor(config: MutationConfig<TData, TError, TVariables, TContext>) {
super()

this.options = {
...config.defaultOptions,
...config.options,
}
this.defaultOptions = config.defaultOptions
this.mutationId = config.mutationId
this.mutationCache = config.mutationCache
this.logger = config.logger || defaultLogger
this.observers = []
this.state = config.state || getDefaultState()

this.updateCacheTime(this.options.cacheTime)
this.setOptions(config.options)
this.scheduleGc()
}

setOptions(
options?: MutationOptions<TData, TError, TVariables, TContext>,
): void {
this.options = { ...this.defaultOptions, ...options }

this.updateCacheTime(this.options.cacheTime)
}

get meta(): MutationMeta | undefined {
return this.options.meta
}
Expand Down
1 change: 1 addition & 0 deletions packages/query-core/src/mutationObserver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export class MutationObserver<
observer: this,
})
}
this.currentMutation?.setOptions(this.options)
}

protected onUnsubscribe(): void {
Expand Down
31 changes: 31 additions & 0 deletions packages/query-core/src/tests/mutations.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import type { QueryClient } from '..'
import { createQueryClient, executeMutation, queryKey, sleep } from './utils'
import type { MutationState } from '../mutation'
import { MutationObserver } from '../mutationObserver'
import { waitFor } from '@testing-library/react'

describe('mutations', () => {
let queryClient: QueryClient
Expand Down Expand Up @@ -358,4 +359,34 @@ describe('mutations', () => {
expect(onSuccess).not.toHaveBeenCalled()
expect(onSettled).not.toHaveBeenCalled()
})

test('mutation callbacks should see updated options', async () => {
const onSuccess = jest.fn()

const mutation = new MutationObserver(queryClient, {
mutationFn: async () => {
sleep(100)
return 'update'
},
onSuccess: () => {
onSuccess(1)
},
})

void mutation.mutate()

mutation.setOptions({
mutationFn: async () => {
sleep(100)
return 'update'
},
onSuccess: () => {
onSuccess(2)
},
})

await waitFor(() => expect(onSuccess).toHaveBeenCalledTimes(1))

expect(onSuccess).toHaveBeenCalledWith(2)
})
})