fix(graphql): omit variables and operation name if empty. Fixes #243

Author: mefellows

src/dsl/graphql.spec.ts

@@ -26,12 +26,12 @@ describe("GraphQLInteraction", () => {
       });
     });
     describe("when no operation is provided", () => {
-      it("should marshal to null", () => {
+      it("should not be present in unmarshaled body", () => {
         interaction.uponReceiving("a request");
         interaction.withQuery("{ hello }");
 
         const json: any = interaction.json();
-        expect(json.request.body.operationName).to.eq(null);
+        expect(json.request.body).to.not.have.property("operationName");
       });
     });
     describe("when given an invalid operation", () => {
@@ -48,13 +48,23 @@ describe("GraphQLInteraction", () => {
         interaction.withOperation("query");
         interaction.withQuery("{ hello }");
         interaction.withVariables({
-          foo: "bar",
+          foo: "bar"
         });
 
         const json: any = interaction.json();
         expect(json.request.body.variables).to.deep.eq({ foo: "bar" });
       });
     });
+    describe("when no variables are provided", () => {
+      it("should not add the variables property to the payload", () => {
+        interaction.uponReceiving("a request");
+        interaction.withOperation("query");
+        interaction.withQuery("{ hello }");
+
+        const json: any = interaction.json();
+        expect(json.request.body).to.not.have.property("variables");
+      });
+    });
   });
 
   describe("#withQuery", () => {
@@ -63,13 +73,15 @@ describe("GraphQLInteraction", () => {
       interaction.withOperation("query");
       interaction.withQuery("{ hello }");
       interaction.withVariables({
-        foo: "bar",
+        foo: "bar"
       });
     });
 
     describe("when given an invalid query", () => {
       it("should fail with an error", () => {
-        expect(() => interaction.withQuery("{ not properly terminated")).to.throw(Error);
+        expect(() =>
+          interaction.withQuery("{ not properly terminated")
+        ).to.throw(Error);
       });
     });
 
@@ -101,7 +113,7 @@ describe("GraphQLInteraction", () => {
             }
           }`);
           interaction.withVariables({
-            name: "bar",
+            name: "bar"
           });
           const json: any = interaction.json();
 
@@ -110,9 +122,7 @@ describe("GraphQLInteraction", () => {
           const lotsOfWhitespace = `{             Hello(id: \$id) { name    } }`;
           expect(r.test(lotsOfWhitespace)).to.eq(true);
         });
-
       });
     });
   });
-
 });

src/dsl/graphql.ts

@@ -5,7 +5,7 @@
  */
 import { Interaction, InteractionState } from "../dsl/interaction";
 import { regex } from "./matchers";
-import { isNil, extend } from "lodash";
+import { isNil, extend, omitBy, isEmpty } from "lodash";
 import gql from "graphql-tag";
 
 export interface GraphQLVariables { [name: string]: any; }
@@ -81,12 +81,12 @@ export class GraphQLInteraction extends Interaction {
       throw new Error("You must provide a description for the query.");
     }
 
-    this.state.request =  extend({
-      body: {
+    this.state.request = extend({
+      body: omitBy({
         operationName: this.operation || null,
         query: regex({ generate: this.query, matcher: escapeGraphQlQuery(this.query) }),
         variables: this.variables,
-      },
+      }, isEmpty),
       headers: { "content-type": "application/json" },
       method: "POST",
     }, this.state.request);