Merge branch 'main' into build_plugin_integration_tests

Package.swift

@@ -35,7 +35,7 @@ let products: [Product] = [
 let dependencies: [Package.Dependency] = [
   .package(
     url: "https://github.com/grpc/grpc-swift.git",
-    exact: "2.0.0-beta.3"
+    branch: "main"
   ),
   .package(
     url: "https://github.com/apple/swift-protobuf.git",

Plugins/PluginsShared/PluginError.swift

@@ -23,8 +23,8 @@ enum PluginError: Error {
 extension PluginError: CustomStringConvertible {
   var description: String {
     switch self {
-    case .incompatibleTarget(let string):
-      "Build plugin applied to incompatible target."
+    case .incompatibleTarget(let target):
+      "Build plugin applied to incompatible target (\(target))."
     case .noConfigFilesFound:
       "No config files found. The build plugin relies on the existence of one or more '\(configFileName)' files in the target source."
     }

Sources/GRPCProtobufCodeGen/ProtobufCodeGenParser.swift

@@ -18,11 +18,12 @@ internal import SwiftProtobuf
 package import SwiftProtobufPluginLibrary
 
 package import struct GRPCCodeGen.CodeGenerationRequest
+package import struct GRPCCodeGen.CodeGenerator
 package import struct GRPCCodeGen.Dependency
 package import struct GRPCCodeGen.MethodDescriptor
-package import struct GRPCCodeGen.Name
+package import struct GRPCCodeGen.MethodName
 package import struct GRPCCodeGen.ServiceDescriptor
-package import struct GRPCCodeGen.SourceGenerator
+package import struct GRPCCodeGen.ServiceName
 
 #if canImport(FoundationEssentials)
 internal import struct FoundationEssentials.IndexPath
@@ -34,12 +35,12 @@ internal import struct Foundation.IndexPath
 package struct ProtobufCodeGenParser {
   let extraModuleImports: [String]
   let protoToModuleMappings: ProtoFileToModuleMappings
-  let accessLevel: SourceGenerator.Config.AccessLevel
+  let accessLevel: CodeGenerator.Config.AccessLevel
 
   package init(
     protoFileModuleMappings: ProtoFileToModuleMappings,
     extraModuleImports: [String],
-    accessLevel: SourceGenerator.Config.AccessLevel
+    accessLevel: CodeGenerator.Config.AccessLevel
   ) {
     self.extraModuleImports = extraModuleImports
     self.protoToModuleMappings = protoFileModuleMappings
@@ -69,12 +70,6 @@ package struct ProtobufCodeGenParser {
       //   https://github.com/grpc/grpc-swift
 
       """
-    let lookupSerializer: (String) -> String = { messageType in
-      "GRPCProtobuf.ProtobufSerializer<\(messageType)>()"
-    }
-    let lookupDeserializer: (String) -> String = { messageType in
-      "GRPCProtobuf.ProtobufDeserializer<\(messageType)>()"
-    }
 
     let services = descriptor.services.map {
       GRPCCodeGen.ServiceDescriptor(
@@ -90,8 +85,12 @@ package struct ProtobufCodeGenParser {
       leadingTrivia: header + leadingTrivia,
       dependencies: self.codeDependencies(file: descriptor),
       services: services,
-      lookupSerializer: lookupSerializer,
-      lookupDeserializer: lookupDeserializer
+      makeSerializerCodeSnippet: { messageType in
+        "GRPCProtobuf.ProtobufSerializer<\(messageType)>()"
+      },
+      makeDeserializerCodeSnippet: { messageType in
+        "GRPCProtobuf.ProtobufDeserializer<\(messageType)>()"
+      }
     )
   }
 }
@@ -147,22 +146,17 @@ extension GRPCCodeGen.ServiceDescriptor {
         protobufNamer: protobufNamer
       )
     }
-    let name = Name(
-      base: descriptor.name,
+
+    let typePrefix = protobufNamer.typePrefix(forFile: file)
+    let name = ServiceName(
+      identifyingName: descriptor.fullName,
       // The service name from the '.proto' file is expected to be in upper camel case
-      generatedUpperCase: descriptor.name,
-      generatedLowerCase: CamelCaser.toLowerCamelCase(descriptor.name)
+      typeName: typePrefix + descriptor.name,
+      propertyName: protobufNamer.typePrefixProperty(file: file) + descriptor.name
     )
 
-    // Packages that are based on the path of the '.proto' file usually
-    // contain dots. For example: "grpc.test".
-    let namespace = Name(
-      base: package,
-      generatedUpperCase: protobufNamer.formattedUpperCasePackage(file: file),
-      generatedLowerCase: protobufNamer.formattedLowerCasePackage(file: file)
-    )
     let documentation = descriptor.protoSourceComments()
-    self.init(documentation: documentation, name: name, namespace: namespace, methods: methods)
+    self.init(documentation: documentation, name: name, methods: methods)
   }
 }
 
@@ -171,11 +165,11 @@ extension GRPCCodeGen.MethodDescriptor {
     descriptor: SwiftProtobufPluginLibrary.MethodDescriptor,
     protobufNamer: SwiftProtobufNamer
   ) {
-    let name = Name(
-      base: descriptor.name,
+    let name = MethodName(
+      identifyingName: descriptor.name,
       // The method name from the '.proto' file is expected to be in upper camel case
-      generatedUpperCase: descriptor.name,
-      generatedLowerCase: CamelCaser.toLowerCamelCase(descriptor.name)
+      typeName: descriptor.name,
+      functionName: CamelCaser.toLowerCamelCase(descriptor.name)
     )
     let documentation = descriptor.protoSourceComments()
     self.init(
@@ -208,17 +202,19 @@ extension FileDescriptor {
 }
 
 extension SwiftProtobufNamer {
-  internal func formattedUpperCasePackage(file: FileDescriptor) -> String {
-    let unformattedPackage = self.typePrefix(forFile: file)
-    return unformattedPackage.trimTrailingUnderscores()
-  }
-
-  internal func formattedLowerCasePackage(file: FileDescriptor) -> String {
-    let upperCasePackage = self.formattedUpperCasePackage(file: file)
-    let lowerCaseComponents = upperCasePackage.split(separator: "_").map { component in
+  internal func typePrefixProperty(file: FileDescriptor) -> String {
+    let typePrefix = self.typePrefix(forFile: file)
+    let lowercased = typePrefix.split(separator: "_").map { component in
       NamingUtils.toLowerCamelCase(String(component))
     }
-    return lowerCaseComponents.joined(separator: "_")
+
+    let joined = lowercased.joined(separator: "_")
+    if typePrefix.hasSuffix("_"), !joined.hasSuffix("_") {
+      // Add the trailing "_" if it was dropped.
+      return joined + "_"
+    } else {
+      return joined
+    }
   }
 }
 

Sources/GRPCProtobufCodeGen/ProtobufCodeGenerator.swift

@@ -18,10 +18,10 @@ package import GRPCCodeGen
 package import SwiftProtobufPluginLibrary
 
 package struct ProtobufCodeGenerator {
-  internal var config: SourceGenerator.Config
+  internal var config: GRPCCodeGen.CodeGenerator.Config
 
   package init(
-    config: SourceGenerator.Config
+    config: GRPCCodeGen.CodeGenerator.Config
   ) {
     self.config = config
   }
@@ -36,10 +36,10 @@ package struct ProtobufCodeGenerator {
       extraModuleImports: extraModuleImports,
       accessLevel: self.config.accessLevel
     )
-    let sourceGenerator = SourceGenerator(config: self.config)
+    let codeGenerator = GRPCCodeGen.CodeGenerator(config: self.config)
 
     let codeGenerationRequest = try parser.parse(descriptor: fileDescriptor)
-    let sourceFile = try sourceGenerator.generate(codeGenerationRequest)
+    let sourceFile = try codeGenerator.generate(codeGenerationRequest)
     return sourceFile.contents
   }
 }

Sources/protoc-gen-grpc-swift/GenerateGRPC.swift

@@ -26,7 +26,7 @@ import Foundation
 #endif
 
 @main
-final class GenerateGRPC: CodeGenerator {
+final class GenerateGRPC: SwiftProtobufPluginLibrary.CodeGenerator {
   var version: String? {
     Version.versionString
   }
@@ -96,7 +96,7 @@ final class GenerateGRPC: CodeGenerator {
       fileNamingOption: options.fileNaming
     )
 
-    let config = SourceGenerator.Config(options: options)
+    let config = CodeGenerator.Config(options: options)
     let fileGenerator = ProtobufCodeGenerator(config: config)
     let contents = try fileGenerator.generateCode(
       fileDescriptor: descriptor,
@@ -182,9 +182,9 @@ private func splitPath(pathname: String) -> (dir: String, base: String, suffix:
   return (dir: dir, base: base, suffix: suffix)
 }
 
-extension SourceGenerator.Config {
+extension GRPCCodeGen.CodeGenerator.Config {
   init(options: GeneratorOptions) {
-    let accessLevel: SourceGenerator.Config.AccessLevel
+    let accessLevel: GRPCCodeGen.CodeGenerator.Config.AccessLevel
     switch options.visibility {
     case .internal:
       accessLevel = .internal

Tests/GRPCProtobufCodeGenTests/ProtobufCodeGenParserTests.swift

@@ -78,12 +78,7 @@ struct ProtobufCodeGenParserTests {
 
       @Test("Name")
       func name() {
-        #expect(self.service.name.base == "TestService")
-      }
-
-      @Test("Namespace")
-      func namespace() {
-        #expect(self.service.namespace.base == "test")
+        #expect(self.service.name.identifyingName == "test.TestService")
       }
 
       @Suite("Methods")
@@ -114,10 +109,10 @@ struct ProtobufCodeGenParserTests {
 
         @Test("Name")
         func name() {
-          #expect(self.unary.name.base == "Unary")
-          #expect(self.clientStreaming.name.base == "ClientStreaming")
-          #expect(self.serverStreaming.name.base == "ServerStreaming")
-          #expect(self.bidiStreaming.name.base == "BidirectionalStreaming")
+          #expect(self.unary.name.identifyingName == "Unary")
+          #expect(self.clientStreaming.name.identifyingName == "ClientStreaming")
+          #expect(self.serverStreaming.name.identifyingName == "ServerStreaming")
+          #expect(self.bidiStreaming.name.identifyingName == "BidirectionalStreaming")
         }
 
         @Test("Input")
@@ -181,31 +176,29 @@ struct ProtobufCodeGenParserTests {
     @Test("Service1")
     func service1() throws {
       let service = self.codeGen.services[0]
-      #expect(service.name.base == "FooService1")
-      #expect(service.namespace.base == "foo")
+      #expect(service.name.identifyingName == "foo.FooService1")
       #expect(service.methods.count == 1)
     }
 
     @Test("Service1.Method")
     func service1Method() throws {
       let method = self.codeGen.services[0].methods[0]
-      #expect(method.name.base == "Foo")
+      #expect(method.name.identifyingName == "Foo")
       #expect(method.inputType == "Foo_FooInput")
       #expect(method.outputType == "Foo_FooOutput")
     }
 
     @Test("Service2")
     func service2() throws {
       let service = self.codeGen.services[1]
-      #expect(service.name.base == "FooService2")
-      #expect(service.namespace.base == "foo")
+      #expect(service.name.identifyingName == "foo.FooService2")
       #expect(service.methods.count == 1)
     }
 
     @Test("Service2.Method")
     func service2Method() throws {
       let method = self.codeGen.services[1].methods[0]
-      #expect(method.name.base == "Foo")
+      #expect(method.name.identifyingName == "Foo")
       #expect(method.inputType == "Foo_FooInput")
       #expect(method.outputType == "Foo_FooOutput")
     }
@@ -227,12 +220,7 @@ struct ProtobufCodeGenParserTests {
 
     @Test("Service name")
     func serviceName() {
-      #expect(self.service.name.base == "BarService")
-    }
-
-    @Test("Service namespace")
-    func serviceNamespace() {
-      #expect(self.service.namespace.base == "")
+      #expect(self.service.name.identifyingName == "BarService")
     }
   }
 

Tests/GRPCProtobufCodeGenTests/ProtobufCodeGeneratorTests.swift

@@ -25,10 +25,10 @@ struct ProtobufCodeGeneratorTests {
     static let descriptorSetName = "test-service"
     static let fileDescriptorName = "test-service"
 
-    @Test("Generate", arguments: [SourceGenerator.Config.AccessLevel.internal, .public, .package])
-    func generate(accessLevel: SourceGenerator.Config.AccessLevel) throws {
+    @Test("Generate", arguments: [CodeGenerator.Config.AccessLevel.internal])
+    func generate(accessLevel: GRPCCodeGen.CodeGenerator.Config.AccessLevel) throws {
       let generator = ProtobufCodeGenerator(
-        config: SourceGenerator.Config(
+        config: CodeGenerator.Config(
           accessLevel: accessLevel,
           accessLevelOnImports: false,
           client: true,
@@ -1072,7 +1072,7 @@ struct ProtobufCodeGeneratorTests {
     @Test("Generate")
     func generate() throws {
       let generator = ProtobufCodeGenerator(
-        config: SourceGenerator.Config(
+        config: CodeGenerator.Config(
           accessLevel: .public,
           accessLevelOnImports: false,
           client: true,

Tests/GRPCProtobufCodeGenTests/Utilities.swift

@@ -21,7 +21,7 @@ import SwiftProtobufPluginLibrary
 import Testing
 
 import struct GRPCCodeGen.CodeGenerationRequest
-import struct GRPCCodeGen.SourceGenerator
+import struct GRPCCodeGen.CodeGenerator
 
 protocol UsesDescriptorSet {
   static var descriptorSetName: String { get }
@@ -71,7 +71,7 @@ private func loadDescriptorSet(
 func parseDescriptor(
   _ descriptor: FileDescriptor,
   extraModuleImports: [String] = [],
-  accessLevel: SourceGenerator.Config.AccessLevel = .internal
+  accessLevel: CodeGenerator.Config.AccessLevel = .internal
 ) throws -> CodeGenerationRequest {
   let parser = ProtobufCodeGenParser(
     protoFileModuleMappings: .init(),