Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: custom endpoint plugin #369

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: custom endpoint plugin #369

wants to merge 1 commit into from

Conversation

crystall-bitquill
Copy link
Contributor

@crystall-bitquill crystall-bitquill commented Jan 14, 2025 •
edited
Loading

Summary

Custom Endpoint Plugin

Description

  • Adds the custom endpoint plugin
  • Implements setAvailability in PluginService
  • Moves getRegion in the IamAuthUtils to RegionUtils
  • Fixes the MySQL database dialect getHostRole method - previously the query result was not being parsed correctly

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@crystall-bitquill crystall-bitquill added the ready for review Pull requests that are ready to be reviewed label Jan 14, 2025
karenc-bq
karenc-bq reviewed Jan 15, 2025
View reviewed changes
tests/integration/container/tests/custom_endpoint.test.ts
afterEach(async () => {
if (client !== null) {
try {
await client.end();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to clear the cache each test run via PluginManager.releaseResources()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, releaseResources is called below this line

@crystall-bitquill crystall-bitquill force-pushed the feat/custom-endpoints branch 6 times, most recently from cc6f3be to 33a53d9 Compare January 24, 2025 00:43
sophia-bq
sophia-bq reviewed Jan 24, 2025
View reviewed changes
tests/integration/container/tests/read_write_splitting.test.ts
@@ -104,6 +104,7 @@ describe("aurora read write splitting", () => {
await TestEnvironment.verifyClusterStatus();
await TestEnvironment.verifyAllInstancesHasRightState("available");
await TestEnvironment.verifyAllInstancesUp();
await PluginManager.releaseResources();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resources are already being released in afterEach - what is needing to be cleaned up here?

tests/integration/container/tests/utils/aurora_test_utility.ts
@@ -135,7 +134,11 @@ export class AuroraTestUtility {
return clusters[0];
}

async failoverClusterAndWaitUntilWriterChanged(initialWriter?: string, clusterId?: string) {
async failoverClusterToATargetAndWaitUntilWriterChanged(clusterId: string, initialWriterId: string, targetWriterId: string): Promise<void> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can just directly call this.failoverClusterAndWaitUntilWriterChanged instead of using this method.

tests/integration/container/tests/utils/aurora_test_utility.ts
@@ -148,7 +151,11 @@ export class AuroraTestUtility {
const clusterEndpoint = databaseInfo.clusterEndpoint;
const initialClusterAddress = await dns.promises.lookup(clusterEndpoint);

await this.failoverCluster(clusterId);
if (targetWriterId) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can pass targetWriterId directly to failoverClusterToTarget as it checks for it there

tests/integration/container/tests/utils/aurora_test_utility.ts
@@ -157,7 +164,11 @@ export class AuroraTestUtility {
throw new Error("failover request unsuccessful");
}

await this.failoverCluster(clusterId);
if (targetWriterId) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above

tests/unit/reader_failover_handler.test.ts
@@ -56,6 +56,7 @@ describe("reader failover handler", () => {
const currentHostIndex = 2;
const successHostIndex = 3;

when(mockPluginService.getAllHosts()).thenReturn(hosts);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can remove the line for getHosts from this file too

docs/using-the-nodejs-wrapper/using-plugins/UsingTheCustomEndpointPlugin.md
@@ -0,0 +1,28 @@
# Custom Endpoint Plugin

The Custom Endpoint Plugin adds support for RDS custom endpoints. When the Custom Endpoint Plugin is in use, the driver will analyse custom endpoint information to ensure instances used in connections are part of the custom endpoint being used. This includes connections used in failover and read-write splitting.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Custom Endpoint Plugin adds support for RDS custom endpoints. When the Custom Endpoint Plugin is in use, the driver will analyse custom endpoint information to ensure instances used in connections are part of the custom endpoint being used. This includes connections used in failover and read-write splitting.
The Custom Endpoint Plugin adds support for [RDS custom endpoints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Custom.html). When the Custom Endpoint Plugin is in use, the driver will analyse custom endpoint information to ensure instances used in connections are part of the custom endpoint being used. This includes connections used in failover and read-write splitting.
Suggested change
The Custom Endpoint Plugin adds support for RDS custom endpoints. When the Custom Endpoint Plugin is in use, the driver will analyse custom endpoint information to ensure instances used in connections are part of the custom endpoint being used. This includes connections used in failover and read-write splitting.
The Custom Endpoint Plugin adds support for RDS custom endpoints. When the Custom Endpoint Plugin is in use, the driver will analyse custom endpoint information to ensure instances used in connections are part of the custom endpoint being used. This includes connections used in failover and read-write splitting.

common/lib/plugins/custom_endpoint/custom_endpoint_plugin.ts

export class CustomEndpointPlugin extends AbstractConnectionPlugin implements CanReleaseResources {
private static readonly TELEMETRY_WAIT_FOR_INFO_COUNTER = "customEndpoint.waitForInfo.counter";
private static SUBSCRIBED_METHODS: Set<string> = new Set<string>(["connect", "forceConnect"].concat(SubscribedMethodHelper.NETWORK_BOUND_METHODS));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
private static SUBSCRIBED_METHODS: Set<string> = new Set<string>(["connect", "forceConnect"].concat(SubscribedMethodHelper.NETWORK_BOUND_METHODS));
private static SUBSCRIBED_METHODS: Set<string> = new Set<string>(SubscribedMethodHelper.NETWORK_BOUND_METHODS);

common/lib/plugins/custom_endpoint/custom_endpoint_plugin.ts
static closeMonitors() {
logger.info(Messages.get("CustomEndpointPlugin.closeMonitors"));
// The clear call automatically calls close() on all monitors.
CustomEndpointPlugin.monitors.clear();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does monitors need similar handling such as a for loop through each monitor as releaseResources in MonitorService?

common/lib/plugins/custom_endpoint/custom_endpoint_plugin.ts
}

createMonitorIfAbsent(props: Map<string, any>): CustomEndpointMonitor {
return CustomEndpointPlugin.monitors.computeIfAbsent(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should check if there is already a monitor for this host before calling new CustomEndpointMonitorImpl - in the constructor it has a call to run and this might leave some hanging resources if a monitor already exists

common/lib/plugins/custom_endpoint/custom_endpoint_monitor_impl.ts
return CustomEndpointMonitorImpl.customEndpointInfoCache.get(this.customEndpointHostInfo.host) != null;
}

shouldDispose(): boolean {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could instead just return true in the initialization of the monitors in custom_endpoint_plugin

sophia-bq
sophia-bq reviewed Jan 24, 2025
View reviewed changes
tests/integration/container/tests/custom_endpoint.test.ts
);

itIf(
"test custom endpoint read write splitting with custom endpoint changes",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if this should be separated into two tests, one with a single host and one with multiple?

tests/integration/container/tests/custom_endpoint.test.ts
port: port,
plugins: "customEndpoint,readWriteSplitting,failover",
failoverTimeoutMs: 250000,
failoverMode: "reader-or-writer",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to also test another failoverMode?

tests/unit/plugin_service.test.ts
it("test get hosts - allowed hosts empty", async () => {
pluginService.setHosts(allHosts);
const allowedHosts = new Set<string>();
const blockedHosts = new Set<string>(["host-3", "host-4"]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: change blockedHosts here to at least have one different outcome in your tests.

Suggested change
const blockedHosts = new Set<string>(["host-3", "host-4"]);
const blockedHosts = new Set<string>(["host-1", "host-2"]);

tests/unit/custom_endpoint_monitor_impl.test.ts
expect(captureResult[0].getBlockedHostIds()).toBeNull();

// Wait for monitor to close
await sleep(100);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to incorporate this necessary waiting into monitor.close()I think we already have some time waiting set there?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sophia-bq sophia-bq sophia-bq left review comments

@karenc-bq karenc-bq karenc-bq left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ready for review Pull requests that are ready to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@crystall-bitquill @karenc-bq @sophia-bq