socketio / socketio/socket.io-website

Connection State Recovery

Open
#464 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
342
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the connection state recovery documentation and compare its usage, disclaimer, and how-it-works-under-the-hood sections. Move the existing requirement into a prominent usage or disclaimer warning, add the suggested warning text, and verify the rendered callout clearly communicates that recovery requires at least one server event.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.