feat: load protos from JSON, grpc-fallback support (#571)

* [CHANGE ME] Re-generated to pick up changes in the API or client library generator. * no browser support for typescript * fix headers order in system test
googleapis · Sep 5, 2019 · 41ef532 · 41ef532
1 parent 7077e64
commit 41ef532
Show file tree

Hide file tree

Showing 11 changed files with 646 additions and 540 deletions.
diff --git a/protos/protos.json b/protos/protos.json
diff --git a/src/v2/config_service_v2_client.js b/src/v2/config_service_v2_client.js
@@ -59,6 +59,16 @@ class ConfigServiceV2Client {
     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,70 +85,91 @@ class ConfigServiceV2Client {
     // 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/logging/v2/logging_config.proto']
+      opts.fallback ? require('../../protos/protos.json') : nodejsProtoPath
     );
 
     // This API contains "path templates"; forward-slash-separated
     // identifiers to uniquely identify resources within the API.
     // Create useful helper objects for these.
     this._pathTemplates = {
-      billingPathTemplate: new gax.PathTemplate(
+      billingPathTemplate: new gaxModule.PathTemplate(
         'billingAccounts/{billing_account}'
       ),
-      billingExclusionPathTemplate: new gax.PathTemplate(
+      billingExclusionPathTemplate: new gaxModule.PathTemplate(
         'billingAccounts/{billing_account}/exclusions/{exclusion}'
       ),
-      billingSinkPathTemplate: new gax.PathTemplate(
+      billingSinkPathTemplate: new gaxModule.PathTemplate(
         'billingAccounts/{billing_account}/sinks/{sink}'
       ),
-      exclusionPathTemplate: new gax.PathTemplate(
+      exclusionPathTemplate: new gaxModule.PathTemplate(
         'projects/{project}/exclusions/{exclusion}'
       ),
-      folderPathTemplate: new gax.PathTemplate('folders/{folder}'),
-      folderExclusionPathTemplate: new gax.PathTemplate(
+      folderPathTemplate: new gaxModule.PathTemplate('folders/{folder}'),
+      folderExclusionPathTemplate: new gaxModule.PathTemplate(
         'folders/{folder}/exclusions/{exclusion}'
       ),
-      folderSinkPathTemplate: new gax.PathTemplate(
+      folderSinkPathTemplate: new gaxModule.PathTemplate(
         'folders/{folder}/sinks/{sink}'
       ),
-      organizationPathTemplate: new gax.PathTemplate(
+      organizationPathTemplate: new gaxModule.PathTemplate(
         'organizations/{organization}'
       ),
-      organizationExclusionPathTemplate: new gax.PathTemplate(
+      organizationExclusionPathTemplate: new gaxModule.PathTemplate(
         'organizations/{organization}/exclusions/{exclusion}'
       ),
-      organizationSinkPathTemplate: new gax.PathTemplate(
+      organizationSinkPathTemplate: new gaxModule.PathTemplate(
         'organizations/{organization}/sinks/{sink}'
       ),
-      projectPathTemplate: new gax.PathTemplate('projects/{project}'),
-      sinkPathTemplate: new gax.PathTemplate('projects/{project}/sinks/{sink}'),
+      projectPathTemplate: new gaxModule.PathTemplate('projects/{project}'),
+      sinkPathTemplate: new gaxModule.PathTemplate(
+        'projects/{project}/sinks/{sink}'
+      ),
     };
 
     // Some of the methods on this service return "paged" results,
     // (e.g. 50 results at a time, with tokens to get subsequent
     // pages). Denote the keys used for pagination and results.
     this._descriptors.page = {
-      listSinks: new gax.PageDescriptor('pageToken', 'nextPageToken', 'sinks'),
-      listExclusions: new gax.PageDescriptor(
+      listSinks: new gaxModule.PageDescriptor(
+        'pageToken',
+        'nextPageToken',
+        'sinks'
+      ),
+      listExclusions: new gaxModule.PageDescriptor(
         'pageToken',
         'nextPageToken',
         'exclusions'
@@ -161,7 +192,9 @@ class ConfigServiceV2Client {
     // Put together the "service stub" for
     // google.logging.v2.ConfigServiceV2.
     const configServiceV2Stub = gaxGrpc.createStub(
-      protos.google.logging.v2.ConfigServiceV2,
+      opts.fallback
+        ? protos.lookupService('google.logging.v2.ConfigServiceV2')
+        : protos.google.logging.v2.ConfigServiceV2,
       opts
     );
 
@@ -180,18 +213,16 @@ class ConfigServiceV2Client {
       'deleteExclusion',
     ];
     for (const methodName of configServiceV2StubMethods) {
-      this._innerApiCalls[methodName] = gax.createApiCall(
-        configServiceV2Stub.then(
-          stub =>
-            function() {
-              const args = Array.prototype.slice.call(arguments, 0);
-              return stub[methodName].apply(stub, args);
-            },
-          err =>
-            function() {
-              throw err;
-            }
-        ),
+      const innerCallPromise = configServiceV2Stub.then(
+        stub => (...args) => {
+          return stub[methodName].apply(stub, args);
+        },
+        err => () => {
+          throw err;
+        }
+      );
+      this._innerApiCalls[methodName] = gaxModule.createApiCall(
+        innerCallPromise,
         defaults[methodName],
         this._descriptors.page[methodName]
       );

diff --git a/src/v2/config_service_v2_proto_list.json b/src/v2/config_service_v2_proto_list.json
@@ -0,0 +1,3 @@
+[
+  "../../protos/google/logging/v2/logging_config.proto"
+]
diff --git a/src/v2/logging_service_v2_client.js b/src/v2/logging_service_v2_client.js
@@ -17,7 +17,6 @@
 const gapicConfig = require('./logging_service_v2_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 LoggingServiceV2Client {
     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,88 +84,98 @@ class LoggingServiceV2Client {
     // 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/logging/v2/logging.proto']
+      opts.fallback ? require('../../protos/protos.json') : nodejsProtoPath
     );
 
     // This API contains "path templates"; forward-slash-separated
     // identifiers to uniquely identify resources within the API.
     // Create useful helper objects for these.
     this._pathTemplates = {
-      billingPathTemplate: new gax.PathTemplate(
+      billingPathTemplate: new gaxModule.PathTemplate(
         'billingAccounts/{billing_account}'
       ),
-      billingLogPathTemplate: new gax.PathTemplate(
+      billingLogPathTemplate: new gaxModule.PathTemplate(
         'billingAccounts/{billing_account}/logs/{log}'
       ),
-      folderPathTemplate: new gax.PathTemplate('folders/{folder}'),
-      folderLogPathTemplate: new gax.PathTemplate(
+      folderPathTemplate: new gaxModule.PathTemplate('folders/{folder}'),
+      folderLogPathTemplate: new gaxModule.PathTemplate(
         'folders/{folder}/logs/{log}'
       ),
-      logPathTemplate: new gax.PathTemplate('projects/{project}/logs/{log}'),
-      organizationPathTemplate: new gax.PathTemplate(
+      logPathTemplate: new gaxModule.PathTemplate(
+        'projects/{project}/logs/{log}'
+      ),
+      organizationPathTemplate: new gaxModule.PathTemplate(
         'organizations/{organization}'
       ),
-      organizationLogPathTemplate: new gax.PathTemplate(
+      organizationLogPathTemplate: new gaxModule.PathTemplate(
         'organizations/{organization}/logs/{log}'
       ),
-      projectPathTemplate: new gax.PathTemplate('projects/{project}'),
+      projectPathTemplate: new gaxModule.PathTemplate('projects/{project}'),
     };
 
     // Some of the methods on this service return "paged" results,
     // (e.g. 50 results at a time, with tokens to get subsequent
     // pages). Denote the keys used for pagination and results.
     this._descriptors.page = {
-      listLogEntries: new gax.PageDescriptor(
+      listLogEntries: new gaxModule.PageDescriptor(
         'pageToken',
         'nextPageToken',
         'entries'
       ),
-      listMonitoredResourceDescriptors: new gax.PageDescriptor(
+      listMonitoredResourceDescriptors: new gaxModule.PageDescriptor(
         'pageToken',
         'nextPageToken',
         'resourceDescriptors'
       ),
-      listLogs: new gax.PageDescriptor(
+      listLogs: new gaxModule.PageDescriptor(
         'pageToken',
         'nextPageToken',
         'logNames'
       ),
     };
-    let protoFilesRoot = new gax.GoogleProtoFilesRoot();
-    protoFilesRoot = protobuf.loadSync(
-      path.join(
-        __dirname,
-        '..',
-        '..',
-        'protos',
-        'google/logging/v2/logging.proto'
-      ),
-      protoFilesRoot
-    );
+
+    const protoFilesRoot = opts.fallback
+      ? gaxModule.protobuf.Root.fromJSON(require('../../protos/protos.json'))
+      : gaxModule.protobuf.loadSync(nodejsProtoPath);
 
     // Some methods on this API support automatically batching
     // requests; denote this.
     this._descriptors.batching = {
-      writeLogEntries: new gax.BundleDescriptor(
+      writeLogEntries: new gaxModule.BundleDescriptor(
         'entries',
         ['logName', 'resource', 'labels'],
         null,
@@ -182,7 +201,9 @@ class LoggingServiceV2Client {
     // Put together the "service stub" for
     // google.logging.v2.LoggingServiceV2.
     const loggingServiceV2Stub = gaxGrpc.createStub(
-      protos.google.logging.v2.LoggingServiceV2,
+      opts.fallback
+        ? protos.lookupService('google.logging.v2.LoggingServiceV2')
+        : protos.google.logging.v2.LoggingServiceV2,
       opts
     );
 
@@ -196,18 +217,16 @@ class LoggingServiceV2Client {
       'listLogs',
     ];
     for (const methodName of loggingServiceV2StubMethods) {
-      this._innerApiCalls[methodName] = gax.createApiCall(
-        loggingServiceV2Stub.then(
-          stub =>
-            function() {
-              const args = Array.prototype.slice.call(arguments, 0);
-              return stub[methodName].apply(stub, args);
-            },
-          err =>
-            function() {
-              throw err;
-            }
-        ),
+      const innerCallPromise = loggingServiceV2Stub.then(
+        stub => (...args) => {
+          return stub[methodName].apply(stub, args);
+        },
+        err => () => {
+          throw err;
+        }
+      );
+      this._innerApiCalls[methodName] = gaxModule.createApiCall(
+        innerCallPromise,
         defaults[methodName],
         this._descriptors.page[methodName] ||
           this._descriptors.batching[methodName]

diff --git a/src/v2/logging_service_v2_proto_list.json b/src/v2/logging_service_v2_proto_list.json
@@ -0,0 +1,3 @@
+[
+  "../../protos/google/logging/v2/logging.proto"
+]