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
feat(req): add restifyDone event #1740
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
### restifyDone | ||
|
||
After request has been fully serviced, an `restifyDone` event is fired. | ||
restify considers a request to be fully serviced when either: | ||
|
||
1) The handler chain for a route has been fully completed | ||
2) An error was returned to `next()`, and the corresponding error events have | ||
been fired for that error type | ||
|
||
The signature for the `restifyDone` event is as follows: | ||
|
||
```js | ||
function(route, error) { } | ||
``` | ||
|
||
* `route` - the route object that serviced the request | ||
* `error` - the error passed to `next()`, if applicable | ||
|
||
Note that when the server automatically responds with a | ||
`NotFound`/`MethodNotAllowed`/`VersionNotAllowed`, this event will still be | ||
fired. |
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,4 +1,6 @@ | ||
toc: | ||
- Request | ||
- name: Events | ||
file: ../api/server-events.md | ||
- name: Log | ||
file: ../api/request-log.md |
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 |
---|---|---|
|
@@ -223,3 +223,55 @@ test('should provide date when request started', function(t) { | |
t.end(); | ||
}); | ||
}); | ||
|
||
// restifyDone is emitted at the same time when server's after event is emitted, | ||
// you can find more comprehensive testing for `after` lives in server tests. | ||
test('should emit restifyDone event when request is fully served', function(t) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we add a test for |
||
var clientDone = false; | ||
|
||
SERVER.get('/', function(req, res, next) { | ||
req.on('restifyDone', function(route, err) { | ||
t.ifError(err); | ||
t.ok(route); | ||
setImmediate(function() { | ||
t.ok(clientDone); | ||
t.end(); | ||
}); | ||
}); | ||
|
||
res.send('hello'); | ||
return next(); | ||
}); | ||
|
||
CLIENT.get('/', function(err, _, res) { | ||
t.ifError(err); | ||
t.equal(res.statusCode, 200); | ||
clientDone = true; | ||
}); | ||
}); | ||
|
||
// eslint-disable-next-line max-len | ||
test('should emit restifyDone event when request is fully served with error', function(t) { | ||
var clientDone = false; | ||
|
||
SERVER.get('/', function(req, res, next) { | ||
var myErr = new Error('My Error'); | ||
|
||
req.on('restifyDone', function(route, err) { | ||
t.ok(route); | ||
t.deepEqual(err, myErr); | ||
setImmediate(function() { | ||
t.ok(clientDone); | ||
t.end(); | ||
}); | ||
}); | ||
|
||
return next(myErr); | ||
}); | ||
|
||
CLIENT.get('/', function(err, _, res) { | ||
t.ok(err); | ||
t.equal(res.statusCode, 500); | ||
clientDone = true; | ||
}); | ||
}); |
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.
Any reason not to match the API of server after?
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 just thought it would look strange that we pass req in a req event...