Moved ReadOnly/BestEffort to Txn, Created TxnOptions

Author: Aelbannan

lib/client.d.ts

@@ -1,6 +1,6 @@
 import { DgraphClientStub } from "./clientStub";
 import { Txn } from "./txn";
-import { Operation, Payload, UiKeywords } from "./types";
+import { Operation, Payload, UiKeywords, TxnOptions } from "./types";
 export declare class DgraphClient {
     private readonly clients;
     private debugMode;
@@ -11,7 +11,7 @@ export declare class DgraphClient {
     alter(op: Operation): Promise<Payload>;
     login(userid: string, password: string): Promise<boolean>;
     logout(): void;
-    newTxn(): Txn;
+    newTxn(options?: TxnOptions): Txn;
     setDebugMode(mode?: boolean): void;
     fetchUiKeywords(): Promise<UiKeywords>;
     debug(msg: string): void;

lib/client.js

@@ -83,8 +83,8 @@ var DgraphClient = (function () {
         this.debug("Logout");
         this.clients.forEach(function (c) { return c.logout(); });
     };
-    DgraphClient.prototype.newTxn = function () {
-        return new txn_1.Txn(this);
+    DgraphClient.prototype.newTxn = function (options) {
+        return new txn_1.Txn(this, options);
     };
     DgraphClient.prototype.setDebugMode = function (mode) {
         if (mode === void 0) { mode = true; }

lib/txn.d.ts

@@ -1,20 +1,18 @@
 import { DgraphClient } from "./client";
-import { Assigned, Mutation, Response } from "./types";
+import { Assigned, Mutation, Response, TxnOptions } from "./types";
 export declare class Txn {
     private readonly dc;
     private readonly ctx;
     private finished;
     private mutated;
-    constructor(dc: DgraphClient);
+    constructor(dc: DgraphClient, options?: TxnOptions);
     query(q: string, options?: {
         debug?: boolean;
     }): Promise<Response>;
     queryWithVars(q: string, vars?: {
         [k: string]: any;
     }, options?: {
         debug?: boolean;
-        readOnly?: boolean;
-        bestEffort?: boolean;
     }): Promise<Response>;
     mutate(mu: Mutation): Promise<Assigned>;
     commit(): Promise<void>;

lib/txn.js

@@ -39,14 +39,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var errors_1 = require("./errors");
 var util_1 = require("./util");
 var Txn = (function () {
-    function Txn(dc) {
+    function Txn(dc, options) {
         this.finished = false;
         this.mutated = false;
         this.dc = dc;
+        if (options.bestEffort && !options.readOnly) {
+            this.dc.debug('Best effort only works with read-only queries.');
+            throw errors_1.ERR_ABORTED;
+        }
         this.ctx = {
             start_ts: 0,
             keys: [],
             preds: [],
+            readOnly: options.readOnly || false,
+            bestEffort: options.bestEffort || false
         };
     }
     Txn.prototype.query = function (q, options) {
@@ -63,17 +69,13 @@ var Txn = (function () {
                             this.dc.debug("Query request (ERR_FINISHED):\nquery = " + q + "\nvars = " + vars);
                             throw errors_1.ERR_FINISHED;
                         }
-                        if (options.bestEffort && !options.readOnly) {
-                            this.dc.debug('Best effort only works with read-only queries.');
-                            throw errors_1.ERR_FINISHED;
-                        }
                         req = {
                             query: q,
                             startTs: this.ctx.start_ts,
                             timeout: this.dc.getQueryTimeout(),
                             debug: options.debug,
-                            readOnly: options.readOnly,
-                            bestEffort: options.bestEffort
+                            readOnly: this.ctx.readOnly,
+                            bestEffort: this.ctx.bestEffort
                         };
                         if (vars !== undefined) {
                             varsObj_1 = {};

lib/types.d.ts

@@ -61,9 +61,15 @@ export interface TxnContext {
     aborted?: boolean | null;
     keys?: string[] | null;
     preds?: string[] | null;
+    readOnly: boolean;
+    bestEffort: boolean;
 }
 export interface Latency {
     parsing_ns?: number | null;
     processing_ns?: number | null;
     encoding_ns?: number | null;
 }
+export interface TxnOptions {
+    readOnly?: boolean;
+    bestEffort?: boolean;
+}

src/client.ts

@@ -1,7 +1,7 @@
 import { DgraphClientStub } from "./clientStub";
 import { ERR_NO_CLIENTS } from "./errors";
 import { Txn } from "./txn";
-import { Operation, Payload, UiKeywords } from "./types";
+import { Operation, Payload, UiKeywords, TxnOptions } from "./types";
 import { stringifyMessage } from "./util";
 
 /**
@@ -76,8 +76,8 @@ export class DgraphClient {
     /**
      * newTxn creates a new transaction.
      */
-    public newTxn(): Txn {
-        return new Txn(this);
+    public newTxn(options?: TxnOptions): Txn {
+        return new Txn(this, options);
     }
 
     /**

src/txn.ts

@@ -1,6 +1,6 @@
 import { DgraphClient } from "./client";
 import { ERR_ABORTED, ERR_FINISHED } from "./errors";
-import { Assigned, Mutation, Request, Response, TxnContext } from "./types";
+import { Assigned, Mutation, Request, Response, TxnContext, TxnOptions } from "./types";
 import {
     isAbortedError,
     isConflictError,
@@ -27,12 +27,20 @@ export class Txn {
     private finished: boolean = false;
     private mutated: boolean = false;
 
-    constructor(dc: DgraphClient) {
+    constructor(dc: DgraphClient, options?: TxnOptions) {
         this.dc = dc;
+
+        if (options.bestEffort && !options.readOnly) {
+            this.dc.debug('Best effort only works with read-only queries.');
+            throw ERR_ABORTED;
+        }
+
         this.ctx = {
           start_ts: 0,
           keys: [],
           preds: [],
+          readOnly: options.readOnly || false,
+          bestEffort: options.bestEffort || false
         };
     }
 
@@ -41,7 +49,7 @@ export class Txn {
      * need to be made in the same transaction, it's convenient to chain the method,
      * e.g. client.newTxn().query("...").
      */
-    public query(q: string, options?: { debug?: boolean, readOnly?: boolean, bestEffort?: boolean }): Promise<Response> {
+    public query(q: string, options?: { debug?: boolean }): Promise<Response> {
         return this.queryWithVars(q, undefined, options);
     }
 
@@ -52,25 +60,20 @@ export class Txn {
     public async queryWithVars(
         q: string,
         vars?: { [k: string]: any }, // tslint:disable-line no-any
-        options: { debug?: boolean, readOnly?: boolean, bestEffort?: boolean } = {},
+        options: { debug?: boolean } = {},
     ): Promise<Response> {
         if (this.finished) {
             this.dc.debug(`Query request (ERR_FINISHED):\nquery = ${q}\nvars = ${vars}`);
             throw ERR_FINISHED;
         }
 
-        if (options.bestEffort && !options.readOnly) {
-            this.dc.debug('Best effort only works with read-only queries.');
-            throw ERR_FINISHED;
-        }
-
         const req: Request = {
             query: q,
             startTs: this.ctx.start_ts,
             timeout: this.dc.getQueryTimeout(),
             debug: options.debug,
-            readOnly: options.readOnly,
-            bestEffort: options.bestEffort
+            readOnly: this.ctx.readOnly,
+            bestEffort: this.ctx.bestEffort
         };
         if (vars !== undefined) {
             const varsObj: { [k: string]: string } = {};

src/types.ts

@@ -66,10 +66,17 @@ export interface TxnContext {
     aborted?: boolean | null;
     keys?: string[] | null;
     preds?: string[] | null;
+    readOnly: boolean;
+    bestEffort: boolean;
 }
 
 export interface Latency {
     parsing_ns?: number | null;
     processing_ns?: number | null;
     encoding_ns?: number | null;
 }
+
+export interface TxnOptions {
+    readOnly?: boolean,
+    bestEffort?: boolean
+}