fix: allow passing gax instance to client constructor (#403)

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 470911839 Source-Link: googleapis/googleapis@3527566 Source-Link: googleapis/googleapis-gen@f16a1d2 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjE2YTFkMjI0ZjAwYTYzMGVhNDNkNmE5YTFhMzFmNTY2ZjQ1Y2RlYSJ9 feat: accept google-gax instance as a parameter Please see the documentation of the client constructor for details. PiperOrigin-RevId: 470332808 Source-Link: googleapis/googleapis@d4a2367 Source-Link: googleapis/googleapis-gen@e97a1ac Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTk3YTFhYzIwNGVhZDRmZTczNDFmOTFlNzJkYjdjNmFjNjAxNjM0MSJ9
googleapis · Sep 1, 2022 · e19cd1e · e19cd1e
1 parent ea6db49
commit e19cd1e
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 35 deletions.
diff --git a/packages/google-cloud-recaptchaenterprise/src/v1/recaptcha_enterprise_service_client.ts b/packages/google-cloud-recaptchaenterprise/src/v1/recaptcha_enterprise_service_client.ts
@@ -17,16 +17,15 @@
 // ** All changes to this file may be overwritten. **
 
 /* global window */
-import * as gax from 'google-gax';
-import {
+import type * as gax from 'google-gax';
+import type {
  Callback,
  CallOptions,
  Descriptors,
  ClientOptions,
  PaginationCallback,
  GaxCall,
 } from 'google-gax';
-
 import {Transform} from 'stream';
 import * as protos from '../../protos/protos';
 import jsonProtos = require('../../protos/protos.json');
@@ -36,7 +35,6 @@ import jsonProtos = require('../../protos/protos.json');
  * This file defines retry strategy and timeouts for all API methods in this library.
  */
 import * as gapicConfig from './recaptcha_enterprise_service_client_config.json';
-
 const version = require('../../../package.json').version;
 
 /**
@@ -96,8 +94,18 @@ export class RecaptchaEnterpriseServiceClient {
  * Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
  * For more information, please check the
  * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+ * need to avoid loading the default gRPC version and want to use the fallback
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
+ * ```
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+ * const client = new RecaptchaEnterpriseServiceClient({fallback: 'rest'}, gax);
+ * ```
  */
- constructor(opts?: ClientOptions) {
+ constructor(
+ opts?: ClientOptions,
+ gaxInstance?: typeof gax | typeof gax.fallback
+ ) {
  // Ensure that options include all the required fields.
  const staticMembers = this
  .constructor as typeof RecaptchaEnterpriseServiceClient;
@@ -118,8 +126,13 @@ export class RecaptchaEnterpriseServiceClient {
  opts['scopes'] = staticMembers.scopes;
  }
 
+ // Load google-gax module synchronously if needed
+ if (!gaxInstance) {
+ gaxInstance = require('google-gax') as typeof gax;
+ }
+
  // Choose either gRPC or proto-over-HTTP implementation of google-gax.
- this._gaxModule = opts.fallback ? gax.fallback : gax;
+ this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
 
  // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
  this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
@@ -224,7 +237,7 @@ export class RecaptchaEnterpriseServiceClient {
  this.innerApiCalls = {};
 
  // Add a warn function to the client constructor so it can be easily tested.
- this.warn = gax.warn;
+ this.warn = this._gaxModule.warn;
  }
 
  /**
@@ -450,7 +463,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  this.initialize();
@@ -562,7 +575,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  name: request.name || '',
  });
  this.initialize();
@@ -656,7 +669,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  this.initialize();
@@ -748,7 +761,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  name: request.name || '',
  });
  this.initialize();
@@ -842,7 +855,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  'key.name': request.key!.name || '',
  });
  this.initialize();
@@ -934,7 +947,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  name: request.name || '',
  });
  this.initialize();
@@ -1031,7 +1044,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  name: request.name || '',
  });
  this.initialize();
@@ -1124,7 +1137,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  name: request.name || '',
  });
  this.initialize();
@@ -1226,7 +1239,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  this.initialize();
@@ -1267,7 +1280,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  const defaultCallSettings = this._defaults['listKeys'];
@@ -1317,7 +1330,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  const defaultCallSettings = this._defaults['listKeys'];
@@ -1429,7 +1442,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  this.initialize();
@@ -1479,7 +1492,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  const defaultCallSettings = this._defaults['listRelatedAccountGroups'];
@@ -1534,7 +1547,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  const defaultCallSettings = this._defaults['listRelatedAccountGroups'];
@@ -1647,7 +1660,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  this.initialize();
@@ -1698,7 +1711,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  const defaultCallSettings =
@@ -1755,7 +1768,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  const defaultCallSettings =
@@ -1873,7 +1886,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  project: request.project || '',
  });
  this.initialize();
@@ -1928,7 +1941,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  project: request.project || '',
  });
  const defaultCallSettings =
@@ -1989,7 +2002,7 @@ export class RecaptchaEnterpriseServiceClient {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  project: request.project || '',
  });
  const defaultCallSettings =

diff --git a/...gle-cloud-recaptchaenterprise/src/v1beta1/recaptcha_enterprise_service_v1_beta1_client.ts b/...gle-cloud-recaptchaenterprise/src/v1beta1/recaptcha_enterprise_service_v1_beta1_client.ts
@@ -17,8 +17,13 @@
 // ** All changes to this file may be overwritten. **
 
 /* global window */
-import * as gax from 'google-gax';
-import {Callback, CallOptions, Descriptors, ClientOptions} from 'google-gax';
+import type * as gax from 'google-gax';
+import type {
+ Callback,
+ CallOptions,
+ Descriptors,
+ ClientOptions,
+} from 'google-gax';
 
 import * as protos from '../../protos/protos';
 import jsonProtos = require('../../protos/protos.json');
@@ -28,7 +33,6 @@ import jsonProtos = require('../../protos/protos.json');
  * This file defines retry strategy and timeouts for all API methods in this library.
  */
 import * as gapicConfig from './recaptcha_enterprise_service_v1_beta1_client_config.json';
-
 const version = require('../../../package.json').version;
 
 /**
@@ -88,8 +92,18 @@ export class RecaptchaEnterpriseServiceV1Beta1Client {
  * Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
  * For more information, please check the
  * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+ * need to avoid loading the default gRPC version and want to use the fallback
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
+ * ```
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+ * const client = new RecaptchaEnterpriseServiceV1Beta1Client({fallback: 'rest'}, gax);
+ * ```
  */
- constructor(opts?: ClientOptions) {
+ constructor(
+ opts?: ClientOptions,
+ gaxInstance?: typeof gax | typeof gax.fallback
+ ) {
  // Ensure that options include all the required fields.
  const staticMembers = this
  .constructor as typeof RecaptchaEnterpriseServiceV1Beta1Client;
@@ -110,8 +124,13 @@ export class RecaptchaEnterpriseServiceV1Beta1Client {
  opts['scopes'] = staticMembers.scopes;
  }
 
+ // Load google-gax module synchronously if needed
+ if (!gaxInstance) {
+ gaxInstance = require('google-gax') as typeof gax;
+ }
+
  // Choose either gRPC or proto-over-HTTP implementation of google-gax.
- this._gaxModule = opts.fallback ? gax.fallback : gax;
+ this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
 
  // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
  this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
@@ -177,7 +196,7 @@ export class RecaptchaEnterpriseServiceV1Beta1Client {
  this.innerApiCalls = {};
 
  // Add a warn function to the client constructor so it can be easily tested.
- this.warn = gax.warn;
+ this.warn = this._gaxModule.warn;
  }
 
  /**
@@ -393,7 +412,7 @@ export class RecaptchaEnterpriseServiceV1Beta1Client {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  parent: request.parent || '',
  });
  this.initialize();
@@ -504,7 +523,7 @@ export class RecaptchaEnterpriseServiceV1Beta1Client {
  options.otherArgs = options.otherArgs || {};
  options.otherArgs.headers = options.otherArgs.headers || {};
  options.otherArgs.headers['x-goog-request-params'] =
- gax.routingHeader.fromParams({
+ this._gaxModule.routingHeader.fromParams({
  name: request.name || '',
  });
  this.initialize();