@apollo/gateway 0.300.0-alpha.2 → 2.0.0-alpha.2

package/src/__tests__/gateway/reporting.test.ts

@@ -2,14 +2,15 @@ import { gunzipSync } from 'zlib';
 import nock from 'nock';
 import { GraphQLSchemaModule } from 'apollo-graphql';
 import gql from 'graphql-tag';
-import { buildFederatedSchema } from '@apollo/federation';
+import { buildSubgraphSchema } from '@apollo/subgraph';
 import { ApolloServer } from 'apollo-server';
+import { ApolloServerPluginUsageReporting } from 'apollo-server-core';
 import { execute, toPromise } from 'apollo-link';
 import { createHttpLink } from 'apollo-link-http';
 import fetch from 'node-fetch';
 import { ApolloGateway } from '../..';
 import { Plugin, Config, Refs } from 'pretty-format';
-import { Report } from 'apollo-engine-reporting-protobuf';
+import { Report, Trace } from 'apollo-reporting-protobuf';
 import { fixtures } from 'apollo-federation-integration-testsuite';
 
 // Normalize specific fields that change often (eg timestamps) to static values,
@@ -28,7 +29,7 @@ function replaceFieldValuesSerializer(
         value &&
         typeof value === 'object' &&
         !value[alreadyProcessed] &&
-        fieldNames.some(n => n in value)
+        fieldNames.some((n) => n in value)
       );
     },
 
@@ -45,7 +46,7 @@ function replaceFieldValuesSerializer(
       // don't reprocess it ourselves.
       const newValue = { ...value };
       Object.defineProperty(newValue, alreadyProcessed, { value: true });
-      fieldNames.forEach(fn => {
+      fieldNames.forEach((fn) => {
         if (fn in value) {
           const replacement = replacements[fn];
           if (typeof replacement === 'function') {
@@ -77,7 +78,7 @@ expect.addSnapshotSerializer(
 );
 
 async function startFederatedServer(modules: GraphQLSchemaModule[]) {
-  const schema = buildFederatedSchema(modules);
+  const schema = buildSubgraphSchema(modules);
   const server = new ApolloServer({ schema });
   const { url } = await server.listen({ port: 0 });
   return { url, server };
@@ -92,11 +93,11 @@ describe('reporting', () => {
 
   beforeEach(async () => {
     let reportResolver: (report: any) => void;
-    reportPromise = new Promise<any>(resolve => {
+    reportPromise = new Promise<any>((resolve) => {
       reportResolver = resolve;
     });
 
-    nockScope = nock('https://engine-report.apollodata.com')
+    nockScope = nock('https://usage-reporting.api.apollographql.com')
       .post('/api/ingress/traces')
       .reply(200, (_: any, requestBody: string) => {
         reportResolver(requestBody);
@@ -116,10 +117,15 @@ describe('reporting', () => {
     gatewayServer = new ApolloServer({
       schema,
       executor,
-      engine: {
-        apiKey: 'service:foo:bar',
-        sendReportsImmediately: true,
+      apollo: {
+        key: 'service:foo:bar',
+        graphRef: 'foo@current',
       },
+      plugins: [
+        ApolloServerPluginUsageReporting({
+          sendReportsImmediately: true,
+        }),
+      ],
     });
     ({ url: gatewayUrl } = await gatewayServer.listen({ port: 0 }));
   });
@@ -138,7 +144,10 @@ describe('reporting', () => {
     const query = gql`
       query {
         me {
-          name
+          name {
+            first
+            last
+          }
         }
         topProducts {
           name
@@ -152,31 +161,34 @@ describe('reporting', () => {
       }),
     );
     expect(result).toMatchInlineSnapshot(`
-                                                                  Object {
-                                                                    "data": Object {
-                                                                      "me": Object {
-                                                                        "name": "Ada Lovelace",
-                                                                      },
-                                                                      "topProducts": Array [
-                                                                        Object {
-                                                                          "name": "Table",
-                                                                        },
-                                                                        Object {
-                                                                          "name": "Couch",
-                                                                        },
-                                                                        Object {
-                                                                          "name": "Chair",
-                                                                        },
-                                                                        Object {
-                                                                          "name": "Structure and Interpretation of Computer Programs (1996)",
-                                                                        },
-                                                                        Object {
-                                                                          "name": "Object Oriented Software Construction (1997)",
-                                                                        },
-                                                                      ],
-                                                                    },
-                                                                  }
-                                        `);
+      Object {
+        "data": Object {
+          "me": Object {
+            "name": Object {
+              "first": "Ada",
+              "last": "Lovelace",
+            },
+          },
+          "topProducts": Array [
+            Object {
+              "name": "Table",
+            },
+            Object {
+              "name": "Couch",
+            },
+            Object {
+              "name": "Chair",
+            },
+            Object {
+              "name": "Structure and Interpretation of Computer Programs (1996)",
+            },
+            Object {
+              "name": "Object Oriented Software Construction (1997)",
+            },
+          ],
+        },
+      }
+    `);
     const reportBody = await reportPromise;
     // nock returns binary bodies as hex strings
     const gzipReportBuffer = Buffer.from(reportBody, 'hex');
@@ -184,10 +196,10 @@ describe('reporting', () => {
     const report = Report.decode(reportBuffer);
 
     // Some handwritten tests to capture salient properties.
-    const statsReportKey = '# -\n{me{name}topProducts{name}}';
+    const statsReportKey = '# -\n{me{name{first last}}topProducts{name}}';
     expect(Object.keys(report.tracesPerQuery)).toStrictEqual([statsReportKey]);
     expect(report.tracesPerQuery[statsReportKey]!.trace!.length).toBe(1);
-    const trace = report.tracesPerQuery[statsReportKey]!.trace![0]!;
+    const trace = report.tracesPerQuery[statsReportKey]!.trace![0]! as Trace;
     // In the gateway, the root trace is just an empty node (unless there are errors).
     expect(trace.root!.child).toStrictEqual([]);
     // The query plan has (among other things) a fetch against 'accounts' and a
@@ -211,13 +223,20 @@ describe('reporting', () => {
 
     expect(report).toMatchInlineSnapshot(`
       Object {
-        "endTime": null,
+        "endTime": Object {
+          "nanos": 123000000,
+          "seconds": "1562203363",
+        },
         "header": "<HEADER>",
         "tracesPerQuery": Object {
           "# -
-      {me{name}topProducts{name}}": Object {
+      {me{name{first last}}topProducts{name}}": Object {
             "trace": Array [
               Object {
+                "cachePolicy": Object {
+                  "maxAgeNs": "30000000000",
+                  "scope": "PRIVATE",
+                },
                 "clientName": "",
                 "clientReferenceId": "",
                 "clientVersion": "",
@@ -258,11 +277,27 @@ describe('reporting', () => {
                                 Object {
                                   "child": Array [
                                     Object {
+                                      "child": Array [
+                                        Object {
+                                          "endTime": "45678",
+                                          "parentType": "Name",
+                                          "responseName": "first",
+                                          "startTime": "34567",
+                                          "type": "String",
+                                        },
+                                        Object {
+                                          "endTime": "45678",
+                                          "parentType": "Name",
+                                          "responseName": "last",
+                                          "startTime": "34567",
+                                          "type": "String",
+                                        },
+                                      ],
                                       "endTime": "45678",
                                       "parentType": "User",
                                       "responseName": "name",
                                       "startTime": "34567",
-                                      "type": "String",
+                                      "type": "Name",
                                     },
                                   ],
                                   "endTime": "45678",
@@ -409,13 +444,6 @@ describe('reporting', () => {
                                             "child": Array [
                                               Object {
                                                 "child": Array [
-                                                  Object {
-                                                    "endTime": "45678",
-                                                    "parentType": "Book",
-                                                    "responseName": "isbn",
-                                                    "startTime": "34567",
-                                                    "type": "String!",
-                                                  },
                                                   Object {
                                                     "endTime": "45678",
                                                     "parentType": "Book",
@@ -435,13 +463,6 @@ describe('reporting', () => {
                                               },
                                               Object {
                                                 "child": Array [
-                                                  Object {
-                                                    "endTime": "45678",
-                                                    "parentType": "Book",
-                                                    "responseName": "isbn",
-                                                    "startTime": "34567",
-                                                    "type": "String!",
-                                                  },
                                                   Object {
                                                     "endTime": "45678",
                                                     "parentType": "Book",