[2.0] Switch apollo-engine-reporting to use fetch instead of the Node request module #1274
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| import * as os from 'os'; | ||
| import { gzip } from 'zlib'; | ||
| import { DocumentNode } from 'graphql'; | ||
| import { | ||
| FullTracesReport, | ||
|
|
@@ -9,6 +8,9 @@ import { | |
| Trace, | ||
| } from 'apollo-engine-reporting-protobuf'; | ||
|
|
||
| import { fetch, Response } from 'apollo-server-env'; | ||
| import * as retry from 'async-retry'; | ||
|
|
||
| import { EngineReportingExtension } from './extension'; | ||
|
|
||
| // Override the generated protobuf Traces.encode function so that it will look | ||
|
|
@@ -170,101 +172,94 @@ export class EngineReportingAgent<TContext = any> { | |
| } | ||
| } | ||
|
|
||
| public async sendReport(): Promise<void> { | ||
| const report = this.report; | ||
| this.resetReport(); | ||
|
|
||
| if (Object.keys(report.tracesPerQuery).length === 0) { | ||
| return; | ||
| } | ||
|
|
||
| // Send traces asynchronously, so that (eg) addTrace inside a resolver | ||
| // doesn't block on it. | ||
| await Promise.resolve(); | ||
|
|
||
| if (this.options.debugPrintReports) { | ||
| // tslint:disable-next-line no-console | ||
| console.log(`Engine sending report: ${JSON.stringify(report.toJSON())}`); | ||
| } | ||
|
|
||
| const protobufError = FullTracesReport.verify(report); | ||
| if (protobufError) { | ||
| throw new Error(`Error encoding report: ${protobufError}`); | ||
| } | ||
| const message = FullTracesReport.encode(report).finish(); | ||
|
|
||
| const compressed = await new Promise<Buffer>((resolve, reject) => { | ||
| // The protobuf library gives us a Uint8Array. Node 8's zlib lets us | ||
| // pass it directly; convert for the sake of Node 6. (No support right | ||
| // now for Node 4, which lacks Buffer.from.) | ||
| const messageBuffer = Buffer.from( | ||
| message.buffer as ArrayBuffer, | ||
| message.byteOffset, | ||
| message.byteLength, | ||
| ); | ||
| gzip(messageBuffer, (err, compressed) => { | ||
| if (err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(compressed); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| const endpointUrl = | ||
| (this.options.endpointUrl || 'https://engine-report.apollodata.com') + | ||
| '/api/ingress/traces'; | ||
|
|
||
| // Wrap fetch with async-retry for automatic retrying | ||
| const response: Response = await retry( | ||
| // Retry on network errors and 5xx HTTP | ||
| // responses. | ||
| async () => { | ||
| const response = await fetch(endpointUrl, { | ||
| method: 'POST', | ||
| headers: { | ||
| 'user-agent': 'apollo-engine-reporting', | ||
| 'x-api-key': this.apiKey, | ||
| 'content-encoding': 'gzip', | ||
| }, | ||
| body: compressed, | ||
| }); | ||
|
|
||
| if (response.status >= 500 && response.status < 600) { | ||
| throw new Error(`${response.status}: ${response.statusText}`); | ||
| } else { | ||
| return response; | ||
| } | ||
| }, | ||
| { | ||
| retries: this.options.maxAttempts || 5, | ||
|
There was a problem hiding this comment. I assume this change which passes a "max attempts" (inclusive of first attempt) number to a "retries" (exclusive of first attempt) parameter was unintentional. See #3218. |
||
| minTimeout: this.options.minimumRetryDelayMs || 100, | ||
| factor: 2, | ||
| }, | ||
| ).catch((err: Error) => { | ||
| throw new Error(`Error sending report to Engine servers: ${err}`); | ||
| }); | ||
|
|
||
| if (response.status < 200 || response.status >= 300) { | ||
| // Note that we don't expect to see a 3xx here because request follows | ||
| // redirects. | ||
| throw new Error( | ||
| `Error sending report to Engine servers (HTTP status ${ | ||
| response.status | ||
| }): ${await response.text()}`, | ||
| ); | ||
| } | ||
| if (this.options.debugPrintReports) { | ||
| // tslint:disable-next-line no-console | ||
| console.log(`Engine report: status ${response.status}`); | ||
| } | ||
| } | ||
|
|
||
| // Stop prevents reports from being sent automatically due to time or buffer | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,5 +15,5 @@ | |
| }, | ||
| "include": ["src/**/*"], | ||
| "exclude": ["node_modules", "**/__tests__/*", "**/__mocks__/*"], | ||
| "types": [] | ||
| } | ||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume this change from body to statusText (which leaves out the response body which we do craft in the server to be read by humans in logs) was unintentional. See #3218.