Skip to content

Commit ea0d6f1

Browse files
kateinoigakukunkateinoigakukun
committed
Experimental global executor cooperating with JS event loop
1 parent aa521a1 commit ea0d6f1

File tree

11 files changed

+496
-0
lines changed

11 files changed

+496
-0
lines changed

‎IntegrationTests/Makefile

+2
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,5 @@ benchmark: benchmark_setup run_benchmark
3333
.PHONY: test
3434
test: build_rt dist/PrimaryTests.wasm
3535
node bin/primary-tests.js
36+
concurrency_test: build_rt dist/ConcurrencyTests.wasm
37+
node bin/concurrency-tests.js

‎IntegrationTests/TestSuites/Package.swift

+15
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,32 @@ import PackageDescription
44

55
let package = Package(
66
name: "TestSuites",
7+
platforms: [
8+
// This package doesn't work on macOS host, but should be able to be built for it
9+
// for developing on Xcode. This minimum version requirement is to prevent availability
10+
// errors for Concurrency API, whose runtime support is shipped from macOS 12.0
11+
.macOS("12.0")
12+
],
713
products: [
814
.executable(
915
name: "PrimaryTests", targets: ["PrimaryTests"]
1016
),
17+
.executable(
18+
name: "ConcurrencyTests", targets: ["ConcurrencyTests"]
19+
),
1120
.executable(
1221
name: "BenchmarkTests", targets: ["BenchmarkTests"]
1322
),
1423
],
1524
dependencies: [.package(name: "JavaScriptKit", path: "../../")],
1625
targets: [
1726
.target(name: "PrimaryTests", dependencies: ["JavaScriptKit"]),
27+
.target(
28+
name: "ConcurrencyTests",
29+
dependencies: [
30+
.product(name: "JavaScriptEventLoop", package: "JavaScriptKit"),
31+
]
32+
),
1833
.target(name: "BenchmarkTests", dependencies: ["JavaScriptKit"]),
1934
]
2035
)

‎IntegrationTests/TestSuites/Sources/ConcurrencyTests/UnitTestUtils.swift

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
import JavaScriptKit
2+
3+
var printTestNames = false
4+
// Uncomment the next line to print the name of each test suite before running it.
5+
// This will make it easier to debug any errors that occur on the JS side.
6+
//printTestNames = true
7+
8+
func test(_ name: String, testBlock: () throws -> Void) throws {
9+
if printTestNames { print(name) }
10+
do {
11+
try testBlock()
12+
} catch {
13+
print("Error in \(name)")
14+
print(error)
15+
throw error
16+
}
17+
}
18+
19+
func asyncTest(_ name: String, testBlock: () async throws -> Void) async throws -> Void {
20+
if printTestNames { print(name) }
21+
do {
22+
try await testBlock()
23+
} catch {
24+
print("Error in \(name)")
25+
print(error)
26+
throw error
27+
}
28+
}
29+
30+
struct MessageError: Error {
31+
let message: String
32+
let file: StaticString
33+
let line: UInt
34+
let column: UInt
35+
init(_ message: String, file: StaticString, line: UInt, column: UInt) {
36+
self.message = message
37+
self.file = file
38+
self.line = line
39+
self.column = column
40+
}
41+
}
42+
43+
func expectEqual<T: Equatable>(
44+
_ lhs: T, _ rhs: T,
45+
file: StaticString = #file, line: UInt = #line, column: UInt = #column
46+
) throws {
47+
if lhs != rhs {
48+
throw MessageError("Expect to be equal \"\(lhs)\" and \"\(rhs)\"", file: file, line: line, column: column)
49+
}
50+
}
51+
52+
func expectCast<T, U>(
53+
_ value: T, to type: U.Type = U.self,
54+
file: StaticString = #file, line: UInt = #line, column: UInt = #column
55+
) throws -> U {
56+
guard let value = value as? U else {
57+
throw MessageError("Expect \"\(value)\" to be \(U.self)", file: file, line: line, column: column)
58+
}
59+
return value
60+
}
61+
62+
func expectObject(_ value: JSValue, file: StaticString = #file, line: UInt = #line, column: UInt = #column) throws -> JSObject {
63+
switch value {
64+
case let .object(ref): return ref
65+
default:
66+
throw MessageError("Type of \(value) should be \"object\"", file: file, line: line, column: column)
67+
}
68+
}
69+
70+
func expectArray(_ value: JSValue, file: StaticString = #file, line: UInt = #line, column: UInt = #column) throws -> JSArray {
71+
guard let array = value.array else {
72+
throw MessageError("Type of \(value) should be \"object\"", file: file, line: line, column: column)
73+
}
74+
return array
75+
}
76+
77+
func expectFunction(_ value: JSValue, file: StaticString = #file, line: UInt = #line, column: UInt = #column) throws -> JSFunction {
78+
switch value {
79+
case let .function(ref): return ref
80+
default:
81+
throw MessageError("Type of \(value) should be \"function\"", file: file, line: line, column: column)
82+
}
83+
}
84+
85+
func expectBoolean(_ value: JSValue, file: StaticString = #file, line: UInt = #line, column: UInt = #column) throws -> Bool {
86+
switch value {
87+
case let .boolean(bool): return bool
88+
default:
89+
throw MessageError("Type of \(value) should be \"boolean\"", file: file, line: line, column: column)
90+
}
91+
}
92+
93+
func expectNumber(_ value: JSValue, file: StaticString = #file, line: UInt = #line, column: UInt = #column) throws -> Double {
94+
switch value {
95+
case let .number(number): return number
96+
default:
97+
throw MessageError("Type of \(value) should be \"number\"", file: file, line: line, column: column)
98+
}
99+
}
100+
101+
func expectString(_ value: JSValue, file: StaticString = #file, line: UInt = #line, column: UInt = #column) throws -> String {
102+
switch value {
103+
case let .string(string): return String(string)
104+
default:
105+
throw MessageError("Type of \(value) should be \"string\"", file: file, line: line, column: column)
106+
}
107+
}
108+
109+
func expectAsyncThrow<T>(_ body: @autoclosure () async throws -> T, file: StaticString = #file, line: UInt = #line, column: UInt = #column) async throws -> Error {
110+
do {
111+
_ = try await body()
112+
} catch {
113+
return error
114+
}
115+
throw MessageError("Expect to throw an exception", file: file, line: line, column: column)
116+
}
117+
118+
func expectNotNil<T>(_ value: T?, file: StaticString = #file, line: UInt = #line, column: UInt = #column) throws {
119+
switch value {
120+
case .some: return
121+
case .none:
122+
throw MessageError("Expect a non-nil value", file: file, line: line, column: column)
123+
}
124+
}

‎IntegrationTests/TestSuites/Sources/ConcurrencyTests/main.swift

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
import JavaScriptEventLoop
2+
import JavaScriptKit
3+
4+
5+
func entrypoint() async throws {
6+
struct E: Error, Equatable {
7+
let value: Int
8+
}
9+
10+
try await asyncTest("Task.init value") {
11+
let handle = Task { 1 }
12+
try expectEqual(await handle.value, 1)
13+
}
14+
15+
try await asyncTest("Task.init throws") {
16+
let handle = Task {
17+
throw E(value: 2)
18+
}
19+
let error = try await expectAsyncThrow(await handle.value)
20+
let e = try expectCast(error, to: E.self)
21+
try expectEqual(e, E(value: 2))
22+
}
23+
24+
try await asyncTest("await resolved Promise") {
25+
let p = JSPromise(resolver: { resolve in
26+
resolve(.success(1))
27+
})
28+
try await expectEqual(p.value, 1)
29+
}
30+
31+
try await asyncTest("await rejected Promise") {
32+
let p = JSPromise(resolver: { resolve in
33+
resolve(.failure(.number(3)))
34+
})
35+
let error = try await expectAsyncThrow(await p.value)
36+
let jsValue = try expectCast(error, to: JSValue.self)
37+
try expectEqual(jsValue, 3)
38+
}
39+
40+
try await asyncTest("Continuation") {
41+
let value = await withUnsafeContinuation { cont in
42+
cont.resume(returning: 1)
43+
}
44+
try expectEqual(value, 1)
45+
}
46+
47+
try await asyncTest("Task.sleep(_:)") {
48+
await Task.sleep(1_000_000_000)
49+
}
50+
51+
// FIXME(katei): Somehow it doesn't work due to a mysterious unreachable inst
52+
// at the end of thunk.
53+
// This issue is not only on JS host environment, but also on standalone coop executor.
54+
// try await asyncTest("Task.sleep(nanoseconds:)") {
55+
// try await Task.sleep(nanoseconds: 1_000_000_000)
56+
// }
57+
}
58+
59+
60+
// Note: Please define `USE_SWIFT_TOOLS_VERSION_NEWER_THAN_5_5` if the swift-tools-version is newer
61+
// than 5.5 to avoid the linking issue.
62+
#if USE_SWIFT_TOOLS_VERSION_NEWER_THAN_5_5
63+
// Workaround: The latest SwiftPM rename main entry point name of executable target
64+
// to avoid conflicting "main" with test target since `swift-tools-version >= 5.5`.
65+
// The main symbol is renamed to "{{module_name}}_main" and it's renamed again to be
66+
// "main" when linking the executable target. The former renaming is done by Swift compiler,
67+
// and the latter is done by linker, so SwiftPM passes some special linker flags for each platform.
68+
// But SwiftPM assumes that wasm-ld supports it by returning an empty array instead of nil even though
69+
// wasm-ld doesn't support it yet.
70+
// ref: https://github.com/apple/swift-package-manager/blob/1be68e811d0d814ba7abbb8effee45f1e8e6ec0d/Sources/Build/BuildPlan.swift#L117-L126
71+
// So define an explicit "main" by @_cdecl
72+
@_cdecl("main")
73+
func main(argc: Int32, argv: Int32) -> Int32 {
74+
JavaScriptEventLoop.installGlobalExecutor()
75+
Task {
76+
do {
77+
try await entrypoint()
78+
} catch {
79+
print(error)
80+
}
81+
}
82+
return 0
83+
}
84+
#else
85+
JavaScriptEventLoop.installGlobalExecutor()
86+
Task {
87+
do {
88+
try await entrypoint()
89+
} catch {
90+
print(error)
91+
}
92+
}
93+
94+
#endif

‎IntegrationTests/bin/concurrency-tests.js

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
const { startWasiTask } = require("../lib");
2+
3+
startWasiTask("./dist/ConcurrencyTests.wasm").catch((err) => {
4+
console.log(err);
5+
process.exit(1);
6+
});

‎Package.swift

+12
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,26 @@ import PackageDescription
44

55
let package = Package(
66
name: "JavaScriptKit",
7+
platforms: [
8+
// This package doesn't work on macOS host, but should be able to be built for it
9+
// for developing on Xcode. This minimum version requirement is to prevent availability
10+
// errors for Concurrency API, whose runtime support is shipped from macOS 12.0
11+
.macOS("12.0")
12+
],
713
products: [
814
.library(name: "JavaScriptKit", targets: ["JavaScriptKit"]),
15+
.library(name: "JavaScriptEventLoop", targets: ["JavaScriptEventLoop"]),
916
],
1017
targets: [
1118
.target(
1219
name: "JavaScriptKit",
1320
dependencies: ["_CJavaScriptKit"]
1421
),
1522
.target(name: "_CJavaScriptKit"),
23+
.target(
24+
name: "JavaScriptEventLoop",
25+
dependencies: ["JavaScriptKit", "_CJavaScriptEventLoop"]
26+
),
27+
.target(name: "_CJavaScriptEventLoop"),
1628
]
1729
)

0 commit comments

Comments
 (0)