workflow: switch to cargo-msfs for building the package (#12)

* workflow(cherrypick): switch to cargo-msfs

* chore: update npm workflow run

* workflow: attempt to fix new build

* workflow: more fixes

* workflow: try windows build

* workflow: change clang version

* workflow: try newer ubuntu

* workflow: trying manual clang version

* workflow: change clang version

* workflow: try windows one last time

* fix: package comparison now includes revisions

* workflow(fix): correct version of windows

* workflow(fix): switch to a different clang installer

* workflow(fix): now autocreates the out folder

* workflow(fix): final workflow fix

* workflow(test): is the preopens issue local

* workflow(fix): add winpty to call

* fix: implement course for dfdv2

* feat: add description_code to fix output

* fix: change test to test-workflow

* fix: move winpty

* chore: update package version

Author: ZigTag

.cargo/config.toml

@@ -1,4 +1,4 @@
-[target.wasm32-wasi]
+[target.wasm32-wasip1]
 rustflags = [
   "-Ctarget-feature=-crt-static,+bulk-memory",
   "-Clink-self-contained=no",
@@ -21,4 +21,4 @@ rustflags = [
 ]
 
 [build]
-target = "wasm32-wasi"
+target = "wasm32-wasip1"

.github/workflows/pr.yml

@@ -50,7 +50,7 @@ jobs:
 
   build-test:
     name: Build & test 🛠️
-    runs-on: ubuntu-latest
+    runs-on: windows-2022
     if: ${{ !github.event.pull_request.draft && !contains(github.event.pull_request.labels.*.name , 'release') }}
     steps:
       - name: Checkout
@@ -60,10 +60,23 @@ jobs:
 
       - name: Create env file
         run: |
-          touch .env
           echo NAVIGATION_DATA_SIGNED_URL=${{ secrets.NAVIGATION_DATA_SIGNED_URL }} >> .env
           echo NAVIGATION_DATA_SIGNED_URL_V2=${{ secrets.NAVIGATION_DATA_SIGNED_URL_V2 }} >> .env
 
+      - name: Install LLVM and Clang
+        uses: KyleMayes/[email protected]
+        with:
+          version: "17.0.6"
+
+      - name: Cache cargo-msfs
+        uses: actions/cache@v4
+        with:
+          path: ~\.cargo\bin
+          key: ${{ runner.os }}-cargo-msfs
+
+      - name: Setup
+        run: npm run setup
+
       - name: Build WASM module
         run: npm run build:wasm-workflow
 

.github/workflows/pre-release.yml

@@ -10,10 +10,24 @@ run-name: Create pre-release for `${{ github.ref_name }}`
 
 jobs:
   release-wasm:
-    runs-on: ubuntu-latest
+    runs-on: windows-2022
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install LLVM and Clang
+        uses: KyleMayes/[email protected]
+        with:
+          version: "17.0.6"
+
+      - name: Cache cargo-msfs
+        uses: actions/cache@v4
+        with:
+          path: ~\.cargo\bin
+          key: ${{ runner.os }}-cargo-msfs
+
+      - name: Setup
+        run: npm run setup
+
       - name: Build WASM module
         run: npm run build:wasm-workflow
 

.github/workflows/release.yml

@@ -11,10 +11,24 @@ run-name: Create release for `${{ github.ref_name }}`
 
 jobs:
   release-wasm:
-    runs-on: ubuntu-latest
+    runs-on: windows-2022
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install LLVM and Clang
+        uses: KyleMayes/[email protected]
+        with:
+          version: "17.0.6"
+
+      - name: Cache cargo-msfs
+        uses: actions/cache@v4
+        with:
+          path: ~\.cargo\bin
+          key: ${{ runner.os }}-cargo-msfs
+
+      - name: Setup
+        run: npm run setup
+
       - name: Build WASM module
         run: npm run build:wasm-workflow
 

Cargo.lock

@@ -8,4 +8,4 @@ lto = true
 strip = true
 
 [patch.crates-io]
-rusqlite = { git = "https://github.com/navigraph/rusqlite", rev = "7921774" }
+rusqlite = { git = "https://github.com/navigraph/rusqlite", rev = "f716d5c" }

Cargo.toml

@@ -62,7 +62,7 @@ Before building, make sure you have properly created and set an `.env` file in `
 
 ## Building the WASM Module Yourself
 
-1. [Download](https://www.docker.com/products/docker-desktop/) Docker Desktop
+1. [Install](https://github.com/navigraph/cargo-msfs) cargo-msfs
 2. Run `npm run build:wasm` (must be on Windows)
    - This will take a while to download and build the first time, but subsequent runs will be quicker
 3. The compiled WASM module will be copied to `out` **and** `examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navigation_Data_Interface_Aircraft/panel`

README.md

@@ -6,14 +6,15 @@
   "scripts": {
     "format": "prettier --write .",
     "lint:js": "eslint \"src/js/**/*.ts\"",
+    "setup": ".\\scripts\\setup.bat",
     "build:wasm": ".\\scripts\\build.bat",
-    "build:wasm-workflow": "./scripts/run_docker_cmd.sh ./scripts/build.sh",
+    "build:wasm-workflow": ".\\scripts\\build_workflow.bat",
     "build:js": "cd .\\src\\js && npm run build",
     "build:gauge": "cd .\\examples\\gauge && npm run build",
     "dev:gauge": "cd .\\examples\\gauge && npm run dev",
     "jest": "jest --verbose",
     "test": ".\\scripts\\test.bat",
-    "test-workflow": "./scripts/test.sh",
+    "test-workflow": ".\\scripts\\test_workflow.bat",
     "docker": ".\\scripts\\run_docker_cmd.bat"
   },
   "devDependencies": {

package.json

@@ -1,3 +1,4 @@
 [toolchain]
 profile = "default"
-channel = "1.79.0"
+channel = "1.83"
+targets = ["wasm32-wasip1"]

rust-toolchain.toml

@@ -2,8 +2,8 @@
 
 cd %~dp0
 
-call .\run_docker_cmd.bat ./scripts/build.sh
+mkdir ..\out
 
-cd %~dp0
+cargo-msfs build msfs2020 -i .. -o ..\out\msfs_navigation_data_interface.wasm
 
 copy ..\out\msfs_navigation_data_interface.wasm ..\examples\aircraft\PackageSources\SimObjects\Airplanes\Navigraph_Navigation_Data_Interface_Aircraft\panel

scripts/build.bat

@@ -0,0 +1,7 @@
+@echo off
+
+cd %~dp0
+
+mkdir ..\out
+
+cargo-msfs build msfs2020 -i .. -o ..\out\msfs_navigation_data_interface.wasm

scripts/build.sh

@@ -0,0 +1,7 @@
+@echo off
+
+set image="ghcr.io/flybywiresim/dev-env@sha256:aa36c0e4b8c66c2ec0195a104f8ae04a8ffbf45e8ddb6a8aca4f7237436bd876"
+
+cd %~dp0
+
+docker run --rm -it -v "%cd%\..\:/external" -v "%cd%\..\out:/out" %image% %*

scripts/build_workflow.bat

@@ -0,0 +1,5 @@
+@echo off
+
+cargo install --git https://github.com/navigraph/cargo-msfs
+
+cargo-msfs install msfs2020

scripts/run_docker_cmd.sh

@@ -5,4 +5,5 @@ cd %~dp0
 rmdir /s /q ..\test_work
 mkdir ..\test_work
 
+:: Docker is a must for now, WASI preopens don't exist on windows.
 call .\run_docker_cmd.bat npm run jest

scripts/run_docker_cmd_workflow.bat

@@ -0,0 +1,9 @@
+@echo off
+
+cd %~dp0
+
+rmdir /s /q ..\test_work
+mkdir ..\test_work
+
+:: Docker is a must for now, WASI preopens don't exist on windows.
+winpty .\run_docker_cmd_workflow.bat npm run jest

scripts/setup.bat

@@ -6,8 +6,8 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-rusqlite = { version = "0.30.0", features = ["bundled"] }
-serde_rusqlite = "0.34.0"
+rusqlite = { version = "0.32.0", features = ["bundled"] }
+serde_rusqlite = "0.36.0"
 serde = { version = "1.0.190", features = ["derive"] }
 serde_json = "1.0.108"
 serde_with = "3.4.0"

scripts/test.bat

@@ -67,6 +67,7 @@ pub(crate) fn map_airways(data: Vec<sql_structs::EnrouteAirways>) -> Vec<Airway>
                 airway_row.icao_code.unwrap_or("NULL".to_string()),
                 None,
                 airway_row.waypoint_ref_table,
+                airway_row.waypoint_description_code.clone(),
             ));
 
             if airway_row