[DRAFT] - Code to generate spring autoconfig modules. (not intended to merge) #1030

zhumin8 · 2022-08-25T22:26:09Z

This is a WIP pr for discussion.

Code is incomplete but with major skeleton done.

Code for composing the Spring classes are moved to src/spring/composer
Addition in Writer.java is to generate spring.factories file (as in sample here). ~~Will consider extending Write.java instead.~~ Create a copy as it contains mostly static methods.
Main.java is the entry point to use gapic-gen under current infra.
java_gapic.bzl and java_gapic_pkg.bzl changes mimics how sample is generated, and adds a spring top level folder to final output tar.

To do items:

A manual sample repo of intended output is here.

From in-person review takeaway points:

Add Spring dependencies in. One benefit being safe in case of future package name changes for imported classes.
Setup golden test to compare results instead of expected string.
Try creating separate bazel targets for Spring code gen, and separate out Main.class changes.

…ode needs cleanup.

…oud-[name]-[v]-java/spring/src/main/...

…trySettingsComposer to help generate declare,getter,setters for retrysettings in properties. Other WIP changes in AutoConfig.

…adding todo notes as reminder to revisit.

…ending to do after annotation feature in.

src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java

…tatic types instead of vapor references (#1046) Adding Spring related dependencies to build files and use static types instead of vapor references. Benefit of this change: - easier to test - less code change needed for future changes (e.g. package change of classes). One caveat is that because `gapic-generator-java` is brought into `googleapis` as `http_archive` code addition to `googleapis` is also needed to include these libraries. Add below code snippet to [WORKSPACE](https://github.com/googleapis/googleapis/blob/38e8b447d173909d3b2fe8fdc3e6cbb3c85442fd/WORKSPACE#L239-L245): ``` SPRING_MAVEN_ARTIFACTS = [ "org.springframework.boot:spring-boot-starter:2.7.4", "com.google.cloud:spring-cloud-gcp-core:3.3.0", ] maven_install( artifacts = PROTOBUF_MAVEN_ARTIFACTS + SPRING_MAVEN_ARTIFACTS, generate_compat_repositories = True, repositories = [ "https://repo.maven.apache.org/maven2/", ], ) ``` ------------ Updates: - Updated pr with #1065, - Moved annotation classed added in #1045 to static types. - Fixed conflicts from merged changes in #1093 - Moved logging classes added in #1053 to static types.

- `{{starter-version}}` are not needed anymore as we inherit version from parent pom. - add parent version placeholder. Changes on spring-cloud-gcp side: GoogleCloudPlatform/spring-cloud-gcp#1353. - remove redundant groupid. - remove versions for `spring-cloud-gcp-core` and `spring-boot-starter`, specified in `genereated-parent` pom

* fix(spring codegen): use client-library-artifact-id as pom artifactId prefix. (#1092) * rename to global properties * fix(test): update goldens * fix: format * fix: typo in GLobalProperties * fix: typo in goldens * fix: remove unnecessary comments * fix: reference to com.google.cloud.spring.global * fix: typo and static ref fix Co-authored-by: Min Zhu <zhumin@google.com>

sonarcloud · 2022-11-24T17:18:27Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
93 Code Smells

89.7% Coverage
3.3% Duplication

) This is the last item missed in #1099.

* feat: degrade logging level to trace * feat: wrap logging with `isTraceEnabled()` * feat: credential usage logging * fix: use Statement for logging variables * fix: use Statement return type in createLoggerStatement() * fix: unnecessary variable creation

change `@Generated` description to spring specific and separate from "gapic-generator-java" for client libraries. Also moved relevant annotation from `SpringPackageInfoComposer` to `SpringComposer`.

This change intend to set the auto-configuration to be enabled by default.

* feat: spring service settings as its own bean * chore: update goldens * fix: rename settings creation method * fix: remove name parameter from conditional bean annotation * fix: common service settings method name and unnecessary comment

…1123) As discussed off-line, instead of depending on a new `global-properties` module, use `CredentialsProvider` bean from `spring-cloud-gcp-autoconfigure` instead. - Replace dependency from `core` to `autoconfigure` module. - Revert #1071 and implement changes shown in [poc](zhumin8/language_poc1#7) - Minor code cleanups and util method extracted from `SpringPropertiesClassComposer.java`. Note: #1071 and GoogleCloudPlatform/spring-cloud-gcp#1308 will be obsolete after this change. Also, conflicts needs to be resolved between this pr and #1110 depending on merging order.

This PR updates spring branch with CI fix from #1163 - with commit 71f0df1 cherry-picked from main branch.

…ed properties (#1143) * This PR refactors the current setup (method-level and individual settings) to use a nested Retry object provided through properties at both service-level and method-level.

This is part 2 of implementation for repo structural changes in [PoC](GoogleCloudPlatform/spring-cloud-gcp#1383). Changes in Pom string: - changed parent to `spring-cloud-gcp-starters` and version with "-preview" suffix - removed client library version (should inherit from Libraries BOM). Corresponding changes in spring-cloud-gcp: GoogleCloudPlatform/spring-cloud-gcp#1394

Task derived from GoogleCloudPlatform/spring-cloud-gcp#1355 (comment). Removing `spring.auto` from properties prefix.

Add name to `@ConditionalOnMissingBean` annotation when creating `TransportChannelProvider` bean so that it can be picked up with Qualifier in serviceSettings bean creation that follows. This was missed in original [commit](0643085) adding this bean and should fix error seen in GoogleCloudPlatform/spring-cloud-gcp#1407 (comment)

#1209) Addressing: #1110 (comment) This was leftover from changes made in #1110

This adds AutoConfigureAfter(GcpContextAutoConfiguration.class) annotation to enforce configuration order. It also makes two related changes to enable this annotation: * Switches dependency from spring-cloud-gcp-core to spring-cloud-gcp-autoconfigure, and bumps version to latest * Fixes ImportWriter to account for types introduced by annotation parameters

* This PR is a patch for the RetrySettings configuration issue discovered in GoogleCloudPlatform/spring-cloud-gcp#1407. It excludes streaming and LRO methods from retry configuration through spring properties for now.

Adds `@param` and `@return` to method javadoc comments in generated autoconfiguration classes. Also adding a change to `JavaDocComment` to enable `@return` in comment. (this change in 537e33c can be copied to main branch of `gapic-generator-java` if useful.)

…rt option (#1227) * Updated behaviour for when Transport.REST_GRPC and useRest = true (through properties): * The ServiceSettings bean uses newHttpJsonBuilder * The TransportChannelProvider bean definition returns defaultHttpJsonTransportProviderBuilder

* This PR switches camelcase handling to use align with logic used in generating client libraries.

This enables release-please setup in spring-cloud-gcp to update version as needed.

* use ClassNames util to generate client and settings class names in comments * update settings bean comment, and remove other usages of service.name()

…pported methods (#1343)

…golden tests (#1348) This PR is a follow-up on #1343: - Extends fix to SpringPropertiesClassComposer, so that for services without REST-enabled rpcs, the unused useRest property is also not generated - Adds golden tests for the updated hasRestOption scenario using the wicked proto - Updates SpringAutoconfigCommentComposer for javadoc comments alluding to the useRest option

suztomo · 2023-03-10T02:12:09Z

Please reopen if you need this pull request.

….13.0 (#1030)

zhumin8 added 29 commits June 24, 2022 13:58

add ClassComposer to generate spring bean.

ced6302

add composer on top of class composer.

be4814a

add to generator and adding comments.

96288f2

add conditionOnClass annotation, parameter not set yet.

558f2c5

update name for packaga and class produced.

c2dfbe0

producing [name]_java_gapic_srcjar-spring.srcjar.

fce0945

adding spring content to produced google-cloud-[name]-v1-java.tar.gz.

7051858

added private member and constructor to spring autoconfig composer. c…

f9199fd

…ode needs cleanup.

Merge branch 'main' into autoconfig-gen-draft2

8ba06f8

use new lambdaExpr infer type feature.

fbdc282

adding writing spring.factories. also adjust output path to google-cl…

7390d7a

…oud-[name]-[v]-java/spring/src/main/...

added RETRY_PARAM_DEFINITIONS map to generated code.

b937bb1

added SpringPropertiesClassComposer and test. Added util method to Re…

cc14a8c

…trySettingsComposer to help generate declare,getter,setters for retrysettings in properties. Other WIP changes in AutoConfig.

added class annotation and interface to SpringProperties class. Also …

5882774

…adding todo notes as reminder to revisit.

come code cleanups and added 2 more needed class annotations.- with p…

05befeb

…ending to do after annotation feature in.

comment out not needed code for constructor.

1d16132

create CredentialsProvider Bean method.

25f7bb8

create TransportChannelProvider Bean.

0643085

building service client bean. Basic settings.

697d89c

added 2 if statements and todo comments to service client bean.

71b66e6

adding if statements to client bean creation.

7b67cfd

minor cleanup edits.

37e5cfa

move added spring composers to new package.

53400f6

add expected generated property class to test.

906f9bf

cleanup unused code in test.:

a571639

move additional code out of gapic RetrySettingsComposer.

25716ef

separate out spring generator.

f4aa900

back out changes to protowriter/Writer and creat a copy for Spring code.

a45fd18

some cleanups: remove unused code, add comment reminder.

899a4a7

dangazineu reviewed Sep 1, 2022

View reviewed changes

src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java Outdated Show resolved Hide resolved

zhumin8 and others added 3 commits November 21, 2022 10:50

zhumin8 and others added 21 commits November 30, 2022 19:19

fix(spring): remove dependency versions that should be inherited. (#1102

cc068c9

) This is the last item missed in #1099.

fix(spring): change @generated description to spring specific. (#1103)

59ecb5b

change `@Generated` description to spring specific and separate from "gapic-generator-java" for client libraries. Also moved relevant annotation from `SpringPackageInfoComposer` to `SpringComposer`.

fix(spring): set autoconfig to be enabled by default. (#1107)

9fc2a5c

This change intend to set the auto-configuration to be enabled by default.

feat: service settings as a bean (#1110)

405e361

* feat: spring service settings as its own bean * chore: update goldens * fix: rename settings creation method * fix: remove name parameter from conditional bean annotation * fix: common service settings method name and unnecessary comment

build(spring): update spring branch with Bazel CI fix from main (#1164)

63291e0

This PR updates spring branch with CI fix from #1163 - with commit 71f0df1 cherry-picked from main branch.

fix(spring): refactor retry settings to service and method-level nest…

d0b45cc

…ed properties (#1143) * This PR refactors the current setup (method-level and individual settings) to use a nested Retry object provided through properties at both service-level and method-level.

fix(spring): add javadoc comments for properties (#1171)

7f550b5

fix: remove spring.auto from property prefix. (#1176)

79a288f

Task derived from GoogleCloudPlatform/spring-cloud-gcp#1355 (comment). Removing `spring.auto` from properties prefix.

fix(spring): Separate out client settings bean and client bean comment (

62153dc

#1209) Addressing: #1110 (comment) This was leftover from changes made in #1110

fix(spring): switch camelcase conversion logic to use JavaStyle (#1245)

a3d86b0

* This PR switches camelcase handling to use align with logic used in generating client libraries.

chore(spring): add release-please annotations to pom template (#1259)

e06aa48

This enables release-please setup in spring-cloud-gcp to update version as needed.

fix(spring): fix client and settings class names in comments (#1277)

26c2e12

* use ClassNames util to generate client and settings class names in comments * update settings bean comment, and remove other usages of service.name()

fix(spring): update hasRestOption to exclude services with no rest-su…

3f5db4d

…pported methods (#1343)

product-auto-label bot added the size: xl Pull request size is extra large. label Feb 9, 2023

suztomo closed this Mar 10, 2023

suztomo pushed a commit that referenced this pull request Mar 21, 2023

deps: update dependency com.google.auth:google-auth-library-bom to v1…

d35de4b

….13.0 (#1030)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DRAFT] - Code to generate spring autoconfig modules. (not intended to merge) #1030

[DRAFT] - Code to generate spring autoconfig modules. (not intended to merge) #1030

zhumin8 commented Aug 25, 2022 •

edited by JoeWang1127

Loading

sonarcloud bot commented Nov 24, 2022

suztomo commented Mar 10, 2023

[DRAFT] - Code to generate spring autoconfig modules. (not intended to merge) #1030

[DRAFT] - Code to generate spring autoconfig modules. (not intended to merge) #1030

Conversation

zhumin8 commented Aug 25, 2022 • edited by JoeWang1127 Loading

sonarcloud bot commented Nov 24, 2022

suztomo commented Mar 10, 2023

zhumin8 commented Aug 25, 2022 •

edited by JoeWang1127

Loading