docs(nextjs): Document cache components limitations #15899
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
logaretm
requested review from
inventarSarah and
sergical
and removed request for
Copilot
sergical
left a comment
sergical
left a comment
There was a problem hiding this comment.
thanks for taking this on since there was feedback coming in already about it 🙏
|
|
||
| <Alert level="warning" title="Cache Components Limitation"> | ||
|
|
||
| If you're using Next.js [Cache Components](https://nextjs.org/docs/app/getting-started/cache-components), there are known compatibility issues with server-side tracing. See [Cache Components Limitations](#cache-components-limitations) for details and workarounds. |
There was a problem hiding this comment.
i dont think this page will have that content so the link won't work. maybe create both the alert and the section as platform includes components so we can reuse them if needed, maybe also link to a github ticket tracking the work / conversation around supporting cache components?
There was a problem hiding this comment.
Good catch! I already included the issues in the section description, do you think the links should be also in the alert?
There was a problem hiding this comment.
merging now but happy to change it later
There was a problem hiding this comment.
i think its fine as is, sorry i missed it in the description
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for known limitations when using Next.js Cache Components with the Sentry SDK, addressing compatibility issues users are encountering with server-side tracing.
- Documents cache components limitations and associated errors
- Provides workarounds for both Turbopack and webpack configurations
- Adds warning alerts to main Next.js documentation pages
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| platform-includes/nextjs-cache-components-limitations/section/javascript.nextjs.mdx | New file containing detailed documentation of cache components limitations with two scenarios (Turbopack with generateMetadata, Webpack with Cache Components) and their workarounds |
| platform-includes/nextjs-cache-components-limitations/alert/javascript.nextjs.mdx | New alert component warning users about cache components compatibility issues with links to detailed documentation |
| docs/platforms/javascript/guides/nextjs/manual-setup/index.mdx | Integrates cache components warning alert and adds "Known Limitations" section with the detailed documentation |
| docs/platforms/javascript/guides/nextjs/index.mdx | Integrates cache components warning alert at the beginning and includes limitations section before "Next Steps" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
platform-includes/nextjs-cache-components-limitations/alert/javascript.nextjs.mdx
Outdated
Show resolved
Hide resolved
andreiborza
left a comment
andreiborza
left a comment
There was a problem hiding this comment.
Thanks for taking care of this!
…vascript.nextjs.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
logaretm
deleted the
awad/fe-676-document-limitations-around-nextjs-and-cache-components
branch
With more users adopting cache components and running into our current limitations with it, we have to document it for them with the possible workarounds.
None of these are ideal, but the way cache components interferes with our core SDK behavior is not straightforward to fix and may need fundamental changes to our core SDK.
For now I made sure we document the couple of wide cases that the issue appears in, and possible workarounds (more like compromises).