BridgeJS: Unified prelude.mjs tests with 2 test targets

BridgeJS: Extend snapshot test setup for exports <-> global this by including mixed module test case

Author: krodak

Makefile

@@ -11,16 +11,6 @@ unittest:
 	    --disable-sandbox \
 	    js test --prelude ./Tests/prelude.mjs -Xnode --expose-gc
 
-.PHONY: unittest-with-global
-unittest-with-global:
-	cp Tests/BridgeJSRuntimeTests/bridge-js.config.exposeToGlobal.json Tests/BridgeJSRuntimeTests/bridge-js.config.local.json
-	swift package --allow-writing-to-directory Tests/BridgeJSRuntimeTests \
-	    bridge-js --package-path Tests/BridgeJSRuntimeTests
-	rm -f Tests/BridgeJSRuntimeTests/bridge-js.config.local.json
-	env JAVASCRIPTKIT_EXPERIMENTAL_BRIDGEJS=1 swift package --swift-sdk "$(SWIFT_SDK_ID)" \
-	    --disable-sandbox \
-	    js test --prelude ./Tests/prelude.exposeToGlobal.mjs -Xnode --expose-gc
-
 .PHONY: regenerate_swiftpm_resources
 regenerate_swiftpm_resources:
 	npm run build

Package.swift

@@ -180,5 +180,18 @@ let package = Package(
             ],
             linkerSettings: testingLinkerFlags
         ),
+        .testTarget(
+            name: "BridgeJSGlobalTests",
+            dependencies: ["JavaScriptKit", "JavaScriptEventLoop"],
+            exclude: [
+                "bridge-js.config.json",
+                "bridge-js.d.ts",
+                "Generated/JavaScript",
+            ],
+            swiftSettings: [
+                .enableExperimentalFeature("Extern")
+            ],
+            linkerSettings: testingLinkerFlags
+        ),
     ]
 )

Plugins/BridgeJS/Sources/BridgeJSLink/BridgeJSLink.swift

@@ -1127,13 +1127,13 @@ struct BridgeJSLink {
         }
 
         // Generate wrapper functions for each module
-        for (moduleName, classes) in modulesByName {
+        for (moduleName, classes) in modulesByName.sorted(by: { $0.key < $1.key }) {
             wrapperLines.append("// Wrapper functions for module: \(moduleName)")
             wrapperLines.append("if (!importObject[\"\(moduleName)\"]) {")
             wrapperLines.append("    importObject[\"\(moduleName)\"] = {};")
             wrapperLines.append("}")
 
-            for klass in classes {
+            for klass in classes.sorted(by: { $0.name < $1.name }) {
                 let wrapperFunctionName = "bjs_\(klass.name)_wrap"
                 wrapperLines.append("importObject[\"\(moduleName)\"][\"\(wrapperFunctionName)\"] = function(pointer) {")
                 wrapperLines.append("    const obj = \(klass.name).__construct(pointer);")
@@ -2639,14 +2639,14 @@ extension BridgeJSLink {
             renderTSSignatureCallback: @escaping ([Parameter], BridgeType, Effects) -> String
         ) -> [String] {
             let printer = CodeFragmentPrinter()
-            
+
             let globalSkeletons = exportedSkeletons.filter { $0.exposeToGlobal }
             let nonGlobalSkeletons = exportedSkeletons.filter { !$0.exposeToGlobal }
-            
+
             if !globalSkeletons.isEmpty {
                 let globalRootNode = NamespaceNode(name: "")
                 buildExportsTree(rootNode: globalRootNode, exportedSkeletons: globalSkeletons)
-                
+
                 if !globalRootNode.children.isEmpty {
                     printer.write("export {};")
                     printer.nextLine()
@@ -2664,11 +2664,11 @@ extension BridgeJSLink {
                     printer.nextLine()
                 }
             }
-            
+
             if !nonGlobalSkeletons.isEmpty {
                 let localRootNode = NamespaceNode(name: "")
                 buildExportsTree(rootNode: localRootNode, exportedSkeletons: nonGlobalSkeletons)
-                
+
                 if !localRootNode.children.isEmpty {
                     generateNamespaceDeclarationsForNode(
                         node: localRootNode,
@@ -2682,7 +2682,7 @@ extension BridgeJSLink {
 
             return printer.lines
         }
-        
+
         private func generateNamespaceDeclarationsForNode(
             node: NamespaceNode,
             depth: Int,
@@ -2871,13 +2871,19 @@ extension BridgeJSLink {
                         }
                     }
 
-                    generateNamespaceDeclarationsForNode(node: childNode, depth: depth + 1, printer: printer, exposeToGlobal: exposeToGlobal, renderTSSignatureCallback: renderTSSignatureCallback)
+                    generateNamespaceDeclarationsForNode(
+                        node: childNode,
+                        depth: depth + 1,
+                        printer: printer,
+                        exposeToGlobal: exposeToGlobal,
+                        renderTSSignatureCallback: renderTSSignatureCallback
+                    )
 
                     printer.unindent()
                     printer.write("}")
                 }
             }
-            
+
             generateNamespaceDeclarations(node: node, depth: depth)
         }
     }

Plugins/BridgeJS/Tests/BridgeJSToolTests/BridgeJSLinkTests.swift

@@ -91,4 +91,25 @@ import Testing
         let bridgeJSLink: BridgeJSLink = BridgeJSLink(exportedSkeletons: [outputSkeleton], sharedMemory: false)
         try snapshot(bridgeJSLink: bridgeJSLink, name: name + ".Global.Export")
     }
+
+    @Test
+    func snapshotMixedModuleExposure() throws {
+        let globalURL = Self.inputsDirectory.appendingPathComponent("MixedGlobal.swift")
+        let globalSourceFile = Parser.parse(source: try String(contentsOf: globalURL, encoding: .utf8))
+        let globalAPI = ExportSwift(progress: .silent, moduleName: "GlobalModule", exposeToGlobal: true)
+        try globalAPI.addSourceFile(globalSourceFile, "MixedGlobal.swift")
+        let (_, globalSkeleton) = try #require(try globalAPI.finalize())
+
+        let privateURL = Self.inputsDirectory.appendingPathComponent("MixedPrivate.swift")
+        let privateSourceFile = Parser.parse(source: try String(contentsOf: privateURL, encoding: .utf8))
+        let privateAPI = ExportSwift(progress: .silent, moduleName: "PrivateModule", exposeToGlobal: false)
+        try privateAPI.addSourceFile(privateSourceFile, "MixedPrivate.swift")
+        let (_, privateSkeleton) = try #require(try privateAPI.finalize())
+
+        let bridgeJSLink = BridgeJSLink(
+            exportedSkeletons: [globalSkeleton, privateSkeleton],
+            sharedMemory: false
+        )
+        try snapshot(bridgeJSLink: bridgeJSLink, name: "MixedModules.Export")
+    }
 }

Plugins/BridgeJS/Tests/BridgeJSToolTests/Inputs/MixedGlobal.swift

@@ -0,0 +1,8 @@
+@JS(namespace: "GlobalAPI")
+func globalFunction() -> String
+
+@JS(namespace: "GlobalAPI")
+class GlobalClass {
+    @JS public init()
+    @JS public func greet() -> String
+}

Plugins/BridgeJS/Tests/BridgeJSToolTests/Inputs/MixedPrivate.swift

@@ -0,0 +1,8 @@
+@JS(namespace: "PrivateAPI")
+func privateFunction() -> String
+
+@JS(namespace: "PrivateAPI")
+class PrivateClass {
+    @JS public init()
+    @JS public func greet() -> String
+}

Plugins/BridgeJS/Tests/BridgeJSToolTests/__Snapshots__/BridgeJSLinkTests/DefaultParameters.Export.js

@@ -191,6 +191,10 @@ export async function createInstantiator(options, swift) {
             if (!importObject["TestModule"]) {
                 importObject["TestModule"] = {};
             }
+            importObject["TestModule"]["bjs_ConstructorDefaults_wrap"] = function(pointer) {
+                const obj = ConstructorDefaults.__construct(pointer);
+                return swift.memory.retain(obj);
+            };
             importObject["TestModule"]["bjs_DefaultGreeter_wrap"] = function(pointer) {
                 const obj = DefaultGreeter.__construct(pointer);
                 return swift.memory.retain(obj);
@@ -199,10 +203,6 @@ export async function createInstantiator(options, swift) {
                 const obj = EmptyGreeter.__construct(pointer);
                 return swift.memory.retain(obj);
             };
-            importObject["TestModule"]["bjs_ConstructorDefaults_wrap"] = function(pointer) {
-                const obj = ConstructorDefaults.__construct(pointer);
-                return swift.memory.retain(obj);
-            };
         },
         setInstance: (i) => {
             instance = i;

Plugins/BridgeJS/Tests/BridgeJSToolTests/__Snapshots__/BridgeJSLinkTests/MixedGlobal.Export.d.ts

@@ -0,0 +1,33 @@
+// NOTICE: This is auto-generated code by BridgeJS from JavaScriptKit,
+// DO NOT EDIT.
+//
+// To update this file, just rebuild your project or run
+// `swift package bridge-js`.
+
+/// Represents a Swift heap object like a class instance or an actor instance.
+export interface SwiftHeapObject {
+    /// Release the heap object.
+    ///
+    /// Note: Calling this method will release the heap object and it will no longer be accessible.
+    release(): void;
+}
+export interface GlobalClass extends SwiftHeapObject {
+    greet(): string;
+}
+export type Exports = {
+    GlobalAPI: {
+        GlobalClass: {
+            new(): GlobalClass;
+        }
+        globalFunction(): string;
+    },
+}
+export type Imports = {
+}
+export function createInstantiator(options: {
+    imports: Imports;
+}, swift: any): Promise<{
+    addImports: (importObject: WebAssembly.Imports) => void;
+    setInstance: (instance: WebAssembly.Instance) => void;
+    createExports: (instance: WebAssembly.Instance) => Exports;
+}>;