Merge pull request #72 from nicmunroe/feature/javax-to-jakarta-transi…

…tion

Backstopper 2.0 - Refactor code from javax ecosystem to jakarta, drop old modules, and pin to java 17

.codecov.yml

@@ -5,7 +5,7 @@ coverage:
     project:
       default:
         enabled: yes
-        target: 90%
+        target: 85%
     patch:
       default:
         enabled: yes

.github/workflows/build.yml

@@ -11,14 +11,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up JDK 11
-        uses: actions/setup-java@v2
+      - uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
         with:
-          java-version: 11
           distribution: 'temurin'
-      - name: Validate Gradle wrapper
-        uses: gradle/wrapper-validation-action@e6e38bacfdf1a337459f332974bb2327a31aaf4b
+          java-version: '17'
+          cache: 'gradle'
+      - name: Validate Gradle Wrapper Checksums
+        uses: gradle/actions/wrapper-validation@v3
       - name: Build with Gradle
         run: ./gradlew clean build
       - name: Upload coverage report to CodeCov
@@ -29,7 +30,7 @@ jobs:
           verbose: true
           token: ${{ secrets.CODECOV_TOKEN }}
       - name: Upload reports and test results to GitHub
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: reports-and-test-results
           path: |

backstopper-core/README.md

@@ -1,17 +1,28 @@
 # Backstopper - core
 
-Backstopper is a framework-agnostic API error handling and (optional) model validation solution for Java 7 and greater.
+Backstopper is a framework-agnostic API error handling and (optional) model validation solution for Java 17 and greater.
 
-This `backstopper-core` library contains the key core components necessary for a Backstopper system to work. The [base project README.md](../README.md) and [User Guide](../USER_GUIDE.md) contain the main bulk of information regarding Backstopper, but in particular:
-
-* [Backstopper key components](../USER_GUIDE.md#key_components) - This describes the main classes contained in this core library and what they are for. See the source code and javadocs on classes for further information.
-* [Framework-specific modules](../README.md#framework_modules) - The list of specific framework plugin libraries Backstopper currently has support for.
-* [Sample applications](../README.md#samples) - The list of sample applications demonstrating how to integrate and use Backstopper in the various supported frameworks.
-* [Creating new framework integrations](../USER_GUIDE.md#new_framework_integrations) - Information on how to create new framework integrations.
+(NOTE: The [Backstopper 1.x branch](https://github.com/Nike-Inc/backstopper/tree/v1.x) contains a version of
+Backstopper for Java 7+, and for the `javax` ecosystem. The current Backstopper supports Java 17+ and the `jakarta`
+ecosystem.)
+
+This `backstopper-core` library contains the key core components necessary for a Backstopper system to work.
+The [base project README.md](../README.md) and [User Guide](../USER_GUIDE.md) contain the main bulk of information
+regarding Backstopper, but in particular:
+
+* [Backstopper key components](../USER_GUIDE.md#key_components) - This describes the main classes contained in this core
+  library and what they are for. See the source code and javadocs on classes for further information.
+* [Framework-specific modules](../README.md#framework_modules) - The list of specific framework plugin libraries
+  Backstopper currently has support for.
+* [Sample applications](../README.md#samples) - The list of sample applications demonstrating how to integrate and use
+  Backstopper in the various supported frameworks.
+* [Creating new framework integrations](../USER_GUIDE.md#new_framework_integrations) - Information on how to create new
+  framework integrations.
 
 ## More Info
 
-See the [base project README.md](../README.md), [User Guide](../USER_GUIDE.md), and Backstopper repository source code and javadocs for all further information.
+See the [base project README.md](../README.md), [User Guide](../USER_GUIDE.md), and Backstopper repository source code
+and javadocs for all further information.
 
 ## License
 

backstopper-core/build.gradle

@@ -1,16 +1,11 @@
 evaluationDependsOn(':')
 
-compileTestJava {
-    sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
-}
-
 dependencies {
     api(
             project(":nike-internal-util"),
             "org.slf4j:slf4j-api:$slf4jVersion",
-            "javax.inject:javax.inject:$javaxInjectVersion",
-            "javax.validation:validation-api:$javaxValidationVersion"
+            "jakarta.inject:jakarta.inject-api:$jakartaInjectVersion",
+            "jakarta.validation:jakarta.validation-api:$jakartaValidationVersion"
     )
     compileOnly(
             "org.jetbrains:annotations:$jetbrainsAnnotationsVersion"
@@ -24,6 +19,5 @@ dependencies {
             "org.assertj:assertj-core:$assertJVersion",
             "com.tngtech.java:junit-dataprovider:$junitDataproviderVersion",
             "org.hamcrest:hamcrest-all:$hamcrestVersion",
-            "org.hibernate:hibernate-validator:$hibernateValidatorVersion"
     )
 }

backstopper-core/src/main/java/com/nike/backstopper/apierror/ApiErrorBase.java

@@ -3,7 +3,6 @@
 import com.nike.backstopper.util.ApiErrorUtil;
 
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -41,8 +40,8 @@ public ApiErrorBase(String name, String errorCode, String message, int httpStatu
         }
 
         this.metadata = (metadata.isEmpty())
-                        ? Collections.<String, Object>emptyMap()
-                        : Collections.unmodifiableMap(new HashMap<>(metadata));
+                        ? Collections.emptyMap()
+                        : Map.copyOf(metadata);
     }
 
     public ApiErrorBase(String name, int errorCode, String message, int httpStatusCode, Map<String, Object> metadata) {
@@ -106,6 +105,7 @@ public Map<String, Object> getMetadata() {
     }
 
     @Override
+    @SuppressWarnings("EqualsWhichDoesntCheckParameterClass")
     public boolean equals(Object o) {
         return ApiErrorUtil.isApiErrorEqual(this, o);
     }

backstopper-core/src/main/java/com/nike/backstopper/apierror/ApiErrorWithMetadata.java

@@ -83,6 +83,7 @@ public int getHttpStatusCode() {
     }
 
     @Override
+    @SuppressWarnings("EqualsWhichDoesntCheckParameterClass")
     public boolean equals(Object o) {
         return ApiErrorUtil.isApiErrorEqual(this, o);
     }

backstopper-core/src/main/java/com/nike/backstopper/apierror/projectspecificinfo/ProjectApiErrors.java

@@ -336,7 +336,7 @@ public List<Integer> getStatusCodePriorityOrder() {
      *          the possibility of null being returned and have a strategy for picking a winner.
      */
     public Integer determineHighestPriorityHttpStatusCode(Collection<ApiError> apiErrors) {
-        if (apiErrors == null || apiErrors.size() == 0) {
+        if (apiErrors == null || apiErrors.isEmpty()) {
             return null;
         }
 
@@ -368,7 +368,7 @@ public Integer determineHighestPriorityHttpStatusCode(Collection<ApiError> apiEr
         logger.error(
             "None of the HTTP status codes in the ApiErrors passed to determineHighestPriorityHttpStatusCode() were"
             + " found in the getStatusCodePriorityOrder() list. Offending set of http status codes (these should be "
-            + "added to the getStatusCodePriorityOrder() list for this project): " + validStatusCodePossibilities
+            + "added to the getStatusCodePriorityOrder() list for this project): {}", validStatusCodePossibilities
         );
 
         return null;

backstopper-core/src/main/java/com/nike/backstopper/apierror/sample/SampleCoreApiError.java

@@ -20,7 +20,7 @@
 
 /**
  * A sample/example of some core errors that many APIs are likely to need. Any given {@link ProjectApiErrors} could
- * return these as its {@link ProjectApiErrors#getCoreApiErrors()} if the error codes and messages associated with these
+ * return these as its {@code ProjectApiErrors#getCoreApiErrors()} if the error codes and messages associated with these
  * are fine for your project (see {@link SampleProjectApiErrorsBase} for a base implementation that does exactly that).
  *
  * <p>In practice most organizations should copy/paste this class and customize the error codes and messages for their
@@ -64,7 +64,7 @@ public enum SampleCoreApiError implements ApiError {
 
     SampleCoreApiError(int errorCode, String message, int httpStatusCode) {
         this(new ApiErrorBase(
-            "delegated-to-enum-wrapper-" + UUID.randomUUID().toString(), errorCode, message, httpStatusCode
+            "delegated-to-enum-wrapper-" + UUID.randomUUID(), errorCode, message, httpStatusCode
         ));
     }
 

backstopper-core/src/main/java/com/nike/backstopper/apierror/sample/SampleProjectApiErrorsBase.java

@@ -26,7 +26,7 @@
 public abstract class SampleProjectApiErrorsBase extends ProjectApiErrors {
 
     private static final List<ApiError> SAMPLE_CORE_API_ERRORS_AS_LIST =
-        Arrays.<ApiError>asList(SampleCoreApiError.values());
+        Arrays.asList(SampleCoreApiError.values());
 
     @Override
     protected List<ApiError> getCoreApiErrors() {

backstopper-core/src/main/java/com/nike/backstopper/exception/ApiException.java

@@ -215,8 +215,8 @@ protected static String extractMessage(ApiError error) {
     }
 
     /**
-     * Extracts and joins all messages from the input List<{@link ApiError}> if the desired message is null.
-     *
+     * Extracts and joins all messages from the input List&lt;{@link ApiError}> if the desired message is null.
+     * <p>
      * Will return null if the input error List is null
      */
     protected static String extractMessage(List<ApiError> apiErrors, String desiredMessage) {
@@ -253,9 +253,9 @@ public StackTraceLoggingBehavior getStackTraceLoggingBehavior() {
      */
     @SuppressWarnings("WeakerAccess")
     public static class Builder {
-        private List<ApiError> apiErrors = new ArrayList<>();
-        private List<Pair<String, String>> extraDetailsForLogging = new ArrayList<>();
-        private List<Pair<String, List<String>>> extraResponseHeaders = new ArrayList<>();
+        private final List<ApiError> apiErrors = new ArrayList<>();
+        private final List<Pair<String, String>> extraDetailsForLogging = new ArrayList<>();
+        private final List<Pair<String, List<String>>> extraResponseHeaders = new ArrayList<>();
         private String message;
         private Throwable cause;
         private StackTraceLoggingBehavior stackTraceLoggingBehavior;

backstopper-core/src/main/java/com/nike/backstopper/exception/ClientDataValidationError.java

@@ -2,7 +2,7 @@
 
 import java.util.List;
 
-import javax.validation.ConstraintViolation;
+import jakarta.validation.ConstraintViolation;
 
 /**
  * A runtime exception representing a <b>CLIENT DATA</b> JSR 303 validation failure (i.e. a validation error with data
@@ -51,8 +51,8 @@ public List<ConstraintViolation<Object>> getViolations() {
 
     /**
      * @return The validation groups that were used to do the validation, if any. This may be null or empty; if this is
-     *          null/empty it means the {@link javax.validation.groups.Default} validation group was used as per
-     *          {@link javax.validation.Validator#validate(Object, Class[])} (i.e. no groups were passed in to that
+     *          null/empty it means the {@link jakarta.validation.groups.Default} validation group was used as per
+     *          {@link jakarta.validation.Validator#validate(Object, Class[])} (i.e. no groups were passed in to that
      *          method).
      */
     public Class<?>[] getValidationGroups() {

backstopper-core/src/main/java/com/nike/backstopper/exception/ServersideValidationError.java

@@ -4,7 +4,7 @@
 
 import java.util.Set;
 
-import javax.validation.ConstraintViolation;
+import jakarta.validation.ConstraintViolation;
 
 /**
  * A runtime exception representing a <b>SERVERSIDE</b> JSR 303 validation failure (i.e. a validation error with

backstopper-core/src/main/java/com/nike/backstopper/handler/ApiExceptionHandlerBase.java

@@ -280,8 +280,7 @@ protected ErrorResponseInfo<T> doHandleApiException(
         // Add connection type to our extra logging data if appropriate. This particular log message is here so it can
         //      be done in one spot rather than trying to track down all the different places we're handling
         //      NetworkExceptionBase subclasses (and possibly missing some by accident).
-        if (coreException instanceof NetworkExceptionBase) {
-            NetworkExceptionBase neb = ((NetworkExceptionBase)coreException);
+        if (coreException instanceof NetworkExceptionBase neb) {
             extraDetailsForLogging.add(Pair.of("connection_type", neb.getConnectionType()));
         }
 
@@ -294,20 +293,20 @@ protected ErrorResponseInfo<T> doHandleApiException(
 
         // Bulletproof against somehow getting a completely empty collection of client errors. This should never happen
         //      but if it does we want a reasonable response.
-        if (filteredClientErrors == null || filteredClientErrors.size() == 0) {
+        if (filteredClientErrors == null || filteredClientErrors.isEmpty()) {
             ApiError genericServiceError = projectApiErrors.getGenericServiceError();
             UUID trackingUuid = UUID.randomUUID();
             String trackingLogKey = "bad_handler_logic_tracking_uuid";
             extraDetailsForLogging.add(Pair.of(trackingLogKey, trackingUuid.toString()));
-            logger.error(String.format(
+            logger.error(
                 "Found a situation where we ended up with 0 ApiErrors to return to the client. This should not happen "
                 + "and likely indicates a logic error in ApiExceptionHandlerBase, or a ProjectApiErrors that isn't "
-                + "setup properly. Defaulting to " + genericServiceError.getName() + " for now, but this should be "
-                + "investigated and fixed. Search for %s=%s in the logs to find the log message that contains the "
+                + "setup properly. Defaulting to {} for now, but this should be "
+                + "investigated and fixed. Search for {}={} in the logs to find the log message that contains the "
                 + "details of the request along with the full stack trace of the original exception. "
-                + "unfiltered_api_errors=%s",
-                trackingLogKey, trackingUuid.toString(), utils.concatenateErrorCollection(clientErrors)
-            ));
+                + "unfiltered_api_errors={}",
+                genericServiceError.getName(), trackingLogKey, trackingUuid, utils.concatenateErrorCollection(clientErrors)
+            );
             filteredClientErrors = Collections.singletonList(genericServiceError);
             highestPriorityStatusCode = genericServiceError.getHttpStatusCode();
         }
@@ -376,8 +375,11 @@ protected ErrorResponseInfo<T> doHandleApiException(
      */
     @SuppressWarnings("UnusedParameters")
     protected boolean shouldLogStackTrace(
-        int statusCode, Collection<ApiError> filteredClientErrors, Throwable originalException,
-        Throwable coreException, RequestInfoForLogging request
+        int statusCode,
+        @SuppressWarnings("unused") Collection<ApiError> filteredClientErrors,
+        @SuppressWarnings("unused") Throwable originalException,
+        Throwable coreException,
+        @SuppressWarnings("unused") RequestInfoForLogging request
     ) {
         if (coreException instanceof ApiException) {
             // See if this ApiException is explicitly requesting stack trace logging to be forced on or off.

backstopper-core/src/main/java/com/nike/backstopper/handler/ApiExceptionHandlerUtils.java

@@ -15,8 +15,8 @@
 import java.util.Set;
 import java.util.UUID;
 
-import javax.inject.Named;
-import javax.inject.Singleton;
+import jakarta.inject.Named;
+import jakarta.inject.Singleton;
 
 /**
  * Set of reusable utility methods used by the API exception handling chain
@@ -211,21 +211,21 @@ public String buildErrorMessageForLogs(StringBuilder sb, RequestInfoForLogging r
     }
 
     protected @Nullable Object extractOrigErrorRequestUriAttr(@NotNull RequestInfoForLogging request) {
-        // Corresponds to javax.servlet.RequestDispatcher.ERROR_REQUEST_URI.
-        return request.getAttribute("javax.servlet.error.request_uri");
+        // Corresponds to jakarta.servlet.RequestDispatcher.ERROR_REQUEST_URI.
+        return request.getAttribute("jakarta.servlet.error.request_uri");
     }
 
     protected @Nullable Object extractOrigForwardedRequestUriAttr(@NotNull RequestInfoForLogging request) {
-        // Corresponds to javax.servlet.RequestDispatcher.FORWARD_REQUEST_URI.
-        Object forwardedRequestUriAttr = request.getAttribute("javax.servlet.forward.request_uri");
+        // Corresponds to jakarta.servlet.RequestDispatcher.FORWARD_REQUEST_URI.
+        Object forwardedRequestUriAttr = request.getAttribute("jakarta.servlet.forward.request_uri");
 
         if (forwardedRequestUriAttr != null) {
             return forwardedRequestUriAttr;
         }
 
         // The forwarded request URI attr was null. Try the path info attr as a last resort.
-        //      Corresponds to javax.servlet.RequestDispatcher.FORWARD_PATH_INFO.
-        return request.getAttribute("javax.servlet.forward.path_info");
+        //      Corresponds to jakarta.servlet.RequestDispatcher.FORWARD_PATH_INFO.
+        return request.getAttribute("jakarta.servlet.forward.path_info");
     }
 
     /**
@@ -299,8 +299,8 @@ public String parseSpecificHeaderToString(RequestInfoForLogging request, String
 
 
     /**
-     * @param sensitiveHeaders
-     * @param headerName
+     * @param sensitiveHeaders The set of sensitive headers names.
+     * @param headerName The header name in question.
      * @return Returns true if the header name is one of the sensitive headers in lower, upper or camel case.
      */
     private static boolean containsCaseInSensitive(Set<String> sensitiveHeaders, String headerName) {

backstopper-core/src/main/java/com/nike/backstopper/handler/UnhandledExceptionHandlerBase.java

@@ -170,7 +170,7 @@ public ErrorResponseInfo<T> handleException(Throwable ex, RequestInfoForLogging
                 try {
                     body = request.getBody();
                 } catch (RequestInfoForLogging.GetBodyException e) {
-                    logger.warn("Failed to retrieve request_body while handling exception ex=" + ex, e);
+                    logger.warn("Failed to retrieve request_body while handling exception ex={}", ex, e);
                     body = "[ERROR_EXTRACING_BODY]";
                 }
 
@@ -229,7 +229,7 @@ public ErrorResponseInfo<T> handleException(Throwable ex, RequestInfoForLogging
      *          Note that in many frameworks if the body has already been read once then it cannot be read again,
      *          so you may have more work to do than just setting this method to return true.
      */
-    @SuppressWarnings("UnusedParameters")
+    @SuppressWarnings("unused")
     protected boolean logRequestBodyOnUnhandledExceptions(Throwable ex, RequestInfoForLogging request) {
         return false;
     }