docs(oauth2,repo): correct the modules table and document server storage - #36
Merged
Conversation
The oauth2 modules table named `mountOAuthLogin` as the fastify export; that function does not exist there — the subpath exports `oauthLogin` and `oauthLoginPlugin`, as the prose above the table already showed. The row was a copy of the express one. The `./server` row listed three of its exports and omitted the rest, including every Redis store. More consequential: the README never mentioned storage at all, so a reader following it deploys an authorization server on in-memory stores and finds out the hard way on the second instance. Adds a storage section that says which stores exist, which clients are supported, and why memory is not a default you can ship behind a load balancer. Also drops the stale "22-package stack" line in CLAUDE.md, which every other doc puts at 20, and corrects the redis-helpers header that claimed the module is not consumed outside `@exortek/shared` — oauth2, opaque and session all import it directly.
README.md is in the published files list, so these corrections change the tarball and need a version bump to reach anyone.
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
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.
Independent.
The consequential part: the oauth2 README never mentioned storage, so a reader following it deploys an authorization server on in-memory stores and finds out on the second instance — a code issued on one node cannot be redeemed on another. Adds a storage section covering the Redis-backed stores, which clients they work with, and why memory is not a default to run behind a load balancer.
Corrections:
mountOAuthLoginas the fastify export. That function is Express-only; the fastify subpath exportsoauthLoginandoauthLoginPlugin. The row was a copy of the express one — the prose above the table was already right../serverrow listed three exports and omitted the rest, includingoauth2Handlers, the client registry helpers, and every Redis store.CLAUDE.mdsaid "22-package stack"; every other doc says 20.redis-helpersheader claimed the module is not consumed outside@exortek/shared— oauth2, opaque and session all import it directly.README.mdis in the published files list, so this changes the tarball and carries a patch changeset.