-
Notifications
You must be signed in to change notification settings - Fork 47
juspaybrain: fix chat ui synchronization among different instances #673
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
base: main
Are you sure you want to change the base?
juspaybrain: fix chat ui synchronization among different instances #673
Conversation
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @Pradeesh333, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request primarily addresses a critical bug where the chat UI would synchronize across different browser instances, leading to unexpected URL navigation. I've implemented a robust solution using sessionStorage
to uniquely identify and track chat sessions per browser tab, ensuring that UI updates are isolated to the originating instance. Additionally, I've updated the backend API to support these new identifiers and performed a significant code cleanup and reformatting across the Slack integration modules.
Highlights
- Chat UI Synchronization Fix: Implemented a mechanism to ensure chat UI updates, specifically URL navigation, are isolated to the originating browser tab or instance. This prevents unintended redirects or state changes in other open tabs.
- Session-based Chat Tracking: Introduced unique
tabId
andlocalChatId
identifiers, stored insessionStorage
, to accurately track and manage individual chat sessions across different browser instances. - Backend API Enhancement: Extended the chat message API to accept and return the
localChatId
inResponseMetadata
events, facilitating improved synchronization between the frontend and backend for specific chat instances. - Code Style & Formatting: Applied extensive code formatting and linting across several Slack integration files, improving consistency and readability.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a mechanism to synchronize new chat creation across multiple browser tabs using sessionStorage
. The core logic involves generating a temporary localChatId
on the client, passing it to the server, and using it to identify which tab initiated the chat when the server responds with the permanent chat ID.
The implementation correctly passes the necessary IDs between the frontend and backend. However, there is a critical race condition in how sessionStorage
is updated from multiple tabs, which could lead to data loss and UI synchronization failures.
const pendingChats = JSON.parse( | ||
sessionStorage.getItem("pendingChats") || "{}", | ||
) | ||
pendingChats[localChatId] = { tabId, status: "pending" } | ||
sessionStorage.setItem("pendingChats", JSON.stringify(pendingChats)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This read-modify-write operation on sessionStorage
is vulnerable to a race condition. If two tabs create new chats at nearly the same time, one tab's update to pendingChats
can be overwritten by the other. This can lead to a lost entry and prevent the UI from updating correctly when the chat is created.
A more robust solution would involve a locking mechanism or changing the storage strategy to avoid operating on a single large object (e.g., one sessionStorage
entry per pending chat).
setTimeout(() => { | ||
const currentPendingChats = JSON.parse( | ||
sessionStorage.getItem("pendingChats") || "{}", | ||
) | ||
delete currentPendingChats[responseLocalChatId] | ||
sessionStorage.setItem( | ||
"pendingChats", | ||
JSON.stringify(currentPendingChats), | ||
) | ||
}, 5000) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This setTimeout
block has two issues:
- Magic Number: The delay
5000
is a magic number. It should be extracted into a constant with a descriptive name to improve readability and maintainability. - Race Condition: This block performs a read-modify-write on
sessionStorage
, which is vulnerable to the same race condition mentioned forstartStream
. If multiple timeouts from different tabs fire and execute concurrently, they could overwrite each other's changes.
setTimeout(() => { | |
const currentPendingChats = JSON.parse( | |
sessionStorage.getItem("pendingChats") || "{}", | |
) | |
delete currentPendingChats[responseLocalChatId] | |
sessionStorage.setItem( | |
"pendingChats", | |
JSON.stringify(currentPendingChats), | |
) | |
}, 5000) | |
const PENDING_CHAT_CLEANUP_DELAY_MS = 5000; | |
setTimeout(() => { | |
const currentPendingChats = JSON.parse( | |
sessionStorage.getItem("pendingChats") || "{}", | |
) | |
// Check if the key still exists before deleting to avoid errors if another process already cleaned it up. | |
if (currentPendingChats[responseLocalChatId]) { | |
delete currentPendingChats[responseLocalChatId] | |
sessionStorage.setItem( | |
"pendingChats", | |
JSON.stringify(currentPendingChats), | |
) | |
} | |
}, PENDING_CHAT_CLEANUP_DELAY_MS) |
Description
Testing
Additional Notes