Improvement/osis 145 disable get usage api #139
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anurag4DSB
force-pushed
the
improvement/OSIS-145-disable-get-usage-API
branch
from
90bc170
to
cc383dc
Compare
anurag4DSB
commented
Jan 9, 2024
Comment on lines
32
to
20
| // HttpURLConnection connection = null; | ||
| // try { | ||
| // // check if Utapi Endpoint is reachable | ||
| // connection = (HttpURLConnection) new java.net.URL(appEnv.getUtapiEndpoint()).openConnection(); | ||
| // connection.setConnectTimeout(appEnv.getUtapiHealthCheckTimeout()); | ||
| // connection.connect(); | ||
| // } catch (SocketTimeoutException e) { | ||
| // logger.warn("Failed to connect to Utapi endpoint {} in timeout {}",appEnv.getUtapiEndpoint(), appEnv.getUtapiHealthCheckTimeout()); | ||
| // return Health.down() | ||
| // .withDetail("error", e.getMessage()) | ||
| // .build(); | ||
| // } catch (IOException e) { | ||
| // logger.warn("an I/O error occurs while trying to connect {}.",appEnv.getUtapiEndpoint()); | ||
| // return Health.down() | ||
| // .withDetail("error", e.getMessage()) | ||
| // .build(); | ||
| // } finally { | ||
| // if (connection != null) { | ||
| // connection.disconnect(); | ||
| // } | ||
| // } | ||
| return Health.down().build(); |
There was a problem hiding this comment.
This will be refactored in the future as there are some edge cases where not setting the right configuration causes unexpected issues. Hence even if this is not callable as we commented code below, we have commented this code.
There was a problem hiding this comment.
Can we just delete it, as it stays in the git history forever?
williamlardier
approved these changes
Jan 9, 2024
Comment on lines
32
to
20
| // HttpURLConnection connection = null; | ||
| // try { | ||
| // // check if Utapi Endpoint is reachable | ||
| // connection = (HttpURLConnection) new java.net.URL(appEnv.getUtapiEndpoint()).openConnection(); | ||
| // connection.setConnectTimeout(appEnv.getUtapiHealthCheckTimeout()); | ||
| // connection.connect(); | ||
| // } catch (SocketTimeoutException e) { | ||
| // logger.warn("Failed to connect to Utapi endpoint {} in timeout {}",appEnv.getUtapiEndpoint(), appEnv.getUtapiHealthCheckTimeout()); | ||
| // return Health.down() | ||
| // .withDetail("error", e.getMessage()) | ||
| // .build(); | ||
| // } catch (IOException e) { | ||
| // logger.warn("an I/O error occurs while trying to connect {}.",appEnv.getUtapiEndpoint()); | ||
| // return Health.down() | ||
| // .withDetail("error", e.getMessage()) | ||
| // .build(); | ||
| // } finally { | ||
| // if (connection != null) { | ||
| // connection.disconnect(); | ||
| // } | ||
| // } | ||
| return Health.down().build(); |
There was a problem hiding this comment.
Can we just delete it, as it stays in the git history forever?
| @@ -1 +1 @@ | |||
| * @scality/object-lead @XinLiScality | |||
There was a problem hiding this comment.
😢
Suggested change
| * @scality/object-lead @XinLiScality | |
| * @scality/object-lead @XinLiScality |
build.gradle
Outdated
There was a problem hiding this comment.
should the commit message say 2.2.2?
There was a problem hiding this comment.
yes it should, I will amend it.
anurag4DSB
force-pushed
the
improvement/OSIS-145-disable-get-usage-API
branch
from
cc383dc
to
2932e33
Compare
|
@williamlardierI removed the commented code in intermediate fix up commit 319f6e4 |
nicolas2bert
approved these changes
Jan 10, 2024
GetUsage API is disabled to unblock RING v9.3 release.
Removed Xin as she is not a part of Scality and changed lead group to object. We still have branch protection rules in place for main branch. This rule does not allow any merges without 2 approvals.
anurag4DSB
force-pushed
the
improvement/OSIS-145-disable-get-usage-API
branch
from
2932e33
to
55c9125
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary: Modification of
getUsageAPI BehaviorChanges Introduced:
getUsageAPI to consistently return aNotImplementedstatus, regardless of UTAPI enablement. This ensures uniformity in API responses and decouples the behavior from UTAPI's operational state.Implications:
Federation Impact:
Code and Output Samples:
getUsageAPI now returns the following output:getInfoAPI'snot_implementedlist now includesgetUsage:Generated by Copilot:
This pull request includes various changes to different files in the codebase. The most important changes are as follows:
osis-app/src/main/java/com/scality/osis/healthcheck/UtapiHealthIndicator.java: Modified the health check for the Utapi endpoint in theUtapiHealthIndicatorclass to always return "down" regardless of the actual health of the endpoint.osis-core/src/test/java/com/scality/osis/service/impl/ScalityOsisServiceMiscTests.java: Added a new test method, commented out and disabled existing test methods, and added the@Disabledannotation to disable all test methods temporarily.osis-core/src/main/java/com/scality/osis/model/ScalityOsisConstants.java: Added usage api to the not implemented listosis-app/src/main/java/com/scality/osis/resource/ScalityOsisController.java: Temporarily disabled thegetUsageAPI method in theScalityOsisControllerclass by annotating it with@NotImplementand replacing the implementation with aNotImplementedException. This change will be reverted in a future update in S3C-8266osis-core/src/main/java/com/scality/osis/service/impl/ScalityOsisServiceImpl.java: Commented out thegetOsisUsagemethod inScalityOsisServiceImpl.javaand replaced it with athrow new NotImplementedException();statement, rendering the method non-functional and always throwing an exception.