Skip to content

Commit c8d5500

Browse files
glbrnttglbrntt
authored
Add an underscore between generated service name and component (#2072)
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`.
1 parent cf29048 commit c8d5500

8 files changed

+110
-109
lines changed

‎Package.swift‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ let targets: [Target] = [
6565
name: "GRPCCoreTests",
6666
dependencies: [
6767
.target(name: "GRPCCore"),
68+
.target(name: "GRPCInProcessTransport"),
6869
.product(name: "SwiftProtobuf", package: "swift-protobuf")
6970
],
7071
resources: [

‎Sources/GRPCCodeGen/Internal/Translator/ClientCodeTranslator.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ extension ClientCodeTranslator {
121121
let clientProtocol = Declaration.protocol(
122122
ProtocolDescription(
123123
accessModifier: self.accessModifier,
124-
name: "\(service.namespacedGeneratedName)ClientProtocol",
124+
name: "\(service.namespacedGeneratedName)_ClientProtocol",
125125
conformances: ["Sendable"],
126126
members: methods
127127
)
@@ -592,7 +592,7 @@ extension ClientCodeTranslator {
592592
.struct(
593593
StructDescription(
594594
accessModifier: self.accessModifier,
595-
name: "\(service.namespacedGeneratedName)Client",
595+
name: "\(service.namespacedGeneratedName)_Client",
596596
conformances: ["\(service.namespacedGeneratedName).ClientProtocol"],
597597
members: [clientProperty, initializer] + methods
598598
)

‎Sources/GRPCCodeGen/Internal/Translator/ServerCodeTranslator.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -481,8 +481,8 @@ extension ServerCodeTranslator {
481481
streaming: Bool
482482
) -> String {
483483
if streaming {
484-
return "\(service.namespacedGeneratedName)StreamingServiceProtocol"
484+
return "\(service.namespacedGeneratedName)_StreamingServiceProtocol"
485485
}
486-
return "\(service.namespacedGeneratedName)ServiceProtocol"
486+
return "\(service.namespacedGeneratedName)_ServiceProtocol"
487487
}
488488
}

‎Sources/GRPCCodeGen/Internal/Translator/TypealiasTranslator.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -256,12 +256,12 @@ extension TypealiasTranslator {
256256
let streamingServiceProtocolTypealias = Declaration.typealias(
257257
accessModifier: self.accessModifier,
258258
name: "StreamingServiceProtocol",
259-
existingType: .member("\(service.namespacedGeneratedName)StreamingServiceProtocol")
259+
existingType: .member("\(service.namespacedGeneratedName)_StreamingServiceProtocol")
260260
)
261261
let serviceProtocolTypealias = Declaration.typealias(
262262
accessModifier: self.accessModifier,
263263
name: "ServiceProtocol",
264-
existingType: .member("\(service.namespacedGeneratedName)ServiceProtocol")
264+
existingType: .member("\(service.namespacedGeneratedName)_ServiceProtocol")
265265
)
266266

267267
return [
@@ -284,7 +284,7 @@ extension TypealiasTranslator {
284284
.typealias(
285285
accessModifier: self.accessModifier,
286286
name: "ClientProtocol",
287-
existingType: .member("\(service.namespacedGeneratedName)ClientProtocol")
287+
existingType: .member("\(service.namespacedGeneratedName)_ClientProtocol")
288288
)
289289
)
290290
}
@@ -297,7 +297,7 @@ extension TypealiasTranslator {
297297
.typealias(
298298
accessModifier: self.accessModifier,
299299
name: "Client",
300-
existingType: .member("\(service.namespacedGeneratedName)Client")
300+
existingType: .member("\(service.namespacedGeneratedName)_Client")
301301
)
302302
)
303303
}

‎Tests/GRPCCodeGenTests/Internal/Translator/ClientCodeTranslatorSnippetBasedTests.swift‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
4444
"""
4545
/// Documentation for ServiceA
4646
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
47-
public protocol NamespaceA_ServiceAClientProtocol: Sendable {
47+
public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
4848
/// Documentation for MethodA
4949
func methodA<R>(
5050
request: GRPCCore.ClientRequest.Single<NamespaceA_ServiceARequest>,
@@ -96,7 +96,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
9696
}
9797
/// Documentation for ServiceA
9898
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
99-
public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
99+
public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
100100
private let client: GRPCCore.GRPCClient
101101
102102
public init(wrapping client: GRPCCore.GRPCClient) {
@@ -151,7 +151,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
151151
"""
152152
/// Documentation for ServiceA
153153
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
154-
public protocol NamespaceA_ServiceAClientProtocol: Sendable {
154+
public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
155155
/// Documentation for MethodA
156156
func methodA<R>(
157157
request: GRPCCore.ClientRequest.Stream<NamespaceA_ServiceARequest>,
@@ -203,7 +203,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
203203
}
204204
/// Documentation for ServiceA
205205
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
206-
public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
206+
public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
207207
private let client: GRPCCore.GRPCClient
208208
209209
public init(wrapping client: GRPCCore.GRPCClient) {
@@ -258,7 +258,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
258258
"""
259259
/// Documentation for ServiceA
260260
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
261-
public protocol NamespaceA_ServiceAClientProtocol: Sendable {
261+
public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
262262
/// Documentation for MethodA
263263
func methodA<R>(
264264
request: GRPCCore.ClientRequest.Single<NamespaceA_ServiceARequest>,
@@ -306,7 +306,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
306306
}
307307
/// Documentation for ServiceA
308308
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
309-
public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
309+
public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
310310
private let client: GRPCCore.GRPCClient
311311
312312
public init(wrapping client: GRPCCore.GRPCClient) {
@@ -359,7 +359,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
359359
"""
360360
/// Documentation for ServiceA
361361
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
362-
public protocol NamespaceA_ServiceAClientProtocol: Sendable {
362+
public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
363363
/// Documentation for MethodA
364364
func methodA<R>(
365365
request: GRPCCore.ClientRequest.Stream<NamespaceA_ServiceARequest>,
@@ -407,7 +407,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
407407
}
408408
/// Documentation for ServiceA
409409
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
410-
public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
410+
public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
411411
private let client: GRPCCore.GRPCClient
412412
413413
public init(wrapping client: GRPCCore.GRPCClient) {
@@ -468,7 +468,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
468468
"""
469469
/// Documentation for ServiceA
470470
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
471-
package protocol NamespaceA_ServiceAClientProtocol: Sendable {
471+
package protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
472472
/// Documentation for MethodA
473473
func methodA<R>(
474474
request: GRPCCore.ClientRequest.Stream<NamespaceA_ServiceARequest>,
@@ -561,7 +561,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
561561
}
562562
/// Documentation for ServiceA
563563
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
564-
package struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
564+
package struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
565565
private let client: GRPCCore.GRPCClient
566566
567567
package init(wrapping client: GRPCCore.GRPCClient) {
@@ -634,7 +634,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
634634
"""
635635
/// Documentation for ServiceA
636636
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
637-
internal protocol ServiceAClientProtocol: Sendable {
637+
internal protocol ServiceA_ClientProtocol: Sendable {
638638
/// Documentation for MethodA
639639
func methodA<R>(
640640
request: GRPCCore.ClientRequest.Single<ServiceARequest>,
@@ -686,7 +686,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
686686
}
687687
/// Documentation for ServiceA
688688
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
689-
internal struct ServiceAClient: ServiceA.ClientProtocol {
689+
internal struct ServiceA_Client: ServiceA.ClientProtocol {
690690
private let client: GRPCCore.GRPCClient
691691
692692
internal init(wrapping client: GRPCCore.GRPCClient) {
@@ -747,7 +747,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
747747
"""
748748
/// Documentation for ServiceA
749749
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
750-
public protocol NamespaceA_ServiceAClientProtocol: Sendable {}
750+
public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {}
751751
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
752752
extension NamespaceA_ServiceA.ClientProtocol {
753753
}
@@ -756,7 +756,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
756756
}
757757
/// Documentation for ServiceA
758758
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
759-
public struct NamespaceA_ServiceAClient: NamespaceA_ServiceA.ClientProtocol {
759+
public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
760760
private let client: GRPCCore.GRPCClient
761761
762762
public init(wrapping client: GRPCCore.GRPCClient) {
@@ -767,7 +767,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
767767
///
768768
/// Line 2
769769
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
770-
public protocol ServiceBClientProtocol: Sendable {}
770+
public protocol ServiceB_ClientProtocol: Sendable {}
771771
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
772772
extension ServiceB.ClientProtocol {
773773
}
@@ -778,7 +778,7 @@ final class ClientCodeTranslatorSnippetBasedTests: XCTestCase {
778778
///
779779
/// Line 2
780780
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
781-
public struct ServiceBClient: ServiceB.ClientProtocol {
781+
public struct ServiceB_Client: ServiceB.ClientProtocol {
782782
private let client: GRPCCore.GRPCClient
783783
784784
public init(wrapping client: GRPCCore.GRPCClient) {

‎Tests/GRPCCodeGenTests/Internal/Translator/IDLToStructuredSwiftTranslatorSnippetBasedTests.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,9 @@ final class IDLToStructuredSwiftTranslatorSnippetBasedTests: XCTestCase {
222222
public static let descriptors: [GRPCCore.MethodDescriptor] = []
223223
}
224224
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
225-
public typealias StreamingServiceProtocol = NamespaceA_ServiceAStreamingServiceProtocol
225+
public typealias StreamingServiceProtocol = NamespaceA_ServiceA_StreamingServiceProtocol
226226
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
227-
public typealias ServiceProtocol = NamespaceA_ServiceAServiceProtocol
227+
public typealias ServiceProtocol = NamespaceA_ServiceA_ServiceProtocol
228228
}
229229
230230
extension GRPCCore.ServiceDescriptor {
@@ -236,7 +236,7 @@ final class IDLToStructuredSwiftTranslatorSnippetBasedTests: XCTestCase {
236236
237237
/// Documentation for AService
238238
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
239-
public protocol NamespaceA_ServiceAStreamingServiceProtocol: GRPCCore.RegistrableRPCService {}
239+
public protocol NamespaceA_ServiceA_StreamingServiceProtocol: GRPCCore.RegistrableRPCService {}
240240
241241
/// Conformance to `GRPCCore.RegistrableRPCService`.
242242
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
@@ -247,9 +247,9 @@ final class IDLToStructuredSwiftTranslatorSnippetBasedTests: XCTestCase {
247247
248248
/// Documentation for AService
249249
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
250-
public protocol NamespaceA_ServiceAServiceProtocol: NamespaceA_ServiceA.StreamingServiceProtocol {}
250+
public protocol NamespaceA_ServiceA_ServiceProtocol: NamespaceA_ServiceA.StreamingServiceProtocol {}
251251
252-
/// Partial conformance to `NamespaceA_ServiceAStreamingServiceProtocol`.
252+
/// Partial conformance to `NamespaceA_ServiceA_StreamingServiceProtocol`.
253253
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
254254
extension NamespaceA_ServiceA.ServiceProtocol {
255255
}

0 commit comments

Comments
 (0)