Add default timeout support to opal api proxy - #368
Merged
Conversation
iamfrankiemoran
left a comment
Contributor
There was a problem hiding this comment.
Remember to bump the library version number
iamfrankiemoran
requested changes
Jul 23, 2026
iamfrankiemoran
left a comment
Contributor
There was a problem hiding this comment.
You need to bump the version number in the package.json
Co-authored-by: Frankie Moran <frankie.jack.moran@gmail.com>
|
Contributor
Author
|
Changes done to this library (including readme) and opal-frontend pr |
6 tasks
This file contains hidden or 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
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.



Jira link
See PO-3939
Change description
This PR updates
opal-frontend-common-node-libso the shared frontend proxy no longer relies on implicit proxy behaviour for timeout and transport failures.OpalApiProxynow takes an explicit timeout value, passes it through tohttp-proxy-middleware, and returns a deterministic response when the upstream service times out or cannot be reached.For timeout and network-style failures, the proxy now returns a
504 Gateway Timeoutresponse with a consistent error body andretriable: true. For other unexpected proxy failures, it returns a502 Bad Gatewayresponse withretriable: false. The proxy itself does not retry requests, so read and mutation safety stays with the consuming frontend.I also added a small source-local README under
src/proxy/opal-api-proxy/README.mdto document the timeout contract, the error mapping, and how the optional retry mechanism inopal-frontend-common-ui-libcan be used by consumers.Assumptions
opal-fines-service.Testing
Local Testing Completed
Testing Still Outstanding
Some things I couldn't test in the browser and will possibly need integration tests written by QA:
Security Vulnerability Assessment
CVE Suppression: Are there any CVEs present in the codebase (either newly introduced or pre-existing) that are being intentionally suppressed or ignored by this commit?
Checklist