refactor: drop dependency on @google-cloud/common (googleapis#714)

Author: JustinBeckwith

handwritten/bigtable/package.json

@@ -43,7 +43,6 @@
     "test": "c8 mocha build/test"
   },
   "dependencies": {
-    "@google-cloud/common": "^3.0.0",
     "@google-cloud/paginator": "^3.0.0",
     "@google-cloud/projectify": "^2.0.0",
     "@google-cloud/promisify": "^2.0.0",

handwritten/bigtable/src/.eslintrc.yml

@@ -19,7 +19,6 @@ import * as extend from 'extend';
 import {GoogleAuth, CallOptions} from 'google-gax';
 import * as gax from 'google-gax';
 import * as protos from '../protos/protos';
-import {AbortableDuplex} from '@google-cloud/common';
 
 import {AppProfile} from './app-profile';
 import {Cluster} from './cluster';
@@ -35,7 +34,7 @@ import {shouldRetryRequest} from './decorateStatus';
 import {google} from '../protos/protos';
 import {ServiceError} from 'google-gax';
 import * as v2 from './v2';
-import {PassThrough} from 'stream';
+import {PassThrough, Duplex} from 'stream';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const retryRequest = require('retry-request');
@@ -74,6 +73,10 @@ export interface RequestOptions {
   method?: string;
 }
 
+export interface AbortableDuplex extends Duplex {
+  abort(): void;
+}
+
 export interface BigtableOptions extends gax.GoogleAuthOptions {
   /**
    * Override the default API endpoint used to reach Bigtable. This is useful for connecting to your local Bigtable emulator.
@@ -1093,6 +1096,7 @@ export {
   MutateCallback,
   MutateOptions,
   MutateResponse,
+  PartialFailureError,
   Policy,
   PolicyBinding,
   PrefixRange,

handwritten/bigtable/src/index.ts

@@ -25,6 +25,7 @@ import {
   MutateCallback,
   MutateResponse,
   MutateOptions,
+  PartialFailureError,
 } from './table';
 import {Chunk} from './chunktransformer';
 import {CallOptions} from 'google-gax';
@@ -89,7 +90,7 @@ export type CreateRulesResponse = [
   google.bigtable.v2.IReadModifyWriteRowResponse
 ];
 export type CreateRowCallback = (
-  err: ServiceError | null,
+  err: ServiceError | PartialFailureError | null,
   row?: Row | null,
   apiResponse?: google.protobuf.Empty
 ) => void;

handwritten/bigtable/src/row.ts

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import * as common from '@google-cloud/common';
 import {promisifyAll} from '@google-cloud/promisify';
 import arrify = require('arrify');
 import {ServiceError} from 'google-gax';
@@ -38,7 +37,7 @@ import {Mutation} from './mutation';
 import {Row} from './row';
 import {ChunkTransformer} from './chunktransformer';
 import {CallOptions} from 'google-gax';
-import {Bigtable} from '.';
+import {Bigtable, AbortableDuplex} from '.';
 import {Instance} from './instance';
 import {google} from '../protos/protos';
 import {Duplex} from 'stream';
@@ -353,12 +352,12 @@ export type GetRowsCallback = (
 ) => void;
 export type GetRowsResponse = [Row[], google.bigtable.v2.ReadRowsResponse];
 export type InsertRowsCallback = (
-  err: ServiceError | null,
+  err: ServiceError | PartialFailureError | null,
   apiResponse?: google.protobuf.Empty
 ) => void;
 export type InsertRowsResponse = [google.protobuf.Empty];
 export type MutateCallback = (
-  err: ServiceError | null,
+  err: ServiceError | PartialFailureError | null,
   apiResponse?: google.protobuf.Empty
 ) => void;
 export type MutateResponse = [google.protobuf.Empty];
@@ -632,7 +631,7 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
   createReadStream(opts?: GetRowsOptions) {
     const options = opts || {};
     const maxRetries = is.number(this.maxRetries) ? this.maxRetries! : 3;
-    let activeRequestStream: common.AbortableDuplex;
+    let activeRequestStream: AbortableDuplex;
     let rowKeys: string[] | null;
     const ranges = options.ranges || [];
     let filter: {} | null;
@@ -1382,7 +1381,7 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
       typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
     const options =
       typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
-    const entries = (arrify(entriesRaw) as Entry[]).reduce(
+    const entries: Entry[] = (arrify(entriesRaw) as Entry[]).reduce(
       (a, b) => a.concat(b),
       []
     );
@@ -1398,10 +1397,11 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
     );
     const mutationErrorsByEntryIndex = new Map();
 
-    const onBatchResponse = (err: ServiceError | null) => {
+    const onBatchResponse = (
+      err: ServiceError | PartialFailureError | null
+    ) => {
       if (err) {
-        // The error happened before a request was even made, don't
-        // retry.
+        // The error happened before a request was even made, don't retry.
         callback(err);
         return;
       }
@@ -1412,10 +1412,7 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
 
       if (mutationErrorsByEntryIndex.size !== 0) {
         const mutationErrors = Array.from(mutationErrorsByEntryIndex.values());
-        err = new common.util.PartialFailureError({
-          errors: mutationErrors,
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        } as any) as ServiceError;
+        err = new PartialFailureError(mutationErrors);
       }
 
       callback(err);
@@ -1439,7 +1436,7 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
       };
 
       this.bigtable
-        .request({
+        .request<google.bigtable.v2.MutateRowsResponse>({
           client: 'BigtableClient',
           method: 'mutateRows',
           reqOpts,
@@ -1878,3 +1875,26 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
 promisifyAll(Table, {
   exclude: ['family', 'row'],
 });
+
+export interface GoogleInnerError {
+  reason?: string;
+  message?: string;
+}
+
+export class PartialFailureError extends Error {
+  errors?: GoogleInnerError[];
+  constructor(errors: GoogleInnerError[]) {
+    super();
+    this.errors = errors;
+    this.name = 'PartialFailureError';
+    let messages = errors.map(e => e.message);
+    if (messages.length > 1) {
+      messages = messages.map((message, i) => `    ${i + 1}. ${message}`);
+      messages.unshift(
+        'Multiple errors occurred during the request. Please see the `errors` array for complete details.\n'
+      );
+      messages.push('\n');
+    }
+    this.message = messages.join('\n');
+  }
+}

handwritten/bigtable/src/table.ts

@@ -25,8 +25,7 @@ import {afterEach, beforeEach, describe, it} from 'mocha';
 import * as sinon from 'sinon';
 import {EventEmitter} from 'events';
 import {ProjectIdCallback, GoogleAuth} from 'google-auth-library';
-import {PartialFailureError} from '@google-cloud/common/build/src/util';
-import {Entry} from '../src/table';
+import {Entry, PartialFailureError} from '../src/table';
 import {CancellableStream, GrpcClient} from 'google-gax';
 import {BigtableClient} from '../src/v2';
 import {PassThrough} from 'stream';

handwritten/bigtable/system-test/.eslintrc.yml

@@ -24,8 +24,7 @@ import * as ProtoBuf from 'protobufjs';
 import * as fs from 'fs';
 import * as path from 'path';
 import {Instance} from '../src/instance';
-import {Bigtable} from '../src';
-import {AbortableDuplex} from '@google-cloud/common';
+import {Bigtable, AbortableDuplex} from '../src';
 
 const protosJson = path.resolve(__dirname, '../protos/protos.json');
 const root = ProtoBuf.Root.fromJSON(