Add support for alpha's auth_token and Slash API key

Author: Paul Korzhyk

README.md

@@ -12,28 +12,28 @@ This client follows the [Dgraph Javascript gRPC client][grpcclient] closely.
 Before using this client, we highly recommend that you go through [docs.dgraph.io],
 and understand how to run and work with Dgraph.
 
-[docs.dgraph.io]:https://docs.dgraph.io
+[docs.dgraph.io]: https://docs.dgraph.io
 
 **Use [Discuss Issues](https://discuss.dgraph.io/c/issues/35) for reporting issues about this repository.**
 
 ## Table of contents
 
-  - [Install](#install)
-  - [Supported Versions](#supported-versions)
-  - [Quickstart](#quickstart)
-  - [Using a client](#using-a-client)
-    - [Create a client](#create-a-client)
-    - [Login into Dgraph](#login-into-dgraph)
-    - [Alter the database](#alter-the-database)
-    - [Create a transaction](#create-a-transaction)
-    - [Run a mutation](#run-a-mutation)
-    - [Run a query](#run-a-query)
-    - [Commit a transaction](#commit-a-transaction)
-    - [Check request latency](#check-request-latency)
-    - [Debug mode](#debug-mode)
-  - [Development](#development)
-    - [Building the source](#building-the-source)
-    - [Running tests](#running-tests)
+-   [Install](#install)
+-   [Supported Versions](#supported-versions)
+-   [Quickstart](#quickstart)
+-   [Using a client](#using-a-client)
+    -   [Create a client](#create-a-client)
+    -   [Login into Dgraph](#login-into-dgraph)
+    -   [Alter the database](#alter-the-database)
+    -   [Create a transaction](#create-a-transaction)
+    -   [Run a mutation](#run-a-mutation)
+    -   [Run a query](#run-a-query)
+    -   [Commit a transaction](#commit-a-transaction)
+    -   [Check request latency](#check-request-latency)
+    -   [Debug mode](#debug-mode)
+-   [Development](#development)
+    -   [Building the source](#building-the-source)
+    -   [Running tests](#running-tests)
 
 ## Install
 
@@ -60,9 +60,9 @@ Depending on the version of Dgraph that you are connecting to, you will have to
 use a different version of this client.
 
 | Dgraph version | dgraph-js-http version |
-|:--------------------:|:------------------------------:|
-|      >= 20.03.0      |           >= *20.3.0*          |
-|        >= 1.1       |            >= *1.1.0*           |
+| :------------: | :--------------------: |
+|   >= 20.03.0   |      >= _20.3.0_       |
+|     >= 1.1     |       >= _1.1.0_       |
 
 ## Quickstart
 
@@ -86,10 +86,10 @@ The following code snippet shows just one connection.
 const dgraph = require("dgraph-js-http");
 
 const clientStub = new dgraph.DgraphClientStub(
-  // addr: optional, default: "http://localhost:8080"
-  "http://localhost:8080",
-  // legacyApi: optional, default: false. Set to true when connecting to Dgraph v1.0.x
-  false,
+    // addr: optional, default: "http://localhost:8080"
+    "http://localhost:8080",
+    // legacyApi: optional, default: false. Set to true when connecting to Dgraph v1.0.x
+    false,
 );
 const dgraphClient = new dgraph.DgraphClient(clientStub);
 ```
@@ -118,31 +118,51 @@ you need to `login` again on a periodic basis:
 await clientStub.login();
 ```
 
+### Configure access tokens
+
+Some Dgraph configurations require extra access tokens.
+
+1. Alpha servers can be configured with [Secure Alter Operations](https://dgraph.io/docs/deploy/dgraph-administration/#securing-alter-operations).
+   In this case the token needs to be set on the client instance:
+
+```js
+dgraphClient.setAlphaAuthToken("My secret token value");
+```
+
+2. [Slash GraphQL](https://dgraph.io/slash-graphql) requires API key for HTTP access:
+
+```js
+dgraphClient.setSlashApiKey("Copy the Api Key from Slash GraphQL admin page");
+```
+
 ### 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');
+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');
+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 clientStub = new dgraph.DgraphClientStub(
+    "https://localhost:8080",
+    false,
+    { agent },
+);
 const dgraphClient = new dgraph.DgraphClient(clientStub);
 ```
 
-
 ### Alter the database
 
 To set the schema, pass the schema to `DgraphClient#alter(Operation)` method.
@@ -180,15 +200,15 @@ and you can call `Txn#discard()` multiple times with no additional side-effects.
 ```js
 const txn = dgraphClient.newTxn();
 try {
-  // Do something here
-  // ...
+    // Do something here
+    // ...
 } finally {
-  await txn.discard();
-  // ...
+    await txn.discard();
+    // ...
 }
 ```
 
-You can make queries read-only and best effort by passing ```options``` to ```DgraphClient#newTxn```. For example:
+You can make queries read-only and best effort by passing `options` to `DgraphClient#newTxn`. For example:
 
 ```js
 const options = { readOnly: true, bestEffort: true };
@@ -197,7 +217,6 @@ const res = await dgraphClient.newTxn(options).query(query);
 
 Read-only transactions are useful to increase read speed because they can circumvent the usual consensus protocol. Best effort queries can also increase read speed in read bound system. Please note that best effort requires readonly.
 
-
 ### Run a mutation
 
 `Txn#mutate(Mutation)` runs a mutation. It takes in a `Mutation` object, which
@@ -232,7 +251,6 @@ mutation must be immediately committed.
 await txn.mutate({ setJson: p, commitNow: true });
 ```
 
-
 ### Run a query
 
 You can run a query by calling `Txn#query(string)`. You will need to pass in a
@@ -243,7 +261,7 @@ the variables object as the second argument.
 The response would contain the `data` field, `Response#data`, which returns the response
 JSON.
 
-Let’s run the following query with a variable $a:
+Let’s run the following query with a variable \$a:
 
 ```console
 query all($a: string) {
@@ -270,7 +288,7 @@ const ppl = res.data;
 
 // Print results.
 console.log(`Number of people named "Alice": ${ppl.all.length}`);
-ppl.all.forEach((person) => console.log(person.name));
+ppl.all.forEach(person => console.log(person.name));
 ```
 
 This should print:
@@ -280,7 +298,6 @@ Number of people named "Alice": 1
 Alice
 ```
 
-
 ### Commit a transaction
 
 A transaction can be committed using the `Txn#commit()` method. If your transaction
@@ -294,21 +311,21 @@ transactions when they fail.
 ```js
 const txn = dgraphClient.newTxn();
 try {
-  // ...
-  // Perform any number of queries and mutations
-  // ...
-  // and finally...
-  await txn.commit();
+    // ...
+    // Perform any number of queries and mutations
+    // ...
+    // and finally...
+    await txn.commit();
 } catch (e) {
-  if (e === dgraph.ERR_ABORTED) {
-    // Retry or handle exception.
-  } else {
-    throw e;
-  }
+    if (e === dgraph.ERR_ABORTED) {
+        // Retry or handle exception.
+    } else {
+        throw e;
+    }
 } finally {
-  // Clean up. Calling this after txn.commit() is a no-op
-  // and hence safe.
-  await txn.discard();
+    // Clean up. Calling this after txn.commit() is a no-op
+    // and hence safe.
+    await txn.discard();
 }
 ```
 

lib/client.d.ts

@@ -9,6 +9,8 @@ export declare class DgraphClient {
     setQueryTimeout(timeout: number): DgraphClient;
     getQueryTimeout(): number;
     alter(op: Operation): Promise<Payload>;
+    setAlphaAuthToken(authToken: string): void;
+    setSlashApiKey(apiKey: string): void;
     login(userid: string, password: string): Promise<boolean>;
     logout(): void;
     newTxn(options?: TxnOptions): Txn;

lib/client.js

@@ -36,6 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DgraphClient = void 0;
 var errors_1 = require("./errors");
 var txn_1 = require("./txn");
 var util_1 = require("./util");
@@ -69,6 +70,14 @@ var DgraphClient = (function () {
             });
         });
     };
+    DgraphClient.prototype.setAlphaAuthToken = function (authToken) {
+        this.clients.forEach(function (c) {
+            return c.setAlphaAuthToken(authToken);
+        });
+    };
+    DgraphClient.prototype.setSlashApiKey = function (apiKey) {
+        this.clients.forEach(function (c) { return c.setSlashApiKey(apiKey); });
+    };
     DgraphClient.prototype.login = function (userid, password) {
         return __awaiter(this, void 0, void 0, function () {
             var c;

lib/clientStub.d.ts

@@ -28,6 +28,8 @@ export declare class DgraphClientStub {
     getHealth(all?: boolean): Promise<Response>;
     getState(): Promise<Response>;
     setAutoRefresh(val: boolean): void;
+    setAlphaAuthToken(authToken: string): void;
+    setSlashApiKey(apiKey: string): void;
     private cancelRefreshTimer;
     private maybeStartRefreshTimer;
     private callAPI;

lib/clientStub.js

@@ -47,10 +47,14 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DgraphClientStub = void 0;
 var fetch = require("isomorphic-fetch");
 var jwt = require("jsonwebtoken");
 var errors_1 = require("./errors");
 var AUTO_REFRESH_PREFETCH_TIME = 5000;
+var ACL_TOKEN_HEADER = "X-Dgraph-AccessToken";
+var ALPHA_AUTH_TOKEN_HEADER = "X-Dgraph-AuthToken";
+var SLASH_API_KEY_HEADER = "X-Auth-Token";
 var DgraphClientStub = (function () {
     function DgraphClientStub(addr, stubConfig, options) {
         if (stubConfig === void 0) { stubConfig = {}; }
@@ -104,7 +108,8 @@ var DgraphClientStub = (function () {
         return this.callAPI("alter", __assign(__assign({}, this.options), { method: "POST", body: body }));
     };
     DgraphClientStub.prototype.query = function (req) {
-        var headers = Object.assign({}, this.options.headers !== undefined ? this.options.headers : {});
+        var headers = this.options.headers !== undefined
+            ? __assign({}, this.options.headers) : {};
         if (req.vars !== undefined) {
             if (this.legacyApi) {
                 headers["X-Dgraph-Vars"] = JSON.stringify(req.vars);
@@ -213,9 +218,7 @@ var DgraphClientStub = (function () {
         else {
             return Promise.reject("Mutation has no data");
         }
-        var headers = Object.assign({}, this.options.headers !== undefined ? this.options.headers : {}, {
-            "Content-Type": "application/" + (usingJSON ? "json" : "rdf"),
-        });
+        var headers = __assign(__assign({}, (this.options.headers !== undefined ? this.options.headers : {})), { "Content-Type": "application/" + (usingJSON ? "json" : "rdf") });
         if (usingJSON && this.legacyApi) {
             headers["X-Dgraph-MutationType"] = "json";
         }
@@ -253,7 +256,7 @@ var DgraphClientStub = (function () {
     DgraphClientStub.prototype.abort = function (ctx) {
         var url = !this.legacyApi
             ? "commit?startTs=" + ctx.start_ts + "&abort=true"
-            : "/abort/" + ctx.start_ts;
+            : "abort/" + ctx.start_ts;
         return this.callAPI(url, __assign(__assign({}, this.options), { method: "POST" }));
     };
     DgraphClientStub.prototype.login = function (userid, password, refreshToken) {
@@ -279,10 +282,7 @@ var DgraphClientStub = (function () {
                             body.userid = userid;
                             body.password = password;
                         }
-                        return [4, this.callAPI("login", {
-                                method: "POST",
-                                body: JSON.stringify(body),
-                            })];
+                        return [4, this.callAPI("login", __assign(__assign({}, this.options), { method: "POST", body: JSON.stringify(body) }))];
                     case 1:
                         res = _a.sent();
                         this.accessToken = res.data.accessJWT;
@@ -332,6 +332,12 @@ var DgraphClientStub = (function () {
         this.autoRefresh = val;
         this.maybeStartRefreshTimer(this.accessToken);
     };
+    DgraphClientStub.prototype.setAlphaAuthToken = function (authToken) {
+        this.options.headers[ALPHA_AUTH_TOKEN_HEADER] = authToken;
+    };
+    DgraphClientStub.prototype.setSlashApiKey = function (apiKey) {
+        this.options.headers[SLASH_API_KEY_HEADER] = apiKey;
+    };
     DgraphClientStub.prototype.cancelRefreshTimer = function () {
         if (this.autoRefreshTimer !== undefined) {
             clearTimeout(this.autoRefreshTimer);
@@ -358,7 +364,7 @@ var DgraphClientStub = (function () {
                         url = this.getURL(path);
                         if (this.accessToken !== undefined && path !== "login") {
                             config.headers = config.headers !== undefined ? config.headers : {};
-                            config.headers["X-Dgraph-AccessToken"] = this.accessToken;
+                            config.headers[ACL_TOKEN_HEADER] = this.accessToken;
                         }
                         return [4, fetch(url, config)];
                     case 1:

lib/errors.js

@@ -13,6 +13,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIError = exports.CustomError = exports.ERR_BEST_EFFORT_REQUIRED_READ_ONLY = exports.ERR_ABORTED = exports.ERR_FINISHED = exports.ERR_NO_CLIENTS = void 0;
 exports.ERR_NO_CLIENTS = new Error("No clients provided in DgraphClient constructor");
 exports.ERR_FINISHED = new Error("Transaction has already been committed or discarded");
 exports.ERR_ABORTED = new Error("Transaction has been aborted. Please retry");

lib/index.js

@@ -1,9 +1,17 @@
 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./clientStub"));
-__export(require("./client"));
-__export(require("./txn"));
-__export(require("./errors"));
+__exportStar(require("./types"), exports);
+__exportStar(require("./clientStub"), exports);
+__exportStar(require("./client"), exports);
+__exportStar(require("./txn"), exports);
+__exportStar(require("./errors"), exports);

lib/txn.js

@@ -36,6 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Txn = void 0;
 var errors_1 = require("./errors");
 var util_1 = require("./util");
 var Txn = (function () {

lib/util.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyMessage = exports.isConflictError = exports.isAbortedError = void 0;
 var errors_1 = require("./errors");
 function isAbortedError(error) {
     if (!(error instanceof errors_1.APIError)) {