support jax-rs

[seasidesky]

Describe what this PR does / why we need it

add jax-rs adapter to support jax-rs

Does this pull request fix one issue?

fix #1387

Describe how you did it

• add sentinel-jax-rs-adapter module
• add SentinelJaxRsClientFilter for jax-rs client
• add SentinelJaxRsProviderFilter for jax-rs server

Describe how to verify it

run test of sentinel-jax-rs-adapter module

Special notes for reviews

[codecov-io]

Codecov Report

Merging #1396 into master will increase coverage by 0.30%.
The diff coverage is 83.54%.

@@             Coverage Diff              @@
##             master    #1396      +/-   ##
============================================
+ Coverage     43.59%   43.89%   +0.30%     
- Complexity     1684     1714      +30     
============================================
  Files           364      372       +8     
  Lines         10523    10602      +79     
  Branches       1416     1420       +4     
============================================
+ Hits           4587     4654      +67     
- Misses         5369     5379      +10     
- Partials        567      569       +2     

Impacted Files	Coverage Δ	Complexity Δ
...r/jaxrs/fallback/DefaultSentinelJaxRsFallback.java	71.42% <71.42%> (ø)	2.00 <2.00> (?)
...p/sentinel/adapter/jaxrs/future/FutureWrapper.java	73.33% <73.33%> (ø)	5.00 <5.00> (?)
...apter/jaxrs/request/DefaultResourceNameParser.java	75.00% <75.00%> (ø)	2.00 <2.00> (?)
...nel/adapter/jaxrs/SentinelJaxRsClientTemplate.java	76.92% <76.92%> (ø)	3.00 <3.00> (?)
...inel/adapter/jaxrs/config/SentinelJaxRsConfig.java	83.33% <83.33%> (ø)	6.00 <6.00> (?)
...nel/adapter/jaxrs/SentinelJaxRsProviderFilter.java	95.45% <95.45%> (ø)	7.00 <7.00> (?)
...dapter/jaxrs/exception/DefaultExceptionMapper.java	100.00% <100.00%> (ø)	2.00 <2.00> (?)
...pter/jaxrs/request/DefaultRequestOriginParser.java	100.00% <100.00%> (ø)	2.00 <2.00> (?)
... and 7 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a0196b6...c00ce6c. Read the comment docs.

[sczyh30]

Could you please prepend the license header to each Java code file?

[seasidesky]

Could you please prepend the license header to each Java code file?

license header added

[sczyh30]

Could you please sync the version with master branch?

[seasidesky]

Could you please sync the version with master branch?

synced with master branch

[sczyh30]

Will the response filter method still be executed when unexpected error occurs? We need to guarantee the Entry exited finally.

[seasidesky]

for provider side

according to 3.3.4 Exceptions of jaxrs-2_1-final-spec:

Checked exceptions and throwables that have not been mapped and cannot be thrown directly MUSTbe wrapped in a container-specific exception that is then thrown and allowed to propagate to the un-derlying container.

if WebApplicationException or its subclasses is thrown, there are automated converted to Response and can enter response filter.

if throw exception which is not WebApplicationException or its subclass, and not matched by custom exception mapper, then the response filter cannot be called. for this case, I thank a default exception mapper maybe introduced.

according to 4.4 Exception Mapping Providers of jaxrs-2_1-final-spec:

When choosing an exception mapping provider to map an exception, an implementation MUST use theprovider whose generic type is the nearest superclass of the exception. If two or more exception providers are applicable, the one with the highest priority MUST be chosen as described in Section 4.1.3.

in case of misuse, maybe a default exception mapper of Throwable can be provided by default, then the response filter can be called.

if user also provide custom exception mapper of Throwable, then user has the responsibility to convert it to response and then the response filter can be called.

as describe in 6.7.1 exceptions of jaxrs-2_1-final-spec:

A response mapped from an exception MUST be processed using the ContainerResponsefilter chain and theWriteTointerceptor chain (if an entity is present in the mapped response).

[sczyh30]

Are there any similar problems on client side?

[seasidesky]

client side may have similar problems, according to 4.4 Exception Mapping Providers of jaxrs-2_1-final-spec

Note that exception mapping providers are not supported as part of the Client API.

I introduce SentinelJaxRsClientTemplate to replace the original SentinelJaxRsClientFilter to fix it.

[sczyh30]

I observed that the Entry would not be completed when error occurred in the controller:

EntranceNode: sentinel_jax_rs_provider_context(t:16 pq:0.0 bq:0.0 tq:0.0 rt:0.0 prq:0.0 1mp:14 1mb:12 1mt:26)
--GET:/hello(t:16 pq:0.0 bq:0.0 tq:0.0 rt:0.0 prq:0.0 1mp:14 1mb:12 1mt:26)

Are there any approaches to handle the error in JAX-RS?

[seasidesky]

I add an default exception mapper to solve this problem

[sczyh30]

I add an default exception mapper to solve this problem

Great. Could you please also update the README and demo?

[sczyh30]

For client side we don't need to exit the context here.

[seasidesky]

fixed, in the latest commit, the original SentinelJaxRsClientFilter is replaced by SentinelJaxRsClientTemplate to handle the exception and exit entry.

[seasidesky]

I add an default exception mapper to solve this problem

Great. Could you please also update the README and demo?

updated

[sczyh30]

LGTM

[sczyh30]

Nice work. Thanks for contributing and looking forward more!

[sczyh30]

Fancy a PR for Quarkus? #1233

[seasidesky]

Fancy a PR for Quarkus? #1233

yep