Move apollo-engine-reporting signatures into apollo-graphql.

docs/source/api/apollo-server.md

@@ -303,8 +303,10 @@ addMockFunctionsToSchema({
 
 *  `calculateSignature`: (ast: DocumentNode, operationName: string) => string
 
-   Specify the function for creating a signature for a query. See signature.ts
-   for details.
+   Specify the function for creating a signature for a query.
+
+   > See [`apollo-graphql`'s `signature.ts`](https://npm.im/apollo-graphql)
+   > for more information on how the default signature is generated.
 
 *  `reportIntervalMs`: number
 

jest.config.base.js

@@ -21,7 +21,7 @@ module.exports = {
       // We don't want to match `apollo-server-env` and
       // `apollo-engine-reporting-protobuf`, because these don't depend on
       // compilation but need to be initialized from as parto of `prepare`.
-      '^(?!apollo-server-env|apollo-engine-reporting-protobuf)(apollo-(?:server|datasource|cache-control|tracing|engine)[^/]*|graphql-extensions)(?:/dist)?((?:/.*)|$)': '<rootDir>/../../packages/$1/src$2'
+      '^(?!apollo-server-env|apollo-engine-reporting-protobuf)(apollo-(?:server|graphql|datasource|cache-control|tracing|engine)[^/]*|graphql-extensions)(?:/dist)?((?:/.*)|$)': '<rootDir>/../../packages/$1/src$2'
     },
     clearMocks: true,
     globals: {

package.json

@@ -40,6 +40,7 @@
     "apollo-datasource-rest": "file:packages/apollo-datasource-rest",
     "apollo-engine-reporting": "file:packages/apollo-engine-reporting",
     "apollo-engine-reporting-protobuf": "file:packages/apollo-engine-reporting-protobuf",
+    "apollo-graphql": "file:packages/apollo-graphql",
     "apollo-server": "file:packages/apollo-server",
     "apollo-server-azure-functions": "file:packages/apollo-server-azure-functions",
     "apollo-server-cache-memcached": "file:packages/apollo-server-cache-memcached",
@@ -74,6 +75,7 @@
     "@types/koa-multer": "1.0.0",
     "@types/koa-router": "7.0.39",
     "@types/lodash": "4.14.120",
+    "@types/lodash.sortby": "4.7.4",
     "@types/lru-cache": "4.1.1",
     "@types/memcached": "2.2.5",
     "@types/micro": "7.3.3",

packages/apollo-engine-reporting/CHANGELOG.md

@@ -1,4 +1,10 @@
 ### vNext
 
-* Initial release.
+# v1.0.0
+
+* The signature functions which were previously exported from this package's
+  main module have been removed from `apollo-engine-reporting` and
+  moved to the `apollo-graphql` package.  They should be more universally
+  helpful in that library, and should avoid tooling which needs to use them
+  from needing to bring in all of `apollo-server-core`.
 

packages/apollo-engine-reporting/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apollo-engine-reporting",
-  "version": "0.2.2",
+  "version": "1.0.0",
   "description": "Send reports about your GraphQL services to Apollo Engine",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -12,10 +12,10 @@
   },
   "dependencies": {
     "apollo-engine-reporting-protobuf": "file:../apollo-engine-reporting-protobuf",
+    "apollo-graphql": "file:../apollo-graphql",
     "apollo-server-core": "file:../apollo-server-core",
     "apollo-server-env": "file:../apollo-server-env",
     "async-retry": "^1.2.1",
-    "graphql-extensions": "file:../graphql-extensions",
-    "lodash": "^4.17.10"
+    "graphql-extensions": "file:../graphql-extensions"
   }
 }

packages/apollo-engine-reporting/src/extension.ts

@@ -16,7 +16,7 @@ import {
 import { Trace, google } from 'apollo-engine-reporting-protobuf';
 
 import { EngineReportingOptions, GenerateClientInfo } from './agent';
-import { defaultSignature } from './signature';
+import { defaultEngineReportingSignature } from 'apollo-graphql';
 import { GraphQLRequestContext } from 'apollo-server-core/dist/requestPipelineAPI';
 
 const clientNameHeaderKey = 'apollographql-client-name';
@@ -214,7 +214,7 @@ export class EngineReportingExtension<TContext = any>
       let signature;
       if (this.documentAST) {
         const calculateSignature =
-          this.options.calculateSignature || defaultSignature;
+          this.options.calculateSignature || defaultEngineReportingSignature;
         signature = calculateSignature(this.documentAST, operationName);
       } else if (this.queryString) {
         // We didn't get an AST, possibly because of a parse failure. Let's just

packages/apollo-engine-reporting/src/index.ts

@@ -1,10 +1 @@
-export {
-  hideLiterals,
-  dropUnusedDefinitions,
-  sortAST,
-  removeAliases,
-  printWithReducedWhitespace,
-  defaultSignature,
-} from './signature';
-
 export { EngineReportingOptions, EngineReportingAgent } from './agent';

packages/apollo-engine-reporting/tsconfig.json

@@ -8,6 +8,7 @@
   "exclude": ["**/__tests__", "**/__mocks__"],
   "references": [
     { "path": "../graphql-extensions" },
+    { "path": "../apollo-graphql" },
     { "path": "../apollo-server-core/tsconfig.requestPipelineAPI.json" }
   ]
 }

packages/apollo-graphql/.npmignore

@@ -0,0 +1,6 @@
+*
+!src/**/*
+!dist/**/*
+dist/**/*.test.*
+!package.json
+!README.md

packages/apollo-graphql/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+### vNEXT
+

packages/apollo-graphql/README.md

@@ -0,0 +1 @@
+# `apollo-graphql`

packages/apollo-graphql/jest.config.js

@@ -0,0 +1,3 @@
+const config = require('../../jest.config.base');
+
+module.exports = Object.assign(Object.create(null), config);

packages/apollo-graphql/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "apollo-graphql",
+  "version": "0.0.1-alpha.0",
+  "description": "Apollo GraphQL utility library",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [],
+  "author": "Apollo <opensource@apollographql.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=6"
+  },
+  "dependencies": {
+    "lodash.sortby": "^4.7.0"
+  },
+  "devDependencies": {},
+  "peerDependencies": {
+    "graphql": "^14.0.0"
+  }
+}

packages/apollo-engine-reporting/src/__tests__/signature.test.ts → packages/apollo-graphql/src/__tests__/signature.test.ts

@@ -7,82 +7,12 @@ import {
   dropUnusedDefinitions,
   sortAST,
   removeAliases,
-} from '../signature';
+} from '../transforms';
 
 // The gql duplicate fragment warning feature really is just warnings; nothing
 // breaks if you turn it off in tests.
 disableFragmentWarnings();
 
-describe('printWithReducedWhitespace', () => {
-  const cases = [
-    {
-      name: 'lots of whitespace',
-      // Note: there's a tab after "tab->", which prettier wants to keep as a
-      // literal tab rather than \t.  In the output, there should be a literal
-      // backslash-t.
-      input: gql`
-        query Foo($a: Int) {
-          user(
-            name: "   tab->	yay"
-            other: """
-            apple
-               bag
-            cat
-            """
-          ) {
-            name
-          }
-        }
-      `,
-      output:
-        'query Foo($a:Int){user(name:"   tab->\\tyay",other:"apple\\n   bag\\ncat"){name}}',
-    },
-  ];
-  cases.forEach(({ name, input, output }) => {
-    test(name, () => {
-      expect(printWithReducedWhitespace(input)).toEqual(output);
-    });
-  });
-});
-
-describe('hideLiterals', () => {
-  const cases = [
-    {
-      name: 'full test',
-      input: gql`
-        query Foo($b: Int, $a: Boolean) {
-          user(name: "hello", age: 5) {
-            ...Bar
-            ... on User {
-              hello
-              bee
-            }
-            tz
-            aliased: name
-          }
-        }
-
-        fragment Bar on User {
-          age @skip(if: $a)
-          ...Nested
-        }
-
-        fragment Nested on User {
-          blah
-        }
-      `,
-      output:
-        'query Foo($b:Int,$a:Boolean){user(name:"",age:0){...Bar...on User{hello bee}tz aliased:name}}' +
-        'fragment Bar on User{age@skip(if:$a)...Nested}fragment Nested on User{blah}',
-    },
-  ];
-  cases.forEach(({ name, input, output }) => {
-    test(name, () => {
-      expect(printWithReducedWhitespace(hideLiterals(input))).toEqual(output);
-    });
-  });
-});
-
 describe('aggressive signature', () => {
   function aggressive(ast: DocumentNode, operationName: string): string {
     return printWithReducedWhitespace(

packages/apollo-graphql/src/__tests__/transforms.test.ts

@@ -0,0 +1,77 @@
+import { default as gql, disableFragmentWarnings } from 'graphql-tag';
+
+import { printWithReducedWhitespace, hideLiterals } from '../transforms';
+
+// The gql duplicate fragment warning feature really is just warnings; nothing
+// breaks if you turn it off in tests.
+disableFragmentWarnings();
+
+describe('printWithReducedWhitespace', () => {
+  const cases = [
+    {
+      name: 'lots of whitespace',
+      // Note: there's a tab after "tab->", which prettier wants to keep as a
+      // literal tab rather than \t.  In the output, there should be a literal
+      // backslash-t.
+      input: gql`
+        query Foo($a: Int) {
+          user(
+            name: "   tab->	yay"
+            other: """
+            apple
+               bag
+            cat
+            """
+          ) {
+            name
+          }
+        }
+      `,
+      output:
+        'query Foo($a:Int){user(name:"   tab->\\tyay",other:"apple\\n   bag\\ncat"){name}}',
+    },
+  ];
+  cases.forEach(({ name, input, output }) => {
+    test(name, () => {
+      expect(printWithReducedWhitespace(input)).toEqual(output);
+    });
+  });
+});
+
+describe('hideLiterals', () => {
+  const cases = [
+    {
+      name: 'full test',
+      input: gql`
+        query Foo($b: Int, $a: Boolean) {
+          user(name: "hello", age: 5) {
+            ...Bar
+            ... on User {
+              hello
+              bee
+            }
+            tz
+            aliased: name
+          }
+        }
+
+        fragment Bar on User {
+          age @skip(if: $a)
+          ...Nested
+        }
+
+        fragment Nested on User {
+          blah
+        }
+      `,
+      output:
+        'query Foo($b:Int,$a:Boolean){user(name:"",age:0){...Bar...on User{hello bee}tz aliased:name}}' +
+        'fragment Bar on User{age@skip(if:$a)...Nested}fragment Nested on User{blah}',
+    },
+  ];
+  cases.forEach(({ name, input, output }) => {
+    test(name, () => {
+      expect(printWithReducedWhitespace(hideLiterals(input))).toEqual(output);
+    });
+  });
+});

packages/apollo-graphql/src/__tests__/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../../../tsconfig.test.base",
+  "include": ["**/*"],
+  "references": [
+    { "path": "../../" }
+  ]
+}

packages/apollo-graphql/src/index.ts

@@ -0,0 +1 @@
+export { defaultEngineReportingSignature } from './signature';