Propagate error info to caller by jlorper · Pull Request #1174 · Worklytics/psoxy

jlorper · 2026-04-27T16:37:22Z

Try to propagate some info to the caller on the FAILED_TO_BUILD_URL error case.

Change implications

dependencies added/changed? no
something important to note in future release notes?
- NOTE in CHANGELOG.md anything that will show up in terraform plan/apply that isn't
  obviously a no-op? no
- breaking changes? if in module/example that is NOT marked alpha, requires major version
  change -> no

jlorper · 2026-04-27T16:39:02Z

        RequestUrls requestUrls;
        try {
            requestUrls = buildRequestedUrls(requestToProxy);
        } catch (Throwable e) {


this catching Throwable doesn't give us much info on what could be happening.
Provide InvalidTokenException with some error codes (probably we should do something like this so we can have more info on our end on what can be happening in order to help the customer)

jlorper · 2026-04-27T16:40:04Z

+            // InvalidTokenException extends RuntimeException
+            if (e instanceof ReversibleTokenizationStrategy.InvalidTokenException ite) {
+                return HttpEventResponse.builder()
+                    // should this be a 500? Maybe 422 Unprocessable Content?


500 will make us retry, and same call would yield same results.
I think 422 makes more sense in this case and we can handle globally on Worklytics' side

jlorper · 2026-04-27T16:41:06Z

-            super(message, cause);
+
+        @Getter
+        public enum ErrorCode {


maybe not the best approach, but for certain cases (rules exceptions, this, and access errors) could be helpful to exactly know what's going on rather than a generic error

Copilot

Pull request overview

This PR adds structured error details to reversible-token decryption failures so callers can distinguish specific FAILED_TO_BUILD_URL / token reversal failure modes.

Changes:

Introduces InvalidTokenException.ErrorCode on ReversibleTokenizationStrategy.InvalidTokenException and updates AES token reversal to throw typed error codes.
Updates ApiDataRequestHandler to surface token reversal error information to callers when request URL building fails.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
`java/gateway-core/src/main/java/com/avaulta/gateway/tokens/impl/AESReversibleTokenizationStrategy.java`	Switches decryption exception handling to throw `InvalidTokenException` with structured `ErrorCode` values.
`java/gateway-core/src/main/java/com/avaulta/gateway/tokens/ReversibleTokenizationStrategy.java`	Adds `ErrorCode` enum + stores it on `InvalidTokenException` so callers can inspect a stable identifier.
`java/core/src/main/java/co/worklytics/psoxy/gateway/impl/ApiDataRequestHandler.java`	Returns additional error detail when URL building fails due to token reversal errors, and attempts to propagate the error code in responses.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-27T16:46:10Z

+                    // should this be a 500? Maybe 422 Unprocessable Content?
+                    .statusCode(HttpStatus.SC_INTERNAL_SERVER_ERROR)
+                    .header(ProcessedDataMetadataFields.ERROR.getHttpHeader(),
+                        ErrorCauses.FAILED_TO_BUILD_URL.name())


This InvalidTokenException branch returns a 500 with FAILED_TO_BUILD_URL, but the same exception type is handled later as a client/token issue (TOKENIZED_REQUEST_PARAMETER_INVALID with a 409). That inconsistency will make it harder for callers to correctly react to token problems; consider mapping this branch to the same status + error cause as the later catch (or otherwise keep the semantics consistent across both paths).

Suggested change

// should this be a 500? Maybe 422 Unprocessable Content?

.statusCode(HttpStatus.SC_INTERNAL_SERVER_ERROR)

.header(ProcessedDataMetadataFields.ERROR.getHttpHeader(),

ErrorCauses.FAILED_TO_BUILD_URL.name())

.statusCode(HttpStatus.SC_CONFLICT)

.header(ProcessedDataMetadataFields.ERROR.getHttpHeader(),

ErrorCauses.TOKENIZED_REQUEST_PARAMETER_INVALID.name())

yeah, I agree not a 500 ... whatever 4xx seems most semantically correct for the case.

Copilot · 2026-04-27T16:46:10Z

+            // InvalidTokenException extends RuntimeException
+            if (e instanceof ReversibleTokenizationStrategy.InvalidTokenException ite) {
+                return HttpEventResponse.builder()
+                    // should this be a 500? Maybe 422 Unprocessable Content?
+                    .statusCode(HttpStatus.SC_INTERNAL_SERVER_ERROR)
+                    .header(ProcessedDataMetadataFields.ERROR.getHttpHeader(),
+                        ErrorCauses.FAILED_TO_BUILD_URL.name())
+                    .body("Error parsing request URL. Error " + ite.getErrorCode().getCode())
+                    .build();
+            }


The newly added behavior that surfaces InvalidTokenException details during URL building (and the associated status/header/body mapping) doesn’t appear to be covered by tests. Please add/extend ApiDataRequestHandlerTest to assert the response status and X-Psoxy-Error header (and any new detail header/body) for this failure mode, so future refactors don’t silently change the contract.

eschultink

i think just use X-Psoxy-Error that exists; no need to create something else that basically duplicates that.

and return whole error enum name or exception name. No need to add extra levels of indirection to save a few chars, but require us to grep the code to determine the actual error

eschultink · 2026-04-27T17:10:46Z

+    /**
+     * a specific error code while processing the request, complements ERROR (optional)
+     */
+    ERROR_CODE("Error-Code"),


i think Error is a value from an enum ... so is specific

so if Error is a strict code -- I think eliminate this, just use Error; but if it's freeform message text, OK.

eschultink · 2026-04-27T17:12:08Z

+
+        @Getter
+        public enum ErrorCode {
+            ALGORITHM_PARAMETER_ERROR("ITE01", "Failed to decrypt token; some algorithm parameter, such as iv, is wrong"),


no need to be so clever here; just return whole enum names ... don't care about a few extra chars in error case

…ersibleTokenizationStrategy.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Use X-Psoxy-Error with full InvalidTokenException.ErrorCode enum names, return 422 for invalid token failures, and remove the redundant Error-Code header. Co-authored-by: Cursor <cursoragent@cursor.com>

Propagate error info to caller

2112668

jlorper commented Apr 27, 2026

View reviewed changes

jlorper requested review from Copilot and eschultink April 27, 2026 16:41

jlorper self-assigned this Apr 27, 2026

Copilot AI reviewed Apr 27, 2026

View reviewed changes

Add a x-psoxy-error-code response header

41313db

eschultink requested changes Apr 27, 2026

View reviewed changes

Base automatically changed from rc-v0.6.0 to main May 8, 2026 16:00

An error occurred while trying to automatically change base from rc-v0.6.0 to main May 8, 2026 16:00

eschultink changed the base branch from main to rc-v0.6.1 May 8, 2026 19:14

eschultink and others added 3 commits May 24, 2026 15:24

Update java/gateway-core/src/main/java/com/avaulta/gateway/tokens/Rev…

408f312

…ersibleTokenizationStrategy.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

b83bb52

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Address PR review feedback on error propagation

e991e15

Use X-Psoxy-Error with full InvalidTokenException.ErrorCode enum names, return 422 for invalid token failures, and remove the redundant Error-Code header. Co-authored-by: Cursor <cursoragent@cursor.com>

Base automatically changed from rc-v0.6.1 to main May 27, 2026 10:15

eschultink changed the base branch from main to rc-v0.6.2 May 27, 2026 15:28

Base automatically changed from rc-v0.6.2 to main May 29, 2026 21:22

eschultink changed the base branch from main to rc-v0.6.3 May 29, 2026 22:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Propagate error info to caller#1174

Propagate error info to caller#1174
jlorper wants to merge 5 commits into
rc-v0.6.3from
s224-more-error-info

jlorper commented Apr 27, 2026

Uh oh!

jlorper Apr 27, 2026

Uh oh!

jlorper Apr 27, 2026

Uh oh!

jlorper Apr 27, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 27, 2026

Uh oh!

eschultink May 26, 2026

Uh oh!

Uh oh!

Copilot AI Apr 27, 2026

Uh oh!

eschultink left a comment

Uh oh!

eschultink Apr 27, 2026

Uh oh!

eschultink May 26, 2026

Uh oh!

eschultink Apr 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jlorper commented Apr 27, 2026

Change implications

Uh oh!

jlorper Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

jlorper Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

jlorper Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

eschultink May 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

eschultink left a comment

Choose a reason for hiding this comment

Uh oh!

eschultink Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

eschultink May 26, 2026

Choose a reason for hiding this comment

Uh oh!

eschultink Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants