mirror/api
1
0
Fork 0
mirror of https://github.com/unraid/api.git synced 2026-01-01 06:01:18 -06:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Pujit Mehrotra
2024-12-13 12:28:56 -05:00
committed by GitHub
parent ef82ec5af5
commit 29d9371cc3
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
web/helpers/apollo-cache/index.ts
View File

@@ -1,5 +1,8 @@
import { InMemoryCache, type InMemoryCacheConfig } from '@apollo/client/core/index.js'; import { InMemoryCache, type InMemoryCacheConfig } from '@apollo/client/core/index.js';
import { getNotifications } from '~/components/Notifications/graphql/notification.query'; import {
getNotifications,
notificationsOverview,
} from '~/components/Notifications/graphql/notification.query';
import { NotificationType, type NotificationOverview } from '~/composables/gql/graphql'; import { NotificationType, type NotificationOverview } from '~/composables/gql/graphql';
import { NotificationType as NotificationCacheType } from '~/composables/gql/typename'; import { NotificationType as NotificationCacheType } from '~/composables/gql/typename';
import { mergeAndDedup } from './merge'; import { mergeAndDedup } from './merge';
@@ -109,6 +112,7 @@ const defaultCacheConfig: InMemoryCacheConfig = {
}, },
archiveNotification: { archiveNotification: {
/** /**
* Optimistically decrements unread total from overview &
* Ensures newly archived notifications appear in the archive list without a page reload. * Ensures newly archived notifications appear in the archive list without a page reload.
* *
* When a notification is archived, we need to evict the cached archive list to force a refetch. * When a notification is archived, we need to evict the cached archive list to force a refetch.
@@ -119,11 +123,13 @@ const defaultCacheConfig: InMemoryCacheConfig = {
* Note: This may cause temporary jitter with infinite scroll. * Note: This may cause temporary jitter with infinite scroll.
* *
* This function: * This function:
* 1. Checks if the cache has an archive list. If not, this function is a no-op. *
* 2. If the list has items, evicts just the archive list * 1. Optimistically updates notification overview
* 3. If it is empty, evicts the entire notifications cache * 2. Checks if the cache has an archive list. If not, this function is a no-op.
* 4. Runs garbage collection to clean up orphaned references * 3. If the list has items, evicts just the archive list
* 5. Returns the original mutation result * 4. If it is empty, evicts the entire notifications cache
* 5. Runs garbage collection to clean up orphaned references
* 6. Returns the original mutation result
* *
* @param _ - Existing cache value (unused) * @param _ - Existing cache value (unused)
* @param incoming - Result (i.e. the archived notification) from the server after archiving * @param incoming - Result (i.e. the archived notification) from the server after archiving
@@ -131,6 +137,13 @@ const defaultCacheConfig: InMemoryCacheConfig = {
* @returns The incoming result to be cached * @returns The incoming result to be cached
*/ */
merge(_, incoming, { cache }) { merge(_, incoming, { cache }) {
cache.updateQuery({ query: notificationsOverview }, (data) => {
if (!data) return;
const update = structuredClone(data);
update.notifications.overview.unread.total--;
return update;
});
const archiveQuery = cache.readQuery({ const archiveQuery = cache.readQuery({
query: getNotifications, query: getNotifications,
// @ts-expect-error the cache only uses the filter type; the limit & offset are superfluous. // @ts-expect-error the cache only uses the filter type; the limit & offset are superfluous.
@@ -147,7 +160,6 @@ const defaultCacheConfig: InMemoryCacheConfig = {
args: { filter: { type: NotificationType.Archive } }, args: { filter: { type: NotificationType.Archive } },
}); });
} }
cache.gc(); cache.gc();
return incoming; return incoming;
}, },