chore: separate connection abortion methods (#248)

aws · Oct 21, 2024 · ac33089 · ac33089
1 parent 48e3cf4
commit ac33089
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 14 deletions.
diff --git a/common/lib/plugin_service.ts b/common/lib/plugin_service.ts
@@ -389,18 +389,16 @@ export class PluginService implements ErrorHandler, HostListProviderService {
     return await this.getDialect().isClientValid(targetClient);
   }
 
-  async tryClosingTargetClient(): Promise<void>;
-  async tryClosingTargetClient(targetClient: ClientWrapper): Promise<void>;
-  async tryClosingTargetClient(targetClient?: ClientWrapper): Promise<void>;
-  async tryClosingTargetClient(targetClient?: ClientWrapper | undefined): Promise<void> {
-    // Note: This last overload is only required because of the way typescript overloads work https://www.typescriptlang.org/docs/handbook/functions.html#overloads
-    if (targetClient) {
-      await this.getDialect().tryClosingTargetClient(targetClient);
-    } else if (this._currentClient.targetClient) {
+  async abortCurrentClient(): Promise<void> {
+    if (this._currentClient.targetClient) {
       await this.getDialect().tryClosingTargetClient(this._currentClient.targetClient);
     }
   }
 
+  async tryClosingTargetClient(targetClient: ClientWrapper): Promise<void> {
+    await this.getDialect().tryClosingTargetClient(targetClient);
+  }
+
   getSessionStateService() {
     return this.sessionStateService;
   }

diff --git a/common/lib/plugins/failover/failover_plugin.ts b/common/lib/plugins/failover/failover_plugin.ts
@@ -352,7 +352,7 @@ export class FailoverPlugin extends AbstractConnectionPlugin {
     }
 
     this.pluginService.getCurrentHostInfo()?.removeAlias(Array.from(oldAliases));
-    await this.pluginService.tryClosingTargetClient();
+    await this.pluginService.abortCurrentClient();
     await this.pluginService.setCurrentClient(result.client, result.newHost);
     await this.updateTopology(true);
   }
@@ -379,7 +379,7 @@ export class FailoverPlugin extends AbstractConnectionPlugin {
       throw new AwsWrapperError();
     }
 
-    await this.pluginService.tryClosingTargetClient();
+    await this.pluginService.abortCurrentClient();
     await this.pluginService.setCurrentClient(result.client, writerHostInfo);
     logger.debug(Messages.get("Failover.establishedConnection", this.pluginService.getCurrentHostInfo()?.host ?? ""));
     await this.pluginService.refreshHostList();
@@ -403,7 +403,7 @@ export class FailoverPlugin extends AbstractConnectionPlugin {
     try {
       const isValid = await client.isValid();
       if (!isValid) {
-        await this.pluginService.tryClosingTargetClient();
+        await this.pluginService.abortCurrentClient();
       }
     } catch (error) {
       // swallow this error, current target client should be useless anyway.

diff --git a/tests/unit/failover_plugin.test.ts b/tests/unit/failover_plugin.test.ts
@@ -84,7 +84,7 @@ describe("reader failover handler", () => {
     when(mockRdsHostListProvider.getRdsUrlType()).thenReturn(RdsUrlType.RDS_WRITER_CLUSTER);
     when(mockPluginService.getHostListProvider()).thenReturn(instance(mockRdsHostListProvider));
     when(mockPluginService.getCurrentClient()).thenReturn(instance(mockAwsClient));
-    when(mockPluginService.tryClosingTargetClient()).thenResolve();
+    when(mockPluginService.abortCurrentClient()).thenResolve();
     properties.clear();
   });
 
@@ -399,11 +399,11 @@ describe("reader failover handler", () => {
 
     await plugin.invalidateCurrentClient();
 
-    when(mockPluginService.tryClosingTargetClient()).thenThrow(new Error("test"));
+    when(mockPluginService.abortCurrentClient()).thenThrow(new Error("test"));
 
     await plugin.invalidateCurrentClient();
 
-    verify(mockPluginService.tryClosingTargetClient()).twice();
+    verify(mockPluginService.abortCurrentClient()).twice();
   });
 
   it("test execute", async () => {