upd corner cases

Author: neSpecc

src/metrics/graphql.ts

@@ -3,7 +3,7 @@ import { ApolloServerPlugin, GraphQLRequestContext, GraphQLRequestListener } fro
 import { GraphQLError } from 'graphql';
 import HawkCatcher from '@hawk.so/nodejs';
 import { notifySlowOperation } from './slowOperationAlert';
-import { buildGraphqlRequestContext } from './graphqlRequestDetails';
+import { buildGraphqlRequestContext, formatGraphqlErrorsForAlert } from './graphqlRequestDetails';
 /**
  * GraphQL operation duration histogram
  * Tracks GraphQL operation duration by operation name and type
@@ -103,7 +103,7 @@ export const graphqlMetricsPlugin: ApolloServerPlugin = {
             operationName,
             ...buildGraphqlRequestContext(ctx),
             ...(hasErrors && {
-              errors: ctx.errors!.map((error: GraphQLError) => error.message),
+              errors: formatGraphqlErrorsForAlert(ctx.errors!),
             }),
           }
         );

src/metrics/graphqlRequestDetails.ts

@@ -1,7 +1,11 @@
 import { GraphQLRequestContext } from 'apollo-server-plugin-base';
+import { GraphQLError } from 'graphql';
 import { ResolverContextBase } from '../types/graphql';
 import { truncateText } from './slowOperationAlert';
 
+const MAX_ALERT_ERRORS = 10;
+const MAX_ALERT_ERRORS_LENGTH = 1200;
+
 const SENSITIVE_VARIABLE_KEYS = new Set([
   'password',
   'token',
@@ -51,8 +55,15 @@ function sanitizeVariableValue(value: unknown, key: string): unknown {
  * @param variables - GraphQL request variables
  * @returns sanitized variables
  */
-function sanitizeVariables(variables: Record<string, unknown> | undefined): Record<string, unknown> {
-  if (!variables) {
+function sanitizeVariables(
+  variables: Record<string, unknown> | null | undefined
+): Record<string, unknown> {
+  /**
+   * Null / non-object values are treated as empty — many clients send
+   * `variables: null` for operations without variables, and arrays are not a
+   * valid GraphQL variables map.
+   */
+  if (variables == null || typeof variables !== 'object' || Array.isArray(variables)) {
     return {};
   }
 
@@ -97,6 +108,23 @@ function collectHighlightedIds(
   return result;
 }
 
+/**
+ * Flatten GraphQL errors into a capped string for Hawk alert context.
+ * sanitizeContext() only truncates top-level strings, not values nested in arrays.
+ * Reserves space for an omitted-count suffix and truncateText()'s ellipsis.
+ *
+ * @param errors - GraphQL errors from the request
+ * @returns flattened and truncated error messages
+ */
+export function formatGraphqlErrorsForAlert(errors: readonly GraphQLError[]): string {
+  const messages = errors.slice(0, MAX_ALERT_ERRORS).map((error) => error.message);
+  const omittedCount = errors.length - messages.length;
+  const omittedSuffix = omittedCount > 0 ? `; …(+${omittedCount} more)` : '';
+  const maxMessagesLength = Math.max(0, MAX_ALERT_ERRORS_LENGTH - omittedSuffix.length - 1);
+
+  return `${truncateText(messages.join('; '), maxMessagesLength)}${omittedSuffix}`;
+}
+
 /**
  * Build request context for slow GraphQL operation alerts.
  *
@@ -105,7 +133,9 @@ function collectHighlightedIds(
  */
 export function buildGraphqlRequestContext(ctx: GraphQLRequestContext): Record<string, unknown> {
   const context = ctx.context as ResolverContextBase | undefined;
-  const variables = sanitizeVariables(ctx.request.variables as Record<string, unknown> | undefined);
+  const variables = sanitizeVariables(
+    ctx.request.variables as Record<string, unknown> | null | undefined
+  );
   const highlightedIds = collectHighlightedIds(variables);
   const alertContext: Record<string, unknown> = {};
 

test/metrics/graphqlRequestDetails.test.ts

@@ -1,4 +1,8 @@
-import { buildGraphqlRequestContext } from '../../src/metrics/graphqlRequestDetails';
+import { GraphQLError } from 'graphql';
+import {
+  buildGraphqlRequestContext,
+  formatGraphqlErrorsForAlert,
+} from '../../src/metrics/graphqlRequestDetails';
 
 describe('buildGraphqlRequestContext', () => {
   it('should include user, highlighted ids and sanitized variables', () => {
@@ -31,4 +35,45 @@ describe('buildGraphqlRequestContext', () => {
       variables: '{"projectId":"6989be3a0bc03531cc430c72","input":{"workspaceId":"workspace-1","password":"[redacted]"},"search":"TypeError"}',
     });
   });
+
+  it('should tolerate null GraphQL variables', () => {
+    const context = buildGraphqlRequestContext({
+      context: {
+        user: {
+          id: 'user-1',
+          accessTokenExpired: false,
+        },
+      },
+      request: {
+        variables: null,
+      },
+    } as never);
+
+    expect(context).toEqual({
+      userId: 'user-1',
+    });
+  });
+});
+
+describe('formatGraphqlErrorsForAlert', () => {
+  it('should flatten error messages into a single string', () => {
+    const text = formatGraphqlErrorsForAlert([
+      new GraphQLError('First error'),
+      new GraphQLError('Second error'),
+    ]);
+
+    expect(text).toBe('First error; Second error');
+  });
+
+  it('should cap the number of errors and truncate long payloads', () => {
+    const errors = Array.from({ length: 12 }, (_, index) => {
+      return new GraphQLError(`validation failed on field_${index}: ${'x'.repeat(200)}`);
+    });
+    const text = formatGraphqlErrorsForAlert(errors);
+
+    expect(text.startsWith('validation failed on field_0:')).toBe(true);
+    expect(text).toContain('…(+2 more)');
+    expect(text).toContain('…; …(+2 more)');
+    expect(text.length).toBeLessThanOrEqual(1200);
+  });
 });