refactor: use session state service impl to change readOnly state

.github/workflows/integration_tests.yml

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

common/lib/aws_client.ts

@@ -42,8 +42,6 @@ export abstract class AwsClient extends EventEmitter {
   protected pluginManager: PluginManager;
   protected pluginService: PluginService;
   protected isConnected: boolean = false;
-  protected _isReadOnly: boolean = false;
-  protected _isolationLevel: number = 0;
   protected _connectionUrlParser: ConnectionUrlParser;
   protected _configurationProfile: ConfigurationProfile | null = null;
   readonly properties: Map<string, any>;
@@ -151,8 +149,6 @@ export abstract class AwsClient extends EventEmitter {
     return this._connectionUrlParser;
   }
 
-  abstract updateSessionStateReadOnly(readOnly: boolean): Promise<any | void>;
-
   abstract setReadOnly(readOnly: boolean): Promise<any | void>;
 
   abstract isReadOnly(): boolean;
@@ -179,8 +175,6 @@ export abstract class AwsClient extends EventEmitter {
 
   abstract rollback(): Promise<any>;
 
-  abstract resetState(): void;
-
   async isValid(): Promise<boolean> {
     if (!this.targetClient) {
       return Promise.resolve(false);

common/lib/client_wrapper.ts

@@ -15,6 +15,7 @@
 */
 
 import { HostInfo } from "./host_info";
+import { SessionState } from "./session_state";
 
 export interface ClientWrapper {
   readonly client: any;

common/lib/database_dialect/database_dialect.ts

@@ -19,6 +19,7 @@ import { HostListProviderService } from "../host_list_provider_service";
 import { ClientWrapper } from "../client_wrapper";
 import { FailoverRestriction } from "../plugins/failover/failover_restriction";
 import { ErrorHandler } from "../error_handler";
+import { SessionState } from "../session_state";
 
 export enum DatabaseType {
   MYSQL,
@@ -30,6 +31,11 @@ export interface DatabaseDialect {
   getHostAliasQuery(): string;
   getHostAliasAndParseResults(targetClient: ClientWrapper): Promise<string>;
   getServerVersionQuery(): string;
+  getSetReadOnlyQuery(readOnly: boolean): string;
+  getSetAutoCommitQuery(autoCommit: boolean): string;
+  getSetTransactionIsolationQuery(level: number): string;
+  getSetCatalogQuery(catalog: string): string;
+  getSetSchemaQuery(schema: string): string;
   getDialectUpdateCandidates(): string[];
   getErrorHandler(): ErrorHandler;
   isDialect(targetClient: ClientWrapper): Promise<boolean>;

common/lib/mysql_client_wrapper.ts

@@ -18,6 +18,8 @@ import { ClientWrapper } from "./client_wrapper";
 import { HostInfo } from "./host_info";
 import { ClientUtils } from "./utils/client_utils";
 import { uniqueId } from "../logutils";
+import { SessionState } from "./session_state";
+import { TransactionIsolationLevel } from "./utils/transaction_isolation_level";
 import { DriverDialect } from "./driver_dialect/driver_dialect";
 
 /*

common/lib/pg_client_wrapper.ts

@@ -17,6 +17,8 @@
 import { ClientWrapper } from "./client_wrapper";
 import { HostInfo } from "./host_info";
 import { uniqueId } from "../logutils";
+import { SessionState } from "./session_state";
+import { TransactionIsolationLevel } from "./utils/transaction_isolation_level";
 
 /*
 This an internal wrapper class for a target community driver client created by the NodePostgresPgDriverDialect.
@@ -26,6 +28,7 @@ export class PgClientWrapper implements ClientWrapper {
   readonly hostInfo: HostInfo;
   readonly properties: Map<string, string>;
   readonly id: string;
+  readonly sessionState = new SessionState();
 
   /**
    * Creates a wrapper for the target community driver client.
@@ -38,6 +41,7 @@ export class PgClientWrapper implements ClientWrapper {
     this.client = targetClient;
     this.hostInfo = hostInfo;
     this.properties = properties;
+    this.sessionState = new SessionState();
     this.id = uniqueId("PgClient_");
   }
 

common/lib/plugin_service.ts

@@ -44,6 +44,7 @@ import { getWriter } from "./utils/utils";
 import { TelemetryFactory } from "./utils/telemetry/telemetry_factory";
 import { DriverDialect } from "./driver_dialect/driver_dialect";
 import { ConfigurationProfile } from "./profile/configuration_profile";
+import { SessionState } from "./session_state";
 
 export class PluginService implements ErrorHandler, HostListProviderService {
   private readonly _currentClient: AwsClient;
@@ -75,10 +76,10 @@ export class PluginService implements ErrorHandler, HostListProviderService {
     this.dbDialectProvider = new DatabaseDialectManager(knownDialectsByCode, dbType, this.props);
     this.driverDialect = driverDialect;
     this.initialHost = props.get(WrapperProperties.HOST.name);
-    this.sessionStateService = new SessionStateServiceImpl(this, this.props);
     container.pluginService = this;
 
     this.dialect = WrapperProperties.CUSTOM_DATABASE_DIALECT.get(this.props) ?? this.dbDialectProvider.getDialect(this.props);
+    this.sessionStateService = new SessionStateServiceImpl(this, this.props);
   }
 
   isInTransaction(): boolean {
@@ -333,7 +334,6 @@ export class PluginService implements ErrorHandler, HostListProviderService {
           this.sessionStateService.begin();
 
           try {
-            this.getCurrentClient().resetState();
             this.getCurrentClient().targetClient = newClient;
             this._currentHostInfo = hostInfo;
             await this.sessionStateService.applyCurrentSessionState(this.getCurrentClient());
@@ -432,35 +432,35 @@ export class PluginService implements ErrorHandler, HostListProviderService {
   private async updateReadOnly(statements: string[]) {
     const updateReadOnly = SqlMethodUtils.doesSetReadOnly(statements, this.getDialect());
     if (updateReadOnly !== undefined) {
-      await this.getCurrentClient().setReadOnly(updateReadOnly);
+      this.getSessionStateService().setReadOnly(updateReadOnly);
     }
   }
 
   private async updateAutoCommit(statements: string[]) {
     const updateAutoCommit = SqlMethodUtils.doesSetAutoCommit(statements, this.getDialect());
     if (updateAutoCommit !== undefined) {
-      await this.getCurrentClient().setAutoCommit(updateAutoCommit);
+      this.getSessionStateService().setAutoCommit(updateAutoCommit);
     }
   }
 
   private async updateCatalog(statements: string[]) {
     const updateCatalog = SqlMethodUtils.doesSetCatalog(statements, this.getDialect());
     if (updateCatalog !== undefined) {
-      await this.getCurrentClient().setCatalog(updateCatalog);
+      this.getSessionStateService().setCatalog(updateCatalog);
     }
   }
 
   private async updateSchema(statements: string[]) {
     const updateSchema = SqlMethodUtils.doesSetSchema(statements, this.getDialect());
     if (updateSchema !== undefined) {
-      await this.getCurrentClient().setSchema(updateSchema);
+      this.getSessionStateService().setSchema(updateSchema);
     }
   }
 
   private async updateTransactionIsolation(statements: string[]) {
     const updateTransactionIsolation = SqlMethodUtils.doesSetTransactionIsolation(statements, this.getDialect());
     if (updateTransactionIsolation !== undefined) {
-      await this.getCurrentClient().setTransactionIsolation(updateTransactionIsolation);
+      this.getSessionStateService().setTransactionIsolation(updateTransactionIsolation);
     }
   }
 

common/lib/plugins/failover/failover_plugin.ts

@@ -388,9 +388,9 @@ export class FailoverPlugin extends AbstractConnectionPlugin {
             throw new FailoverFailedError(Messages.get("Failover.unableToConnectToReader"));
           }
 
-          this.pluginService.getCurrentHostInfo()?.removeAlias(Array.from(oldAliases));
           await this.pluginService.abortCurrentClient();
           await this.pluginService.setCurrentClient(result.client, result.newHost);
+          this.pluginService.getCurrentHostInfo()?.removeAlias(Array.from(oldAliases));
           await this.updateTopology(true);
           this.failoverReaderSuccessCounter.inc();
         } catch (error: any) {

common/lib/pool_client_wrapper.ts

@@ -18,12 +18,14 @@ import { ClientWrapper } from "./client_wrapper";
 import { HostInfo } from "./host_info";
 import { uniqueId } from "../logutils";
 import { ClientUtils } from "./utils/client_utils";
+import { SessionState } from "./session_state";
 
 export class PoolClientWrapper implements ClientWrapper {
   readonly client: any;
   readonly hostInfo: HostInfo;
   readonly properties: Map<string, string>;
   readonly id: string;
+  readonly sessionState = new SessionState();
 
   constructor(targetClient: any, hostInfo: HostInfo, properties: Map<string, any>) {
     this.client = targetClient;

common/lib/session_state.ts

@@ -14,10 +14,28 @@
   limitations under the License.
 */
 
-class SessionStateField<Type> {
+import { DatabaseDialect } from "./database_dialect/database_dialect";
+import { AwsClient } from "./aws_client";
+
+export abstract class SessionStateField<Type> {
   value?: Type;
   pristineValue?: Type;
 
+  constructor(copy?: SessionStateField<Type>) {
+    if (copy) {
+      this.value = copy.value;
+      this.pristineValue = copy.pristineValue;
+    }
+  }
+
+  abstract setValue(state: SessionState): void;
+
+  abstract setPristineValue(state: SessionState): void;
+
+  abstract getQuery(dialect: DatabaseDialect, isPristine: boolean): string;
+
+  abstract getClientValue(client: AwsClient): Type;
+
   resetValue(): void {
     this.value = undefined;
   }
@@ -60,38 +78,123 @@ class SessionStateField<Type> {
     return true;
   }
 
-  copy(): SessionStateField<Type> {
-    const newField: SessionStateField<Type> = new SessionStateField();
-    if (this.value !== undefined) {
-      newField.value = this.value;
-    }
+  toString() {
+    return `${this.pristineValue ?? "(blank)"} => ${this.value ?? "(blank)"}`;
+  }
+}
 
-    if (this.pristineValue !== undefined) {
-      newField.pristineValue = this.pristineValue;
-    }
+class AutoCommitState extends SessionStateField<boolean> {
+  setValue(state: SessionState) {
+    this.value = state.autoCommit.value;
+  }
 
-    return newField;
+  setPristineValue(state: SessionState) {
+    this.value = state.autoCommit.pristineValue;
   }
 
-  toString() {
-    return `${this.pristineValue ?? "(blank)"} => ${this.value ?? "(blank)"}`;
+  getQuery(dialect: DatabaseDialect, isPristine: boolean = false) {
+    return dialect.getSetAutoCommitQuery(isPristine ? this.pristineValue : this.value);
+  }
+
+  getClientValue(client: AwsClient): boolean {
+    return client.getAutoCommit();
+  }
+}
+
+class ReadOnlyState extends SessionStateField<boolean> {
+  setValue(state: SessionState) {
+    this.value = state.readOnly.value;
+  }
+
+  setPristineValue(state: SessionState) {
+    this.value = state.readOnly.pristineValue;
+  }
+
+  getQuery(dialect: DatabaseDialect, isPristine: boolean = false) {
+    return dialect.getSetReadOnlyQuery(this.value);
+  }
+
+  getClientValue(client: AwsClient): boolean {
+    return client.isReadOnly();
+  }
+}
+
+class CatalogState extends SessionStateField<string> {
+  setValue(state: SessionState) {
+    this.value = state.catalog.value;
+  }
+
+  setPristineValue(state: SessionState) {
+    this.value = state.catalog.pristineValue;
+  }
+
+  getQuery(dialect: DatabaseDialect, isPristine: boolean = false) {
+    return dialect.getSetCatalogQuery(isPristine ? this.pristineValue : this.value);
+  }
+
+  getClientValue(client: AwsClient): string {
+    return client.getCatalog();
+  }
+}
+
+class SchemaState extends SessionStateField<string> {
+  setValue(state: SessionState) {
+    this.value = state.schema.value;
+  }
+
+  setPristineValue(state: SessionState) {
+    this.value = state.schema.pristineValue;
+  }
+
+  getQuery(dialect: DatabaseDialect, isPristine: boolean = false) {
+    return dialect.getSetSchemaQuery(isPristine ? this.pristineValue : this.value);
+  }
+
+  getClientValue(client: AwsClient): string {
+    return client.getSchema();
+  }
+}
+
+class TransactionIsolationState extends SessionStateField<number> {
+  setValue(state: SessionState) {
+    this.value = state.transactionIsolation.value;
+  }
+
+  setPristineValue(state: SessionState) {
+    this.value = state.transactionIsolation.pristineValue;
+  }
+
+  getQuery(dialect: DatabaseDialect, isPristine: boolean = false) {
+    return dialect.getSetTransactionIsolationQuery(isPristine ? this.pristineValue : this.value);
+  }
+
+  getClientValue(client: AwsClient): number {
+    return client.getTransactionIsolation();
   }
 }
 
 export class SessionState {
-  autoCommit: SessionStateField<boolean> = new SessionStateField<boolean>();
-  readOnly: SessionStateField<boolean> = new SessionStateField<boolean>();
-  catalog: SessionStateField<string> = new SessionStateField<string>();
-  schema: SessionStateField<string> = new SessionStateField<string>();
-  transactionIsolation: SessionStateField<number> = new SessionStateField<number>();
+  autoCommit: AutoCommitState = new AutoCommitState();
+  readOnly: ReadOnlyState = new ReadOnlyState();
+  catalog: CatalogState = new CatalogState();
+  schema: SchemaState = new SchemaState();
+  transactionIsolation: TransactionIsolationState = new TransactionIsolationState();
+
+  static setState(target: SessionStateField<any>, source: SessionState): void {
+    target.setValue(source);
+  }
+
+  static setPristineState(target: SessionStateField<any>, source: SessionState): void {
+    target.setPristineValue(source);
+  }
 
   copy(): SessionState {
     const newSessionState = new SessionState();
-    newSessionState.autoCommit = this.autoCommit.copy();
-    newSessionState.readOnly = this.readOnly.copy();
-    newSessionState.catalog = this.catalog.copy();
-    newSessionState.schema = this.schema.copy();
-    newSessionState.transactionIsolation = this.transactionIsolation.copy();
+    newSessionState.autoCommit = new AutoCommitState(this.autoCommit);
+    newSessionState.readOnly = new ReadOnlyState(this.readOnly);
+    newSessionState.catalog = new CatalogState(this.catalog);
+    newSessionState.schema = new SchemaState(this.schema);
+    newSessionState.transactionIsolation = new TransactionIsolationState(this.transactionIsolation);
 
     return newSessionState;
   }