Merge pull request #280 from MikeFalcon77/refactor/rust_2024_edition

chore(Rust): migrate to 2024 edition

Author: MikeFalcon77

CONTRIBUTING.md

@@ -16,7 +16,7 @@ We welcome contributions in:
 
 ### 1.1 Prerequisites
 
-- **Rust stable** with Cargo (Edition 2021)
+- **Rust stable** with Cargo (Edition 2024)
 - **Git** for version control
 - **Your favorite editor** (VS Code with rust-analyzer recommended)
 

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace.package]
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 license = "Apache-2.0"
 authors = ["Hypernetix"]
 repository = "https://github.com/hypernetix/hyperspot"

Cargo.toml

@@ -4,11 +4,11 @@ use anyhow::Result;
 use clap::{Parser, Subcommand};
 use figment::Figment;
 use mimalloc::MiMalloc;
+use modkit::LocalProcessBackend;
 use modkit::bootstrap::config::{
-    get_module_runtime_config, render_module_config_for_oop, AppConfig, RuntimeKind,
+    AppConfig, RuntimeKind, get_module_runtime_config, render_module_config_for_oop,
 };
 use modkit::bootstrap::host::{init_logging_unified, normalize_executable_path};
-use modkit::LocalProcessBackend;
 use tokio_util::sync::CancellationToken;
 
 use std::path::{Path, PathBuf};
@@ -23,7 +23,7 @@ static GLOBAL: MiMalloc = MiMalloc;
 
 // Bring runner types & our per-module DB factory
 use modkit::runtime::{
-    run, shutdown, DbOptions, OopModuleSpawnConfig, OopSpawnOptions, RunOptions, ShutdownOptions,
+    DbOptions, OopModuleSpawnConfig, OopSpawnOptions, RunOptions, ShutdownOptions, run, shutdown,
 };
 
 fn ensure_drivers_linked() {
@@ -115,10 +115,10 @@ async fn main() -> Result<()> {
 
     // One-time connectivity probe
     #[cfg(feature = "otel")]
-    if let Some(tc) = modkit_tracing_config.as_ref() {
-        if let Err(e) = modkit::telemetry::init::otel_connectivity_probe(tc) {
-            tracing::error!(error = %e, "OTLP connectivity probe failed");
-        }
+    if let Some(tc) = modkit_tracing_config.as_ref()
+        && let Err(e) = modkit::telemetry::init::otel_connectivity_probe(tc)
+    {
+        tracing::error!(error = %e, "OTLP connectivity probe failed");
     }
 
     // Smoke test span to confirm traces flow to Jaeger
@@ -285,41 +285,41 @@ fn build_oop_spawn_options(
     let mut modules = Vec::new();
 
     for module_name in config.modules.keys() {
-        if let Some(runtime_cfg) = get_module_runtime_config(config, module_name)? {
-            if runtime_cfg.mod_type == RuntimeKind::Oop {
-                let exec_cfg = runtime_cfg.execution.as_ref().ok_or_else(|| {
-                    anyhow::anyhow!(
-                        "module '{module_name}' is type=oop but execution config is missing"
-                    )
-                })?;
-
-                let binary = normalize_executable_path(&exec_cfg.executable_path)?;
-
-                // Copy args from execution config as-is
-                // User controls --config via execution.args in master config
-                let spawn_args = exec_cfg.args.clone();
-
-                // Copy environment from execution config
-                let env = exec_cfg.environment.clone();
-
-                // Render the complete module config (with resolved DB)
-                let rendered_config = render_module_config_for_oop(config, module_name, &home_dir)?;
-                let rendered_json = rendered_config.to_json()?;
-                tracing::debug!(
-                    module = %module_name,
-                    "Prepared OoP module config: db={}",
-                    rendered_config.database.is_some()
-                );
+        if let Some(runtime_cfg) = get_module_runtime_config(config, module_name)?
+            && runtime_cfg.mod_type == RuntimeKind::Oop
+        {
+            let exec_cfg = runtime_cfg.execution.as_ref().ok_or_else(|| {
+                anyhow::anyhow!(
+                    "module '{module_name}' is type=oop but execution config is missing"
+                )
+            })?;
+
+            let binary = normalize_executable_path(&exec_cfg.executable_path)?;
+
+            // Copy args from execution config as-is
+            // User controls --config via execution.args in master config
+            let spawn_args = exec_cfg.args.clone();
+
+            // Copy environment from execution config
+            let env = exec_cfg.environment.clone();
+
+            // Render the complete module config (with resolved DB)
+            let rendered_config = render_module_config_for_oop(config, module_name, &home_dir)?;
+            let rendered_json = rendered_config.to_json()?;
+            tracing::debug!(
+                module = %module_name,
+                "Prepared OoP module config: db={}",
+                rendered_config.database.is_some()
+            );
 
-                modules.push(OopModuleSpawnConfig {
-                    module_name: module_name.clone(),
-                    binary,
-                    args: spawn_args,
-                    env,
-                    working_directory: exec_cfg.working_directory.clone(),
-                    rendered_config_json: rendered_json,
-                });
-            }
+            modules.push(OopModuleSpawnConfig {
+                module_name: module_name.clone(),
+                binary,
+                args: spawn_args,
+                env,
+                working_directory: exec_cfg.working_directory.clone(),
+                rendered_config_json: rendered_json,
+            });
         }
     }
 

apps/hyperspot-server/src/main.rs

@@ -0,0 +1,206 @@
+# OData Macro Consolidation Migration Guide
+
+## Overview
+
+All OData-related procedural macros have been consolidated into a single crate: **`modkit-odata-macros`**.
+
+## What Changed
+
+### Before
+- `ODataSchema` was in `modkit-sdk-macros`
+- `ODataFilterable` was in `modkit-db-macros`
+- Confusion about which crate owns OData contract generation
+- Database crate (`modkit-db-macros`) contained protocol-level macros
+
+### After
+- **All** OData macros are now in `modkit-odata-macros`
+  - `ODataSchema` - Client-side query builder schema generation
+  - `ODataFilterable` - Server-side filter field enum generation
+- Clear separation: Protocol macros in `modkit-odata-macros`, DB macros in `modkit-db-macros`
+- `modkit-sdk-macros` **removed** (no longer needed)
+- `modkit-db-macros` now contains only `Scopable` (SeaORM security)
+
+## Architecture
+
+```
+modkit-odata-macros/
+├── ODataSchema       → Generates Schema trait for client query building
+└── ODataFilterable   → Generates FilterField enum for server filtering
+
+modkit-sdk-macros/    [REMOVED]
+modkit-db-macros/
+└── Scopable          → SeaORM security scoping (non-OData)
+```
+
+## Migration Steps
+
+### For Server-Side Code (API/Service/Infra)
+
+**Old:**
+```toml
+# Cargo.toml
+[dependencies]
+modkit-db-macros = { path = "../modkit-db-macros" }
+```
+
+```rust
+// src/query/mod.rs
+use modkit_db_macros::ODataFilterable;
+
+#[derive(ODataFilterable)]
+pub struct UserQuery {
+    #[odata(filter(kind = "Uuid"))]
+    pub id: Uuid,
+}
+```
+
+**New:**
+```toml
+# Cargo.toml
+[dependencies]
+modkit-db-macros = { path = "../modkit-db-macros" }        # Still needed for Scopable
+modkit-odata-macros = { path = "../modkit-odata-macros" }  # NEW: For ODataFilterable
+```
+
+```rust
+// src/query/mod.rs
+use modkit_odata_macros::ODataFilterable;  // Changed import
+
+#[derive(ODataFilterable)]
+pub struct UserQuery {
+    #[odata(filter(kind = "Uuid"))]
+    pub id: Uuid,
+}
+```
+
+### For Client-Side Code (SDK)
+
+**Old:**
+```toml
+# Cargo.toml
+[dependencies]
+modkit-sdk = { path = "../modkit-sdk", features = ["derive"] }
+```
+
+```rust
+use modkit_sdk::ODataSchema;  // Re-exported from modkit-sdk
+
+#[derive(ODataSchema)]
+struct User {
+    id: uuid::Uuid,
+    email: String,
+}
+```
+
+**New:**
+```toml
+# Cargo.toml
+[dependencies]
+modkit-sdk = { path = "../modkit-sdk", features = ["derive"] }
+# modkit-sdk now re-exports from modkit-odata-macros internally
+```
+
+```rust
+use modkit_sdk::ODataSchema;  // Still works! Now re-exports from modkit-odata-macros
+
+#[derive(ODataSchema)]
+struct User {
+    id: uuid::Uuid,
+    email: String,
+}
+```
+
+**OR** use directly:
+```rust
+use modkit_odata_macros::ODataSchema;  // Direct import also works
+
+#[derive(ODataSchema)]
+struct User {
+    id: uuid::Uuid,
+    email: String,
+}
+```
+
+## Breaking Changes
+
+### 1. `modkit-sdk-macros` is now empty
+
+**Impact:** If you imported directly from `modkit-sdk-macros`, you **must** update.
+
+```rust
+// ❌ OLD - Will not compile
+use modkit_sdk_macros::ODataSchema;
+
+// ✅ NEW - Use modkit-odata-macros
+use modkit_odata_macros::ODataSchema;
+
+// ✅ OR - Use modkit-sdk re-export
+use modkit_sdk::ODataSchema;
+```
+
+### 2. `ODataFilterable` moved out of `modkit-db-macros`
+
+**Impact:** Must add `modkit-odata-macros` dependency and update imports.
+
+```rust
+// ❌ OLD - Will not compile
+use modkit_db_macros::ODataFilterable;
+
+// ✅ NEW
+use modkit_odata_macros::ODataFilterable;
+```
+
+## Rationale
+
+### Problem
+1. **Layering violation**: `modkit-db-macros` contained protocol-level macros, not DB-specific
+2. **Confusion**: OData macros scattered across `modkit-db-macros` and `modkit-sdk-macros`
+3. **Wrong dependencies**: After moving filter DSL to `modkit-odata`, macros in `modkit-db-macros` referenced `modkit-odata` types, creating circular conceptual dependencies
+
+### Solution
+1. **Single source of truth**: All OData protocol macros in `modkit-odata-macros`
+2. **Clear naming**: "odata-macros" explicitly indicates OData protocol
+3. **Correct layering**: DB macros (`Scopable`) stay in `modkit-db-macros`, OData macros move to `modkit-odata-macros`
+4. **No DB pollution**: OData macros don't pull in SeaORM or database dependencies
+
+## Verification
+
+After migration, verify with:
+```bash
+cargo check -p modkit-odata-macros
+cargo check -p modkit-sdk
+cargo check -p modkit-db-macros
+cargo check -p your-service
+```
+
+## FAQ
+
+**Q: Do I need to change my derive attributes?**  
+A: No, `#[derive(ODataFilterable)]` and `#[derive(ODataSchema)]` work exactly the same way.
+
+**Q: Can I still use `modkit-sdk::ODataSchema`?**  
+A: Yes! `modkit-sdk` now re-exports from `modkit-odata-macros`, so existing code continues to work.
+
+**Q: What happened to `modkit-sdk-macros`?**  
+A: It has been completely removed. All OData macros are now in `modkit-odata-macros`.
+
+**Q: Does this affect runtime behavior?**  
+A: No, this is purely a compile-time/packaging change. Generated code is identical.
+
+**Q: Do tests need to change?**  
+A: Only test imports. Test assertions and behavior remain unchanged.
+
+## Checklist
+
+- [ ] Update `Cargo.toml` to add `modkit-odata-macros` dependency
+- [ ] Change `use modkit_db_macros::ODataFilterable` to `use modkit_odata_macros::ODataFilterable`
+- [ ] Change `use modkit_sdk_macros::*` to `use modkit_odata_macros::*` (if importing directly)
+- [ ] Run `cargo check` to verify compilation
+- [ ] Run tests to verify functionality
+- [ ] Update any documentation references
+
+## References
+
+- Filter DSL migration: See earlier migration that moved filter types from `modkit-db` to `modkit-odata`
+- Macro crate source: `libs/modkit-odata-macros/`
+- Generated code inspection: `cargo expand --package your-crate`

docs/ODATA_MACRO_MIGRATION.md

@@ -18,7 +18,7 @@ resolver = "2"
 
 [workspace.package]
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 license = "Apache-2.0"
 authors = ["Hypernetix"]
 

dylint_lints/Cargo.toml

@@ -3,7 +3,7 @@ name = "de0101_no_serde_in_contract"
 version = "0.1.0"
 authors = ["authors go here"]
 description = "description goes here"
-edition = "2024"
+edition.workspace = true
 publish = false
 
 [lib]

dylint_lints/de01_contract_layer/de0101_no_serde_in_contract/Cargo.toml

@@ -3,7 +3,7 @@ name = "de0102_no_toschema_in_contract"
 version = "0.1.0"
 authors = ["authors go here"]
 description = "Contract models should not have ToSchema derive (DE0102)"
-edition = "2024"
+edition.workspace = true
 publish = false
 
 [lib]

dylint_lints/de01_contract_layer/de0102_no_toschema_in_contract/Cargo.toml

@@ -3,7 +3,7 @@ name = "de0103_no_http_types_in_contract"
 version = "0.1.0"
 authors = ["authors go here"]
 description = "Contract modules should not reference HTTP types (DE0103)"
-edition = "2024"
+edition.workspace = true
 publish = false
 
 [lib]

dylint_lints/de01_contract_layer/de0103_no_http_types_in_contract/Cargo.toml

@@ -3,7 +3,7 @@ name = "de0110_no_schema_for_on_gts_structs"
 version = "0.1.0"
 authors = ["Hypernetix"]
 description = "Prohibit using schemars::schema_for!() on GTS-wrapped structs"
-edition = "2024"
+edition.workspace = true
 publish = false
 
 [lib]