The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(metrics): count directly executed GraphQL operations (#26653)
Charles Bochet37f4b65fac41
diff --git a/packages/twenty-server/src/engine/api/graphql/direct-execution/direct-execution.service.ts b/packages/twenty-server/src/engine/api/graphql/direct-execution/direct-execution.service.tsindex 291d844ad12..ff878bbe3d1 100644--- a/packages/twenty-server/src/engine/api/graphql/direct-execution/direct-execution.service.ts+++ b/packages/twenty-server/src/engine/api/graphql/direct-execution/direct-execution.service.ts@@ -16,7 +16,7 @@ import {type GraphQLResolveInfo,} from 'graphql';import { SOURCE_LOCALE } from 'twenty-shared/translations';-import { isDefined } from 'twenty-shared/utils';+import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';import graphqlFields from 'graphql-fields';import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';@@ -68,15 +68,17 @@ import { UpdateManyResolverFactory } from 'src/engine/api/graphql/workspace-resoimport { UpdateOneResolverFactory } from 'src/engine/api/graphql/workspace-resolver-builder/factories/update-one-resolver.factory';import { type WorkspaceResolverBuilderFactoryInterface } from 'src/engine/api/graphql/workspace-resolver-builder/interfaces/workspace-resolver-builder-factory.interface';import { type WorkspaceSchemaBuilderContext } from 'src/engine/api/graphql/workspace-schema-builder/interfaces/workspace-schema-builder-context.interface';+import { getGraphqlOperationMetricKeyFromErrorCode } from 'src/engine/core-modules/graphql/utils/get-graphql-operation-metric-key-from-error-code.util';import { UserInputError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';import { MetricsService } from 'src/engine/core-modules/metrics/metrics.service';+import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';import { buildObjectIdByNameMaps } from 'src/engine/metadata-modules/flat-object-metadata/utils/build-object-id-by-name-maps.util';import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';-type DirectExecutionResult = {+export type DirectExecutionResult = {data?: Record<string, unknown>;errors?: GraphQLFormattedError[];};@@ -204,6 +206,24 @@ export class DirectExecutionService {);}+ recordOperationMetrics(result: Pick<DirectExecutionResult, 'errors'>): void {+ if (!isNonEmptyArray(result.errors)) {+ void this.metricsService.incrementCounterForEvent({+ key: MetricsKeys.GraphqlOperation200,+ });++ return;+ }++ for (const error of result.errors) {+ void this.metricsService.incrementCounterForEvent({+ key:+ getGraphqlOperationMetricKeyFromErrorCode(error.extensions?.code) ??+ MetricsKeys.GraphqlOperationUnknown,+ });+ }+ }+private async executeWorkspaceQuery(req: Request,document: DocumentNode,diff --git a/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.ts b/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.tsindex b1be061b8bc..1fdf64a5f11 100644--- a/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.ts+++ b/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.ts@@ -75,7 +75,11 @@ export function useDirectExecution('This query cannot be executed as a single request. Please split it into separate queries.',);- return endResponse(Response.json({ errors: [error.toJSON()] }));+ const result = { errors: [error.toJSON()] };++ config.directExecutionService.recordOperationMetrics(result);++ return endResponse(Response.json(result));}if (hasCoreFields) {@@ -104,6 +108,8 @@ export function useDirectExecution(return;}+ config.directExecutionService.recordOperationMetrics(result);+return endResponse(Response.json(result));},};diff --git a/packages/twenty-server/src/engine/core-modules/graphql/hooks/use-graphql-error-handler.hook.ts b/packages/twenty-server/src/engine/core-modules/graphql/hooks/use-graphql-error-handler.hook.tsindex 71d2d33de92..81d58ec9894 100644--- a/packages/twenty-server/src/engine/core-modules/graphql/hooks/use-graphql-error-handler.hook.ts+++ b/packages/twenty-server/src/engine/core-modules/graphql/hooks/use-graphql-error-handler.hook.ts@@ -19,19 +19,16 @@ import { type GraphQLContext } from 'src/engine/api/graphql/graphql-config/interimport { type ExceptionHandlerService } from 'src/engine/core-modules/exception-handler/exception-handler.service';import { generateGraphQLErrorFromError } from 'src/engine/core-modules/graphql/utils/generate-graphql-error-from-error.util';+import { getGraphqlOperationMetricKeyFromErrorCode } from 'src/engine/core-modules/graphql/utils/get-graphql-operation-metric-key-from-error-code.util';import {BaseGraphQLError,convertGraphQLErrorToBaseGraphQLError,- ErrorCode,} from 'src/engine/core-modules/graphql/utils/graphql-errors.util';import { type I18nService } from 'src/engine/core-modules/i18n/i18n.service';import { type MetricsService } from 'src/engine/core-modules/metrics/metrics.service';import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';import { type TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';-import {- graphQLErrorCodesToFilter,- shouldCaptureException,-} from 'src/engine/utils/global-exception-handler.util';+import { shouldCaptureException } from 'src/engine/utils/global-exception-handler.util';import { translateUserFriendlyMessageDescriptors } from 'src/engine/core-modules/i18n/utils/translate-user-friendly-message-descriptors.util';const DEFAULT_EVENT_ID_KEY = 'exceptionEventId';@@ -140,14 +137,6 @@ export const useGraphQLErrorHandlerHook = <return originalError;});- const codeToMetricKey: Partial<Record<ErrorCode, MetricsKeys>> = {- [ErrorCode.UNAUTHENTICATED]: MetricsKeys.GraphqlOperation401,- [ErrorCode.FORBIDDEN]: MetricsKeys.GraphqlOperation403,- [ErrorCode.NOT_FOUND]: MetricsKeys.GraphqlOperation404,- [ErrorCode.INTERNAL_SERVER_ERROR]:- MetricsKeys.GraphqlOperation500,- };-const statusToMetricKey: Record<number, MetricsKeys> = {400: MetricsKeys.GraphqlOperation400,401: MetricsKeys.GraphqlOperation401,@@ -160,12 +149,9 @@ export const useGraphQLErrorHandlerHook = <let metricKey: MetricsKeys | undefined;if (error instanceof BaseGraphQLError) {- const code = error.extensions?.code as ErrorCode;-- metricKey = codeToMetricKey[code];- if (!metricKey && graphQLErrorCodesToFilter.includes(code)) {- metricKey = MetricsKeys.GraphqlOperation400;- }+ metricKey = getGraphqlOperationMetricKeyFromErrorCode(+ error.extensions?.code,+ );} else if (error instanceof GraphQLError) {const status = error.extensions?.http?.status as number;diff --git a/packages/twenty-server/src/engine/core-modules/graphql/utils/__tests__/get-graphql-operation-metric-key-from-error-code.util.spec.ts b/packages/twenty-server/src/engine/core-modules/graphql/utils/__tests__/get-graphql-operation-metric-key-from-error-code.util.spec.tsnew file mode 100644index 00000000000..755e3b85f10--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/graphql/utils/__tests__/get-graphql-operation-metric-key-from-error-code.util.spec.ts@@ -0,0 +1,40 @@+import { getGraphqlOperationMetricKeyFromErrorCode } from 'src/engine/core-modules/graphql/utils/get-graphql-operation-metric-key-from-error-code.util';+import { ErrorCode } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';+import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';++describe('getGraphqlOperationMetricKeyFromErrorCode', () => {+ it('should map codes with a dedicated status metric', () => {+ expect(+ getGraphqlOperationMetricKeyFromErrorCode(ErrorCode.UNAUTHENTICATED),+ ).toBe(MetricsKeys.GraphqlOperation401);+ expect(getGraphqlOperationMetricKeyFromErrorCode(ErrorCode.FORBIDDEN)).toBe(+ MetricsKeys.GraphqlOperation403,+ );+ expect(getGraphqlOperationMetricKeyFromErrorCode(ErrorCode.NOT_FOUND)).toBe(+ MetricsKeys.GraphqlOperation404,+ );+ expect(+ getGraphqlOperationMetricKeyFromErrorCode(+ ErrorCode.INTERNAL_SERVER_ERROR,+ ),+ ).toBe(MetricsKeys.GraphqlOperation500);+ });++ it('should map other client error codes to 400', () => {+ expect(+ getGraphqlOperationMetricKeyFromErrorCode(ErrorCode.BAD_USER_INPUT),+ ).toBe(MetricsKeys.GraphqlOperation400);+ expect(+ getGraphqlOperationMetricKeyFromErrorCode(ErrorCode.RATE_LIMITED),+ ).toBe(MetricsKeys.GraphqlOperation400);+ });++ it('should return undefined for unknown codes', () => {+ expect(getGraphqlOperationMetricKeyFromErrorCode('SOMETHING_ELSE')).toBe(+ undefined,+ );+ expect(getGraphqlOperationMetricKeyFromErrorCode(undefined)).toBe(+ undefined,+ );+ });+});diff --git a/packages/twenty-server/src/engine/core-modules/graphql/utils/get-graphql-operation-metric-key-from-error-code.util.ts b/packages/twenty-server/src/engine/core-modules/graphql/utils/get-graphql-operation-metric-key-from-error-code.util.tsnew file mode 100644index 00000000000..4cdb88d8843--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/graphql/utils/get-graphql-operation-metric-key-from-error-code.util.ts@@ -0,0 +1,34 @@+import { isString } from '@sniptt/guards';+import { isDefined } from 'twenty-shared/utils';++import { ErrorCode } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';+import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';+import { graphQLErrorCodesToFilter } from 'src/engine/utils/global-exception-handler.util';++const ERROR_CODES = new Set<string>(Object.values(ErrorCode));++const METRIC_KEY_BY_ERROR_CODE: Partial<Record<ErrorCode, MetricsKeys>> = {+ [ErrorCode.UNAUTHENTICATED]: MetricsKeys.GraphqlOperation401,+ [ErrorCode.FORBIDDEN]: MetricsKeys.GraphqlOperation403,+ [ErrorCode.NOT_FOUND]: MetricsKeys.GraphqlOperation404,+ [ErrorCode.INTERNAL_SERVER_ERROR]: MetricsKeys.GraphqlOperation500,+};++const isErrorCode = (code: unknown): code is ErrorCode =>+ isString(code) && ERROR_CODES.has(code);++export const getGraphqlOperationMetricKeyFromErrorCode = (+ code: unknown,+): MetricsKeys | undefined => {+ if (!isErrorCode(code)) {+ return undefined;+ }++ const metricKey = METRIC_KEY_BY_ERROR_CODE[code];++ if (!isDefined(metricKey) && graphQLErrorCodesToFilter.includes(code)) {+ return MetricsKeys.GraphqlOperation400;+ }++ return metricKey;+};