[feature] custom retry callback #332
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
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,114 @@ | ||||||
| 'use strict' | ||||||
|
|
||||||
| const { test } = require('tap') | ||||||
| const Fastify = require('fastify') | ||||||
| const From = require('..') | ||||||
| const http = require('node:http') | ||||||
| const got = require('got') | ||||||
|
|
||||||
| function serverWithCustomError (stopAfter, statusCodeToFailOn) { | ||||||
| let requestCount = 0 | ||||||
| return http.createServer((req, res) => { | ||||||
| if (requestCount++ < stopAfter) { | ||||||
| res.statusCode = statusCodeToFailOn | ||||||
| res.setHeader('Content-Type', 'text/plain') | ||||||
| return res.end('This Service is Unavailable') | ||||||
| } else { | ||||||
| res.statusCode = 205 | ||||||
| res.setHeader('Content-Type', 'text/plain') | ||||||
| return res.end(`Hello World ${requestCount}!`) | ||||||
| } | ||||||
| }) | ||||||
| } | ||||||
|
|
||||||
| async function setupServer (t, fromOptions = {}, statusCodeToFailOn = 500, stopAfter = 4) { | ||||||
| const target = serverWithCustomError(stopAfter, statusCodeToFailOn) | ||||||
| await target.listen({ port: 0 }) | ||||||
| t.teardown(target.close.bind(target)) | ||||||
|
|
||||||
| const instance = Fastify() | ||||||
| instance.register(From, { | ||||||
| base: `http://localhost:${target.address().port}` | ||||||
| }) | ||||||
|
|
||||||
| instance.get('/', (request, reply) => { | ||||||
| reply.from(`http://localhost:${target.address().port}`, fromOptions) | ||||||
| }) | ||||||
|
|
||||||
| t.teardown(instance.close.bind(instance)) | ||||||
| await instance.listen({ port: 0 }) | ||||||
|
|
||||||
| return { | ||||||
| instance | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| test('a 500 status code with no custom handler should fail', async (t) => { | ||||||
| const { instance } = await setupServer(t) | ||||||
|
|
||||||
| try { | ||||||
| await got.get(`http://localhost:${instance.server.address().port}`, { retry: 0 }) | ||||||
| } catch (error) { | ||||||
| t.ok(error instanceof got.RequestError, 'should throw RequestError') | ||||||
| t.end() | ||||||
| } | ||||||
| }) | ||||||
|
|
||||||
| test("a server 500's with a custom handler and should revive", async (t) => { | ||||||
| const customRetryLogic = (req, res, registerDefaultRetry, defaultRetryAfter) => { | ||||||
| if (res && res.statusCode === 500 && req.method === 'GET') { | ||||||
| return 300 | ||||||
| } | ||||||
| return null | ||||||
| } | ||||||
|
|
||||||
| const { instance } = await setupServer(t, { customRetry: { handler: customRetryLogic, retries: 10 } }) | ||||||
|
|
||||||
| const res = await got.get(`http://localhost:${instance.server.address().port}`, { retry: 0 }) | ||||||
|
|
||||||
| t.equal(res.headers['content-type'], 'text/plain') | ||||||
| t.equal(res.statusCode, 205) | ||||||
| t.equal(res.body.toString(), 'Hello World 5!') | ||||||
| }) | ||||||
|
|
||||||
| test("a server 503's with a custom handler for 500 but the custom handler never registers the default so should fail", async (t) => { | ||||||
| // the key here is our customRetryHandler doesn't register the deefault handler and as a result it doesn't work | ||||||
| const customRetryLogic = (req, res, registerDefaultRetry, defaultRetryAfter) => { | ||||||
| if (res && res.statusCode === 500 && req.method === 'GET') { | ||||||
| return 300 | ||||||
| } | ||||||
| return null | ||||||
| } | ||||||
|
|
||||||
| const { instance } = await setupServer(t, { customRetry: { handler: customRetryLogic, retries: 10 } }, 503) | ||||||
|
|
||||||
| try { | ||||||
| await got.get(`http://localhost:${instance.server.address().port}`, { retry: 0 }) | ||||||
| } catch (error) { | ||||||
| t.equal(error.message, 'Response code 503 (Service Unavailable)') | ||||||
| t.end() | ||||||
| } | ||||||
| }) | ||||||
|
|
||||||
| test("a server 503's with a custom handler for 500 and the custom handler registers the default so it passes", async (t) => { | ||||||
|
There was a problem hiding this comment. If you are down with the language change
Suggested change
|
||||||
| const customRetryLogic = (req, res, registerDefaultRetry, defaultRetryAfter) => { | ||||||
| // registering the default retry logic for non 500 errors if it occurs | ||||||
| if (registerDefaultRetry()) { | ||||||
| return defaultRetryAfter | ||||||
| } | ||||||
|
|
||||||
| if (res && res.statusCode === 500 && req.method === 'GET') { | ||||||
| return 300 | ||||||
| } | ||||||
|
|
||||||
| return null | ||||||
| } | ||||||
|
|
||||||
| const { instance } = await setupServer(t, { customRetry: { handler: customRetryLogic, retries: 10 } }, 503) | ||||||
|
|
||||||
| const res = await got.get(`http://localhost:${instance.server.address().port}`, { retry: 0 }) | ||||||
|
|
||||||
| t.equal(res.headers['content-type'], 'text/plain') | ||||||
| t.equal(res.statusCode, 205) | ||||||
| t.equal(res.body.toString(), 'Hello World 6!') | ||||||
| }) | ||||||
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 think it might be clearer not to describe this as "registering" another retry handler (both in this PR and in the test code), we're not really adding a handler to an event emitter or something, but just passing an option.
Also, I think that a custom retry handler needs to be passed the number of attempts so far if it wants to calculate an exponential delay. What do you think about this API instaead