Simplify generated code (#2131)

glbrntt · web-flow · commit d70fbad6c4c2 · 2024-11-26T13:30:52.000Z
Motivation:

A number of things have changed since the generated code was initially
designed, which means it can be simplified and improved.

Modifications:

- As services are namespaced within a namespace-service enum (rather
than within a service enum in a namespace enum), they no longer need to
be grouped by namespace.
- As deployment targets must be set in the package manifest, the
generated code no longer needs to be annotated with availability guards
so these have been removed.

Result:

Simpler code generation, better generated code.
diff --git a/Sources/GRPCCodeGen/Internal/Renderer/TextBasedRenderer.swift b/Sources/GRPCCodeGen/Internal/Renderer/TextBasedRenderer.swift
@@ -1134,8 +1134,9 @@ struct TextBasedRenderer: RendererProtocol {
   /// Renders the specified code block.
   func renderCodeBlock(_ description: CodeBlock) {
     if let comment = description.comment { renderComment(comment) }
-    let item = description.item
-    renderCodeBlockItem(item)
+    if let item = description.item {
+      renderCodeBlockItem(item)
+    }
   }
 
   /// Renders the specified code blocks.
diff --git a/Sources/GRPCCodeGen/Internal/StructuredSwift+Server.swift b/Sources/GRPCCodeGen/Internal/StructuredSwift+Server.swift
@@ -97,16 +97,13 @@ extension ExtensionDescription {
     return ExtensionDescription(
       onType: extensionName,
       declarations: [
-        .guarded(
-          .grpc,
-          .function(
-            .registerMethods(
-              accessLevel: accessLevel,
-              serviceNamespace: serviceNamespace,
-              methods: methods,
-              serializer: serializer,
-              deserializer: deserializer
-            )
+        .function(
+          .registerMethods(
+            accessLevel: accessLevel,
+            serviceNamespace: serviceNamespace,
+            methods: methods,
+            serializer: serializer,
+            deserializer: deserializer
           )
         )
       ]
diff --git a/Sources/GRPCCodeGen/Internal/StructuredSwift+ServiceMetadata.swift b/Sources/GRPCCodeGen/Internal/StructuredSwift+ServiceMetadata.swift
@@ -288,13 +288,10 @@ extension EnumDescription {
       typealiasNames.append("Client")
     }
     let typealiases: [Declaration] = typealiasNames.map { alias in
-      .guarded(
-        .grpc,
-        .typealias(
-          accessModifier: accessModifier,
-          name: alias,
-          existingType: .member(name + "_" + alias)
-        )
+      .typealias(
+        accessModifier: accessModifier,
+        name: alias,
+        existingType: .member(name + "_" + alias)
       )
     }
     description.members.append(contentsOf: typealiases)
diff --git a/Sources/GRPCCodeGen/Internal/StructuredSwift+Types.swift b/Sources/GRPCCodeGen/Internal/StructuredSwift+Types.swift
@@ -14,18 +14,6 @@
  * limitations under the License.
  */
 
-extension AvailabilityDescription {
-  package static let grpc = AvailabilityDescription(
-    osVersions: [
-      OSVersion(os: .macOS, version: "15.0"),
-      OSVersion(os: .iOS, version: "18.0"),
-      OSVersion(os: .watchOS, version: "11.0"),
-      OSVersion(os: .tvOS, version: "18.0"),
-      OSVersion(os: .visionOS, version: "2.0"),
-    ]
-  )
-}
-
 extension ExistingTypeDescription {
   fileprivate static func grpcCore(_ typeName: String) -> Self {
     return .member(["GRPCCore", typeName])
diff --git a/Sources/GRPCCodeGen/Internal/StructuredSwiftRepresentation.swift b/Sources/GRPCCodeGen/Internal/StructuredSwiftRepresentation.swift
@@ -1207,7 +1207,7 @@ struct CodeBlock: Equatable, Codable, Sendable {
   var comment: Comment?
 
   /// The code block item that appears below the comment.
-  var item: CodeBlockItem
+  var item: CodeBlockItem?
 }
 
 /// A description of a Swift file.
diff --git a/Sources/GRPCCodeGen/Internal/Translator/ClientCodeTranslator.swift b/Sources/GRPCCodeGen/Internal/Translator/ClientCodeTranslator.swift
@@ -79,22 +79,6 @@ struct ClientCodeTranslator {
   init() {}
 
   func translate(
-    accessModifier: AccessModifier,
-    services: [ServiceDescriptor],
-    serializer: (String) -> String,
-    deserializer: (String) -> String
-  ) -> [CodeBlock] {
-    services.flatMap { service in
-      self.translate(
-        accessModifier: accessModifier,
-        service: service,
-        serializer: serializer,
-        deserializer: deserializer
-      )
-    }
-  }
-
-  private func translate(
     accessModifier: AccessModifier,
     service: ServiceDescriptor,
     serializer: (String) -> String,
@@ -114,7 +98,7 @@ struct ClientCodeTranslator {
     blocks.append(
       CodeBlock(
         comment: .preFormatted(service.documentation),
-        item: .declaration(.guarded(.grpc, .protocol(clientProtocol)))
+        item: .declaration(.protocol(clientProtocol))
       )
     )
 
@@ -126,7 +110,7 @@ struct ClientCodeTranslator {
       deserializer: deserializer
     )
     blocks.append(
-      CodeBlock(item: .declaration(.guarded(.grpc, .extension(extensionWithDefaults))))
+      CodeBlock(item: .declaration(.extension(extensionWithDefaults)))
     )
 
     let extensionWithExplodedAPI: ExtensionDescription = .explodedClientMethods(
@@ -135,7 +119,7 @@ struct ClientCodeTranslator {
       methods: service.methods
     )
     blocks.append(
-      CodeBlock(item: .declaration(.guarded(.grpc, .extension(extensionWithExplodedAPI))))
+      CodeBlock(item: .declaration(.extension(extensionWithExplodedAPI)))
     )
 
     let clientStruct: StructDescription = .client(
@@ -148,7 +132,7 @@ struct ClientCodeTranslator {
     blocks.append(
       CodeBlock(
         comment: .preFormatted(service.documentation),
-        item: .declaration(.guarded(.grpc, .struct(clientStruct)))
+        item: .declaration(.struct(clientStruct))
       )
     )
 
diff --git a/Sources/GRPCCodeGen/Internal/Translator/IDLToStructuredSwiftTranslator.swift b/Sources/GRPCCodeGen/Internal/Translator/IDLToStructuredSwiftTranslator.swift
@@ -28,34 +28,50 @@ struct IDLToStructuredSwiftTranslator: Translator {
     try self.validateInput(codeGenerationRequest)
     let accessModifier = AccessModifier(accessLevel)
 
+    var codeBlocks: [CodeBlock] = []
     let metadataTranslator = MetadataTranslator()
-    var codeBlocks = metadataTranslator.translate(
-      accessModifier: accessModifier,
-      services: codeGenerationRequest.services,
-      client: client,
-      server: server
-    )
+    let serverTranslator = ServerCodeTranslator()
+    let clientTranslator = ClientCodeTranslator()
 
-    if server {
-      let translator = ServerCodeTranslator()
-      let blocks = translator.translate(
-        accessModifier: accessModifier,
-        services: codeGenerationRequest.services,
-        serializer: codeGenerationRequest.lookupSerializer,
-        deserializer: codeGenerationRequest.lookupDeserializer
+    for service in codeGenerationRequest.services {
+      codeBlocks.append(
+        CodeBlock(comment: .mark("\(service.fullyQualifiedName)", sectionBreak: true))
       )
-      codeBlocks.append(contentsOf: blocks)
-    }
 
-    if client {
-      let translator = ClientCodeTranslator()
-      let blocks = translator.translate(
+      let metadata = metadataTranslator.translate(
         accessModifier: accessModifier,
-        services: codeGenerationRequest.services,
-        serializer: codeGenerationRequest.lookupSerializer,
-        deserializer: codeGenerationRequest.lookupDeserializer
+        service: service,
+        client: client,
+        server: server
       )
-      codeBlocks.append(contentsOf: blocks)
+      codeBlocks.append(contentsOf: metadata)
+
+      if server {
+        codeBlocks.append(
+          CodeBlock(comment: .mark("\(service.fullyQualifiedName) (server)", sectionBreak: false))
+        )
+
+        let blocks = serverTranslator.translate(
+          accessModifier: accessModifier,
+          service: service,
+          serializer: codeGenerationRequest.lookupSerializer,
+          deserializer: codeGenerationRequest.lookupDeserializer
+        )
+        codeBlocks.append(contentsOf: blocks)
+      }
+
+      if client {
+        codeBlocks.append(
+          CodeBlock(comment: .mark("\(service.fullyQualifiedName) (client)", sectionBreak: false))
+        )
+        let blocks = clientTranslator.translate(
+          accessModifier: accessModifier,
+          service: service,
+          serializer: codeGenerationRequest.lookupSerializer,
+          deserializer: codeGenerationRequest.lookupDeserializer
+        )
+        codeBlocks.append(contentsOf: blocks)
+      }
     }
 
     let fileDescription = FileDescription(
diff --git a/Sources/GRPCCodeGen/Internal/Translator/MetadataTranslator.swift b/Sources/GRPCCodeGen/Internal/Translator/MetadataTranslator.swift
@@ -18,22 +18,6 @@ struct MetadataTranslator {
   init() {}
 
   func translate(
-    accessModifier: AccessModifier,
-    services: [ServiceDescriptor],
-    client: Bool,
-    server: Bool
-  ) -> [CodeBlock] {
-    return services.flatMap { service in
-      self.translate(
-        accessModifier: accessModifier,
-        service: service,
-        client: client,
-        server: server
-      )
-    }
-  }
-
-  private func translate(
     accessModifier: AccessModifier,
     service: ServiceDescriptor,
     client: Bool,
diff --git a/Sources/GRPCCodeGen/Internal/Translator/ServerCodeTranslator.swift b/Sources/GRPCCodeGen/Internal/Translator/ServerCodeTranslator.swift
@@ -61,22 +61,6 @@ struct ServerCodeTranslator {
   init() {}
 
   func translate(
-    accessModifier: AccessModifier,
-    services: [ServiceDescriptor],
-    serializer: (String) -> String,
-    deserializer: (String) -> String
-  ) -> [CodeBlock] {
-    return services.flatMap { service in
-      self.translate(
-        accessModifier: accessModifier,
-        service: service,
-        serializer: serializer,
-        deserializer: deserializer
-      )
-    }
-  }
-
-  private func translate(
     accessModifier: AccessModifier,
     service: ServiceDescriptor,
     serializer: (String) -> String,
@@ -106,7 +90,7 @@ struct ServerCodeTranslator {
     blocks.append(
       CodeBlock(
         comment: .preFormatted(service.documentation),
-        item: .declaration(.guarded(.grpc, .protocol(streamingServiceProtocol)))
+        item: .declaration(.protocol(streamingServiceProtocol))
       )
     )
 
@@ -122,7 +106,7 @@ struct ServerCodeTranslator {
     blocks.append(
       CodeBlock(
         comment: .doc("Conformance to `GRPCCore.RegistrableRPCService`."),
-        item: .declaration(.guarded(.grpc, .extension(registerExtension)))
+        item: .declaration(.extension(registerExtension))
       )
     )
 
@@ -136,7 +120,7 @@ struct ServerCodeTranslator {
     blocks.append(
       CodeBlock(
         comment: .preFormatted(service.documentation),
-        item: .declaration(.guarded(.grpc, .protocol(serviceProtocol)))
+        item: .declaration(.protocol(serviceProtocol))
       )
     )
 
@@ -150,7 +134,7 @@ struct ServerCodeTranslator {
     blocks.append(
       CodeBlock(
         comment: .doc("Partial conformance to `\(streamingServiceProtocolName)`."),
-        item: .declaration(.guarded(.grpc, .extension(streamingServiceDefaultImplExtension)))
+        item: .declaration(.extension(streamingServiceDefaultImplExtension))
       )
     )
 
diff --git a/Tests/GRPCCodeGenTests/Internal/StructuredSwift+MetadataTests.swift b/Tests/GRPCCodeGenTests/Internal/StructuredSwift+MetadataTests.swift
@@ -21,18 +21,6 @@ import Testing
 extension StructuedSwiftTests {
   @Suite("Metadata")
   struct Metadata {
-    @Test("@available(...)")
-    func grpcAvailability() async throws {
-      let availability: AvailabilityDescription = .grpc
-      let structDecl = StructDescription(name: "Ignored")
-      let expected = """
-        @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
-        struct Ignored {}
-        """
-
-      #expect(render(.guarded(availability, .struct(structDecl))) == expected)
-    }
-
     @Test("typealias Input = <Name>", arguments: AccessModifier.allCases)
     func methodInputTypealias(access: AccessModifier) {
       let decl: TypealiasDescription = .methodInput(accessModifier: access, name: "Foo")
@@ -263,9 +251,7 @@ extension StructuedSwiftTests {
 
       if config.server {
         expected += """
-            @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
             \(access) typealias StreamingServiceProtocol = Foo_StreamingServiceProtocol
-            @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
             \(access) typealias ServiceProtocol = Foo_ServiceProtocol
           """
       }
@@ -276,9 +262,7 @@ extension StructuedSwiftTests {
         }
 
         expected += """
-            @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
             \(access) typealias ClientProtocol = Foo_ClientProtocol
-            @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
             \(access) typealias Client = Foo_Client
           """
       }
diff --git a/Tests/GRPCCodeGenTests/Internal/Translator/ClientCodeTranslatorSnippetBasedTests.swift b/Tests/GRPCCodeGenTests/Internal/Translator/ClientCodeTranslatorSnippetBasedTests.swift
@@ -40,7 +40,6 @@ struct ClientCodeTranslatorSnippetBasedTests {
 
     let expectedSwift = """
       /// Documentation for ServiceA
-      @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
       public protocol NamespaceA_ServiceA_ClientProtocol: Sendable {
           /// Documentation for MethodA
           func methodA<Result>(
@@ -51,7 +50,6 @@ struct ClientCodeTranslatorSnippetBasedTests {
               onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<NamespaceA_ServiceAResponse>) async throws -> Result
           ) async throws -> Result where Result: Sendable
       }
-      @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
       extension NamespaceA_ServiceA.ClientProtocol {
           public func methodA<Result>(
               request: GRPCCore.ClientRequest<NamespaceA_ServiceARequest>,
@@ -69,7 +67,6 @@ struct ClientCodeTranslatorSnippetBasedTests {
               )
           }
       }
-      @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
       extension NamespaceA_ServiceA.ClientProtocol {
           /// Documentation for MethodA
           public func methodA<Result>(
@@ -92,7 +89,6 @@ struct ClientCodeTranslatorSnippetBasedTests {
           }
       }
       /// Documentation for ServiceA
-      @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
       public struct NamespaceA_ServiceA_Client: NamespaceA_ServiceA.ClientProtocol {
           private let client: GRPCCore.GRPCClient
 
@@ -131,7 +127,7 @@ struct ClientCodeTranslatorSnippetBasedTests {
     service: ServiceDescriptor
   ) -> String {
     let translator = ClientCodeTranslator()
-    let codeBlocks = translator.translate(accessModifier: accessLevel, services: [service]) {
+    let codeBlocks = translator.translate(accessModifier: accessLevel, service: service) {
       "GRPCProtobuf.ProtobufSerializer<\($0)>()"
     } deserializer: {
       "GRPCProtobuf.ProtobufDeserializer<\($0)>()"
diff --git a/Tests/GRPCCodeGenTests/Internal/Translator/IDLToStructuredSwiftTranslatorSnippetBasedTests.swift b/Tests/GRPCCodeGenTests/Internal/Translator/IDLToStructuredSwiftTranslatorSnippetBasedTests.swift
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
`@@ -288,13 +288,10 @@ extension EnumDescription {`
`288`	`288`	`typealiasNames.append("Client")`
`289`	`289`	`}`
`290`	`290`	`let typealiases: [Declaration] = typealiasNames.map { alias in`
`291`		`- .guarded(`
`292`		`- .grpc,`
`293`		`- .typealias(`
`294`		`- accessModifier: accessModifier,`
`295`		`- name: alias,`
`296`		`- existingType: .member(name + "_" + alias)`
`297`		`- )`
	`291`	`+ .typealias(`
	`292`	`+ accessModifier: accessModifier,`
	`293`	`+ name: alias,`
	`294`	`+ existingType: .member(name + "_" + alias)`
`298`	`295`	`)`
`299`	`296`	`}`
`300`	`297`	`description.members.append(contentsOf: typealiases)`
Original file line number	Diff line number	Diff line change
`@@ -1207,7 +1207,7 @@ struct CodeBlock: Equatable, Codable, Sendable {`
`1207`	`1207`	`var comment: Comment?`
`1208`	`1208`
`1209`	`1209`	`/// The code block item that appears below the comment.`
`1210`		`- var item: CodeBlockItem`
	`1210`	`+ var item: CodeBlockItem?`
`1211`	`1211`	`}`
`1212`	`1212`
`1213`	`1213`	`/// A description of a Swift file.`