Merge pull request #87 from semi-technologies/WEAVIATE-332-js-client

Add raw GraphQL ability to javascript client

Author: antas-marcin

graphql/explorer.js

@@ -3,6 +3,7 @@ import NearVector from "./nearVector";
 import NearObject from "./nearObject";
 import NearImage from "./nearImage";
 import Ask from "./ask";
+import Raw from "./raw";
 import { DEFAULT_KIND, validateKind } from "../kinds";
 
 export default class Explorer {

graphql/index.js

@@ -1,12 +1,14 @@
 import Aggregator from "./aggregator";
 import Getter from "./getter";
 import Explorer from "./explorer";
+import Raw from "./raw";
 
 const graphql = (client) => {
   return {
     get: () => new Getter(client),
     aggregate: () => new Aggregator(client),
     explore: () => new Explorer(client),
+    raw: () => new Raw(client),
   };
 };
 

graphql/journey.test.js

@@ -12,6 +12,18 @@ describe("the graphql journey", () => {
     return setup(client);
   });
 
+
+  test("graphql raw method", () => {
+    return client.graphql
+      .raw()
+      .withQuery("{Get{Article{title url wordCount}}}")
+      .do()
+      .then(function (result) {
+        expect(result.data.Get.Article.length).toEqual(3);
+      });
+  });
+
+
   test("graphql get method with minimal fields", () => {
     return client.graphql
       .get()

graphql/raw.js

@@ -0,0 +1,45 @@
+export default class RawGraphQL {
+    
+    constructor(client, quer) {
+        this.client = client;
+        this.errors = [];
+    }
+
+    withQuery = (query) => {
+        this.query = query;
+        return this;
+    };
+
+      
+    validateIsSet = (prop, name, setter) => {
+        if (prop == undefined || prop == null || prop.length == 0) {
+            this.errors = [
+                ...this.errors,
+                `${name} must be set - set with ${setter}`,
+            ];
+        }
+    };
+
+    validate = () => {
+        this.validateIsSet(
+            this.query,
+            "query",
+            ".raw().withQuery(query)"
+        );
+    };
+
+    do = () => {
+        let params = "";
+
+        this.validate();
+        if (this.errors.length > 0) {
+            return Promise.reject(
+                new Error("invalid usage: " + this.errors.join(", "))
+            );
+        }
+
+        if (this.query) {
+            return this.client.query(this.query);
+        };
+    }
+}

graphql/raw.test.js

@@ -0,0 +1,23 @@
+import Raw from "./raw";
+
+test("a simple raw query", () => {
+  const mockClient = {
+    query: jest.fn(),
+  };
+
+  const expectedQuery = `{Get{Person{name}}}`;
+
+  new Raw(mockClient).withQuery(expectedQuery).do();
+
+  expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
+});
+
+test("reject empty raw query", () => {
+    const mockClient = {
+      query: jest.fn(),
+    };
+    
+        new Raw(mockClient, "").do().catch(err => {
+            expect(err).toMatchObject(new Error("invalid usage: query must be set - set with .raw().withQuery(query)"));
+        });
+  });