-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
[WEB-2382]chore: notifications code improvement #6172
Conversation
WalkthroughThe changes in this pull request involve modifications to the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
web/core/store/notifications/workspace-notifications.store.ts
(2 hunks)
🔇 Additional comments (2)
web/core/store/notifications/workspace-notifications.store.ts (2)
53-53
: LGTM! Interface change maintains backward compatibility.
The addition of the optional newCount
parameter is well-designed, maintaining backward compatibility while enabling the new functionality for custom count updates.
288-297
: Verify usage patterns of setUnreadNotificationsCount.
Let's verify how this method is used across the codebase to ensure the changes won't cause unexpected behavior.
✅ Verification successful
Let me analyze the usage patterns more deeply by checking the implementation details of the notification handling.
Based on the gathered information, I can now provide a final response:
Changes to setUnreadNotificationsCount implementation are safe and properly used
The method is consistently used across the codebase with clear patterns:
- Decrements count when marking notifications as read
- Increments count when marking as unread or when read operations fail
- Used in both "ALL" and "MENTIONS" notification contexts
- All calls properly use the "increment"/"decrement" type parameter
The implementation maintains notification count accuracy by:
- Using atomic update operations
- Handling both total and mention-specific counts
- Properly synchronizing with backend state through notification services
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for all calls to setUnreadNotificationsCount
rg "setUnreadNotificationsCount" --type ts
# Look for potential patterns where notification counts are calculated
rg "unread.*notification.*count" --type ts
Length of output: 2908
Script:
#!/bin/bash
# Check the notification.ts file content to understand the context of setUnreadNotificationsCount usage
rg -A 5 "setUnreadNotificationsCount" web/core/store/notifications/notification.ts
# Check the update function implementation
ast-grep --pattern 'function update($_) {
$$$
}'
Length of output: 1166
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.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
web/core/store/notifications/workspace-notifications.store.ts (1)
293-303
: Consider minor improvements to the count handling.
- The
+
operator for type coercion is unnecessary asMath.max
already returns a number- Consider adding a comment explaining the validation logic
Here's the suggested improvement:
setUnreadNotificationsCount = (type: "increment" | "decrement", newCount: number = 1): void => { + // Ensure non-negative count by taking absolute value and applying floor of 0 const validCount = Math.max(0, Math.abs(newCount)); switch (this.currentNotificationTab) { case ENotificationTab.ALL: update( this.unreadNotificationsCount, "total_unread_notifications_count", - (count: number) => +Math.max(0, type === "increment" ? count + validCount : count - validCount) + (count: number) => Math.max(0, type === "increment" ? count + validCount : count - validCount) ); break; case ENotificationTab.MENTIONS: update( this.unreadNotificationsCount, "mention_unread_notifications_count", - (count: number) => +Math.max(0, type === "increment" ? count + validCount : count - validCount) + (count: number) => Math.max(0, type === "increment" ? count + validCount : count - validCount) ); break; default: break; } };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/modal.tsx
(0 hunks)web/core/store/notifications/workspace-notifications.store.ts
(2 hunks)
💤 Files with no reviewable changes (1)
- web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/modal.tsx
🔇 Additional comments (2)
web/core/store/notifications/workspace-notifications.store.ts (2)
53-53
: LGTM: Interface change looks good!
The optional parameter makes the interface backward compatible while adding flexibility for custom counts.
288-290
: Implementation addresses validation concerns.
The implementation correctly validates the count by:
- Using Math.abs() to handle negative inputs
- Using Math.max() to ensure non-negative results
* chore: adjusted increment/decrement for unread count * chore: improved param handling for unread notification count function
Description
Modified unread count update function to accept custom count.
Type of Change
References
WEB-2382
Summary by CodeRabbit
Summary by CodeRabbit