Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

es/v2: Remove "Common errors" #219

Merged
merged 2 commits into from
Oct 30, 2024
Merged

Conversation

timostamm
Copy link
Member

The page Connect for Web / Common errors only explains a single common error: Failed CORS requests when updating to the v0.6.0 release of @connectrpc/connect-web. This release is nearly two years old, so I don't think it's a common error anymore. This moves the content to the FAQ.

Copy link

vercel bot commented Oct 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
connect ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 2:35pm

docs/faq.md Outdated
Comment on lines 389 to 392
One specific gotcha to be aware of involves a new header `Connect-Protocol-Version`. With the [v0.6.0 release](https://github.com/connectrpc/connect-es/releases/tag/v0.6.0)
of `@connectrpc/connect-web`, this header was added to all requests sent via the library. As a result, Connect clients
that were working prior may start experiencing CORS errors upon upgrading to `v0.6.0`. Note that this also only affects
Connect traffic. gRPC-Web traffic is unaffected.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if this is even worth mentioning any more. We moved to @connectrpc after v0.13.0 and this predates even that by at least 7 releases. I'm sure people are still downloading this out in the wild, but is it worth the extra FAQ noise?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. There are only ~250 weekly downloads for < v0.6.0, and we link to the CORS docs from other FAQs. Updated.

Signed-off-by: Timo Stamm <[email protected]>
@timostamm timostamm changed the title es/v2: Move "Common errors" to the FAQ es/v2: Remove "Common errors" Oct 30, 2024
@timostamm timostamm merged commit b9a72a9 into es/v2 Oct 30, 2024
3 of 5 checks passed
@timostamm timostamm deleted the tstamm/move-web-common-errors-to-faq branch October 30, 2024 14:37
@timostamm timostamm mentioned this pull request Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants