Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 3.26 KB
Raw

Contributing guide

You're more than welcome to work on this extension. Check issues first and pick something from there, or add your own suggestions and start discussion. Then create fork or branch and Pull Request once it's ready.

Setup

IDE Config and Code Style

Quarkus has a strictly enforced code style, so as this extension. Code formatting is done by the Eclipse code formatter, using the config files found in the ide-config directory. By default when you run ./mvnw install the code will be formatted automatically.

If you want to run the formatting without doing a full build, you can run ./mvnw process-sources or ./mvnw formatter:format.

More details on how to setup your ide can be found in official Quarkus Contributing guide

Modules

runtime - this happens in the runtime: this code ends up in your app's classpath
deployment - this is Quarkus compile-time stuff
integration-test - test scenarios + test endpoints + runners for Jackson and JsonB apps

Architecture

Everything in this extension revolves around ExceptionMapperBase abstract class from runtime module. All exceptions go through exception mappers extending this class.

Exception lifecycle:

  1. JaxRS/JakartaRS implementation (RESTeasy) catches exception, and immediately looks for best matching ExceptionMapper. Hopefully it will be one of our mappers :)
  2. ExceptionMapperBase::toResponse method is called, where original exception is turned into HttpProblem object by the specific subclass mapper (e.g WebApplicationExceptionMapper).
  3. HttpProblem goes into post-processing phase to apply logging, metrics generation, MCD properties injection etc.
  4. Enhanced HttpProblem is turned into JaxRS/JakartaRS Response object, with HttpProblem object placed as entity (response body). This is where ExceptionMapper work is finished.
  5. RESTeasy serializes Response object into raw HTTP response, with little help from our JSON serializer (either JacksonProblemSerializer or JsonBProblemSerializer)
  6. End user gets nice application/problem+json HTTP response.

Running tests

Jackson profile is active by default when you use IntelliJ test runner.

Command line:
./mvnw verify - jackson profile with RESTeasy classic (blocking) enabled by default\ ./mvnw verify -pl integration-test -Pjsonb-classic
./mvnw verify -pl integration-test -Pjsonb-reactive
./mvnw verify -pl integration-test -Pjackson-classic,quarkus-1.4 - checking backward compatibility with older versions of Quarkus
./mvnw clean verify -Pnative,jackson-classic -pl integration-test - running tests in native mode

Deployment and release

Releases are managed and conducted by Tietoevry. Stable (release) artifacts are available from Maven Central.

./mvnw release:prepare release:perform

Now create and publish new release on Github.

This will also automatically trigger GH Action, which will deploy artifacts built from newly created version to OSSRH staging nexus.