Add preliminary support for Embedded Swift in recipes

Author: MaxDesiatov

Package.resolved

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.8
+// swift-tools-version: 5.9
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

Package.swift

@@ -34,7 +34,7 @@ extension Triple.Arch {
 }
 
 extension SwiftSDKGenerator {
-  public func run(recipe: SwiftSDKRecipe) async throws {
+  package func run(recipe: SwiftSDKRecipe) async throws {
     try await withQueryEngine(OSFileSystem(), self.logger, cacheLocation: self.engineCachePath) {
       engine in
       let httpClientType: HTTPClientProtocol.Type
@@ -58,13 +58,29 @@ extension SwiftSDKGenerator {
 
         let toolsetJSONPath = try await self.generateToolsetJSON(recipe: recipe)
 
-        try await generateDestinationJSON(
-          toolsetPath: toolsetJSONPath,
-          sdkDirPath: swiftSDKProduct.sdkDirPath,
-          recipe: recipe
-        )
+        var artifacts = try await [
+          self.artifactID: generateSwiftSDKMetadata(
+            toolsetPath: toolsetJSONPath,
+            sdkDirPath: swiftSDKProduct.sdkDirPath,
+            recipe: recipe
+          )
+        ]
+
+        if recipe.shouldSupportEmbeddedSwift {
+          let toolsetJSONPath = try await self.generateToolsetJSON(recipe: recipe, isForEmbeddedSwift: true)
 
-        try await generateArtifactBundleManifest(hostTriples: swiftSDKProduct.hostTriples)
+          artifacts["\(self.artifactID)-embedded"] = try await generateSwiftSDKMetadata(
+            toolsetPath: toolsetJSONPath,
+            sdkDirPath: swiftSDKProduct.sdkDirPath,
+            recipe: recipe,
+            isForEmbeddedSwift: true
+          )
+        }
+
+        try await generateArtifactBundleManifest(
+          hostTriples: swiftSDKProduct.hostTriples,
+          artifacts: artifacts
+        )
 
         // Extra spaces added for readability for the user
         print(

Sources/SwiftSDKGenerator/Generator/SwiftSDKGenerator+Entrypoint.swift

@@ -21,10 +21,10 @@ private let encoder: JSONEncoder = {
 }()
 
 extension SwiftSDKGenerator {
-  func generateToolsetJSON(recipe: SwiftSDKRecipe) throws -> FilePath {
+  func generateToolsetJSON(recipe: SwiftSDKRecipe, isForEmbeddedSwift: Bool = false) throws -> FilePath {
     logger.info("Generating toolset JSON file...")
 
-    let toolsetJSONPath = pathsConfiguration.swiftSDKRootPath.appending("toolset.json")
+    let toolsetJSONPath = pathsConfiguration.swiftSDKRootPath.appending("\(isForEmbeddedSwift ? "embedded-" : "")toolset.json")
 
     var relativeToolchainBinDir = pathsConfiguration.toolchainBinDirPath
 
@@ -37,18 +37,21 @@ extension SwiftSDKGenerator {
     }
 
     var toolset = Toolset(rootPath: relativeToolchainBinDir.string)
-    recipe.applyPlatformOptions(toolset: &toolset, targetTriple: self.targetTriple)
+    recipe.applyPlatformOptions(toolset: &toolset, targetTriple: self.targetTriple, isForEmbeddedSwift: isForEmbeddedSwift)
     try writeFile(at: toolsetJSONPath, encoder.encode(toolset))
 
     return toolsetJSONPath
   }
 
-  func generateDestinationJSON(toolsetPath: FilePath, sdkDirPath: FilePath, recipe: SwiftSDKRecipe)
-    throws
-  {
-    logger.info("Generating destination JSON file...")
+  func generateSwiftSDKMetadata(
+    toolsetPath: FilePath,
+    sdkDirPath: FilePath,
+    recipe: SwiftSDKRecipe,
+    isForEmbeddedSwift: Bool = false
+  ) throws -> FilePath {
+    logger.info("Generating Swift SDK metadata JSON file...")
 
-    let destinationJSONPath = pathsConfiguration.swiftSDKRootPath.appending("swift-sdk.json")
+    let destinationJSONPath = pathsConfiguration.swiftSDKRootPath.appending("\(isForEmbeddedSwift ? "embedded-" : "")swift-sdk.json")
 
     var relativeToolchainBinDir = pathsConfiguration.toolchainBinDirPath
     var relativeSDKDir = sdkDirPath
@@ -75,7 +78,8 @@ extension SwiftSDKGenerator {
     recipe.applyPlatformOptions(
       metadata: &metadata,
       paths: pathsConfiguration,
-      targetTriple: self.targetTriple
+      targetTriple: self.targetTriple,
+      isForEmbeddedSwift: isForEmbeddedSwift
     )
 
     try writeFile(
@@ -88,9 +92,11 @@ extension SwiftSDKGenerator {
         )
       )
     )
+
+    return destinationJSONPath
   }
 
-  func generateArtifactBundleManifest(hostTriples: [Triple]?) throws {
+  func generateArtifactBundleManifest(hostTriples: [Triple]?, artifacts: [String: FilePath]) throws {
     logger.info("Generating .artifactbundle info JSON file...")
 
     let artifactBundleManifestPath = pathsConfiguration.artifactBundlePath.appending("info.json")
@@ -100,18 +106,18 @@ extension SwiftSDKGenerator {
       encoder.encode(
         ArtifactsArchiveMetadata(
           schemaVersion: "1.0",
-          artifacts: [
-            artifactID: .init(
+          artifacts: artifacts.mapValues {
+            .init(
               type: .swiftSDK,
               version: self.bundleVersion,
               variants: [
                 .init(
-                  path: FilePath(artifactID).appending(self.targetTriple.triple).string,
+                  path: $0.string,
                   supportedTriples: hostTriples.map { $0.map(\.triple) }
                 )
               ]
             )
-          ]
+          }
         )
       )
     )

Sources/SwiftSDKGenerator/Generator/SwiftSDKGenerator+Metadata.swift

@@ -16,14 +16,14 @@ import Logging
 
 import struct SystemPackage.FilePath
 
-public struct LinuxRecipe: SwiftSDKRecipe {
-  public enum TargetSwiftSource: Sendable {
+package struct LinuxRecipe: SwiftSDKRecipe {
+  package enum TargetSwiftSource: Sendable {
     case docker(baseSwiftDockerImage: String)
     case localPackage(FilePath)
     case remoteTarball
   }
 
-  public enum HostSwiftSource: Sendable, Equatable {
+  package enum HostSwiftSource: Sendable, Equatable {
     case localPackage(FilePath)
     case remoteTarball
     case preinstalled
@@ -35,7 +35,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
   let targetSwiftSource: TargetSwiftSource
   let hostSwiftSource: HostSwiftSource
   let versionsConfiguration: VersionsConfiguration
-  public let logger: Logger
+  package let logger: Logger
 
   var shouldUseDocker: Bool {
     if case .docker = self.targetSwiftSource {
@@ -44,7 +44,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     return false
   }
 
-  public init(
+  package init(
     targetTriple: Triple,
     hostTriple: Triple,
     linuxDistribution: LinuxDistribution,
@@ -98,7 +98,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     )
   }
 
-  public init(
+  package init(
     mainTargetTriple: Triple,
     mainHostTriple: Triple,
     linuxDistribution: LinuxDistribution,
@@ -116,7 +116,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     self.logger = logger
   }
 
-  public func applyPlatformOptions(toolset: inout Toolset, targetTriple: Triple) {
+  package func applyPlatformOptions(toolset: inout Toolset, targetTriple: Triple, isForEmbeddedSwift: Bool) {
     if self.hostSwiftSource == .preinstalled {
       toolset.rootPath = nil
     }
@@ -146,10 +146,11 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     toolset.librarian = Toolset.ToolProperties(path: "llvm-ar")
   }
 
-  public func applyPlatformOptions(
+  package func applyPlatformOptions(
     metadata: inout SwiftSDKMetadataV4.TripleProperties,
     paths: PathsConfiguration,
-    targetTriple: Triple
+    targetTriple: Triple,
+    isForEmbeddedSwift: Bool
   ) {
     var relativeSDKDir = self.sdkDirPath(paths: paths)
     guard relativeSDKDir.removePrefix(paths.swiftSDKRootPath) else {
@@ -159,7 +160,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     metadata.swiftStaticResourcesPath = relativeSDKDir.appending("usr/lib/swift_static").string
   }
 
-  public var defaultArtifactID: String {
+  package var defaultArtifactID: String {
     """
     \(self.versionsConfiguration.swiftVersion)_\(self.linuxDistribution.name.rawValue)_\(
       self.linuxDistribution
@@ -219,7 +220,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     return [self.mainHostTriple]
   }
 
-  public func makeSwiftSDK(
+  package func makeSwiftSDK(
     generator: SwiftSDKGenerator,
     engine: QueryEngine,
     httpClient client: some HTTPClientProtocol