Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

Fix omitted Favorites filter in cache queries and optimistic updates (#6795)

Sean Aye4baabdfa695e
diff --git a/apps/web/src/lib/queries/favorites/graphql.test.tsx b/apps/web/src/lib/queries/favorites/graphql.test.tsx
index 2174648ecc..5e62ba68fc 100644
--- a/apps/web/src/lib/queries/favorites/graphql.test.tsx
+++ b/apps/web/src/lib/queries/favorites/graphql.test.tsx
@@ -330,9 +330,13 @@ describe('GraphQL favorites queries', () => {
expect(onSuccess).toHaveBeenCalledWith(result, input, undefined);
expect(onSettled).toHaveBeenCalledWith(result, null, input, undefined);
expect(executeQuery).toHaveBeenCalledOnce();
+ expect(
+ executeMutation.mock.calls[0]?.[2]?.normalizedCacheOptimistic
+ .revalidations
+ ).toEqual([expect.objectContaining({ variablesJson: '{"filter":null}' })]);
});
- it('projects the live GraphQL list in normalized sort order', async () => {
+ it('projects the unfiltered list using an explicit null cache variable', async () => {
const query = renderHook(() => createGraphqlFavoritesQuery());
await vi.waitFor(() => expect(query.isSuccess).toBe(true));
@@ -345,7 +349,7 @@ describe('GraphQL favorites queries', () => {
fileType: 'md',
});
expect(executeQuery).toHaveBeenCalledWith(
- expect.objectContaining({ variables: {} }),
+ expect.objectContaining({ variables: { filter: null } }),
{ requestPolicy: 'cache-and-network' }
);
});
@@ -396,7 +400,7 @@ describe('GraphQL favorites queries', () => {
]);
expect(optimistic.revalidations).toEqual(
expect.arrayContaining([
- expect.objectContaining({ variablesJson: '{}' }),
+ expect.objectContaining({ variablesJson: '{"filter":null}' }),
expect.objectContaining({
variablesJson: '{"filter":{"entityTypes":["DOCUMENT"]}}',
}),
@@ -404,6 +408,44 @@ describe('GraphQL favorites queries', () => {
);
});
+ it.each([
+ {
+ createMutation: createGraphqlAddFavoriteMutation,
+ patchKind: 'prependUnique',
+ },
+ {
+ createMutation: createGraphqlRemoveFavoriteMutation,
+ patchKind: 'remove',
+ },
+ ])(
+ 'uses the unfiltered query variables for $patchKind and revalidation',
+ async ({ createMutation, patchKind }) => {
+ const hooks = renderHook(() => ({
+ query: createGraphqlFavoritesQuery(),
+ mutation: createMutation(),
+ }));
+ await vi.waitFor(() => expect(hooks.query.isSuccess).toBe(true));
+
+ await hooks.mutation.mutateAsync({
+ entityType: 'document',
+ entityId: 'document-1',
+ });
+
+ const optimistic =
+ executeMutation.mock.calls[0]?.[2]?.normalizedCacheOptimistic;
+ expect(optimistic.linkPatches).toEqual([
+ expect.objectContaining({
+ variablesJson: '{"filter":null}',
+ operation: expect.objectContaining({ kind: patchKind }),
+ }),
+ ]);
+ // The default target and mounted unfiltered query must deduplicate.
+ expect(optimistic.revalidations).toEqual([
+ expect.objectContaining({ variablesJson: '{"filter":null}' }),
+ ]);
+ }
+ );
+
it('refetches the urql-solid list after setting a favorite', async () => {
const onSuccess = vi.fn();
const hooks = renderHook(() => ({
@@ -522,6 +564,9 @@ describe('GraphQL favorites queries', () => {
expect(executeMutation.mock.calls[0]?.[2]).toEqual({
normalizedCacheOptimistic: expect.objectContaining({
linkPatches: [],
+ revalidations: [
+ expect.objectContaining({ variablesJson: '{"filter":null}' }),
+ ],
}),
});
});
diff --git a/apps/web/src/lib/queries/favorites/graphql.ts b/apps/web/src/lib/queries/favorites/graphql.ts
index 5e2ab13dd5..5d6bf96ba3 100644
--- a/apps/web/src/lib/queries/favorites/graphql.ts
+++ b/apps/web/src/lib/queries/favorites/graphql.ts
@@ -25,6 +25,7 @@ import {
type ReorderFavoritesResult,
type SetFavoriteArgs,
toGraphqlFavoriteEntityType,
+ UNFILTERED_FAVORITES_VARIABLES,
} from '@service-storage/graphql-favorites';
import { getGraphqlSoupClient } from '@service-storage/graphql-soup';
import type { AnyVariables, Client, OperationResult } from '@urql/core';
@@ -64,7 +65,7 @@ function favoritesQueryVariables(
entityIds: filter.entityId,
},
}
- : {};
+ : UNFILTERED_FAVORITES_VARIABLES;
}
function favoriteMatchesFilter(
@@ -81,7 +82,10 @@ function activeFavoritesCacheTargets(
favorite?: SetFavoriteArgs
): FavoritesCacheTarget[] {
const targets = new Map<string, FavoritesCacheTarget>([
- [JSON.stringify({}), { variables: {}, updateCachedList: false }],
+ [
+ JSON.stringify(UNFILTERED_FAVORITES_VARIABLES),
+ { variables: UNFILTERED_FAVORITES_VARIABLES, updateCachedList: false },
+ ],
]);
for (const active of activeFavoritesQueries) {
if (favorite && !favoriteMatchesFilter(favorite, active.filter)) continue;
diff --git a/apps/web/src/lib/service-clients/service-storage/graphql-favorites.test.ts b/apps/web/src/lib/service-clients/service-storage/graphql-favorites.test.ts
index ff1aa0fe24..5d8a5b5749 100644
--- a/apps/web/src/lib/service-clients/service-storage/graphql-favorites.test.ts
+++ b/apps/web/src/lib/service-clients/service-storage/graphql-favorites.test.ts
@@ -53,7 +53,7 @@ const revalidations = [
{
query: stringifyDocument(FavoritesDocument),
operationName: 'Favorites',
- variablesJson: '{}',
+ variablesJson: '{"filter":null}',
},
];
@@ -97,7 +97,7 @@ describe('favorites GraphQL mutations', () => {
{
query: stringifyDocument(FavoritesDocument),
operationName: 'Favorites',
- variablesJson: '{}',
+ variablesJson: '{"filter":null}',
path: [{ field: 'user' }, { field: 'favorites' }],
operation: {
kind: patchKind,
diff --git a/apps/web/src/lib/service-clients/service-storage/graphql-favorites.ts b/apps/web/src/lib/service-clients/service-storage/graphql-favorites.ts
index 2f0567bc5e..9e249f9c24 100644
--- a/apps/web/src/lib/service-clients/service-storage/graphql-favorites.ts
+++ b/apps/web/src/lib/service-clients/service-storage/graphql-favorites.ts
@@ -100,6 +100,12 @@ export type SetFavoriteArgs = {
entityId: string;
};
+/** Explicit null keeps unfiltered reads, link patches, and revalidations on the
+ * same cache field; the cache cannot resolve an omitted optional variable. */
+export const UNFILTERED_FAVORITES_VARIABLES = {
+ filter: null,
+} satisfies FavoritesQueryVariables;
+
export type FavoritesCacheTarget = {
variables: FavoritesQueryVariables;
updateCachedList: boolean;
@@ -112,7 +118,7 @@ export function executeGraphqlSetFavoriteMutation(
favorite: boolean,
optimisticSortOrder: number,
cacheTargets: readonly FavoritesCacheTarget[] = [
- { variables: {}, updateCachedList: true },
+ { variables: UNFILTERED_FAVORITES_VARIABLES, updateCachedList: true },
]
): Promise<OperationResult<SetFavoriteMutation, SetFavoriteMutationVariables>> {
const entityType = toGraphqlFavoriteEntityType(args.entityType);
@@ -211,7 +217,9 @@ export type ReorderFavoritesResult =
export function executeGraphqlReorderFavoritesMutation(
client: Client,
args: ReorderFavoritesRequest,
- revalidationVariables: readonly FavoritesQueryVariables[] = [{}]
+ revalidationVariables: readonly FavoritesQueryVariables[] = [
+ UNFILTERED_FAVORITES_VARIABLES,
+ ]
): Promise<
OperationResult<ReorderFavoritesMutation, ReorderFavoritesMutationVariables>
> {