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: Adding logs #1391

Merged
merged 1 commit into from
Dec 19, 2024
Merged

fix: Adding logs #1391

merged 1 commit into from
Dec 19, 2024

Conversation

alexrisch
Copy link
Contributor

@alexrisch alexrisch commented Dec 19, 2024

Adding logs and typesafety

Summary by CodeRabbit

  • New Features

    • Enhanced data fetching for group members in the Group Screen.
    • Improved error handling for group member retrieval.
  • Bug Fixes

    • Added checks to prevent runtime errors related to group member functions.
  • Documentation

    • Updated prop types for better type enforcement in the GroupScreenMembersTable.

Adding logs and typesafety
@alexrisch alexrisch requested a review from a team as a code owner December 19, 2024 16:09
Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request introduces changes to two files: GroupScreenMembersTable.tsx and useGroupConversationListAvatarInfo.ts. In GroupScreenMembersTable.tsx, the topic prop is now required, and a new query hook useGroupMembersConversationScreenQuery is implemented to fetch group members. The useGroupConversationListAvatarInfo.ts file adds an import for Group and includes additional error handling when accessing group.members.

Changes

File Change Summary
containers/GroupScreenMembersTable.tsx - Changed topic prop from optional to required
- Added new query hook useGroupMembersConversationScreenQuery
- Updated members data retrieval and processing logic
features/conversation-list/useGroupConversationListAvatarInfo.ts - Added Group import
- Added error checking for group.members function

Sequence Diagram

sequenceDiagram
    participant Component as GroupScreenMembersTable
    participant Query as useGroupMembersConversationScreenQuery
    participant Profiles as useInboxProfilesSocials

    Component->>Query: Fetch members with currentAccount and topic
    Query-->>Component: Return members data
    Component->>Component: Create memberInboxIds
    Component->>Profiles: Pass memberInboxIds
    Profiles-->>Component: Return profile information
Loading

Possibly related PRs

Suggested labels

2.0.7

Suggested reviewers

  • thierryskoda
  • technoplato

Poem

🐰 Hopping through code with glee,
Members queried, data now free!
Type checks tight, no more undefined,
A rabbit's refactor, precisely designed! 🔍
Group screens dancing, queries so bright! 🌟


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

🧹 Nitpick comments (2)
features/conversation-list/useGroupConversationListAvatarInfo.ts (1)

25-30: Enhance error logging with more context

While the type check is good, the error log could be more descriptive to aid debugging.

-        logger.error(
-          `Group members is not a function instance of group is ${group instanceof Group}`
-        );
+        logger.error(
+          `Invalid group.members type`, {
+            isFunction: typeof group.members === "function",
+            instanceType: group instanceof Group,
+            groupType: typeof group,
+            topic: group.topic
+          }
+        );
containers/GroupScreenMembersTable.tsx (1)

Line range hint 115-159: Refactor duplicate error handling

The error handling pattern is repeated across multiple catch blocks. Consider extracting it into a reusable function.

+ const handleMemberActionError = (action: string, e: unknown, memberId: string) => {
+   logger.error(`Failed to ${action} member`, {
+     error: e,
+     memberId,
+     topic
+   });
+   captureErrorWithFriendlyToast(e);
+ };

// Then in catch blocks:
- catch (e) {
-   logger.error(e);
-   captureErrorWithFriendlyToast(e);
- }
+ catch (e) {
+   handleMemberActionError('promote to super admin', e, a.inboxId);
+ }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d25c8b2 and 5bb964e.

📒 Files selected for processing (2)
  • containers/GroupScreenMembersTable.tsx (2 hunks)
  • features/conversation-list/useGroupConversationListAvatarInfo.ts (2 hunks)
🔇 Additional comments (2)
features/conversation-list/useGroupConversationListAvatarInfo.ts (1)

1-1: Verify type migration strategy

The change from GroupWithCodecsType to Group type suggests a migration towards using SDK types. However, the function still accepts GroupWithCodecsType in its signature (line 13), which could lead to type inconsistencies.

Also applies to: 9-9

containers/GroupScreenMembersTable.tsx (1)

32-32: Good type safety improvement with required topic

Making the topic prop required is a good type safety improvement. However, group is still marked as possibly undefined or null while being used throughout the component.

Also applies to: 33-33

Comment on lines +41 to +44
const { data: members } = useGroupMembersConversationScreenQuery(
currentAccount,
topic
);
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add error handling for query failures

The query implementation is good, but there's no handling of query errors which could affect the component's functionality.

-    const { data: members } = useGroupMembersConversationScreenQuery(
+    const { data: members, error } = useGroupMembersConversationScreenQuery(
       currentAccount,
       topic
     );
+    
+    useEffect(() => {
+      if (error) {
+        logger.error('Failed to fetch group members', { error, topic });
+        captureErrorWithFriendlyToast(error);
+      }
+    }, [error, topic]);
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const { data: members } = useGroupMembersConversationScreenQuery(
currentAccount,
topic
);
const { data: members, error } = useGroupMembersConversationScreenQuery(
currentAccount,
topic
);
useEffect(() => {
if (error) {
logger.error('Failed to fetch group members', { error, topic });
captureErrorWithFriendlyToast(error);
}
}, [error, topic]);

Copy link
Contributor

Performance Comparison Report

  • Current: c1212aa - 2024-12-19 16:14:57Z
  • Baseline: release/3.0.0 (d25c8b2) - 2024-12-19 16:13:36Z

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.0 ms (-0.1 ms, -9.1%) 1 → 1
Avatar Image 50 runs render 1.1 ms → 1.2 ms (+0.1 ms, +5.4%) 1 → 1
Empty Avatar 10 runs render 0.9 ms → 0.9 ms 1 → 1
Empty Avatar 50 runs render 0.8 ms → 0.8 ms (+0.0 ms, +5.3%) 1 → 1
Text Component with color prop - 10 runs render 0.1 ms → 0.1 ms 1 → 1
Text Component with default props - 10 runs render 0.6 ms → 0.4 ms (-0.2 ms, -33.3%) 🟢 1 → 1
Text Component with translation key - 10 runs render 0.2 ms → 0.0 ms (-0.2 ms, -100.0%) 🟢 1 → 1
Text Component with weight and size - 10 runs render 0.2 ms → 0.2 ms 1 → 1
Show details
Name Type Duration Count
Avatar Image 10 runs render Baseline
Mean: 1.1 ms
Stdev: 0.3 ms (28.7%)
Runs: 1 1 1 1 1 1 2 1 1 1
Warmup runs: 3

Current
Mean: 1.0 ms
Stdev: 0.0 ms (0.0%)
Runs: 1 1 1 1 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:
Avatar Image 50 runs render Baseline
Mean: 1.1 ms
Stdev: 0.6 ms (49.9%)
Runs: 1 1 1 1 1 2 1 1 1 1 1 1 2 1 1 1 1 1 1 2 1 1 0 4 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 1 2 1 1 1 1 2 1 1 1
Warmup runs: 1

Current
Mean: 1.2 ms
Stdev: 0.5 ms (40.8%)
Runs: 1 2 1 1 2 2 1 0 2 1 1 2 0 2 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 2 2 2 1 1 1 1 2 1 1 1 1 2 1 1 1 1 1 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: 0.9 ms
Stdev: 0.3 ms (35.1%)
Runs: 1 1 1 1 1 0 1 1 1 1
Warmup runs: 3

Current
Mean: 0.9 ms
Stdev: 0.6 ms (63.1%)
Runs: 1 1 0 1 2 1 0 1 1 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:
Empty Avatar 50 runs render Baseline
Mean: 0.8 ms
Stdev: 0.4 ms (56.8%)
Runs: 1 1 1 1 1 0 0 0 0 1 1 0 1 1 1 1 0 1 1 1 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 1 1 0 0 1 1 1 1 0 1 1 1 1 0
Warmup runs: 1

Current
Mean: 0.8 ms
Stdev: 0.4 ms (50.5%)
Runs: 1 1 1 0 1 1 0 0 1 0 1 1 1 1 1 1 1 0 1 1 0 1 0 1 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 1 1 0 1 1 1 1 1 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:
Text Component with color prop - 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: 1 0 0 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:
Text Component with default props - 10 runs render Baseline
Mean: 0.6 ms
Stdev: 0.5 ms (86.1%)
Runs: 1 0 1 1 1 1 0 0 0 1
Warmup runs: 1

Current
Mean: 0.4 ms
Stdev: 0.5 ms (129.1%)
Runs: 0 1 0 1 0 0 1 0 1 0
Warmup runs: 1
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: 0 0 0 0 0 0 1 1 0 0
Warmup runs: 1

Current
Mean: 0.0 ms
Stdev: 0.0 ms (NaN%)
Runs: 0 0 0 0 0 0 0 0 0 0
Warmup runs: 1
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.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 0 1 0 0 1 0 0 0 0 0
Warmup runs: 0

Current
Mean: 0.2 ms
Stdev: 0.4 ms (210.8%)
Runs: 0 0 0 1 0 1 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 5bb964e

@alexrisch alexrisch merged commit 0e9fe34 into release/3.0.0 Dec 19, 2024
6 checks passed
@alexrisch alexrisch deleted the ar/groups-members-logs branch December 19, 2024 16:22
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.

2 participants