refactor!: consolidate initReq in payload - #17690
Draft
jacobsfletch wants to merge 16 commits into
Draft
Conversation
Contributor
📦 esbuild Bundle Analysis for payloadThis analysis was generated by esbuild-bundle-analyzer. 🤖
Largest pathsThese visualization shows top 20 largest paths in the bundle.Meta file: packages/next/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_shared.json, Out file: esbuild/exports/shared.js
Meta file: packages/richtext-lexical/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_shared.json, Out file: esbuild/exports/shared_optimized/index.js
DetailsNext to the size is how much the size has increased or decreased compared with the base branch of this PR.
|
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.
Consolidates
initReqso that every framework adapter uses the same request initialization behavior frompayload.initReqwas originally built with the Next.js rendering model in mind. As support for TanStack Start was added, it became clear that the shared initialization logic also carried assumptions specific to Next.js, leading TanStack Start to maintain its own implementation.Moving the shared behavior into
payloadgives us one canonical implementation while keeping the genuinely framework-specific pieces at the adapter boundary. Framework adapters are responsible for:ServerAdapterA regression test verifies that Next.js preserves its existing request-scoped caching behavior.
Breaking Changes
initReqis a low-level integration point intended only for framework adapters. Consumers should not call it directly. Payload already supplies an initializedPayloadRequestto custom endpoints, server-rendered custom admin views, and every other supported extension point where request state is needed.The previously exposed
@payloadcms/ui/utilities/initReqpath is removed without a public replacement. Consumers should use the initialized request supplied by Payload at supported extension points instead of initializing requests directly. If absolutely needed, you can use the canonicalinitReqat your own risk: