Add Dropwizard module #2236

OneCricketeer · 2019-11-06T10:06:32Z

Adding module for dropwizard integration

Why

I use Dropwizard at work, currently, I'm sure others do as well, and trust it's built-in Jetty http server, but might want other features. There already is a Dropwizard gRPC Bundle, but doesn't handle Thrift, AFAIK (not that that is a major feature for me, anyway).
Wanted to see how difficult swapping out Dropwizard Jetty servers would be. 😄
I am curious how much "faster" Dropwizard would be with Armeria. src: https://www.techempower.com/benchmarks/#section=data-r18&hw=ph&test=plaintext&l=zik0vz-f

Progress

Dropwizard Bundle
- Buildable Source
- Tests
  - YAML configurations
  - Dropwizard lifecycle of Armeria server
  - Testing of services within an Dropwizard application instance (maybe via AccessLog capture)
Runnable Example
Docs

Closes #2165

CLAassistant · 2019-11-06T10:06:59Z

All committers have signed the CLA.

trustin · 2019-11-06T10:23:52Z

Whoa. This is awesome! Let me review some time tomorrow!

OneCricketeer

Notes

dropwizard/build.gradle

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaServerFactory.java

examples/dropwizard-bundle/build.gradle

examples/dropwizard-bundle/src/main/java/example/dropwizard/DropwizardArmeriaApplication.java

settings.gradle

dropwizard/README.md

dropwizard/build.gradle

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaServerFactory.java

OneCricketeer · 2019-11-06T22:12:38Z

Master builds failing?

Task :examples:spring-boot-minimal:compileTestJava FAILED

trustin · 2019-11-07T01:32:29Z

Master builds failing?

That is weird. Build passes at master. Let me check what is happening in this branch.

trustin · 2019-11-07T01:38:32Z

My guess is that dropwizard-bom includes other dependencies than dropwizard-, interfering with Armeria's dependencies, such as Spring Boot 2. Could you remove dropwizard-bom and specify individual dependencies?

OneCricketeer · 2019-11-07T04:06:27Z

Am seeing this Exception when running my example module with common AccessLogWriter

WARN  [2019-11-07 03:52:13,183] com.linecorp.armeria.common.logging.RequestLogListenerInvoker: onRequestLog() failed with an exception:
! java.lang.ClassCastException: class com.linecorp.armeria.server.HttpServerHandler$EarlyRespondingRequestContext cannot be cast to class com.linecorp.armeria.server.ServiceRequestContext (com.linecorp.armeria.server.HttpServerHandler$EarlyRespondingRequestContext and com.linecorp.armeria.server.ServiceRequestContext are in unnamed module of loader 'app')
! at com.linecorp.armeria.server.logging.AccessLogger.write(AccessLogger.java:109)
! at com.linecorp.armeria.server.logging.AccessLogWriter.lambda$common$0(AccessLogWriter.java:38)
! at com.linecorp.armeria.common.logging.RequestLogListenerInvoker.invokeOnRequestLog(RequestLogListenerInvoker.java:38)
! at com.linecorp.armeria.common.logging.DefaultRequestLog.addListener(DefaultRequestLog.java:346)
! at com.linecorp.armeria.common.logging.DefaultRequestLog.addListener(DefaultRequestLog.java:322)
! at com.linecorp.armeria.server.HttpServerHandler.lambda$respond0$6(HttpServerHandler.java:608)
! at io.netty.util.concurrent.DefaultPromise.notifyListener0(DefaultPromise.java:577)
! at io.netty.util.concurrent.DefaultPromise.notifyListeners0(DefaultPromise.java:570)
! at io.netty.util.concurrent.DefaultPromise.notifyListenersNow(DefaultPromise.java:549)
! at io.netty.util.concurrent.DefaultPromise.notifyListeners(DefaultPromise.java:490)

codecov · 2019-11-07T04:28:42Z

Codecov Report

Merging #2236 into master will increase coverage by 0.13%.
The diff coverage is 77.63%.

@@             Coverage Diff              @@
##             master    #2236      +/-   ##
============================================
+ Coverage     73.69%   73.83%   +0.13%     
- Complexity    10324    10430     +106     
============================================
  Files           895      910      +15     
  Lines         39405    39689     +284     
  Branches       4890     4902      +12     
============================================
+ Hits          29041    29303     +262     
- Misses         7882     7893      +11     
- Partials       2482     2493      +11

Impacted Files	Coverage Δ	Complexity Δ
...ecorp/armeria/dropwizard/ManagedArmeriaServer.java	`0% <0%> (ø)`	`0 <0> (?)`
...com/linecorp/armeria/dropwizard/ArmeriaBundle.java	`0% <0%> (ø)`	`0 <0> (?)`
...a/dropwizard/connector/ArmeriaServerDecorator.java	`100% <100%> (ø)`	`4 <4> (?)`
...opwizard/logging/CustomAccessLogWriterFactory.java	`100% <100%> (ø)`	`5 <5> (?)`
...om/linecorp/armeria/server/jetty/JettyService.java	`63.05% <100%> (ø)`	`23 <0> (ø)`	⬇️
...dropwizard/armeria/services/http/HelloService.java	`100% <100%> (ø)`	`3 <3> (?)`
...wizard/logging/CombinedAccessLogWriterFactory.java	`100% <100%> (ø)`	`2 <2> (?)`
...a/example/dropwizard/resources/JerseyResource.java	`100% <100%> (ø)`	`2 <2> (?)`
...ple/dropwizard/DropwizardArmeriaConfiguration.java	`100% <100%> (ø)`	`1 <1> (?)`
.../connector/proxy/ArmeriaProxyConnectorFactory.java	`100% <100%> (ø)`	`7 <7> (?)`
... and 40 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 150aa5a...788611c. Read the comment docs.

trustin · 2019-11-07T05:09:22Z

Am seeing this Exception when running my example module with common AccessLogWriter

Doh! Let me send a fix PR for that.

minwoox · 2019-11-07T05:30:01Z

Oops, that was recently introduced by me. #2159 😅

OneCricketeer · 2019-11-07T06:10:22Z

Now getting NoSuchMethodError related to the Guava relocation.

> Task :dropwizard:shadedTest
com.linecorp.armeria.server.dropwizard.ArmeriaServerFactoryTest > typesAreDiscoverable() FAILED
    java.lang.NoSuchMethodError: io.dropwizard.jackson.DiscoverableSubtypeResolver.getDiscoveredSubtypes()Lcom/linecorp/armeria/internal/shaded/guava/collect/ImmutableList;
        at com.linecorp.armeria.server.dropwizard.ArmeriaServerFactoryTest.typesAreDiscoverable(ArmeriaServerFactoryTest.java:45)

com.linecorp.armeria.server.dropwizard.ArmeriaConnectorFactoryTest > typesAreDiscoverable() FAILED
    java.lang.NoSuchMethodError: io.dropwizard.jackson.DiscoverableSubtypeResolver.getDiscoveredSubtypes()Lcom/linecorp/armeria/internal/shaded/guava/collect/ImmutableList;
        at com.linecorp.armeria.server.dropwizard.ArmeriaConnectorFactoryTest.typesAreDiscoverable(ArmeriaConnectorFactoryTest.java:49)

com.linecorp.armeria.server.dropwizard.ArmeriaConnectorFactoryTest > com.linecorp.armeria.server.dropwizard.ArmeriaConnectorFactoryTest$ArmeriaHttpsConnectorFactoryTest > withoutKeyStore_shouldNotValidate() FAILED
    java.lang.NoSuchMethodError: io.dropwizard.configuration.ConfigurationValidationException.getConstraintViolations()Lcom/linecorp/armeria/internal/shaded/guava/collect/ImmutableSet;
        at com.linecorp.armeria.server.dropwizard.ArmeriaConnectorFactoryTest$ArmeriaHttpsConnectorFactoryTest.withoutKeyStore_shouldNotValidate(ArmeriaConnectorFactoryTest.java:85)

com.linecorp.armeria.server.dropwizard.logging.AccessLogWriterFactoryTest > typesAreDiscoverable() FAILED
    java.lang.NoSuchMethodError: io.dropwizard.jackson.DiscoverableSubtypeResolver.getDiscoveredSubtypes()Lcom/linecorp/armeria/internal/shaded/guava/collect/ImmutableList;
        at com.linecorp.armeria.server.dropwizard.logging.AccessLogWriterFactoryTest.typesAreDiscoverable(AccessLogWriterFactoryTest.java:44)

11 tests completed, 4 failed

> Task :dropwizard:shadedTest FAILED

trustin · 2019-11-07T10:14:36Z

Now getting NoSuchMethodError related to the Guava relocation.

Ah, we need to exclude dropwizard packages for ShadowTask Gradle task. Let me send you a patch for this. Please stay in your IDE meanwhile. 🙇‍♂️

trustin · 2019-11-08T10:13:28Z

@Cricket007 A little bit more complicated than imagined, but here's the fix:

diff --git dropwizard/build.gradle dropwizard/build.gradle
index 099afb9a2..12dfd7bd9 100644
--- dropwizard/build.gradle
+++ dropwizard/build.gradle
@@ -1,3 +1,12 @@
+buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath "com.github.jengelman.gradle.plugins:shadow:${managedVersions['com.github.jengelman.gradle.plugins:shadow']}"
+    }
+}
+
 dependencies {
     compile project(':jetty')
     // Dropwizard
@@ -9,3 +18,16 @@ dependencies {
 
     testCompile 'io.dropwizard:dropwizard-testing'
 }
+
+// Do not relocate Guava because it's part of Dropwizard's public API.
+[tasks.shadedJar, tasks.shadedTestJar].each { task ->
+    task.relocators.clear()
+    project.ext.relocations.each { Map<String, String> props ->
+        def from = props['from']
+        def to = props['to']
+        if (from in ['com.google.common', 'com.google.thirdparty.publicsuffix']) {
+            return
+        }
+        task.relocate from, to
+    }
+}

dropwizard/README.md

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaServerFactory.java

...s/dropwizard-bundle/src/main/java/example/dropwizard/armeria/services/http/HelloService.java

site/src/sphinx/advanced-dropwizard-integration.rst

...com/linecorp/armeria/server/dropwizard/connector/proxy/ArmeriaHttpProxyConnectorFactory.java

...ava/com/linecorp/armeria/server/dropwizard/connector/proxy/ArmeriaProxyConnectorFactory.java

...wizard/src/test/java/com/linecorp/armeria/server/dropwizard/ArmeriaConnectorFactoryTest.java

trustin · 2019-11-08T13:31:05Z

I'm still looking into fixing the ClassCastException you mentioned. Please ignore it meanwhile.

trustin · 2019-11-13T11:28:02Z

The ClassCastException has been fixed in master.

dropwizard/README.md

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaBundle.java

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaServerFactory.java

...com/linecorp/armeria/server/dropwizard/connector/proxy/ArmeriaHttpProxyConnectorFactory.java

...ava/com/linecorp/armeria/server/dropwizard/connector/proxy/ArmeriaProxyConnectorFactory.java

...wizard/src/test/java/com/linecorp/armeria/server/dropwizard/ArmeriaConnectorFactoryTest.java

dropwizard/src/test/resources/yaml/server/https-server-minimal.yaml

trustin

Just some nits.

site/src/sphinx/advanced-dropwizard-integration.rst

site/src/sphinx/server-access-log.rst

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaServerFactory.java

...d/src/main/java/com/linecorp/armeria/server/dropwizard/connector/ArmeriaServerDecorator.java

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaServerFactory.java

site/src/sphinx/advanced-dropwizard-integration.rst

examples/dropwizard/src/main/java/example/dropwizard/DropwizardArmeriaApplication.java

trustin · 2019-11-25T10:48:10Z

Didn't have a chance to look into the error yet. Will try this week. 🙇‍♂️

Signed-off-by: Jordan Moore <[email protected]>

minwoox

Thanks a lot, @Cricket007. You did an excellent work!

dropwizard/src/test/java/com/linecorp/armeria/dropwizard/ArmeriaServerFactoryTest.java

ikhoon

Thanks a million! You did a great job! 👍

OneCricketeer · 2019-12-23T07:34:00Z

Thanks again, everyone!

trustin · 2019-12-23T07:39:10Z

🎉🎉🎉

Thanks, @Cricket007!

Motivation: Armeria's Spring Boot auto configure moduleffers to customize the Armeria server from JSON YAML. Dropwizard module has been added to Armeria by line#2236. It can also customize Armeria Server from YAML. But the configuration style is different. Sometimes it may confuse the user. Modification: * Apply Spring Boot's YAML convention to the Dropwizard module. * Add ArmeriaConfigurationUtil for applying ArmeriaSettings to * ServerBuilder. * Copy `CustomAliasKeyManagerFactory` and * `CustomAliasX509ExtendedKeyManager` from `amreria/spring/boot-autoconfigure` to configure TLS fluenltly. * Add meter exporsition for `DropwizardMeterRegistry` * Remove unused configuration files. Result: Provide a consistent configuration to Armeria Dropwizard.

Motivation: Armeria's Spring Boot auto configure module offers to customize the Armeria server from JSON YAML. Dropwizard module has been added to Armeria by line#2236. It can also customize Armeria Server from YAML. But the configuration style is different. Sometimes it may confuse the user. Modification: * Apply Spring Boot's YAML convention to the Dropwizard module. * Add ArmeriaConfigurationUtil for applying ArmeriaSettings to * ServerBuilder. * Copy `CustomAliasKeyManagerFactory` and `CustomAliasX509ExtendedKeyManager` from `amreria/spring/boot-autoconfigure` to configure TLS fluenltly. * Add meter exporsition for `DropwizardMeterRegistry` * Remove unused configuration files. Result: Provide a consistent configuration to Armeria Dropwizard.

Motivation: Armeria's Spring Boot auto configure module offers to customize the Armeria server from JSON YAML. Dropwizard module has been added to Armeria by #2236. It can also customize Armeria Server from YAML. But the configuration style is different between Spring Boot and Dropwizard. The user should learn how to configure Armeria in each module. It may confuse the user. Modification: * Apply Spring Boot's YAML convention to the Dropwizard module. * Add ArmeriaConfigurationUtil for applying ArmeriaSettings to ServerBuilder. * Copy `CustomAliasKeyManagerFactory` and `CustomAliasX509ExtendedKeyManager` from `amreria/spring/boot-autoconfigure` to configure TLS fluenltly. * Add meter exporsition for `DropwizardMeterRegistry`. * Remove unused configuration files. Result: Provide a consistent configuration to Armeria Dropwizard.

Motivation: Dropwizard is another popular framework we'd like to integrate Armeria into. Modifications: - Add `armeria-dropwizard` which provides a Dropwizard bundle and SPI implementations. - Add documentation about Dropwizard integration - Add an example Result: Closes line#2165

Motivation: Armeria's Spring Boot auto configure module offers to customize the Armeria server from JSON YAML. Dropwizard module has been added to Armeria by line#2236. It can also customize Armeria Server from YAML. But the configuration style is different between Spring Boot and Dropwizard. The user should learn how to configure Armeria in each module. It may confuse the user. Modification: * Apply Spring Boot's YAML convention to the Dropwizard module. * Add ArmeriaConfigurationUtil for applying ArmeriaSettings to ServerBuilder. * Copy `CustomAliasKeyManagerFactory` and `CustomAliasX509ExtendedKeyManager` from `amreria/spring/boot-autoconfigure` to configure TLS fluenltly. * Add meter exporsition for `DropwizardMeterRegistry`. * Remove unused configuration files. Result: Provide a consistent configuration to Armeria Dropwizard.

OneCricketeer requested review from ikhoon, minwoox and trustin as code owners November 6, 2019 10:06

OneCricketeer commented Nov 6, 2019

View reviewed changes

dropwizard/README.md Outdated Show resolved Hide resolved

dropwizard/build.gradle Show resolved Hide resolved

dropwizard/src/main/java/com/linecorp/armeria/server/dropwizard/ArmeriaServerFactory.java Outdated Show resolved Hide resolved

OneCricketeer changed the title ~~[WIP] Feature/dropwizard integration~~ [WIP] Dropwizard Module Nov 6, 2019

trustin added the new feature label Nov 6, 2019

OneCricketeer mentioned this pull request Nov 8, 2019

Implementing Armeria GRPC in Dropwizard? #2165

Closed

OneCricketeer commented Nov 8, 2019

View reviewed changes

dropwizard/README.md Outdated Show resolved Hide resolved

trustin reviewed Nov 8, 2019

View reviewed changes

OneCricketeer commented Nov 8, 2019

View reviewed changes

trustin reviewed Nov 13, 2019

View reviewed changes

trustin reviewed Nov 15, 2019

View reviewed changes

site/src/sphinx/advanced-dropwizard-integration.rst Outdated Show resolved Hide resolved

OneCricketeer commented Nov 15, 2019

View reviewed changes

examples/dropwizard/src/main/java/example/dropwizard/DropwizardArmeriaApplication.java Show resolved Hide resolved

OneCricketeer and others added 8 commits December 21, 2019 03:10

builder-ify in the ServerFactory

66f50ae

Fixes and clean-ups / Make ArmeriaConnector a ServerConnector

357f7e3

Checkstyle

5c40578

Move package. Increase coverage.

c4bee29

Signed-off-by: Jordan Moore <[email protected]>

Bump dropwizard 1.3.16 -> 1.3.17

c6fbe6c

Signed-off-by: Jordan Moore <[email protected]>

Review comments

43a938d

Signed-off-by: Jordan Moore <[email protected]>

Drop visibility on few classes

c3e1b3b

Signed-off-by: Jordan Moore <[email protected]>

Remove dropwizard-bom

09cfd34

Signed-off-by: Jordan Moore <[email protected]>

minwoox approved these changes Dec 23, 2019

View reviewed changes

dropwizard/src/test/java/com/linecorp/armeria/dropwizard/ArmeriaServerFactoryTest.java Outdated Show resolved Hide resolved

ikhoon approved these changes Dec 23, 2019

View reviewed changes

Fix tests

5aeb9e4

trustin added this to the 0.98.0 milestone Dec 23, 2019

Update README.md

788611c

trustin changed the title ~~Dropwizard Module~~ Add Dropwizard module Dec 23, 2019

trustin merged commit db47ad3 into line:master Dec 23, 2019

ikhoon mentioned this pull request Jan 4, 2020

Provide a consistent configuration to Armeria Dropwizard #2373

Merged

OneCricketeer deleted the feature/dropwizard-integration branch February 13, 2020 22:14

minwoox mentioned this pull request Aug 21, 2020

Add Thrift example #3009

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Dropwizard module #2236

Add Dropwizard module #2236

OneCricketeer commented Nov 6, 2019 •

edited

Loading

CLAassistant commented Nov 6, 2019 •

edited

Loading

trustin commented Nov 6, 2019

OneCricketeer left a comment

OneCricketeer commented Nov 6, 2019

trustin commented Nov 7, 2019

trustin commented Nov 7, 2019

OneCricketeer commented Nov 7, 2019

codecov bot commented Nov 7, 2019 •

edited

Loading

trustin commented Nov 7, 2019

minwoox commented Nov 7, 2019

OneCricketeer commented Nov 7, 2019

trustin commented Nov 7, 2019

trustin commented Nov 8, 2019 •

edited

Loading

trustin commented Nov 8, 2019

trustin commented Nov 13, 2019

trustin left a comment

trustin commented Nov 25, 2019

minwoox left a comment

ikhoon left a comment

OneCricketeer commented Dec 23, 2019

trustin commented Dec 23, 2019

Add Dropwizard module #2236

Add Dropwizard module #2236

Conversation

OneCricketeer commented Nov 6, 2019 • edited Loading

CLAassistant commented Nov 6, 2019 • edited Loading

trustin commented Nov 6, 2019

OneCricketeer left a comment

Choose a reason for hiding this comment

OneCricketeer commented Nov 6, 2019

trustin commented Nov 7, 2019

trustin commented Nov 7, 2019

OneCricketeer commented Nov 7, 2019

codecov bot commented Nov 7, 2019 • edited Loading

Codecov Report

trustin commented Nov 7, 2019

minwoox commented Nov 7, 2019

OneCricketeer commented Nov 7, 2019

trustin commented Nov 7, 2019

trustin commented Nov 8, 2019 • edited Loading

trustin commented Nov 8, 2019

trustin commented Nov 13, 2019

trustin left a comment

Choose a reason for hiding this comment

trustin commented Nov 25, 2019

minwoox left a comment

Choose a reason for hiding this comment

ikhoon left a comment

Choose a reason for hiding this comment

OneCricketeer commented Dec 23, 2019

trustin commented Dec 23, 2019

OneCricketeer commented Nov 6, 2019 •

edited

Loading

CLAassistant commented Nov 6, 2019 •

edited

Loading

codecov bot commented Nov 7, 2019 •

edited

Loading

trustin commented Nov 8, 2019 •

edited

Loading