[WEB-2382]chore:notification snooze modal

[vamsikrishnamathala]

Summary

Modified types for snooze modal functions.

Reference

WEB-2382

Summary by CodeRabbit

• New Features

  • Enhanced the notification snooze functionality for improved user experience.
  • Updated the notifications sidebar component to improve visual structure.

• Bug Fixes

  • Streamlined the submission process in the notification snooze modal for clearer outcomes.

• Refactor

  • Updated the handling of asynchronous operations in the notification snooze process to improve efficiency.
  • Renamed the notifications sidebar component for consistency.

• Chores

  • Adjusted access modifiers in the notification store for better extensibility.
  • Re-exported entities from the notifications module for easier access.
  • Removed the outdated NotificationsSidebar export to streamline the codebase.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the onSubmit method in the TNotificationSnoozeModal type, changing its return type from a Promise<TNotification | undefined> to Promise<void>. This adjustment simplifies the submission process. Additionally, the handleNotificationSnoozeDate function in the NotificationItemSnoozeOption component has been updated to remove the response variable and its associated return statements, while retaining error handling. The constructor of the WorkspaceNotificationStore class has been modified to change the access modifier of the store parameter from private to protected. Furthermore, component renaming and import adjustments have been made for the notifications sidebar.

Changes

File	Change Summary
web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/modal.tsx	Updated onSubmit method signature to return Promise<void> instead of `Promise<TNotification
web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/root.tsx	Removed response variable and return statements in handleNotificationSnoozeDate, while keeping error handling intact.
web/core/store/notifications/workspace-notifications.store.ts	Changed access modifier of store parameter in WorkspaceNotificationStore constructor from private to protected.
web/app/[workspaceSlug]/(projects)/notifications/layout.tsx	Replaced NotificationsSidebar with NotificationsSidebarRoot in the layout component.
web/ce/components/workspace-notifications/root.tsx	Renamed exported component from NotificationsSidebar to NotificationsSidebarRoot.
web/ee/components/workspace-notifications/index.ts	Added export statement to re-export all entities from ce/components/workspace-notifications.
web/ee/components/workspace-notifications/root.tsx	Deleted file containing export for NotificationsSidebar, removing its availability for import.

Possibly related PRs

• [WEB-2333] chore: intake issue back date snooze disabled #5888: The changes in this PR involve disabling the ability to select backdated snooze dates in the InboxIssueSnoozeModal, which relates to the handling of notifications and user interactions with snooze functionality.
• [WEB-2382]chore:notifications file rearranging #6110: This PR involves rearranging notification-related files, which may impact the organization of components that handle notifications, including those related to snoozing notifications.
• [WEB-2770] fix: inbox issue detail loader on focus change #6074: This PR addresses the loading behavior of inbox issue details, which could be relevant to how notifications are displayed or interacted with in the context of the inbox.
• [WEB-2380] chore: cycle sidebar refactor #5759: This PR refactors the cycle sidebar, which may indirectly relate to how notifications are managed or displayed in the sidebar context.
• WEB-2381 Chore: intake refactor #5752: This PR introduces enhancements to the intake system, which may include notifications related to issue submissions and their management.
• [WEB-2709] chore: intake issue navigation improvement #5891: This PR focuses on improving navigation for intake issues, which could involve notifications related to those issues.
• [WEB-2401] chore: worklog enhancements #5982: This PR enhances the worklog functionality, which may include notifications related to time logging on issues.
• chore: code refactor #5952: This PR involves a code refactor that may impact how notifications are handled in the context of duplicate issues.

Suggested labels

🧹chore

Suggested reviewers

• SatishGandham
• rahulramesha

🐰 In the garden where the bunnies play,
A modal change has brightened the day.
With snooze now simpler, no waits in line,
Our notifications hop, all feeling fine!
Protected stores, a leap to the sky,
Let's celebrate these changes, oh my! 🌼✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 11c5937 and c0d2cd6.

📒 Files selected for processing (1)

• web/core/store/notifications/workspace-notifications.store.ts (2 hunks)

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

• web/core/store/notifications/workspace-notifications.store.ts

---

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.

[coderabbitai]

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 b1c340b and c3c5d65.

📒 Files selected for processing (3)

• web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/modal.tsx (1 hunks)
• web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/root.tsx (1 hunks)
• web/core/store/notifications/workspace-notifications.store.ts (1 hunks)

🔇 Additional comments (2)

web/core/components/workspace-notifications/sidebar/notification-card/options/snooze/modal.tsx (1)

20-20: LGTM! Type signature simplification

The change to return Promise is a good simplification as the notification update is handled through the store, and the return value wasn't being used.

web/core/store/notifications/workspace-notifications.store.ts (1)

87-87: LGTM! Enhanced extensibility

Changing the store parameter from private to protected is a good improvement that enables better extensibility through inheritance while maintaining proper encapsulation.

[coderabbitai]

⚠️ Potential issue

Fix inconsistent async/await usage

The async handling is inconsistent between snooze and unsnooze operations. Line 37 doesn't await the snoozeNotification call while line 48 awaits unSnoozeNotification. This could lead to misleading success messages if the operation fails.

Apply this fix to ensure consistent async handling:

-snoozeNotification(workspaceSlug, snoozeTill);
+await snoozeNotification(workspaceSlug, snoozeTill);

Also applies to: 48-48