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

Fix halfopen websocket #18934

Merged
merged 4 commits into from
Jul 19, 2024
Merged

Fix halfopen websocket #18934

merged 4 commits into from
Jul 19, 2024

Conversation

leonardmgh
Copy link
Contributor

@leonardmgh leonardmgh commented Dec 6, 2023

Breaking change

Proposed change

Implement ping from frontend to backend to detect a broken websocket connection that doesn't trigger a disconnect event. Currently there is no mechanism to detect this and the frontend doesn't indicate that the shown values can be trusted.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • New Features
    • Improved management of websocket pings and reconnects for better stability and performance.

@leonardmgh
Copy link
Contributor Author

Is this the right place to implement this change?

@@ -275,6 +276,23 @@ export const connectionMixin = <T extends Constructor<HassBaseEl>>(
subscribeFrontendUserData(conn, "core", (userData) =>
this._updateHass({ userData })
);

const pingBackend = async () => {
Copy link
Contributor Author

@leonardmgh leonardmgh Dec 7, 2023

Choose a reason for hiding this comment

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

Should i create a seperate function for this? And can i rely on connect is just called once, otherwise i might end up with muliple pings being scheduled at the same time.

this.hass?.connection.reconnect(true);
});
}
setTimeout(pingBackend, 5000);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should the interval be higher? In this case the function can probably just be scheduled with setInterval

Copy link
Member

Choose a reason for hiding this comment

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

To know if the interval should be higher we really need to test or know when the issue occurs...

Copy link

Choose a reason for hiding this comment

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

My own experience with the bug is that a few minutes are enough to trigger

@leonardmgh leonardmgh marked this pull request as ready for review December 7, 2023 14:45
@bramkragten
Copy link
Member

bramkragten commented Dec 8, 2023

Is this the right place to implement this change?

This should probably be done in https://github.com/home-assistant/home-assistant-js-websocket

@leonardmgh
Copy link
Contributor Author

Is this the right place to implement this change?

This should probably be done in https://github.com/home-assistant/home-assistant-js-websocket

That already got rejected...

@frenck
Copy link
Member

frenck commented Dec 8, 2023

Ref: home-assistant/home-assistant-js-websocket#403

@codyc1515
Copy link
Contributor

Have you understood the circumstances that let this happen? I have seen it occasionally but not commonly.

@leonardmgh
Copy link
Contributor Author

Have you understood the circumstances that let this happen? I have seen it occasionally but not commonly.

From my understanding the cause for this are bugs in the implementation of web sockets in browers. In the issue if have linked, i was able to reproduce this on an iPad, but people have also reported the same problem on other platforms. So there are probably multiple circumstances that can cause this.
Ideally this fix would not be needed, but the "reported" state of web sockets can't be relied upon. For me the biggest issue is that the front end doesn't show any indication of something being wrong and everything seems to be working, if you can't see the controlled device directly.

@bramkragten bramkragten self-assigned this Feb 28, 2024
@leonardmgh
Copy link
Contributor Author

@bramkragten i can see you assigned the issue to yourself. Are there still some information/context you are missing that i can help with?

Copy link
Contributor

coderabbitai bot commented Jul 15, 2024

Walkthrough

Walkthrough

The changes in the src/state/connection-mixin.ts file focus on enhancing websocket connection management through the introduction of a promiseTimeout function and a private variable __backendPingInterval. These updates improve the handling of websocket pings and reconnections within the connectionMixin function's initializeHass method.

Changes

File Change Summary
src/state/connection-mixin.ts Added promiseTimeout for better websocket ping and reconnect functionality. Introduced private variable __backendPingInterval to manage the ping intervals.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant WebSocket

    User->>App: Initialize Application
    App->>WebSocket: Establish Connection
    WebSocket-->>App: Connection Established

    loop Every Interval
        App->>WebSocket: Send Ping
        WebSocket-->>App: Pong Response
    end

    Note over App,WebSocket: If no Pong Response
    App->>WebSocket: Attempt Reconnect
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 340fa06 and 2f481ca.

Files selected for processing (1)
  • src/state/connection-mixin.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/state/connection-mixin.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@leonardmgh
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

src/state/connection-mixin.ts Show resolved Hide resolved
@bramkragten bramkragten enabled auto-merge (squash) July 19, 2024 09:56
@bramkragten bramkragten merged commit 677cffd into home-assistant:dev Jul 19, 2024
9 checks passed
@leonardmgh leonardmgh deleted the fix-halfopen-websocket branch July 19, 2024 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants