Skip to content

Commit a6f20c3

Browse files
karenc-bqkarenc-bq
committed
chore: separate database dialect and driver dialect
1 parent 737571e commit a6f20c3

29 files changed

+299
-207
lines changed

‎.eslintrc.json

+6-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@
2121
"@typescript-eslint/no-explicit-any": "off",
2222
"@typescript-eslint/no-unused-vars": "off",
2323
"@typescript-eslint/ban-ts-comment": "off",
24-
"prettier/prettier": 2,
24+
"prettier/prettier": [
25+
"error",
26+
{
27+
"endOfLine": "auto"
28+
}
29+
],
2530
"header/header": [
2631
1,
2732
"block",

‎common/lib/aws_client.ts

+4-7
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { ClientWrapper } from "./client_wrapper";
2727
import { ConnectionProviderManager } from "./connection_provider_manager";
2828
import { DefaultTelemetryFactory } from "./utils/telemetry/default_telemetry_factory";
2929
import { TelemetryFactory } from "./utils/telemetry/telemetry_factory";
30+
import { DriverDialect } from "./driver_dialect/driver_dialect";
3031

3132
export abstract class AwsClient extends EventEmitter {
3233
private _defaultPort: number = -1;
@@ -40,7 +41,6 @@ export abstract class AwsClient extends EventEmitter {
4041
protected _schema: string = "";
4142
protected _isolationLevel: number = 0;
4243
protected _errorHandler: ErrorHandler;
43-
protected _createClientFunc?: (config: any) => any;
4444
protected _connectionUrlParser: ConnectionUrlParser;
4545
readonly properties: Map<string, any>;
4646
config: any;
@@ -51,7 +51,8 @@ export abstract class AwsClient extends EventEmitter {
5151
errorHandler: ErrorHandler,
5252
dbType: DatabaseType,
5353
knownDialectsByCode: Map<string, DatabaseDialect>,
54-
parser: ConnectionUrlParser
54+
parser: ConnectionUrlParser,
55+
driverDialect: DriverDialect
5556
) {
5657
super();
5758
this.config = config;
@@ -62,7 +63,7 @@ export abstract class AwsClient extends EventEmitter {
6263

6364
this.telemetryFactory = new DefaultTelemetryFactory(this.properties);
6465
const container = new PluginServiceManagerContainer();
65-
this.pluginService = new PluginService(container, this, dbType, knownDialectsByCode, this.properties);
66+
this.pluginService = new PluginService(container, this, dbType, knownDialectsByCode, this.properties, driverDialect);
6667
this.pluginManager = new PluginManager(
6768
container,
6869
this.properties,
@@ -111,10 +112,6 @@ export abstract class AwsClient extends EventEmitter {
111112
return this._connectionUrlParser;
112113
}
113114

114-
getCreateClientFunc<Type>(): ((config: any) => Type) | undefined {
115-
return this._createClientFunc;
116-
}
117-
118115
abstract updateSessionStateReadOnly(readOnly: boolean): Promise<any | void>;
119116

120117
abstract setReadOnly(readOnly: boolean): Promise<any | void>;

‎common/lib/database_dialect/database_dialect.ts

-6
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,7 @@ export interface DatabaseDialect {
3333
getServerVersionQuery(): string;
3434
getDialectUpdateCandidates(): string[];
3535
isDialect(targetClient: ClientWrapper): Promise<boolean>;
36-
getAwsPoolClient(props: any): AwsPoolClient;
3736
getHostListProvider(props: Map<string, any>, originalUrl: string, hostListProviderService: HostListProviderService): HostListProvider;
38-
tryClosingTargetClient(targetClient: ClientWrapper): Promise<void>;
39-
rollback(targetClient: ClientWrapper): Promise<any>;
4037
isClientValid(targetClient: ClientWrapper): Promise<boolean>;
4138
getDatabaseType(): DatabaseType;
4239
getDialectName(): string;
@@ -46,7 +43,4 @@ export interface DatabaseDialect {
4643
doesStatementSetAutoCommit(statement: string): boolean | undefined;
4744
doesStatementSetSchema(statement: string): string | undefined;
4845
doesStatementSetCatalog(statement: string): string | undefined;
49-
connect(targetClient: any): Promise<any>;
50-
end(clientWrapper: ClientWrapper | undefined): Promise<void>;
51-
preparePoolClientProperties(props: Map<string, any>, poolConfig: AwsPoolConfig | undefined): any;
5246
}

‎common/lib/driver_connection_provider.ts

+5-7
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import { logger } from "../logutils";
3131
import { maskProperties } from "./utils/utils";
3232
import { ClientWrapper } from "./client_wrapper";
3333
import { RoundRobinHostSelector } from "./round_robin_host_selector";
34-
import { DatabaseDialect } from "./database_dialect/database_dialect";
34+
import { DriverDialect } from "./driver_dialect/driver_dialect";
3535

3636
export class DriverConnectionProvider implements ConnectionProvider {
3737
private static readonly acceptedStrategies: Map<string, HostSelector> = new Map([
@@ -53,9 +53,9 @@ export class DriverConnectionProvider implements ConnectionProvider {
5353
const resultProps = new Map(props);
5454
let connectionHostInfo: HostInfo;
5555

56+
const driverDialect: DriverDialect = pluginService.getDriverDialect();
5657
try {
57-
const targetClient: any = await Promise.resolve(pluginService.createTargetClient(props));
58-
await pluginService.getDialect().connect(targetClient);
58+
const targetClient: any = await driverDialect.connect(props);
5959
connectionHostInfo = new HostInfoBuilder({
6060
hostAvailabilityStrategy: hostInfo.hostAvailabilityStrategy
6161
})
@@ -108,9 +108,7 @@ export class DriverConnectionProvider implements ConnectionProvider {
108108
JSON.stringify(Object.fromEntries(maskProperties(resultProps)))
109109
);
110110

111-
const newTargetClient = pluginService.createTargetClient(resultProps);
112-
await pluginService.getDialect().connect(newTargetClient);
113-
resultTargetClient = newTargetClient;
111+
resultTargetClient = driverDialect.connect(resultProps);
114112
}
115113

116114
return {
@@ -124,7 +122,7 @@ export class DriverConnectionProvider implements ConnectionProvider {
124122
if (clientWrapper === undefined) {
125123
return;
126124
}
127-
return await pluginService.getDialect().end(clientWrapper);
125+
return await pluginService.getDriverDialect().end(clientWrapper);
128126
}
129127

130128
getHostInfoByStrategy(hosts: HostInfo[], role: HostRole, strategy: string, props?: Map<string, any>): HostInfo {

‎common/lib/driver_dialect/driver_dialect.ts

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License").
5+
You may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
import { ClientWrapper } from "../client_wrapper";
18+
import { AwsPoolConfig } from "../aws_pool_config";
19+
import { AwsPoolClient } from "../aws_pool_client";
20+
21+
export interface DriverDialect {
22+
getDialectName(): string;
23+
abort(targetClient: ClientWrapper): Promise<void>;
24+
rollback(targetClient: ClientWrapper): Promise<any>;
25+
connect(props: Map<string, any>): Promise<any>;
26+
end(targetClient: ClientWrapper | undefined): Promise<void>;
27+
preparePoolClientProperties(props: Map<string, any>, poolConfig: AwsPoolConfig | undefined): any;
28+
getAwsPoolClient(props: any): AwsPoolClient;
29+
}

‎common/lib/internal_pooled_connection_provider.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export class InternalPooledConnectionProvider implements PooledConnectionProvide
104104
}
105105
}
106106

107-
const dialect = pluginService.getDialect();
107+
const dialect = pluginService.getDriverDialect();
108108
const preparedConfig = dialect.preparePoolClientProperties(props, this._poolConfig);
109109

110110
this.internalPool = this.databasePools.computeIfAbsent(

‎common/lib/plugin_service.ts

+17-15
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ import { DatabaseDialectCodes } from "./database_dialect/database_dialect_codes"
4343
import { getWriter } from "./utils/utils";
4444
import { ConnectionProvider } from "./connection_provider";
4545
import { TelemetryFactory } from "./utils/telemetry/telemetry_factory";
46+
import { DriverDialect } from "./driver_dialect/driver_dialect";
4647

4748
export class PluginService implements ErrorHandler, HostListProviderService {
4849
private readonly _currentClient: AwsClient;
@@ -55,6 +56,7 @@ export class PluginService implements ErrorHandler, HostListProviderService {
5556
private dbDialectProvider: DatabaseDialectProvider;
5657
private readonly initialHost: string;
5758
private dialect: DatabaseDialect;
59+
private readonly driverDialect: DriverDialect;
5860
protected readonly sessionStateService: SessionStateService;
5961
protected static readonly hostAvailabilityExpiringCache: CacheMap<string, HostAvailability> = new CacheMap<string, HostAvailability>();
6062
readonly props: Map<string, any>;
@@ -64,12 +66,14 @@ export class PluginService implements ErrorHandler, HostListProviderService {
6466
client: AwsClient,
6567
dbType: DatabaseType,
6668
knownDialectsByCode: Map<DatabaseDialectCodes, DatabaseDialect>,
67-
props: Map<string, any>
69+
props: Map<string, any>,
70+
driverDialect: DriverDialect
6871
) {
6972
this._currentClient = client;
7073
this.pluginServiceManagerContainer = container;
7174
this.props = props;
7275
this.dbDialectProvider = new DatabaseDialectManager(knownDialectsByCode, dbType, this.props);
76+
this.driverDialect = driverDialect;
7377
this.initialHost = props.get(WrapperProperties.HOST.name);
7478
this.sessionStateService = new SessionStateServiceImpl(this, this.props);
7579
container.pluginService = this;
@@ -158,6 +162,10 @@ export class PluginService implements ErrorHandler, HostListProviderService {
158162
return this.dialect;
159163
}
160164

165+
getDriverDialect(): DriverDialect {
166+
return this.driverDialect;
167+
}
168+
161169
getHostInfoBuilder(): HostInfoBuilder {
162170
return new HostInfoBuilder({ hostAvailabilityStrategy: new HostAvailabilityStrategyFactory().create(this.props) });
163171
}
@@ -310,14 +318,6 @@ export class PluginService implements ErrorHandler, HostListProviderService {
310318
return provider.identifyConnection(targetClient, this.dialect);
311319
}
312320

313-
createTargetClient(props: Map<string, any>): any {
314-
const createClientFunc = this.getCurrentClient().getCreateClientFunc();
315-
if (createClientFunc) {
316-
return createClientFunc(props);
317-
}
318-
throw new AwsWrapperError("AwsClient is missing create target client function."); // This should not be reached
319-
}
320-
321321
connect(hostInfo: HostInfo, props: Map<string, any>): Promise<ClientWrapper> {
322322
return this.pluginServiceManagerContainer.pluginManager!.connect(hostInfo, props, false);
323323
}
@@ -356,7 +356,7 @@ export class PluginService implements ErrorHandler, HostListProviderService {
356356

357357
if (oldClient && (isInTransaction || WrapperProperties.ROLLBACK_ON_SWITCH.get(this.props))) {
358358
try {
359-
await this.getDialect().rollback(oldClient);
359+
await this.getDriverDialect().rollback(oldClient);
360360
} catch (error: any) {
361361
// Ignore.
362362
}
@@ -379,7 +379,7 @@ export class PluginService implements ErrorHandler, HostListProviderService {
379379
}
380380

381381
try {
382-
await this.tryClosingTargetClient(oldClient);
382+
await this.abortTargetClient(oldClient);
383383
} catch (error: any) {
384384
// Ignore.
385385
}
@@ -400,12 +400,14 @@ export class PluginService implements ErrorHandler, HostListProviderService {
400400

401401
async abortCurrentClient(): Promise<void> {
402402
if (this._currentClient.targetClient) {
403-
await this.getDialect().tryClosingTargetClient(this._currentClient.targetClient);
403+
await this.getDriverDialect().abort(this._currentClient.targetClient);
404404
}
405405
}
406406

407-
async tryClosingTargetClient(targetClient: ClientWrapper): Promise<void> {
408-
await this.getDialect().tryClosingTargetClient(targetClient);
407+
async abortTargetClient(targetClient: ClientWrapper | undefined): Promise<void> {
408+
if (targetClient) {
409+
await this.getDriverDialect().abort(targetClient);
410+
}
409411
}
410412

411413
getSessionStateService() {
@@ -482,7 +484,7 @@ export class PluginService implements ErrorHandler, HostListProviderService {
482484
}
483485

484486
async rollback(targetClient: ClientWrapper) {
485-
return await this.getDialect().rollback(targetClient);
487+
return await this.getDriverDialect().rollback(targetClient);
486488
}
487489

488490
getTelemetryFactory(): TelemetryFactory {

‎common/lib/plugins/aurora_initial_connection_strategy_plugin.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export class AuroraInitialConnectionStrategyPlugin extends AbstractConnectionPlu
137137
if (writerCandidate) {
138138
if (writerCandidate.role !== HostRole.WRITER) {
139139
// Shouldn't be here. But let's try again.
140-
await this.pluginService.tryClosingTargetClient(writerCandidateClient);
140+
await this.pluginService.abortTargetClient(writerCandidateClient);
141141
await sleep(retryDelayMs);
142142
continue;
143143
}
@@ -154,7 +154,7 @@ export class AuroraInitialConnectionStrategyPlugin extends AbstractConnectionPlu
154154
// If the new connection resolves to a reader instance, this means the topology is outdated.
155155
// Force refresh to update the topology.
156156
await this.pluginService.forceRefreshHostList(writerCandidateClient);
157-
await this.pluginService.tryClosingTargetClient(writerCandidateClient);
157+
await this.pluginService.abortTargetClient(writerCandidateClient);
158158
await sleep(retryDelayMs);
159159
continue;
160160
}
@@ -165,7 +165,7 @@ export class AuroraInitialConnectionStrategyPlugin extends AbstractConnectionPlu
165165
}
166166
return writerCandidateClient;
167167
} catch (error: any) {
168-
await this.pluginService.tryClosingTargetClient(writerCandidateClient);
168+
await this.pluginService.abortTargetClient(writerCandidateClient);
169169
if (this.pluginService.isLoginError(error) || !writerCandidate) {
170170
throw error;
171171
} else if (writerCandidate) {
@@ -211,7 +211,7 @@ export class AuroraInitialConnectionStrategyPlugin extends AbstractConnectionPlu
211211
}
212212
return readerCandidateClient;
213213
}
214-
await this.pluginService.tryClosingTargetClient(readerCandidateClient);
214+
await this.pluginService.abortTargetClient(readerCandidateClient);
215215
await sleep(retryDelayMs);
216216
continue;
217217
}
@@ -240,7 +240,7 @@ export class AuroraInitialConnectionStrategyPlugin extends AbstractConnectionPlu
240240
}
241241
return readerCandidateClient;
242242
}
243-
await this.pluginService.tryClosingTargetClient(readerCandidateClient);
243+
await this.pluginService.abortTargetClient(readerCandidateClient);
244244
await sleep(retryDelayMs);
245245
continue;
246246
}
@@ -250,7 +250,7 @@ export class AuroraInitialConnectionStrategyPlugin extends AbstractConnectionPlu
250250
}
251251
return readerCandidateClient;
252252
} catch (error: any) {
253-
await this.pluginService.tryClosingTargetClient(readerCandidateClient);
253+
await this.pluginService.abortTargetClient(readerCandidateClient);
254254
if (this.pluginService.isLoginError(error) || !readerCandidate) {
255255
throw error;
256256
} else if (readerCandidate) {

‎common/lib/plugins/connection_tracker/opened_connection_tracker.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export class OpenedConnectionTracker {
104104
if (!client) {
105105
continue;
106106
}
107-
await this.pluginService.tryClosingTargetClient(client);
107+
await this.pluginService.abortTargetClient(client);
108108
}
109109
}
110110

‎common/lib/plugins/default_plugin.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export class DefaultPlugin extends AbstractConnectionPlugin {
7676
private async connectInternal(hostInfo: HostInfo, props: Map<string, any>, connProvider: ConnectionProvider): Promise<ClientWrapper> {
7777
const telemetryFactory = this.pluginService.getTelemetryFactory();
7878
const telemetryContext = telemetryFactory.openTelemetryContext(
79-
`${this.pluginService.getDialect().getDialectName()} - connect`,
79+
`${this.pluginService.getDriverDialect().getDialectName()} - connect`,
8080
TelemetryTraceLevel.NESTED
8181
);
8282

@@ -91,7 +91,7 @@ export class DefaultPlugin extends AbstractConnectionPlugin {
9191

9292
const telemetryFactory = this.pluginService.getTelemetryFactory();
9393
const telemetryContext = telemetryFactory.openTelemetryContext(
94-
`${this.pluginService.getDialect().getDialectName()} - ${methodName}`,
94+
`${this.pluginService.getDriverDialect().getDialectName()} - ${methodName}`,
9595
TelemetryTraceLevel.NESTED
9696
);
9797

‎common/lib/plugins/efm/host_monitoring_connection_plugin.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export class HostMonitoringConnectionPlugin extends AbstractConnectionPlugin imp
137137

138138
if (!targetClient || !isClientValid) {
139139
if (targetClient) {
140-
await this.pluginService.tryClosingTargetClient(targetClient);
140+
await this.pluginService.abortTargetClient(targetClient);
141141
}
142142
// eslint-disable-next-line no-unsafe-finally
143143
throw new AwsWrapperError(Messages.get("HostMonitoringConnectionPlugin.unavailableHost", monitoringHostInfo.host));

‎common/lib/plugins/efm/monitor.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ export class MonitorImpl implements Monitor {
287287

288288
async endMonitoringClient() {
289289
if (this.monitoringClient) {
290-
await this.pluginService.tryClosingTargetClient(this.monitoringClient);
290+
await this.pluginService.abortTargetClient(this.monitoringClient);
291291
this.monitoringClient = null;
292292
}
293293
}

‎common/lib/plugins/efm/monitor_connection_context.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export class MonitorConnectionContext {
7474
}
7575

7676
try {
77-
await this.pluginService.tryClosingTargetClient(this.clientToAbort);
77+
await this.pluginService.abortTargetClient(this.clientToAbort);
7878
this.telemetryAbortedConnectionCounter.inc();
7979
} catch (error: any) {
8080
// ignore

‎common/lib/plugins/failover/reader_failover_handler.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export class ClusterAwareReaderFailoverHandler implements ReaderFailoverHandler
131131
// Need to continue this loop and to make another try to connect to a reader.
132132

133133
try {
134-
await this.pluginService.tryClosingTargetClient(result.client);
134+
await this.pluginService.abortTargetClient(result.client);
135135
} catch (error) {
136136
// ignore
137137
}
@@ -322,7 +322,7 @@ class ConnectionAttemptTask {
322322
this.taskHandler.setSelectedConnectionAttemptTask(this.failoverTaskId, this.taskId);
323323
return new ReaderFailoverResult(this.targetClient, this.newHost, true, undefined, this.taskId);
324324
}
325-
await this.pluginService.tryClosingTargetClient(this.targetClient);
325+
await this.pluginService.abortTargetClient(this.targetClient);
326326
return new ReaderFailoverResult(null, null, false, undefined, this.taskId);
327327
} catch (error) {
328328
this.pluginService.setAvailability(this.newHost.allAliases, HostAvailability.NOT_AVAILABLE);
@@ -342,7 +342,7 @@ class ConnectionAttemptTask {
342342

343343
async performFinalCleanup() {
344344
if (this.taskHandler.getSelectedConnectionAttemptTask(this.failoverTaskId) !== this.taskId) {
345-
await this.pluginService.tryClosingTargetClient(this.targetClient);
345+
await this.pluginService.abortTargetClient(this.targetClient);
346346
}
347347
}
348348
}

0 commit comments

Comments
 (0)