Skip to content

Fix: Remove separate persistence flow from update_comment in socket handler - #1693

Open
rajnisht7 wants to merge 1 commit into
fossasia:devfrom
rajnisht7:fix-update-comment
Open

Fix: Remove separate persistence flow from update_comment in socket handler#1693
rajnisht7 wants to merge 1 commit into
fossasia:devfrom
rajnisht7:fix-update-comment

Conversation

@rajnisht7

@rajnisht7 rajnisht7 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Description

This PR removes the separate flow from update_comment

Motivation and Context

remove separate flow from update_comment making consistency with other end points

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactor or cleanup (changes to existing code for improved readability or performance)

Checklist:

  • I adapted the version number under py/visdom/VERSION according to Semantic Versioning
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Summary by Sourcery

Enhancements:

  • Rely on the standard environment persistence flow for comment updates instead of invoking storage.save_env directly from the socket handler.

Copilot AI lite review requested due to automatic review settings August 7, 2026 09:48
@sourcery-ai

sourcery-ai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Removes the explicit background persistence call from the socket handler’s update_comment path so that comment updates rely on the standard, shared persistence mechanism used by other commands.

Sequence diagram for updated update_comment socket flow

sequenceDiagram
    actor Client
    participant SocketHandler
    participant Broadcast

    Client->>SocketHandler: on_message(update_comment)
    SocketHandler->>Broadcast: broadcast_packet
    Broadcast-->>Client: updated_comment_broadcast
    Broadcast-->>Client: updated_comment_broadcast (other listeners)
Loading

File-Level Changes

Change Details Files
Unify update_comment persistence with other websocket commands by removing its dedicated IOLoop executor save call.
  • Removed the run_in_executor call that invoked storage.save_env after broadcasting an update_comment change
  • Ensured that comment updates now depend on the same environment persistence flow used by other commands, improving behavioral consistency
py/visdom/server/handlers/socket_handlers.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

3 participants