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

Stop batching polling query fetches. #4800

Merged
merged 1 commit into from
May 10, 2019
Merged
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
118 changes: 34 additions & 84 deletions packages/apollo-client/src/core/QueryManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1341,15 +1341,10 @@ export class QueryManager<TStore> {
// Map from client ID to { interval, options }.
private pollingInfoByQueryId = new Map<string, {
interval: number;
lastPollTimeMs: number;
timeout: NodeJS.Timeout;
options: WatchQueryOptions;
}>();

private nextPoll: {
time: number;
timeout: NodeJS.Timeout;
} | null = null;

public startPollingQuery(
options: WatchQueryOptions,
queryId: string,
Expand All @@ -1364,95 +1359,50 @@ export class QueryManager<TStore> {

// Do not poll in SSR mode
if (!this.ssrMode) {
this.pollingInfoByQueryId.set(queryId, {
interval: pollInterval!,
// Avoid polling until at least pollInterval milliseconds from now.
// The -10 is a fudge factor to help with tests that rely on simulated
// timeouts via jest.runTimersToTime.
lastPollTimeMs: Date.now() - 10,
options: {
...options,
fetchPolicy: 'network-only',
},
});
let info = this.pollingInfoByQueryId.get(queryId)!;
if (!info) {
this.pollingInfoByQueryId.set(queryId, (info = {} as any));
}

info.interval = pollInterval!;
info.options = {
...options,
fetchPolicy: 'network-only',
};

const maybeFetch = () => {
const info = this.pollingInfoByQueryId.get(queryId);
if (info) {
if (this.checkInFlight(queryId)) {
poll();
} else {
this.fetchQuery(queryId, info.options, FetchType.poll).then(
poll,
poll,
);
}
}
};

const poll = () => {
const info = this.pollingInfoByQueryId.get(queryId);
if (info) {
clearTimeout(info.timeout);
info.timeout = setTimeout(maybeFetch, info.interval);
}
};

if (listener) {
this.addQueryListener(queryId, listener);
}

this.schedulePoll(pollInterval!);
poll();
}

return queryId;
}

public stopPollingQuery(queryId: string) {
// Since the master polling interval dynamically adjusts to the contents of
// this.pollingInfoByQueryId, stopping a query from polling is as easy as
// removing it from the map.
this.pollingInfoByQueryId.delete(queryId);
}

// Calling this method ensures a poll will happen within the specified time
// limit, canceling any pending polls that would not happen in time.
private schedulePoll(timeLimitMs: number) {
const now = Date.now();

if (this.nextPoll) {
if (timeLimitMs < this.nextPoll.time - now) {
// The next poll will happen too far in the future, so cancel it, and
// fall through to scheduling a new timeout.
clearTimeout(this.nextPoll.timeout);
} else {
// The next poll will happen within timeLimitMs, so all is well.
return;
}
}

this.nextPoll = {
// Estimated time when the timeout will fire.
time: now + timeLimitMs,

timeout: setTimeout(() => {
this.nextPoll = null;
let nextTimeLimitMs = Infinity;

this.pollingInfoByQueryId.forEach((info, queryId) => {
// Pick next timeout according to current minimum interval.
if (info.interval < nextTimeLimitMs) {
nextTimeLimitMs = info.interval;
}

if (!this.checkInFlight(queryId)) {
// If this query was last polled more than interval milliseconds
// ago, poll it now. Note that there may be a small delay between
// the desired polling time and the actual polling time (equal to
// at most the minimum polling interval across all queries), but
// that's the tradeoff to batching polling intervals.
if (Date.now() - info.lastPollTimeMs >= info.interval) {
const updateLastPollTime = () => {
info.lastPollTimeMs = Date.now();
};
this.fetchQuery(queryId, info.options, FetchType.poll).then(
// Set info.lastPollTimeMs after the fetch completes, whether
// or not it succeeded. Promise.prototype.finally would be nice
// here, but we don't have a polyfill for that at the moment,
// and this code has historically silenced errors, which is not
// the behavior of .finally(updateLastPollTime).
updateLastPollTime,
updateLastPollTime
);
}
}
});

// If there were no entries in this.pollingInfoByQueryId, then
// nextTimeLimitMs will still be Infinity, so this.schedulePoll will
// not be called, thus ending the master polling interval.
if (isFinite(nextTimeLimitMs)) {
this.schedulePoll(nextTimeLimitMs);
}
}, timeLimitMs),
};
}
}