Skip to content
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.

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

refactor(cactus-core): catch block get-open-api-spec-v1-endpoint-base #2979

Merged

Conversation

ArchanaArige
Copy link
Contributor

1. The GetOpenApiSpecV1EndpointBase<S, P> class now has the request
handler migrated to the new error handling mechanism that automatically
differentiates between HTTP statuses of 4xx and 5xx.
2. The register-web-service-endpoint utility function uses the new error
handling utilities as well, but on the lower level, e.g. it coerces unknown
errors to RuntimeError instances to minimize the risk of information loss
when re-throwing the inner exception with more context attached to it.
3. The consensus-has-transaction-finality file was similarly migrated
to the new error handling mechanisms.
4. A dependency to the cactus-core package was added for the easier handling
of HTTP specific errors. The http-errors-enhanced-cjs package contains
useful shorthands for HTTP-aware error handling and can be used in common
JS environments instead of being constrainted to ESM only like the original
library.

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ArchanaArige FYI: I rebased it onto upstream/main and removed the indentation from the commit message.

Copy link
Contributor

@izuru0 izuru0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

1. The GetOpenApiSpecV1EndpointBase<S, P> class now has the request
handler migrated to the new error handling mechanism that automatically
differentiates between HTTP statuses of 4xx and 5xx.
2. The register-web-service-endpoint utility function uses the new error
handling utilities as well, but on the lower level, e.g. it coerces unknown
errors to RuntimeError instances to minimize the risk of information loss
when re-throwing the inner exception with more context attached to it.
3. The consensus-has-transaction-finality file was similarly migrated
to the new error handling mechanisms.
4. A dependency to the cactus-core package was added for the easier handling
of HTTP specific errors. The http-errors-enhanced-cjs package contains
useful shorthands for HTTP-aware error handling and can be used in common
JS environments instead of being constrainted to ESM only like the original
library.

Co-authored-by: Peter Somogyvari <peter.somogyvari@accenture.com>

Signed-off-by: ArchanaArige <nigam_archana@yahoo.co.in>
Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
@petermetz petermetz enabled auto-merge (rebase) January 22, 2024 17:12
@petermetz petermetz merged commit 81c93f9 into hyperledger-cacti:main Jan 22, 2024
121 of 147 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants