Fix #4 by making API equal to graphqls

README.md

@@ -9,10 +9,9 @@ import React from "react";
 import ReactDOM from "react-dom";
 import "./styles.css";
 
-import graphql from "reactive-graphql";
+import { graphql } from "reactive-graphql";
 
 import { makeExecutableSchema } from "graphql-tools";
-import gql from "graphql-tag";
 import { from, interval, of } from "rxjs";
 import { map, merge, scan, combineLatest } from "rxjs/operators";
 import { componentFromStream } from "@dcos/data-service";
@@ -66,7 +65,7 @@ const schema = makeExecutableSchema({
   }
 });
 
-const query = gql`
+const query = `
   query {
     posts {
       title
@@ -75,7 +74,7 @@ const query = gql`
   }
 `;
 
-const postStream = graphql(query, schema);
+const postStream = graphql(schema, query);
 const PostsList = componentFromStream(propsStream =>
   propsStream.pipe(
     combineLatest(postStream, (props, result) => {
@@ -108,10 +107,11 @@ ReactDOM.render(<App />, rootElement);
 
 - fragments of all kinds
 - subscriptions (as everything is treated as a subscription)
+- only one top-level operation is supported
 
 ## API
 
-The first argument you pass into `reactive-graphql` is an executable schema, the second one a parsed GraphQL query. You can pass in the root context as an object as a third parameter. The variables can be passed as 4th parameter.
+The 1st argument you pass into `reactive-graphql` is an executable schema, the 2nd one a GraphQL query, either parsed or as string. You can pass in the root value as 3rd and the root context as an object as 4th parameter. The variables can be passed as 5th parameter.
 
 The implementation will always return an Observable.
 If any of the resolvers returns an error the implementation will emit the error on the stream.

package.json

@@ -1,5 +1,9 @@
 {
   "name": "reactive-graphql",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mesosphere/reactive-graphql"
+  },
   "main": "./dist/index.js",
   "typings": "dist/index",
   "files": [

src/__tests__/fieldNotFoundMessageForType-test.ts

@@ -1,5 +1,5 @@
 import { GraphQLObjectType, GraphQLString, GraphQLScalarType } from "graphql";
-import { fieldNotFoundMessageForType } from "..";
+import { fieldNotFoundMessageForType } from "../reactive-graphql";
 
 describe("fieldNotFoundMessageForType", () => {
   it("returns a helpful message for null", () => {

src/__tests__/graphqlObservable-test.ts

@@ -6,7 +6,7 @@ import { marbles } from "rxjs-marbles/jest";
 import { makeExecutableSchema } from "graphql-tools";
 import gql from "graphql-tag";
 
-import graphqlObservable from "../";
+import { graphql } from "../";
 
 const typeDefs = `
   type Shuttle {
@@ -26,13 +26,24 @@ const typeDefs = `
 
 const mockResolvers = {
   Query: {
-    launched: (_, args, ctx) => {
+    launched: (parent, args, ctx) => {
       const { name } = args;
 
       // act according with the type of filter
       if (name === undefined) {
         // When no filter is passed
-        return ctx.query;
+        if (!parent) {
+          return ctx.query;
+        }
+
+        return ctx.query.pipe(
+          map((shuttles: any[]) =>
+            shuttles.map(shuttle => ({
+              ...shuttle,
+              name: shuttle.name + parent.shuttleSuffix
+            }))
+          )
+        );
       } else if (typeof name === "string") {
         // When the filter is a value
         return ctx.query.pipe(
@@ -179,6 +190,10 @@ const itMarbles = (title, test) => {
   return it(title, marbles(test));
 };
 
+itMarbles.only = (title, test) => {
+  return it.only(title, marbles(test));
+};
+
 describe("graphqlObservable", function() {
   describe("Query", function() {
     itMarbles("solves listing all fields", function(m) {
@@ -196,7 +211,27 @@ describe("graphqlObservable", function() {
         a: { data: { launched: expectedData } }
       });
 
-      const result = graphqlObservable(query, schema, { query: dataSource });
+      const result = graphql(schema, query, null, { query: dataSource });
+
+      m.expect(result.pipe(take(1))).toBeObservable(expected);
+    });
+
+    itMarbles("solves listing all fields with string query", function(m) {
+      const query = `
+        query {
+          launched {
+            name
+          }
+        }
+      `;
+
+      const expectedData = [{ name: "discovery" }];
+      const dataSource = of(expectedData);
+      const expected = m.cold("(a|)", {
+        a: { data: { launched: expectedData } }
+      });
+
+      const result = graphql(schema, query, null, { query: dataSource });
 
       m.expect(result.pipe(take(1))).toBeObservable(expected);
     });
@@ -218,11 +253,17 @@ describe("graphqlObservable", function() {
       });
 
       const nameFilter = of("apollo11");
-      const result = graphqlObservable(query, schema, {
-        query: dataSource
-      }, {
-        nameFilter
-      });
+      const result = graphql(
+        schema,
+        query,
+        null,
+        {
+          query: dataSource
+        },
+        {
+          nameFilter
+        }
+      );
 
       m.expect(result.pipe(take(1))).toBeObservable(expected);
     });
@@ -243,7 +284,7 @@ describe("graphqlObservable", function() {
         a: { data: { launched: [expectedData[0]] } }
       });
 
-      const result = graphqlObservable(query, schema, {
+      const result = graphql(schema, query, null, {
         query: dataSource
       });
 
@@ -265,7 +306,7 @@ describe("graphqlObservable", function() {
         a: { data: { launched: [{ name: "discovery" }] } }
       });
 
-      const result = graphqlObservable(query, schema, {
+      const result = graphql(schema, query, null, {
         query: dataSource
       });
 
@@ -287,13 +328,42 @@ describe("graphqlObservable", function() {
         a: { data: { launched: [{ title: "challenger" }] } }
       });
 
-      const result = graphqlObservable(query, schema, {
+      const result = graphql(schema, query, null, {
         query: dataSource
       });
 
       m.expect(result.pipe(take(1))).toBeObservable(expected);
     });
 
+    itMarbles.only("resolves using root value", function(m) {
+      const query = gql`
+        query {
+          launched {
+            name
+          }
+        }
+      `;
+
+      const expectedData = [{ name: "challenger", firstFlight: 1984 }];
+      const dataSource = of(expectedData);
+      const expected = m.cold("(a|)", {
+        a: { data: { launched: [{ name: "challenger-nasa" }] } }
+      });
+
+      const result = graphql(
+        schema,
+        query,
+        {
+          shuttleSuffix: "-nasa"
+        },
+        {
+          query: dataSource
+        }
+      );
+
+      m.expect(result.pipe(take(1))).toBeObservable(expected);
+    });
+
     describe("Field Resolvers", function() {
       describe("Leafs", function() {
         itMarbles("defaults to return the property on the object", function(m) {
@@ -307,7 +377,7 @@ describe("graphqlObservable", function() {
           const expected = m.cold("(a|)", {
             a: { data: { plain: { noFieldResolver: "Yes" } } }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
 
@@ -322,7 +392,7 @@ describe("graphqlObservable", function() {
           const expected = m.cold("(a|)", {
             a: { data: { plain: { fieldResolver: "I am a field resolver" } } }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
 
@@ -345,7 +415,7 @@ describe("graphqlObservable", function() {
               }
             }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
 
@@ -368,7 +438,7 @@ describe("graphqlObservable", function() {
               }
             }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
 
@@ -389,7 +459,7 @@ describe("graphqlObservable", function() {
               }
             }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
       });
@@ -414,7 +484,7 @@ describe("graphqlObservable", function() {
               }
             }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
 
@@ -441,7 +511,7 @@ describe("graphqlObservable", function() {
               }
             }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
 
@@ -468,7 +538,7 @@ describe("graphqlObservable", function() {
               }
             }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
 
@@ -491,7 +561,7 @@ describe("graphqlObservable", function() {
               }
             }
           });
-          const result = graphqlObservable(query, fieldResolverSchema, {});
+          const result = graphql(fieldResolverSchema, query, null, {});
           m.expect(result.pipe(take(1))).toBeObservable(expected);
         });
       });
@@ -521,7 +591,7 @@ describe("graphqlObservable", function() {
             }
           }
         });
-        const result = graphqlObservable(query, fieldResolverSchema, {});
+        const result = graphql(fieldResolverSchema, query, null, {});
         m.expect(result.pipe(take(1))).toBeObservable(expected);
       });
     });
@@ -539,7 +609,7 @@ describe("graphqlObservable", function() {
           "reactive-graphql: resolver 'throwingResolver' throws this error: 'Error: my personal error'"
         )
       );
-      const result = graphqlObservable(query, fieldResolverSchema, {});
+      const result = graphql(fieldResolverSchema, query, null, {});
       m.expect(result.pipe(take(1))).toBeObservable(expected);
     });
 
@@ -558,7 +628,7 @@ describe("graphqlObservable", function() {
             "reactive-graphql: field 'youDontKnowMe' was not found on type 'Query'. The only fields found in this Object are: plain,item,nested,throwingResolver."
           )
         );
-        const result = graphqlObservable(query, fieldResolverSchema, {});
+        const result = graphql(fieldResolverSchema, query, null, {});
         m.expect(result.pipe(take(1))).toBeObservable(expected);
       }
     );
@@ -577,7 +647,7 @@ describe("graphqlObservable", function() {
       const fakeRequest = { name: "RocketShip" };
       const commandContext = of(fakeRequest);
 
-      const result = graphqlObservable(mutation, schema, {
+      const result = graphql(schema, mutation, null, {
         mutation: commandContext
       });
 
@@ -601,7 +671,7 @@ describe("graphqlObservable", function() {
 
         const commandContext = of("a request");
 
-        const result = graphqlObservable(mutation, schema, {
+        const result = graphql(schema, mutation, null, {
           mutation: commandContext
         });
 
@@ -634,9 +704,15 @@ describe("graphqlObservable", function() {
       const variables = {
         name: "RocketShip"
       };
-      const result = graphqlObservable(mutation, schema, {
-        mutation: commandContext,
-      }, variables);
+      const result = graphql(
+        schema,
+        mutation,
+        null,
+        {
+          mutation: commandContext
+        },
+        variables
+      );
 
       const expected = m.cold("(a|)", {
         a: { data: { shut: { name: "RocketShip" } } }

src/__tests__/reference/starWarsQuery-test.ts

@@ -2,14 +2,20 @@ import gql from "graphql-tag";
 import { take } from "rxjs/operators";
 
 import StarWarsSchema from "./starWarsSchema";
-import graphqlObservable from "../../";
+import { graphql as graphqlObservable } from "../../";
 
-const graphql = (schema, query, _rootValue?, contextValue?, variableValues?) => {
+const graphql = (schema, query, rootValue?, contextValue?, variableValues?) => {
   return new Promise(resolve => {
     const taggedQuery = gql`
       ${query}
     `;
-    graphqlObservable(taggedQuery, schema, contextValue, variableValues)
+    graphqlObservable(
+      schema,
+      taggedQuery,
+      rootValue,
+      contextValue,
+      variableValues
+    )
       .pipe(take(1))
       .subscribe(resolve);
   });