From bf5b1e0c29fed85713fd4a57bdd11fb39078f71f Mon Sep 17 00:00:00 2001 From: Yuta Saito Date: Thu, 5 Jun 2025 18:38:41 +0900 Subject: [PATCH 1/3] PackageToJS: Add hint for missing `.enableExperimentalFeature("Extern")` setting --- .../Sources/PackageToJSPlugin.swift | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/Plugins/PackageToJS/Sources/PackageToJSPlugin.swift b/Plugins/PackageToJS/Sources/PackageToJSPlugin.swift index e7f74e97..04f4dcd4 100644 --- a/Plugins/PackageToJS/Sources/PackageToJSPlugin.swift +++ b/Plugins/PackageToJS/Sources/PackageToJSPlugin.swift @@ -71,6 +71,27 @@ struct PackageToJSPlugin: CommandPlugin { See https://book.swiftwasm.org/getting-started/setup.html for more information. """ }), + ( + // In case the SwiftPM target using BridgeJS didn't specify `.enableExperimentalFeature("Extern")` + { build, arguments in + guard + build.logText.contains("@_extern requires '-enable-experimental-feature Extern'") + else { + return nil + } + return """ + The SwiftPM target using BridgeJS didn't specify `.enableExperimentalFeature("Extern")`. + Please add it to the target's `swiftSettings` configuration. + + For example: + ```swift + dependencies: [...], + swiftSettings: [ + .enableExperimentalFeature("Extern"), + ] + ``` + """ + }), ] private func emitHintMessage(_ message: String) { From 80821febe9462731e7f2bbd3908822b60851c07c Mon Sep 17 00:00:00 2001 From: Yuta Saito Date: Thu, 5 Jun 2025 21:05:26 +0900 Subject: [PATCH 2/3] PackageToJS: Fail tests when continuation leaks are detected --- .../SwiftTesting/Package.swift | 17 +++++++++ .../SwiftTesting/Tests/CheckTests.swift | 5 +++ .../XCTest/Package.swift | 17 +++++++++ .../XCTest/Tests/CheckTests.swift | 7 ++++ Plugins/PackageToJS/Templates/bin/test.js | 13 +++++++ Plugins/PackageToJS/Tests/ExampleTests.swift | 35 ++++++++++++++++--- 6 files changed, 89 insertions(+), 5 deletions(-) create mode 100644 Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Package.swift create mode 100644 Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Tests/CheckTests.swift create mode 100644 Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Package.swift create mode 100644 Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Tests/CheckTests.swift diff --git a/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Package.swift b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Package.swift new file mode 100644 index 00000000..84130401 --- /dev/null +++ b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Package.swift @@ -0,0 +1,17 @@ +// swift-tools-version: 6.0 +import PackageDescription + +let package = Package( + name: "Check", + dependencies: [.package(name: "JavaScriptKit", path: "../../../../../")], + targets: [ + .testTarget( + name: "CheckTests", + dependencies: [ + "JavaScriptKit", + .product(name: "JavaScriptEventLoopTestSupport", package: "JavaScriptKit"), + ], + path: "Tests" + ) + ] +) diff --git a/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Tests/CheckTests.swift b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Tests/CheckTests.swift new file mode 100644 index 00000000..9ed73b7c --- /dev/null +++ b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting/Tests/CheckTests.swift @@ -0,0 +1,5 @@ +import Testing + +@Test func never() async throws { + let _: Void = await withUnsafeContinuation { _ in } +} diff --git a/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Package.swift b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Package.swift new file mode 100644 index 00000000..84130401 --- /dev/null +++ b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Package.swift @@ -0,0 +1,17 @@ +// swift-tools-version: 6.0 +import PackageDescription + +let package = Package( + name: "Check", + dependencies: [.package(name: "JavaScriptKit", path: "../../../../../")], + targets: [ + .testTarget( + name: "CheckTests", + dependencies: [ + "JavaScriptKit", + .product(name: "JavaScriptEventLoopTestSupport", package: "JavaScriptKit"), + ], + path: "Tests" + ) + ] +) diff --git a/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Tests/CheckTests.swift b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Tests/CheckTests.swift new file mode 100644 index 00000000..324df370 --- /dev/null +++ b/Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest/Tests/CheckTests.swift @@ -0,0 +1,7 @@ +import XCTest + +final class CheckTests: XCTestCase { + func testNever() async throws { + let _: Void = await withUnsafeContinuation { _ in } + } +} diff --git a/Plugins/PackageToJS/Templates/bin/test.js b/Plugins/PackageToJS/Templates/bin/test.js index f4aad4b8..34031628 100644 --- a/Plugins/PackageToJS/Templates/bin/test.js +++ b/Plugins/PackageToJS/Templates/bin/test.js @@ -68,6 +68,19 @@ const harnesses = { options = prelude.setupOptions(options, { isMainThread: true }) } } + process.on("beforeExit", () => { + // NOTE: "beforeExit" is fired when the process exits gracefully without calling `process.exit` + // Either XCTest or swift-testing should always call `process.exit` through `proc_exit` even + // if the test succeeds. So exiting gracefully means something went wrong (e.g. withUnsafeContinuation is leaked) + // Therefore, we exit with code 1 to indicate that the test execution failed. + console.error(` + +================================================================================================= +Detected that the test execution ended without a termination signal from the testing framework. +Hint: This typically means that a continuation leak occurred. +=================================================================================================`) + process.exit(1) + }) await instantiate(options) } catch (e) { if (e instanceof WebAssembly.CompileError) { diff --git a/Plugins/PackageToJS/Tests/ExampleTests.swift b/Plugins/PackageToJS/Tests/ExampleTests.swift index ab0d1d79..9c5f260d 100644 --- a/Plugins/PackageToJS/Tests/ExampleTests.swift +++ b/Plugins/PackageToJS/Tests/ExampleTests.swift @@ -88,7 +88,6 @@ extension Trait where Self == ConditionTrait { atPath: destinationPath.path, withDestinationPath: linkDestination ) - enumerator.skipDescendants() continue } @@ -117,8 +116,11 @@ extension Trait where Self == ConditionTrait { typealias RunProcess = (_ executableURL: URL, _ args: [String], _ env: [String: String]) throws -> Void typealias RunSwift = (_ args: [String], _ env: [String: String]) throws -> Void - func withPackage(at path: String, body: (URL, _ runProcess: RunProcess, _ runSwift: RunSwift) throws -> Void) throws - { + func withPackage( + at path: String, + assertTerminationStatus: (Int32) -> Bool = { $0 == 0 }, + body: @escaping (URL, _ runProcess: RunProcess, _ runSwift: RunSwift) throws -> Void + ) throws { try withTemporaryDirectory { tempDir, retain in let destination = tempDir.appending(path: Self.repoPath.lastPathComponent) try Self.copyRepository(to: destination) @@ -139,11 +141,11 @@ extension Trait where Self == ConditionTrait { try process.run() process.waitUntilExit() - if process.terminationStatus != 0 { + if !assertTerminationStatus(process.terminationStatus) { retain = true } try #require( - process.terminationStatus == 0, + assertTerminationStatus(process.terminationStatus), """ Swift package should build successfully, check \(destination.appending(path: path).path) for details stdout: \(stdoutPath.path) @@ -275,4 +277,27 @@ extension Trait where Self == ConditionTrait { ) } } + + @Test(.requireSwiftSDK) + func continuationLeakInTest_XCTest() throws { + let swiftSDKID = try #require(Self.getSwiftSDKID()) + try withPackage( + at: "Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/XCTest", + assertTerminationStatus: { $0 != 0 } + ) { packageDir, _, runSwift in + try runSwift(["package", "--disable-sandbox", "--swift-sdk", swiftSDKID, "js", "test"], [:]) + } + } + + // TODO: Remove triple restriction once swift-testing is shipped in p1-threads SDK + @Test(.requireSwiftSDK(triple: "wasm32-unknown-wasi")) + func continuationLeakInTest_SwiftTesting() throws { + let swiftSDKID = try #require(Self.getSwiftSDKID()) + try withPackage( + at: "Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting", + assertTerminationStatus: { $0 == 0 } + ) { packageDir, _, runSwift in + try runSwift(["package", "--disable-sandbox", "--swift-sdk", swiftSDKID, "js", "test"], [:]) + } + } } From f7ca331455d8985be319ddff9cbbba0bb13450bd Mon Sep 17 00:00:00 2001 From: Yuta Saito Date: Thu, 5 Jun 2025 21:22:12 +0900 Subject: [PATCH 3/3] Testing module is not included in 6.0 SDK --- Plugins/PackageToJS/Tests/ExampleTests.swift | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Plugins/PackageToJS/Tests/ExampleTests.swift b/Plugins/PackageToJS/Tests/ExampleTests.swift index 9c5f260d..d860a685 100644 --- a/Plugins/PackageToJS/Tests/ExampleTests.swift +++ b/Plugins/PackageToJS/Tests/ExampleTests.swift @@ -289,15 +289,17 @@ extension Trait where Self == ConditionTrait { } } + #if compiler(>=6.1) // TODO: Remove triple restriction once swift-testing is shipped in p1-threads SDK @Test(.requireSwiftSDK(triple: "wasm32-unknown-wasi")) func continuationLeakInTest_SwiftTesting() throws { let swiftSDKID = try #require(Self.getSwiftSDKID()) try withPackage( at: "Plugins/PackageToJS/Fixtures/ContinuationLeakInTest/SwiftTesting", - assertTerminationStatus: { $0 == 0 } + assertTerminationStatus: { $0 != 0 } ) { packageDir, _, runSwift in try runSwift(["package", "--disable-sandbox", "--swift-sdk", swiftSDKID, "js", "test"], [:]) } } + #endif }