Fix reserved words handling in putUser #120
Conversation
Before, this would check the parent `opts` object, not `metadata` properties.
`metadata` is not a reserved word in a CouchDB user document. Also, CouchDB only uses `_id` and `_rev` as underscore-prefixed reserved words. Therefore, explicitly list them and remove the `startsWith` condition in case the user wants to set others.
tlvince
force-pushed
the
reserved-prop
branch
from
ec02871
to
96c4bc0
Compare
| if (reservedWords.indexOf(key) !== -1 || key.startsWith('_')) { | ||
| return callback(new AuthError('cannot use reserved word in metadata: "' + key + '"')); | ||
| } | ||
| if (reservedWords.indexOf(key) !== -1) { |
There was a problem hiding this comment.
The hasOwnProperty check is not optional; it's standard for these kind of JS for loops
There was a problem hiding this comment.
@nolanlawson @tlvince We only have to keep the hasOwnProperty test if it makes sense to have an opts object that is an instance of a class in a class hierarchy. I guess for options to a function this does never occur.
However, if we choose to keep it, it has to be tested on opts.metadata and not on opts directly, right ?
Currently, this only check for reserved words on properties that are defined both on opts and opts.metadata.
|
TBQH I have no idea what this code was doing, either. Can you add a new test or something to confirm the behavior? |
| if (reservedWords.indexOf(key) !== -1 || key.startsWith('_')) { | ||
| return callback(new AuthError('cannot use reserved word in metadata: "' + key + '"')); | ||
| } | ||
| if (reservedWords.indexOf(key) !== -1) { |
There was a problem hiding this comment.
@nolanlawson @tlvince We only have to keep the hasOwnProperty test if it makes sense to have an opts object that is an instance of a class in a class hierarchy. I guess for options to a function this does never occur.
However, if we choose to keep it, it has to be tested on opts.metadata and not on opts directly, right ?
Currently, this only check for reserved words on properties that are defined both on opts and opts.metadata.
|
@tlvince Do you mind if I take over your pull request ? |
|
Please do. |
I'm a little confused by the way this was previously being handled, but it seems to me what this is supposed to do is prevent reserved words from being set in
opts.metadata, notopts.If that's the case,
metadatais not a reserved word in a CouchDB user document. Also, CouchDB only uses_idand_revas underscore-prefixed reserved words. Therefore, explicitly list them and remove thestartsWithcondition in case the user wants to set others.