Reject reserved names in morgan.token() - #385
Open
seethinajayadileep wants to merge 1 commit into
Open
seethinajayadileep wants to merge 1 commit into
seethinajayadileep wants to merge 1 commit into
Conversation
Registering a token named token/format/compile overwrote morgan's own API methods because tokens are stored on the export object. Throw a TypeError instead, document the reserved names, and add regression tests. Fixes expressjs#265 Signed-off-by: JAYA DILEEP <seethinajayadileep@hotmail.com>
seethinajayadileep
marked this pull request as ready for review
September 6, 2026 04:28
5 tasks done
|
Tested this locally against the reproduction in #265. On master, registering a token named token is accepted, and later On this branch, I also listed the functions exposed on morgan. compile, format and token are the ones morgan itself relies on, so the reserved list looks complete. Built-in tokens and formats stay overridable, which seems intentional. The README note is accurate and sits well next to the existing "same name overwrites" sentence. npm test and npm run lint both pass on this branch. Looks good to me. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
morgan.token()stores callbacks on the morgan export object. Registering a token namedtoken,format, orcompiletherefore overwrote morgan's own API methods. Aftermorgan.token('token', ...), latermorgan.token(...)calls failed withTypeError: ... is not a function, which matches issue #265.Per maintainer guidance on that issue, 1.x should reject those reserved names with a clear error (and document them). Allowing arbitrary names is left for a future 2.0 redesign.
Changes
TypeErrorwhen registering a reserved token namemorgan.tokenusable after a rejected registration)Test plan
./node_modules/.bin/mocha --exit test/morgan.js(96 pass)NO_COLOR=1 ./node_modules/.bin/mocha --exit test/noColor.js(6 pass)Fixes #265