Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: pretty print Contentful errors after all retry attempts failed
- Loading branch information
Showing
3 changed files
with
290 additions
and
29 deletions.
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
219 changes: 219 additions & 0 deletions
219
packages/gatsby-source-contentful/src/__tests__/fetch-network-errors.js
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 |
|---|---|---|
| @@ -0,0 +1,219 @@ | ||
| /** | ||
| * @jest-environment node | ||
| */ | ||
|
|
||
| import nock from "nock" | ||
| import fetchData from "../fetch" | ||
| import { createPluginConfig } from "../plugin-options" | ||
|
|
||
| nock.disableNetConnect() | ||
|
|
||
| const host = `localhost` | ||
| const options = { | ||
| spaceId: `12345`, | ||
| accessToken: `67890`, | ||
| host, | ||
| contentfulClientConfig: { | ||
| retryLimit: 2, | ||
| }, | ||
| } | ||
| const baseURI = `https://${host}` | ||
|
|
||
| const start = jest.fn() | ||
| const end = jest.fn() | ||
| const mockActivity = { | ||
| start, | ||
| end, | ||
| tick: jest.fn(), | ||
| done: end, | ||
| } | ||
|
|
||
| const reporter = { | ||
| info: jest.fn(), | ||
| verbose: jest.fn(), | ||
| panic: jest.fn(e => { | ||
| throw e | ||
| }), | ||
| activityTimer: jest.fn(() => mockActivity), | ||
| createProgress: jest.fn(() => mockActivity), | ||
| } | ||
|
|
||
| const pluginConfig = createPluginConfig(options) | ||
|
|
||
| describe(`fetch-retry`, () => { | ||
| afterEach(() => { | ||
| nock.cleanAll() | ||
| reporter.verbose.mockClear() | ||
| reporter.panic.mockClear() | ||
| }) | ||
|
|
||
| test(`request retries when network timeout happens`, async () => { | ||
| const scope = nock(baseURI) | ||
| // Space | ||
| .get(`/spaces/${options.spaceId}/`) | ||
| .reply(200, { items: [] }) | ||
| // Locales | ||
| .get(`/spaces/${options.spaceId}/environments/master/locales`) | ||
| .reply(200, { items: [{ code: `en`, default: true }] }) | ||
| // Sync | ||
| .get( | ||
| `/spaces/${options.spaceId}/environments/master/sync?initial=true&limit=100` | ||
| ) | ||
| .times(1) | ||
| .replyWithError({ code: `ETIMEDOUT` }) | ||
| .get( | ||
| `/spaces/${options.spaceId}/environments/master/sync?initial=true&limit=100` | ||
| ) | ||
| .reply(200, { items: [] }) | ||
| // Content types | ||
| .get( | ||
| `/spaces/${options.spaceId}/environments/master/content_types?skip=0&limit=100&order=sys.createdAt` | ||
| ) | ||
| .reply(200, { items: [] }) | ||
|
|
||
| await fetchData({ pluginConfig, reporter }) | ||
|
|
||
| expect(reporter.panic).not.toBeCalled() | ||
| expect(scope.isDone()).toBeTruthy() | ||
| }) | ||
|
|
||
| test(`request should fail after to many retries`, async () => { | ||
| // Due to the retries, this can take up to 10 seconds | ||
| jest.setTimeout(10000) | ||
|
|
||
| const scope = nock(baseURI) | ||
| // Space | ||
| .get(`/spaces/${options.spaceId}/`) | ||
| .reply(200, { items: [] }) | ||
| // Locales | ||
| .get(`/spaces/${options.spaceId}/environments/master/locales`) | ||
| .reply(200, { items: [{ code: `en`, default: true }] }) | ||
| // Sync | ||
| .get( | ||
| `/spaces/${options.spaceId}/environments/master/sync?initial=true&limit=100` | ||
| ) | ||
| .times(3) | ||
| .reply( | ||
| 500, | ||
| { | ||
| sys: { | ||
| type: `Error`, | ||
| id: `MockedContentfulError`, | ||
| }, | ||
| message: `Mocked message of Contentful error`, | ||
| }, | ||
| { [`x-contentful-request-id`]: `123abc` } | ||
| ) | ||
|
|
||
| try { | ||
| await fetchData({ pluginConfig, reporter }) | ||
| jest.fail() | ||
| } catch (e) { | ||
| const msg = expect(e.context.sourceMessage) | ||
| msg.toEqual( | ||
| expect.stringContaining( | ||
| `Fetching contentful data failed: 500 MockedContentfulError` | ||
| ) | ||
| ) | ||
| msg.toEqual(expect.stringContaining(`Request ID: 123abc`)) | ||
| msg.toEqual( | ||
| expect.stringContaining(`The request was sent with 3 attempts`) | ||
| ) | ||
| } | ||
| expect(reporter.panic).toBeCalled() | ||
| expect(scope.isDone()).toBeTruthy() | ||
| }) | ||
| }) | ||
|
|
||
| describe(`fetch-network-errors`, () => { | ||
| test(`catches plain network error`, async () => { | ||
| const scope = nock(baseURI) | ||
| // Space | ||
| .get(`/spaces/${options.spaceId}/`) | ||
| .replyWithError({ code: `ECONNRESET` }) | ||
| try { | ||
| await fetchData({ | ||
| pluginConfig: createPluginConfig({ | ||
| ...options, | ||
| contentfulClientConfig: { retryOnError: false }, | ||
| }), | ||
| reporter, | ||
| }) | ||
| jest.fail() | ||
| } catch (e) { | ||
| expect(e.context.sourceMessage).toEqual( | ||
| expect.stringContaining( | ||
| `Accessing your Contentful space failed: ECONNRESET` | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| expect(reporter.panic).toBeCalled() | ||
| expect(scope.isDone()).toBeTruthy() | ||
| }) | ||
|
|
||
| test(`catches error with response string`, async () => { | ||
| const scope = nock(baseURI) | ||
| // Space | ||
| .get(`/spaces/${options.spaceId}/`) | ||
| .reply(502, `Bad Gateway`) | ||
|
|
||
| try { | ||
| await fetchData({ | ||
| pluginConfig: createPluginConfig({ | ||
| ...options, | ||
| contentfulClientConfig: { retryOnError: false }, | ||
| }), | ||
| reporter, | ||
| }) | ||
| jest.fail() | ||
| } catch (e) { | ||
| expect(e.context.sourceMessage).toEqual( | ||
| expect.stringContaining( | ||
| `Accessing your Contentful space failed: Bad Gateway` | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| expect(reporter.panic).toBeCalled() | ||
| expect(scope.isDone()).toBeTruthy() | ||
| }) | ||
|
|
||
| test(`catches error with response object`, async () => { | ||
| const scope = nock(baseURI) | ||
| // Space | ||
| .get(`/spaces/${options.spaceId}/`) | ||
| .reply(429, { | ||
| sys: { | ||
| type: `Error`, | ||
| id: `MockedContentfulError`, | ||
| }, | ||
| message: `Mocked message of Contentful error`, | ||
| requestId: `123abc`, | ||
| }) | ||
|
|
||
| try { | ||
| await fetchData({ | ||
| pluginConfig: createPluginConfig({ | ||
| ...options, | ||
| contentfulClientConfig: { retryOnError: false }, | ||
| }), | ||
| reporter, | ||
| }) | ||
| jest.fail() | ||
| } catch (e) { | ||
| const msg = expect(e.context.sourceMessage) | ||
|
|
||
| msg.toEqual( | ||
| expect.stringContaining( | ||
| `Accessing your Contentful space failed: MockedContentfulError` | ||
| ) | ||
| ) | ||
| msg.toEqual(expect.stringContaining(`Mocked message of Contentful error`)) | ||
| msg.toEqual(expect.stringContaining(`Request ID: 123abc`)) | ||
| } | ||
|
|
||
| expect(reporter.panic).toBeCalled() | ||
| expect(scope.isDone()).toBeTruthy() | ||
| }) | ||
| }) |
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