feat: Generate end to end tests for retries

package.json

@@ -51,6 +51,7 @@
     "@google-cloud/promisify": "^3.0.0",
     "arrify": "^2.0.0",
     "concat-stream": "^2.0.0",
+    "deep-equal": "^2.0.5",
     "dot-prop": "^6.0.0",
     "escape-string-regexp": "^4.0.0",
     "extend": "^3.0.2",
@@ -89,6 +90,7 @@
     "sinon": "^14.0.0",
     "tcp-port-used": "^1.0.2",
     "snap-shot-it": "^7.9.1",
+    "tcp-port-used": "^1.0.2",
     "ts-loader": "^9.0.0",
     "typescript": "^4.6.4",
     "uuid": "^8.0.0",

src/util/mock-servers/service-testers/service-handlers/implementation/read-rows-handler.ts

@@ -0,0 +1,126 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+import {SameCallHandler} from './same-call-handler';
+import {MockService} from '../../../mock-service';
+import {Mutation} from '../../../../../mutation';
+
+function rowResponse(rowKey: {}) {
+  return {
+    rowKey: Mutation.convertToBytes(rowKey),
+    familyName: {value: 'family'},
+    qualifier: {value: Mutation.convertToBytes('qualifier')},
+    valueSize: 0,
+    timestampMicros: 0,
+    labels: [],
+    commitRow: true,
+    value: Mutation.convertToBytes('value'),
+  };
+}
+
+export interface ReadRowsResponse {
+  row_keys?: string[];
+  last_row_key?: string;
+  end_with_error?: number;
+}
+
+export class ReadRowsHandler extends SameCallHandler {
+  responses: ReadRowsResponse[];
+  request: any = null;
+  callCount = 0;
+  message: any;
+
+  // TODO: service and endpoint should be bundled into one object.
+  constructor(
+    service: MockService,
+    endpoint: string,
+    responses: ReadRowsResponse[],
+    message?: any
+  ) {
+    super(service, endpoint);
+    this.responses = responses;
+    this.message = Object.assign({}, message);
+  }
+
+  // TODO: Create interface for this.
+  callHandler(call: any) {
+    const lastResponse = this.responses[this.callCount - 1];
+    if (lastResponse && lastResponse.row_keys) {
+      const grpcResponse = {
+        chunks: lastResponse.row_keys.map(rowResponse),
+        lastScannedRowKey: Mutation.convertToBytes(lastResponse.last_row_key),
+      };
+      call.write(grpcResponse);
+    }
+    // Set a timer and send an error if we are confident that all data has been sent back to the user
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const self = this;
+    const endRequest = (lastResponse: any) => {
+      const errorCode = lastResponse.end_with_error;
+      if (errorCode) {
+        call.emit('error', {
+          code: errorCode,
+          details: 'Details for a particular type of error',
+        });
+      } else {
+        call.end();
+      }
+    };
+    const checkCollected = () => {
+      // Send the error if all data was collected
+      const lastIndex = self.data.length - 1;
+      const lastResponse = self.responses[self.callCount - 1];
+      if (lastResponse) {
+        if (lastResponse.row_keys) {
+          if (self.data[lastIndex].length === lastResponse.row_keys.length) {
+            endRequest(lastResponse);
+          } else {
+            startTimer();
+          }
+        } else {
+          endRequest(lastResponse);
+        }
+      } else {
+        throw Error('Ran out of requests to send');
+      }
+    };
+    const startTimer = () => {
+      setTimeout(checkCollected, 2500);
+    };
+    startTimer();
+  }
+
+  addData(data: string) {
+    // Add data collected from the stream
+    const lastIndex = this.data.length - 1;
+    this.data[lastIndex].push(data);
+  }
+
+  snapshot(results: any): any {
+    return {
+      input: Object.assign(
+        {responses: this.responses},
+        this.message ? {message: this.message} : null
+      ),
+      output: {
+        results,
+        requestData: this.requests(),
+      },
+    };
+  }
+}

src/util/mock-servers/service-testers/service-handlers/implementation/same-call-handler.ts

@@ -0,0 +1,74 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+import {MockService} from '../../../mock-service';
+import {ServiceHandler} from '../service-handler';
+
+const equal = require('deep-equal');
+
+export abstract class SameCallHandler extends ServiceHandler {
+  service: MockService;
+  request: any = null;
+  requestList: any[] = [];
+  requestOrder: number[] = [];
+  callCount = 0;
+  endpoint: string;
+  data: string[][] = [];
+
+  protected constructor(service: MockService, endpoint: string) {
+    super();
+    this.endpoint = endpoint;
+    this.service = service;
+  }
+
+  setupService(): void {
+    const handleRpcCall = (call: any) => {
+      // TODO: Make an abstraction of this
+      const callRequest = call.request;
+      const requestIndex = this.requestList.findIndex(request => {
+        return equal(request, callRequest);
+      });
+      if (requestIndex === -1) {
+        this.requestList.push(callRequest);
+        this.requestOrder.push(this.requestList.length - 1);
+      } else {
+        this.requestOrder.push(requestIndex);
+      }
+      this.request = callRequest;
+      this.callCount++;
+      this.data.push([]);
+      this.callHandler(call);
+    };
+    this.service.setService({
+      // Abstraction: Always emit error
+      [this.endpoint]: handleRpcCall,
+    });
+  }
+
+  getData() {
+    return this.data;
+  }
+
+  requests() {
+    return {
+      requests: Object.assign({}, this.requestList),
+      requestOrder: this.requestOrder,
+      callCount: this.callCount,
+    };
+  }
+}

src/util/mock-servers/service-testers/service-handlers/implementation/send-error-handler.ts

@@ -0,0 +1,66 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+import {grpc} from 'google-gax';
+import {SameCallHandler} from './same-call-handler';
+import {MockService} from '../../../mock-service';
+import {Row} from '../../../../../row';
+
+export class SendErrorHandler extends SameCallHandler {
+  code: grpc.status;
+  request: any = null;
+  callCount = 0;
+  message: any;
+
+  // TODO: service and endpoint should be bundled into one object.
+  constructor(
+    service: MockService,
+    endpoint: string,
+    code: grpc.status,
+    message?: any
+  ) {
+    super(service, endpoint);
+    this.code = code;
+    this.message = Object.assign({}, message);
+  }
+
+  callHandler(call: any) {
+    call.emit('error', {
+      code: this.code,
+      details: 'Details for a particular type of error',
+    });
+  }
+
+  addData(data: string) {
+    const lastIndex = this.data.length - 1;
+    this.data[lastIndex].push(data);
+  }
+
+  snapshot(results: any): any {
+    return {
+      input: Object.assign(
+        {code: this.code},
+        this.message ? {message: this.message} : null
+      ),
+      output: {
+        results,
+        requestData: this.requests(),
+      },
+    };
+  }
+}

src/util/mock-servers/service-testers/service-handlers/service-handler.ts

@@ -0,0 +1,48 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+export abstract class ServiceHandler {
+  /*
+  callHandler accepts a grpc call and provides behaviour for that grpc call
+  which may involve sending errors or data back to the client for
+  example.
+  */
+  abstract callHandler(call: any): void;
+
+  /*
+  snapshotOutput is used to provide a custom json object that represents the
+  results of the test that was run with this service handler.
+   */
+  abstract snapshot(results: any): any;
+
+  /*
+  setupService is called to setup the service we use for collecting data about
+  a running test.
+   */
+  abstract setupService(): void;
+
+  /*
+  addData is called to add data which will be reported in the snapshot later on.
+   */
+  abstract addData(data: string): void;
+
+  /*
+  getData is called to get all data which was collected from requests.
+   */
+  abstract getData(): string[][];
+}

src/util/mock-servers/service-testers/stream-fetchers/implementation/read-rows-fetcher.ts

@@ -0,0 +1,36 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+import {GetRowsOptions, Table} from '../../../../../table';
+import internal = require('stream');
+import {StreamFetcher} from '../stream-fetcher';
+
+export class ReadRowsFetcher extends StreamFetcher {
+  table: Table;
+  opts: GetRowsOptions;
+
+  constructor(table: Table, opts?: GetRowsOptions) {
+    super();
+    this.opts = opts ?? {};
+    this.table = table;
+  }
+
+  fetchStream(): internal.PassThrough {
+    return this.table.createReadStream(this.opts);
+  }
+}

src/util/mock-servers/service-testers/stream-fetchers/stream-fetcher.ts

@@ -0,0 +1,23 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+import internal = require('stream');
+
+export abstract class StreamFetcher {
+  abstract fetchStream(): internal.PassThrough;
+}