chore: use consistent naming for GlobalDB related functionalities (#690)

Author: karenc-bq

common/lib/authentication/iam_authentication_plugin.ts

@@ -28,7 +28,7 @@ import { RegionUtils } from "../utils/region_utils";
 import { CanReleaseResources } from "../can_release_resources";
 import { RdsUrlType } from "../utils/rds_url_type";
 import { RdsUtils } from "../utils/rds_utils";
-import { GDBRegionUtils } from "../utils/gdb_region_utils";
+import { GlobalDbRegionUtils } from "../utils/global_db_region_utils";
 
 export class IamAuthenticationPlugin extends AbstractConnectionPlugin implements CanReleaseResources {
   private static readonly SUBSCRIBED_METHODS = new Set<string>(["connect", "forceConnect"]);
@@ -85,7 +85,7 @@ export class IamAuthenticationPlugin extends AbstractConnectionPlugin implements
     const port = this.iamAuthUtils.getIamPort(props, hostInfo, this.pluginService.getCurrentClient().defaultPort);
 
     const type: RdsUrlType = this.rdsUtils.identifyRdsType(host.host);
-    this.regionUtils = type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER ? new GDBRegionUtils() : new RegionUtils();
+    this.regionUtils = type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER ? new GlobalDbRegionUtils() : new RegionUtils();
     const region: string | null = await this.regionUtils.getRegion(WrapperProperties.IAM_REGION.name, host, props);
 
     if (!region) {

common/lib/connection_plugin_chain_builder.ts

@@ -43,9 +43,9 @@ import { CustomEndpointPluginFactory } from "./plugins/custom_endpoint/custom_en
 import { ConfigurationProfile } from "./profile/configuration_profile";
 import { HostMonitoring2PluginFactory } from "./plugins/efm/v2/host_monitoring2_plugin_factory";
 import { BlueGreenPluginFactory } from "./plugins/bluegreen/blue_green_plugin_factory";
-import { GlobalDbFailoverPluginFactory } from "./plugins/gdb_failover/global_db_failover_plugin_factory";
+import { GlobalDbFailoverPluginFactory } from "./plugins/global_db_failover/global_db_failover_plugin_factory";
 import { FullServicesContainer } from "./utils/full_services_container";
-import { GdbReadWriteSplittingPluginFactory } from "./plugins/read_write_splitting/gdb_read_write_splitting_plugin_factory";
+import { GlobalDbReadWriteSplittingPluginFactory } from "./plugins/read_write_splitting/global_db_read_write_splitting_plugin_factory";
 
 /*
   Type alias used for plugin factory sorting. It holds a reference to a plugin
@@ -66,7 +66,7 @@ export class ConnectionPluginChainBuilder {
     ["staleDns", { factory: StaleDnsPluginFactory, weight: 500 }],
     ["bg", { factory: BlueGreenPluginFactory, weight: 550 }],
     ["readWriteSplitting", { factory: ReadWriteSplittingPluginFactory, weight: 600 }],
-    ["gdbReadWriteSplitting", { factory: GdbReadWriteSplittingPluginFactory, weight: 610 }],
+    ["gdbReadWriteSplitting", { factory: GlobalDbReadWriteSplittingPluginFactory, weight: 610 }],
     ["failover", { factory: FailoverPluginFactory, weight: 700 }],
     ["failover2", { factory: Failover2PluginFactory, weight: 710 }],
     ["gdbFailover", { factory: GlobalDbFailoverPluginFactory, weight: 720 }],
@@ -89,7 +89,7 @@ export class ConnectionPluginChainBuilder {
     [StaleDnsPluginFactory, 500],
     [BlueGreenPluginFactory, 550],
     [ReadWriteSplittingPluginFactory, 600],
-    [GdbReadWriteSplittingPluginFactory, 610],
+    [GlobalDbReadWriteSplittingPluginFactory, 610],
     [FailoverPluginFactory, 700],
     [Failover2PluginFactory, 710],
     [GlobalDbFailoverPluginFactory, 720],

common/lib/host_list_provider/global_topology_utils.ts

@@ -22,11 +22,11 @@ import { isDialectTopologyAware } from "../database_dialect/topology_aware_datab
 import { Messages } from "../utils/messages";
 import { AwsWrapperError } from "../utils/errors";
 
-export interface GdbTopologyUtils {
+export interface GlobalDbTopologyUtils {
   getRegion(instanceId: string, targetClient: ClientWrapper, dialect: DatabaseDialect): Promise<string | null>;
 }
 
-export class GlobalTopologyUtils extends TopologyUtils implements GdbTopologyUtils {
+export class GlobalTopologyUtils extends TopologyUtils implements GlobalDbTopologyUtils {
   async queryForTopology(
     targetClient: ClientWrapper,
     dialect: DatabaseDialect,

common/lib/host_list_provider/monitoring/global_aurora_topology_monitor.ts

@@ -15,7 +15,7 @@
 */
 
 import { ClusterTopologyMonitorImpl } from "./cluster_topology_monitor";
-import { GdbTopologyUtils } from "../global_topology_utils";
+import { GlobalDbTopologyUtils } from "../global_topology_utils";
 import { FullServicesContainer } from "../../utils/full_services_container";
 import { HostInfo } from "../../host_info";
 import { ClientWrapper } from "../../client_wrapper";
@@ -24,19 +24,19 @@ import { Messages } from "../../utils/messages";
 import { TopologyUtils } from "../topology_utils";
 import { AccessibleRegions } from "../../utils/accessible_regions";
 import { MonitoringConnectionHandler } from "./monitoring_connection_handler";
-import { GdbMonitoringConnectionHandler } from "./gdb_monitoring_connection_handler";
+import { GlobalDbMonitoringConnectionHandler } from "./global_db_monitoring_connection_handler";
 import { WrapperProperties } from "../../wrapper_property";
 import { RdsUtils } from "../../utils/rds_utils";
 import { logger } from "../../../logutils";
 
-function isGdbTopologyUtils(utils: TopologyUtils): utils is TopologyUtils & GdbTopologyUtils {
-  return "getRegion" in utils && typeof (utils as unknown as GdbTopologyUtils).getRegion === "function";
+function isGlobalDbTopologyUtils(utils: TopologyUtils): utils is TopologyUtils & GlobalDbTopologyUtils {
+  return "getRegion" in utils && typeof (utils as unknown as GlobalDbTopologyUtils).getRegion === "function";
 }
 
 export class GlobalAuroraTopologyMonitor extends ClusterTopologyMonitorImpl {
   protected readonly instanceTemplatesByRegion: Map<string, HostInfo>;
   protected readonly accessibleRegions: string[] | null;
-  protected readonly gdbRdsUtils: RdsUtils = new RdsUtils();
+  protected readonly globalDbRdsUtils: RdsUtils = new RdsUtils();
   declare public readonly topologyUtils: TopologyUtils;
 
   constructor(
@@ -63,8 +63,8 @@ export class GlobalAuroraTopologyMonitor extends ClusterTopologyMonitorImpl {
 
   protected override createConnectionHandler(): MonitoringConnectionHandler {
     const homeRegion =
-      WrapperProperties.FAILOVER_HOME_REGION.get(this.monitoringProperties) ?? this.gdbRdsUtils.getRdsRegion(this.initialHostInfo.host);
-    return new GdbMonitoringConnectionHandler(
+      WrapperProperties.FAILOVER_HOME_REGION.get(this.monitoringProperties) ?? this.globalDbRdsUtils.getRdsRegion(this.initialHostInfo.host);
+    return new GlobalDbMonitoringConnectionHandler(
       this.pluginService,
       this.monitoringProperties,
       this.accessibleRegions,
@@ -84,7 +84,7 @@ export class GlobalAuroraTopologyMonitor extends ClusterTopologyMonitorImpl {
     if (this.accessibleRegions) {
       // Only fail loud when the initial host's region is known and excluded. If the region can't be
       // determined, defer to the normal workflow rather than blocking the connection.
-      const region = this.gdbRdsUtils.getRdsRegion(this.initialHostInfo.host);
+      const region = this.globalDbRdsUtils.getRdsRegion(this.initialHostInfo.host);
       if (region && !this.accessibleRegions.includes(region.toLowerCase())) {
         const msg = Messages.get("GlobalAuroraTopologyMonitor.initialHostNotInAccessibleRegion", this.initialHostInfo.host, region);
         throw new AwsWrapperError(msg);
@@ -95,7 +95,7 @@ export class GlobalAuroraTopologyMonitor extends ClusterTopologyMonitorImpl {
   }
 
   protected override async getInstanceTemplate(hostId: string, targetClient: ClientWrapper): Promise<HostInfo> {
-    if (!isGdbTopologyUtils(this.topologyUtils)) {
+    if (!isGlobalDbTopologyUtils(this.topologyUtils)) {
       throw new AwsWrapperError(Messages.get("GlobalAuroraTopologyMonitor.invalidTopologyUtils"));
     }
 

…ing/gdb_monitoring_connection_handler.ts …obal_db_monitoring_connection_handler.tscommon/lib/host_list_provider/monitoring/gdb_monitoring_connection_handler.ts renamed to common/lib/host_list_provider/monitoring/global_db_monitoring_connection_handler.ts common/lib/host_list_provider/monitoring/gdb_monitoring_connection_handler.ts renamed to common/lib/host_list_provider/monitoring/global_db_monitoring_connection_handler.ts

@@ -25,7 +25,7 @@ import { Messages } from "../../utils/messages";
 import { AbstractMonitoringConnectionHandler } from "./monitoring_connection_handler";
 import { equalsIgnoreCase } from "../../utils/utils";
 
-export enum GdbMonitoringConnectionPriority {
+export enum GlobalDbMonitoringConnectionPriority {
   STRICT_WRITER_PRIMARY = "strict-writer-primary",
   STRICT_WRITER_SECONDARY = "strict-writer-secondary",
   STRICT_READER_PRIMARY = "strict-reader-primary",
@@ -35,44 +35,44 @@ export enum GdbMonitoringConnectionPriority {
   REGION = "region"
 }
 
-interface GdbPriorityConfig {
-  type: GdbMonitoringConnectionPriority;
+interface GlobalDbPriorityConfig {
+  type: GlobalDbMonitoringConnectionPriority;
   region?: string;
 }
 
 // AWS region identifiers look like "us-east-1", "eu-west-2", "ap-southeast-1".
 const REGION_SHAPE = /^[a-z]{2}-[a-z]+-\d+$/;
 
-function parseGdbPriority(value: string | null): GdbPriorityConfig | null {
+function parseGlobalDbPriority(value: string | null): GlobalDbPriorityConfig | null {
   if (!value) {
     return null;
   }
   const lower = value.toLowerCase().trim();
   switch (lower) {
     case "strict-writer-primary":
-      return { type: GdbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY };
+      return { type: GlobalDbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY };
     case "strict-writer-secondary":
-      return { type: GdbMonitoringConnectionPriority.STRICT_WRITER_SECONDARY };
+      return { type: GlobalDbMonitoringConnectionPriority.STRICT_WRITER_SECONDARY };
     case "strict-reader-primary":
-      return { type: GdbMonitoringConnectionPriority.STRICT_READER_PRIMARY };
+      return { type: GlobalDbMonitoringConnectionPriority.STRICT_READER_PRIMARY };
     case "strict-reader-secondary":
-      return { type: GdbMonitoringConnectionPriority.STRICT_READER_SECONDARY };
+      return { type: GlobalDbMonitoringConnectionPriority.STRICT_READER_SECONDARY };
     case "writer-or-reader-primary":
-      return { type: GdbMonitoringConnectionPriority.WRITER_OR_READER_PRIMARY };
+      return { type: GlobalDbMonitoringConnectionPriority.WRITER_OR_READER_PRIMARY };
     case "writer-or-reader-secondary":
-      return { type: GdbMonitoringConnectionPriority.WRITER_OR_READER_SECONDARY };
+      return { type: GlobalDbMonitoringConnectionPriority.WRITER_OR_READER_SECONDARY };
     default:
       // Any unrecognized token is treated as a region literal. If it doesn't look like an AWS
       // region identifier, it is most likely a typo (e.g. "strict-wrtier-primary") that will
       // never match any host, so warn to aid diagnosis.
       if (!REGION_SHAPE.test(lower)) {
-        logger.warn(Messages.get("GdbMonitoringConnectionHandler.unrecognizedPriority", value));
+        logger.warn(Messages.get("GlobalDbMonitoringConnectionHandler.unrecognizedPriority", value));
       }
-      return { type: GdbMonitoringConnectionPriority.REGION, region: lower };
+      return { type: GlobalDbMonitoringConnectionPriority.REGION, region: lower };
   }
 }
 
-export class GdbMonitoringConnectionHandler extends AbstractMonitoringConnectionHandler<GdbPriorityConfig> {
+export class GlobalDbMonitoringConnectionHandler extends AbstractMonitoringConnectionHandler<GlobalDbPriorityConfig> {
   private readonly rdsUtils: RdsUtils = new RdsUtils();
   private readonly accessibleRegions: string[] | null;
   private primaryRegion: string | null = null;
@@ -86,24 +86,26 @@ export class GdbMonitoringConnectionHandler extends AbstractMonitoringConnection
     getMonitoringClient: () => ClientWrapper | null,
     setMonitoringClient: (client: ClientWrapper | null) => void
   ) {
-    const priorities = GdbMonitoringConnectionHandler.parsePriorities(WrapperProperties.GDB_MONITORING_CONNECTION_PRIORITY.get(monitoringProperties));
+    const priorities = GlobalDbMonitoringConnectionHandler.parsePriorities(
+      WrapperProperties.GLOBAL_DB_MONITORING_CONNECTION_PRIORITY.get(monitoringProperties)
+    );
     super(pluginService, monitoringProperties, priorities, getMonitoringClient, setMonitoringClient);
     this.accessibleRegions = accessibleRegions;
-    logger.debug(Messages.get("GdbMonitoringConnectionHandler.initialized", JSON.stringify(this.priorities)));
+    logger.debug(Messages.get("GlobalDbMonitoringConnectionHandler.initialized", JSON.stringify(this.priorities)));
   }
 
-  private static parsePriorities(value: string | null): GdbPriorityConfig[] {
+  private static parsePriorities(value: string | null): GlobalDbPriorityConfig[] {
     if (!value) {
-      return [{ type: GdbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY }];
+      return [{ type: GlobalDbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY }];
     }
-    const results: GdbPriorityConfig[] = [];
+    const results: GlobalDbPriorityConfig[] = [];
     for (const part of value.split(",")) {
-      const p = parseGdbPriority(part.trim());
+      const p = parseGlobalDbPriority(part.trim());
       if (p) {
         results.push(p);
       }
     }
-    return results.length > 0 ? results : [{ type: GdbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY }];
+    return results.length > 0 ? results : [{ type: GlobalDbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY }];
   }
 
   override acceptConnection(client: ClientWrapper, isWriter: boolean, hostInfo: HostInfo): boolean {
@@ -148,21 +150,21 @@ export class GdbMonitoringConnectionHandler extends AbstractMonitoringConnection
     return -1;
   }
 
-  private isSatisfiedBy(priority: GdbPriorityConfig, hostInfo: HostInfo, isWriter: boolean): boolean {
+  private isSatisfiedBy(priority: GlobalDbPriorityConfig, hostInfo: HostInfo, isWriter: boolean): boolean {
     switch (priority.type) {
-      case GdbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY:
         return isWriter && this.isInPrimaryRegion(hostInfo);
-      case GdbMonitoringConnectionPriority.STRICT_WRITER_SECONDARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_WRITER_SECONDARY:
         return isWriter && !this.isInPrimaryRegion(hostInfo);
-      case GdbMonitoringConnectionPriority.STRICT_READER_PRIMARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_READER_PRIMARY:
         return !isWriter && this.isInPrimaryRegion(hostInfo);
-      case GdbMonitoringConnectionPriority.STRICT_READER_SECONDARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_READER_SECONDARY:
         return !isWriter && !this.isInPrimaryRegion(hostInfo);
-      case GdbMonitoringConnectionPriority.WRITER_OR_READER_PRIMARY:
+      case GlobalDbMonitoringConnectionPriority.WRITER_OR_READER_PRIMARY:
         return this.isInPrimaryRegion(hostInfo);
-      case GdbMonitoringConnectionPriority.WRITER_OR_READER_SECONDARY:
+      case GlobalDbMonitoringConnectionPriority.WRITER_OR_READER_SECONDARY:
         return !this.isInPrimaryRegion(hostInfo);
-      case GdbMonitoringConnectionPriority.REGION:
+      case GlobalDbMonitoringConnectionPriority.REGION:
         return equalsIgnoreCase(this.getHostRegion(hostInfo), priority.region);
       default:
         return false;
@@ -177,29 +179,29 @@ export class GdbMonitoringConnectionHandler extends AbstractMonitoringConnection
     const filtered = this.filterAccessible(candidates);
     this.updatePrimaryRegion(filtered);
     switch (priority.type) {
-      case GdbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_WRITER_PRIMARY:
         return filtered.filter((h) => h.role === HostRole.WRITER && this.isInPrimaryRegion(h));
 
-      case GdbMonitoringConnectionPriority.STRICT_WRITER_SECONDARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_WRITER_SECONDARY:
         return filtered.filter((h) => h.role === HostRole.WRITER && !this.isInPrimaryRegion(h));
 
-      case GdbMonitoringConnectionPriority.STRICT_READER_PRIMARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_READER_PRIMARY:
         return filtered.filter((h) => h.role === HostRole.READER && this.isInPrimaryRegion(h));
 
-      case GdbMonitoringConnectionPriority.STRICT_READER_SECONDARY:
+      case GlobalDbMonitoringConnectionPriority.STRICT_READER_SECONDARY:
         return filtered.filter((h) => h.role === HostRole.READER && !this.isInPrimaryRegion(h));
 
-      case GdbMonitoringConnectionPriority.WRITER_OR_READER_PRIMARY: {
+      case GlobalDbMonitoringConnectionPriority.WRITER_OR_READER_PRIMARY: {
         const writers = filtered.filter((h) => h.role === HostRole.WRITER && this.isInPrimaryRegion(h));
         return writers.length > 0 ? writers : filtered.filter((h) => h.role === HostRole.READER && this.isInPrimaryRegion(h));
       }
 
-      case GdbMonitoringConnectionPriority.WRITER_OR_READER_SECONDARY: {
+      case GlobalDbMonitoringConnectionPriority.WRITER_OR_READER_SECONDARY: {
         const writers = filtered.filter((h) => h.role === HostRole.WRITER && !this.isInPrimaryRegion(h));
         return writers.length > 0 ? writers : filtered.filter((h) => h.role === HostRole.READER && !this.isInPrimaryRegion(h));
       }
 
-      case GdbMonitoringConnectionPriority.REGION: {
+      case GlobalDbMonitoringConnectionPriority.REGION: {
         const targetRegion = priority.region!;
         const writers = filtered.filter((h) => h.role === HostRole.WRITER && equalsIgnoreCase(this.getHostRegion(h), targetRegion));
         return writers.length > 0 ? writers : filtered.filter((h) => equalsIgnoreCase(this.getHostRegion(h), targetRegion));

common/lib/host_list_provider/monitoring/monitoring_connection_handler.ts

@@ -101,7 +101,7 @@ export interface MonitoringConnectionHandler {
  * Base class for monitoring connection handlers that manage a priority-ordered connection
  * lifecycle. Subclasses provide priority-specific logic via abstract hooks.
  *
- * @typeParam P the priority type (e.g. MonitoringConnectionPriority, GdbPriorityConfig)
+ * @typeParam P the priority type (e.g. MonitoringConnectionPriority, GlobalDbPriorityConfig)
  */
 export abstract class AbstractMonitoringConnectionHandler<P> implements MonitoringConnectionHandler {
   protected readonly pluginService: PluginService;

common/lib/plugins/custom_endpoint/custom_endpoint_plugin.ts

@@ -32,7 +32,7 @@ import { CustomEndpointMonitor, CustomEndpointMonitorImpl } from "./custom_endpo
 import { SubscribedMethodHelper } from "../../utils/subscribed_method_helper";
 import { CanReleaseResources } from "../../can_release_resources";
 import { RdsUrlType } from "../../utils/rds_url_type";
-import { GDBRegionUtils } from "../../utils/gdb_region_utils";
+import { GlobalDbRegionUtils } from "../../utils/global_db_region_utils";
 
 export class CustomEndpointPlugin extends AbstractConnectionPlugin implements CanReleaseResources {
   private static readonly TELEMETRY_WAIT_FOR_INFO_COUNTER = "customEndpoint.waitForInfo.counter";

common/lib/plugins/federated_auth/saml_auth_plugin.ts

@@ -29,7 +29,7 @@ import { ClientWrapper } from "../../client_wrapper";
 import { TelemetryCounter } from "../../utils/telemetry/telemetry_counter";
 import { RegionUtils } from "../../utils/region_utils";
 import { RdsUrlType } from "../../utils/rds_url_type";
-import { GDBRegionUtils } from "../../utils/gdb_region_utils";
+import { GlobalDbRegionUtils } from "../../utils/global_db_region_utils";
 import { AwsCredentialIdentity, AwsCredentialIdentityProvider } from "@smithy/types/dist-types/identity/awsCredentialIdentity";
 
 export class BaseSamlAuthPlugin extends AbstractConnectionPlugin {
@@ -93,7 +93,7 @@ export class BaseSamlAuthPlugin extends AbstractConnectionPlugin {
       credentialsProvider = await this.credentialsProviderFactory.getAwsCredentialsProvider(hostInfo.host, null, props);
     }
 
-    this.regionUtils = type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER ? new GDBRegionUtils(credentialsProvider) : new RegionUtils();
+    this.regionUtils = type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER ? new GlobalDbRegionUtils(credentialsProvider) : new RegionUtils();
     const region: string | null = await this.regionUtils.getRegion(WrapperProperties.IAM_REGION.name, host, props);
 
     if (!region) {

…/gdb_failover/global_db_failover_mode.ts …l_db_failover/global_db_failover_mode.tscommon/lib/plugins/gdb_failover/global_db_failover_mode.ts renamed to common/lib/plugins/global_db_failover/global_db_failover_mode.ts common/lib/plugins/gdb_failover/global_db_failover_mode.ts renamed to common/lib/plugins/global_db_failover/global_db_failover_mode.ts

@@ -104,7 +104,7 @@ export class GlobalDbFailoverPlugin extends Failover2Plugin {
       // The home region must be reachable. If it is excluded from the accessible regions, failover
       // candidate filtering would always drop it, so fail loudly at configuration time.
       if (this.homeRegion && !this.accessibleRegions.includes(this.homeRegion.toLowerCase())) {
-        throw new AwsWrapperError(Messages.get("Gdb.homeRegionNotAccessible", this.homeRegion, this.accessibleRegions.join(",")));
+        throw new AwsWrapperError(Messages.get("GlobalDb.homeRegionNotAccessible", this.homeRegion, this.accessibleRegions.join(",")));
       }
     }