fix(gax): fix logging backend fallback, filter matching, url.domain resolution, and fail-open logCall

Author: shivanee-p

core/packages/gax/src/clientInterface.ts

@@ -54,9 +54,10 @@ export interface ClientOptions
    * Whether to enable telemetry logging for the client.
    *
    * Logging is only enabled when `GOOGLE_SDK_NODE_EXPERIMENTAL_LOGGING` is enabled
-   * AND either a user passes `enableTelemetryLogging: true` in their client options
-   * or the `GOOGLE_SDK_NODE_LOGGING` environment variable matches the client service
-   * namespace.
+   * AND either `enableTelemetryLogging: true` is passed here or, when unset, the
+   * `GOOGLE_SDK_NODE_LOGGING` environment variable matches the client service
+   * namespace. Explicitly setting `enableTelemetryLogging: false` disables logging
+   * for this client even when `GOOGLE_SDK_NODE_LOGGING` matches.
    */
   enableTelemetryLogging?: boolean;
 }

core/packages/gax/src/fallback.ts

@@ -18,6 +18,7 @@ import {OutgoingHttpHeaders} from 'http';
 import objectHash from 'object-hash';
 import * as protobuf from 'protobufjs';
 import * as gax from './gax';
+import {setSettingsDefaultDomain} from './observability/contextUtil';
 import * as routingHeader from './routingHeader';
 import {Status} from './status';
 import {GoogleAuth, AuthClient} from 'google-auth-library';
@@ -305,7 +306,7 @@ export class GrpcClient {
     if (this._port !== undefined) {
       otherArgs.port = this._port;
     }
-    return gax.constructSettings(
+    const defaults = gax.constructSettings(
       serviceName,
       clientConfig,
       configOverrides,
@@ -315,6 +316,17 @@ export class GrpcClient {
       _legacyTelemetryInfo,
       enableTelemetryLogging ?? this._enableTelemetryLogging,
     );
+    const defaultServicePath = (this.auth as {defaultServicePath?: unknown})
+      ?.defaultServicePath;
+    if (
+      typeof defaultServicePath === 'string' &&
+      defaultServicePath.includes('.')
+    ) {
+      for (const methodName of Object.keys(defaults)) {
+        setSettingsDefaultDomain(defaults[methodName], defaultServicePath);
+      }
+    }
+    return defaults;
   }
 
   /**

core/packages/gax/src/gax.ts

@@ -25,6 +25,10 @@ import {GoogleError} from './googleError';
 import {BundleOptions} from './bundlingCalls/bundleExecutor';
 import {toLowerCamelCase} from './util';
 import {checkTracingEnabled, checkLoggingEnabled} from './observability/util';
+import {
+  getSettingsDefaultDomain,
+  setSettingsDefaultDomain,
+} from './observability/contextUtil';
 import {Status} from './status';
 import {RequestType} from './apitypes';
 
@@ -253,7 +257,12 @@ export class CallSettings {
    */
   merge(options?: CallOptions | null) {
     if (!options) {
-      return new CallSettings(this);
+      const merged = new CallSettings(this);
+      const defaultDomain = getSettingsDefaultDomain(this);
+      if (defaultDomain) {
+        setSettingsDefaultDomain(merged, defaultDomain);
+      }
+      return merged;
     }
     let timeout = this.timeout;
     let retry = this.retry;
@@ -364,7 +373,7 @@ export class CallSettings {
       signal = options.signal;
     }
 
-    return new CallSettings({
+    const merged = new CallSettings({
       timeout,
       retry,
       bundleOptions: this.bundleOptions,
@@ -380,6 +389,17 @@ export class CallSettings {
       resumableUpload,
       signal,
     });
+    const defaultDomain =
+      (options instanceof CallSettings
+        ? getSettingsDefaultDomain(options)
+        : undefined) ??
+      (!('apiName' in options) || options.apiName === this.apiName
+        ? getSettingsDefaultDomain(this)
+        : undefined);
+    if (defaultDomain) {
+      setSettingsDefaultDomain(merged, defaultDomain);
+    }
+    return merged;
   }
 }
 
@@ -869,8 +889,8 @@ export interface ClientConfig {
  * @param {boolean} [enableTelemetryTracing] - Flag to enable telemetry tracing
  *   when passed in client options (or overridden by `GOOGLE_SDK_NODE_ENABLE_TRACING`).
  * @param {unknown} [_legacyTelemetryInfo] - Unused legacy parameter kept for backward compatibility.
- * @param {boolean} [enableTelemetryLogging] - Flag to enable telemetry logging
- *   when passed in client options (or when `GOOGLE_SDK_NODE_LOGGING` matches the service namespace).
+ * @param {boolean} [enableTelemetryLogging] - Flag to enable or disable telemetry
+ *   logging for this client, taking precedence over `GOOGLE_SDK_NODE_LOGGING` when set.
  * @return {Object} A mapping from method name to CallSettings, or null if the
  *   service is not found in the config.
  */
@@ -905,15 +925,21 @@ export function constructSettings(
     env.GOOGLE_SDK_NODE_EXPERIMENTAL_LOGGING?.trim().toLowerCase();
   const isExperimentalLoggingEnabled =
     experimentalLogging === 'true' || experimentalLogging === '1';
-  const isLoggingEnvEnabled = checkLoggingEnabled(
-    new CallSettings({apiName: serviceName}),
-  );
-
+  const isLoggingEnvEnabled =
+    isExperimentalLoggingEnabled && enableTelemetryLogging === undefined
+      ? checkLoggingEnabled(new CallSettings({apiName: serviceName}))
+      : false;
+  const resolvedLogging =
+    enableTelemetryLogging !== undefined
+      ? enableTelemetryLogging
+      : isLoggingEnvEnabled
+        ? true
+        : undefined;
   const loggingRequested =
-    isExperimentalLoggingEnabled &&
-    (isLoggingEnvEnabled || Boolean(enableTelemetryLogging));
+    isExperimentalLoggingEnabled && Boolean(resolvedLogging);
 
   otherArgs = otherArgs || {};
+
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const defaults: any = {};
 
@@ -982,9 +1008,7 @@ export function constructSettings(
       apiName,
       enableTelemetryTracing: isEnvSet ? isEnvEnabled : enableTelemetryTracing,
       enableTelemetryLogging: isExperimentalLoggingEnabled
-        ? isLoggingEnvEnabled
-          ? true
-          : enableTelemetryLogging
+        ? resolvedLogging
         : enableTelemetryLogging !== undefined
           ? false
           : undefined,

core/packages/gax/src/grpc.ts

@@ -27,6 +27,7 @@ import * as protobuf from 'protobufjs';
 import objectHash from 'object-hash';
 
 import * as gax from './gax';
+import {setSettingsDefaultDomain} from './observability/contextUtil';
 import {ClientOptions} from '@grpc/grpc-js/build/src/client';
 
 const googleProtoFilesDir = path.join(__dirname, '..', '..', 'build', 'protos');
@@ -67,9 +68,10 @@ export interface GrpcClientOptions extends GoogleAuthOptions {
    * Whether to enable telemetry logging for the client.
    *
    * Logging is only enabled when `GOOGLE_SDK_NODE_EXPERIMENTAL_LOGGING` is enabled
-   * AND either a user passes `enableTelemetryLogging: true` in their client options
-   * or the `GOOGLE_SDK_NODE_LOGGING` environment variable matches the client service
-   * namespace.
+   * AND either `enableTelemetryLogging: true` is passed here or, when unset, the
+   * `GOOGLE_SDK_NODE_LOGGING` environment variable matches the client service
+   * namespace. Explicitly setting `enableTelemetryLogging: false` disables logging
+   * for this client even when `GOOGLE_SDK_NODE_LOGGING` matches.
    */
   enableTelemetryLogging?: boolean;
 }
@@ -430,7 +432,7 @@ export class GrpcClient {
     if (this._port !== undefined) {
       otherArgs.port = this._port;
     }
-    return gax.constructSettings(
+    const defaults = gax.constructSettings(
       serviceName,
       clientConfig,
       configOverrides,
@@ -440,6 +442,17 @@ export class GrpcClient {
       _legacyTelemetryInfo,
       enableTelemetryLogging ?? this._enableTelemetryLogging,
     );
+    const defaultServicePath = (this.auth as {defaultServicePath?: unknown})
+      ?.defaultServicePath;
+    if (
+      typeof defaultServicePath === 'string' &&
+      defaultServicePath.includes('.')
+    ) {
+      for (const methodName of Object.keys(defaults)) {
+        setSettingsDefaultDomain(defaults[methodName], defaultServicePath);
+      }
+    }
+    return defaults;
   }
 
   /**