Skip to content

Use package-trait to enable Embedded specific options #319

New issue

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

Sign up for GitHub

By clicking “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? Sign in to your account

Merged
merged 4 commits into from
Mar 27, 2025
Merged

Use package-trait to enable Embedded specific options #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb6fad8
Rename Package.swift -> [email protected]
kateinoigakukun Mar 27, 2025
f9b3973
Add package-trait based Package.swift
kateinoigakukun Mar 27, 2025
64fb506
Update Examples/Embedded to use the new `Embedded` trait
kateinoigakukun Mar 27, 2025
047e5a6
Detect Embedded build mode by compilation condition
kateinoigakukun Mar 27, 2025
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
4 changes: 2 additions & 2 deletions Examples/Embedded/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// swift-tools-version:6.0
// swift-tools-version:6.1

import PackageDescription

let package = Package(
name: "Embedded",
dependencies: [
.package(name: "JavaScriptKit", path: "../../"),
.package(name: "JavaScriptKit", path: "../../", traits: ["Embedded"]),
.package(url: "https://github.com/swiftwasm/swift-dlmalloc", branch: "0.1.0"),
],
targets: [
Expand Down
3 changes: 1 addition & 2 deletions Examples/Embedded/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#!/bin/bash
package_dir="$(cd "$(dirname "$0")" && pwd)"
JAVASCRIPTKIT_EXPERIMENTAL_EMBEDDED_WASM=true \
swift package --package-path "$package_dir" \
swift package --package-path "$package_dir" \
-c release --triple wasm32-unknown-none-wasm js
24 changes: 12 additions & 12 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
// swift-tools-version:6.0
// swift-tools-version:6.1

import PackageDescription

// NOTE: needed for embedded customizations, ideally this will not be necessary at all in the future, or can be replaced with traits
let shouldBuildForEmbedded = Context.environment["JAVASCRIPTKIT_EXPERIMENTAL_EMBEDDED_WASM"].flatMap(Bool.init) ?? false
let useLegacyResourceBundling =
Context.environment["JAVASCRIPTKIT_USE_LEGACY_RESOURCE_BUNDLING"].flatMap(Bool.init) ?? false

Expand All @@ -16,22 +15,23 @@ let package = Package(
.library(name: "JavaScriptEventLoopTestSupport", targets: ["JavaScriptEventLoopTestSupport"]),
.plugin(name: "PackageToJS", targets: ["PackageToJS"]),
],
traits: [
"Embedded"
],
targets: [
.target(
name: "JavaScriptKit",
dependencies: ["_CJavaScriptKit"],
exclude: useLegacyResourceBundling ? [] : ["Runtime"],
resources: useLegacyResourceBundling ? [.copy("Runtime")] : [],
cSettings: shouldBuildForEmbedded
? [
.unsafeFlags(["-fdeclspec"])
] : nil,
swiftSettings: shouldBuildForEmbedded
? [
.enableExperimentalFeature("Embedded"),
.enableExperimentalFeature("Extern"),
.unsafeFlags(["-Xfrontend", "-emit-empty-object-file"]),
] : nil
cSettings: [
.unsafeFlags(["-fdeclspec"], .when(traits: ["Embedded"]))
],
swiftSettings: [
.enableExperimentalFeature("Embedded", .when(traits: ["Embedded"])),
.enableExperimentalFeature("Extern", .when(traits: ["Embedded"])),
.unsafeFlags(["-Xfrontend", "-emit-empty-object-file"], .when(traits: ["Embedded"])),
]
),
.target(name: "_CJavaScriptKit"),
.testTarget(
Expand Down
94 changes: 94 additions & 0 deletions [email protected]
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// swift-tools-version:6.0

import PackageDescription

// NOTE: needed for embedded customizations, ideally this will not be necessary at all in the future, or can be replaced with traits
let shouldBuildForEmbedded = Context.environment["JAVASCRIPTKIT_EXPERIMENTAL_EMBEDDED_WASM"].flatMap(Bool.init) ?? false
let useLegacyResourceBundling =
Context.environment["JAVASCRIPTKIT_USE_LEGACY_RESOURCE_BUNDLING"].flatMap(Bool.init) ?? false

let package = Package(
name: "JavaScriptKit",
products: [
.library(name: "JavaScriptKit", targets: ["JavaScriptKit"]),
.library(name: "JavaScriptEventLoop", targets: ["JavaScriptEventLoop"]),
.library(name: "JavaScriptBigIntSupport", targets: ["JavaScriptBigIntSupport"]),
.library(name: "JavaScriptEventLoopTestSupport", targets: ["JavaScriptEventLoopTestSupport"]),
.plugin(name: "PackageToJS", targets: ["PackageToJS"]),
],
targets: [
.target(
name: "JavaScriptKit",
dependencies: ["_CJavaScriptKit"],
exclude: useLegacyResourceBundling ? [] : ["Runtime"],
resources: useLegacyResourceBundling ? [.copy("Runtime")] : [],
cSettings: shouldBuildForEmbedded
? [
.unsafeFlags(["-fdeclspec"])
] : nil,
swiftSettings: shouldBuildForEmbedded
? [
.enableExperimentalFeature("Embedded"),
.enableExperimentalFeature("Extern"),
.unsafeFlags(["-Xfrontend", "-emit-empty-object-file"]),
] : nil
),
.target(name: "_CJavaScriptKit"),
.testTarget(
name: "JavaScriptKitTests",
dependencies: ["JavaScriptKit"],
swiftSettings: [
.enableExperimentalFeature("Extern")
]
),

.target(
name: "JavaScriptBigIntSupport",
dependencies: ["_CJavaScriptBigIntSupport", "JavaScriptKit"]
),
.target(name: "_CJavaScriptBigIntSupport", dependencies: ["_CJavaScriptKit"]),
.testTarget(
name: "JavaScriptBigIntSupportTests",
dependencies: ["JavaScriptBigIntSupport", "JavaScriptKit"]
),

.target(
name: "JavaScriptEventLoop",
dependencies: ["JavaScriptKit", "_CJavaScriptEventLoop"]
),
.target(name: "_CJavaScriptEventLoop"),
.testTarget(
name: "JavaScriptEventLoopTests",
dependencies: [
"JavaScriptEventLoop",
"JavaScriptKit",
"JavaScriptEventLoopTestSupport",
],
swiftSettings: [
.enableExperimentalFeature("Extern")
]
),
.target(
name: "JavaScriptEventLoopTestSupport",
dependencies: [
"_CJavaScriptEventLoopTestSupport",
"JavaScriptEventLoop",
]
),
.target(name: "_CJavaScriptEventLoopTestSupport"),
.testTarget(
name: "JavaScriptEventLoopTestSupportTests",
dependencies: [
"JavaScriptKit",
"JavaScriptEventLoopTestSupport",
]
),
.plugin(
name: "PackageToJS",
capability: .command(
intent: .custom(verb: "js", description: "Convert a Swift package to a JavaScript package")
),
sources: ["Sources"]
),
]
)
52 changes: 31 additions & 21 deletions Plugins/PackageToJS/Sources/PackageToJSPlugin.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,11 @@ struct PackageToJSPlugin: CommandPlugin {
}

// Build products
let selfPackage = try findSelfPackage(in: context.package)
let productName = try buildOptions.product ?? deriveDefaultProduct(package: context.package)
let build = try buildWasm(
productName: productName,
selfPackage: selfPackage,
context: context,
options: buildOptions.packageOptions
)
Expand All @@ -178,14 +180,6 @@ struct PackageToJSPlugin: CommandPlugin {
} else {
context.pluginWorkDirectoryURL.appending(path: "Package")
}
guard
let selfPackage = findPackageInDependencies(
package: context.package,
id: Self.JAVASCRIPTKIT_PACKAGE_ID
)
else {
throw PackageToJSError("Failed to find JavaScriptKit in dependencies!?")
}
var make = MiniMake(
explain: buildOptions.packageOptions.explain,
printProgress: self.printProgress
Expand Down Expand Up @@ -226,9 +220,11 @@ struct PackageToJSPlugin: CommandPlugin {
exit(1)
}

let selfPackage = try findSelfPackage(in: context.package)
let productName = "\(context.package.displayName)PackageTests"
let build = try buildWasm(
productName: productName,
selfPackage: selfPackage,
context: context,
options: testOptions.packageOptions
)
Expand Down Expand Up @@ -264,14 +260,6 @@ struct PackageToJSPlugin: CommandPlugin {
} else {
context.pluginWorkDirectoryURL.appending(path: "PackageTests")
}
guard
let selfPackage = findPackageInDependencies(
package: context.package,
id: Self.JAVASCRIPTKIT_PACKAGE_ID
)
else {
throw PackageToJSError("Failed to find JavaScriptKit in dependencies!?")
}
var make = MiniMake(
explain: testOptions.packageOptions.explain,
printProgress: self.printProgress
Expand Down Expand Up @@ -311,6 +299,7 @@ struct PackageToJSPlugin: CommandPlugin {

private func buildWasm(
productName: String,
selfPackage: Package,
context: PluginContext,
options: PackageToJS.PackageOptions
) throws
Expand All @@ -331,11 +320,7 @@ struct PackageToJSPlugin: CommandPlugin {
)
parameters.echoLogs = true
parameters.otherSwiftcFlags = ["-color-diagnostics"]
let buildingForEmbedded =
ProcessInfo.processInfo.environment["JAVASCRIPTKIT_EXPERIMENTAL_EMBEDDED_WASM"].flatMap(
Bool.init
) ?? false
if !buildingForEmbedded {
if !isBuildingForEmbedded(selfPackage: selfPackage) {
// NOTE: We only support static linking for now, and the new SwiftDriver
// does not infer `-static-stdlib` for WebAssembly targets intentionally
// for future dynamic linking support.
Expand All @@ -355,6 +340,31 @@ struct PackageToJSPlugin: CommandPlugin {
return try self.packageManager.build(.product(productName), parameters: parameters)
}

/// Check if the build is for embedded WebAssembly
private func isBuildingForEmbedded(selfPackage: Package) -> Bool {
let coreTarget = selfPackage.targets.first { $0.name == "JavaScriptKit" }
guard let swiftTarget = coreTarget as? SwiftSourceModuleTarget else {
return false
}
// SwiftPM defines "Embedded" compilation condition when `Embedded` experimental
// feature is enabled.
// TODO: This should be replaced with a proper trait-based solution in the future.
return swiftTarget.compilationConditions.contains("Embedded")
}

/// Find JavaScriptKit package in the dependencies of the given package recursively
private func findSelfPackage(in package: Package) throws -> Package {
guard
let selfPackage = findPackageInDependencies(
package: package,
id: Self.JAVASCRIPTKIT_PACKAGE_ID
)
else {
throw PackageToJSError("Failed to find JavaScriptKit in dependencies!?")
}
return selfPackage
}

/// Clean if the build graph of the packaging process has changed
///
/// This is especially important to detect user changes debug/release
Expand Down