feat: gdb failover support

Author: karenc-bq

.github/workflows/integration_tests.yml

@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - main
-      - refactor/monitor-service
     paths-ignore:
       - "**/*.md"
       - "**/*.jpg"

common/lib/authentication/aws_secrets_manager_plugin.ts

@@ -129,21 +129,18 @@ export class AwsSecretsManagerPlugin extends AbstractConnectionPlugin implements
       this.pluginService.updateConfigWithProperties(props);
       return await connectFunc();
     } catch (error) {
-      if (error instanceof Error) {
-        if ((error.message.includes("password authentication failed") || error.message.includes("Access denied")) && !secretWasFetched) {
-          // Login unsuccessful with cached credentials
-          // Try to re-fetch credentials and try again
-
-          secretWasFetched = await this.updateSecret(true);
-          if (secretWasFetched) {
-            WrapperProperties.USER.set(props, this.secret?.username ?? "");
-            WrapperProperties.PASSWORD.set(props, this.secret?.password ?? "");
-            return await connectFunc();
-          }
+      if ((error.message.includes("password authentication failed") || error.message.includes("Access denied")) && !secretWasFetched) {
+        // Login unsuccessful with cached credentials
+        // Try to re-fetch credentials and try again
+
+        secretWasFetched = await this.updateSecret(true);
+        if (secretWasFetched) {
+          WrapperProperties.USER.set(props, this.secret?.username ?? "");
+          WrapperProperties.PASSWORD.set(props, this.secret?.password ?? "");
+          return await connectFunc();
         }
-        logger.debug(Messages.get("AwsSecretsManagerConnectionPlugin.unhandledError", error.name, error.message));
       }
-      throw error;
+      logger.debug(Messages.get("AwsSecretsManagerConnectionPlugin.unhandledError", error.name, error.message));
     }
   }
 

common/lib/authentication/aws_secrets_manager_plugin_factory.ts

@@ -28,7 +28,7 @@ export class AwsSecretsManagerPluginFactory extends ConnectionPluginFactory {
       if (!AwsSecretsManagerPluginFactory.awsSecretsManagerPlugin) {
         AwsSecretsManagerPluginFactory.awsSecretsManagerPlugin = await import("./aws_secrets_manager_plugin");
       }
-      return new AwsSecretsManagerPluginFactory.awsSecretsManagerPlugin.AwsSecretsManagerPlugin(servicesContainer.getPluginService(), new Map(properties));
+      return new AwsSecretsManagerPluginFactory.awsSecretsManagerPlugin.AwsSecretsManagerPlugin(servicesContainer.pluginService, new Map(properties));
     } catch (error: any) {
       if (error.code === "MODULE_NOT_FOUND") {
         throw new AwsWrapperError(Messages.get("ConnectionPluginChainBuilder.errorImportingPlugin", error.message, "AwsSecretsManagerPlugin"));

common/lib/authentication/iam_authentication_plugin_factory.ts

@@ -28,7 +28,7 @@ export class IamAuthenticationPluginFactory extends ConnectionPluginFactory {
       if (!IamAuthenticationPluginFactory.iamAuthenticationPlugin) {
         IamAuthenticationPluginFactory.iamAuthenticationPlugin = await import("./iam_authentication_plugin");
       }
-      return new IamAuthenticationPluginFactory.iamAuthenticationPlugin.IamAuthenticationPlugin(servicesContainer.getPluginService());
+      return new IamAuthenticationPluginFactory.iamAuthenticationPlugin.IamAuthenticationPlugin(servicesContainer.pluginService);
     } catch (error: any) {
       throw new AwsWrapperError(Messages.get("ConnectionPluginChainBuilder.errorImportingPlugin", error.message, "IamAuthenticationPlugin"));
     }

common/lib/aws_client.ts

@@ -71,7 +71,7 @@ export abstract class AwsClient extends EventEmitter implements SessionStateClie
 
     this.properties = new Map<string, any>(Object.entries(config));
 
-    this.storageService = CoreServicesContainer.getInstance().getStorageService();
+    this.storageService = CoreServicesContainer.getInstance().storageService;
 
     const profileName = WrapperProperties.PROFILE_NAME.get(this.properties);
     if (profileName && profileName.length > 0) {
@@ -108,9 +108,9 @@ export abstract class AwsClient extends EventEmitter implements SessionStateClie
     }
 
     const coreServicesContainer: CoreServicesContainer = CoreServicesContainer.getInstance();
-    this.storageService = coreServicesContainer.getStorageService();
-    this.monitorService = coreServicesContainer.getMonitorService();
-    this.eventPublisher = coreServicesContainer.getEventPublisher();
+    this.storageService = coreServicesContainer.storageService;
+    this.monitorService = coreServicesContainer.monitorService;
+    this.eventPublisher = coreServicesContainer.eventPublisher;
     this.telemetryFactory = new DefaultTelemetryFactory(this.properties);
 
     this.fullServiceContainer = ServiceUtils.instance.createStandardServiceContainer(
@@ -126,8 +126,8 @@ export abstract class AwsClient extends EventEmitter implements SessionStateClie
       connectionProvider
     );
 
-    this.pluginService = this.fullServiceContainer.getPluginService();
-    this.pluginManager = this.fullServiceContainer.getPluginManager();
+    this.pluginService = this.fullServiceContainer.pluginService;
+    this.pluginManager = this.fullServiceContainer.pluginManager;
   }
 
   private async setup() {
@@ -144,7 +144,7 @@ export abstract class AwsClient extends EventEmitter implements SessionStateClie
     await this.pluginService.refreshHostList();
     const initialHostInfo = this.pluginService.getInitialConnectionHostInfo();
     if (initialHostInfo != null) {
-      await this.pluginManager.initHostProvider(initialHostInfo, this.properties, this.fullServiceContainer.getHostListProviderService());
+      await this.pluginManager.initHostProvider(initialHostInfo, this.properties, this.fullServiceContainer.hostListProviderService);
       await this.pluginService.refreshHostList();
     }
   }

common/lib/connection_plugin_chain_builder.ts

@@ -43,6 +43,7 @@ import { CustomEndpointPluginFactory } from "./plugins/custom_endpoint/custom_en
 import { ConfigurationProfile } from "./profile/configuration_profile";
 import { HostMonitoring2PluginFactory } from "./plugins/efm2/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 { FullServicesContainer } from "./utils/full_services_container";
 
 /*
@@ -66,6 +67,7 @@ export class ConnectionPluginChainBuilder {
     ["readWriteSplitting", { factory: ReadWriteSplittingPluginFactory, weight: 600 }],
     ["failover", { factory: FailoverPluginFactory, weight: 700 }],
     ["failover2", { factory: Failover2PluginFactory, weight: 710 }],
+    ["gdbFailover", { factory: GlobalDbFailoverPluginFactory, weight: 720 }],
     ["efm", { factory: HostMonitoringPluginFactory, weight: 800 }],
     ["efm2", { factory: HostMonitoring2PluginFactory, weight: 810 }],
     ["fastestResponseStrategy", { factory: FastestResponseStrategyPluginFactory, weight: 900 }],
@@ -87,6 +89,7 @@ export class ConnectionPluginChainBuilder {
     [ReadWriteSplittingPluginFactory, 600],
     [FailoverPluginFactory, 700],
     [Failover2PluginFactory, 710],
+    [GlobalDbFailoverPluginFactory, 720],
     [HostMonitoringPluginFactory, 800],
     [HostMonitoring2PluginFactory, 810],
     [LimitlessConnectionPluginFactory, 950],

common/lib/database_dialect/database_dialect_codes.ts

@@ -15,11 +15,13 @@
 */
 
 export class DatabaseDialectCodes {
+  static readonly GLOBAL_AURORA_MYSQL: string = "global-aurora-mysql";
   static readonly AURORA_MYSQL: string = "aurora-mysql";
   static readonly RDS_MYSQL: string = "rds-mysql";
   static readonly MYSQL: string = "mysql";
   // https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
   static readonly RDS_MULTI_AZ_MYSQL: string = "rds-multi-az-mysql";
+  static readonly GLOBAL_AURORA_PG: string = "global-aurora-pg";
   static readonly AURORA_PG: string = "aurora-pg";
   static readonly RDS_PG: string = "rds-pg";
   // https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html

common/lib/database_dialect/database_dialect_manager.ts

@@ -95,6 +95,14 @@ export class DatabaseDialectManager implements DatabaseDialectProvider {
 
     if (this.dbType === DatabaseType.MYSQL) {
       const type = this.rdsHelper.identifyRdsType(host);
+      if (type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER) {
+        this.canUpdate = false;
+        this.dialectCode = DatabaseDialectCodes.GLOBAL_AURORA_MYSQL;
+        this.dialect = <DatabaseDialect>this.knownDialectsByCode.get(DatabaseDialectCodes.GLOBAL_AURORA_MYSQL);
+        this.logCurrentDialect();
+        return this.dialect;
+      }
+
       if (type.isRdsCluster) {
         this.canUpdate = true;
         this.dialectCode = DatabaseDialectCodes.AURORA_MYSQL;
@@ -128,6 +136,14 @@ export class DatabaseDialectManager implements DatabaseDialectProvider {
         return this.dialect;
       }
 
+      if (type == RdsUrlType.RDS_GLOBAL_WRITER_CLUSTER) {
+        this.canUpdate = false;
+        this.dialectCode = DatabaseDialectCodes.GLOBAL_AURORA_PG;
+        this.dialect = <DatabaseDialect>this.knownDialectsByCode.get(DatabaseDialectCodes.GLOBAL_AURORA_PG);
+        this.logCurrentDialect();
+        return this.dialect;
+      }
+
       if (type.isRdsCluster) {
         this.canUpdate = true;
         this.dialectCode = DatabaseDialectCodes.AURORA_PG;

common/lib/driver_dialect/driver_dialect.ts

@@ -30,7 +30,7 @@ export interface DriverDialect {
 
   setConnectTimeout(props: Map<string, any>, wrapperConnectTimeout?: any): void;
 
-  setQueryTimeout(props: Map<string, any>, sql?: any, wrapperConnectTimeout?: any): void;
+  setQueryTimeout(props: Map<string, any>, sql?: any, wrapperQueryTimeout?: any): void;
 
   setKeepAliveProperties(props: Map<string, any>, keepAliveProps: any): void;
 

common/lib/highest_weight_host_selector.ts

@@ -26,7 +26,7 @@ export class HighestWeightHostSelector implements HostSelector {
 
   getHost(hosts: HostInfo[], role: HostRole, props?: Map<string, any>): HostInfo {
     const eligibleHosts: HostInfo[] = hosts
-      .filter((host: HostInfo) => host.role === role && host.availability === HostAvailability.AVAILABLE)
+      .filter((host: HostInfo) => (role === null || host.role === role) && host.availability === HostAvailability.AVAILABLE)
       .sort((hostA: HostInfo, hostB: HostInfo) => (hostA.weight > hostB.weight ? -1 : hostA.weight < hostB.weight ? 1 : 0));
 
     if (eligibleHosts.length === 0) {