Skip to content
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.

Sign up for GitHub

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

test: Add tests for add/remove header after sent. #8682

Closed
wants to merge 5 commits into from
Closed

test: Add tests for add/remove header after sent. #8682

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
361542b
test: Add tests for add/remove header after sent.
niklasi Sep 20, 2016
8787d21
Use port 0 instead of common.PORT.
niklasi Sep 21, 2016
b8ed5ee
Check error messages.
niklasi Sep 21, 2016
a72b6fc
Fix missing semicolon.
niklasi Sep 21, 2016
60a1081
Escape '.' when checking error message.
niklasi Sep 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions test/parallel/test-http-response-add-header-after-sent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
'use strict';
require('../common');
const assert = require('assert');
const http = require('http');

const server = http.createServer((req, res) => {
assert.doesNotThrow(() => {
res.setHeader('header1', 1);
});
res.write('abc')
assert.throws(() => {
res.setHeader('header2', 2);
}, /Can't set headers after they are sent./)
res.end()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it can be useful checking the error message too. 'Can\'t set headers after they are sent.'

Copy link
Contributor Author

@niklasi niklasi Sep 21, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went back and forth with this one. I can see why it could be useful to check the error message, but I can also see why it could be problematic. The way I see it is that the error message is an "implementation detail" and not part of the api and therefore you make the test more fragile if you test the error message. I don't think the test should fail if you change the error message, but on the other hand how do you know if it is the "right" Error? I'm not sure what the best way to do this is, in this context, and I'm more than happy to discuss this.
Btw, this is my first PR for the node-project and I really appreciate your feedback.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm not wrong changing the error message is considered a breaking change so I'm +1 for also checking the error message.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, if that's considered a breaking change then I'm also for checking the error message :-)
Thank you for the clarification. I will fix it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have fixed the error message check now.

});

server.listen(0, () => {
http.get({port: server.address().port}, () => {
server.close()
});
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would listen in the 0 port so it picks a random port

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. s/common.PORT/0/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I will fix that. Just a question about it... In the guide for how to write tests it is mentioned that you should "always use common.PORT instead of an arbitrary value as it allows to run tests in parallel safely". It doesn't mention that you can use port 0 as well. If it is preferable to use port 0 than maybe the guide should be updated? Or did I misunderstand the guide?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, you're right. The guide was written just before changing the policy regarding the port. It should be updated to reflect this change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the PR with 0 as port number now. Thanks for the feedback.

});
21 changes: 21 additions & 0 deletions test/parallel/test-http-response-remove-header-after-sent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
'use strict';
require('../common');
const assert = require('assert');
const http = require('http');

const server = http.createServer((req, res) => {
assert.doesNotThrow(() => {
res.removeHeader('header1', 1);
});
res.write('abc')
assert.throws(() => {
res.removeHeader('header2', 2);
}, /Can't remove headers after they are sent/)
res.end()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check error message here too.

});

server.listen(0, () => {
http.get({port: server.address().port}, () => {
server.close()
});
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing

});