feat: optional config

Author: pepperoni505

README.md

@@ -2,8 +2,8 @@
 
 The Navigraph Navigation Data Interface enables developers to download and integrate navigation data from Navigraph directly into add-on aircraft in MSFS.
 
-
 ## Key Features
+
 - Navigraph DFD Format: Leverage specialized support for Navigraph's DFD format, based on SQLite, which includes an SQL interface on the commbus for efficient data handling.
 - Javascript and WASM support: The navdata interface is accessible from both Javascript (Coherent) and WASM, providing flexibility for developers.
 - Supports updating of custom data formats.
@@ -29,22 +29,36 @@ Here's an overview on the structure of this repository, which is designed to be
 1. You'll need to either build the WASM module yourself (not recommended, but documented further down) or download it from [the latest release](https://github.com/Navigraph/msfs-navigation-data-interface/releases) (alternatively you can download it off of a commit by looking at the uploaded artifacts).
 2. Add the WASM module into your `panel` folder in `PackageSources`
 3. Add the following entry into `panel.cfg` (make sure to replace `NN` with the proper `VCockpit` ID):
+
    ```
    [VCockpitNN]
    size_mm=0,0
    pixel_size=0,0
    texture=NO_TEXTURE
    htmlgauge00=WasmInstrument/WasmInstrument.html?wasm_module=msfs_navigation_data_interface.wasm&wasm_gauge=navigation_data_interface,0,0,1,1
    ```
+
    - Note that if you already have a `VCockpit` with `NO_TEXTURE` you can just add another `htmlgauge` to it, while making sure to increase the index
+4. **Optional**: Create a `Navigraph/config.json` file to assist with Sentry reports. This info will be reported to us should any error occur in the library. We will use this to directly reach out to you (the developer) for these errors.
+
+    - The file must look like
+
+    ```json
+    {
+      "addon": {
+        "developer": "Navigraph",
+        "product": "Sample Aircraft"
+      }
+    }
+    ```
 
 ## Dealing with Bundled Navigation Data
 
-If you bundle outdated navigation data in your aircraft and you want this module to handle updating it for users with subscriptions, place the navigation data into the `NavigationData` directory in `PackageSources`. You can see an example [here](examples/aircraft/PackageSources/NavigationData/)
+If you bundle outdated navigation data in your aircraft and you want this module to handle updating it for users with subscriptions, place the navigation data into the `Navigraph/BundledData` directory in `PackageSources`. You can see an example [here](examples/aircraft/PackageSources/Navigraph/BundledData/)
 
 ## 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. (although it gets copied into the `work` directory at runtime)
+The default location for navigation data is `work/NavigationData`.
 
 ## Building the Sample Aircraft
 

examples/aircraft/PackageDefinitions/navigraph-aircraft-navigation-data-interface-sample.xml

@@ -27,13 +27,13 @@
 			<AssetDir>PackageSources\Data\</AssetDir>
 			<OutputDir>Data\</OutputDir>
 		</AssetGroup>
-		<AssetGroup Name="NavigationData">
+		<AssetGroup Name="Navigraph">
 			<Type>Copy</Type>
 			<Flags>
 				<FSXCompatibility>false</FSXCompatibility>
 			</Flags>
-			<AssetDir>PackageSources\NavigationData\</AssetDir>
-			<OutputDir>NavigationData\</OutputDir>
+			<AssetDir>PackageSources\Navigraph\</AssetDir>
+			<OutputDir>Navigraph\</OutputDir>
 		</AssetGroup>
 		<AssetGroup Name="SimObject">
 			<Type>SimObject</Type>
@@ -53,4 +53,3 @@
 		</AssetGroup>
 	</AssetGroups>
 </AssetPackage>
-

examples/aircraft/PackageSources/NavigationData/cycle.json renamed to examples/aircraft/PackageSources/Navigraph/BundledData/cycle.json

@@ -0,0 +1,6 @@
+{
+    "addon": {
+        "developer": "Navigraph",
+        "product": "Sample Aircraft"
+    }
+}

examples/aircraft/PackageSources/NavigationData/db.s3db renamed to examples/aircraft/PackageSources/Navigraph/BundledData/db.s3db

@@ -0,0 +1,29 @@
+use std::fs::File;
+
+use anyhow::Result;
+use serde::Deserialize;
+
+/// The path to an optional addon-specific config file containing data about the addon
+const ADDON_CONFIG_FILE: &str = ".\\Navigraph/config.json";
+
+/// Information about the current addon
+#[derive(Deserialize)]
+pub struct Addon {
+    pub developer: String,
+    pub product: String,
+}
+
+/// Configuration data provided by the developer
+#[derive(Deserialize)]
+pub struct Config {
+    pub addon: Addon,
+}
+
+impl Config {
+    /// Try to get the config
+    pub fn get_config() -> Result<Self> {
+        let file = File::open(ADDON_CONFIG_FILE)?;
+
+        Ok(serde_json::from_reader(file)?)
+    }
+}

examples/aircraft/PackageSources/Navigraph/config.json

@@ -47,7 +47,7 @@ pub const WORK_CYCLE_JSON_PATH: &str = "\\work/NavigationData/cycle.json";
 /// The path to the "master" SQLite DB
 pub const WORK_DB_PATH: &str = "\\work/NavigationData/db.s3db";
 /// The folder name for bundled navigation data
-pub const BUNDLED_FOLDER_NAME: &str = ".\\NavigationData";
+pub const BUNDLED_FOLDER_NAME: &str = ".\\Navigraph/BundledData";
 
 /// The global exported database state
 pub static DATABASE_STATE: Lazy<Mutex<DatabaseState>> =
@@ -143,6 +143,8 @@ impl DatabaseState {
     fn new() -> Self {
         // Start out with a fresh instance
         let mut instance = Self::default();
+
+        // Try to load a DB
         match instance.try_load_db() {
             Ok(()) => {}
             Err(e) => {

src/wasm/src/config.rs

@@ -1,4 +1,4 @@
-use std::{cell::RefCell, collections::VecDeque, rc::Rc, time::Instant};
+use std::{cell::RefCell, collections::VecDeque, fs::File, rc::Rc, time::Instant};
 
 use anyhow::{anyhow, Result};
 use funcs::{InterfaceFunction, RunStatus};
@@ -7,9 +7,15 @@ use sentry::{integrations::anyhow::capture_anyhow, protocol::Context};
 use sentry_gauge::{wrap_gauge_with_sentry, SentryGauge};
 use serde::Serialize;
 
+/// Developer-configured values for interface
+mod config;
+/// SQLite mapping implementation
 mod database;
+/// Interface function definitions
 mod funcs;
+/// Futures implementations for use in interface functions
 mod futures;
+/// The sentry wrapper implementation around the MSFS gauge callbacks
 mod sentry_gauge;
 
 /// Amount of MS between dispatches of the heartbeat commbus event

src/wasm/src/database/mod.rs

@@ -1,5 +1,5 @@
 use std::{
-    fs::{File, OpenOptions},
+    fs::OpenOptions,
     sync::{Arc, Mutex},
     time::{Duration, Instant},
 };
@@ -15,6 +15,8 @@ use sentry::integrations::anyhow::capture_anyhow;
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 
+use crate::config::Config;
+
 /// The path to the sentry persistent state file
 const SENTRY_FILE: &str = "\\work/ng_sentry.json";
 
@@ -246,12 +248,19 @@ where
         .user_id
         .to_string();
 
-    // Configure the sentry scope to report the user ID
+    // Configure the sentry scope to report the user ID and sentry config (if present)
     sentry::configure_scope(|scope| {
         scope.set_user(Some(sentry::User {
             id: Some(user_id),
             ..Default::default()
         }));
+
+        if let Ok(config) = Config::get_config() {
+            scope.set_tag(
+                "addon",
+                format!("{}/{}", config.addon.developer, config.addon.product),
+            );
+        }
     });
 
     // Drain any pending reports. We need to structure it like this as opposed to just a top level `let Ok(state) = ...`` due to the fact we should not be holding a MutexGuard across an await point