hot reloading should be behind feature (#3)

Author: TitanNano

.github/workflows/ci.yaml

@@ -20,6 +20,8 @@ jobs:
       uses: actions/checkout@v3
     - name: Setup Cache
       uses: Swatinem/rust-cache@v2
+      with:
+        cache-on-failure: true
     - name: Install Tools
       run: cargo install clippy-sarif sarif-fmt
     - name: Build Debug
@@ -36,8 +38,7 @@ jobs:
       with:
         sarif_file: rust-build-results.sarif
         wait-for-processing: true 
-  
-  
+
   clippy:
     runs-on: "ubuntu-22.04"
 
@@ -59,4 +60,18 @@ jobs:
         if: ${{ always() }}
         with:
           sarif_file: rust-clippy-results.sarif
-          wait-for-processing: true 
+          wait-for-processing: true
+
+  tests:
+    runs-on: "ubuntu-22.04"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: Tests
+        run: |
+          cargo test

Cargo.lock

@@ -11,8 +11,6 @@ edition = "2021"
 
 [workspace.dependencies]
 godot = { git = "https://github.com/titannano/gdext", rev = "0f9a3e22f9cbdc31e0c575a12c69d26241a92f9f" }
-#godot = { path = "../gdext/godot" }
-backtrace = "0.3.64"
 hot-lib-reloader = "0.6.5"
 itertools = "0.10.3"
 abi_stable = { version = "0.11.2", default-features = false }

Cargo.toml

@@ -7,15 +7,19 @@ edition.workspace = true
 
 [dependencies]
 godot.workspace = true
-backtrace.workspace = true
-hot-lib-reloader.workspace = true
 itertools.workspace = true
 abi_stable.workspace = true
 rand.workspace = true
 cfg-if.workspace = true
-process_path.workspace = true
+
+hot-lib-reloader = { workspace = true, optional = true }
+process_path = { workspace = true, optional = true }
 
 godot-rust-script-derive.workspace = true
 
 [dev-dependencies]
-tests-scripts-lib = { path = "../tests-scripts-lib" }
+tests-scripts-lib = { path = "../tests-scripts-lib", features = ["hot-reload"] }
+
+[features]
+default = ["hot-reload"]
+hot-reload = ["dep:process_path", "dep:hot-lib-reloader"]

rust-script/Cargo.toml

@@ -12,6 +12,8 @@ pub mod private_export {
     pub use super::script_registry::RemoteVariantType;
     pub use abi_stable::std_types::{RStr, RString, RVec};
     pub use godot::sys::{plugin_add, plugin_registry};
+
+    #[cfg(all(feature = "hot-reload", debug_assertions))]
     pub use hot_lib_reloader::{self, hot_module};
 }
 

rust-script/src/lib.rs

@@ -1,4 +1,4 @@
-#[cfg(debug_assertions)]
+#[cfg(all(feature = "hot-reload", debug_assertions))]
 mod hot_reloader;
 mod resource_loader;
 mod resource_saver;
@@ -28,13 +28,13 @@ use crate::{
 
 use self::rust_script_language::RustScriptLanguage;
 
-#[cfg(debug_assertions)]
+#[cfg(all(feature = "hot-reload", debug_assertions))]
 use hot_reloader::{HotReloadEntry, HotReloader};
 
 #[macro_export]
 macro_rules! setup {
     ($lib_crate:tt) => {
-        #[cfg(debug_assertions)]
+        #[cfg(all(feature = "hot-reload", debug_assertions))]
         #[$crate::private_export::hot_module(dylib = stringify!($lib_crate), lib_dir=process_path::get_dylib_path().and_then(|path| path.parent().map(std::path::Path::to_path_buf)).unwrap_or_default())]
         mod scripts_lib {
             use $crate::private_export::RVec;
@@ -54,7 +54,7 @@ macro_rules! setup {
             pub use ::$lib_crate::__GODOT_RUST_SCRIPT_SRC_ROOT;
         }
 
-        #[cfg(not(debug_assertions))]
+        #[cfg(not(all(feature = "hot-reload", debug_assertions)))]
         mod scripts_lib {
             pub use ::$lib_crate::{__godot_rust_script_init, __GODOT_RUST_SCRIPT_SRC_ROOT};
         }
@@ -67,15 +67,15 @@ macro_rules! init {
         $crate::RustScriptExtensionLayer::new(
             scripts_lib::__godot_rust_script_init,
             scripts_lib::__GODOT_RUST_SCRIPT_SRC_ROOT,
-            #[cfg(debug_assertions)]
+            #[cfg(all(feature = "hot-reload", debug_assertions))]
             scripts_lib::subscribe,
         )
     };
 }
 
 thread_local! {
     static SCRIPT_REGISTRY: RwLock<HashMap<String, ScriptMetaData>> = RwLock::default();
-    #[cfg(debug_assertions)]
+    #[cfg(all(feature = "hot-reload", debug_assertions))]
     static HOT_RELOAD_BRIDGE: std::cell::RefCell<HashMap<rust_script_instance::RustScriptInstanceId, std::cell::RefCell<HotReloadEntry>>> = std::cell::RefCell::default();
 }
 
@@ -86,7 +86,7 @@ pub trait RustScriptLibInit: Fn(Option<BindingInit>) -> RVec<RemoteScriptMetaDat
 impl<F> RustScriptLibInit for F where F: Fn(Option<BindingInit>) -> RVec<RemoteScriptMetaData> {}
 
 cfg_if! {
-    if #[cfg(debug_assertions)] {
+    if #[cfg(all(feature = "hot-reload", debug_assertions))] {
         type HotReloadSubscribe = fn() -> hot_lib_reloader::LibReloadObserver;
     }
 }
@@ -98,18 +98,19 @@ pub struct RustScriptExtensionLayer {
     res_loader: Option<Gd<RustScriptResourceLoader>>,
     scripts_src_dir: Option<&'static str>,
 
-    #[cfg(debug_assertions)]
+    #[cfg(all(feature = "hot-reload", debug_assertions))]
     hot_reload_subscribe: HotReloadSubscribe,
 
-    #[cfg(debug_assertions)]
+    #[cfg(all(feature = "hot-reload", debug_assertions))]
     hot_reloader: Option<Gd<HotReloader>>,
 }
 
 impl RustScriptExtensionLayer {
     pub fn new<F: RustScriptLibInit + 'static + Clone>(
         lib_init_fn: F,
         scripts_src_dir: &'static str,
-        #[cfg(debug_assertions)] hot_reload_subscribe: HotReloadSubscribe,
+        #[cfg(all(feature = "hot-reload", debug_assertions))]
+        hot_reload_subscribe: HotReloadSubscribe,
     ) -> Self {
         Self {
             lib_init_fn: Rc::new(lib_init_fn),
@@ -118,10 +119,10 @@ impl RustScriptExtensionLayer {
             res_loader: None,
             scripts_src_dir: Some(scripts_src_dir),
 
-            #[cfg(debug_assertions)]
+            #[cfg(all(feature = "hot-reload", debug_assertions))]
             hot_reload_subscribe,
 
-            #[cfg(debug_assertions)]
+            #[cfg(all(feature = "hot-reload", debug_assertions))]
             hot_reloader: None,
         }
     }
@@ -134,7 +135,7 @@ impl RustScriptExtensionLayer {
         let res_saver = Gd::new(RustScriptResourceSaver);
 
         cfg_if! {
-            if #[cfg(debug_assertions)] {
+            if #[cfg(all(feature = "hot-reload", debug_assertions))] {
                 use godot::prelude::StringName;
 
                 let mut hot_reloader = Gd::with_base(|base| HotReloader::new((self.hot_reload_subscribe)(), self.lib_init_fn.clone(), base));
@@ -179,7 +180,7 @@ impl RustScriptExtensionLayer {
 
 fn load_rust_scripts(lib_init_fn: Rc<dyn RustScriptLibInit>) {
     cfg_if! {
-        if #[cfg(debug_assertions)] {
+        if #[cfg(all(feature = "hot-reload", debug_assertions))] {
             let ffi_init = Some(unsafe { godot::sys::get_binding() });
         } else {
             let ffi_init = None;
@@ -239,17 +240,3 @@ impl ToDictionary for MethodInfo {
         })
     }
 }
-
-#[cfg(test)]
-mod test {
-    mod macros_test {
-        crate::setup!(tests_scripts_lib);
-
-        #[test]
-        fn verify_macros() {
-            let inst = crate::init!();
-
-            assert_eq!(inst.lang, None);
-        }
-    }
-}