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.

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

New: Expose context #83

Closed
wants to merge 2 commits into from
Closed

New: Expose context #83

wants to merge 2 commits into from

Conversation

aegyed91
Copy link

@aegyed91 aegyed91 commented Oct 2, 2017

If context is a non empty object, expose it intoJSON.

After inspecting the code I found the best solution would be to include context, in the response. Internally the module does not place sensitive information on context.

On second thought, this could leak sensitive information in applications relying on context being excluded in response. They might utilise this for internal logging. In this case, logger should either introduce a breaking change and bump major version, or introduce an extra option exposeContext with default value of false.

fixes #80
ping @DonutEspresso @ltvolks @maoueh

@coveralls
Copy link

Coverage Status

Coverage increased (+0.03%) to 98.214% when pulling 4d23f72 on tsm91:feat/expose-context into ebe71cc on restify:master.

2 similar comments
@coveralls
Copy link

Coverage Status

Coverage increased (+0.03%) to 98.214% when pulling 4d23f72 on tsm91:feat/expose-context into ebe71cc on restify:master.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.03%) to 98.214% when pulling 4d23f72 on tsm91:feat/expose-context into ebe71cc on restify:master.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.04%) to 98.222% when pulling 6ae62ca on tsm91:feat/expose-context into ebe71cc on restify:master.

2 similar comments
@coveralls
Copy link

Coverage Status

Coverage increased (+0.04%) to 98.222% when pulling 6ae62ca on tsm91:feat/expose-context into ebe71cc on restify:master.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.04%) to 98.222% when pulling 6ae62ca on tsm91:feat/expose-context into ebe71cc on restify:master.

@aegyed91
Copy link
Author

aegyed91 commented Oct 2, 2017

On third thought. This is not needed.

The only reason i wanted to use this for is client side error metadata. BadRequest already tells its a client side error. Client should validate form before submission, and be able to act upon BadRequest w/o metadata as well

@aegyed91 aegyed91 closed this Oct 2, 2017
@DonutEspresso
Copy link
Member

Glad you found a solution @tsm91 👍 We've had continuing conversations around this, but ended up not serializing context by default exactly for the reason you mentioned re: leaking potentially sensitive context. That said, a custom toJSON() can be implemented if absolutely needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[question] Add extra fields to response
3 participants