Add timeout when making requests to Uplink #1950
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's an internal function, it's OK to make it newly required
- Use `onRetry` synchronously - Set a `maxTimeout` since the current default is `Infinity` - Remove `earliestFetchTime` because it wasn't doing what we thought and it's not super helpful in a datetime format when we already have a similar notion as an absolute delay in ms. - Add logging
✅ Deploy Preview for apollo-federation-docs canceled.
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
It makes types show up better in my editor
I don't think we want to give this power to everyone
Our `FetcherRequestInit` type doesn't include `timeout` (though most implementations support that). There's also `signal` that `node-fetch` supports and is in the `minipass-fetch` API (the library the underlies `make-fetch-happen`), but the types aren't updated correctly. Rather than dealing with either of these things directly, I'm just adding locally for now. In general, we may not want to allow users to pass in a custom fetcher for Uplink anyway.
Trying to keep the number of random exports we have down, so exposing default uplink info via the `UplinkSupergraphManager` class makes most sense
- Consolidate `fallbackPollIntervalMs` and `minDelayMs` into `pollIntervalMs` in `UplinkSupergraphManager` - Set `pollIntervalMs` in `updateSupergraphSdl`, since that's needed both during init and during polling - Moved checking `pollIntervalMs` out of the main gateway code so that more Uplink logic can live in `UplinkSupergraphManager`
Add `AbortableFetcher` and its ilk to support a `Fetcher` that also has a `signal` field, which is used implement the timeout pattern in standard web `fetch`. This also adds a `requestTimeout` property to `UplinkSupergraphManager`, though I didn't expose it in the constructor because I'm not sure if that's a knob we want to expose yet.
benweatherman
changed the title
pcmanus
reviewed
Jul 19, 2022
pcmanus
approved these changes
Jul 19, 2022
We can technically still set property values, but TS will complain. We can abuse that functionality to make our tests behave like we want. This is better than special-casing the value so users don't accidentally get lower values in their test environments.
I think we'll get less test cross-talk this way
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a series of changes that will hopefully fix or shed light on why we've gotten several reports of "gateway stops polling Uplink".
fallbackPollIntervalMsandearliestFetchDateintopollIntervalMsinUplinkSupergraphManager. This makes the code easier to follow, and simplifies where and how we setUplinkSupergraphManager.pollIntervalMs.async-retry.onRetryasynchronously because that function is called synchronously, and was resulting in some odd behavior.pollIntervalMsasminTimeout, so that defaults to 1000msmaxTimeoutto 60_000 ms so we'll never reach the default Infinity (maxRetrieswould have to be set very high to reach Infinity, but this is a safer option)node-retrylibrary to set time between retries.