feat: unit tests and project refactor (#1)

* start node running of interface

* refactors

* fix: update `memoryBuffer` after `malloc`

* refactor: add `test_out` directory, fix our path type implementation

* refactor: project structure

* feat: jest test environment

* fix: stop lifecycle once tests completed

* feat: automatic download

* remove unnecessary package

* refactor: Cleanup setup.ts

* fix: make sh files executable

* fix: have build run with docker

* feat: test workflow

* fix: make test.sh executable

* Update test.sh

* test

* Update setup.ts

* Create push.yml

* Update push.yml

* general fixes

* fix: workspace issues

---------

Co-authored-by: Jack Lavigne <[email protected]>

Author: professoralex13

src/wasm_navdata_interface/.cargo/config.toml renamed to .cargo/config.toml

@@ -1,11 +1,11 @@
-[target.wasm32-wasi]
-rustflags = [
-  "-Clink-arg=--export-table",
-  "-Clink-arg=--export=malloc",
-  "-Clink-arg=--export=free",
-  "-Clink-arg=-L/usr/lib/llvm-15/lib/clang/15.0.7/lib/wasi",
-  "-Clink-arg=-lclang_rt.builtins-wasm32"
-]
-
-[build]
+[target.wasm32-wasi]
+rustflags = [
+  "-Clink-arg=--export-table",
+  "-Clink-arg=--export=malloc",
+  "-Clink-arg=--export=free",
+  "-Clink-arg=-L/usr/lib/llvm-15/lib/clang/15.0.7/lib/wasi",
+  "-Clink-arg=-lclang_rt.builtins-wasm32"
+]
+
+[build]
 target = "wasm32-wasi"

.eslintrc.js

@@ -1,6 +1,6 @@
 module.exports = {
   root: true,
-  ignorePatterns: [".eslintrc.js", "src/wasm_navdata_interface/", "msfstypes/"],
+  ignorePatterns: [".eslintrc.js", "src/wasm/", "msfstypes/"],
   env: { browser: true, commonjs: true, es6: true },
   plugins: ["@typescript-eslint"],
   extends: [
@@ -11,7 +11,7 @@ module.exports = {
   ],
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project: ["./examples/gauge/tsconfig.json"],
+    project: ["./tsconfig.json"],
     ecmaVersion: 2022,
     sourceType: "module",
     ecmaFeatures: { jsx: true },

.github/workflows/pr.yml

@@ -12,11 +12,16 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Build WASM module
+      - name: create env file
         run: |
-          ./src/wasm_navdata_interface/scripts/run_docker_cmd.sh ./scripts/build.sh
+          touch .env
+          echo NAVDATA_SIGNED_URL=${{ secrets.NAVDATA_SIGNED_URL }} >> .env
+      - name: Build WASM module
+        run: npm run build:wasm-workflow
+      - name: Test
+        run: npm run test-workflow
       - name: Upload WASM module to GitHub
         uses: actions/upload-artifact@v2
         with:
-          name: navdata_interface.wasm
-          path: ./src/wasm_navdata_interface/out/navdata_interface.wasm
+          name: msfs_navdata_interface.wasm
+          path: ./out/msfs_navdata_interface.wasm

.github/workflows/pre-release.yml

@@ -12,10 +12,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Build WASM module
-        run: |
-          ./src/wasm_navdata_interface/scripts/run_docker_cmd.sh ./scripts/build.sh
+        run: npm run build:wasm-workflow
       - name: Pre-Release
         uses: softprops/action-gh-release@v1
         with:
-          files: ./src/wasm_navdata_interface/out/navdata_interface.wasm
+          files: ./out/msfs_navdata_interface.wasm
           prerelease: true

.github/workflows/push.yml

@@ -0,0 +1,24 @@
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: create env file
+        run: |
+          touch .env
+          echo NAVDATA_SIGNED_URL=${{ secrets.NAVDATA_SIGNED_URL }} >> .env
+      - name: Build WASM module
+        run: npm run build:wasm-workflow
+      - name: Test
+        run: npm run test-workflow
+      - name: Upload WASM module to GitHub
+        uses: actions/upload-artifact@v2
+        with:
+          name: msfs_navdata_interface.wasm
+          path: ./out/msfs_navdata_interface.wasm

.github/workflows/release.yml

@@ -13,9 +13,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Build WASM module
-        run: |
-          ./src/wasm_navdata_interface/scripts/run_docker_cmd.sh ./scripts/build.sh
+        run: npm run build:wasm-workflow
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
-          files: ./src/wasm_navdata_interface/out/navdata_interface.wasm
+          files: ./out/msfs_navdata_interface.wasm

.gitignore

@@ -5,8 +5,8 @@ _PackageInt
 tsconfig.tsbuildinfo
 .vs
 examples/aircraft/PackageSources/html_ui/Pages/VCockpit/Instruments/Navigraph/NavdataInterfaceSample
-examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navdata_Interface_Aircraft/panel/navdata_interface.wasm
-src/wasm_navdata_interface/out
+examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navdata_Interface_Aircraft/panel/msfs_navdata_interface.wasm
+out
 
 # Rust
 # will have compiled files and executables
@@ -27,3 +27,5 @@ Cargo.lock
 .env
 *.local
 .DS_Store
+
+test_work/

CODEOWNERS

@@ -3,3 +3,4 @@
 # @Navigraph/app-dev will be requested for
 # review when someone opens a pull request.
 *       @pepperoni505
+*       @professoralex13

Cargo.toml

@@ -0,0 +1,11 @@
+[workspace]
+resolver = "2"
+
+members = ["src/wasm"]
+
+[profile.release]
+lto = true
+strip = true
+
+[patch.crates-io]
+rusqlite = { git = "https://github.com/navigraph/rusqlite", rev = "7921774" }

README.md

@@ -13,8 +13,9 @@ Here's an overview on the structure of this repository, which is designed to be
   - `aircraft/` includes a base aircraft to test in the sim
   - `gauge/` includes a very simple TypeScript instrument to communicate with the WASM module
 - `src/`
-  - Contains the source for the navdata interface (and soon the JS library)
-  - `wasm_navdata_interface` includes the Rust source code for the WASM module
+  - `js` Includes source code for the JS interface for using the sdk
+  - `test` Includes code for testing the JS and Rust code using a Node runtime
+  - `wasm` includes the Rust source code for the WASM module which handles the database interface
 
 ## Including in Your Aircraft
 
@@ -44,7 +45,6 @@ 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
-2. Open the `src/wasm_navdata_interface` folder in a terminal
-3. Run `.\build.bat` (must be on Windows)
+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
-4. The compiled WASM module will be copied to `src/wasm_navdata_interface/out` **and** `examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navdata_Interface_Aircraft/panel`
+3. The compiled WASM module will be copied to `out` **and** `examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navdata_Interface_Aircraft/panel`