Skip to content

Implement Pinging mechanism to keep Websocket connection alive #3783

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

Open
wants to merge 4 commits into
base: websockets
Choose a base branch
from

Conversation

ozer550
Copy link
Member

@ozer550 ozer550 commented Oct 30, 2022

Summary

Ping Websocket to keep the connection alive

Description of the change(s) you made

  • Frontend pings websocket connection in an interval of 25 seconds
  • Ping messages are limited to only occur when any other messages hadn't been sent during the period timeframe.

Manual verification steps performed

  1. Open a channel
  2. Try changing its name
  3. Websocket PONG response is skipped and occurs after a bit delay then 25 seconds

References

Fixes #3656


Reviewer guidance

How can a reviewer test these changes?

Are there any risky areas that deserve extra testing?

  • I am thinking of a typical edge case where we ping and send some changes simultaneously!

Comments

  • Re-think about the 25 seconds interval as the worst case might be 50 seconds gap between pinging. This may occur in the edge case resulting in the closure of the connection despite our pinging mechanism.

Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

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