Set captureTraces to false if we don't report

apollographql · May 15, 2020 · e552ba9 · e552ba9
1 parent c6b854b
commit e552ba9
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 14 deletions.
diff --git a/packages/apollo-engine-reporting/src/__tests__/plugin.test.ts b/packages/apollo-engine-reporting/src/__tests__/plugin.test.ts
@@ -314,19 +314,18 @@ function makeTestHTTP(): Trace.HTTP {
   });
 }
 
-describe("tests for the shouldReportQuery reporting option", () => {
+describe('tests for the shouldReportQuery reporting option', () => {
   const schema = makeExecutableSchema({ typeDefs });
   addMockFunctionsToSchema({ schema });
 
   const addTrace = jest.fn();
   beforeEach(() => {
     addTrace.mockClear();
-  })
-  it("report no traces", async () => {
-
+  });
+  it('report no traces', async () => {
     const pluginInstance = plugin({ traceReporting: false }, addTrace);
 
-    await pluginTestHarness({
+    const context = await pluginTestHarness({
       pluginInstance,
       schema,
       graphqlRequest: {
@@ -344,17 +343,20 @@ describe("tests for the shouldReportQuery reporting option", () => {
         });
       },
     });
+    expect(context.metrics.captureTraces).toBeFalsy();
   });
 
   it('report traces based on operation name', async () => {
     const pluginInstance = plugin(
       {
-        traceReporting: async (request) => {
-          return request.request.operationName === 'report'
-        }
-      }, addTrace);
+        traceReporting: async request => {
+          return request.request.operationName === 'report';
+        },
+      },
+      addTrace,
+    );
 
-    await pluginTestHarness({
+    const context1 = await pluginTestHarness({
       pluginInstance,
       schema,
       graphqlRequest: {
@@ -374,9 +376,10 @@ describe("tests for the shouldReportQuery reporting option", () => {
     });
 
     expect(addTrace).toBeCalledTimes(1);
+    expect(context1.metrics.captureTraces).toBeTruthy();
     addTrace.mockClear();
 
-    await pluginTestHarness({
+    const context2 = await pluginTestHarness({
       pluginInstance,
       schema,
       graphqlRequest: {
@@ -396,10 +399,10 @@ describe("tests for the shouldReportQuery reporting option", () => {
     });
 
     expect(addTrace).not.toBeCalled();
+    expect(context2.metrics.captureTraces).toBeFalsy();
   });
 });
 
-
 /**
  * TESTS FOR THE sendHeaders REPORTING OPTION
  */

diff --git a/packages/apollo-engine-reporting/src/plugin.ts b/packages/apollo-engine-reporting/src/plugin.ts
@@ -44,7 +44,12 @@ export const plugin = <TContext>(
       request: { http, variables },
     }) {
       // If the options are false don't do any metrics timing.
-      if (options.traceReporting === false) return {};
+      if (options.traceReporting === false) {
+        // If we are running in gateway mode don't send the ftv1 trace
+        metrics.captureTraces = false;
+        return {};
+      }
+      metrics.captureTraces = true;
 
       const treeBuilder: EngineReportingTreeBuilder = new EngineReportingTreeBuilder(
         {
@@ -97,7 +102,12 @@ export const plugin = <TContext>(
         // Returning here if we aren't reporting the trace to make sure,
         // endDone is set and the treeBuilder has stopped
 
-        if (!reportTrace) return;
+        if (!reportTrace) {
+          // If we are running in gateway mode don't send the ftv1 trace
+          // after we have stopped trace timing.
+          metrics.captureTraces = false;
+          return;
+        }
 
         treeBuilder.trace.fullQueryCacheHit = !!metrics.responseCacheHit;
         treeBuilder.trace.forbiddenOperation = !!metrics.forbiddenOperation;