feat: load protos from JSON, grpc-fallback support

* [CHANGE ME] Re-generated  to pick up changes in the API or client library generator.

* fixes

* fix webpack.config.js

src/browser.js

@@ -0,0 +1,21 @@
+// Copyright 2019 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.
+
+'use strict';
+
+// Set a flag that we are running in a browser bundle.
+global.isBrowser = true;
+
+// Re-export all exports from ./index.js.
+module.exports = require('./index');

src/v1/speech_client.js

@@ -17,7 +17,6 @@
 const gapicConfig = require('./speech_client_config.json');
 const gax = require('google-gax');
 const path = require('path');
-const protobuf = require('protobufjs');
 
 const VERSION = require('../../package.json').version;
 
@@ -59,6 +58,16 @@ class SpeechClient {
     opts = opts || {};
     this._descriptors = {};
 
+    if (global.isBrowser) {
+      // If we're in browser, we use gRPC fallback.
+      opts.fallback = true;
+    }
+
+    // If we are in browser, we are already using fallback because of the
+    // "browser" field in package.json.
+    // But if we were explicitly requested to use fallback, let's do it now.
+    const gaxModule = !global.isBrowser && opts.fallback ? gax.fallback : gax;
+
     const servicePath =
       opts.servicePath || opts.apiEndpoint || this.constructor.servicePath;
 
@@ -75,51 +84,59 @@ class SpeechClient {
     // Create a `gaxGrpc` object, with any grpc-specific options
     // sent to the client.
     opts.scopes = this.constructor.scopes;
-    const gaxGrpc = new gax.GrpcClient(opts);
+    const gaxGrpc = new gaxModule.GrpcClient(opts);
 
     // Save the auth object to the client, for use by other methods.
     this.auth = gaxGrpc.auth;
 
     // Determine the client header string.
-    const clientHeader = [
-      `gl-node/${process.versions.node}`,
-      `grpc/${gaxGrpc.grpcVersion}`,
-      `gax/${gax.version}`,
-      `gapic/${VERSION}`,
-    ];
+    const clientHeader = [];
+
+    if (typeof process !== 'undefined' && 'versions' in process) {
+      clientHeader.push(`gl-node/${process.versions.node}`);
+    }
+    clientHeader.push(`gax/${gaxModule.version}`);
+    if (opts.fallback) {
+      clientHeader.push(`gl-web/${gaxModule.version}`);
+    } else {
+      clientHeader.push(`grpc/${gaxGrpc.grpcVersion}`);
+    }
+    clientHeader.push(`gapic/${VERSION}`);
     if (opts.libName && opts.libVersion) {
       clientHeader.push(`${opts.libName}/${opts.libVersion}`);
     }
 
     // Load the applicable protos.
+    // For Node.js, pass the path to JSON proto file.
+    // For browsers, pass the JSON content.
+
+    const nodejsProtoPath = path.join(
+      __dirname,
+      '..',
+      '..',
+      'protos',
+      'protos.json'
+    );
     const protos = gaxGrpc.loadProto(
-      path.join(__dirname, '..', '..', 'protos'),
-      ['google/cloud/speech/v1/cloud_speech.proto']
+      opts.fallback ? require('../../protos/protos.json') : nodejsProtoPath
     );
 
     // Some of the methods on this service provide streaming responses.
     // Provide descriptors for these.
     this._descriptors.stream = {
-      streamingRecognize: new gax.StreamDescriptor(
+      streamingRecognize: new gaxModule.StreamDescriptor(
         gax.StreamType.BIDI_STREAMING
       ),
     };
-    let protoFilesRoot = new gax.GoogleProtoFilesRoot();
-    protoFilesRoot = protobuf.loadSync(
-      path.join(
-        __dirname,
-        '..',
-        '..',
-        'protos',
-        'google/cloud/speech/v1/cloud_speech.proto'
-      ),
-      protoFilesRoot
-    );
+
+    const protoFilesRoot = opts.fallback
+      ? gaxModule.protobuf.Root.fromJSON(require('../../protos/protos.json'))
+      : gaxModule.protobuf.loadSync(nodejsProtoPath);
 
     // This API contains "long-running operations", which return a
     // an Operation object that allows for tracking of the operation,
     // rather than holding a request open.
-    this.operationsClient = new gax.lro({
+    this.operationsClient = new gaxModule.lro({
       auth: gaxGrpc.auth,
       grpc: gaxGrpc.grpc,
     }).operationsClient(opts);
@@ -132,7 +149,7 @@ class SpeechClient {
     );
 
     this._descriptors.longrunning = {
-      longRunningRecognize: new gax.LongrunningDescriptor(
+      longRunningRecognize: new gaxModule.LongrunningDescriptor(
         this.operationsClient,
         longRunningRecognizeResponse.decode.bind(longRunningRecognizeResponse),
         longRunningRecognizeMetadata.decode.bind(longRunningRecognizeMetadata)
@@ -155,7 +172,9 @@ class SpeechClient {
     // Put together the "service stub" for
     // google.cloud.speech.v1.Speech.
     const speechStub = gaxGrpc.createStub(
-      protos.google.cloud.speech.v1.Speech,
+      opts.fallback
+        ? protos.lookupService('google.cloud.speech.v1.Speech')
+        : protos.google.cloud.speech.v1.Speech,
       opts
     );
 
@@ -167,18 +186,16 @@ class SpeechClient {
       'streamingRecognize',
     ];
     for (const methodName of speechStubMethods) {
-      this._innerApiCalls[methodName] = gax.createApiCall(
-        speechStub.then(
-          stub =>
-            function() {
-              const args = Array.prototype.slice.call(arguments, 0);
-              return stub[methodName].apply(stub, args);
-            },
-          err =>
-            function() {
-              throw err;
-            }
-        ),
+      const innerCallPromise = speechStub.then(
+        stub => (...args) => {
+          return stub[methodName].apply(stub, args);
+        },
+        err => () => {
+          throw err;
+        }
+      );
+      this._innerApiCalls[methodName] = gaxModule.createApiCall(
+        innerCallPromise,
         defaults[methodName],
         this._descriptors.stream[methodName] ||
           this._descriptors.longrunning[methodName]

src/v1/speech_proto_list.json

@@ -0,0 +1,3 @@
+[
+  "../../protos/google/cloud/speech/v1/cloud_speech.proto"
+]

src/v1p1beta1/speech_client.js

@@ -17,7 +17,6 @@
 const gapicConfig = require('./speech_client_config.json');
 const gax = require('google-gax');
 const path = require('path');
-const protobuf = require('protobufjs');
 
 const VERSION = require('../../package.json').version;
 
@@ -59,6 +58,16 @@ class SpeechClient {
     opts = opts || {};
     this._descriptors = {};
 
+    if (global.isBrowser) {
+      // If we're in browser, we use gRPC fallback.
+      opts.fallback = true;
+    }
+
+    // If we are in browser, we are already using fallback because of the
+    // "browser" field in package.json.
+    // But if we were explicitly requested to use fallback, let's do it now.
+    const gaxModule = !global.isBrowser && opts.fallback ? gax.fallback : gax;
+
     const servicePath =
       opts.servicePath || opts.apiEndpoint || this.constructor.servicePath;
 
@@ -75,51 +84,59 @@ class SpeechClient {
     // Create a `gaxGrpc` object, with any grpc-specific options
     // sent to the client.
     opts.scopes = this.constructor.scopes;
-    const gaxGrpc = new gax.GrpcClient(opts);
+    const gaxGrpc = new gaxModule.GrpcClient(opts);
 
     // Save the auth object to the client, for use by other methods.
     this.auth = gaxGrpc.auth;
 
     // Determine the client header string.
-    const clientHeader = [
-      `gl-node/${process.versions.node}`,
-      `grpc/${gaxGrpc.grpcVersion}`,
-      `gax/${gax.version}`,
-      `gapic/${VERSION}`,
-    ];
+    const clientHeader = [];
+
+    if (typeof process !== 'undefined' && 'versions' in process) {
+      clientHeader.push(`gl-node/${process.versions.node}`);
+    }
+    clientHeader.push(`gax/${gaxModule.version}`);
+    if (opts.fallback) {
+      clientHeader.push(`gl-web/${gaxModule.version}`);
+    } else {
+      clientHeader.push(`grpc/${gaxGrpc.grpcVersion}`);
+    }
+    clientHeader.push(`gapic/${VERSION}`);
     if (opts.libName && opts.libVersion) {
       clientHeader.push(`${opts.libName}/${opts.libVersion}`);
     }
 
     // Load the applicable protos.
+    // For Node.js, pass the path to JSON proto file.
+    // For browsers, pass the JSON content.
+
+    const nodejsProtoPath = path.join(
+      __dirname,
+      '..',
+      '..',
+      'protos',
+      'protos.json'
+    );
     const protos = gaxGrpc.loadProto(
-      path.join(__dirname, '..', '..', 'protos'),
-      ['google/cloud/speech/v1p1beta1/cloud_speech.proto']
+      opts.fallback ? require('../../protos/protos.json') : nodejsProtoPath
     );
 
     // Some of the methods on this service provide streaming responses.
     // Provide descriptors for these.
     this._descriptors.stream = {
-      streamingRecognize: new gax.StreamDescriptor(
+      streamingRecognize: new gaxModule.StreamDescriptor(
         gax.StreamType.BIDI_STREAMING
       ),
     };
-    let protoFilesRoot = new gax.GoogleProtoFilesRoot();
-    protoFilesRoot = protobuf.loadSync(
-      path.join(
-        __dirname,
-        '..',
-        '..',
-        'protos',
-        'google/cloud/speech/v1p1beta1/cloud_speech.proto'
-      ),
-      protoFilesRoot
-    );
+
+    const protoFilesRoot = opts.fallback
+      ? gaxModule.protobuf.Root.fromJSON(require('../../protos/protos.json'))
+      : gaxModule.protobuf.loadSync(nodejsProtoPath);
 
     // This API contains "long-running operations", which return a
     // an Operation object that allows for tracking of the operation,
     // rather than holding a request open.
-    this.operationsClient = new gax.lro({
+    this.operationsClient = new gaxModule.lro({
       auth: gaxGrpc.auth,
       grpc: gaxGrpc.grpc,
     }).operationsClient(opts);
@@ -132,7 +149,7 @@ class SpeechClient {
     );
 
     this._descriptors.longrunning = {
-      longRunningRecognize: new gax.LongrunningDescriptor(
+      longRunningRecognize: new gaxModule.LongrunningDescriptor(
         this.operationsClient,
         longRunningRecognizeResponse.decode.bind(longRunningRecognizeResponse),
         longRunningRecognizeMetadata.decode.bind(longRunningRecognizeMetadata)
@@ -155,7 +172,9 @@ class SpeechClient {
     // Put together the "service stub" for
     // google.cloud.speech.v1p1beta1.Speech.
     const speechStub = gaxGrpc.createStub(
-      protos.google.cloud.speech.v1p1beta1.Speech,
+      opts.fallback
+        ? protos.lookupService('google.cloud.speech.v1p1beta1.Speech')
+        : protos.google.cloud.speech.v1p1beta1.Speech,
       opts
     );
 
@@ -167,18 +186,16 @@ class SpeechClient {
       'streamingRecognize',
     ];
     for (const methodName of speechStubMethods) {
-      this._innerApiCalls[methodName] = gax.createApiCall(
-        speechStub.then(
-          stub =>
-            function() {
-              const args = Array.prototype.slice.call(arguments, 0);
-              return stub[methodName].apply(stub, args);
-            },
-          err =>
-            function() {
-              throw err;
-            }
-        ),
+      const innerCallPromise = speechStub.then(
+        stub => (...args) => {
+          return stub[methodName].apply(stub, args);
+        },
+        err => () => {
+          throw err;
+        }
+      );
+      this._innerApiCalls[methodName] = gaxModule.createApiCall(
+        innerCallPromise,
         defaults[methodName],
         this._descriptors.stream[methodName] ||
           this._descriptors.longrunning[methodName]

src/v1p1beta1/speech_proto_list.json

@@ -0,0 +1,3 @@
+[
+  "../../protos/google/cloud/speech/v1p1beta1/cloud_speech.proto"
+]

synth.metadata

@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-08-28T11:21:37.744438Z",
+  "updateTime": "2019-08-31T11:19:24.627851Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.35.1",
-        "dockerImage": "googleapis/artman@sha256:b11c7ea0d0831c54016fb50f4b796d24d1971439b30fbc32a369ba1ac887c384"
+        "version": "0.36.1",
+        "dockerImage": "googleapis/artman@sha256:7c20f006c7a62d9d782e2665647d52290c37a952ef3cd134624d5dd62b3f71bd"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "dbd38035c35083507e2f0b839985cf17e212cb1c",
-        "internalRef": "265796259"
+        "sha": "82809578652607c8ee29d9e199c21f28f81a03e0",
+        "internalRef": "266247326"
       }
     },
     {

synth.py

@@ -60,3 +60,4 @@
 #
 subprocess.run(['npm', 'install'])
 subprocess.run(['npm', 'run', 'fix'])
+subprocess.run(['npx', 'compileProtos', 'src'])

test/gapic-v1.js

@@ -45,6 +45,11 @@ describe('SpeechClient', () => {
     assert(client);
   });
 
+  it('should create a client with gRPC fallback', () => {
+    const client = new speechModule.v1.SpeechClient({fallback: true});
+    assert(client);
+  });
+
   describe('recognize', () => {
     it('invokes recognize without error', done => {
       const client = new speechModule.v1.SpeechClient({

test/gapic-v1p1beta1.js

@@ -45,6 +45,11 @@ describe('SpeechClient', () => {
     assert(client);
   });
 
+  it('should create a client with gRPC fallback', () => {
+    const client = new speechModule.v1p1beta1.SpeechClient({fallback: true});
+    assert(client);
+  });
+
   describe('recognize', () => {
     it('invokes recognize without error', done => {
       const client = new speechModule.v1p1beta1.SpeechClient({