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: Fixed type to match new SDK Version #1404

Closed
wants to merge 2 commits into from

Conversation

alexrisch
Copy link
Collaborator

@alexrisch alexrisch commented Dec 19, 2024

Added senderInboxId

Summary by CodeRabbit

  • New Features
    • Implemented a polling mechanism for group join requests, improving the handling and status reporting of join attempts.
  • Bug Fixes
    • Updated the property name for sender identification in message handling, enhancing clarity in the messaging process.

@alexrisch alexrisch requested a review from a team as a code owner December 19, 2024 22:05
Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request modifies the useSendMessage hook in the conversation feature by renaming the senderAddress property to senderInboxId within the textMessage object. This change updates how the sender's identifier is referenced when creating a new message. Additionally, in the liveAttemptToJoinGroup method, a polling mechanism is introduced for group join requests, enhancing error handling and status reporting. The core functionalities of both features remain unchanged.

Changes

File Change Summary
features/conversation/hooks/use-send-message.ts Renamed senderAddress property to senderInboxId in textMessage object
features/GroupInvites/joinGroup/JoinGroup.client.ts Added polling mechanism for group join requests using wait utility; enhanced error handling and status reporting

Possibly related PRs

  • fix: Frames Renders on initial Send #1113: This PR involves changes to the Chat.tsx component that also affect how messages are rendered, which may relate to the handling of message properties in the useSendMessage function.
  • Fix reply message profile display #1326: This PR modifies the message-reply.tsx file to change how sender information is displayed in reply messages, which could be relevant to the changes in sender identification in the useSendMessage function.
  • feat: Members Query on Conversation List  #1343: This PR updates the handling of group members in the conversation list, which may relate to the overall message handling and sender identification in the context of conversations.

Suggested labels

2.0.7

Suggested reviewers

  • thierryskoda
  • technoplato

Poem

🐰 In the code where messages fly,
senderAddress waved goodbye.
With senderInboxId now in sight,
Our messages hop with pure delight!
Join requests now check and retry,
With logs that tell us how and why! 📨✨

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Collaborator

@technoplato technoplato left a comment

Choose a reason for hiding this comment

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

does this fix .send is not a function?

@alexrisch
Copy link
Collaborator Author

does this fix .send is not a function?

Hmm no I don't think so, I'll try to find a log for it, likely related to conversation context not getting set correctly

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: 0

🧹 Nitpick comments (1)
features/conversation/hooks/use-send-message.ts (1)

82-84: Consider addressing the @ts-ignore comment.

The presence of @ts-ignore for the deliveryStatus property suggests potential type mismatches. Consider properly typing IConversationMessageStatus in the SDK types or creating a proper type intersection.

Example approach:

type OptimisticDecodedMessage<T> = DecodedMessage<T> & {
  deliveryStatus: IConversationMessageStatus;
};
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4ada0c and 1555d80.

📒 Files selected for processing (1)
  • features/conversation/hooks/use-send-message.ts (1 hunks)
🔇 Additional comments (1)
features/conversation/hooks/use-send-message.ts (1)

85-85: LGTM! Verify complete SDK type implementation.

The change from senderAddress to senderInboxId aligns with the SDK update. The value is correctly sourced from currentUserInboxId.

Let's verify if there are any other instances where sender identification needs to be updated:

✅ Verification successful

The change to senderInboxId is part of a broader SDK update and is correctly implemented

The codebase search reveals that senderInboxId is consistently used across the application, particularly in message-related functionality. The change from senderAddress to senderInboxId in the use-send-message.ts file aligns with this pattern. The few remaining instances of senderAddress are either:

  • In comments explaining legacy behavior
  • In type definitions for specific data structures
  • In iOS notification extension code that handles address translation
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential missed updates to sender identification
rg -i "senderAddress|senderInbox" --type typescript

Length of output: 88


Script:

#!/bin/bash
# Search for potential missed updates to sender identification using ripgrep without file type filter
rg -i "senderAddress|senderInbox"

Length of output: 10805

Copy link
Contributor

github-actions bot commented Dec 19, 2024

Performance Comparison Report

  • Current: dc03a5f - 2024-12-19 22:42:13Z
  • Baseline: release/3.0.0 (a4ada0c) - 2024-12-19 22:40:53Z

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Type Duration Count
Avatar Image 10 runs render 1.1 ms → 1.4 ms (+0.3 ms, +27.3%) 🔴 1 → 1
Avatar Image 50 runs render 1.0 ms → 1.1 ms (+0.1 ms, +11.8%) 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.8 ms → 0.9 ms (+0.1 ms, +13.2%) 1 → 1
Text Component with color prop - 10 runs render 0.2 ms → 0.2 ms 1 → 1
Text Component with default props - 10 runs render 0.5 ms → 0.1 ms (-0.4 ms, -80.0%) 🟢 1 → 1
Text Component with translation key - 10 runs render 0.2 ms → 0.3 ms (+0.1 ms, +50.0%) 🔴 1 → 1
Text Component with weight and size - 10 runs render 0.1 ms → 0.1 ms 1 → 1
Show details
Name Type Duration Count
Avatar Image 10 runs render Baseline
Mean: 1.1 ms
Stdev: 0.6 ms (51.6%)
Runs: 2 1 1 1 1 2 1 1 1 0
Warmup runs: 2

Current
Mean: 1.4 ms
Stdev: 0.5 ms (36.9%)
Runs: 1 1 1 2 1 2 2 1 2 1
Warmup runs: 2
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.0 ms
Stdev: 0.2 ms (24.2%)
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 2 1 2 1 1 1 1 1 1 1 1 1 1 1 1 0 1 1 1 1 1 1 1 1 1
Warmup runs: 1

Current
Mean: 1.1 ms
Stdev: 0.4 ms (30.7%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 2 2 1 2 1 1 1 1 1 1 2 1 1 2 1 1 1 1 1 1 2 1 1 1 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 1 0 1 1 1 1 2 1 1
Warmup runs: 3

Current
Mean: 0.9 ms
Stdev: 0.6 ms (63.1%)
Runs: 2 1 0 0 1 1 1 1 1 1
Warmup runs: 2
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.8 ms
Stdev: 0.4 ms (56.8%)
Runs: 1 1 1 1 0 1 1 1 1 1 1 1 1 1 1 1 0 1 1 0 0 0 1 0 1 1 0 1 0 1 0 0 1 1 1 1 1 1 1 0 1 1 1 1 1 1 0 1 1 1
Warmup runs: 1

Current
Mean: 0.9 ms
Stdev: 0.4 ms (40.8%)
Runs: 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 1 1 1 1 0 1 1 1 0 1 1 0 1 1 1 1 0 1 1 1 1 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:
Text Component with color prop - 10 runs render Baseline
Mean: 0.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 0 0 0 0 0 1 0 1 0 0
Warmup runs: 0

Current
Mean: 0.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 0 1 0 0 1 0 0 0 0 0
Warmup runs: 0
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:
Text Component with default props - 10 runs render Baseline
Mean: 0.5 ms
Stdev: 0.5 ms (105.4%)
Runs: 0 1 1 0 0 1 1 0 0 1
Warmup runs: 1

Current
Mean: 0.1 ms
Stdev: 0.3 ms (316.2%)
Runs: 0 0 0 1 0 0 0 0 0 0
Warmup runs: 0
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:
Text Component with translation key - 10 runs render Baseline
Mean: 0.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 1 0 0 0 1 0 0 0 0 0
Warmup runs: 1

Current
Mean: 0.3 ms
Stdev: 0.5 ms (161.0%)
Runs: 0 1 0 0 1 0 0 0 1 0
Warmup runs: 0
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:
Text Component with weight and size - 10 runs render Baseline
Mean: 0.1 ms
Stdev: 0.3 ms (316.2%)
Runs: 0 0 0 0 0 0 0 0 1 0
Warmup runs: 0

Current
Mean: 0.1 ms
Stdev: 0.3 ms (316.2%)
Runs: 0 0 1 0 0 0 0 0 0 0
Warmup runs: 0
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:

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 44be864

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: 0

🔭 Outside diff range comments (1)
features/GroupInvites/joinGroup/JoinGroup.client.ts (1)

Line range hint 315-317: Fix type inconsistencies in test fixtures.

There are several type-related issues in the test fixtures that should be addressed:

  1. Fix the incorrect variable reference:
- return fixtureGroupsDataEntity;
+ return fixtureConversationDataEntity;
  1. Align the return types:
- ): Promise<GroupsDataEntity> => {
+ ): Promise<ConversationDataEntity> => {
  1. Remove @ts-expect-error comments by properly typing the fixtures:
- // @ts-expect-error
- return fixtureGroupsDataEntity;
+ return {
+   ids: [GroupIdUserIsAlreadyAMemberOf],
+   byId: {
+     [GroupIdUserIsAlreadyAMemberOf]: conversationFixture,
+   },
+ } as ConversationDataEntity;

Also applies to: 386-388, 469-471

🧹 Nitpick comments (1)
features/GroupInvites/joinGroup/JoinGroup.client.ts (1)

Line range hint 132-196: Consider enhancing the polling mechanism.

The implementation is solid with good error handling and logging. However, consider these improvements:

  1. Implement exponential backoff instead of fixed intervals to reduce server load
  2. Make polling parameters configurable via options
  3. Add an overall timeout parameter separate from attempt count

Example implementation with exponential backoff:

- const GROUP_JOIN_REQUEST_POLL_INTERVAL_MS = 1000;
+ const BASE_POLL_INTERVAL_MS = 1000;
+ const MAX_POLL_INTERVAL_MS = 5000;

  while (attemptsToRetryJoinGroup < GROUP_JOIN_REQUEST_POLL_MAX_ATTEMPTS) {
    // ... existing code ...
-   await wait(GROUP_JOIN_REQUEST_POLL_INTERVAL_MS);
+   const backoffInterval = Math.min(
+     BASE_POLL_INTERVAL_MS * Math.pow(2, attemptsToRetryJoinGroup),
+     MAX_POLL_INTERVAL_MS
+   );
+   await wait(backoffInterval);
  }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1555d80 and 44be864.

📒 Files selected for processing (1)
  • features/GroupInvites/joinGroup/JoinGroup.client.ts (1 hunks)
🔇 Additional comments (1)
features/GroupInvites/joinGroup/JoinGroup.client.ts (1)

27-30: LGTM! Well-defined polling parameters.

The polling configuration with 10 attempts at 1-second intervals provides a reasonable balance between responsiveness and server load.

@thierryskoda
Copy link
Collaborator

does this fix .send is not a function?

should have been fixed in previous PR. You've seen it again?

@alexrisch alexrisch closed this Dec 19, 2024
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