feat(common): add afterAuthenticated middleware hook #40
Conversation
eunjae-lee
requested review from
a team,
demetriusfeijoo,
BibiSebi and
Dawntraoz
and removed request for
a team
| @@ -16,6 +19,10 @@ declare module '@nuxt/schema' { | |||
| errorCallback: string; | |||
| middleware?: { | |||
| ignoredPaths?: string[]; //e.g.: ['/api/endpoint'] | |||
| afterAuth?: (params: { | |||
There was a problem hiding this comment.
Hey @eunjae-lee 🙌
Would be possible to create a type for this function? wdyt?
|
|
||
| const afterAuth = appConfig.auth.middleware?.afterAuth; | ||
| if (typeof afterAuth === 'function') { | ||
| return await afterAuth({ event, appSession }); |
There was a problem hiding this comment.
This function is called only when the authentication succeeds, so I was wondering if we could name it more specifically, what do you think?
afterAuthSucceeds? 🤔
| }); | ||
|
|
||
| const isMiddlewareIgnored = ( | ||
| currentPath: string, | ||
| ignoredPaths: string[] | undefined, | ||
| ignoredPaths: string[] | undefined |
There was a problem hiding this comment.
nit: In another task we can add this config to the .prettier file 🤔
"trailingComma": "all",
|
@demetriusfeijoo thanks for the feedback! I've applied them here :) What do you think about |
eunjae-lee
changed the title
There was a problem hiding this comment.
Do you think in the future we could move these types to a types folder and then configure it to work with auto-import? I don't know if it would work since we use this project as a layer for others. 🤔
There was a problem hiding this comment.
Hey that's actually what I wondered about, but didn't go deep enough to test the configuration with this layer. So for now I simply put it under utils, so that it can be auto-imported without any special configs. However, it's worth trying later :)
What?
This PR adds
afterAuthhook to the auth middleware.Why?
User may want to add more logic right after the authentication. For example, if only admin should enter
/settingspage, then users need to add more logic for that. It can be done by creating a server middleware on the user's project, but currently there is a bug on Nuxt regarding the middleware execution order. But even if the bug is not there, this hook can be a easier way for user to put an extra simple action right after the authentication.For example, the following is possible with
afterAuth:undefinedawait sendRedirect(...)throw createError(...)