Make AnnotatedService public #5628

chickenchickenlove · 2024-04-22T11:24:41Z

Motivation:

In the past, AnnotatedService provided specialized information for annotated services such as Method, service instance, and the default status, and so on. however, users could not access this information because it was declared with a package-private access modifier, so it was not part of the public API.

Modifications:

Split AnnotatedService into two parts: AnnotatedService (interface) and DefaultAnnotatedService (implementation).
AnnotatedService : The methods that can be used by users through the Public API are declared in the AnnotatedService interface.
DefaultAnnotatedService: Methods intended for internal use are declared in DefaultAnnotatedService.

Result:

Closes Make AnnotatedService public #5382
Make the specialized information provided by AnnotatedService available through a public API.

github-actions · 2024-04-22T11:36:48Z

🔍 Build Scan® (commit: `3dadf29`)

Job name	Status	Build Scan®
build-windows-latest-jdk-19	✅	https://ge.armeria.dev/s/yfw77kbltbtgi
build-self-hosted-unsafe-jdk-8	❌ (failure)	https://ge.armeria.dev/s/v2bvmrwblybzu
build-self-hosted-unsafe-jdk-19-snapshot-blockhound	✅	https://ge.armeria.dev/s/wulxqeryiftnq
build-self-hosted-unsafe-jdk-17-min-java-17-coverage	✅	https://ge.armeria.dev/s/gciayjpwmauwu
build-self-hosted-unsafe-jdk-17-min-java-11	✅	https://ge.armeria.dev/s/glgsrurzzzlfm
build-self-hosted-unsafe-jdk-17-leak	✅	https://ge.armeria.dev/s/plvn3ej4em5xs
build-self-hosted-unsafe-jdk-11	✅	https://ge.armeria.dev/s/bmnqm67o2f7gk
build-macos-12-jdk-19	✅	https://ge.armeria.dev/s/7tjyzl4zxgnzg

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java

core/src/main/java/com/linecorp/armeria/server/DefaultServiceConfigSetters.java

core/src/main/java/com/linecorp/armeria/internal/server/annotation/AnnotatedServiceElement.java

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java

core/src/main/java/com/linecorp/armeria/server/annotation/AnnotatedService.java

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java

...src/main/java/com/linecorp/armeria/internal/server/annotation/AnnotatedDocServicePlugin.java

core/src/main/java/com/linecorp/armeria/server/annotation/AnnotatedService.java

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java

core/src/main/java/com/linecorp/armeria/server/DefaultServiceConfigSetters.java

core/src/main/java/com/linecorp/armeria/server/annotation/AnnotatedService.java

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java

...src/main/java/com/linecorp/armeria/internal/server/annotation/AnnotatedDocServicePlugin.java

…tion/AnnotatedDocServicePlugin.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

…tion/DefaultAnnotatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

…onfigSetters.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

…tion/AnnotatedDocServicePlugin.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

trustin

Almost there - Let's go!

core/src/main/java/com/linecorp/armeria/internal/common/util/ServiceNamingUtil.java

...src/main/java/com/linecorp/armeria/internal/server/annotation/AnnotatedDocServicePlugin.java

core/src/main/java/com/linecorp/armeria/server/DefaultServiceConfigSetters.java

core/src/main/java/com/linecorp/armeria/server/annotation/AnnotatedService.java

…onfigSetters.java Co-authored-by: Trustin Lee <t@motd.kr>

…erviceNamingUtil.java Co-authored-by: Trustin Lee <t@motd.kr>

ikhoon

Nice work! Thanks, @chickenchickenlove. 🙇‍♂️🙇‍♂️

trustin

jrhee17

Pushed a small commit with minor cleanups. Thanks @chickenchickenlove ! 🙇 👍 🙇

minwoox

Looks really great! Thanks, @chickenchickenlove! 👍 👍 👍

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java

…tion/DefaultAnnotatedService.java

trustin · 2024-05-07T13:24:10Z

Please make sure the PR description is up to date and has no grammar errors or incorrect class names next time. Also, please do not mix up motivation, modification and result. For example, what you initially wrote at the motivation section is the result of your work.

chickenchickenlove · 2024-05-07T14:17:10Z

Thanks for your comment.
I updated the PR description following your guide. 🙇‍♂️

Motivation: - Related issue: line#5382 - It'd be nice if a user can access the information provided by `AnnotatredService`, but it is not part of the public API. ### Modifications: - Split `AnnotatedService` into `AnnotatedService` (interface) and `DefaultAnnotatedService` (implementation). ### Result: - Closes line#5382 Before: ```java ServiceRequestContext serviceRequestContext = ServiceRequestContext.current(); AnnotatedService service = serviceRequestContext.config().service().as(AnnotatedService.class); // This doesn't compile. // service.method(); // service.defaultStatus(); ``` After: ```java ServiceRequestContext serviceRequestContext = ServiceRequestContext.current(); AnnotatedService service = serviceRequestContext.config().service().as(AnnotatedService.class); // This compiles and provides useful properties. service.method(); service.defaultStatus(); ``` --------- Co-authored-by: Ikhun Um <ih.pert@gmail.com> Co-authored-by: Trustin Lee <t@motd.kr> Co-authored-by: jrhee17 <guins_j@guins.org> Co-authored-by: minux <songmw725@gmail.com>

Make AnnotatedService public

2d75886

chickenchickenlove mentioned this pull request Apr 22, 2024

Make AnnotatedService public #5621

Closed

fix dependencies

51424ed

trustin added new feature sprint Issues for OSS Sprint participants labels Apr 23, 2024

trustin reviewed Apr 23, 2024

View reviewed changes

apply review

8f785a9

chickenchickenlove requested a review from trustin April 24, 2024 02:08

trustin reviewed Apr 24, 2024

View reviewed changes

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java Outdated Show resolved Hide resolved

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java Outdated Show resolved Hide resolved

chickenchickenlove added 2 commits April 24, 2024 14:50

rename to .

15b1fb5

apply review

4fed8e3

chickenchickenlove requested a review from trustin April 24, 2024 06:38

ikhoon reviewed Apr 26, 2024

View reviewed changes

chickenchickenlove and others added 15 commits April 28, 2024 19:29

Update core/src/main/java/com/linecorp/armeria/internal/server/annota…

93a11dc

…tion/AnnotatedDocServicePlugin.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/internal/server/annota…

dabc97b

…tion/DefaultAnnotatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

31811e0

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

68d422a

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/DefaultServiceC…

e2989b0

…onfigSetters.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/DefaultServiceC…

23e41d5

…onfigSetters.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

db4cbb0

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

ce2d651

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

ee3baae

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

f13f91a

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

ffb97bb

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/server/annotation/Anno…

3424468

…tatedService.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/internal/server/annota…

d622251

…tion/AnnotatedDocServicePlugin.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Update core/src/main/java/com/linecorp/armeria/internal/server/annota…

2bdfcd1

…tion/AnnotatedDocServicePlugin.java Co-authored-by: Ikhun Um <ih.pert@gmail.com>

Apply reveiw

12b7179

chickenchickenlove requested a review from ikhoon April 28, 2024 12:07

trustin reviewed Apr 30, 2024

View reviewed changes

chickenchickenlove and others added 3 commits April 30, 2024 19:30

Update core/src/main/java/com/linecorp/armeria/server/DefaultServiceC…

698579f

…onfigSetters.java Co-authored-by: Trustin Lee <t@motd.kr>

Update core/src/main/java/com/linecorp/armeria/internal/common/util/S…

6cc6923

…erviceNamingUtil.java Co-authored-by: Trustin Lee <t@motd.kr>

apply review

180d110

chickenchickenlove requested review from jrhee17 and minwoox as code owners April 30, 2024 15:20

chickenchickenlove requested a review from trustin May 2, 2024 01:12

ikhoon added this to the 1.29.0 milestone May 2, 2024

ikhoon approved these changes May 2, 2024

View reviewed changes

trustin approved these changes May 2, 2024

View reviewed changes

jrhee17 added 2 commits May 3, 2024 18:11

minor cleanups

68e509f

DefaultAnnotatedService can be package-private

c42fb4d

jrhee17 approved these changes May 3, 2024

View reviewed changes

minwoox approved these changes May 7, 2024

View reviewed changes

core/src/main/java/com/linecorp/armeria/internal/server/annotation/DefaultAnnotatedService.java Outdated Show resolved Hide resolved

Update core/src/main/java/com/linecorp/armeria/internal/server/annota…

3dadf29

…tion/DefaultAnnotatedService.java

trustin merged commit 7d562ce into line:main May 7, 2024
14 of 15 checks passed

chickenchickenlove mentioned this pull request May 7, 2024

Implement @Attribute Injection. #5547

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make AnnotatedService public #5628

Make AnnotatedService public #5628

chickenchickenlove commented Apr 22, 2024 •

edited

Loading

github-actions bot commented Apr 22, 2024 •

edited

Loading

trustin left a comment

ikhoon left a comment

trustin left a comment

jrhee17 left a comment

minwoox left a comment

trustin commented May 7, 2024

chickenchickenlove commented May 7, 2024

Make AnnotatedService public #5628

Make AnnotatedService public #5628

Conversation

chickenchickenlove commented Apr 22, 2024 • edited Loading

github-actions bot commented Apr 22, 2024 • edited Loading

🔍 Build Scan® (commit: 3dadf29)

trustin left a comment

Choose a reason for hiding this comment

ikhoon left a comment

Choose a reason for hiding this comment

trustin left a comment

Choose a reason for hiding this comment

jrhee17 left a comment

Choose a reason for hiding this comment

minwoox left a comment

Choose a reason for hiding this comment

trustin commented May 7, 2024

chickenchickenlove commented May 7, 2024

chickenchickenlove commented Apr 22, 2024 •

edited

Loading

github-actions bot commented Apr 22, 2024 •

edited

Loading

🔍 Build Scan® (commit: `3dadf29`)