fix(web): edge case where archived notifications don't appear #978

pujitm · 2024-12-11T17:11:45Z

if the archive has already been fetched/loaded.

Summary by CodeRabbit

New Features
- Enhanced cache management for notifications, ensuring immediate visibility of archived notifications.
- Improved handling of incoming notifications without requiring a page refresh.
Bug Fixes
- Improved consistency in notification handling by updating the delete functionality to align with new cache types.
Documentation
- Added comments for clarity on cache management processes.

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1208947930278994

if the archive has already been fetched/loaded.

coderabbitai · 2024-12-11T17:11:55Z

Walkthrough

The changes in this pull request focus on enhancing cache management for notifications within the Apollo Client setup in the web/helpers/apollo-cache/index.ts file. Key modifications include the addition of the getNotifications import for the new archiveNotification field under Mutation, which features a merge function to manage archived notifications. The deletion logic is updated to use NotificationCacheType, ensuring consistent type usage. Overall, the changes refine how notification states are managed and displayed.

Changes

File Path	Change Summary
web/helpers/apollo-cache/index.ts	- Added `merge(_, incoming, { cache })` for `archiveNotification` under `Mutation`.
	- Renamed `NotificationType` to `NotificationCacheType`.
	- Enhanced cache management for notifications, updating logic for archiving and deletion.
	- Minor formatting adjustments and comments for clarity.

Possibly related PRs

feat(web): delete notifications from archive view #941: Modifies the deleteNotification mutation, directly related to changes in the deleteNotification merge function.
feat(web): notification settings link & delete all button #962: Introduces a new deleteAllNotifications mutation, relevant to cache management for notifications.
feat(web): add loading and error states to notification sidebar #974: Enhances the notification sidebar with loading and error states, connecting to user experience improvements in notification management.
feat(web): add count labels to notification tabs #975: Adds count labels to notification tabs, complementing the notification management features being enhanced in the main PR.
feat(web): move notification indicator icons to top-right of bell icon #977: Focuses on improving the accessibility of notification indicators, relevant to overall user experience improvements in notification handling.

Suggested reviewers

mdatelle
zackspear

🐰 In the cache where notifications dwell,
New merges and types work quite well.
Archiving with grace,
Users see the new face,
Of updates that ring like a bell! 🎉

🪧 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. (Experiment)
@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

🧹 Outside diff range and nitpick comments (1)

web/helpers/apollo-cache/index.ts (1)
150-151: Consider compatibility of 'structuredClone' for deep cloning

structuredClone is a relatively new API and may not be supported in all environments. Consider using an alternative method for deep cloning to ensure broader compatibility.

Alternative approach using a utility library:
import cloneDeep from 'lodash/cloneDeep';

// ...

const updated = cloneDeep(data);
Or using JSON methods (if the data is serializable):
const updated = JSON.parse(JSON.stringify(data));

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f320a77 and 133053f.

📒 Files selected for processing (1)

web/helpers/apollo-cache/index.ts (4 hunks)

🔇 Additional comments (3)

web/helpers/apollo-cache/index.ts (3)

1-7: Imports are appropriately updated for enhanced cache management

The added imports and type alias improve clarity and support the new cache functionality for handling notifications.

145-145: Verify that 'NotificationType.Archive' is correctly referenced

Ensure that NotificationType.Archive is properly imported and corresponds to the correct value used for filtering archived notifications.

172-172: Consistent use of 'NotificationCacheType' in cache operations

Great job updating the __typename to NotificationCacheType when identifying the cache entry. This ensures accurate eviction of the notification from the cache.

web/helpers/apollo-cache/index.ts

github-actions · 2024-12-11T17:15:50Z

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL: https://preview.dl.unraid.net/unraid-api/pr/978/dynamix.unraid.net.staging.plg

mdatelle

Just this nit pick

web/helpers/apollo-cache/index.ts

…y modifying cache

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

web/helpers/apollo-cache/index.ts (1)

137-137: Remove @ts-expect-error by properly typing the query variables

Instead of suppressing the TypeScript error, consider creating proper types for the query variables.

-            // @ts-expect-error the cache only uses the filter type; the limit & offset are superfluous.
-            variables: { filter: { type: NotificationType.Archive } },
+            variables: {
+              filter: { type: NotificationType.Archive },
+              limit: 1,  // Add minimum required fields
+              offset: 0
+            },

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0a2c07c and 4adf354.

📒 Files selected for processing (1)

web/helpers/apollo-cache/index.ts (4 hunks)

🔇 Additional comments (4)

web/helpers/apollo-cache/index.ts (4)

2-4: LGTM: Import changes are appropriate

The new imports support the archive notification functionality and improve type consistency.

64-66: LGTM: Clear and helpful documentation

The added documentation effectively explains the cache busting behavior and its impact on the user experience.

133-153: Verify the impact of cache eviction on UI stability

While the implementation addresses the archived notifications visibility issue, there are a few concerns to consider:

The complete cache eviction when the archive list is empty (line 142) might cause unnecessary refetches of unrelated notification data.
As noted in the comments, this may cause temporary jitter with infinite scroll.

Consider implementing a more targeted cache update strategy to minimize UI disruption.

168-169: LGTM: Improved type consistency

The change to use NotificationCacheType aligns with the correct type for cache operations.

web/helpers/apollo-cache/index.ts

github-actions · 2024-12-11T20:33:36Z

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL: https://preview.dl.unraid.net/unraid-api/pr/978/dynamix.unraid.net.staging.plg

fix(web): edge case where archived notifications don't appear

133053f

if the archive has already been fetched/loaded.

pujitm temporarily deployed to production December 11, 2024 17:11 — with GitHub Actions Inactive

coderabbitai bot reviewed Dec 11, 2024

View reviewed changes

web/helpers/apollo-cache/index.ts Outdated Show resolved Hide resolved

pujitm requested review from mdatelle and zackspear December 11, 2024 17:23

mdatelle reviewed Dec 11, 2024

View reviewed changes

web/helpers/apollo-cache/index.ts Outdated Show resolved Hide resolved

pujitm temporarily deployed to production December 11, 2024 20:25 — with GitHub Actions Inactive

pujitm force-pushed the fix/notif-archive branch from 0a2c07c to 41bbc9b Compare December 11, 2024 20:29

pujitm had a problem deploying to production December 11, 2024 20:29 — with GitHub Actions Error

refactor(web): evict notification list on archival instead of manuall…

4adf354

…y modifying cache

pujitm force-pushed the fix/notif-archive branch from 41bbc9b to 4adf354 Compare December 11, 2024 20:29

pujitm temporarily deployed to production December 11, 2024 20:30 — with GitHub Actions Inactive

coderabbitai bot reviewed Dec 11, 2024

View reviewed changes

web/helpers/apollo-cache/index.ts Show resolved Hide resolved

mdatelle approved these changes Dec 11, 2024

View reviewed changes

pujitm merged commit cda5d74 into main Dec 11, 2024
9 checks passed

pujitm deleted the fix/notif-archive branch December 11, 2024 21:32

This was referenced Dec 12, 2024

feat(web): rm old notification bell upon plugin installation #979

Merged

fix(web): update unread total immediately upon archiving #982

Merged

refactor(api): delete only archived notifications in deleteAll #983

Merged

This was referenced Jul 22, 2025

chore: Remove legacy store modules and add new API key and reporting services #1536

Merged

feat: add ups monitoring to graphql api #1526

Merged

coderabbitai bot mentioned this pull request Jul 31, 2025

Feat/mothership v2 #1551

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(web): edge case where archived notifications don't appear #978

fix(web): edge case where archived notifications don't appear #978

Uh oh!

pujitm commented Dec 11, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

github-actions bot commented Dec 11, 2024

Uh oh!

mdatelle left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

github-actions bot commented Dec 11, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

fix(web): edge case where archived notifications don't appear #978

fix(web): edge case where archived notifications don't appear #978

Uh oh!

Conversation

pujitm commented Dec 11, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Dec 11, 2024

Uh oh!

mdatelle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Dec 11, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pujitm commented Dec 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)