Add an underscore between generated service name and component (#2072)

glbrntt · web-flow · commit c8d550040c91 · 2024-09-25T10:14:49.000+01:00
Motivation:

A 'bar' package defining a 'FooService' service will have a number of
types generateed for it, for example, `Bar_FooServiceServiceProtocol`,
or `Bar_FooServiceClient`. The protocol buffers style guide reccomends
that services are suffixed with "Service" (e.g. "FooService", not "Foo")
which results in some strange protocol names (like
`Bar_FooServiceServiceProtocol`).

There should be a clearer differentiation between the qualified service
name ("bar.FooServce") and the type being generated. The code generator
already replaces "." with "_" in fully qualified names, so "_" is a
natural choice as a separator.

Modifications:

- Add an "_" between the generated fully qualified service name and the
gRPC component being generated
- Update tests

Result:

Better names in generated code.

The `Bar_FooServiceServiceProtocol` example above becomes
`Bar_FooService_ServiceProtocol`, while `Bar_FooServiceClient` becomes
`Bar_FooService_Client`.
diff --git a/Package.swift b/Package.swift
@@ -65,6 +65,7 @@ let targets: [Target] = [
     name: "GRPCCoreTests",
     dependencies: [
       .target(name: "GRPCCore"),
+      .target(name: "GRPCInProcessTransport"),
       .product(name: "SwiftProtobuf", package: "swift-protobuf")
     ],
     resources: [
diff --git a/Sources/GRPCCodeGen/Internal/Translator/ClientCodeTranslator.swift b/Sources/GRPCCodeGen/Internal/Translator/ClientCodeTranslator.swift
@@ -121,7 +121,7 @@ extension ClientCodeTranslator {
     let clientProtocol = Declaration.protocol(
       ProtocolDescription(
         accessModifier: self.accessModifier,
-        name: "\(service.namespacedGeneratedName)ClientProtocol",
+        name: "\(service.namespacedGeneratedName)_ClientProtocol",
         conformances: ["Sendable"],
         members: methods
       )
@@ -592,7 +592,7 @@ extension ClientCodeTranslator {
       .struct(
         StructDescription(
           accessModifier: self.accessModifier,
-          name: "\(service.namespacedGeneratedName)Client",
+          name: "\(service.namespacedGeneratedName)_Client",
           conformances: ["\(service.namespacedGeneratedName).ClientProtocol"],
           members: [clientProperty, initializer] + methods
         )
diff --git a/Sources/GRPCCodeGen/Internal/Translator/ServerCodeTranslator.swift b/Sources/GRPCCodeGen/Internal/Translator/ServerCodeTranslator.swift
@@ -481,8 +481,8 @@ extension ServerCodeTranslator {
     streaming: Bool
   ) -> String {
     if streaming {
-      return "\(service.namespacedGeneratedName)StreamingServiceProtocol"
+      return "\(service.namespacedGeneratedName)_StreamingServiceProtocol"
     }
-    return "\(service.namespacedGeneratedName)ServiceProtocol"
+    return "\(service.namespacedGeneratedName)_ServiceProtocol"
   }
 }
diff --git a/Sources/GRPCCodeGen/Internal/Translator/TypealiasTranslator.swift b/Sources/GRPCCodeGen/Internal/Translator/TypealiasTranslator.swift
@@ -256,12 +256,12 @@ extension TypealiasTranslator {
     let streamingServiceProtocolTypealias = Declaration.typealias(
       accessModifier: self.accessModifier,
       name: "StreamingServiceProtocol",
-      existingType: .member("\(service.namespacedGeneratedName)StreamingServiceProtocol")
+      existingType: .member("\(service.namespacedGeneratedName)_StreamingServiceProtocol")
     )
     let serviceProtocolTypealias = Declaration.typealias(
       accessModifier: self.accessModifier,
       name: "ServiceProtocol",
-      existingType: .member("\(service.namespacedGeneratedName)ServiceProtocol")
+      existingType: .member("\(service.namespacedGeneratedName)_ServiceProtocol")
     )
 
     return [
@@ -284,7 +284,7 @@ extension TypealiasTranslator {
       .typealias(
         accessModifier: self.accessModifier,
         name: "ClientProtocol",
-        existingType: .member("\(service.namespacedGeneratedName)ClientProtocol")
+        existingType: .member("\(service.namespacedGeneratedName)_ClientProtocol")
       )
     )
   }
@@ -297,7 +297,7 @@ extension TypealiasTranslator {
       .typealias(
         accessModifier: self.accessModifier,
         name: "Client",
-        existingType: .member("\(service.namespacedGeneratedName)Client")
+        existingType: .member("\(service.namespacedGeneratedName)_Client")
       )
     )
   }
diff --git a/Tests/GRPCCodeGenTests/Internal/Translator/ClientCodeTranslatorSnippetBasedTests.swift b/Tests/GRPCCodeGenTests/Internal/Translator/ClientCodeTranslatorSnippetBasedTests.swift
@@ -44,7 +44,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       """
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol NamespaceA_ServiceAClientProtocol: Sendable {
+      public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
           /// Documentation for MethodA
           func methodA<R>(
               request: GRPCCore.ClientRequest.Single<NamespaceA_ServiceARequest>,
@@ -96,7 +96,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       }
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
+      public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           public init(wrapping client: GRPCCore.GRPCClient) {
@@ -151,7 +151,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       """
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol NamespaceA_ServiceAClientProtocol: Sendable {
+      public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
           /// Documentation for MethodA
           func methodA<R>(
               request: GRPCCore.ClientRequest.Stream<NamespaceA_ServiceARequest>,
@@ -203,7 +203,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       }
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
+      public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           public init(wrapping client: GRPCCore.GRPCClient) {
@@ -258,7 +258,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       """
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol NamespaceA_ServiceAClientProtocol: Sendable {
+      public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
           /// Documentation for MethodA
           func methodA<R>(
               request: GRPCCore.ClientRequest.Single<NamespaceA_ServiceARequest>,
@@ -306,7 +306,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       }
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
+      public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           public init(wrapping client: GRPCCore.GRPCClient) {
@@ -359,7 +359,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       """
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol NamespaceA_ServiceAClientProtocol: Sendable {
+      public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
           /// Documentation for MethodA
           func methodA<R>(
               request: GRPCCore.ClientRequest.Stream<NamespaceA_ServiceARequest>,
@@ -407,7 +407,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       }
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
+      public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           public init(wrapping client: GRPCCore.GRPCClient) {
@@ -468,7 +468,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       """
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      package protocol NamespaceA_ServiceAClientProtocol: Sendable {
+      package protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
           /// Documentation for MethodA
           func methodA<R>(
               request: GRPCCore.ClientRequest.Stream<NamespaceA_ServiceARequest>,
@@ -561,7 +561,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       }
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      package struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
+      package struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           package init(wrapping client: GRPCCore.GRPCClient) {
@@ -634,7 +634,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       """
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      internal protocol ServiceAClientProtocol: Sendable {
+      internal protocol ServiceA_ClientProtocol: Sendable {
           /// Documentation for MethodA
           func methodA<R>(
               request: GRPCCore.ClientRequest.Single<ServiceARequest>,
@@ -686,7 +686,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       }
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      internal struct ServiceAClient: ServiceA.ClientProtocol {
+      internal struct ServiceA_Client: ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           internal init(wrapping client: GRPCCore.GRPCClient) {
@@ -747,7 +747,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       """
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol NamespaceA_ServiceAClientProtocol: Sendable {}
+      public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {}
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
       extension NamespaceA_ServiceA.ClientProtocol {
       }
@@ -756,7 +756,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       }
       /// Documentation for ServiceA
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
+      public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           public init(wrapping client: GRPCCore.GRPCClient) {
@@ -767,7 +767,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       ///
       /// Line 2
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol ServiceBClientProtocol: Sendable {}
+      public protocol ServiceB_ClientProtocol: Sendable {}
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
       extension ServiceB.ClientProtocol {
       }
@@ -778,7 +778,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
       ///
       /// Line 2
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public struct ServiceBClient: ServiceB.ClientProtocol {
+      public struct ServiceB_Client: ServiceB.ClientProtocol {
           private let client: GRPCCore.GRPCClient
           
           public init(wrapping client: GRPCCore.GRPCClient) {
diff --git a/Tests/GRPCCodeGenTests/Internal/Translator/IDLToStructuredSwiftTranslatorSnippetBasedTests.swift b/Tests/GRPCCodeGenTests/Internal/Translator/IDLToStructuredSwiftTranslatorSnippetBasedTests.swift
@@ -222,9 +222,9 @@ final class IDLToStructuredSwiftTranslatorSnippetBasedTests: XCTestCase {
               public static let descriptors: [GRPCCore.MethodDescriptor] = []
           }
           @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-          public typealias StreamingServiceProtocol = NamespaceA_ServiceAStreamingServiceProtocol
+          public typealias StreamingServiceProtocol = NamespaceA_ServiceA_StreamingServiceProtocol
           @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-          public typealias ServiceProtocol = NamespaceA_ServiceAServiceProtocol
+          public typealias ServiceProtocol = NamespaceA_ServiceA_ServiceProtocol
       }
 
       extension GRPCCore.ServiceDescriptor {
@@ -236,7 +236,7 @@ final class IDLToStructuredSwiftTranslatorSnippetBasedTests: XCTestCase {
 
       /// Documentation for AService
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol NamespaceA_ServiceAStreamingServiceProtocol: GRPCCore.RegistrableRPCService {}
+      public protocol NamespaceA_ServiceA_StreamingServiceProtocol: GRPCCore.RegistrableRPCService {}
 
       /// Conformance to `GRPCCore.RegistrableRPCService`.
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
@@ -247,9 +247,9 @@ final class IDLToStructuredSwiftTranslatorSnippetBasedTests: XCTestCase {
 
       /// Documentation for AService
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-      public protocol NamespaceA_ServiceAServiceProtocol: NamespaceA_ServiceA.StreamingServiceProtocol {}
+      public protocol NamespaceA_ServiceA_ServiceProtocol: NamespaceA_ServiceA.StreamingServiceProtocol {}
 
-      /// Partial conformance to `NamespaceA_ServiceAStreamingServiceProtocol`.
+      /// Partial conformance to `NamespaceA_ServiceA_StreamingServiceProtocol`.
       @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
       extension NamespaceA_ServiceA.ServiceProtocol {
       }
diff --git a/Tests/GRPCCodeGenTests/Internal/Translator/ServerCodeTranslatorSnippetBasedTests.swift b/Tests/GRPCCodeGenTests/Internal/Translator/ServerCodeTranslatorSnippetBasedTests.swift
diff --git a/Tests/GRPCCodeGenTests/Internal/Translator/TypealiasTranslatorSnippetBasedTests.swift b/Tests/GRPCCodeGenTests/Internal/Translator/TypealiasTranslatorSnippetBasedTests.swift

Original file line number	Diff line number	Diff line change
`@@ -481,8 +481,8 @@ extension ServerCodeTranslator {`
`481`	`481`	`streaming: Bool`
`482`	`482`	`) -> String {`
`483`	`483`	`if streaming {`
`484`		`- return "\(service.namespacedGeneratedName)StreamingServiceProtocol"`
	`484`	`+ return "\(service.namespacedGeneratedName)_StreamingServiceProtocol"`
`485`	`485`	`}`
`486`		`- return "\(service.namespacedGeneratedName)ServiceProtocol"`
	`486`	`+ return "\(service.namespacedGeneratedName)_ServiceProtocol"`
`487`	`487`	`}`
`488`	`488`	`}`
Original file line number	Diff line number	Diff line change
`@@ -256,12 +256,12 @@ extension TypealiasTranslator {`
`256`	`256`	`let streamingServiceProtocolTypealias = Declaration.typealias(`
`257`	`257`	`accessModifier: self.accessModifier,`
`258`	`258`	`name: "StreamingServiceProtocol",`
`259`		`- existingType: .member("\(service.namespacedGeneratedName)StreamingServiceProtocol")`
	`259`	`+ existingType: .member("\(service.namespacedGeneratedName)_StreamingServiceProtocol")`
`260`	`260`	`)`
`261`	`261`	`let serviceProtocolTypealias = Declaration.typealias(`
`262`	`262`	`accessModifier: self.accessModifier,`
`263`	`263`	`name: "ServiceProtocol",`
`264`		`- existingType: .member("\(service.namespacedGeneratedName)ServiceProtocol")`
	`264`	`+ existingType: .member("\(service.namespacedGeneratedName)_ServiceProtocol")`
`265`	`265`	`)`
`266`	`266`
`267`	`267`	`return [`
`@@ -284,7 +284,7 @@ extension TypealiasTranslator {`
`284`	`284`	`.typealias(`
`285`	`285`	`accessModifier: self.accessModifier,`
`286`	`286`	`name: "ClientProtocol",`
`287`		`- existingType: .member("\(service.namespacedGeneratedName)ClientProtocol")`
	`287`	`+ existingType: .member("\(service.namespacedGeneratedName)_ClientProtocol")`
`288`	`288`	`)`
`289`	`289`	`)`
`290`	`290`	`}`
`@@ -297,7 +297,7 @@ extension TypealiasTranslator {`
`297`	`297`	`.typealias(`
`298`	`298`	`accessModifier: self.accessModifier,`
`299`	`299`	`name: "Client",`
`300`		`- existingType: .member("\(service.namespacedGeneratedName)Client")`
	`300`	`+ existingType: .member("\(service.namespacedGeneratedName)_Client")`
`301`	`301`	`)`
`302`	`302`	`)`
`303`	`303`	`}`