Broadcast cache writes to all tabs/windows

[CarsonF]

This allows fresh data from one tab to be applied to all tabs.
Each tab still has its own cache, changes are just synced.
So refreshing the page will still initialize empty, so if some data point became stale (now in all tabs), the user can refresh one page, and the fresh data will refresh all tabs.

Summary by CodeRabbit

• New Features

  • Introduced cross-tab communication for impersonation state changes using the BroadcastChannel API.
  • Enhanced cache functionality to synchronize write operations across multiple tabs/windows.

• Bug Fixes

  • Improved handling of impersonation state updates to ensure consistency across different contexts.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce functionality for inter-window communication in the application using the BroadcastChannel API. In the ImpersonationProvider component, a BroadcastChannel instance is created to facilitate cross-tab synchronization of impersonation state changes. The createCache function is also updated to broadcast write operations to other contexts, enhancing the cache's ability to synchronize state across multiple instances of the application. Overall, these modifications improve the application's responsiveness to state changes across different tabs or windows.

Changes

File Path	Change Summary
src/api/client/ImpersonationContext.tsx	Introduced BroadcastChannel for impersonation state communication; modified set function and added useEffect for listening to messages.
src/api/client/createCache.ts	Added BroadcastChannel functionality to createCache for inter-window communication during cache write operations.

Poem

In the world of tabs, oh what a sight,
A rabbit hops through day and night.
With channels that broadcast, so clever and bright,
Impersonation dances, a joyous delight!
Cache writes whisper, across the air,
Synchronizing magic, everywhere! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

src/api/client/createCache.ts (1)

32-36: Consider using more descriptive variable and function names

For improved code readability, consider renaming variables:

• Rename orig to originalWrite to clearly indicate its purpose.
• Rename ourWrite to broadcastedWrite or wrappedWrite to reflect its role in broadcasting and overriding the cache's write method.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 785560f and ebd038c.

📒 Files selected for processing (2)

• src/api/client/ImpersonationContext.tsx (4 hunks)
• src/api/client/createCache.ts (2 hunks)

🧰 Additional context used

🔇 Additional comments (5)

src/api/client/createCache.ts (2)

2-2: LGTM

The import statement correctly brings in the Cache type for use in type annotations.

---

30-39: Ensure Cache.WriteOptions is serializable before broadcasting

The options object passed to writeChannel.postMessage(options); in line 34 must be serializable using the structured clone algorithm used by BroadcastChannel. Verify that Cache.WriteOptions does not contain any functions or non-serializable data types to prevent runtime errors when broadcasting cache writes.

src/api/client/ImpersonationContext.tsx (3)

31-35: Initialization of BroadcastChannel is correct

The use of useState to conditionally initialize the broadcast channel ensures compatibility with environments where BroadcastChannel is not available.

---

49-49: Broadcasting impersonation state changes

The line broadcast?.postMessage(next); effectively broadcasts state changes to other tabs when BroadcastChannel is available.

---

59-59: Including broadcast in the dependency array of set

Including broadcast in the dependency array of the set function's useCallback ensures that any changes to broadcast will update the set function, which is appropriate.