Skip to content

vjd-10 Retry logic refactoring #12

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
merged 2 commits into from
Oct 10, 2022
Merged

vjd-10 Retry logic refactoring #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98b5fb9
vjd-10 Retry logic refactoring
Oct 10, 2022
12e9a61
Merge branch 'master' into vjd-10
tledkov Oct 10, 2022
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
1,661 changes: 755 additions & 906 deletions src/main/java/io/github/jopenlibs/vault/api/Auth.java
View file
Open in desktop

Large diffs are not rendered by default.

147 changes: 78 additions & 69 deletions src/main/java/io/github/jopenlibs/vault/api/Debug.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@
import io.github.jopenlibs.vault.VaultException;
import io.github.jopenlibs.vault.response.HealthResponse;
import io.github.jopenlibs.vault.rest.Rest;
import io.github.jopenlibs.vault.rest.RestException;
import io.github.jopenlibs.vault.rest.RestResponse;
import java.util.HashSet;
import java.util.Set;


/**
* <p>The implementing class for operations on REST endpoints, under the "Debug" section of the Vault HTTP API
* <p>The implementing class for operations on REST endpoints, under the "Debug" section of the
* Vault HTTP API
* docs (https://www.vaultproject.io/docs/http/index.html).</p>
*
* <p>This class is not intended to be constructed directly. Rather, it is meant to used by way of
* <code>Vault</code> in a DSL-style builder pattern. See the Javadoc comments of each <code>public</code>
* <code>Vault</code> in a DSL-style builder pattern. See the Javadoc comments of each
* <code>public</code>
* method for usage examples.</p>
*/
public class Debug {

private final VaultConfig config;
public class Debug extends OperationsBase {

private String nameSpace;

public Debug(final VaultConfig config) {
this.config = config;
super(config);

if (this.config.getNameSpace() != null && !this.config.getNameSpace().isEmpty()) {
this.nameSpace = this.config.getNameSpace();
}
Expand All @@ -42,8 +42,10 @@ public Debug withNameSpace(final String nameSpace) {
* health check and provides a simple way to monitor the health of a Vault instance.</p>
*
* @return The response information returned from Vault
* @throws VaultException If any errors occurs with the REST request (e.g. non-200 status code, invalid JSON payload, etc), and the maximum number of retries is exceeded.
* @see <a href="https://www.vaultproject.io/docs/http/sys-health.html">https://www.vaultproject.io/docs/http/sys-health.html</a>
* @throws VaultException If any errors occurs with the REST request (e.g. non-200 status code,
* invalid JSON payload, etc), and the maximum number of retries is exceeded.
* @see <a
* href="https://www.vaultproject.io/docs/http/sys-health.html">https://www.vaultproject.io/docs/http/sys-health.html</a>
*
* <blockquote>
* <pre>{@code
Expand All @@ -61,19 +63,27 @@ public HealthResponse health() throws VaultException {
}

/**
* <p>An overloaded version of {@link Debug#health()} that allows for passing one or more optional parameters.</p>
* <p>An overloaded version of {@link Debug#health()} that allows for passing one or more
* optional parameters.</p>
*
* <p>WARNING: In testing, we've found that changing the default HTTP status codes can result in the operation
* succeeding, but returning an empty JSON payload in the response. For example, this seems to happen when you
* set <code>activeCode</code> to 204, but not for 212 (the regular default is 200). When this happens, the
* <code>HealthResponse</code> return object will have <code>null</code> values in most of its fields, and you
* will need to check <code>HealthReponse.getRestResponse().getStatus()</code> to determine the result of
* the operation.</p>
* <p>WARNING: In testing, we've found that changing the default HTTP status codes can result
* in the operation
* succeeding, but returning an empty JSON payload in the response. For example, this seems to
* happen when you set <code>activeCode</code> to 204, but not for 212 (the regular default is
* 200). When this happens, the
* <code>HealthResponse</code> return object will have <code>null</code> values in most of its
* fields, and you
* will need to check <code>HealthReponse.getRestResponse().getStatus()</code> to determine the
* result of the operation.</p>
*
* @param standbyOk (optional) Indicates that being a standby should still return the active status code instead of the standby code
* @param activeCode (optional) Indicates the status code that should be returned for an active node instead of the default of 200
* @param standbyCode (optional) Indicates the status code that should be returned for a standby node instead of the default of 429
* @param sealedCode (optional) Indicates the status code that should be returned for a sealed node instead of the default of 500
* @param standbyOk (optional) Indicates that being a standby should still return the active
* status code instead of the standby code
* @param activeCode (optional) Indicates the status code that should be returned for an active
* node instead of the default of 200
* @param standbyCode (optional) Indicates the status code that should be returned for a standby
* node instead of the default of 429
* @param sealedCode (optional) Indicates the status code that should be returned for a sealed
* node instead of the default of 500
* @return The response information returned from Vault
* @throws VaultException If an error occurs or unexpected response received from Vault
*/
Expand All @@ -84,56 +94,55 @@ public HealthResponse health(
final Integer sealedCode
) throws VaultException {
final String path = "sys/health";
int retryCount = 0;
while (true) {
try {
// Build an HTTP request for Vault
final Rest rest = new Rest()//NOPMD
.url(config.getAddress() + "/v1/" + path)
.header("X-Vault-Token", config.getToken())
.header("X-Vault-Namespace", this.nameSpace)
.connectTimeoutSeconds(config.getOpenTimeout())
.readTimeoutSeconds(config.getReadTimeout())
.sslVerification(config.getSslConfig().isVerify())
.sslContext(config.getSslConfig().getSslContext());
// Add params if present
if (standbyOk != null) rest.parameter("standbyok", standbyOk.toString());
if (activeCode != null) rest.parameter("activecode", activeCode.toString());
if (standbyCode != null) rest.parameter("standbycode", standbyCode.toString());
if (sealedCode != null) rest.parameter("sealedcode", sealedCode.toString());
// Execute request
final RestResponse restResponse = rest.get();

// Validate response
final Set<Integer> validCodes = new HashSet<>();//NOPMD
validCodes.add(200);
validCodes.add(429);
validCodes.add(500);
if (activeCode != null) validCodes.add(activeCode);
if (standbyCode != null) validCodes.add(standbyCode);
if (sealedCode != null) validCodes.add(sealedCode);
if (!validCodes.contains(restResponse.getStatus())) {
throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus(), restResponse.getStatus());
}
return new HealthResponse(restResponse, retryCount);
} catch (RuntimeException | VaultException | RestException e) {
// If there are retries to perform, then pause for the configured interval and then execute the loop again...
if (retryCount < config.getMaxRetries()) {
retryCount++;
try {
final int retryIntervalMilliseconds = config.getRetryIntervalMilliseconds();
Thread.sleep(retryIntervalMilliseconds);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
} else if (e instanceof VaultException) {
// ... otherwise, give up.
throw (VaultException) e;
} else {
throw new VaultException(e);
}
return retry(attempt -> {
// Build an HTTP request for Vault
final Rest rest = new Rest()//NOPMD
.url(config.getAddress() + "/v1/" + path)
.header("X-Vault-Token", config.getToken())
.header("X-Vault-Namespace", this.nameSpace)
.connectTimeoutSeconds(config.getOpenTimeout())
.readTimeoutSeconds(config.getReadTimeout())
.sslVerification(config.getSslConfig().isVerify())
.sslContext(config.getSslConfig().getSslContext());
// Add params if present
if (standbyOk != null) {
rest.parameter("standbyok", standbyOk.toString());
}
}
}
if (activeCode != null) {
rest.parameter("activecode", activeCode.toString());
}
if (standbyCode != null) {
rest.parameter("standbycode", standbyCode.toString());
}
if (sealedCode != null) {
rest.parameter("sealedcode", sealedCode.toString());
}
// Execute request
final RestResponse restResponse = rest.get();

// Validate response
final Set<Integer> validCodes = new HashSet<>();//NOPMD
validCodes.add(200);
validCodes.add(429);
validCodes.add(500);
if (activeCode != null) {
validCodes.add(activeCode);
}
if (standbyCode != null) {
validCodes.add(standbyCode);
}
if (sealedCode != null) {
validCodes.add(sealedCode);
}

if (!validCodes.contains(restResponse.getStatus())) {
throw new VaultException(
"Vault responded with HTTP status code: " + restResponse.getStatus(),
restResponse.getStatus());
}

return new HealthResponse(restResponse, attempt);
});
}
}
Loading