Add gRPC service registration feature in spring-boot-autoconfigure #1749

matsumana · 2019-05-04T16:09:23Z

Hello, I've added gRPC service registration feature in spring-boot-autoconfigure

Motivation:

Makes it easy to configure gRPC server in Spring Boot applications

Modifications:

Add GrpcServiceRegistrationBean.java
Add configureGrpcServices method in ArmeriaConfigurationUtil.java then call it in ArmeriaAutoConfiguration.java and ArmeriaReactiveWebServerFactory.java

Result:

It can be configured as follows

@Bean
public GrpcServiceRegistrationBean helloService() {
    return new GrpcServiceRegistrationBean()
            .setServiceName("helloService")
            .setService(new GrpcServiceBuilder()
                                .addService(new HelloService())
                                .supportedSerializationFormats(
                                        GrpcSerializationFormats.values())
                                .enableUnframedRequests(true)
                                .build())
            .setDecorators(LoggingService.newDecorator())
            .setExampleRequests(List.of(ExampleRequest.of(HelloServiceGrpc.SERVICE_NAME,
                                                          "Hello",
                                                          HelloRequest.newBuilder()
                                                                      .setName("Armeria")
                                                                      .build())));
}

codecov · 2019-05-04T16:39:24Z

Codecov Report

Merging #1749 into master will increase coverage by 0.04%.
The diff coverage is 94%.

@@             Coverage Diff              @@
##             master    #1749      +/-   ##
============================================
+ Coverage      71.8%   71.85%   +0.04%     
- Complexity     8419     8428       +9     
============================================
  Files           760      761       +1     
  Lines         33780    33827      +47     
  Branches       4158     4162       +4     
============================================
+ Hits          24255    24305      +50     
+ Misses         7420     7405      -15     
- Partials       2105     2117      +12

Impacted Files	Coverage Δ	Complexity Δ
...meria/spring/AnnotatedServiceRegistrationBean.java	`85% <ø> (ø)`	`9 <0> (ø)`	⬇️
...rmeria/spring/AbstractServiceRegistrationBean.java	`92.85% <ø> (ø)`	`9 <0> (ø)`	⬇️
...rp/armeria/spring/HttpServiceRegistrationBean.java	`80% <ø> (ø)`	`3 <0> (ø)`	⬇️
...rp/armeria/spring/GrpcServiceRegistrationBean.java	`100% <100%> (ø)`	`3 <3> (?)`
...ecorp/armeria/spring/ArmeriaAutoConfiguration.java	`78.57% <83.33%> (+0.19%)`	`8 <0> (ø)`	⬇️
.../web/reactive/ArmeriaReactiveWebServerFactory.java	`72.5% <83.33%> (+0.57%)`	`21 <0> (ø)`	⬇️
...eria/internal/spring/ArmeriaConfigurationUtil.java	`61.3% <95.83%> (+3.14%)`	`38 <5> (+5)`	⬆️
...corp/armeria/common/stream/FixedStreamMessage.java	`80.35% <0%> (-3.58%)`	`18% <0%> (-2%)`
...lient/circuitbreaker/CircuitBreakerHttpClient.java	`69.69% <0%> (-3.04%)`	`10% <0%> (-1%)`
...inecorp/armeria/client/grpc/ArmeriaClientCall.java	`80.59% <0%> (-1.5%)`	`36% <0%> (-1%)`
... and 9 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 4566782...ba7754e. Read the comment docs.

trustin

Very nice work! Left just a few minor comments. 👍

spring/boot-autoconfigure/build.gradle

...oot-autoconfigure/src/main/java/com/linecorp/armeria/spring/GrpcServiceRegistrationBean.java

Because gradle-scripts takes care that.

matsumana · 2019-05-08T17:03:22Z

Thank you for your comment!
updated.

The test failed in AppVeyor, but it seems to have nothing to do with the last push, right?

trustin · 2019-05-09T03:09:05Z

it seems to have nothing to do with the last push, right?

Yeah, just an issue with AppVeyor.

trustin

👍

trustin · 2019-05-09T03:09:58Z

...autoconfigure/src/main/java/com/linecorp/armeria/spring/AbstractServiceRegistrationBean.java

- * An abstract bean with information for registering a service object. It enables micrometer
- * monitoring of the service automatically.
+ * An abstract bean with information for registering a service object.
+ * It enables Micrometer metric collection of the service automatically.


Thanks! 🙇‍♂️

minwoox

Great job!

minwoox · 2019-05-09T03:31:46Z

...g/boot-autoconfigure/src/main/java/com/linecorp/armeria/spring/ArmeriaAutoConfiguration.java

+                              docServiceBuilder,
+                              grpcServiceRegistrationBean.orElseGet(Collections::emptyList),
+                              meterIdPrefixFuncFactory,
+                              armeriaSettings.getDocsPath());


nit: Could extract armeriaSettings.getDocsPath() as a variable and reuse it?

minwoox · 2019-05-09T03:38:29Z

...oot-autoconfigure/src/main/java/com/linecorp/armeria/spring/GrpcServiceRegistrationBean.java

+            return exampleRequest;
+        }
+
+        public static ExampleRequest of(String serviceType, String methodName, Object exampleRequest) {


nit: Could add @NotNull to all parameters?

hyangtack

Great job!

trustin · 2019-05-09T08:58:24Z

@matsumana Would you mind resolving the conflict and addressing @minwoox's comments?

…ot-autoconfigure

matsumana · 2019-05-09T10:54:35Z

Updated!

trustin · 2019-05-09T11:22:47Z

Thanks, @matsumana !

matsumana · 2019-05-09T11:27:32Z

Thank you!

xmeng1 · 2019-10-11T07:00:05Z

is it possible to config with the DocServiceBuilder?

@bean

…ine#1749) Motivation: - Makes it easy to configure gRPC server in Spring Boot applications Modifications: - Add `GrpcServiceRegistrationBean.java` - Add `configureGrpcServices` method in `ArmeriaConfigurationUtil.java` then call it in `ArmeriaAutoConfiguration.java` and `ArmeriaReactiveWebServerFactory.java` Result: - It can be configured as follows ```java @bean public GrpcServiceRegistrationBean helloService() { return new GrpcServiceRegistrationBean() .setServiceName("helloService") .setService(new GrpcServiceBuilder() .addService(new HelloService()) .supportedSerializationFormats( GrpcSerializationFormats.values()) .enableUnframedRequests(true) .build()) .setDecorators(LoggingService.newDecorator()) .setExampleRequests(List.of(ExampleRequest.of(HelloServiceGrpc.SERVICE_NAME, "Hello", HelloRequest.newBuilder() .setName("Armeria") .build()))); } ```

matsumana requested review from hyangtack, minwoox and trustin as code owners May 4, 2019 16:09

matsumana force-pushed the feature/add-grpc-integration-for-spring-boot-autoconfigure branch from 231d9ae to 1fef5de Compare May 4, 2019 19:40

Add gRPC service registration feature in spring-boot-autoconfigure

678fef6

matsumana force-pushed the feature/add-grpc-integration-for-spring-boot-autoconfigure branch from 1fef5de to 678fef6 Compare May 4, 2019 19:45

add assertion

2c48ae5

trustin added the new feature label May 8, 2019

trustin added this to the 0.85.0 milestone May 8, 2019

trustin reviewed May 8, 2019

View reviewed changes

spring/boot-autoconfigure/build.gradle Outdated Show resolved Hide resolved

spring/boot-autoconfigure/build.gradle Outdated Show resolved Hide resolved

...oot-autoconfigure/src/main/java/com/linecorp/armeria/spring/GrpcServiceRegistrationBean.java Outdated Show resolved Hide resolved

matsumana added 2 commits May 9, 2019 01:27

Fix comments

cefc33b

Delete unnecessary gradle setting

18ef6a7

Because gradle-scripts takes care that.

trustin approved these changes May 9, 2019

View reviewed changes

minwoox approved these changes May 9, 2019

View reviewed changes

hyangtack approved these changes May 9, 2019

View reviewed changes

matsumana added 3 commits May 9, 2019 19:08

Extract to the variable for reuse

31e7efb

Add NotNull annotations

89f3782

Merge branch 'master' into feature/add-grpc-integration-for-spring-bo…

ba7754e

…ot-autoconfigure

trustin merged commit 031981f into line:master May 9, 2019

matsumana deleted the feature/add-grpc-integration-for-spring-boot-autoconfigure branch May 9, 2019 11:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add gRPC service registration feature in spring-boot-autoconfigure #1749

Add gRPC service registration feature in spring-boot-autoconfigure #1749

matsumana commented May 4, 2019

codecov bot commented May 4, 2019 •

edited

Loading

trustin left a comment

matsumana commented May 8, 2019

trustin commented May 9, 2019

trustin left a comment

trustin May 9, 2019

minwoox left a comment

minwoox May 9, 2019

minwoox May 9, 2019

hyangtack left a comment

trustin commented May 9, 2019

matsumana commented May 9, 2019

trustin commented May 9, 2019

matsumana commented May 9, 2019

xmeng1 commented Oct 11, 2019

Add gRPC service registration feature in spring-boot-autoconfigure #1749

Add gRPC service registration feature in spring-boot-autoconfigure #1749

Conversation

matsumana commented May 4, 2019

codecov bot commented May 4, 2019 • edited Loading

Codecov Report

trustin left a comment

Choose a reason for hiding this comment

matsumana commented May 8, 2019

trustin commented May 9, 2019

trustin left a comment

Choose a reason for hiding this comment

trustin May 9, 2019

Choose a reason for hiding this comment

minwoox left a comment

Choose a reason for hiding this comment

minwoox May 9, 2019

Choose a reason for hiding this comment

minwoox May 9, 2019

Choose a reason for hiding this comment

hyangtack left a comment

Choose a reason for hiding this comment

trustin commented May 9, 2019

matsumana commented May 9, 2019

trustin commented May 9, 2019

matsumana commented May 9, 2019

xmeng1 commented Oct 11, 2019

codecov bot commented May 4, 2019 •

edited

Loading