Supply JSKit runtime in SwiftPM resources (#193)

Due to the fact that swiftlang/swift-package-manager#4306 will only be available starting with Swift 5.7, we can't generate these resources with a SwiftPM plugin. I propose storing the generated code in the repository directly for now. When 5.7 is released, we can switch to a SwiftPM plugin approach.

Can be tested end-to-end with swiftwasm/carton#335.

Co-authored-by: Yuta Saito <kateinoigakukun@gmail.com>

Author: MaxDesiatov

.gitattributes

@@ -0,0 +1 @@
+Sources/JavaScriptKit/Runtime/** linguist-generated

.github/workflows/test.yml

@@ -38,6 +38,11 @@ jobs:
           SWIFT_VERSION=${{ matrix.entry.toolchain }} make bootstrap
           echo ${{ matrix.entry.toolchain }} > .swift-version
           make test
+      - name: Check if SwiftPM resources are stale
+        run: |
+          make regenerate_swiftpm_resources
+          git diff --exit-code Sources/JavaScriptKit/Runtime
+
   native-build:
     # Check native build to make it easy to develop applications by Xcode
     name: Build for native target

Makefile

@@ -29,3 +29,8 @@ run_benchmark:
 .PHONY: perf-tester
 perf-tester:
 	cd ci/perf-tester && npm ci
+
+.PHONY: regenerate_swiftpm_resources
+regenerate_swiftpm_resources:
+	npm run build
+	cp Runtime/lib/index.js Runtime/lib/index.mjs Sources/JavaScriptKit/Runtime

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.2
+// swift-tools-version:5.3
 
 import PackageDescription
 
@@ -12,7 +12,8 @@ let package = Package(
     targets: [
         .target(
             name: "JavaScriptKit",
-            dependencies: ["_CJavaScriptKit"]
+            dependencies: ["_CJavaScriptKit"],
+            resources: [.copy("Runtime")]
         ),
         .target(name: "_CJavaScriptKit"),
         .target(

Runtime/src/closure-heap.ts

@@ -1,4 +1,4 @@
-import { ExportedFunctions } from "./types";
+import { ExportedFunctions } from "./types.js";
 
 /// Memory lifetime of closures in Swift are managed by Swift side
 export class SwiftClosureDeallocator {

Runtime/src/index.ts

@@ -1,14 +1,14 @@
-import { SwiftClosureDeallocator } from "./closure-heap";
+import { SwiftClosureDeallocator } from "./closure-heap.js";
 import {
     LibraryFeatures,
     ExportedFunctions,
     ref,
     pointer,
     TypedArray,
     ImportedFunctions,
-} from "./types";
-import * as JSValue from "./js-value";
-import { Memory } from "./memory";
+} from "./types.js";
+import * as JSValue from "./js-value.js";
+import { Memory } from "./memory.js";
 
 export class SwiftRuntime {
     private _instance: WebAssembly.Instance | null;

Runtime/src/js-value.ts

@@ -1,5 +1,5 @@
-import { Memory } from "./memory";
-import { assertNever, pointer } from "./types";
+import { Memory } from "./memory.js";
+import { assertNever, pointer } from "./types.js";
 
 export const enum Kind {
     Boolean = 0,

Runtime/src/memory.ts

@@ -1,5 +1,5 @@
-import { SwiftRuntimeHeap } from "./object-heap";
-import { pointer } from "./types";
+import { SwiftRuntimeHeap } from "./object-heap.js";
+import { pointer } from "./types.js";
 
 export class Memory {
     readonly rawMemory: WebAssembly.Memory;

Runtime/src/object-heap.ts

@@ -1,5 +1,5 @@
-import { globalVariable } from "./find-global";
-import { ref } from "./types";
+import { globalVariable } from "./find-global.js";
+import { ref } from "./types.js";
 
 type SwiftRuntimeHeapEntry = {
     id: number;

Runtime/src/types.ts

@@ -1,4 +1,4 @@
-import * as JSValue from "./js-value";
+import * as JSValue from "./js-value.js";
 
 export type ref = number;
 export type pointer = number;