Merge branch 'chore/ui-improvements' of https://github.com/Navigraph/msfs-navdata-interface into chore/ui-improvements

SkySails · SkySails · commit 2b8254b2b660 · 2024-05-13T13:11:46.000+02:00
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ If you bundle outdated navigation data in your aircraft and you want this module
 
 ## Where is the Navigation Data Stored?
 
-The default location for navigation data is `work/NavigationData`. If you have bundled navigation data, its located in the `NavigationData` folder in the root of your project.
+The default location for navigation data is `work/NavigationData`. If you have bundled navigation data, its located in the `NavigationData` folder in the root of your project. (although it gets copied into the `work` directory at runtime)
 
 ## Building the Sample Aircraft
 
diff --git a/examples/gauge/Components/InterfaceSample.css b/examples/gauge/Components/InterfaceSample.css
@@ -5,6 +5,16 @@
   position: relative;
 }
 
+.loading-container {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  width: 100%;
+  height: 100%;
+  font-size: x-large;
+  text-align: center;
+}
+
 .button {
   width: 150px;
   height: 50px;
diff --git a/examples/gauge/Components/InterfaceSample.tsx b/examples/gauge/Components/InterfaceSample.tsx
@@ -5,6 +5,7 @@ import {
   FSComponent,
   MappedSubject,
   Subject,
+  SubscribableMapFunctions,
   VNode,
 } from "@microsoft/msfs-sdk"
 import {
@@ -36,6 +37,8 @@ export class InterfaceSample extends DisplayComponent<InterfaceSampleProps> {
   private readonly sqlInputRef = FSComponent.createRef<Input>()
   private readonly executeSqlButtonRef = FSComponent.createRef<HTMLButtonElement>()
   private readonly outputRef = FSComponent.createRef<HTMLPreElement>()
+  private readonly loadingRef = FSComponent.createRef<HTMLDivElement>()
+  private readonly authContainerRef = FSComponent.createRef<HTMLDivElement>()
 
   private readonly navigationDataStatus = Subject.create<NavigationDataStatus | null>(null)
 
@@ -94,65 +97,75 @@ export class InterfaceSample extends DisplayComponent<InterfaceSampleProps> {
 
   public render(): VNode {
     return (
-      <div class="auth-container">
-        <div class="horizontal">
-          <div class="vertical">
-            <h4>Step 1 - Sign in</h4>
-            <div ref={this.textRef}>Loading</div>
-            <div ref={this.loginButtonRef} class="button" />
-            <div ref={this.navigationDataTextRef} />
-            <img ref={this.qrCodeRef} class="qr-code" />
-          </div>
-          <div class="vertical">
-            <h4>Step 2 - Select Database</h4>
-            <Dropdown ref={this.dropdownRef} />
-            <div ref={this.downloadButtonRef} class="button">
-              Download
+      <>
+        <div class="loading-container" ref={this.loadingRef}>
+          Waiting for navigation data interface to initialize... If building for the first time, this may take a few
+          minutes
+        </div>
+        <div class="auth-container" ref={this.authContainerRef} style={{ display: "none" }}>
+          <div class="horizontal">
+            <div class="vertical">
+              <h4>Step 1 - Sign in</h4>
+              <div ref={this.textRef}>Loading</div>
+              <div ref={this.loginButtonRef} class="button" />
+              <div ref={this.navigationDataTextRef} />
+              <img ref={this.qrCodeRef} class="qr-code" />
+            </div>
+            <div class="vertical">
+              <h4>Step 2 - Select Database</h4>
+              <Dropdown ref={this.dropdownRef} />
+              <div ref={this.downloadButtonRef} class="button">
+                Download
+              </div>
+              {this.renderDatabaseStatus()}
             </div>
-            {this.renderDatabaseStatus()}
           </div>
-        </div>
 
-        <h4 style="text-align: center;">Step 3 - Query the database</h4>
-        <div class="horizontal">
-          <div class="vertical">
-            <Input ref={this.icaoInputRef} value="ESSA" class="text-field" />
-            <div ref={this.executeIcaoButtonRef} class="button">
-              Fetch Airport
-            </div>
-            <div style="height:30px;"></div>
-            <Input
-              ref={this.sqlInputRef}
-              textarea
-              value="SELECT airport_name FROM tbl_airports WHERE airport_identifier = 'ESSA'"
-              class="text-field"
-            />
-            <div ref={this.executeSqlButtonRef} class="button">
-              Execute SQL
+          <h4 style="text-align: center;">Step 3 - Query the database</h4>
+          <div class="horizontal">
+            <div class="vertical">
+              <Input ref={this.icaoInputRef} value="ESSA" class="text-field" />
+              <div ref={this.executeIcaoButtonRef} class="button">
+                Fetch Airport
+              </div>
+              <div style="height:30px;"></div>
+              <Input
+                ref={this.sqlInputRef}
+                textarea
+                value="SELECT airport_name FROM tbl_airports WHERE airport_identifier = 'ESSA'"
+                class="text-field"
+              />
+              <div ref={this.executeSqlButtonRef} class="button">
+                Execute SQL
+              </div>
             </div>
+            <pre ref={this.outputRef} id="output">
+              The output of the query will show up here
+            </pre>
           </div>
-          <pre ref={this.outputRef} id="output">
-            The output of the query will show up here
-          </pre>
         </div>
-      </div>
+      </>
     )
   }
 
   public onAfterRender(node: VNode): void {
     super.onAfterRender(node)
 
-    this.loginButtonRef.instance.addEventListener("click", () => this.handleClick())
-    this.downloadButtonRef.instance.addEventListener("click", () => this.handleDownloadClick())
-
     // Populate status when ready
     this.navigationDataInterface.onReady(() => {
       this.navigationDataInterface
         .get_navigation_data_install_status()
         .then(status => this.navigationDataStatus.set(status))
         .catch(e => console.error(e))
+
+      // show the auth container
+      this.authContainerRef.instance.style.display = "block"
+      this.loadingRef.instance.style.display = "none"
     })
 
+    this.loginButtonRef.instance.addEventListener("click", () => this.handleClick())
+    this.downloadButtonRef.instance.addEventListener("click", () => this.handleDownloadClick())
+
     this.executeIcaoButtonRef.instance.addEventListener("click", () => {
       console.time("query")
       this.navigationDataInterface
diff --git a/src/database/src/database.rs b/src/database/src/database.rs
@@ -76,7 +76,7 @@ impl Database {
     pub fn open_connection(&mut self, path: String) -> Result<(), Box<dyn Error>> {
         // We have to open with flags because the SQLITE_OPEN_CREATE flag with the default open causes the file to
         // be overwritten
-        let flags = OpenFlags::SQLITE_OPEN_READ_WRITE | OpenFlags::SQLITE_OPEN_URI | OpenFlags::SQLITE_OPEN_NO_MUTEX;
+        let flags = OpenFlags::SQLITE_OPEN_READ_ONLY | OpenFlags::SQLITE_OPEN_URI | OpenFlags::SQLITE_OPEN_NO_MUTEX;
         let conn = Connection::open_with_flags(path, flags)?;
         self.database = Some(conn);
 
diff --git a/src/test/setup.ts b/src/test/setup.ts
@@ -157,7 +157,7 @@ let wasmFunctionTable: WebAssembly.Table // The table of callback functions in t
  * Maps request ids to a tuple of the returned data's pointer, and the data's size
  */
 const promiseResults = new Map<bigint, [number, number]>()
-const failedRequests: bigint[] = [];
+const failedRequests: bigint[] = []
 
 wasmInstance = new WebAssembly.Instance(wasmModule, {
   wasi_snapshot_preview1: wasiSystem.wasiImport,
@@ -223,20 +223,20 @@ wasmInstance = new WebAssembly.Instance(wasmModule, {
           func(requestId, 200, ctx)
         })
         .catch(err => {
-          failedRequests.push(requestId);
+          failedRequests.push(requestId)
         })
 
       return requestId
     },
     fsNetworkHttpRequestGetState: (requestId: bigint) => {
-      if(failedRequests.includes(requestId)) {
+      if (failedRequests.includes(requestId)) {
         return 4 // FS_NETWORK_HTTP_REQUEST_STATE_FAILED
       }
-      if(promiseResults.has(requestId)) {
+      if (promiseResults.has(requestId)) {
         return 3 // FS_NETWORK_HTTP_REQUEST_STATE_DATA_READY
       }
       return 2 // FS_NETWORK_HTTP_REQUEST_STATE_WAITING_FOR_DATA
-    }
+    },
   },
 }) as WasmInstance
 
@@ -290,6 +290,15 @@ beforeAll(async () => {
     throw new Error("Please specify the env var `NAVIGATION_DATA_SIGNED_URL`")
   }
 
+  // Utility function to convert onReady to a promise
+  const waitForReady = (navDataInterface: NavigraphNavigationDataInterface): Promise<void> => {
+    return new Promise((resolve, _reject) => {
+      navDataInterface.onReady(() => resolve())
+    })
+  }
+
+  await waitForReady(navigationDataInterface)
+
   await navigationDataInterface.download_navigation_data(downloadUrl)
 }, 30000)
 
diff --git a/src/wasm/src/consts.rs b/src/wasm/src/consts.rs
@@ -1,2 +1,3 @@
 pub const NAVIGATION_DATA_DEFAULT_LOCATION: &str = ".\\NavigationData";
-pub const NAVIGATION_DATA_DOWNLOADED_LOCATION: &str = "\\work/NavigationData";
+pub const NAVIGATION_DATA_WORK_LOCATION: &str = "\\work/NavigationData";
+pub const NAVIGATION_DATA_INTERNAL_CONFIG_LOCATION: &str = "\\work/navigraph_navigation_data_interface_config.json";
diff --git a/src/wasm/src/dispatcher.rs b/src/wasm/src/dispatcher.rs
@@ -1,4 +1,4 @@
-use std::{cell::RefCell, error::Error, path::Path, rc::Rc};
+use std::{cell::RefCell, path::Path, rc::Rc};
 
 use msfs::{commbus::*, network::NetworkRequestState, sys::sGaugeDrawData, MSFSEvent};
 use navigation_database::database::Database;
@@ -11,7 +11,7 @@ use crate::{
         functions::{CallFunction, FunctionResult, FunctionStatus, FunctionType},
         params,
     },
-    meta,
+    meta::{self, InternalState},
     network_helper::NetworkHelper,
     util::{self, path_exists},
 };
@@ -114,39 +114,86 @@ impl<'a> Dispatcher<'a> {
             self.downloader.acknowledge_download();
         }
     }
-
     fn load_database(&mut self) {
         println!("[NAVIGRAPH] Loading database");
-        // First check if we have a database in the downloaded location
-        let found_downloaded = self
-            .set_database_if_exists(consts::NAVIGATION_DATA_DOWNLOADED_LOCATION)
-            .is_ok();
-
-        if found_downloaded {
-            println!("[NAVIGRAPH] Loaded database from downloaded location");
-            return;
-        }
 
-        // If we didn't find a database in the downloaded location, check the default location
-        let found_default = self
-            .set_database_if_exists(consts::NAVIGATION_DATA_DEFAULT_LOCATION)
-            .is_ok();
-
-        if !found_default {
-            println!("[NAVIGRAPH] No database found in default location, not loading any database");
+        // Go through logic to determine which database to load
+
+        // Are we bundled? None means we haven't installed anything yet
+        let is_bundled = meta::get_internal_state()
+            .map(|internal_state| Some(internal_state.is_bundled))
+            .unwrap_or(None);
+
+        // Get the installed cycle (if it exists)
+        let installed_cycle = match meta::get_installed_cycle_from_json(
+            &Path::new(consts::NAVIGATION_DATA_WORK_LOCATION).join("cycle.json"),
+        ) {
+            Ok(cycle) => Some(cycle.cycle),
+            Err(_) => None,
+        };
+
+        // Get the bundled cycle (if it exists)
+        let bundled_cycle = match meta::get_installed_cycle_from_json(
+            &Path::new(consts::NAVIGATION_DATA_DEFAULT_LOCATION).join("cycle.json"),
+        ) {
+            Ok(cycle) => Some(cycle.cycle),
+            Err(_) => None,
+        };
+
+        // Determine if we are bundled ONLY and the bundled cycle is newer than the installed (old bundled) cycle
+        let bundled_updated = if is_bundled.is_some() && is_bundled.unwrap() {
+            if installed_cycle.is_some() && bundled_cycle.is_some() {
+                bundled_cycle.unwrap() > installed_cycle.unwrap()
+            } else {
+                false
+            }
+        } else {
+            false
+        };
+
+        // If there is no addon config, we can assume that we need to copy the bundled database to the work location
+        let need_to_copy = is_bundled.is_none();
+
+        // If we are bundled and the installed cycle is older than the bundled cycle, we need to copy the bundled database to the work location. Or if we haven't installed anything yet, we need to copy the bundled database to the work location
+        if bundled_updated || need_to_copy {
+            match util::copy_files_to_folder(
+                &Path::new(consts::NAVIGATION_DATA_DEFAULT_LOCATION),
+                &Path::new(consts::NAVIGATION_DATA_WORK_LOCATION),
+            ) {
+                Ok(_) => {
+                    // Set the internal state to bundled
+                    let res = meta::set_internal_state(InternalState { is_bundled: true });
+                    if let Err(e) = res {
+                        println!("[NAVIGRAPH] Failed to set internal state: {}", e);
+                    }
+                },
+                Err(e) => {
+                    println!(
+                        "[NAVIGRAPH] Failed to copy database from default location to work location: {}",
+                        e
+                    );
+                    return;
+                },
+            }
         }
-    }
 
-    fn set_database_if_exists(&mut self, path: &str) -> Result<(), Box<dyn Error>> {
-        if path_exists(&Path::new(path)) {
-            self.database.set_active_database(path.to_owned())
+        // Finally, set the active database
+        if path_exists(&Path::new(consts::NAVIGATION_DATA_WORK_LOCATION)) {
+            match self.database.set_active_database(consts::NAVIGATION_DATA_WORK_LOCATION.to_owned()) {
+                Ok(_) => {
+                    println!("[NAVIGRAPH] Loaded database");
+                },
+                Err(e) => {
+                    println!("[NAVIGRAPH] Failed to load database: {}", e);
+                },
+            }
         } else {
-            Err("Path does not exist".into())
+            println!("[NAVIGRAPH] Failed to load database: there is no installed database");
         }
     }
 
     fn on_download_finish(&mut self) {
-        match navigation_database::util::find_sqlite_file(consts::NAVIGATION_DATA_DOWNLOADED_LOCATION) {
+        match navigation_database::util::find_sqlite_file(consts::NAVIGATION_DATA_WORK_LOCATION) {
             Ok(path) => {
                 match self.database.set_active_database(path) {
                     Ok(_) => {},
diff --git a/src/wasm/src/download/downloader.rs b/src/wasm/src/download/downloader.rs
@@ -7,6 +7,7 @@ use crate::{
     dispatcher::{Dispatcher, Task, TaskStatus},
     download::zip_handler::{BatchReturn, ZipFileHandler},
     json_structs::{events, params},
+    meta::{self, InternalState},
 };
 
 pub struct DownloadOptions {
@@ -63,6 +64,11 @@ impl NavigationDataDownloader {
                         borrowed_task.status = TaskStatus::Success(None);
                     }
                     self.download_status.replace(DownloadStatus::Downloaded);
+                    // Update the internal state
+                    let res = meta::set_internal_state(InternalState { is_bundled: false });
+                    if let Err(e) = res {
+                        println!("[NAVIGRAPH] Failed to set internal state: {}", e);
+                    }
                 },
                 Ok(BatchReturn::MoreFilesToDelete) => {
                     self.download_status.replace(DownloadStatus::CleaningDestination);
@@ -181,7 +187,7 @@ impl NavigationDataDownloader {
             return;
         }
 
-        let path = PathBuf::from(consts::NAVIGATION_DATA_DOWNLOADED_LOCATION);
+        let path = PathBuf::from(consts::NAVIGATION_DATA_WORK_LOCATION);
 
         // Check the data from the request
         let data = request.data();
diff --git a/src/wasm/src/meta.rs b/src/wasm/src/meta.rs
diff --git a/src/wasm/src/util.rs b/src/wasm/src/util.rs
