Add a test for the mock server

Measure the latency between the original call and the mock server.

test/gapic-mocks/commit.ts

@@ -16,6 +16,8 @@ import * as assert from 'assert';
 import {before, describe} from 'mocha';
 import * as ds from '../../src';
 import * as proxyquire from 'proxyquire';
+import * as gax from 'google-gax';
+const {grpc} = new gax.GrpcClient();
 
 function FakeV1() {}
 

test/grpc-mocks/with-mock-server.ts

@@ -0,0 +1,63 @@
+// Copyright 2023 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
+//
+//     http://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.
+
+import {before, describe} from 'mocha';
+import {Datastore} from '../../src';
+import {MockService} from '../util/mock-servers/mock-service';
+import {MockServer} from '../util/mock-servers/mock-server';
+import {DatastoreClientMockService} from '../util/mock-servers/service-implementations/datastore-client-mock-service';
+// import assert from 'assert';
+
+describe('Datastore/Unary', () => {
+  let server: MockServer;
+  let service: MockService;
+  let datastore: Datastore;
+
+  before(async () => {
+    // make sure we have everything initialized before starting tests
+    const port = await new Promise<string>(resolve => {
+      server = new MockServer(resolve);
+    });
+    datastore = new Datastore({
+      apiEndpoint: `localhost:${port}`,
+    });
+    service = new DatastoreClientMockService(server);
+  });
+
+  describe('some-test', async () => {
+    let callStartTime: number;
+    const emitTableNotExistsError = (stream: any) => {
+      const callEndTime = Date.now();
+      const timeElaspsed = callEndTime - callStartTime;
+      console.log(timeElaspsed);
+    };
+    before(async () => {
+      service.setService({
+        RunQuery: emitTableNotExistsError,
+      });
+    });
+    it.only('should not experience latency when making the grpc call', async () => {
+      // const startTime = Date.now();
+      callStartTime = Date.now();
+      const kind = 'Character';
+      const query = datastore.createQuery(kind);
+      await datastore.runQuery(query);
+      service.setService({
+        RunQuery: emitTableNotExistsError,
+      });
+      await datastore.runQuery(query);
+      // const [entities] = await datastore.runQuery(query);
+    });
+  });
+});

test/util/mock-servers/mock-server.ts

@@ -0,0 +1,63 @@
+// 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';
+
+const DEFAULT_PORT = 1234;
+
+export class MockServer {
+  port: string;
+  services: Set<grpc.ServiceDefinition> = new Set();
+  server: grpc.Server;
+
+  constructor(
+    callback?: (port: string) => void,
+    port?: string | number | undefined
+  ) {
+    const portString = Number(port ? port : DEFAULT_PORT).toString();
+    this.port = portString;
+    const server = new grpc.Server();
+    this.server = server;
+    server.bindAsync(
+      `localhost:${this.port}`,
+      grpc.ServerCredentials.createInsecure(),
+      () => {
+        server.start();
+        callback ? callback(portString) : undefined;
+      }
+    );
+  }
+
+  setService(
+    service: grpc.ServiceDefinition,
+    implementation: grpc.UntypedServiceImplementation
+  ) {
+    if (this.services.has(service)) {
+      this.server.removeService(service);
+    } else {
+      this.services.add(service);
+    }
+    this.server.addService(service, implementation);
+  }
+
+  shutdown(callback: (err?: Error) => void) {
+    this.server.tryShutdown((err?: Error) => {
+      callback(err);
+    });
+  }
+}

test/util/mock-servers/mock-service.ts

@@ -0,0 +1,34 @@
+// 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 {MockServer} from './mock-server';
+
+export abstract class MockService {
+  abstract service: grpc.ServiceDefinition;
+  server: MockServer;
+
+  constructor(server: MockServer) {
+    this.server = server;
+  }
+
+  setService(implementation: grpc.UntypedServiceImplementation) {
+    this.server.setService(this.service, implementation);
+  }
+}

test/util/mock-servers/service-implementations/datastore-client-mock-service.ts

@@ -0,0 +1,38 @@
+// 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 = require('@grpc/grpc-js');
+import jsonProtos = require('../../../../protos/protos.json');
+import protoLoader = require('@grpc/proto-loader');
+import {MockService} from '../mock-service';
+
+const packageDefinition = protoLoader.fromJSON(jsonProtos, {
+  keepCase: true,
+  longs: String,
+  enums: String,
+  defaults: true,
+  oneofs: true,
+});
+const proto = grpc.loadPackageDefinition(packageDefinition);
+
+export class DatastoreClientMockService extends MockService {
+  service =
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    proto.google.datastore.v1.Datastore.service;
+}