fix: Sync Account on Add

[alexrisch]

Added subscription for accounts store

Summary by CodeRabbit

• New Features

  • Enhanced account synchronization logic with a new subscription to monitor account changes.
  • Improved logging for account synchronization activities.

• Bug Fixes

  • Added cleanup for the account store subscription in the destroy method to prevent potential memory leaks.

[coderabbitai]

Walkthrough

The changes in the pull request involve modifications to the XmtpEngine class within the components/XmtpEngine.tsx file. A new import for useAccountsStore has been added, along with a new property, accountsStoreSubscription. The start method now establishes a subscription to monitor account changes, triggering the syncAccounts method when necessary. Additionally, the syncAccounts method has been updated with logging functionality, and the destroy method now includes cleanup for the subscription.

Changes

File	Change Summary
components/XmtpEngine.tsx	- Added import for useAccountsStore. - Introduced accountsStoreSubscription property. - Updated start method to subscribe to useAccountsStore. - Enhanced syncAccounts method with logging. - Modified destroy method to clean up accountsStoreSubscription.

Poem

🐇 In the garden where accounts play,
A new subscription leads the way.
Syncing accounts with a hop and a cheer,
Logging the changes, making it clear.
With every update, we dance and we twirl,
In the world of Xmtp, watch our flags unfurl! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8bc2747 and af74a3f.

📒 Files selected for processing (1)

• components/XmtpEngine.tsx (5 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• components/XmtpEngine.tsx

---

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.

[github-actions]

Performance Comparison Report

• Current: a7d9e63 - 2024-10-25 17:11:02Z
• Baseline: release/2.0.8 (f0756cf) - 2024-10-25 17:10:23Z

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries

Name	Type	Duration	Count
Avatar Image 10 runs	render	1.3 ms → 1.2 ms (-0.1 ms, -7.7%)	1 → 1
Avatar Image 50 runs	render	1.1 ms → 1.1 ms	1 → 1
Empty Avatar 10 runs	render	1.0 ms → 0.9 ms (-0.1 ms, -10.0%)	1 → 1
Empty Avatar 50 runs	render	0.6 ms → 0.7 ms (+0.1 ms, +16.1%) 🔴	1 → 1

Show details

Name	Type	Duration	Count
Avatar Image 10 runs	render	Baseline Mean: 1.3 ms Stdev: 0.5 ms (37.2%) Runs: 1 1 2 1 1 1 1 2 2 1 Warmup runs: 2 Current Mean: 1.2 ms Stdev: 0.6 ms (52.7%) Runs: 2 1 1 1 2 1 1 2 0 1 Warmup runs: 3	Baseline Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 Render issues: Current Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 Render issues:
Avatar Image 50 runs	render	Baseline Mean: 1.1 ms Stdev: 0.3 ms (29.6%) Runs: 1 1 2 1 1 1 1 0 1 1 1 1 1 1 1 1 2 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 2 1 1 2 1 1 1 1 1 1 1 1 Warmup runs: 1 Current Mean: 1.1 ms Stdev: 0.2 ms (22.6%) Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 2 1 1 1 1 1 1 1 1 1 1 1 2 1 1 1 1 2 1 1 Warmup runs: 1	Baseline Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 Render issues: Current Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 Render issues:
Empty Avatar 10 runs	render	Baseline Mean: 1.0 ms Stdev: 0.5 ms (47.1%) Runs: 1 2 1 1 1 1 0 1 1 1 Warmup runs: 78 Current Mean: 0.9 ms Stdev: 0.3 ms (35.1%) Runs: 1 1 1 1 1 0 1 1 1 1 Warmup runs: 8	Baseline Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 Render issues: Current Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 Render issues:
Empty Avatar 50 runs	render	Baseline Mean: 0.6 ms Stdev: 0.5 ms (79.1%) Runs: 0 1 0 0 0 1 1 1 0 1 1 0 1 1 1 1 1 0 0 1 1 1 1 1 1 1 1 1 0 0 0 0 1 1 1 1 0 1 1 0 1 0 0 1 0 0 1 0 1 1 Warmup runs: 1 Current Mean: 0.7 ms Stdev: 0.5 ms (69.0%) Runs: 0 1 1 1 1 1 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 0 1 0 0 0 1 1 0 0 1 1 1 1 1 1 0 1 1 1 2 1 0 1 0 0 1 1 0 Warmup runs: 1	Baseline Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 Render issues: Current Mean: 1 Stdev: 0 (0.0%) Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 Render issues:

Render Count Changes

There are no entries

Render Issues

There are no entries

Added Scenarios

There are no entries

Removed Scenarios

There are no entries

Generated by 🚫 dangerJS against af74a3f

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

components/XmtpEngine.tsx (1)

Line range hint 147-162: Enhance error handling and async flow in syncAccounts.

The sync logic could benefit from improved error handling and modern async/await syntax:

1. Add error logging in catch block
2. Consider using async/await for better readability
3. Add protection against race conditions

Consider refactoring to:

 async syncAccounts(accountsToSync: string[]) {
-  accountsToSync.forEach((a) => {
+  await Promise.all(accountsToSync.map(async (a) => {
     if (!this.syncingAccounts[a]) {
       logger.info(`[XmtpEngine] Syncing account ${a}`);
-      getTopicsData(a).then((topicsData) => {
-        getChatStore(a).getState().setTopicsData(topicsData, true);
-      });
+      try {
+        const topicsData = await getTopicsData(a);
+        getChatStore(a).getState().setTopicsData(topicsData, true);
+        this.syncedAccounts[a] = true;
+        this.syncingAccounts[a] = true;
+        await syncXmtpClient(a);
+      } catch (error) {
+        logger.error(`[XmtpEngine] Error syncing account ${a}:`, error);
+      } finally {
+        this.syncingAccounts[a] = false;
+      }
-      this.syncedAccounts[a] = true;
-      this.syncingAccounts[a] = true;
-      syncXmtpClient(a)
-        .then(() => {
-          this.syncingAccounts[a] = false;
-        })
-        .catch(() => {
-          this.syncingAccounts[a] = false;
-        });
     }
-  });
+  }));
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between eb8e82f and 8bc2747.

📒 Files selected for processing (1)

• components/XmtpEngine.tsx (5 hunks)

🔇 Additional comments (4)

components/XmtpEngine.tsx (4)

16-20: LGTM! Import changes are well-organized.

The new useAccountsStore import is appropriately grouped with related account store imports.

---

33-33: LGTM! Property declaration follows established patterns.

The accountsStoreSubscription property follows the same pattern as other subscription properties in the class.

---

167-167: LGTM! Proper cleanup implementation.

The cleanup of accountsStoreSubscription follows the established pattern and properly handles the null case.

---

Line range hint 33-69: Verify subscription cleanup across component lifecycle.

While the implementation aligns with the PR objectives, let's verify that subscriptions are properly cleaned up across all scenarios.

Also applies to: 167-167

✅ Verification successful

Let me analyze the subscription cleanup patterns in the codebase to verify the concern about subscription cleanup.

---

Let me try a different search pattern to find the cleanup logic.

---

Subscription cleanup is properly implemented

The code shows proper cleanup of all subscriptions in the XmtpEngine:

• this.accountsStoreSubscription?.() - Cleans up accounts store subscription
• this.appStoreSubscription?.() - Cleans up app store subscription
• this.appStateSubscription?.remove() - Cleans up app state subscription

The implementation follows best practices for subscription management and memory leak prevention.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential memory leaks in subscription handling
echo "Checking for other subscription cleanup patterns in the codebase:"
rg -A 5 "useAccountsStore.subscribe" 

echo "Checking for component unmount cleanup patterns:"
ast-grep --pattern 'useEffect(() => {
  $$$
  return () => {
    $$$
  };
}, $$$)'

Length of output: 39815

---

Script:

#!/bin/bash
# Search for stop/cleanup method in XmtpEngine
ast-grep --pattern 'stop() {
  $$$
}'

# Search for subscription cleanup in XmtpEngine
rg -A 5 "this.accountsStoreSubscription\(\)" components/XmtpEngine.tsx
rg -A 5 "this.appStoreSubscription\(\)" components/XmtpEngine.tsx

Length of output: 180

---

Script:

#!/bin/bash
# Search for stop method and subscription cleanup in XmtpEngine
rg -A 10 "stop\(\)" components/XmtpEngine.tsx

# Search for subscription cleanup patterns
rg -A 5 "this\.accountsStoreSubscription\?" components/XmtpEngine.tsx
rg -A 5 "this\.appStoreSubscription\?" components/XmtpEngine.tsx

Length of output: 436