PRO-8013: comprehensive solution to support atypical passport strategies #31
Conversation
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
boutell
commented
Jul 3, 2025
| ### Working with passport strategies that expect different arguments to the `verify` callback | ||
|
|
||
| All passport strategies expect us to provide a `verify` callback. By default, `@apostrophecms/passport-bridge` passes its `findOrCreateUser` function as the `verify` callback, which works for many strategies including `passport-oauth2`, `passport-github2` and `passport-gitlab2`. For other strategies, you can pass an explicit `verify` option which will remap the strategy `verify` method with `@apostrophecms/passport-bridge` `findOrCreateUser` method. | ||
| All passport strategies expect us to provide a `verify` callback. By default, `@apostrophecms/passport-bridge` passes its `findOrCreateUser` function as the `verify` callback, which works for many strategies including `passport-oauth2`, `passport-github2` and `passport-gitlab2`. For other strategies, you can pass an explicit `verify` option which will remap the strategy `verify` method to our `@apostrophecms/passport-bridge` `findOrCreateUser` method. |
Member
Author
There was a problem hiding this comment.
I made some wording improvements regarding verify, I didn't change it.
boutell
commented
Jul 3, 2025
|
|
||
| That function accepts the normal verify callback from the passport bridge module, and returns an alternative function which accepts `req`, plus the arguments that are typical for `passport-auth0` or the strategy of your choice, and then invokes the normal verify callback with the arguments it expects, returning the result. | ||
|
|
||
| ### Working with `oidc-client` and other passport strategies that don't follow typical patterns |
Member
Author
There was a problem hiding this comment.
Here's the juicy new feature.
boutell
commented
Jul 3, 2025
|
|
||
| for (const strategy of self.options.strategies) { | ||
| const spec = klona(strategy); | ||
| for (let spec of self.options.strategies) { |
Member
Author
There was a problem hiding this comment.
freeing up the variable name strategy for the actual strategy object.
boutell
commented
Jul 3, 2025
| // sensibly. But we can do it by making a dummy strategy object now | ||
| const dummy = new Strategy({ | ||
| callbackURL: 'https://dummy/test', | ||
| const dummy = await factory({ |
Member
Author
There was a problem hiding this comment.
this edge case will rarely be used with a factory function, but must be thorough
boutell
commented
Jul 3, 2025
| self.strategies[spec.name] = strategy; | ||
| self.apos.login.passport.use(strategy); | ||
| if (strategy._oauth2) { | ||
| // This will only work with strategies that actually have an _oauth2 object |
Member
Author
There was a problem hiding this comment.
not everything is oauth2 based. Oops. A bug fix.
Member
Author
There was a problem hiding this comment.
Without this we get a crash with strategies that can't support automatic token refresh. Which isn't even important unless you're reusing the tokens for API calls.
haroun
approved these changes
Jul 4, 2025
Contributor
haroun
left a comment
haroun
left a comment
There was a problem hiding this comment.
There are tiny request changes in the doc, the rest is ok
Co-authored-by: haroun <[email protected]>
Co-authored-by: haroun <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This has been tested:
apostrophecms/starter-kit-assembly-essentials#130
apostrophecms/starter-kit-essentials#75