Chore: Implement naming convention for createClient functions #547
Conversation
This file contains 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
dijonmusters
commented
May 17, 2023
silentworks
approved these changes
May 18, 2023
|
Awesome work! Thanks @silentworks! 🙌 |
silentworks
added a commit
that referenced
this pull request
May 25, 2023
* Update changeset config and git workflow * Update to ci pipeline latest LTS nodejs * Storage adapter (#507) * add storage adapters * Remove unused filterCookies function * add pkce support * update sveltekit example * Add pre-release changeset * Bump SvelteKit version --------- Co-authored-by: David Plugge <[email protected]> * chore: update versions (next) (#508) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * simplifying defaults for storage adapter (#510) * chore: update versions (next) (#511) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * remove unused type (#512) * remove unused type * add changeset * chore: update versions (next) (#513) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * chore: add jose to .next branch (#526) * Add jose for it's base64url decode support * Remove js-base64 becuase buffer check Vercel issue * chore: update versions (next) (#527) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Fix Failed to parse cookie string in middleware (#532) * chore: update versions (next) (#533) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix cookie saving in middleware/routeHandler (#536) * chore: update versions (next) (#537) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * add lint and format scripts (#538) * change prettier config * format md files with spaces * add husky and pre-commit script * add lint-staged * configure lint-staged * use tsc as linter * add ci workflow * add checks permission * use prettierignore * WIP: Writable cookies (#543) * wip: example for writable cookies - server actions and route handlers * add ReadonlyRequestCookies type for Server Component client * swap routeHandler and serverActions client (#544) * Chore: Implement naming convention for createClient functions (#547) * implement consistent naming convention for createClient functions * Add deprecated functions and changeset --------- Co-authored-by: Andrew Smith <[email protected]> * chore: update versions (next) (#548) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Ignore changeset and github actions * Chore: Implement singleton pattern for createClientComponentClient function (#550) * implement singleton pattern for createClientComponentClient * Fix type issue (#554) * Fix: Set response cookie (#551) * add cookie header to make refreshed session available in Server Components * add guard around setting headers * Chore: Update Next.js and remove custom type for WritableCookies (#552) * update next.js and remove custom type * chore: update versions (next) (#555) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Fix: Typedefs for clientClient functions (#556) * add explicit return types for createClient functions * add deprecated functions for App Router createClient functions * add changeset * Fix: missing type from SvelteKit and remix package (#557) * chore: update versions (next) (#558) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Final release of auth-helpers PKCE * chore: update versions (#559) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> --------- Co-authored-by: David Plugge <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: David Plugge <[email protected]> Co-authored-by: Jon Meyers <[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.
What kind of change does this PR introduce?
Chore
What is the current behavior?
What is the new behavior?
The App Router createClient functions follow a contextual convention as to where they are being used:
Pages directory createClient functions now contain
pagesin their nameHave also removed the
Supabasepart of each export, as this feels unnecessary.Additional context
We cannot consolidate all server-side functions into a single createServerClient function, as Server Components will not be able to
setcookies, therefore, will always need to use middleware to refresh expired sessions: vercel/next.js#41745 (reply in thread)While
createRouteHandlerClientandcreateServerActionClientare exactly the same function, I think it best to keep these as separate exports to simplify the DX when consuming them - if they were named the same, I think it would cause more confusion and require an unnecessarily deep understanding of the design decisions of the Next.js App Router.This same justification goes for
createPagesBrowserClientandcreateClientComponentClient. Having this clear separation betweenpagesandApp Routersimplifies the DX.