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

Connection State Recovery #464

Open
HeroOfOdyssey opened this issue Oct 16, 2024 · 1 comment
Open

Connection State Recovery #464

HeroOfOdyssey opened this issue Oct 16, 2024 · 1 comment

Comments

@HeroOfOdyssey
Copy link

I think there's a critical issue in connection state recovery documentation. The fact that the server must emit an event for it to be successful is documented, but unfortunately, I only saw that tidbit after hours of debugging. I think the "For the recovery to succeed, the server must send at least one event, in order to initialize the offset on the client side." text shouldn't solely be under "how it works under the hood" because that's critical information for implementation of connection state recovery, and is relevant to anyone who is implementing it, not just those who are curious about how it works. I think it should be under the "usage" section or the "disclaimer" section and be in a yellow or red box, not a grey "note" box because it's a little bit more than a note. An additional "Connection State Recovery will NOT be successful unless the client has received at least one event from the server" warning would be greatly beneficial.

@HeroOfOdyssey
Copy link
Author

#465
Made a pull request with the change. currently its a tip element but maybe it should be a caution element

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

No branches or pull requests

1 participant