Files
twenty/packages/twenty-front/src/modules/sse-db-event/components/SSEQuerySubscribeEffect.tsx
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

148 lines
4.8 KiB
TypeScript

import { ADD_QUERY_TO_EVENT_STREAM_MUTATION } from '@/sse-db-event/graphql/mutations/AddQueryToEventStreamMutation';
import { REMOVE_QUERY_FROM_EVENT_STREAM_MUTATION } from '@/sse-db-event/graphql/mutations/RemoveQueryFromEventStreamMutation';
import { activeQueryListenersState } from '@/sse-db-event/states/activeQueryListenersState';
import { requiredQueryListenersState } from '@/sse-db-event/states/requiredQueryListenersState';
import { shouldDestroyEventStreamState } from '@/sse-db-event/states/shouldDestroyEventStreamState';
import { sseEventStreamIdState } from '@/sse-db-event/states/sseEventStreamIdState';
import { getSnapshotValue } from '@/ui/utilities/state/utils/getSnapshotValue';
import { ApolloError, useMutation } from '@apollo/client';
import { isNonEmptyString } from '@sniptt/guards';
import { useEffect } from 'react';
import { useRecoilCallback, useRecoilValue } from 'recoil';
import {
compareArraysOfObjectsByProperty,
isDefined,
} from 'twenty-shared/utils';
import { useDebouncedCallback } from 'use-debounce';
import {
type AddQuerySubscriptionInput,
type RemoveQueryFromEventStreamInput,
} from '~/generated-metadata/graphql';
export const SSEQuerySubscribeEffect = () => {
const sseEventStreamId = useRecoilValue(sseEventStreamIdState);
const [addQueryToEventStream] = useMutation<
boolean,
{ input: AddQuerySubscriptionInput }
>(ADD_QUERY_TO_EVENT_STREAM_MUTATION);
const [removeQueryFromEventStream] = useMutation<
void,
{ input: RemoveQueryFromEventStreamInput }
>(REMOVE_QUERY_FROM_EVENT_STREAM_MUTATION);
const requiredQueryListeners = useRecoilValue(requiredQueryListenersState);
const activeQueryListeners = useRecoilValue(activeQueryListenersState);
const updateQueryListeners = useRecoilCallback(
({ set, snapshot }) =>
async () => {
if (!isDefined(sseEventStreamId)) {
return;
}
const requiredQueryListeners = getSnapshotValue(
snapshot,
requiredQueryListenersState,
);
const activeQueryListeners = getSnapshotValue(
snapshot,
activeQueryListenersState,
);
const queryListenersToAdd = requiredQueryListeners.filter(
(listener) =>
!activeQueryListeners.some(
(activeListener) => activeListener.queryId === listener.queryId,
),
);
const queryListenersToRemove = activeQueryListeners.filter(
(listener) =>
!requiredQueryListeners.some(
(requiredListener) =>
requiredListener.queryId === listener.queryId,
),
);
try {
for (const queryListenerToAdd of queryListenersToAdd) {
await addQueryToEventStream({
variables: {
input: {
eventStreamId: sseEventStreamId,
queryId: queryListenerToAdd.queryId,
operationSignature: queryListenerToAdd.operationSignature,
},
},
});
}
for (const queryListenerToRemove of queryListenersToRemove) {
await removeQueryFromEventStream({
variables: {
input: {
eventStreamId: sseEventStreamId,
queryId: queryListenerToRemove.queryId,
},
},
});
}
} catch (error) {
if (error instanceof ApolloError) {
const subCode = error.graphQLErrors[0]?.extensions?.subCode;
switch (subCode) {
case 'EVENT_STREAM_DOES_NOT_EXIST':
case 'EVENT_STREAM_ALREADY_EXISTS': {
set(activeQueryListenersState, []);
set(shouldDestroyEventStreamState, true);
return;
}
default: {
throw new Error(
`Unhandled error for event stream: ${error.message}`,
);
}
}
}
}
set(activeQueryListenersState, requiredQueryListeners);
},
[addQueryToEventStream, removeQueryFromEventStream, sseEventStreamId],
);
const debouncedUpdateQueryListeners = useDebouncedCallback(
updateQueryListeners,
1000,
{ leading: true },
);
useEffect(() => {
if (!isNonEmptyString(sseEventStreamId)) {
return;
}
const areRequiredQueryListenersDifferentFromActiveQueryListeners =
compareArraysOfObjectsByProperty(
requiredQueryListeners,
activeQueryListeners,
'queryId',
);
if (areRequiredQueryListenersDifferentFromActiveQueryListeners) {
debouncedUpdateQueryListeners();
}
}, [
sseEventStreamId,
requiredQueryListeners,
activeQueryListeners,
debouncedUpdateQueryListeners,
]);
return null;
};