Files
twenty/packages/twenty-front/src/modules/activities/hooks/useCustomResolver.ts
T
Charles Bochet 9e21e55db4 Prevent leak between /metadata and /graphql GQL schemas (#17845)
## Fix resolver schema leaking between `/metadata` and `/graphql`
endpoints

### Summary
- Patch `@nestjs/graphql` to support a `resolverSchemaScope` option that
filters resolvers at both schema generation and runtime, preventing
cross-endpoint leaking
- Introduce `@CoreResolver()` and `@MetadataResolver()` decorators to
explicitly scope each resolver to its endpoint
- Move most resolvers (auth, billing, workspace, user, etc.) to the
metadata schema where the frontend expects them; only workflow and
timeline calendar/messaging resolvers remain on `/graphql`
- Fix frontend `SSEQuerySubscribeEffect` to use the default (metadata)
Apollo client instead of the core client

### Problem
NestJS GraphQL's module-based resolver discovery traverses transitive
imports, causing resolvers from `/metadata` modules to leak into the
`/graphql` schema and vice versa. This made the schemas unpredictable
and tightly coupled to module import order.

### Approach
- Added `resolverSchemaScope` to `GqlModuleOptions` via a patch on
`@nestjs/graphql`, filtering in both `filterResolvers()` (runtime
binding) and `getAllCtors()` (schema generation)
- Each resolver is explicitly decorated with `@CoreResolver()` or
`@MetadataResolver()`
- Organized decorator, constant, and type files under `graphql-config/`
following project conventions


Core GQL Schema: (see: no more fields!)
<img width="827" height="894" alt="image"
src="https://github.com/user-attachments/assets/668f3f0f-485e-43f0-92be-4345aeccacb6"
/>

Metadata GQL Schema (see no more getTimelineCalendarEventsFromCompany)
<img width="827" height="894" alt="image"
src="https://github.com/user-attachments/assets/443913db-e5fe-4161-b0e7-4a971cc80a71"
/>
2026-02-11 10:05:24 +00:00

128 lines
3.2 KiB
TypeScript

import {
type DocumentNode,
type OperationVariables,
type TypedDocumentNode,
useQuery,
} from '@apollo/client';
import { useState } from 'react';
import { type ActivityTargetableObject } from '@/activities/types/ActivityTargetableEntity';
import { useApolloCoreClient } from '@/object-metadata/hooks/useApolloCoreClient';
import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
type CustomResolverQueryResult<
T extends {
[key: string]: any;
},
> = {
[queryName: string]: T;
};
export const useCustomResolver = <
T extends {
[key: string]: any;
},
>(
query:
| DocumentNode
| TypedDocumentNode<CustomResolverQueryResult<T>, OperationVariables>,
queryName: string,
objectName: string,
activityTargetableObject: ActivityTargetableObject,
pageSize: number,
): {
data: CustomResolverQueryResult<T> | undefined;
firstQueryLoading: boolean;
isFetchingMore: boolean;
fetchMoreRecords: () => Promise<void>;
} => {
const { enqueueErrorSnackBar } = useSnackBar();
const apolloCoreClient = useApolloCoreClient();
const [page, setPage] = useState({
pageNumber: 1,
hasNextPage: true,
});
const [isFetchingMore, setIsFetchingMore] = useState(false);
const queryVariables = {
...(activityTargetableObject.targetObjectNameSingular ===
CoreObjectNameSingular.Person
? { personId: activityTargetableObject.id }
: activityTargetableObject.targetObjectNameSingular ===
CoreObjectNameSingular.Opportunity
? { opportunityId: activityTargetableObject.id }
: { companyId: activityTargetableObject.id }),
page: 1,
pageSize,
};
const {
data,
loading: firstQueryLoading,
fetchMore,
} = useQuery<CustomResolverQueryResult<T>>(query, {
client: apolloCoreClient,
variables: queryVariables,
onError: (error) => {
enqueueErrorSnackBar({
apolloError: error,
});
},
});
const fetchMoreRecords = async () => {
if (page.hasNextPage && !isFetchingMore && !firstQueryLoading) {
setIsFetchingMore(true);
await fetchMore({
variables: {
...queryVariables,
page: page.pageNumber + 1,
},
updateQuery: (prev, { fetchMoreResult }) => {
if (!fetchMoreResult?.[queryName]?.[objectName]?.length) {
setPage((page) => ({
...page,
hasNextPage: false,
}));
return {
[queryName]: {
...prev?.[queryName],
[objectName]: [...(prev?.[queryName]?.[objectName] ?? [])],
},
};
}
return {
[queryName]: {
...prev?.[queryName],
[objectName]: [
...(prev?.[queryName]?.[objectName] ?? []),
...(fetchMoreResult?.[queryName]?.[objectName] ?? []),
],
},
};
},
});
setPage((page) => ({
...page,
pageNumber: page.pageNumber + 1,
}));
setIsFetchingMore(false);
}
};
return {
data,
firstQueryLoading,
isFetchingMore,
fetchMoreRecords,
};
};