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

[WEB-2382]chore: notifications code improvement #6172

Merged
merged 2 commits into from
Dec 9, 2024

Conversation

vamsikrishnamathala
Copy link
Collaborator

@vamsikrishnamathala vamsikrishnamathala commented Dec 9, 2024

Description

Modified unread count update function to accept custom count.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

References

WEB-2382

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Enhanced unread notifications management by allowing flexible increment or decrement counts.
  • Bug Fixes
    • Improved consistency in updating total and mention unread notifications counts across different tabs.
  • Chores
    • Removed unused type import from the Notification Snooze Modal component.

Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in this pull request involve modifications to the setUnreadNotificationsCount method in the IWorkspaceNotificationStore interface and its implementation in the WorkspaceNotificationStore class. An optional parameter newCount of type number has been added, allowing for flexible adjustments to the unread notifications count. This update replaces the previous hardcoded increment and decrement values, enabling the method to specify how many notifications to adjust. Additionally, an unused type import was removed from the NotificationSnoozeModal component.

Changes

File Path Change Summary
web/core/store/notifications/workspace-notifications.store.ts Updated setUnreadNotificationsCount method signature to include an optional newCount parameter for flexible updates.
web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/modal.tsx Removed unused import of TNotification from @plane/types.

Possibly related PRs

Suggested labels

🧹chore

Suggested reviewers

  • SatishGandham
  • rahulramesha

🐇 In the realm of notifications bright,
A method changed to bring delight.
With counts that flex to fit the need,
Unread alerts, we now can heed!
So hop along, let updates flow,
In our workspace, watch the numbers grow! 🌟


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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 547c138 and c9a8e8f.

📒 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

@vamsikrishnamathala vamsikrishnamathala marked this pull request as draft December 9, 2024 12:21
@vamsikrishnamathala vamsikrishnamathala marked this pull request as ready for review December 9, 2024 12:25
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 and nitpick comments (1)
web/core/store/notifications/workspace-notifications.store.ts (1)

293-303: Consider minor improvements to the count handling.

  1. The + operator for type coercion is unnecessary as Math.max already returns a number
  2. 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

📥 Commits

Reviewing files that changed from the base of the PR and between c9a8e8f and bf57d9e.

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

  1. Using Math.abs() to handle negative inputs
  2. Using Math.max() to ensure non-negative results

@SatishGandham SatishGandham merged commit d046194 into preview Dec 9, 2024
21 of 22 checks passed
@SatishGandham SatishGandham deleted the chore-notifications_stacked branch December 9, 2024 12:37
nishantPFM pushed a commit to Pocket-Fm/plane that referenced this pull request Dec 12, 2024
* chore: adjusted  increment/decrement  for unread count

* chore: improved param handling for unread notification count function
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟enhancement New feature or request 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants