Skip to content

Stop using higher-order functions to convert JSValues to RawJSValues #346

New issue

Have a question about this project? No Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “No Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? No Sign in to your account

Merged
merged 3 commits into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Examples/Testing/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"devDependencies": {
"playwright": "^1.52.0"
}
}
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ SWIFT_SDK_ID ?= wasm32-unknown-wasi
.PHONY: bootstrap
bootstrap:
npm ci
npx playwright install

.PHONY: unittest
unittest:
Expand Down
7 changes: 6 additions & 1 deletion Plugins/PackageToJS/Templates/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@
"dependencies": {
"@bjorn3/browser_wasi_shim": "0.3.0"
},
"devDependencies": {
"peerDependencies": {
"playwright": "^1.51.0"
},
"peerDependenciesMeta": {
"playwright": {
"optional": true
}
}
}
55 changes: 31 additions & 24 deletions Plugins/PackageToJS/Tests/ExampleTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -114,20 +114,17 @@ 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, _ runSwift: RunSwift) throws -> Void) throws {
func withPackage(at path: String, body: (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)
try body(destination.appending(path: path)) { args, env in
func runProcess(_ executableURL: URL, _ args: [String], _ env: [String: String]) throws {
let process = Process()
process.executableURL = URL(
fileURLWithPath: "swift",
relativeTo: URL(
fileURLWithPath: try #require(Self.getSwiftPath())
)
)
process.executableURL = executableURL
process.arguments = args
process.currentDirectoryURL = destination.appending(path: path)
process.environment = ProcessInfo.processInfo.environment.merging(env) { _, new in
Expand Down Expand Up @@ -157,13 +154,21 @@ extension Trait where Self == ConditionTrait {
"""
)
}
func runSwift(_ args: [String], _ env: [String: String]) throws {
let swiftExecutable = URL(
fileURLWithPath: "swift",
relativeTo: URL(fileURLWithPath: try #require(Self.getSwiftPath()))
)
try runProcess(swiftExecutable, args, env)
}
try body(destination.appending(path: path), runProcess, runSwift)
}
}

@Test(.requireSwiftSDK)
func basic() throws {
let swiftSDKID = try #require(Self.getSwiftSDKID())
try withPackage(at: "Examples/Basic") { packageDir, runSwift in
try withPackage(at: "Examples/Basic") { packageDir, _, runSwift in
try runSwift(["package", "--swift-sdk", swiftSDKID, "js"], [:])
try runSwift(["package", "--swift-sdk", swiftSDKID, "js", "--debug-info-format", "dwarf"], [:])
try runSwift(["package", "--swift-sdk", swiftSDKID, "js", "--debug-info-format", "name"], [:])
Expand All @@ -177,7 +182,10 @@ extension Trait where Self == ConditionTrait {
@Test(.requireSwiftSDK)
func testing() throws {
let swiftSDKID = try #require(Self.getSwiftSDKID())
try withPackage(at: "Examples/Testing") { packageDir, runSwift in
try withPackage(at: "Examples/Testing") { packageDir, runProcess, runSwift in
try runProcess(which("npm"), ["install"], [:])
try runProcess(which("npx"), ["playwright", "install", "chromium-headless-shell"], [:])

try runSwift(["package", "--swift-sdk", swiftSDKID, "js", "test"], [:])
try withTemporaryDirectory(body: { tempDir, _ in
let scriptContent = """
Expand Down Expand Up @@ -208,27 +216,26 @@ extension Trait where Self == ConditionTrait {
func testingWithCoverage() throws {
let swiftSDKID = try #require(Self.getSwiftSDKID())
let swiftPath = try #require(Self.getSwiftPath())
try withPackage(at: "Examples/Testing") { packageDir, runSwift in
try withPackage(at: "Examples/Testing") { packageDir, runProcess, runSwift in
try runSwift(
["package", "--swift-sdk", swiftSDKID, "js", "test", "--enable-code-coverage"],
[
"LLVM_PROFDATA_PATH": URL(fileURLWithPath: swiftPath).appending(path: "llvm-profdata").path
]
)
do {
let llvmCov = try which("llvm-cov")
let process = Process()
process.executableURL = llvmCov
let profdata = packageDir.appending(
path: ".build/plugins/PackageToJS/outputs/PackageTests/default.profdata"
)
let wasm = packageDir.appending(
path: ".build/plugins/PackageToJS/outputs/PackageTests/TestingPackageTests.wasm"
let possibleWasmPaths = ["CounterPackageTests.xctest.wasm", "CounterPackageTests.wasm"].map {
packageDir.appending(path: ".build/plugins/PackageToJS/outputs/PackageTests/\($0)")
}
let wasmPath = try #require(
possibleWasmPaths.first(where: { FileManager.default.fileExists(atPath: $0.path) }),
"No wasm file found"
)
process.arguments = ["report", "-instr-profile", profdata.path, wasm.path]
process.standardOutput = FileHandle.nullDevice
try process.run()
process.waitUntilExit()
let llvmCov = try which("llvm-cov")
try runProcess(llvmCov, ["report", "-instr-profile", profdata.path, wasmPath.path], [:])
}
}
}
Expand All @@ -237,29 +244,29 @@ extension Trait where Self == ConditionTrait {
@Test(.requireSwiftSDK(triple: "wasm32-unknown-wasip1-threads"))
func multithreading() throws {
let swiftSDKID = try #require(Self.getSwiftSDKID())
try withPackage(at: "Examples/Multithreading") { packageDir, runSwift in
try withPackage(at: "Examples/Multithreading") { packageDir, _, runSwift in
try runSwift(["package", "--swift-sdk", swiftSDKID, "js"], [:])
}
}

@Test(.requireSwiftSDK(triple: "wasm32-unknown-wasip1-threads"))
func offscreenCanvas() throws {
let swiftSDKID = try #require(Self.getSwiftSDKID())
try withPackage(at: "Examples/OffscrenCanvas") { packageDir, runSwift in
try withPackage(at: "Examples/OffscrenCanvas") { packageDir, _, runSwift in
try runSwift(["package", "--swift-sdk", swiftSDKID, "js"], [:])
}
}

@Test(.requireSwiftSDK(triple: "wasm32-unknown-wasip1-threads"))
func actorOnWebWorker() throws {
let swiftSDKID = try #require(Self.getSwiftSDKID())
try withPackage(at: "Examples/ActorOnWebWorker") { packageDir, runSwift in
try withPackage(at: "Examples/ActorOnWebWorker") { packageDir, _, runSwift in
try runSwift(["package", "--swift-sdk", swiftSDKID, "js"], [:])
}
}

@Test(.requireEmbeddedSwift) func embedded() throws {
try withPackage(at: "Examples/Embedded") { packageDir, runSwift in
try withPackage(at: "Examples/Embedded") { packageDir, _, runSwift in
try runSwift(
["package", "--triple", "wasm32-unknown-none-wasm", "js", "-c", "release"],
[
Expand Down
51 changes: 16 additions & 35 deletions Sources/JavaScriptKit/ConvertibleToJSValue.swift
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,10 @@ extension RawJSValue: ConvertibleToJSValue {

extension JSValue {
func withRawJSValue<T>(_ body: (RawJSValue) -> T) -> T {
body(convertToRawJSValue())
}

fileprivate func convertToRawJSValue() -> RawJSValue {
let kind: JavaScriptValueKind
let payload1: JavaScriptPayload1
var payload2: JavaScriptPayload2 = 0
Expand All @@ -232,7 +236,9 @@ extension JSValue {
payload1 = 0
payload2 = numberValue
case .string(let string):
return string.withRawJSValue(body)
kind = .string
payload1 = string.asInternalJSRef()
payload2 = 0
case .object(let ref):
kind = .object
payload1 = JavaScriptPayload1(ref.id)
Expand All @@ -252,53 +258,28 @@ extension JSValue {
kind = .bigInt
payload1 = JavaScriptPayload1(bigIntRef.id)
}
let rawValue = RawJSValue(kind: kind, payload1: payload1, payload2: payload2)
return body(rawValue)
return RawJSValue(kind: kind, payload1: payload1, payload2: payload2)
}
}

extension Array where Element: ConvertibleToJSValue {
func withRawJSValues<T>(_ body: ([RawJSValue]) -> T) -> T {
// fast path for empty array
guard self.count != 0 else { return body([]) }

func _withRawJSValues(
_ values: Self,
_ index: Int,
_ results: inout [RawJSValue],
_ body: ([RawJSValue]) -> T
) -> T {
if index == values.count { return body(results) }
return values[index].jsValue.withRawJSValue { (rawValue) -> T in
results.append(rawValue)
return _withRawJSValues(values, index + 1, &results, body)
}
let jsValues = map { $0.jsValue }
// Ensure the jsValues live longer than the temporary raw JS values
return withExtendedLifetime(jsValues) {
body(jsValues.map { $0.convertToRawJSValue() })
}
var _results = [RawJSValue]()
return _withRawJSValues(self, 0, &_results, body)
}
}

#if !hasFeature(Embedded)
extension Array where Element == ConvertibleToJSValue {
func withRawJSValues<T>(_ body: ([RawJSValue]) -> T) -> T {
// fast path for empty array
guard self.count != 0 else { return body([]) }

func _withRawJSValues(
_ values: [ConvertibleToJSValue],
_ index: Int,
_ results: inout [RawJSValue],
_ body: ([RawJSValue]) -> T
) -> T {
if index == values.count { return body(results) }
return values[index].jsValue.withRawJSValue { (rawValue) -> T in
results.append(rawValue)
return _withRawJSValues(values, index + 1, &results, body)
}
let jsValues = map { $0.jsValue }
// Ensure the jsValues live longer than the temporary raw JS values
return withExtendedLifetime(jsValues) {
body(jsValues.map { $0.convertToRawJSValue() })
}
var _results = [RawJSValue]()
return _withRawJSValues(self, 0, &_results, body)
}
}
#endif
9 changes: 0 additions & 9 deletions Sources/JavaScriptKit/FundamentalObjects/JSString.swift
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,4 @@ extension JSString {
func asInternalJSRef() -> JavaScriptObjectRef {
guts.jsRef
}

func withRawJSValue<T>(_ body: (RawJSValue) -> T) -> T {
let rawValue = RawJSValue(
kind: .string,
payload1: guts.jsRef,
payload2: 0
)
return body(rawValue)
}
}
18 changes: 8 additions & 10 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"@bjorn3/browser_wasi_shim": "^0.4.1",
"@rollup/plugin-typescript": "^12.1.2",
"@types/node": "^22.13.14",
"playwright": "^1.51.0",
"playwright": "^1.52.0",
"prettier": "3.5.3",
"rollup": "^4.37.0",
"rollup-plugin-dts": "^6.2.1",
Expand Down