From 5763aefc44a4c27d7b7921249aac3a49a69ad633 Mon Sep 17 00:00:00 2001 From: David Ankin Date: Tue, 17 Dec 2024 13:43:55 -0500 Subject: [PATCH 1/2] fix: Use future-compatible grpc generated annotation flag --- .../springgrpc/GrpcGradleGroovyBuildCustomizer.java | 5 ++++- .../springgrpc/GrpcGradleKotlinBuildCustomizer.java | 9 +++++---- .../dependency/springgrpc/GrpcMavenBuildCustomizer.java | 1 + .../SpringGrpcProjectGenerationConfigurationTests.java | 7 +++++-- 4 files changed, 15 insertions(+), 7 deletions(-) diff --git a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java index f3f4f120b8a..42740652320 100644 --- a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java +++ b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java @@ -38,7 +38,10 @@ protected void customizeExtensions(GradleExtensionContainer extensions) { protobuf.nested("plugins", (plugins) -> plugins.nested("grpc", (grpc) -> grpc.attribute("artifact", quote("io.grpc:protoc-gen-grpc-java")))); protobuf.nested("generateProtoTasks", (generateProtoTasks) -> generateProtoTasks.nested("all()*.plugins", - (plugins) -> plugins.nested("grpc", (grpc) -> grpc.invoke("option", quote("jakarta_omit"))))); + (plugins) -> plugins.nested("grpc", (grpc) -> { + grpc.invoke("option", quote("jakarta_omit") + " // legacy (v1.63) param"); + grpc.invoke("option", quote("@generated=omit") + " // param name starting v1.64"); + }))); }); } diff --git a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java index faf2dc4b5a8..e050cf8bebb 100644 --- a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java +++ b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java @@ -38,10 +38,11 @@ protected void customizeExtensions(GradleExtensionContainer extensions) { protobuf.importType("com.google.protobuf.gradle.id"); protobuf.nested("plugins", (plugins) -> plugins.nested("id(\"grpc\")", (grpc) -> grpc.attribute("artifact", quote("io.grpc:protoc-gen-grpc-java")))); - protobuf.nested("generateProtoTasks", - (generateProtoTasks) -> generateProtoTasks.nested("all().forEach", - (forEach) -> forEach.nested("it.plugins", (plugins) -> plugins.nested("id(\"grpc\")", - (grpc) -> grpc.invoke("option", quote("jakarta_omit")))))); + protobuf.nested("generateProtoTasks", (generateProtoTasks) -> generateProtoTasks.nested("all().forEach", + (forEach) -> forEach.nested("it.plugins", (plugins) -> plugins.nested("id(\"grpc\")", (grpc) -> { + grpc.invoke("option", quote("jakarta_omit") + " /* legacy (v1.63) param */"); + grpc.invoke("option", quote("@generated=omit") + " /* param name starting v1.64 */"); + })))); }); } diff --git a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcMavenBuildCustomizer.java b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcMavenBuildCustomizer.java index b0304b1321f..d5e2fad0e1b 100644 --- a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcMavenBuildCustomizer.java +++ b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcMavenBuildCustomizer.java @@ -80,6 +80,7 @@ private void addProtobufPlugin(MavenPluginContainer plugins, VersionProperty pro plugin.execution("compile", (execution) -> { execution.goal("compile").goal("compile-custom"); execution.configuration((configuration) -> configuration.add("pluginParameter", "jakarta_omit")); + execution.configuration((configuration) -> configuration.add("pluginParameter", "@generated=omit")); }); }); } diff --git a/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java b/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java index a4dbc8c0b96..f233cbb633c 100644 --- a/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java +++ b/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java @@ -76,7 +76,8 @@ void shouldAddGrpcPluginAndConfigurationForGradleGroovy() { generateProtoTasks { all()*.plugins { grpc { - option 'jakarta_omit' + option 'jakarta_omit' // legacy (v1.63) param + option '@generated=omit' // param name starting v1.64 } } } @@ -104,7 +105,8 @@ void shouldAddGrpcPluginAndConfigurationForGradleKotlin() { all().forEach { it.plugins { id("grpc") { - option("jakarta_omit") + option("jakarta_omit" /* legacy (v1.63) param */) + option("@generated=omit" /* param name starting v1.64 */) } } } @@ -159,6 +161,7 @@ void shouldAddProtobufPluginForMaven() { jakarta_omit + @generated=omit From 665368754e7b13376d5016ea41dc98ac88797abf Mon Sep 17 00:00:00 2001 From: David Ankin Date: Wed, 18 Dec 2024 10:05:57 -0500 Subject: [PATCH 2/2] remove comments per feedback --- .../springgrpc/GrpcGradleGroovyBuildCustomizer.java | 4 ++-- .../springgrpc/GrpcGradleKotlinBuildCustomizer.java | 4 ++-- .../SpringGrpcProjectGenerationConfigurationTests.java | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java index 42740652320..080c63de77e 100644 --- a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java +++ b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleGroovyBuildCustomizer.java @@ -39,8 +39,8 @@ protected void customizeExtensions(GradleExtensionContainer extensions) { (grpc) -> grpc.attribute("artifact", quote("io.grpc:protoc-gen-grpc-java")))); protobuf.nested("generateProtoTasks", (generateProtoTasks) -> generateProtoTasks.nested("all()*.plugins", (plugins) -> plugins.nested("grpc", (grpc) -> { - grpc.invoke("option", quote("jakarta_omit") + " // legacy (v1.63) param"); - grpc.invoke("option", quote("@generated=omit") + " // param name starting v1.64"); + grpc.invoke("option", quote("jakarta_omit")); + grpc.invoke("option", quote("@generated=omit")); }))); }); } diff --git a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java index e050cf8bebb..123643a64b1 100644 --- a/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java +++ b/start-site/src/main/java/io/spring/start/site/extension/dependency/springgrpc/GrpcGradleKotlinBuildCustomizer.java @@ -40,8 +40,8 @@ protected void customizeExtensions(GradleExtensionContainer extensions) { (grpc) -> grpc.attribute("artifact", quote("io.grpc:protoc-gen-grpc-java")))); protobuf.nested("generateProtoTasks", (generateProtoTasks) -> generateProtoTasks.nested("all().forEach", (forEach) -> forEach.nested("it.plugins", (plugins) -> plugins.nested("id(\"grpc\")", (grpc) -> { - grpc.invoke("option", quote("jakarta_omit") + " /* legacy (v1.63) param */"); - grpc.invoke("option", quote("@generated=omit") + " /* param name starting v1.64 */"); + grpc.invoke("option", quote("jakarta_omit")); + grpc.invoke("option", quote("@generated=omit")); })))); }); } diff --git a/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java b/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java index f233cbb633c..2a519658958 100644 --- a/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java +++ b/start-site/src/test/java/io/spring/start/site/extension/dependency/springgrpc/SpringGrpcProjectGenerationConfigurationTests.java @@ -76,8 +76,8 @@ void shouldAddGrpcPluginAndConfigurationForGradleGroovy() { generateProtoTasks { all()*.plugins { grpc { - option 'jakarta_omit' // legacy (v1.63) param - option '@generated=omit' // param name starting v1.64 + option 'jakarta_omit' + option '@generated=omit' } } } @@ -105,8 +105,8 @@ void shouldAddGrpcPluginAndConfigurationForGradleKotlin() { all().forEach { it.plugins { id("grpc") { - option("jakarta_omit" /* legacy (v1.63) param */) - option("@generated=omit" /* param name starting v1.64 */) + option("jakarta_omit") + option("@generated=omit") } } }