fix: ensure table funcs accept gaxOptions directly (googleapis#1371)

AVaksman · Jun 29, 2021 · 41788f4 · 41788f4
1 parent 1165cf5
commit 41788f4
Show file tree

Hide file tree

Showing 2 changed files with 111 additions and 31 deletions.
diff --git a/src/table.ts b/src/table.ts
@@ -327,12 +327,12 @@ class Table {
   }
   deleteRows(
     keys: Key[],
-    options?: DeleteRowsOptions
+    options?: DeleteRowsOptions | CallOptions
   ): Promise<DeleteRowsResponse>;
   deleteRows(keys: Key[], callback: DeleteRowsCallback): void;
   deleteRows(
     keys: Key[],
-    options: DeleteRowsOptions,
+    options: DeleteRowsOptions | CallOptions,
     callback: DeleteRowsCallback
   ): void;
   /**
@@ -383,7 +383,7 @@ class Table {
    */
   deleteRows(
     keys: Key[],
-    optionsOrCallback?: DeleteRowsOptions | DeleteRowsCallback,
+    optionsOrCallback?: DeleteRowsOptions | CallOptions | DeleteRowsCallback,
     cb?: DeleteRowsCallback
   ): Promise<DeleteRowsResponse> | void {
     const options =
@@ -452,12 +452,12 @@ class Table {
   }
   insert(
     rows: object | object[],
-    options?: InsertRowsOptions
+    options?: InsertRowsOptions | CallOptions
   ): Promise<InsertRowsResponse>;
   insert(rows: object | object[], callback: InsertRowsCallback): void;
   insert(
     rows: object | object[],
-    options: InsertRowsOptions,
+    options: InsertRowsOptions | CallOptions,
     callback: InsertRowsCallback
   ): void;
   /**
@@ -467,7 +467,7 @@ class Table {
    *
    * @param {object|object[]} rows A map of names to values of data to insert
    *     into this table.
-   * @param {DeleteRowsOptions} [options] Options for configuring the request.
+   * @param {InsertRowsOptions} [options] Options for configuring the request.
    * @param {BasicCallback} [callback] Callback function.
    * @returns {Promise<BasicResponse>}
    *
@@ -519,7 +519,7 @@ class Table {
    */
   insert(
     rows: object | object[],
-    optionsOrCallback?: InsertRowsOptions | InsertRowsCallback,
+    optionsOrCallback?: InsertRowsOptions | CallOptions | InsertRowsCallback,
     cb?: InsertRowsCallback
   ): Promise<InsertRowsResponse> | void {
     const options =
@@ -709,12 +709,12 @@ class Table {
   }
   replace(
     rows: object | object[],
-    options?: ReplaceRowsOptions
+    options?: ReplaceRowsOptions | CallOptions
   ): Promise<ReplaceRowsResponse>;
   replace(rows: object | object[], callback: ReplaceRowsCallback): void;
   replace(
     rows: object | object[],
-    options: ReplaceRowsOptions,
+    options: ReplaceRowsOptions | CallOptions,
     callback: ReplaceRowsCallback
   ): void;
   /**
@@ -759,7 +759,7 @@ class Table {
    */
   replace(
     rows: object | object[],
-    optionsOrCallback?: ReplaceRowsOptions | ReplaceRowsCallback,
+    optionsOrCallback?: ReplaceRowsOptions | CallOptions | ReplaceRowsCallback,
     cb?: ReplaceRowsCallback
   ): Promise<ReplaceRowsResponse> | void {
     const options =
@@ -771,12 +771,12 @@ class Table {
   }
   update(
     rows: object | object[],
-    options?: UpdateRowsOptions
+    options?: UpdateRowsOptions | CallOptions
   ): Promise<UpdateRowsResponse>;
   update(rows: object | object[], callback: UpdateRowsCallback): void;
   update(
     rows: object | object[],
-    options: UpdateRowsOptions,
+    options: UpdateRowsOptions | CallOptions,
     callback: UpdateRowsCallback
   ): void;
   /**
@@ -825,7 +825,7 @@ class Table {
    */
   update(
     rows: object | object[],
-    optionsOrCallback?: UpdateRowsOptions | UpdateRowsCallback,
+    optionsOrCallback?: UpdateRowsOptions | CallOptions | UpdateRowsCallback,
     cb?: UpdateRowsCallback
   ): Promise<UpdateRowsResponse> | void {
     const options =
@@ -837,12 +837,12 @@ class Table {
   }
   upsert(
     rows: object | object[],
-    options?: UpsertRowsOptions
+    options?: UpsertRowsOptions | CallOptions
   ): Promise<UpsertRowsResponse>;
   upsert(rows: object | object[], callback: UpsertRowsCallback): void;
   upsert(
     rows: object | object[],
-    options: UpsertRowsOptions,
+    options: UpsertRowsOptions | CallOptions,
     callback: UpsertRowsCallback
   ): void;
   /**
@@ -888,7 +888,7 @@ class Table {
    */
   upsert(
     rows: object | object[],
-    optionsOrCallback?: UpsertRowsOptions | UpsertRowsCallback,
+    optionsOrCallback?: UpsertRowsOptions | CallOptions | UpsertRowsCallback,
     cb?: UpsertRowsCallback
   ): Promise<UpsertRowsResponse> | void {
     const options =

diff --git a/test/table.ts b/test/table.ts
@@ -255,12 +255,12 @@ describe('Table', () => {
     });
 
     it('should accept gaxOptions', done => {
-      const deleteRowsOptions = {gaxOptions: {}};
+      const gaxOptions = {};
       transaction.commit = options => {
-        assert.strictEqual(options, deleteRowsOptions);
+        assert.strictEqual(options, gaxOptions);
         done();
       };
-      table.deleteRows(KEYS, deleteRowsOptions, assert.ifError);
+      table.deleteRows(KEYS, gaxOptions, assert.ifError);
     });
 
     it('should accept commit options', done => {
@@ -272,6 +272,18 @@ describe('Table', () => {
       table.deleteRows(KEYS, deleteRowsOptions, assert.ifError);
     });
 
+    it('should accept gax options in commit options', done => {
+      const deleteRowsOptions = {
+        returnCommitStats: true,
+        gaxOptions: {},
+      };
+      transaction.commit = options => {
+        assert.strictEqual(options, deleteRowsOptions);
+        done();
+      };
+      table.deleteRows(KEYS, deleteRowsOptions, assert.ifError);
+    });
+
     it('should accept requestOptions', done => {
       const deleteRowsOptions = {
         requestOptions: {priority: RequestOptions.Priority.PRIORITY_HIGH},
@@ -353,17 +365,17 @@ describe('Table', () => {
     });
 
     it('should accept gaxOptions', done => {
-      const insertRowsOptions = {gaxOptions: {}};
+      const gaxOptions = {};
       (sandbox.stub(transaction, 'insert') as sinon.SinonStub).withArgs(
         table.name,
         ROW
       );
       transaction.commit = options => {
-        assert.strictEqual(options, insertRowsOptions);
+        assert.strictEqual(options, gaxOptions);
         done();
       };
 
-      table.insert(ROW, insertRowsOptions, assert.ifError);
+      table.insert(ROW, gaxOptions, assert.ifError);
     });
 
     it('should accept commit options', done => {
@@ -380,6 +392,23 @@ describe('Table', () => {
       table.insert(ROW, insertRowsOptions, assert.ifError);
     });
 
+    it('should accept gax options in commit options', done => {
+      const insertRowsOptions = {
+        returnCommitStats: true,
+        gaxOptions: {},
+      };
+      (sandbox.stub(transaction, 'insert') as sinon.SinonStub).withArgs(
+        table.name,
+        ROW
+      );
+      transaction.commit = options => {
+        assert.strictEqual(options, insertRowsOptions);
+        done();
+      };
+
+      table.insert(ROW, insertRowsOptions, assert.ifError);
+    });
+
     it('should accept requestOptions', done => {
       const insertRowsOptions = {
         requestOptions: {priority: RequestOptions.Priority.PRIORITY_HIGH},
@@ -490,17 +519,17 @@ describe('Table', () => {
     });
 
     it('should accept gaxOptions', done => {
-      const replaceRowsOptions = {gaxOptions: {}};
+      const gaxOptions = {};
       (sandbox.stub(transaction, 'replace') as sinon.SinonStub).withArgs(
         table.name,
         ROW
       );
       transaction.commit = options => {
-        assert.strictEqual(options, replaceRowsOptions);
+        assert.strictEqual(options, gaxOptions);
         done();
       };
 
-      table.replace(ROW, replaceRowsOptions, assert.ifError);
+      table.replace(ROW, gaxOptions, assert.ifError);
     });
 
     it('should accept commit options', done => {
@@ -517,6 +546,23 @@ describe('Table', () => {
       table.replace(ROW, replaceRowsOptions, assert.ifError);
     });
 
+    it('should accept gax options in commit options', done => {
+      const replaceRowsOptions = {
+        returnCommitStats: true,
+        gaxOptions: {},
+      };
+      (sandbox.stub(transaction, 'replace') as sinon.SinonStub).withArgs(
+        table.name,
+        ROW
+      );
+      transaction.commit = options => {
+        assert.strictEqual(options, replaceRowsOptions);
+        done();
+      };
+
+      table.replace(ROW, replaceRowsOptions, assert.ifError);
+    });
+
     it('should accept requestOptions', done => {
       const replaceRowsOptions = {
         requestOptions: {priority: RequestOptions.Priority.PRIORITY_HIGH},
@@ -563,17 +609,17 @@ describe('Table', () => {
     });
 
     it('should accept gaxOptions', done => {
-      const updateRowsOptions = {gaxOptions: {}};
+      const gaxOptions = {};
       (sandbox.stub(transaction, 'update') as sinon.SinonStub).withArgs(
         table.name,
         ROW
       );
       transaction.commit = options => {
-        assert.strictEqual(options, updateRowsOptions);
+        assert.strictEqual(options, gaxOptions);
         done();
       };
 
-      table.update(ROW, updateRowsOptions, assert.ifError);
+      table.update(ROW, gaxOptions, assert.ifError);
     });
 
     it('should accept commit options', done => {
@@ -590,6 +636,23 @@ describe('Table', () => {
       table.update(ROW, updateRowsOptions, assert.ifError);
     });
 
+    it('should accept gax options in commit options', done => {
+      const updateRowsOptions = {
+        returnCommitStats: true,
+        gaxOptions: {},
+      };
+      (sandbox.stub(transaction, 'update') as sinon.SinonStub).withArgs(
+        table.name,
+        ROW
+      );
+      transaction.commit = options => {
+        assert.strictEqual(options, updateRowsOptions);
+        done();
+      };
+
+      table.update(ROW, updateRowsOptions, assert.ifError);
+    });
+
     it('should accept requestOptions', done => {
       const updateRowsOptions = {
         requestOptions: {priority: RequestOptions.Priority.PRIORITY_LOW},
@@ -636,17 +699,17 @@ describe('Table', () => {
     });
 
     it('should accept gaxOptions', done => {
-      const upsertRowsOptions = {gaxOptions: {}};
+      const gaxOptions = {};
       (sandbox.stub(transaction, 'upsert') as sinon.SinonStub).withArgs(
         table.name,
         ROW
       );
       transaction.commit = options => {
-        assert.strictEqual(options, upsertRowsOptions);
+        assert.strictEqual(options, gaxOptions);
         done();
       };
 
-      table.upsert(ROW, upsertRowsOptions, assert.ifError);
+      table.upsert(ROW, gaxOptions, assert.ifError);
     });
 
     it('should accept commit options', done => {
@@ -663,6 +726,23 @@ describe('Table', () => {
       table.upsert(ROW, upsertRowsOptions, assert.ifError);
     });
 
+    it('should accept gax options in commit options', done => {
+      const upsertRowsOptions = {
+        returnCommitStats: true,
+        gaxOptions: {},
+      };
+      (sandbox.stub(transaction, 'upsert') as sinon.SinonStub).withArgs(
+        table.name,
+        ROW
+      );
+      transaction.commit = options => {
+        assert.strictEqual(options, upsertRowsOptions);
+        done();
+      };
+
+      table.upsert(ROW, upsertRowsOptions, assert.ifError);
+    });
+
     it('should accept requestOptions', done => {
       const upsertRowsOptions = {
         requestOptions: {priority: RequestOptions.Priority.PRIORITY_MEDIUM},