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

react: MutationResult.client is always set #6617

Merged
merged 2 commits into from
Jul 20, 2020
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@
- Tolerate `!==` callback functions (like `onCompleted` and `onError`) in `useQuery` options, since those functions are almost always freshly evaluated each time `useQuery` is called. <br/>
[@hwillson](https://github.com/hwillson) and [@benjamn](https://github.com/benjamn) in [#6588](https://github.com/apollographql/apollo-client/pull/6588)

## Improvements

- Make the `client` field of the `MutationResult` type non-optional, since it is always provided. <br/>
[@glasser](https://github.com/glasser) in [#6617](https://github.com/apollographql/apollo-client/pull/6617)

## Apollo Client 3.0.2

## Bug Fixes
Expand Down
18 changes: 10 additions & 8 deletions src/react/data/MutationData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,22 @@ import {
MutationDataOptions,
MutationTuple,
MutationFunctionOptions,
MutationResult
MutationResult,
} from '../types/types';
import { OperationData } from './OperationData';
import { OperationVariables } from '../../core';
import { FetchResult } from '../../link/core';

type MutationResultWithoutClient<TData = any> = Omit<MutationResult<TData>, 'client'>;

export class MutationData<
TData = any,
TVariables = OperationVariables
> extends OperationData {
private mostRecentMutationId: number;
private result: MutationResult<TData>;
private previousResult?: MutationResult<TData>;
private setResult: (result: MutationResult<TData>) => any;
private result: MutationResultWithoutClient<TData>;
private previousResult?: MutationResultWithoutClient<TData>;
private setResult: (result: MutationResultWithoutClient<TData>) => any;

constructor({
options,
Expand All @@ -29,8 +31,8 @@ export class MutationData<
}: {
options: MutationDataOptions<TData, TVariables>;
context: any;
result: MutationResult<TData>;
setResult: (result: MutationResult<TData>) => any;
result: MutationResultWithoutClient<TData>;
setResult: (result: MutationResultWithoutClient<TData>) => any;
}) {
super(options, context);
this.verifyDocumentType(options.mutation, DocumentType.Mutation);
Expand All @@ -39,7 +41,7 @@ export class MutationData<
this.mostRecentMutationId = 0;
}

public execute(result: MutationResult<TData>) {
public execute(result: MutationResultWithoutClient<TData>): MutationTuple<TData, TVariables> {
this.isMounted = true;
this.verifyDocumentType(this.getOptions().mutation, DocumentType.Mutation);
return [
Expand Down Expand Up @@ -148,7 +150,7 @@ export class MutationData<
return this.mostRecentMutationId === mutationId;
}

private updateResult(result: MutationResult<TData>) {
private updateResult(result: MutationResultWithoutClient<TData>) {
if (
this.isMounted &&
(!this.previousResult || !equal(this.previousResult, result))
Expand Down
2 changes: 1 addition & 1 deletion src/react/types/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ export interface MutationResult<TData = any> {
error?: ApolloError;
loading: boolean;
called: boolean;
client?: ApolloClient<object>;
client: ApolloClient<object>;
}

export declare type MutationFunction<
Expand Down