Merge pull request #27 from shaneu/feature/adding-tls-support

Paul Korzhyk · web-flow · commit 1837d8dd89dd · 2020-05-18T16:44:31.000+03:00
Feature/adding tls support
diff --git a/README.md b/README.md
@@ -116,6 +116,30 @@ you need to `login` again on a periodic basis:
 await clientStub.login();
 ```
 
+### Create https connection
+
+If your cluster is using tls/mtls you can pass a node `https.Agent` configured with you
+certificates as follows:
+
+```js
+const https = require('https');
+const fs = require('fs');
+// read your certificates
+const cert = fs.readFileSync('./certs/client.crt', 'utf8');
+const ca = fs.readFileSync('./certs/ca.crt', 'utf8');
+const key = fs.readFileSync('./certs/client.key', 'utf8');
+
+// create your https.Agent
+const agent = https.Agent({
+    cert,
+    ca,
+    key,
+})
+
+const clientStub = new dgraph.DgraphClientStub('https://localhost:8080', false, {agent});
+const dgraphClient = new dgraph.DgraphClient(clientStub);
+```
+
 
 ### Alter the database
 
diff --git a/lib/clientStub.d.ts b/lib/clientStub.d.ts
@@ -1,12 +1,13 @@
-import { Assigned, Mutation, Operation, Payload, Request, Response, TxnContext, UiKeywords } from "./types";
+import { Assigned, Mutation, Operation, Options, Payload, Request, Response, TxnContext, UiKeywords } from "./types";
 export declare class DgraphClientStub {
     private readonly addr;
+    private readonly options;
     private legacyApi;
     private accessToken;
     private refreshToken;
     private autoRefresh;
     private autoRefreshTimer?;
-    constructor(addr?: string, legacyApi?: boolean);
+    constructor(addr?: string, legacyApi?: boolean, options?: Options);
     detectApiVersion(): Promise<string>;
     alter(op: Operation): Promise<Payload>;
     query(req: Request): Promise<Response>;
diff --git a/lib/clientStub.js b/lib/clientStub.js
@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -41,13 +52,19 @@ var jwt = require("jsonwebtoken");
 var errors_1 = require("./errors");
 var AUTO_REFRESH_PREFETCH_TIME = 5000;
 var DgraphClientStub = (function () {
-    function DgraphClientStub(addr, legacyApi) {
+    function DgraphClientStub(addr, legacyApi, options) {
         if (addr === undefined) {
             this.addr = "http://localhost:8080";
         }
         else {
             this.addr = addr;
         }
+        if (options === undefined) {
+            this.options = {};
+        }
+        else {
+            this.options = options;
+        }
         this.legacyApi = !!legacyApi;
     }
     DgraphClientStub.prototype.detectApiVersion = function () {
@@ -82,10 +99,7 @@ var DgraphClientStub = (function () {
         else {
             return Promise.reject("Invalid op argument in alter");
         }
-        return this.callAPI("alter", {
-            method: "POST",
-            body: body,
-        });
+        return this.callAPI("alter", __assign(__assign({}, this.options), { method: "POST", body: body }));
     };
     DgraphClientStub.prototype.query = function (req) {
         var headers = {};
@@ -155,11 +169,7 @@ var DgraphClientStub = (function () {
                     .join("&");
             }
         }
-        return this.callAPI(url, {
-            method: "POST",
-            body: req.query,
-            headers: headers,
-        });
+        return this.callAPI(url, __assign(__assign({}, this.options), { method: "POST", body: req.query, headers: headers }));
     };
     DgraphClientStub.prototype.mutate = function (mu) {
         var body;
@@ -222,11 +232,8 @@ var DgraphClientStub = (function () {
                 headers["X-Dgraph-CommitNow"] = "true";
             }
         }
-        return this.callAPI(url, {
-            method: "POST",
-            body: body,
-            headers: headers,
-        });
+        return this.callAPI(url, __assign(__assign({}, this.options), { method: "POST", body: body,
+            headers: headers }));
     };
     DgraphClientStub.prototype.commit = function (ctx) {
         var body;
@@ -239,16 +246,13 @@ var DgraphClientStub = (function () {
         var url = !this.legacyApi
             ? "commit?startTs=" + ctx.start_ts
             : "commit/" + ctx.start_ts;
-        return this.callAPI(url, {
-            method: "POST",
-            body: body,
-        });
+        return this.callAPI(url, __assign(__assign({}, this.options), { method: "POST", body: body }));
     };
     DgraphClientStub.prototype.abort = function (ctx) {
         var url = !this.legacyApi
             ? "commit?startTs=" + ctx.start_ts + "&abort=true"
             : "/abort/" + ctx.start_ts;
-        return this.callAPI(url, { method: "POST" });
+        return this.callAPI(url, __assign(__assign({}, this.options), { method: "POST" }));
     };
     DgraphClientStub.prototype.login = function (userid, password, refreshToken) {
         return __awaiter(this, void 0, void 0, function () {
@@ -300,24 +304,22 @@ var DgraphClientStub = (function () {
     DgraphClientStub.prototype.fetchUiKeywords = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2, this.callAPI("ui/keywords", {})];
+                return [2, this.callAPI("ui/keywords", this.options)];
             });
         });
     };
     DgraphClientStub.prototype.getHealth = function (all) {
         if (all === void 0) { all = false; }
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2, this.callAPI("health" + (all ? "?all" : ""), {
-                        acceptRawText: true,
-                    })];
+                return [2, this.callAPI("health" + (all ? "?all" : ""), __assign(__assign({}, this.options), { acceptRawText: true }))];
             });
         });
     };
     DgraphClientStub.prototype.getState = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2, this.callAPI("state", {})];
+                return [2, this.callAPI("state", this.options)];
             });
         });
     };
diff --git a/lib/types.d.ts b/lib/types.d.ts
@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import * as https from "https";
 export interface Operation {
     schema?: string | null;
     dropAttr?: string | null;
@@ -76,3 +78,10 @@ export interface TxnOptions {
 export interface ErrorNonJson extends Error {
     responseText?: string;
 }
+export interface Options extends https.RequestOptions {
+    agent?: https.Agent;
+}
+export interface Config extends Options {
+    acceptRawText?: boolean;
+    body?: string;
+}
diff --git a/src/clientStub.ts b/src/clientStub.ts
@@ -4,10 +4,12 @@ import * as jwt from "jsonwebtoken";
 import { APIError, APIResultError } from "./errors";
 import {
     Assigned,
+    Config,
     ErrorNonJson,
     LoginResponse,
     Mutation,
     Operation,
+    Options,
     Payload,
     Request,
     Response,
@@ -23,18 +25,26 @@ const AUTO_REFRESH_PREFETCH_TIME = 5000;
  */
 export class DgraphClientStub {
     private readonly addr: string;
+    private readonly options: Options;
     private legacyApi: boolean;
     private accessToken: string;
     private refreshToken: string;
     private autoRefresh: boolean;
     private autoRefreshTimer?: number;
 
-    constructor(addr?: string, legacyApi?: boolean) {
+    constructor(addr?: string, legacyApi?: boolean, options?: Options) {
         if (addr === undefined) {
             this.addr = "http://localhost:8080"; // tslint:disable-line no-http-string
         } else {
             this.addr = addr;
         }
+
+        if (options === undefined) {
+            this.options = {};
+        } else {
+            this.options = options;
+        }
+
         this.legacyApi = !!legacyApi;
     }
 
@@ -62,6 +72,7 @@ export class DgraphClientStub {
         }
 
         return this.callAPI("alter", {
+            ...this.options,
             method: "POST",
             body,
         });
@@ -142,6 +153,7 @@ export class DgraphClientStub {
         }
 
         return this.callAPI(url, {
+            ...this.options,
             method: "POST",
             body: req.query,
             headers,
@@ -224,6 +236,7 @@ export class DgraphClientStub {
         }
 
         return this.callAPI(url, {
+            ...this.options,
             method: "POST",
             body,
             headers,
@@ -243,6 +256,7 @@ export class DgraphClientStub {
             : `commit/${ctx.start_ts}`;
 
         return this.callAPI(url, {
+            ...this.options,
             method: "POST",
             body,
         });
@@ -253,7 +267,7 @@ export class DgraphClientStub {
             ? `commit?startTs=${ctx.start_ts}&abort=true`
             : `/abort/${ctx.start_ts}`;
 
-        return this.callAPI(url, { method: "POST" });
+        return this.callAPI(url, { ...this.options, method: "POST" });
     }
 
     public async login(
@@ -307,14 +321,15 @@ export class DgraphClientStub {
     }
 
     public async fetchUiKeywords(): Promise<UiKeywords> {
-        return this.callAPI("ui/keywords", {});
+        return this.callAPI("ui/keywords", this.options);
     }
 
     /**
      * Gets instance or cluster health, based on the all param
      */
     public async getHealth(all: boolean = false): Promise<Response> {
         return this.callAPI(`health${all ? "?all" : ""}`, {
+            ...this.options,
             acceptRawText: true,
         });
     }
@@ -323,7 +338,7 @@ export class DgraphClientStub {
      * Gets the state of the cluster
      */
     public async getState(): Promise<Response> {
-        return this.callAPI("state", {});
+        return this.callAPI("state", this.options);
     }
 
     public setAutoRefresh(val: boolean) {
@@ -369,12 +384,7 @@ export class DgraphClientStub {
 
     private async callAPI<T>(
         path: string,
-        config: {
-            acceptRawText?: boolean;
-            method?: string;
-            body?: string;
-            headers?: { [k: string]: string };
-        },
+        config: Config,
     ): Promise<T> {
         const url = this.getURL(path);
         if (this.accessToken !== undefined && path !== "login") {
diff --git a/src/types.ts b/src/types.ts
@@ -1,3 +1,5 @@
+import * as https from "https";
+
 export interface Operation {
     schema?: string | null;
     dropAttr?: string | null;
@@ -85,3 +87,12 @@ export interface TxnOptions {
 export interface ErrorNonJson extends Error {
     responseText?: string;
 }
+
+export interface Options extends https.RequestOptions {
+    agent?: https.Agent;
+}
+
+export interface Config extends Options {
+    acceptRawText?: boolean;
+    body?: string;
+}
