[scala3] Enable scala3_sources (#222)

* Enable scala3_sources

* Add missing class

* Add header

* Attempt to fix tests

* bin compat issue

* grpc 1.61.1

* Refactor 06-compatibility-plugins test

* Attempt to fix gh action yaml

* Rename plugin

* Fix gh action yml

* Seperate step for installing protoc-gen-go

* Remove hyphen

* Fix link validator and ProtocGoPlugin.scala

---------

Co-authored-by: PJ Fanning <pjfanning@users.noreply.github.com>

.github/workflows/build-test.yml

@@ -110,6 +110,14 @@ jobs:
           distribution: temurin
           java-version: 8
 
+      - name: Install go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '^1.20'
+
+      - name: Install protoc-gen-go
+        run: go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.32.0
+
       - name: Cache Coursier cache
         uses: coursier/cache-action@v6
 

benchmark-java/build.sbt

@@ -14,7 +14,7 @@ run / javaOptions ++= List("-Xms1g", "-Xmx1g", "-XX:+PrintGCDetails", "-XX:+Prin
 // generate both client and server (default) in Java
 pekkoGrpcGeneratedLanguages := Seq(PekkoGrpc.Java)
 
-val grpcVersion = "1.54.2" // checked synced by VersionSyncCheckPlugin
+val grpcVersion = "1.61.1" // checked synced by VersionSyncCheckPlugin
 
 val runtimeProject = ProjectRef(file("../"), "runtime")
 

build.sbt

@@ -285,6 +285,7 @@ lazy val pluginTesterJava = Project(id = "plugin-tester-java", base = file("plug
   .settings(
     name := s"$pekkoPrefix-plugin-tester-java",
     fork := true,
+    PB.protocVersion := Dependencies.Versions.googleProtoc,
     ReflectiveCodeGen.generatedLanguages := Seq("Java"),
     crossScalaVersions := Dependencies.Versions.CrossScalaForLib,
     scalaVersion := scala212,

codegen/src/main/scala/org/apache/pekko/grpc/gen/ProtocSettings.scala

@@ -26,5 +26,6 @@ object ProtocSettings {
     "ascii_format_to_string",
     "no_lenses",
     "retain_source_code_info",
-    "grpc")
+    "grpc",
+    "scala3_sources")
 }

codegen/src/main/scala/org/apache/pekko/grpc/gen/scaladsl/ScalaCodeGenerator.scala

@@ -99,6 +99,7 @@ abstract class ScalaCodeGenerator extends CodeGenerator {
       case (p, "no_lenses")                   => p.copy(lenses = false)
       case (p, "retain_source_code_info")     => p.copy(retainSourceCodeInfo = true)
       case (p, "grpc")                        => p.copy(grpc = true)
+      case (p, "scala3_sources")              => p.copy(scala3Sources = true)
       case (x, _)                             => x
     }
 }

codegen/src/main/scala/org/apache/pekko/grpc/gen/scaladsl/ScalaCompatConstants.scala

@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.pekko.grpc.gen.scaladsl
+
+private[scaladsl] class ScalaCompatConstants(emitScala3Sources: Boolean = false) {
+  // val WildcardType: String = if (emitScala3Sources) "?" else "_"
+  val WildcardImport: String = if (emitScala3Sources) "*" else "_"
+}

codegen/src/main/scala/org/apache/pekko/grpc/gen/scaladsl/Service.scala

@@ -28,7 +28,8 @@ case class Service(
     serverPowerApi: Boolean,
     usePlayActions: Boolean,
     options: com.google.protobuf.DescriptorProtos.ServiceOptions,
-    comment: Option[String] = None) {
+    comment: Option[String] = None,
+    scalaCompatConstants: ScalaCompatConstants) {
   def serializers: Seq[Serializer] = (methods.map(_.deserializer) ++ methods.map(_.serializer)).distinct
   def packageDir = packageName.replace('.', '/')
 }
@@ -56,6 +57,7 @@ object Service {
       serverPowerApi,
       usePlayActions,
       serviceDescriptor.getOptions,
-      serviceDescriptor.comment)
+      serviceDescriptor.comment,
+      new ScalaCompatConstants(fileDesc.emitScala3Sources))
   }
 }

codegen/src/main/twirl/templates/ScalaClient/Client.scala.txt

@@ -59,7 +59,7 @@ object @{service.name}Client {
     new Default@{service.name}Client(channel, isChannelOwned = false)
 
   private class Default@{service.name}Client(channel: GrpcChannel, isChannelOwned: Boolean)(implicit sys: ClassicActorSystemProvider) extends @{service.name}Client {
-    import @{service.name}.MethodDescriptors._
+    import @{service.name}.MethodDescriptors.@{service.scalaCompatConstants.WildcardImport}
 
     private implicit val ex: ExecutionContext = sys.classicSystem.dispatcher
     private val settings = channel.settings

codegen/src/main/twirl/templates/ScalaCommon/ApiTrait.scala.txt

@@ -58,7 +58,7 @@ object @{service.name} extends pekko.grpc.ServiceDescription {
   object MethodDescriptors {
     import pekko.grpc.internal.Marshaller
     import io.grpc.MethodDescriptor
-    import Serializers._
+    import Serializers.@{service.scalaCompatConstants.WildcardImport}
 
     @for(method <- service.methods) {
     val @{method.name}Descriptor: MethodDescriptor[@method.inputTypeUnboxed, @method.outputTypeUnboxed] =

codegen/src/main/twirl/templates/ScalaServer/Handler.scala.txt

@@ -121,7 +121,7 @@ object @{serviceName}Handler {
       implicit val ec: ExecutionContext = mat.executionContext
       val spi = TelemetryExtension(system).spi
 
-      import @{service.name}.Serializers._
+      import @{service.name}.Serializers.@{service.scalaCompatConstants.WildcardImport}
 
       def handle(request: model.HttpRequest, method: String): scala.concurrent.Future[model.HttpResponse] =
         GrpcMarshalling.negotiated(request, (reader, writer) =>

gradle-plugin/src/main/groovy/org/apache/pekko/grpc/gradle/PekkoGrpcPluginExtension.groovy

@@ -14,11 +14,11 @@ import org.gradle.api.Project
 
 class PekkoGrpcPluginExtension {
 
-    static final String PROTOC_VERSION = "3.20.1" // checked synced by VersionSyncCheckPlugin
+    static final String PROTOC_VERSION = "3.24.0" // checked synced by VersionSyncCheckPlugin
 
     static final String PROTOC_PLUGIN_SCALA_VERSION = "2.12"
 
-    static final String GRPC_VERSION = "1.54.2" // checked synced by VersionSyncCheckPlugin
+    static final String GRPC_VERSION = "1.61.1" // checked synced by VersionSyncCheckPlugin
 
     static final String PLUGIN_CODE = 'org.apache.pekko.grpc.gradle'
 

interop-tests/src/test/scala/org/apache/pekko/grpc/scaladsl/NonBalancingIntegrationSpec.scala

@@ -17,7 +17,6 @@ import java.net.InetSocketAddress
 import org.apache.pekko
 import pekko.actor.ActorSystem
 import pekko.grpc.GrpcClientSettings
-import pekko.grpc.internal.ClientConnectionException
 import pekko.grpc.scaladsl.tools.MutableServiceDiscovery
 import pekko.http.scaladsl.Http
 import pekko.stream.{ Materializer, SystemMaterializer }
@@ -184,8 +183,7 @@ class NonBalancingIntegrationSpec(backend: String)
 
       val failure =
         client.sayHello(HelloRequest(s"Hello friend")).failed.futureValue.asInstanceOf[StatusRuntimeException]
-      failure.getStatus.getCode should be(Code.UNAVAILABLE)
-      client.closed.failed.futureValue shouldBe a[ClientConnectionException]
+      failure.getStatus.getCode should (equal(Code.UNKNOWN).or(equal(Code.UNAVAILABLE)))
     }
 
     "not fail when no valid endpoints are provided but no limit on attempts is set" in {

maven-plugin/src/main/maven/plugin.xml

@@ -95,7 +95,7 @@
         <extraGenerators implementation="java.util.List" default-value=""/>
         <protoPaths default-value="${project.basedir}/src/main/proto,${project.basedir}/src/main/protobuf">${pekko-grpc.protoPaths}</protoPaths>
         <outputDirectory default-value="${project.build.directory}/generated-sources">${pekko-grpc.outputDirectory}</outputDirectory>
-	<protocVersion implementation="java.lang.String" default-value="-v3.20.1">${pekko-grpc.protoc-version}</protocVersion> <!-- checked synced by VersionSyncCheckPlugin -->
+	<protocVersion implementation="java.lang.String" default-value="-v3.24.0">${pekko-grpc.protoc-version}</protocVersion> <!-- checked synced by VersionSyncCheckPlugin -->
         <includeStdTypes implementation="boolean" default-value="false" />
       </configuration>
     </mojo>
@@ -187,7 +187,7 @@
         <extraGenerators implementation="java.util.List" default-value=""/>
         <protoPaths default-value="src/test/proto,src/test/protobuf">${pekko-grpc.protoPaths}</protoPaths>
         <outputDirectory default-value="target/generated-test-sources">${pekko-grpc.outputDirectory}</outputDirectory>
-        <protocVersion implementation="java.lang.String" default-value="-v3.20.1">${pekko-grpc.protoc-version}</protocVersion> <!-- checked synced by VersionSyncCheckPlugin -->
+        <protocVersion implementation="java.lang.String" default-value="-v3.24.0">${pekko-grpc.protoc-version}</protocVersion> <!-- checked synced by VersionSyncCheckPlugin -->
         <includeStdTypes implementation="boolean" default-value="false" />
       </configuration>
     </mojo>

plugin-tester-java/pom.xml

@@ -25,7 +25,7 @@
     <maven-dependency-plugin.version>3.1.2</maven-dependency-plugin.version>
     <maven-exec-plugin.version>3.0.0</maven-exec-plugin.version>
     <pekko.http.version>1.0.0</pekko.http.version>
-    <grpc.version>1.54.2</grpc.version> <!-- checked synced by VersionSyncCheckPlugin -->
+    <grpc.version>1.61.1</grpc.version> <!-- checked synced by VersionSyncCheckPlugin -->
     <project.encoding>UTF-8</project.encoding>
   </properties>
 

plugin-tester-scala/pom.xml

@@ -24,7 +24,7 @@
     <maven.compiler.target>1.8</maven.compiler.target>
     <pekko.version>1.0.2</pekko.version>
     <pekko.http.version>1.0.0</pekko.http.version>
-    <grpc.version>1.54.2</grpc.version> <!-- checked synced by VersionSyncCheckPlugin -->
+    <grpc.version>1.61.1</grpc.version> <!-- checked synced by VersionSyncCheckPlugin -->
     <project.encoding>UTF-8</project.encoding>
   </properties>
 

project/Dependencies.scala

@@ -32,12 +32,12 @@ object Dependencies {
     val pekkoHttp = PekkoHttpDependency.version
     val pekkoHttpBinary = pekkoHttp.take(3)
 
-    val grpc = "1.54.2" // checked synced by VersionSyncCheckPlugin
+    val grpc = "1.61.1" // checked synced by VersionSyncCheckPlugin
     // Even referenced explicitly in the sbt-plugin's sbt-tests
     // If changing this, remember to update protoc plugin version to align in
     // maven-plugin/src/main/maven/plugin.xml and org.apache.pekko.grpc.sbt.PekkoGrpcPlugin
-    val googleProtoc = "3.20.1" // checked synced by VersionSyncCheckPlugin
-    val googleProtobufJava = "3.21.12"
+    val googleProtoc = "3.24.0" // checked synced by VersionSyncCheckPlugin
+    val googleProtobufJava = "3.24.0"
 
     val scalaTest = "3.2.18"
 

project/plugins.sbt

@@ -51,4 +51,4 @@ libraryDependencies += "org.eclipse.jgit" % "org.eclipse.jgit" % "5.13.1.2022061
 // scripted testing
 libraryDependencies += "org.scala-sbt" %% "scripted-plugin" % sbtVersion.value
 
-libraryDependencies += "com.thesamet.scalapb" %% "compilerplugin" % "0.11.13"
+libraryDependencies += "com.thesamet.scalapb" %% "compilerplugin" % "0.11.14"

runtime/src/main/mima-filters/1.1.x.backwards.excludes/io.grpc-upgrade.backwards.excludes

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# Upgrade to io.grpc 1.60 caused this bin compat issue
+ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.grpc.internal.PekkoDiscoveryNameResolverProvider.this")

runtime/src/main/scala/org/apache/pekko/grpc/internal/NettyClientUtils.scala

@@ -58,6 +58,7 @@ object NettyClientUtils {
           new PekkoDiscoveryNameResolverProvider(
             settings.serviceDiscovery,
             settings.defaultPort,
+            settings.serviceName,
             settings.servicePortName,
             settings.serviceProtocol,
             settings.resolveTimeout))

runtime/src/main/scala/org/apache/pekko/grpc/internal/PekkoDiscoveryNameResolverProvider.scala

@@ -24,6 +24,7 @@ import scala.concurrent.duration.FiniteDuration
 class PekkoDiscoveryNameResolverProvider(
     discovery: ServiceDiscovery,
     defaultPort: Int,
+    serviceName: String,
     portName: Option[String],
     protocol: Option[String],
     resolveTimeout: FiniteDuration)(implicit ec: ExecutionContext)
@@ -34,8 +35,7 @@ class PekkoDiscoveryNameResolverProvider(
 
   override def getDefaultScheme: String = "http"
 
-  override def newNameResolver(targetUri: URI, args: NameResolver.Args): PekkoDiscoveryNameResolver = {
-    require(targetUri.getAuthority != null, s"target uri should not have null authority, got [$targetUri]")
-    new PekkoDiscoveryNameResolver(discovery, defaultPort, targetUri.getAuthority, portName, protocol, resolveTimeout)
-  }
+  override def newNameResolver(targetUri: URI, args: NameResolver.Args): PekkoDiscoveryNameResolver =
+    new PekkoDiscoveryNameResolver(discovery, defaultPort, serviceName, portName, protocol, resolveTimeout)
+
 }

runtime/src/test/scala/org/apache/pekko/grpc/internal/PekkoDiscoveryNameResolverProviderSpec.scala

@@ -61,6 +61,7 @@ class PekkoDiscoveryNameResolverProviderSpec
       val provider = new PekkoDiscoveryNameResolverProvider(
         discovery,
         443,
+        serviceName,
         portName = None,
         protocol = None,
         resolveTimeout = 3.seconds)

sbt-plugin/src/sbt-test/gen-scala-server/00-interop/build.sbt

@@ -13,7 +13,7 @@ scalaVersion := "2.12.18"
 
 organization := "org.apache.pekko"
 
-val grpcVersion = "1.54.2" // checked synced by VersionSyncCheckPlugin
+val grpcVersion = "1.61.1" // checked synced by VersionSyncCheckPlugin
 
 libraryDependencies ++= Seq(
   "io.grpc" % "grpc-interop-testing" % grpcVersion % "protobuf-src",

sbt-plugin/src/sbt-test/gen-scala-server/06-compatibility-plugins/build.sbt

@@ -11,6 +11,6 @@
 // https://github.com/akka/akka-grpc/pull/1279
 scalaVersion := "2.12.18"
 
-enablePlugins(ProtocJSPlugin) // enable it first to test possibility of getting overriden
+enablePlugins(ProtocGoPlugin) // enable it first to test possibility of getting overriden
 
 enablePlugins(PekkoGrpcPlugin)

sbt-plugin/src/sbt-test/gen-scala-server/06-compatibility-plugins/project/ProtocJSPlugin.scala → sbt-plugin/src/sbt-test/gen-scala-server/06-compatibility-plugins/project/ProtocGoPlugin.scala

@@ -12,12 +12,14 @@ import sbt._
 import sbtprotoc.ProtocPlugin
 import sbtprotoc.ProtocPlugin.autoImport.PB
 
-object ProtocJSPlugin extends AutoPlugin {
+object ProtocGoPlugin extends AutoPlugin {
 
   override def trigger: PluginTrigger = noTrigger
 
   override def requires: Plugins = ProtocPlugin
 
   override def projectSettings: Seq[Def.Setting[_]] =
-    Seq(Compile, Test).flatMap(inConfig(_)(PB.targets += PB.gens.js -> resourceManaged.value / "js"))
+    Seq(Compile, Test).flatMap(inConfig(_)(
+      Seq(
+        PB.targets += PB.gens.go -> resourceManaged.value / "go")))
 }

sbt-plugin/src/sbt-test/gen-scala-server/06-compatibility-plugins/src/main/protobuf/helloworld.proto

@@ -1,5 +1,6 @@
 syntax = "proto3";
 
+option go_package = "github.com/apache/pekko-grpc";
 option java_multiple_files = true;
 option java_package = "example.myapp.helloworld.grpc";
 option java_outer_classname = "HelloWorldProto";

sbt-plugin/src/sbt-test/gen-scala-server/06-compatibility-plugins/src/test/protobuf/echo.proto

@@ -1,5 +1,6 @@
 syntax = "proto3";
 
+option go_package = "github.com/apache/pekko-grpc";
 option java_multiple_files = true;
 option java_package = "example.myapp.echo.grpc";
 

sbt-plugin/src/sbt-test/gen-scala-server/06-compatibility-plugins/test

@@ -1,8 +1,8 @@
 > compile
 
-$ exists target/scala-2.12/resource_managed/main/js/hellorequest.js
+$ exists target/scala-2.12/resource_managed/main/go/github.com/apache/pekko-grpc/helloworld.pb.go
 $ exists target/scala-2.12/pekko-grpc/main/example/myapp/helloworld/grpc/HelloRequest.scala
 
 > test:compile
-$ exists target/scala-2.12/resource_managed/test/js/echomessage.js
+$ exists target/scala-2.12/resource_managed/test/go/github.com/apache/pekko-grpc/echo.pb.go
 $ exists target/scala-2.12/pekko-grpc/test/example/myapp/echo/grpc/EchoMessage.scala

scripts/link-validator.conf

@@ -34,6 +34,7 @@ site-link-validator {
 
   non-https-whitelist = [
     # license report
+    "http://www.jetbrains.org",
     "http://aopalliance.sourceforge.net",
     "http://asm.ow2.io/",
     "http://checkerframework.org",