fix: add missing operationName (#3488)

Co-authored-by: Tomas Kroupa <[email protected]>
dotansimha · Nov 26, 2024 · a4bc07f · a4bc07f
1 parent f2255d2
commit a4bc07f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 15 deletions.
diff --git a/.changeset/changelog1.md b/.changeset/changelog1.md
@@ -0,0 +1,5 @@
+---
+"@graphql-yoga/plugin-apollo-usage-report": patch
+---
+
+fixed: move logic from `onEnveloped` hook to `onParse` hook (`onParseEnd`) which prevents the `operationName` could be missing.
diff --git a/packages/plugins/apollo-usage-report/src/index.ts b/packages/plugins/apollo-usage-report/src/index.ts
@@ -1,4 +1,4 @@
-import { printSchema, stripIgnoredCharacters } from 'graphql';
+import { DocumentNode, getOperationAST, Kind, printSchema, stripIgnoredCharacters } from 'graphql';
 import {
   isAsyncIterable,
   Maybe,
@@ -134,21 +134,26 @@ export function useApolloUsageReport(options: ApolloUsageReportOptions = {}): Pl
           }
         },
 
-        onEnveloped({ context }) {
-          if (!context) {
-            return;
-          }
-          const ctx = ctxForReq.get(context.request)?.traces.get(context);
-          if (!ctx) {
-            logger.debug('operation tracing context not found, this operation will not be traced.');
-            return;
-          }
+        onParse() {
+          return function onParseEnd({ result, context }) {
+            const ctx = ctxForReq.get(context.request)?.traces.get(context);
+            if (!ctx) {
+              logger.debug(
+                'operation tracing context not found, this operation will not be traced.',
+              );
+              return;
+            }
+
+            const operationName =
+              context.params.operationName ??
+              (isDocumentNode(result) ? getOperationAST(result)?.name?.value : undefined);
+            const signature = context.params.query
+              ? stripIgnoredCharacters(context.params.query)
+              : '';
 
-          const signature = context.params.query
-            ? stripIgnoredCharacters(context.params.query)
-            : '';
-          ctx.operationKey = `# ${context.params.operationName || '-'}\n${signature}`;
-          ctx.schemaId = schemaId;
+            ctx.operationKey = `# ${operationName || '-'}\n${signature}`;
+            ctx.schemaId = schemaId;
+          };
         },
 
         onResultProcess({ request, result, serverContext }) {
@@ -271,3 +276,10 @@ async function sendTrace(
     logger.error('Failed to send trace:', err);
   }
 }
+
+function isDocumentNode(data: unknown): data is DocumentNode {
+  const isObject = (data: unknown): data is Record<string, unknown> =>
+    !!data && typeof data === 'object';
+
+  return isObject(data) && data.kind === Kind.DOCUMENT;
+}