Skip to content

add connect exception handling to IAM plugin #456

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

Merged
karenc-bq merged 1 commit into from
May 21, 2023
Merged

add connect exception handling to IAM plugin #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 43 additions & 2 deletions wrapper/src/main/java/software/amazon/jdbc/plugin/IamAuthConnectionPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,9 @@ private Connection connectInternal(String driverProtocol, HostSpec hostSpec, Pro
port,
region);
final TokenInfo tokenInfo = tokenCache.get(cacheKey);
final boolean isCachedToken = tokenInfo != null && !tokenInfo.isExpired();

if (tokenInfo != null && !tokenInfo.isExpired()) {
if (isCachedToken) {
LOGGER.finest(
() -> Messages.get(
"IamAuthConnectionPlugin.useCachedIamToken",
Expand All @@ -154,7 +155,47 @@ private Connection connectInternal(String driverProtocol, HostSpec hostSpec, Pro
cacheKey,
new TokenInfo(token, Instant.now().plus(tokenExpirationSec, ChronoUnit.SECONDS)));
}
return connectFunc.call();

try {
return connectFunc.call();
} catch (final SQLException exception) {

LOGGER.finest(
Copy link
Contributor

@aaronchung-bitquill aaronchung-bitquill May 19, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Nitpick: Would it also be worth logging the token as well? Or not necessary?

() -> Messages.get(
"IamAuthConnectionPlugin.connectException",
new Object[] {exception}));

if (!this.pluginService.isLoginException(exception) || !isCachedToken) {
throw exception;
Comment on lines +168 to +169
Copy link
Contributor

@karenc-bq karenc-bq May 20, 2023

Choose a reason for hiding this comment

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

Agreed with Aaron, can we log the token and isCachedToken if it is a login exception. Would be beneficial for debugging purposes

}

// Login unsuccessful with cached token
// Try to generate a new token and try to connect again

final String token = generateAuthenticationToken(
hostSpec,
props,
host,
port,
region);
LOGGER.finest(
() -> Messages.get(
"IamAuthConnectionPlugin.generatedNewIamToken",
new Object[] {token}));
PropertyDefinition.PASSWORD.set(props, token);
tokenCache.put(
cacheKey,
new TokenInfo(token, Instant.now().plus(tokenExpirationSec, ChronoUnit.SECONDS)));

return connectFunc.call();

} catch (final Exception exception) {
LOGGER.warning(
() -> Messages.get(
"IamAuthConnectionPlugin.unhandledException",
new Object[] {exception}));
throw new SQLException(exception);
}
}

@Override
Expand Down
2 changes: 2 additions & 0 deletions wrapper/src/main/resources/messages.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ IamAuthConnectionPlugin.unsupportedHostname=Unsupported AWS hostname {0}. Amazon
IamAuthConnectionPlugin.useCachedIamToken=Use cached IAM token = ''{0}''
IamAuthConnectionPlugin.generatedNewIamToken=Generated new IAM token = ''{0}''
IamAuthConnectionPlugin.invalidPort=Port number: {0} is not valid. Port number should be greater than zero.
IamAuthConnectionPlugin.unhandledException=Unhandled exception: ''{0}''
IamAuthConnectionPlugin.connectException=Error occurred while opening a connection: ''{0}''

# Log Query Connection Plugin
LogQueryConnectionPlugin.executingQuery=[{0}] Executing query: {1}
Expand Down