Skip to content

Latest commit

 

History

History
 
 

Embedded

Folders and files

README.md

Embedded example

This example builds JavaScriptKit with Embedded Swift for WebAssembly.

Requirements:

  • Swift 6.3.1 toolchain
  • swift-6.3.1-RELEASE_wasm-embedded Swift SDK

Use SWIFT_BIN when the active swift is not the 6.3.1 toolchain:

export SWIFT_BIN="$(swiftly run +6.3.1 which swift)"
./build.sh
npm install
npx serve ../..

Set SWIFT_SDK_ID to override the SDK identifier. The default base SDK is swift-6.3.1-RELEASE_wasm, and build.sh resolves it to swift-6.3.1-RELEASE_wasm-embedded. You may pass either the base SDK or the full embedded SDK identifier.

Size comparison

Run the same example as standard WASM and Embedded WASM:

export SWIFT_BIN="/Users/1amageek/Library/Developer/Toolchains/swift-6.3.1-RELEASE.xctoolchain/usr/bin/swift"
./measure-size.sh

The script writes:

  • .build/size-comparison/standard/Package
  • .build/size-comparison/embedded/Package
  • .build/size-comparison/size-report.json

On the current Swift 6.3.1 toolchain, without wasm-opt, this example measured:

Encoding Standard Embedded Reduction
raw 8,968,053 bytes 832,001 bytes 90.7%
gzip -9 2,405,936 bytes 277,845 bytes 88.5%
brotli -q 11 1,727,158 bytes 224,900 bytes 87.0%

Browser smoke test

Build the Embedded package, install the JavaScript test dependencies, then run the browser smoke test:

./build.sh
npm install
npm run test:embedded-example

The smoke test serves index.html locally with the generated PackageToJS output, opens Chrome through Playwright, clicks the counter button, and verifies the UTF-8 encoder output.

Fixed Swift 6.4 executor regression

The executor integration is validated with the matching swift-6.4.x-DEVELOPMENT-SNAPSHOT-2026-08-14-a toolchain and swift-6.4.x-DEVELOPMENT-SNAPSHOT-2026-08-14-a_wasm-embedded SDK. From the repository root, with SWIFT_BIN pointing to the real matching executable:

npm ci
JAVASCRIPTKIT_EXPERIMENTAL_EMBEDDED_WASM=false "$SWIFT_BIN" package \
  --package-path Examples/Embedded --build-system native --jobs 2 \
  --swift-sdk swift-6.4.x-DEVELOPMENT-SNAPSHOT-2026-08-14-a_wasm-embedded \
  plugin --allow-writing-to-package-directory js -c debug --no-optimize
node Examples/Embedded/verify.mjs

Run the build and browser command under the caller's bounded timeout guard. The SDK supplies Embedded mode and mandatory WMO; the optional JavaScriptKit empty-object mode remains disabled. In addition to the existing interactions, the browser check requires exactly one detached-main:1 marker after executor installation, a detached task, and a MainActor hop. This is the fixed-profile runtime proof; the historical 6.3.1 size measurements above are not that proof.