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.
Adds static type checking to
res.local.payload
ifstrongJwtVerification()
orweakJwtVerification()
is called, removing the need foras JWTPayload
to ever be used. Ifres.locals.payload
is accessed without calling one of the two middleware factories, then the type ofres.locals.payload
will beunknown
.I also went ahead and added doc comments to both
strongJwtVerification()
andweakJwtVerification()
as both were not really clear as to what they do and what sets them apart.Some things to note
strongJwtVerification()
orweakJwtVerification()
is called, TypeScript will infer that all references tores.locals.payload
are of typeJWTPayload.
If a handler function is run beforestrongJwtVerification()
orweakJwtVerification()
that readsres.locals.payload
, it will lead to UB. Note that this isn't any better than mindlessly castingres.locals.payload
toJWTPayload
(what is currently being done onmain
).I'm not sure if there is a way to give the next handler function a new context object in Express since the context
locals
is baked intores
, andreq
andres
are all mutably shared across all handlers, so I don't know if splitting contexts is a limitation of Express. I'm not too familiar with other frameworks, but for example, TRPC can modify context between handlers and middleware, allowing types to be hardened in future handlers (see first example:ctx.user
is of typeUser | undefined
and if the middleware succeeds, the new type ofctx.user
that is passed to future is of typeUser
): https://trpc.io/docs/server/middlewares