Export useful sanitizing functions: printWithReducedWhitespace, hideStringAndNumericLiterals and hideLiterals (#2057)

Author: mcohen75

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 > **Note:** Apollo's GraphQL VSCode extension is no longer housed in this repository. It is now maintained separately in [this repo](https://github.com/apollographql/vscode-graphql).
 
+## vNEXT
+
+- `apollo-graphql`
+  - Export useful operation sanitization transforms [PR #2057](https://github.com/apollographql/apollo-tooling/pull/2057)
+
 ## `apollo@2.33.7`
 
 - `apollo-graphql@0.9.4`

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

@@ -1,6 +1,10 @@
 import { default as gql, disableFragmentWarnings } from "graphql-tag";
 
-import { printWithReducedWhitespace, hideLiterals } from "../transforms";
+import {
+  printWithReducedWhitespace,
+  hideLiterals,
+  hideStringAndNumericLiterals
+} from "../transforms";
 
 // The gql duplicate fragment warning feature really is just warnings; nothing
 // breaks if you turn it off in tests.
@@ -44,14 +48,27 @@ describe("hideLiterals", () => {
       name: "full test",
       input: gql`
         query Foo($b: Int, $a: Boolean) {
-          user(name: "hello", age: 5) {
+          user(
+            name: "hello"
+            age: 5
+            pct: 0.4
+            lst: ["a", "b", "c"]
+            obj: { a: "a", b: 1 }
+          ) {
             ...Bar
             ... on User {
               hello
               bee
             }
             tz
             aliased: name
+            withInputs(
+              str: "hi"
+              int: 2
+              flt: 0.3
+              lst: ["x", "y", "z"]
+              obj: { q: "r", s: 1 }
+            )
           }
         }
 
@@ -65,7 +82,8 @@ describe("hideLiterals", () => {
         }
       `,
       output:
-        'query Foo($b:Int,$a:Boolean){user(name:"",age:0){...Bar...on User{hello bee}tz aliased:name}}' +
+        'query Foo($b:Int,$a:Boolean){user(name:"",age:0,pct:0,lst:[],obj:{}){...Bar...on User{hello bee}tz aliased:name ' +
+        'withInputs(str:"",int:0,flt:0,lst:[],obj:{})}}' +
         "fragment Bar on User{age@skip(if:$a)...Nested}fragment Nested on User{blah}"
     }
   ];
@@ -75,3 +93,57 @@ describe("hideLiterals", () => {
     });
   });
 });
+
+describe("hideStringAndNumericLiterals", () => {
+  const cases = [
+    {
+      name: "full test",
+      input: gql`
+        query Foo($b: Int, $a: Boolean) {
+          user(
+            name: "hello"
+            age: 5
+            pct: 0.4
+            lst: ["a", "b", "c"]
+            obj: { a: "a", b: 1 }
+          ) {
+            ...Bar
+            ... on User {
+              hello
+              bee
+            }
+            tz
+            aliased: name
+            withInputs(
+              str: "hi"
+              int: 2
+              flt: 0.3
+              lst: ["", "", ""]
+              obj: { q: "", s: 0 }
+            )
+          }
+        }
+
+        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,pct:0,lst:["","",""],obj:{a:"",b:0}){...Bar...on User{hello bee}tz aliased:name ' +
+        'withInputs(str:"",int:0,flt:0,lst:["","",""],obj:{q:"",s:0})}}' +
+        "fragment Bar on User{age@skip(if:$a)...Nested}fragment Nested on User{blah}"
+    }
+  ];
+  cases.forEach(({ name, input, output }) => {
+    test(name, () => {
+      expect(
+        printWithReducedWhitespace(hideStringAndNumericLiterals(input))
+      ).toEqual(output);
+    });
+  });
+});

packages/apollo-graphql/src/index.ts

@@ -7,3 +7,8 @@ export {
   defaultUsageReportingSignature as defaultEngineReportingSignature
 } from "./operationId";
 export * from "./schema";
+export {
+  printWithReducedWhitespace,
+  hideStringAndNumericLiterals,
+  hideLiterals
+} from "./transforms";