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.

Sign up for GitHub

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

Return undefined for result.data if no data is available #4356

Merged
merged 5 commits into from
Jan 31, 2019
Merged

Return undefined for result.data if no data is available #4356

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1e79902
Tightened QueryManager getCurrentQueryResult typings
danilobuerger Jan 26, 2019
58232db
Added ObservableQuery getCurrentResult and deprecated currentResult
danilobuerger Jan 26, 2019
397139e
Use getCurrentResult instead of currentResult everywhere
danilobuerger Jan 26, 2019
ef46211
Merge branch 'master' into undefined
hwillson Jan 31, 2019
aaa9b92
Changelog update
hwillson Jan 31, 2019
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
Prev Previous commit
Next Next commit
Use getCurrentResult instead of currentResult everywhere
  • Loading branch information
@danilobuerger
danilobuerger committed Jan 26, 2019
commit 397139e97029eebefa6b34dfadae5e2e12173421
4 changes: 3 additions & 1 deletion packages/apollo-client/src/__tests__/ApolloClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1136,7 +1136,9 @@ describe('ApolloClient', () => {
count++;
if (count === 1) {
expect(stripSymbols(result.data)).toEqual(data);
expect(stripSymbols(observable.currentResult().data)).toEqual(data);
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
data,
);
const bestFriends = result.data.people.friends.filter(
x => x.type === 'best',
);
Expand Down
83 changes: 45 additions & 38 deletions packages/apollo-client/src/core/__tests__/ObservableQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ import mockQueryManager from '../../__mocks__/mockQueryManager';
import mockWatchQuery from '../../__mocks__/mockWatchQuery';
import { mockSingleLink } from '../../__mocks__/mockLinks';

import { ObservableQuery, ApolloCurrentResult } from '../ObservableQuery';
import { ObservableQuery } from '../ObservableQuery';
import { NetworkStatus } from '../networkStatus';
import { ApolloQueryResult, FetchType } from '../types';
import { QueryManager } from '../QueryManager';
import { DataStore } from '../../data/store';
import ApolloClient from '../../';
Expand Down Expand Up @@ -321,9 +320,9 @@ describe('ObservableQuery', () => {
expect(stripSymbols(result.data)).toEqual(data2);
// go back to first set of variables
observable.setOptions({ variables });
const current = observable.currentResult();
const current = observable.getCurrentResult();
expect(stripSymbols(current.data)).toEqual(data);
const secondCurrent = observable.currentResult();
const secondCurrent = observable.getCurrentResult();
expect(current.data).toEqual(secondCurrent.data);
done();
}
Expand Down Expand Up @@ -714,20 +713,20 @@ describe('ObservableQuery', () => {
subscribeAndCount(done, observable, (handleCount, result) => {
if (handleCount === 1) {
expect(stripSymbols(result.data)).toEqual(dataOne);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
dataOne,
);
observable.setVariables(differentVariables);
expect(stripSymbols(observable.currentResult().data)).toEqual({});
expect(observable.currentResult().loading).toBe(true);
expect(observable.getCurrentResult().data).toEqual(undefined);
expect(observable.getCurrentResult().loading).toBe(true);
}
// after loading is false and data has returned
if (handleCount === 3) {
expect(stripSymbols(result.data)).toEqual(dataTwo);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
dataTwo,
);
expect(observable.currentResult().loading).toBe(false);
expect(observable.getCurrentResult().loading).toBe(false);
done();
}
});
Expand Down Expand Up @@ -781,20 +780,20 @@ describe('ObservableQuery', () => {
subscribeAndCount(done, observable, (handleCount, result) => {
if (handleCount === 1) {
expect(stripSymbols(result.data)).toEqual(dataOne);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
dataOne,
);
observable.setVariables(differentVariables);
expect(observable.currentResult().data).toEqual({});
expect(observable.currentResult().loading).toBe(true);
expect(observable.getCurrentResult().data).toEqual(undefined);
expect(observable.getCurrentResult().loading).toBe(true);
}
// after loading is false and data has returned
if (handleCount === 3) {
expect(stripSymbols(result.data)).toEqual(dataTwo);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
dataTwo,
);
expect(observable.currentResult().loading).toBe(false);
expect(observable.getCurrentResult().loading).toBe(false);
done();
}
});
Expand Down Expand Up @@ -848,20 +847,20 @@ describe('ObservableQuery', () => {
subscribeAndCount(done, observable, (handleCount, result) => {
if (handleCount === 1) {
expect(stripSymbols(result.data)).toEqual(dataOne);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
dataOne,
);
observable.setVariables(differentVariables);
expect(observable.currentResult().data).toEqual({});
expect(observable.currentResult().loading).toBe(true);
expect(observable.getCurrentResult().data).toEqual(undefined);
expect(observable.getCurrentResult().loading).toBe(true);
}
// after loading is false and data has returned
if (handleCount === 3) {
expect(stripSymbols(result.data)).toEqual(dataTwo);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
dataTwo,
);
expect(observable.currentResult().loading).toBe(false);
expect(observable.getCurrentResult().loading).toBe(false);
done();
}
});
Expand All @@ -888,17 +887,17 @@ describe('ObservableQuery', () => {
subscribeAndCount(done, observable, (handleCount, result) => {
if (handleCount === 1) {
expect(result.errors).toEqual([error]);
expect(observable.currentResult().errors).toEqual([error]);
expect(observable.getCurrentResult().errors).toEqual([error]);
observable.setVariables(differentVariables);
expect(observable.currentResult().errors).toEqual([error]);
expect(observable.getCurrentResult().errors).toEqual([error]);
}
// after loading is done and new results are returned
if (handleCount === 3) {
expect(stripSymbols(result.data)).toEqual(dataTwo);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
dataTwo,
);
expect(observable.currentResult().loading).toBe(false);
expect(observable.getCurrentResult().loading).toBe(false);
done();
}
});
Expand Down Expand Up @@ -1387,7 +1386,7 @@ describe('ObservableQuery', () => {
});

subscribeAndCount(done, observable, (count, result) => {
const { data, loading, networkStatus } = observable.currentResult();
const { data, loading, networkStatus } = observable.getCurrentResult();
try {
expect(result).toEqual({
data,
Expand Down Expand Up @@ -1419,7 +1418,7 @@ describe('ObservableQuery', () => {
});

subscribeAndCount(done, observable, () => {
expect(stripSymbols(observable.currentResult())).toEqual({
expect(stripSymbols(observable.getCurrentResult())).toEqual({
data: dataOne,
loading: false,
networkStatus: 7,
Expand All @@ -1428,17 +1427,17 @@ describe('ObservableQuery', () => {
done();
});

expect(observable.currentResult()).toEqual({
expect(observable.getCurrentResult()).toEqual({
loading: true,
data: {},
data: undefined,
networkStatus: 1,
partial: true,
});
setTimeout(
wrap(done, () => {
expect(observable.currentResult()).toEqual({
expect(observable.getCurrentResult()).toEqual({
loading: true,
data: {},
data: undefined,
networkStatus: 1,
partial: true,
});
Expand All @@ -1464,7 +1463,7 @@ describe('ObservableQuery', () => {
query,
variables,
});
expect(stripSymbols(observable.currentResult())).toEqual({
expect(stripSymbols(observable.getCurrentResult())).toEqual({
data: dataOne,
loading: false,
networkStatus: 7,
Expand All @@ -1488,7 +1487,7 @@ describe('ObservableQuery', () => {
error: theError => {
expect(theError.graphQLErrors).toEqual([error]);

const currentResult = observable.currentResult();
const currentResult = observable.getCurrentResult();
expect(currentResult.loading).toBe(false);
expect(currentResult.error!.graphQLErrors).toEqual([error]);
done();
Expand All @@ -1510,10 +1509,10 @@ describe('ObservableQuery', () => {
return observable.result().catch((theError: any) => {
expect(theError.graphQLErrors).toEqual([error]);

const currentResult = observable.currentResult();
const currentResult = observable.getCurrentResult();
expect(currentResult.loading).toBe(false);
expect(currentResult.error!.graphQLErrors).toEqual([error]);
const currentResult2 = observable.currentResult();
const currentResult2 = observable.getCurrentResult();
expect(currentResult.error === currentResult2.error).toBe(true);
});
});
Expand All @@ -1533,7 +1532,7 @@ describe('ObservableQuery', () => {
return observable.result().then(result => {
expect(stripSymbols(result.data)).toEqual(dataOne);
expect(result.errors).toEqual([error]);
const currentResult = observable.currentResult();
const currentResult = observable.getCurrentResult();
expect(currentResult.loading).toBe(false);
expect(currentResult.errors).toEqual([error]);
expect(currentResult.error).toBeUndefined();
Expand All @@ -1555,7 +1554,7 @@ describe('ObservableQuery', () => {
return observable.result().then(result => {
expect(stripSymbols(result.data)).toEqual(dataOne);
expect(result.errors).toBeUndefined();
const currentResult = observable.currentResult();
const currentResult = observable.getCurrentResult();
expect(currentResult.loading).toBe(false);
expect(currentResult.errors).toBeUndefined();
expect(currentResult.error).toBeUndefined();
Expand All @@ -1580,15 +1579,19 @@ describe('ObservableQuery', () => {
variables,
fetchPolicy: 'network-only',
});
expect(stripSymbols(observable.currentResult())).toEqual({
expect(stripSymbols(observable.getCurrentResult())).toEqual({
data: dataOne,
loading: true,
networkStatus: 1,
partial: false,
});

subscribeAndCount(done, observable, (handleCount, subResult) => {
const { data, loading, networkStatus } = observable.currentResult();
const {
data,
loading,
networkStatus,
} = observable.getCurrentResult();
expect(subResult).toEqual({
data,
loading,
Expand Down Expand Up @@ -1650,7 +1653,11 @@ describe('ObservableQuery', () => {
});

subscribeAndCount(done, observable, (count, result) => {
const { data, loading, networkStatus } = observable.currentResult();
const {
data,
loading,
networkStatus,
} = observable.getCurrentResult();
expect(result).toEqual({
data,
loading,
Expand Down
12 changes: 6 additions & 6 deletions packages/apollo-client/src/core/__tests__/QueryManager/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -852,7 +852,7 @@ describe('QueryManager', () => {
try {
expect(stripSymbols(result.data)).toEqual(data1);
expect(stripSymbols(result.data)).toEqual(
stripSymbols(observable.currentResult().data),
stripSymbols(observable.getCurrentResult().data),
);
done();
} catch (error) {
Expand Down Expand Up @@ -1235,7 +1235,7 @@ describe('QueryManager', () => {
observable.subscribe({
next: result => {
expect(stripSymbols(result.data)).toEqual(data);
expect(stripSymbols(observable.currentResult().data)).toEqual(data);
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(data);
done();
},
});
Expand Down Expand Up @@ -2401,7 +2401,7 @@ describe('QueryManager', () => {
partial: false,
});
expect(queryManager.getCurrentQueryResult(observableB)).toEqual({
data: {},
data: undefined,
partial: true,
});
}),
Expand Down Expand Up @@ -4042,7 +4042,7 @@ describe('QueryManager', () => {
queryManager.mutate({ mutation, refetchQueries: ['getAuthors'] });
},
result => {
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
secondReqData,
);
expect(stripSymbols(result.data)).toEqual(secondReqData);
Expand Down Expand Up @@ -4253,7 +4253,7 @@ describe('QueryManager', () => {
}
if (count === 1) {
setTimeout(() => {
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
secondReqData,
);
done();
Expand Down Expand Up @@ -4649,7 +4649,7 @@ describe('QueryManager', () => {
} else {
expect(mutationComplete).toBeTruthy();
}
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
secondReqData,
);
expect(stripSymbols(result.data)).toEqual(secondReqData);
Expand Down
4 changes: 2 additions & 2 deletions packages/apollo-client/src/core/__tests__/QueryManager/recycler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ describe('Subscription lifecycles', () => {
if (count === 2) {
expect(result.loading).toBe(false);
expect(stripSymbols(result.data)).toEqual(initialData);
expect(stripSymbols(observable.currentResult().data)).toEqual(
expect(stripSymbols(observable.getCurrentResult().data)).toEqual(
initialData,
);

Expand All @@ -101,7 +101,7 @@ describe('Subscription lifecycles', () => {
setTimeout(() => {
// step 4, start new Subscription;
const recyled = resubscribe();
const currentResult = recyled.currentResult();
const currentResult = recyled.getCurrentResult();
expect(recyled.isTornDown).toEqual(false);
expect(stripSymbols(currentResult.data)).toEqual(initialData);
done();
Expand Down