Use JSKit runtime from SwiftPM resources

.github/workflows/swift.yml

@@ -13,13 +13,14 @@ jobs:
         include:
           - os: macos-12
             swift_version: 5.6
-            xcode: /Applications/Xcode_13.3.app/Contents/Developer
+            xcode: /Applications/Xcode_13.4.app/Contents/Developer
           - os: macos-11
             swift_version: 5.5
             xcode: /Applications/Xcode_13.2.1.app/Contents/Developer
           - os: ubuntu-20.04
             swift_version: 5.5
     name: Build on ${{ matrix.os }} with Swift ${{ matrix.swift_version }}
+    timeout-minutes: 40
     runs-on: ${{ matrix.os }}
 
     steps:

.swiftformat

@@ -6,5 +6,5 @@
 --ifdef noindent
 --stripunusedargs closure-only
 --disable andOperator
---swiftversion 5.2
---maxwidth 100
+--swiftversion 5.5
+--maxwidth 120

Package.swift

@@ -33,7 +33,7 @@ let package = Package(
       url: "https://github.com/apple/swift-tools-support-core.git",
       .branch("release/5.6")
     ),
-    .package(url: "https://github.com/vapor/vapor.git", from: "4.53.0"),
+    .package(url: "https://github.com/vapor/vapor.git", from: "4.57.1"),
     .package(url: "https://github.com/apple/swift-crypto.git", from: "1.1.0"),
     .package(url: "https://github.com/JohnSundell/Splash.git", from: "0.16.0"),
     .package(

Sources/CartonCLI/Commands/TestRunners/NodeTestRunner.swift

@@ -1,4 +1,4 @@
-// Copyright 2020 Carton contributors
+// Copyright 2022 Carton contributors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,16 +21,39 @@ private enum Constants {
   static let entrypoint = Entrypoint(fileName: "testNode.js", sha256: testNodeEntrypointSHA256)
 }
 
+/// Test runner for Node.js.
 struct NodeTestRunner: TestRunner {
   let testFilePath: AbsolutePath
   let listTestCases: Bool
   let testCases: [String]
   let terminal: InteractiveWriter
 
   func run() async throws {
-    terminal.write("\nRunning the test bundle with NodeJS:\n", inColor: .yellow)
-    let (_, _, filePath) = Constants.entrypoint.paths(on: localFileSystem)
-    var nodeArguments = ["node", filePath.pathString, testFilePath.pathString]
+    terminal.write("\nRunning the test bundle with Node.js:\n", inColor: .yellow)
+
+    let (_, _, entrypointPath) = Constants.entrypoint.paths(on: localFileSystem)
+
+    // Allow Node.js to resolve modules from resource directories by making them relative to the entrypoint path.
+    let buildDirectory = testFilePath.parentDirectory
+    let staticDirectory = entrypointPath.parentDirectory
+
+    // Clean up existing symlinks before creating new ones.
+    for existingSymlink in try localFileSystem.resourcesDirectoryNames(relativeTo: staticDirectory) {
+      try localFileSystem.removeFileTree(staticDirectory.appending(component: existingSymlink))
+    }
+
+    let resourceDirectories = try localFileSystem.resourcesDirectoryNames(relativeTo: buildDirectory)
+
+    // Create new symlink for each resource directory.
+    for resourcesDirectoryName in resourceDirectories {
+      try localFileSystem.createSymbolicLink(
+        staticDirectory.appending(component: resourcesDirectoryName),
+        pointingAt: buildDirectory.appending(component: resourcesDirectoryName),
+        relative: false
+      )
+    }
+
+    var nodeArguments = ["node", entrypointPath.pathString, testFilePath.pathString]
     if listTestCases {
       nodeArguments.append(contentsOf: ["--", "-l"])
     } else if !testCases.isEmpty {
@@ -39,5 +62,4 @@ struct NodeTestRunner: TestRunner {
     }
     try await Process.run(nodeArguments, terminal)
   }
-
 }

Sources/CartonHelpers/Process.swift

@@ -65,13 +65,18 @@ public extension TSCBasic.Process {
   // swiftlint:disable:next function_body_length
   static func run(
     _ arguments: [String],
+    environment: [String: String] = [:],
     loadingMessage: String = "Running...",
     parser: ProcessOutputParser? = nil,
     _ terminal: InteractiveWriter
   ) async throws {
     terminal.clearLine()
     terminal.write("\(loadingMessage)\n", inColor: .yellow)
 
+    if !environment.isEmpty {
+      terminal.write(environment.map { "\($0)=\($1)" }.joined(separator: " ") + " ")
+    }
+
     let processName = arguments[0].first == "/" ?
       AbsolutePath(arguments[0]).basename : arguments[0]
 
@@ -98,6 +103,7 @@ public extension TSCBasic.Process {
 
           let process = Process(
             arguments: arguments,
+            environment: ProcessEnv.vars.merging(environment) { _, new in new },
             outputRedirection: .stream(stdout: stdout, stderr: stderr),
             verbose: true,
             startNewProcessGroup: true

Sources/CartonKit/Server/Application.swift

@@ -60,22 +60,27 @@ extension Application {
 
     get("main.wasm") {
       // stream the file
-      $0.eventLoop
-        .makeSucceededFuture($0.fileio.streamFile(at: configuration.mainWasmPath.pathString))
+      $0.fileio.streamFile(at: configuration.mainWasmPath.pathString)
     }
 
     // Serve resources for all targets at their respective paths.
     let buildDirectory = configuration.mainWasmPath.parentDirectory
 
-    for directoryName in try localFileSystem.resourcesDirectoryNames(relativeTo: buildDirectory) {
-      get(.constant(directoryName), "**") {
-        $0.eventLoop.makeSucceededFuture($0.fileio.streamFile(at: AbsolutePath(
-          buildDirectory.appending(component: directoryName),
-          $0.parameters.getCatchall().joined(separator: "/")
-        ).pathString))
+    func requestHandler(_ directoryName: String) -> ((Request) -> Response) {
+      { (request: Request) -> Response in
+        request.fileio.streamFile(
+          at: AbsolutePath(
+            buildDirectory.appending(component: directoryName),
+            request.parameters.getCatchall().joined(separator: "/")
+          ).pathString
+        )
       }
     }
 
+    for directoryName in try localFileSystem.resourcesDirectoryNames(relativeTo: buildDirectory) {
+      get(.constant(directoryName), "**", use: requestHandler(directoryName))
+    }
+
     let inferredMainTarget = configuration.manifest.targets.first {
       configuration.product?.targets.contains($0.name) == true
     }
@@ -84,11 +89,6 @@ extension Application {
     guard let mainTarget = inferredMainTarget else { return }
 
     let resourcesPath = configuration.manifest.resourcesPath(for: mainTarget)
-    get("**") {
-      $0.eventLoop.makeSucceededFuture($0.fileio.streamFile(at: AbsolutePath(
-        buildDirectory.appending(component: resourcesPath),
-        $0.parameters.getCatchall().joined(separator: "/")
-      ).pathString))
-    }
+    get("**", use: requestHandler(resourcesPath))
   }
 }

Sources/CartonKit/Server/HTML.swift

@@ -53,7 +53,7 @@ extension HTML: ResponseEncodable {
   }
 
   public static func indexPage(customContent: String?, entrypointName: String) -> String {
-    let scriptTag = #"<script type="text/javascript" src="\#(entrypointName)"></script>"#
+    let scriptTag = #"<script type="module" src="\#(entrypointName)"></script>"#
     if let customContent = customContent {
       return customContent.replacingOccurrences(
         of: "</head>",

Sources/CartonKit/Server/Server.swift

@@ -229,7 +229,7 @@ public actor Server {
   /// Blocking function that starts the HTTP server.
   public nonisolated func run() async throws {
     // Explicitly hop to another thread to avoid blocking the thread that is running the actor executor
-    try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Void, Error>) in
+    try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<(), Error>) in
       Thread {
         Task {
           do {

Sources/SwiftToolchain/Toolchain.swift

@@ -19,7 +19,7 @@ import TSCBasic
 import TSCUtility
 import WasmTransformer
 
-public let compatibleJSKitVersion = Version(0, 14, 0)
+public let compatibleJSKitVersion = Version(0, 15, 0)
 
 enum ToolchainError: Error, CustomStringConvertible {
   case directoryDoesNotExist(AbsolutePath)
@@ -86,10 +86,10 @@ extension PackageDependency {
     default: break
     }
     if let exactVersion = exactVersion {
-      return exactVersion == compatibleJSKitVersion
+      return exactVersion >= compatibleJSKitVersion
     }
     if let versionRange = versionRange {
-      return versionRange.upperBound >= compatibleJSKitVersion
+      return versionRange.lowerBound >= compatibleJSKitVersion
     }
     return false
   }
@@ -127,7 +127,8 @@ public final class Toolchain {
     self.terminal = terminal
     if let workingDirectory = fileSystem.currentWorkingDirectory {
       let swiftc = swiftPath.parentDirectory.appending(component: "swiftc")
-      manifest = await Result { try await Manifest.from(path: workingDirectory, swiftc: swiftc, fileSystem: fileSystem, terminal: terminal)
+      manifest = await Result {
+        try await Manifest.from(path: workingDirectory, swiftc: swiftc, fileSystem: fileSystem, terminal: terminal)
       }
     } else {
       manifest = .failure(ToolchainError.noWorkingDirectory)
@@ -147,7 +148,7 @@ public final class Toolchain {
   }
 
   private func inferDevProduct(hint: String?) throws -> ProductDescription? {
-    let manifest = try self.manifest.get()
+    let manifest = try manifest.get()
 
     var candidateProducts = manifest.products
       .filter { $0.type == .executable }
@@ -201,7 +202,7 @@ public final class Toolchain {
   }
 
   public func inferSourcesPaths() throws -> [AbsolutePath] {
-    let manifest = try self.manifest.get()
+    let manifest = try manifest.get()
 
     let targetPaths = manifest.targets.compactMap { target -> String? in
 
@@ -224,7 +225,7 @@ public final class Toolchain {
   }
 
   private func emitJSKitWarningIfNeeded() throws {
-    let manifest = try self.manifest.get()
+    let manifest = try manifest.get()
     guard let jsKit = manifest.dependencies.first(where: {
       $0.nameForTargetDependencyResolutionOnly == "JavaScriptKit"
     }) else {
@@ -305,7 +306,7 @@ public final class Toolchain {
   public func buildTestBundle(
     flavor: BuildFlavor
   ) async throws -> AbsolutePath {
-    let manifest = try self.manifest.get()
+    let manifest = try manifest.get()
     let binPath = try inferBinPath(isRelease: flavor.isRelease)
     let testProductName = "\(manifest.displayName)PackageTests"
     let testBundlePath = binPath.appending(component: "\(testProductName).wasm")

Sources/carton-release/HashArchive.swift

@@ -45,16 +45,34 @@ struct HashArchive: AsyncParsableCommand {
     )
 
     try localFileSystem.createDirectory(dotFilesStaticPath, recursive: true)
-    let hashes = try await ["dev", "bundle", "test", "testNode"].asyncMap { entrypoint -> (String, String) in
-      try await Process.run(["npm", "run", entrypoint], terminal)
-      let entrypointPath = AbsolutePath(staticPath, "\(entrypoint).js")
-      let dotFilesEntrypointPath = dotFilesStaticPath.appending(component: "\(entrypoint).js")
-      try localFileSystem.removeFileTree(dotFilesEntrypointPath)
-      try localFileSystem.copy(from: entrypointPath, to: dotFilesEntrypointPath)
-
-      return (entrypoint, try SHA256().hash(localFileSystem.readFileContents(entrypointPath))
-        .hexadecimalRepresentation.uppercased())
-    }
+    let hashes = try await (["dev", "bundle", "test", "testNode"])
+      .asyncMap { entrypoint -> (String, String) in
+        let filename = "\(entrypoint).js"
+        var arguments = [
+          "npx", "esbuild", "--bundle", "entrypoint/\(filename)", "--outfile=static/\(filename)",
+        ]
+
+        if entrypoint == "testNode" {
+          arguments.append(contentsOf: [
+            "--format=cjs", "--platform=node",
+            "--external:./JavaScriptKit_JavaScriptKit.resources/Runtime/index.js",
+          ])
+        } else {
+          arguments.append(contentsOf: [
+            "--format=esm",
+            "--external:./JavaScriptKit_JavaScriptKit.resources/Runtime/index.mjs",
+          ])
+        }
+
+        try await Process.run(arguments, terminal)
+        let entrypointPath = AbsolutePath(staticPath, filename)
+        let dotFilesEntrypointPath = dotFilesStaticPath.appending(component: filename)
+        try localFileSystem.removeFileTree(dotFilesEntrypointPath)
+        try localFileSystem.copy(from: entrypointPath, to: dotFilesEntrypointPath)
+
+        return (entrypoint, try SHA256().hash(localFileSystem.readFileContents(entrypointPath))
+          .hexadecimalRepresentation.uppercased())
+      }
 
     try localFileSystem.writeFileContents(
       staticPath.appending(component: "so_sanitizer.wasm"),
@@ -83,10 +101,8 @@ struct HashArchive: AsyncParsableCommand {
       public let \($0)EntrypointSHA256 = ByteString([
       \(arrayString(from: $1))
       ])
-
-
       """
-    }.joined())
+    }.joined(separator: "\n\n"))
 
     public let staticArchiveContents = "\(staticArchiveContents.withData { $0.base64EncodedString() })"
     """