diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 941c8a099..000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Bug -about: Notify that an error has ben found on the app and what happened. -title: '' -labels: Bug -assignees: '' - ---- - -**Bug Description** -What is happening? - -**Steps to reproduce** -How do I replicate the issue, what where you doing? - -**Screenshots** -Provide screenshots, videos, links, etc. - -**Context** -What is your environment? - -Fill the following information and add any relevant information: -*OS*: Windows, Mac, Linux, Android, iOS... -*Browser*: Chrome, Opera, Firefox, Safari... -*App Version*: v1.0.0 - -**Notes** -Extra information relevant to the issue. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 6aee6e0d5..000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature -about: Propose a feature to be added to the application. -title: '' -labels: Feature -assignees: '' - ---- - -**Feature description** -What is the feature supposed to do, what will it include? - -**Possible solutions** -What are the possible ways to implement this feature that you can think of? - -**Notes** -What context / extra information is required to understand the proposal? diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md deleted file mode 100644 index 8a717356d..000000000 --- a/.github/ISSUE_TEMPLATE/task.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Task -about: Tasks are units of work assigned to members to be completed. -title: '' -labels: Task -assignees: '' - ---- - -**Description** -Brief description of the task and important details - -**Related** -Related Issues, PRs, Documents, etc. - -**Notes** -Extra information that might be good to know about it diff --git a/.github/workflows/rust-tests.yaml b/.github/workflows/rust-tests.yaml new file mode 100644 index 000000000..6ab44a9ce --- /dev/null +++ b/.github/workflows/rust-tests.yaml @@ -0,0 +1,30 @@ +name: Rust Tests + +on: + pull_request: + paths: + - "backend/**" + - ".github/workflows/rust-tests.yaml" + +jobs: + test: + name: Test (${{ matrix.crate }}) + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + crate: [software-core, station] + steps: + - uses: actions/checkout@v4 + + - name: Set up Rust + uses: dtolnay/rust-toolchain@stable + + - name: Cache cargo + uses: Swatinem/rust-cache@v2 + with: + workspaces: backend + + - name: Run tests + working-directory: backend + run: cargo test --package ${{ matrix.crate }} diff --git a/.gitignore b/.gitignore index bc66fec72..35fee63ab 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,11 @@ # Monorepo / IDE node_modules/ .turbo/ -.vscode/ +.vscode/* +!.vscode/settings.json +!.vscode/extensions.json +!.vscode/launch.json +!.vscode/tasks.json .DS_Store *.code-workspace diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..37006f2d8 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,9 @@ +{ + "recommendations": [ + "rust-lang.rust-analyzer", + "dbaeumer.vscode-eslint", + "esbenp.prettier-vscode", + "ms-python.python", + "tamasfe.even-better-toml" + ] +} diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 000000000..617eff252 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,15 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "lldb", + "request": "launch", + "name": "Debug Backend (Rust)", + "program": "${workspaceFolder}/backend/target/debug/station", + "args": [], + "cwd": "${workspaceFolder}/backend/crates/station", + "preLaunchTask": "Build Backend (Rust)", + "sourceLanguages": ["rust"] + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json index 9ef398bb3..6f381d6a0 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -50,5 +50,33 @@ "editor.codeActionsOnSave": { "source.fixAll.rust-analyzer": "explicit" } + }, + "rust-analyzer.linkedProjects": ["backend/Cargo.toml"], + "rust-analyzer.check.command": "clippy", + "rust-analyzer.check.extraArgs": ["--all-targets"], + + // ESLint: each frontend/* package has its own flat eslint.config.js + "eslint.workingDirectories": [{ "mode": "auto" }], + + // Python: blcu-programming is the only Python project, venv created by + // its postinstall script (blcu-programming/scripts/setup.mjs) + "python.defaultInterpreterPath": "${workspaceFolder}/blcu-programming/.venv/bin/python", + + // Keep VS Code from indexing/watching generated and vendored trees + "files.watcherExclude": { + "**/node_modules/**": true, + "**/target/**": true, + "**/dist/**": true, + "**/.venv/**": true, + "**/.venv-build/**": true, + "**/.turbo/**": true + }, + "search.exclude": { + "**/node_modules": true, + "**/target": true, + "**/dist": true, + "**/.venv": true, + "**/.venv-build": true, + "**/.turbo": true } } diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 000000000..10489440d --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,187 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Run Testing View", + "type": "shell", + "command": "pnpm", + "args": ["dev", "--filter", "testing-view"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "dedicated" + } + }, + { + "label": "Run Competition View", + "type": "shell", + "command": "pnpm", + "args": ["dev", "--filter", "competition-view"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "dedicated" + } + }, + { + "label": "Run Flashing View", + "type": "shell", + "command": "pnpm", + "args": ["dev", "--filter", "flashing-view"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "dedicated" + } + }, + { + "label": "Run Logging View", + "type": "shell", + "command": "pnpm", + "args": ["dev", "--filter", "logging-view"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "dedicated" + } + }, + { + "label": "Run ADJ View", + "type": "shell", + "command": "pnpm", + "args": ["dev", "--filter", "adj-view"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "dedicated" + } + }, + { + "label": "Run Backend (Rust)", + "type": "shell", + "command": "cargo", + "args": ["run", "--package", "station"], + "options": { + "cwd": "${workspaceFolder}/backend" + }, + "problemMatcher": ["$rustc"], + "presentation": { + "reveal": "always", + "panel": "dedicated" + } + }, + { + "label": "Run Python (BLCU Programming)", + "type": "shell", + "command": "pnpm", + "args": ["dev", "--filter", "blcu-programming"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "dedicated" + } + }, + { + "label": "Build App", + "type": "shell", + "command": "pnpm", + "args": ["run", "build"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "group": "build" + }, + { + "label": "Build Backend (Rust)", + "type": "shell", + "command": "cargo", + "args": ["build", "--package", "station"], + "options": { + "cwd": "${workspaceFolder}/backend" + }, + "problemMatcher": ["$rustc"], + "group": "build" + }, + { + "label": "Test App", + "type": "shell", + "command": "pnpm", + "args": ["run", "test"], + "options": { + "cwd": "${workspaceFolder}" + }, + "problemMatcher": [], + "group": "test" + }, + { + "label": "Test Backend (Rust)", + "type": "shell", + "command": "cargo test ${input:rustTestScope} ${input:rustTestFilter}", + "options": { + "cwd": "${workspaceFolder}/backend" + }, + "problemMatcher": ["$rustc"], + "group": "test" + }, + { + "label": "Clippy Backend (Rust)", + "type": "shell", + "command": "cargo", + "args": ["clippy", "--workspace", "--all-targets", "--", "-D", "warnings"], + "options": { + "cwd": "${workspaceFolder}/backend" + }, + "problemMatcher": ["$rustc"], + "group": "test" + }, + { + "label": "Format Backend (Rust)", + "type": "shell", + "command": "cargo", + "args": ["fmt", "--all"], + "options": { + "cwd": "${workspaceFolder}/backend" + }, + "problemMatcher": [], + "group": "none" + } + ], + "inputs": [ + { + "id": "rustTestScope", + "type": "pickString", + "description": "¿Qué crate del backend querés testear?", + "options": [ + { "label": "Todo el workspace", "value": "--workspace" }, + { "label": "software-core", "value": "-p software-core" }, + { "label": "station", "value": "-p station" } + ], + "default": "--workspace" + }, + { + "id": "rustTestFilter", + "type": "promptString", + "description": "Filtro de test/módulo dentro del crate elegido (ej. adj::tests, vacío = todos)", + "default": "" + } + ] +} diff --git a/backend/.gitignore b/backend/.gitignore index 384729b1f..d51409096 100644 --- a/backend/.gitignore +++ b/backend/.gitignore @@ -1,22 +1,7 @@ -log -trace.json - +/target /bin -# Test coverage -*testfile - -# Build artifacts -/bin/ -backend -trace.json - -# Test data -*.out -c.out - -# Logs -cmd/logger/ -cmd/cmd -cmd/adj -/logger/ \ No newline at end of file +# Backend runtime output +/logger/ +*.log +*.csv diff --git a/backend/Cargo.lock b/backend/Cargo.lock new file mode 100644 index 000000000..5ed9308bd --- /dev/null +++ b/backend/Cargo.lock @@ -0,0 +1,3859 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "aho-corasick" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c982642fa9e8606056828ee9a8505737230110bb1099153c79efe865c59d12ba" +dependencies = [ + "memchr", +] + +[[package]] +name = "allocator-api2" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923" + +[[package]] +name = "arc-swap" +version = "1.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "84a22b5d51209f6de83d37a0b33d320acb8da88823e42a94c075140708f032a5" +dependencies = [ + "rustversion", +] + +[[package]] +name = "arrayvec" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3fb67a6e08acf24fdeccbac2cb6ac4305825bd1f117462e0e6f2f193345ad56" + +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + +[[package]] +name = "autocfg" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53" + +[[package]] +name = "aws-lc-rs" +version = "1.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "048006790404103c488e6c5616b3e7e702a71292aadda08e8f7698a9e0d2eb53" +dependencies = [ + "aws-lc-sys", + "zeroize", +] + +[[package]] +name = "aws-lc-sys" +version = "0.47.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8bfbe32ac36b3c428696ce315464181bc4029d689fd58e3f2a4e58c252242f52" +dependencies = [ + "cc", + "cmake", + "dunce", + "fs_extra", + "pkg-config", +] + +[[package]] +name = "axum" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "31b698c5f9a010f6573133b09e0de5408834d0c82f8d7475a89fc1867a71cd90" +dependencies = [ + "axum-core", + "base64 0.22.1", + "bytes", + "form_urlencoded", + "futures-util", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-util", + "itoa", + "matchit", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "serde_core", + "serde_json", + "serde_path_to_error", + "serde_urlencoded", + "sha1", + "sync_wrapper", + "tokio", + "tokio-tungstenite", + "tower", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "axum-core" +version = "0.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08c78f31d7b1291f7ee735c1c6780ccde7785daae9a9206026862dab7d8792d1" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "http-body-util", + "mime", + "pin-project-lite", + "sync_wrapper", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" + +[[package]] +name = "base64" +version = "0.23.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac07cdecf99051d9a5238b80f35af32cdeba5b336e55d957b318b50137e18da5" + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "bitflags" +version = "2.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06" + +[[package]] +name = "block-buffer" +version = "0.10.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71" +dependencies = [ + "generic-array", +] + +[[package]] +name = "bstr" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6bb31b46c14244e20ee9984b11bf5c992b91fb6939fea616e3512c8baecdbe5f" +dependencies = [ + "memchr", + "regex-automata", + "serde_core", +] + +[[package]] +name = "bumpalo" +version = "3.20.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649" + +[[package]] +name = "byteorder" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" + +[[package]] +name = "bytes" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04" + +[[package]] +name = "bytesize" +version = "2.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7354288c522e7e980fafd2075d63d1285794c3a6a16cdd492f189ea406e5f18b" + +[[package]] +name = "cc" +version = "1.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33ef9e3e8154a45c7a95cff4c1299702106ad94062d7bb85fdc5d3a5afd91d45" +dependencies = [ + "find-msvc-tools", + "jobserver", + "libc", + "shlex", +] + +[[package]] +name = "cfg-if" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600" + +[[package]] +name = "cfg_aliases" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f079e83a288787bcd14a6aea84cee5c87a67c5a3e660c30f557a3d24761b3527" + +[[package]] +name = "chacha20" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65c35e4b699c7e15ccbe7ee35c005e4fc0a278d22238a2857e6ce2dadeda1b06" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "rand_core 0.10.1", +] + +[[package]] +name = "clru" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "197fd99cb113a8d5d9b6376f3aa817f32c1078f2343b714fff7d2ca44fdf67d5" +dependencies = [ + "hashbrown 0.16.1", +] + +[[package]] +name = "cmake" +version = "0.1.58" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0f78a02292a74a88ac736019ab962ece0bc380e3f977bf72e376c5d78ff0678" +dependencies = [ + "cc", +] + +[[package]] +name = "combine" +version = "4.6.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4356eba6976435498d05a311ee9fc486da3bc81c200d3f0d7dd9703b41913f92" +dependencies = [ + "bytes", + "memchr", +] + +[[package]] +name = "core-foundation" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2a6cd9ae233e7f62ba4e9353e81a88df7fc8a5987b8d445b4d90c879bd156f6" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" + +[[package]] +name = "core_detect" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f8f80099a98041a3d1622845c271458a2d73e688351bf3cb999266764b81d48" + +[[package]] +name = "cpufeatures" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280" +dependencies = [ + "libc", +] + +[[package]] +name = "cpufeatures" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ca28b0ae3115b884660db4118d803791fd6756b6e88f39c0f3f7859060d7566" +dependencies = [ + "libc", +] + +[[package]] +name = "crc32fast" +version = "1.5.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b929dd2a135771f40afabd1073f85eed59c800b7c61901e5c254270497dad64" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "crossbeam-channel" +version = "0.5.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "98b0cc327b5bc766e7fda9c9260cc0fa81b43a8e240440422dff70788e3f9ef1" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-deque" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "622f3fc73690be383c7214310406f28a90e6edeadc3cea882f9d71e495b9711a" +dependencies = [ + "crossbeam-epoch", + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-epoch" +version = "0.9.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc74980687109a3b14c72fd458107bf0baa1da1a1a805e178d15501ba9b86d9d" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-utils" +version = "0.8.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a31eee39dddec8330830986fcd7625edb5a24ec90ea038215273bbc3adb08ac6" + +[[package]] +name = "crypto-common" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78c8292055d1c1df0cce5d180393dc8cce0abec0a7102adb6c7b1eef6016d60a" +dependencies = [ + "generic-array", + "typenum", +] + +[[package]] +name = "dashmap" +version = "6.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6361d5c062261c78a176addb82d4c821ae42bed6089de0e12603cd25de2059c" +dependencies = [ + "cfg-if", + "crossbeam-utils", + "hashbrown 0.14.5", + "lock_api", + "once_cell", + "parking_lot_core", +] + +[[package]] +name = "data-encoding" +version = "2.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4583a4551df46e2792f82ceeac45e850d2e2d5debba0b91f102385cda5b11f06" + +[[package]] +name = "defmt" +version = "0.3.101" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4deef977660e373c458df605a913d4ab121db0ccd18d1ad6976dff7d37cddb53" +dependencies = [ + "defmt 1.2.0", +] + +[[package]] +name = "defmt" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4a0795ac740cb54d7b3775c9c17345f6aaecf884c01733b39d6017738e0e3e1" +dependencies = [ + "bitflags 1.3.2", + "defmt-macros", +] + +[[package]] +name = "defmt-macros" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "840bb056bd99c495c9188198a258ab787c79f306d864db3e6e8451442d6d8366" +dependencies = [ + "defmt-parser", + "proc-macro2", + "quote", + "syn 3.0.10", +] + +[[package]] +name = "defmt-parser" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "71958f69fb2de856c5dd51ac9377e986ca1aa5919f931bf5395a807277f889a0" +dependencies = [ + "thiserror", +] + +[[package]] +name = "deranged" +version = "0.5.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e9de72ce2ad1f90dc62fa25f0f430ef85eb4b0d8fa0be4f30373bc40a21d28e" + +[[package]] +name = "digest" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292" +dependencies = [ + "block-buffer", + "crypto-common", +] + +[[package]] +name = "dirs" +version = "7.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8d57d423b3c82e89b9a24ca3091fee61f456a26edbd28d26c65906f4bc1dcd8f" +dependencies = [ + "dirs-sys", +] + +[[package]] +name = "dirs-sys" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e01a3366d27ee9890022452ee61b2b63a67e6f13f58900b651ff5665f0bb1fab" +dependencies = [ + "libc", + "option-ext", + "redox_users", + "windows-sys 0.61.2", +] + +[[package]] +name = "displaydoc" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6232dd377dcc64799954cbd3a9bb882e9cdc1308ccd87b1c098f1fb2eaf82a8" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", +] + +[[package]] +name = "dunce" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813" + +[[package]] +name = "encoding_rs" +version = "0.8.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "89253175e704ab869b04f9db224d38630e0211a53841a79181deae0889e169f5" +dependencies = [ + "cfg-if", + "core_detect", + "multiversion_no_op", + "rustversion", + "scopeguard", + "simdutf8", +] + +[[package]] +name = "equivalent" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00d174d5400e5e8fd687ad1049e2f578285fa914201b1af7e8b112a4546bd826" + +[[package]] +name = "errno" +version = "0.3.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e35d6e78f4cebb90e51d543db8fe41528851d6deeef6ef21ebd4bfdc1e784776" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "faster-hex" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04839bdf9d8c10f66806fad16b852fc72aab80873aebc3cb69d85b4fa41543ed" +dependencies = [ + "autocfg", + "defmt 0.3.101", + "heapless", + "serde", +] + +[[package]] +name = "fastrand" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da7c62ceae207dd37ea5b845da6a0696c799f85e97da1ab5b7910be3c1c80223" + +[[package]] +name = "filetime" +version = "0.2.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c287a33c7f0a620c38e641e7f60827713987b3c0f26e8ddc9462cc69cf75759" +dependencies = [ + "cfg-if", + "libc", +] + +[[package]] +name = "find-msvc-tools" +version = "0.1.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c66915cc5391097de7a2b0b972e8505aa33c0df401fd3a6811dbdb32881ba48" + +[[package]] +name = "fnv" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" + +[[package]] +name = "foldhash" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" + +[[package]] +name = "form_urlencoded" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" +dependencies = [ + "percent-encoding", +] + +[[package]] +name = "fs_extra" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42703706b716c37f96a77aea830392ad231f44c9e9a67872fa5548707e11b11c" + +[[package]] +name = "futures-channel" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f9e3d69d39e4862ffed03ed071a76f9a13ba1d9109d355b0f0aa6b15e393c4" +dependencies = [ + "futures-core", + "futures-sink", +] + +[[package]] +name = "futures-core" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92d699e522242e69e3003b94ecc1f960f3a5e015aa7c5d7486e65ad01dd94f5e" + +[[package]] +name = "futures-io" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed" + +[[package]] +name = "futures-sink" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1944426bf7d03f1d14f708785e4b33efd750b36d48a157b836b3efc15ede8e1d" + +[[package]] +name = "futures-task" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd417de3d1d015fc3bfd2b1ea46dfc7bab72ef86f1cc7cc9c78e728b34a6d1fd" + +[[package]] +name = "futures-util" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d50a92467f8ba5dd6e3ee5d4bd04d73ab2e4e1c44474a0674821dfce14b79bc" +dependencies = [ + "futures-core", + "futures-io", + "futures-sink", + "futures-task", + "memchr", + "pin-project-lite", + "slab", +] + +[[package]] +name = "generic-array" +version = "0.14.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a" +dependencies = [ + "typenum", + "version_check", +] + +[[package]] +name = "getrandom" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "wasi 0.11.1+wasi-snapshot-preview1", + "wasm-bindgen", +] + +[[package]] +name = "getrandom" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "899def5c37c4fd7b2664648c28120ecec138e4d395b459e5ca34f9cce2dd77fd" +dependencies = [ + "cfg-if", + "libc", + "r-efi 5.3.0", + "wasip2", +] + +[[package]] +name = "getrandom" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "300e883d756b2e4ec94e02791f39b04b522276138852cfc41d9fb7e904106099" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "r-efi 6.0.0", + "rand_core 0.10.1", + "wasm-bindgen", +] + +[[package]] +name = "gix" +version = "0.87.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fdefc1465d8631807deaf504dacdeff628b978de515653b47976ca7c28ab2a7a" +dependencies = [ + "gix-actor", + "gix-archive", + "gix-attributes", + "gix-blame", + "gix-command", + "gix-commitgraph", + "gix-config", + "gix-credentials", + "gix-date", + "gix-diff", + "gix-dir", + "gix-discover", + "gix-error", + "gix-features", + "gix-filter", + "gix-fs", + "gix-glob", + "gix-hash", + "gix-hashtable", + "gix-ignore", + "gix-index", + "gix-lock", + "gix-mailmap", + "gix-merge", + "gix-negotiate", + "gix-note", + "gix-object", + "gix-odb", + "gix-pack", + "gix-path", + "gix-pathspec", + "gix-prompt", + "gix-protocol", + "gix-quote", + "gix-ref", + "gix-refspec", + "gix-revision", + "gix-revwalk", + "gix-sec", + "gix-shallow", + "gix-status", + "gix-submodule", + "gix-tempfile", + "gix-trace", + "gix-transport", + "gix-traverse", + "gix-url", + "gix-utils", + "gix-validate", + "gix-worktree", + "gix-worktree-state", + "gix-worktree-stream", + "gix-zlib", + "nonempty", + "parking_lot", + "regex", + "signal-hook", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-actor" +version = "0.42.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e37efa99929ac62f980fb1a7dcd09dea85b3aa6ead6ba0498362add3f4e698de" +dependencies = [ + "bstr", + "gix-date", + "gix-error", +] + +[[package]] +name = "gix-archive" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c4ef97efd3920d3525104c5f253dec94dc935f953a50055954939177aed2cdd" +dependencies = [ + "bstr", + "gix-date", + "gix-error", + "gix-object", + "gix-worktree-stream", +] + +[[package]] +name = "gix-attributes" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "76b83782ac69ae28921a6e8fbcf2e24069613f1518030b97ae622b079abffa54" +dependencies = [ + "bstr", + "gix-features", + "gix-glob", + "gix-path", + "gix-quote", + "gix-trace", + "smallvec", + "thiserror", + "unicode-bom", +] + +[[package]] +name = "gix-bitmap" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f17013c7ef5cb95ebb4bf4978201e6a8a42ffea9d666fd5388f1b7e742307d80" +dependencies = [ + "gix-error", +] + +[[package]] +name = "gix-blame" +version = "0.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "54fe27f8037c58cb4b6d60fe0aacf7ee2c998633cedf4e989351c07d9a3a575d" +dependencies = [ + "gix-commitgraph", + "gix-date", + "gix-diff", + "gix-error", + "gix-hash", + "gix-object", + "gix-revwalk", + "gix-trace", + "gix-traverse", + "gix-worktree", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-chunk" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00e32f938b3745ac93d73bc7490b6a15a661b2fc81973bfe90e275cc53c908e1" +dependencies = [ + "gix-error", +] + +[[package]] +name = "gix-command" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa00adbd2c77f584cfe41f348772d2f131af1fa519a7f6b98638f1144ead96a4" +dependencies = [ + "bstr", + "gix-path", + "gix-quote", + "gix-trace", +] + +[[package]] +name = "gix-commitgraph" +version = "0.39.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b93c9fb1f5be01bba54a7a3b7455d359efc68555539c75ef74b8021bb6db497" +dependencies = [ + "bstr", + "gix-chunk", + "gix-error", + "gix-hash", + "memmap2", + "nonempty", +] + +[[package]] +name = "gix-config" +version = "0.60.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f973c28c0a4871a7926fc90c8377d4458fd6cbb19692f56582b4d2022313ae90" +dependencies = [ + "bstr", + "gix-config-value", + "gix-features", + "gix-glob", + "gix-path", + "gix-ref", + "gix-sec", + "gix-utils", + "smallvec", + "thiserror", + "unicode-bom", +] + +[[package]] +name = "gix-config-value" +version = "0.19.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f6af5321bfd3711a279d6b244d58532ba1cfabf9eb6374791f19929d8970082" +dependencies = [ + "bitflags 2.13.2", + "bstr", + "gix-path", + "libc", + "thiserror", +] + +[[package]] +name = "gix-credentials" +version = "0.40.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16c11822054fd4b80a1ab722b703f2e7c691b20484d898374289b742c1f49e50" +dependencies = [ + "bstr", + "gix-command", + "gix-config-value", + "gix-date", + "gix-path", + "gix-prompt", + "gix-quote", + "gix-sec", + "gix-trace", + "gix-url", + "thiserror", +] + +[[package]] +name = "gix-date" +version = "0.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e63d9aa18f29facd571c8953e66224ee0075b9e16622024794555ed4acceea85" +dependencies = [ + "bstr", + "gix-error", + "itoa", + "jiff", +] + +[[package]] +name = "gix-diff" +version = "0.67.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b1689ff5ddeee4acfb2a43e875a1072a76d208624b15a9065c938b39cb0da2a" +dependencies = [ + "bstr", + "gix-attributes", + "gix-command", + "gix-filter", + "gix-fs", + "gix-hash", + "gix-imara-diff", + "gix-index", + "gix-object", + "gix-path", + "gix-pathspec", + "gix-tempfile", + "gix-trace", + "gix-traverse", + "gix-worktree", + "thiserror", +] + +[[package]] +name = "gix-dir" +version = "0.29.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8342d5eb0ea054ed6ef807e628e38f06dd51eceeec9529767d8b23e33eff9c09" +dependencies = [ + "bstr", + "gix-discover", + "gix-fs", + "gix-ignore", + "gix-index", + "gix-object", + "gix-path", + "gix-pathspec", + "gix-trace", + "gix-utils", + "gix-worktree", + "thiserror", +] + +[[package]] +name = "gix-discover" +version = "0.55.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec32a30ec2934735599c2545f30067e80bd255fd3454b52a5d59bc02b52874a3" +dependencies = [ + "bstr", + "dunce", + "gix-fs", + "gix-path", + "gix-ref", + "gix-sec", + "thiserror", +] + +[[package]] +name = "gix-error" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a1ba536602db507119eb5f3cdf80bef3ca5a5ec0dfc6e9c7f46dc70ade7c112" +dependencies = [ + "bstr", +] + +[[package]] +name = "gix-features" +version = "0.49.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39c0e59d9d253dcccc38c3a46b91bfb9b46bd63eed54fe1a719e12194884d52a" +dependencies = [ + "bytes", + "bytesize", + "crc32fast", + "crossbeam-channel", + "gix-path", + "gix-trace", + "gix-utils", + "libc", + "once_cell", + "parking_lot", + "prodash", + "walkdir", +] + +[[package]] +name = "gix-filter" +version = "0.34.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c30b28d957e2e6f1e1bbfbfd26b8e0bb0aab68d8a5e730fb4fd3049943575e3" +dependencies = [ + "bstr", + "encoding_rs", + "gix-attributes", + "gix-command", + "gix-hash", + "gix-object", + "gix-packetline", + "gix-path", + "gix-quote", + "gix-trace", + "gix-utils", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-fs" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebcfa9fd253f25350a3b21b3dd74034a446098e373c6123d4cee3519894f12ef" +dependencies = [ + "bstr", + "gix-features", + "gix-path", + "gix-utils", + "thiserror", +] + +[[package]] +name = "gix-glob" +version = "0.27.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b417cf515fd8c91468b578071f76d6cba716f8a1eccd853906bff4908b2c1413" +dependencies = [ + "bitflags 2.13.2", + "bstr", + "gix-features", + "gix-path", +] + +[[package]] +name = "gix-hash" +version = "0.26.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "380b9c423a54f0821064b954b5a5ab25c660812f6a91da03c3f1cb4b10762aa5" +dependencies = [ + "faster-hex", + "gix-features", + "sha1-checked", + "thiserror", +] + +[[package]] +name = "gix-hashtable" +version = "0.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78fccd6fea3bcf0b39c076bae60ae49b08daaf538b950202101a981f9d3c01d3" +dependencies = [ + "gix-hash", + "hashbrown 0.17.1", + "parking_lot", +] + +[[package]] +name = "gix-ignore" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65859a2f7de5e159d4344a5486ebf53b6bac22d5ec6afa836e47c10ae88a7f0f" +dependencies = [ + "bstr", + "gix-glob", + "gix-path", + "gix-trace", + "unicode-bom", +] + +[[package]] +name = "gix-imara-diff" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c91d8cffac8849493a82233811bd02b2b183b8cf39bf704de0fa0841b737595" +dependencies = [ + "bstr", + "hashbrown 0.17.1", +] + +[[package]] +name = "gix-index" +version = "0.55.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "632e16cb48b0e88a747e106924cb2765194105d8070a7a961b0d080ed806c632" +dependencies = [ + "bitflags 2.13.2", + "bstr", + "filetime", + "fnv", + "gix-bitmap", + "gix-features", + "gix-fs", + "gix-hash", + "gix-lock", + "gix-object", + "gix-traverse", + "gix-utils", + "gix-validate", + "hashbrown 0.17.1", + "itoa", + "libc", + "memmap2", + "rustix", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-lock" +version = "24.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d4c69157820343bf1c6e4b88b9808e920900de02e18aaf5862b30ada43814848" +dependencies = [ + "gix-tempfile", + "gix-utils", + "thiserror", +] + +[[package]] +name = "gix-macros" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3836b4b051393464a753c5a08fe19c7ce0d8b77574a92bd558972941d4553cb" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "gix-mailmap" +version = "0.34.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a1c6ca2f9481e5e98b3600b859bc595d46cdf3b600709d5f91b8c118ae452a1" +dependencies = [ + "bstr", + "gix-actor", + "gix-date", + "gix-error", +] + +[[package]] +name = "gix-merge" +version = "0.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72fad4279c940a0fa460ffdf3a3c0e48b7ca5ccb2b08f51a02b22ffcd1efb900" +dependencies = [ + "bstr", + "gix-command", + "gix-diff", + "gix-filter", + "gix-fs", + "gix-hash", + "gix-imara-diff", + "gix-index", + "gix-object", + "gix-path", + "gix-quote", + "gix-revision", + "gix-revwalk", + "gix-tempfile", + "gix-trace", + "gix-worktree", + "nonempty", + "thiserror", +] + +[[package]] +name = "gix-negotiate" +version = "0.35.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91068ecee956121d663635b873ae87ad9c5d3f2d6788facfd12829140b39c897" +dependencies = [ + "bitflags 2.13.2", + "gix-commitgraph", + "gix-date", + "gix-hash", + "gix-object", + "gix-revwalk", +] + +[[package]] +name = "gix-note" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9af6bbdb3f3c62b4920407c479af1cc0beb27fd75a762782d48baed53d330958" +dependencies = [ + "gix-error", + "gix-hash", + "gix-hashtable", + "gix-object", +] + +[[package]] +name = "gix-object" +version = "0.64.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56fef799ca40cdeab4de5a3e74a696d8fa9b9c6264592646bf022e026f13ce2c" +dependencies = [ + "bstr", + "gix-actor", + "gix-command", + "gix-date", + "gix-features", + "gix-hash", + "gix-hashtable", + "gix-tempfile", + "gix-utils", + "gix-validate", + "itoa", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-odb" +version = "0.84.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf45d195b71cb6363886e7b466821bf4dffd7aba1b6b814ff75488e0061d72a7" +dependencies = [ + "arc-swap", + "gix-features", + "gix-fs", + "gix-hash", + "gix-hashtable", + "gix-object", + "gix-pack", + "gix-path", + "gix-quote", + "gix-zlib", + "memmap2", + "parking_lot", + "tempfile", + "thiserror", +] + +[[package]] +name = "gix-pack" +version = "0.74.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d199d515cbdcf05f531f3859be9771fc12acac7b7fe0f5b581b2c1ab1c3a61e" +dependencies = [ + "clru", + "crossbeam-deque", + "gix-chunk", + "gix-error", + "gix-features", + "gix-hash", + "gix-hashtable", + "gix-object", + "gix-path", + "gix-tempfile", + "gix-zlib", + "memmap2", + "parking_lot", + "smallvec", + "thiserror", + "uluru", +] + +[[package]] +name = "gix-packetline" +version = "0.22.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "792bd92bea390087e6223b18d4d023decc36467de31e6b066b69b94beea1b9e2" +dependencies = [ + "bstr", + "faster-hex", + "gix-trace", + "thiserror", +] + +[[package]] +name = "gix-path" +version = "0.12.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38fc6f029ea67de83cbcbd33fd98c05a48360d2932b39d9fdacbc6eae802d475" +dependencies = [ + "bstr", + "gix-trace", + "gix-validate", + "thiserror", +] + +[[package]] +name = "gix-pathspec" +version = "0.20.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c92e44c63ba53bb55aa88ee48847664beae9446417621582fb14dfc69b2f8c72" +dependencies = [ + "bitflags 2.13.2", + "bstr", + "gix-attributes", + "gix-config-value", + "gix-glob", + "gix-path", + "thiserror", +] + +[[package]] +name = "gix-prompt" +version = "0.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "802256e13ecb2133ba5f9e6acbaa6b08bac027b1c5929f85f6adbb56ba3a4f28" +dependencies = [ + "gix-command", + "gix-config-value", + "parking_lot", + "rustix", + "thiserror", +] + +[[package]] +name = "gix-protocol" +version = "0.65.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68878c37ae168b474c762d70adc8a8e0f9323ed0d80444a672e2eb561fa16691" +dependencies = [ + "bstr", + "gix-credentials", + "gix-date", + "gix-features", + "gix-hash", + "gix-lock", + "gix-macros", + "gix-negotiate", + "gix-object", + "gix-ref", + "gix-refspec", + "gix-revwalk", + "gix-shallow", + "gix-trace", + "gix-transport", + "gix-utils", + "nonempty", + "thiserror", +] + +[[package]] +name = "gix-quote" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f74795eb76eab8313063849f9cbd2bbcdc6e4692f71c1d7d0244ab11cd777329" +dependencies = [ + "bstr", + "gix-error", + "gix-utils", +] + +[[package]] +name = "gix-ref" +version = "0.67.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8328387e7ab354e1dc3afb63e6b4d1866f82d7ce035222bc9d5baaf36bc88020" +dependencies = [ + "gix-actor", + "gix-features", + "gix-fs", + "gix-hash", + "gix-lock", + "gix-object", + "gix-path", + "gix-tempfile", + "gix-utils", + "gix-validate", + "memmap2", + "thiserror", +] + +[[package]] +name = "gix-refspec" +version = "0.45.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7de280d46e8fd9e4d3e7e2ab4276b965e377ba68b2b9a8fce56371015e8bb059" +dependencies = [ + "bstr", + "gix-hash", + "gix-validate", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-revision" +version = "0.49.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4577b864c3e134697e91564553e43230c2e401bb1bcc51cfa998edca21c95078" +dependencies = [ + "bitflags 2.13.2", + "bstr", + "gix-commitgraph", + "gix-date", + "gix-error", + "gix-hash", + "gix-hashtable", + "gix-object", + "gix-revwalk", + "gix-trace", + "nonempty", +] + +[[package]] +name = "gix-revwalk" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "248823eefe405e2c0754b74f6f43ab6faab68670cdbf2d6e114cb0471f766450" +dependencies = [ + "gix-commitgraph", + "gix-date", + "gix-error", + "gix-hash", + "gix-hashtable", + "gix-object", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-sec" +version = "0.14.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af4fe6c152c1d50aea36f299825702cd37e303307832fec1d0fdd5844e47ce2f" +dependencies = [ + "bitflags 2.13.2", + "gix-path", + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "gix-shallow" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ecc9f4b40537043e4bbd7d3d1760e74fb8e7b07a546166b558acaa73ad97f4a" +dependencies = [ + "bstr", + "gix-hash", + "gix-lock", + "nonempty", + "thiserror", +] + +[[package]] +name = "gix-status" +version = "0.34.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1401d871c01d82add5a9f654439b00722d0c632b332cd2cb63193f94327c8458" +dependencies = [ + "bstr", + "filetime", + "gix-diff", + "gix-dir", + "gix-features", + "gix-filter", + "gix-fs", + "gix-hash", + "gix-index", + "gix-object", + "gix-path", + "gix-pathspec", + "gix-worktree", + "hashbrown 0.16.1", + "portable-atomic", + "thiserror", + "windows-sys 0.61.2", +] + +[[package]] +name = "gix-submodule" +version = "0.34.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da85564d6725c483b8d95d7b31d1db0b78c29e462a2b481949e2f18e1ed55a6a" +dependencies = [ + "bstr", + "gix-config", + "gix-path", + "gix-pathspec", + "gix-refspec", + "gix-url", + "thiserror", +] + +[[package]] +name = "gix-tempfile" +version = "24.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b675b920bd5a61d17ad542772f03ec34c60feb8ff683e1560c03ae967363731e" +dependencies = [ + "dashmap", + "gix-fs", + "libc", + "parking_lot", + "signal-hook", + "signal-hook-registry", + "tempfile", +] + +[[package]] +name = "gix-trace" +version = "0.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be3eb81d9dc914335923e50d52829c551feefd6a72d176c4130c546b67a60814" + +[[package]] +name = "gix-transport" +version = "0.59.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b3f41a64939953ff49117df4eb91334d299abc59ff57a90fb2193d8ffa5886f1" +dependencies = [ + "base64 0.22.1", + "bstr", + "gix-command", + "gix-credentials", + "gix-features", + "gix-packetline", + "gix-path", + "gix-quote", + "gix-sec", + "gix-url", + "parking_lot", + "reqwest", + "thiserror", +] + +[[package]] +name = "gix-traverse" +version = "0.61.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9af3503668739f4de5dba57fe15cfd9adc443b08bcbbf195e5de16b648872245" +dependencies = [ + "bitflags 2.13.2", + "gix-commitgraph", + "gix-date", + "gix-hash", + "gix-hashtable", + "gix-object", + "gix-revwalk", + "smallvec", + "thiserror", +] + +[[package]] +name = "gix-url" +version = "0.38.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5bda80ccb4bc81fb9fb07a975916eb0c7a889bcbcb0c8a239c3f82a9cc2abdda" +dependencies = [ + "bstr", + "gix-path", + "gix-utils", + "percent-encoding", + "thiserror", +] + +[[package]] +name = "gix-utils" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0da1c46491b49458a446cc76f0085860f8164c2290742e0aa8c653ce67240a97" +dependencies = [ + "bstr", + "fastrand", + "getrandom 0.4.3", + "unicode-normalization", +] + +[[package]] +name = "gix-validate" +version = "0.11.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4dae8780f63ed8a803b8bdabbd7aa5f5c5d74592c8b50eed875c1bb4f6545a6a" +dependencies = [ + "bstr", +] + +[[package]] +name = "gix-worktree" +version = "0.56.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ed36b627476e2072c129900a17c977a38052b5497e27308159bc881fbf4eecf" +dependencies = [ + "bstr", + "gix-attributes", + "gix-features", + "gix-fs", + "gix-glob", + "gix-hash", + "gix-ignore", + "gix-index", + "gix-object", + "gix-path", + "gix-validate", +] + +[[package]] +name = "gix-worktree-state" +version = "0.34.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c14faa5b9527823c656a033e841dde11ca5b774f1bca7a9cdc23db677e55d56" +dependencies = [ + "bstr", + "gix-features", + "gix-filter", + "gix-fs", + "gix-index", + "gix-object", + "gix-path", + "gix-worktree", + "io-close", + "thiserror", +] + +[[package]] +name = "gix-worktree-stream" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "de5ec0ccbab39c9994656ea031ded8ffd90b370a3cc8e360fbe3c4ebe7c64964" +dependencies = [ + "gix-attributes", + "gix-error", + "gix-features", + "gix-filter", + "gix-fs", + "gix-hash", + "gix-object", + "gix-path", + "gix-traverse", + "parking_lot", +] + +[[package]] +name = "gix-zlib" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e8813f5579b3075ff9c90f7c59cd2b62b4ebb639361f0911648b22d7446cc7c" +dependencies = [ + "thiserror", + "zlib-rs", +] + +[[package]] +name = "h2" +version = "0.4.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d29020232d6aa3fb1daca64c1127cf662cf97f254ae16c18c05b8ab635fc118" +dependencies = [ + "atomic-waker", + "bytes", + "fnv", + "futures-core", + "futures-sink", + "http", + "indexmap", + "slab", + "tokio", + "tokio-util", + "tracing", +] + +[[package]] +name = "hash32" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47d60b12902ba28e2730cd37e95b8c9223af2808df9e902d4df49588d1470606" +dependencies = [ + "byteorder", +] + +[[package]] +name = "hashbrown" +version = "0.14.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" + +[[package]] +name = "hashbrown" +version = "0.16.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "841d1cc9bed7f9236f321df977030373f4a4163ae1a7dbfe1a51a2c1a51d9100" +dependencies = [ + "allocator-api2", + "equivalent", + "foldhash", +] + +[[package]] +name = "hashbrown" +version = "0.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" +dependencies = [ + "allocator-api2", + "equivalent", + "foldhash", +] + +[[package]] +name = "heapless" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bfb9eb618601c89945a70e254898da93b13be0388091d42117462b265bb3fad" +dependencies = [ + "hash32", + "stable_deref_trait", +] + +[[package]] +name = "http" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "918d3568bebf352712bc2ef3d46a8bcf1a75b373be6539de198e9105cbbf9ce0" +dependencies = [ + "bytes", + "itoa", +] + +[[package]] +name = "http-body" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca2a8f2913ee65f60facd6a5905613afaa448497a0230cc41ce022d93290bc2c" +dependencies = [ + "bytes", + "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23169fe34a5fbcdd3f3862e78fb9b6fccd5f02a6dc6f732547005d45631ce71c" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "pin-project-lite", +] + +[[package]] +name = "httparse" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" + +[[package]] +name = "httpdate" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df3b46402a9d5adb4c86a0cf463f42e19994e3ee891101b1841f30a545cb49a9" + +[[package]] +name = "human_format" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eaec953f16e5bcf6b8a3cb3aa959b17e5577dbd2693e94554c462c08be22624b" + +[[package]] +name = "hyper" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2c3e324da4c95177d6291d4c8730197c0d1822f8a9766814a4a44fa5ab797c9c" +dependencies = [ + "atomic-waker", + "bytes", + "futures-channel", + "futures-core", + "h2", + "http", + "http-body", + "httparse", + "httpdate", + "itoa", + "pin-project-lite", + "smallvec", + "tokio", + "want", +] + +[[package]] +name = "hyper-rustls" +version = "0.27.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dfa8e654703247911e29c23fbeaa261834bd9bb74efba2f9acddc37bfb127f53" +dependencies = [ + "http", + "hyper", + "hyper-util", + "rustls", + "tokio", + "tokio-rustls", + "tower-service", +] + +[[package]] +name = "hyper-util" +version = "0.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddc03d96684f9226b8a787cdb71488417b53ab5ea8fdb1dac946cb9431cc8bff" +dependencies = [ + "base64 0.23.1", + "bytes", + "futures-channel", + "futures-util", + "http", + "http-body", + "httparse", + "hyper", + "ipnet", + "libc", + "percent-encoding", + "pin-project-lite", + "socket2", + "tokio", + "tower-service", + "tracing", +] + +[[package]] +name = "icu_collections" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fe090a42a0d3140fed8c63263ed1fecc02422cb2f4bfe55cd8de2de1b8e105dd" +dependencies = [ + "displaydoc", + "potential_utf", + "utf8_iter", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locale_core" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "25d29b57c17c6528d0dc4c2141cfa2d08200465acb537a3909c8b9b8a4a984c0" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_normalizer" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "404a3b8c486f205c87fe7f23ab6894d84a4ad76d6e4671ae1981ba7def87c599" +dependencies = [ + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "20f0088bfb7441f7a37fa0c9e20cb1e9cba1cac6b9ce8cd2a6dc44294f8e8cbc" + +[[package]] +name = "icu_properties" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ea83d991c56158f7cf898bf86436c1dfe7c07ee82fe88951f2695c9f37a379f" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locale_core", + "icu_properties_data", + "icu_provider", + "zerotrie", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b98f29af82d02b163fe50161388350e743bb3107cc8e8c2f7314cb505faddfcf" + +[[package]] +name = "icu_provider" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "413099315636c588ee8f011190b329b971a09a8fae9d157e01dcae8379468514" +dependencies = [ + "displaydoc", + "icu_locale_core", + "writeable", + "yoke", + "zerofrom", + "zerotrie", + "zerovec", +] + +[[package]] +name = "idna" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb68373c0d6620ef8105e855e7745e18b0d00d3bdb07fb532e434244cdb9a714" +dependencies = [ + "icu_normalizer", + "icu_properties", +] + +[[package]] +name = "indexmap" +version = "2.14.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855" +dependencies = [ + "equivalent", + "hashbrown 0.17.1", +] + +[[package]] +name = "io-close" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9cadcf447f06744f8ce713d2d6239bb5bde2c357a452397a9ed90c625da390bc" +dependencies = [ + "libc", + "winapi", +] + +[[package]] +name = "ipnet" +version = "2.12.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0" + +[[package]] +name = "itoa" +version = "1.0.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3bd1574e617a9a6c1f8f8181bd7e841e1f20e4277607ef28945765188d6284d4" + +[[package]] +name = "jiff" +version = "0.2.43" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "26699905cc795a23e3949585cc7ba3ee8ade090872a27e4316304a777297894a" +dependencies = [ + "jiff-core", + "jiff-static", + "jiff-tzdb-platform", + "log", + "portable-atomic", + "portable-atomic-util", + "serde_core", + "windows-link", +] + +[[package]] +name = "jiff-core" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ffe6854081f5ac0a3046a9b223729ccd7a20b1e0e8277e44dc0660eedf67dfe2" +dependencies = [ + "log", +] + +[[package]] +name = "jiff-static" +version = "0.2.43" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b4ff49b2887190c760b86207b55cdcaabbdecaf7a0660d68aa2ed6f652abf0a" +dependencies = [ + "jiff-core", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "jiff-tzdb" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa8377070c6bae868759445e5a77f66d84f0b72f3a054bfb00e6d038b8282da7" + +[[package]] +name = "jiff-tzdb-platform" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "875a5a69ac2bab1a891711cf5eccbec1ce0341ea805560dcd90b7a2e925132e8" +dependencies = [ + "jiff-tzdb", +] + +[[package]] +name = "jni" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5efd9a482cf3a427f00d6b35f14332adc7902ce91efb778580e180ff90fa3498" +dependencies = [ + "cfg-if", + "combine", + "jni-macros", + "jni-sys", + "log", + "simd_cesu8", + "thiserror", + "walkdir", + "windows-link", +] + +[[package]] +name = "jni-macros" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a00109accc170f0bdb141fed3e393c565b6f5e072365c3bd58f5b062591560a3" +dependencies = [ + "proc-macro2", + "quote", + "rustc_version", + "simd_cesu8", + "syn 2.0.119", +] + +[[package]] +name = "jni-sys" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6377a88cb3910bee9b0fa88d4f42e1d2da8e79915598f65fb0c7ee14c878af2" +dependencies = [ + "jni-sys-macros", +] + +[[package]] +name = "jni-sys-macros" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38c0b942f458fe50cdac086d2f946512305e5631e720728f2a61aabcd47a6264" +dependencies = [ + "quote", + "syn 2.0.119", +] + +[[package]] +name = "jobserver" +version = "0.1.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c00acbd29eabad4a2392fa0e921c874934dbbf4194312ad20f04a0ed67a3cb3" +dependencies = [ + "getrandom 0.4.3", + "libc", +] + +[[package]] +name = "js-sys" +version = "0.3.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8dc09d2154098bbf4ef54eab6b117a3c24cbbffe94046b16ee6d6d4510584d3a" +dependencies = [ + "cfg-if", + "futures-util", + "wasm-bindgen", +] + +[[package]] +name = "lazy_static" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "20870f649af7073d53e38067b2a84312175d56ea15217e1b15bc83506ec50afb" + +[[package]] +name = "libc" +version = "0.2.191" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65cd87c9a6d60536580b316ad985726104730a5151c99845f2490428ef91240a" + +[[package]] +name = "libredox" +version = "0.1.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61ff90caf6077a803a240f62fdbe88645a890bbca49ef8174c3cb0404362171d" +dependencies = [ + "libc", +] + +[[package]] +name = "linux-raw-sys" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" + +[[package]] +name = "litemap" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47d9d19d1d6efa0109d2f65ff4c85cddd50bd572e5a00127ab10987290bcefae" + +[[package]] +name = "lock_api" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "224399e74b87b5f3557511d98dff8b14089b3dadafcab6bb93eab67d3aace965" +dependencies = [ + "scopeguard", +] + +[[package]] +name = "log" +version = "0.4.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d15f86d12da44cd8d4ec3c73984537eb7f4cadcb9776a575a0a8a05ca11005c" + +[[package]] +name = "lru-slab" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4050469837a6ff301cd14c1f8f24f88549e6d548f24f64e2148eb0f72cebc51f" + +[[package]] +name = "matchers" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1525a2a28c7f4fa0fc98bb91ae755d1e2d1505079e05539e35bc876b5d65ae9" +dependencies = [ + "regex-automata", +] + +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + +[[package]] +name = "memchr" +version = "2.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98" + +[[package]] +name = "memmap2" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b0ca1155a9ecc25aa12e8313a119f32edf0255fea2f44839c4ac0a12b2ac157" +dependencies = [ + "libc", +] + +[[package]] +name = "mime" +version = "0.3.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d5848f5a9e8117cf94f2f90faac24a87ff81600ff8628c1e3deaab572e76bfa1" + +[[package]] +name = "mio" +version = "1.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1788edb87fdc09c7e26304471e2f5be8cdefb1b6930d6e3985fc02ff53bf86ee" +dependencies = [ + "libc", + "wasi 0.11.1+wasi-snapshot-preview1", + "windows-sys 0.61.2", +] + +[[package]] +name = "multiversion_no_op" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "743fb55ba31b18fb1ecef6bdc9aa2743314978ac084044301a7eee33fb99a20d" + +[[package]] +name = "nonempty" +version = "0.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9737e026353e5cd0736f98eddae28665118eb6f6600902a7f50db585621fecb6" + +[[package]] +name = "ntp_usg-proto" +version = "5.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "31316ff46fc87e03a95e55b93525a27feecfd86fab094ca887a773395f13f50a" +dependencies = [ + "byteorder", + "log", +] + +[[package]] +name = "ntp_usg-server" +version = "5.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0002bd55912864af88a46077abd71db2c4cda88887b46b19c31e1e9a1f289e4e" +dependencies = [ + "ntp_usg-proto", + "tokio", + "tracing", +] + +[[package]] +name = "nu-ansi-term" +version = "0.50.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7957b9740744892f114936ab4a57b3f487491bbeafaf8083688b16841a4240e5" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "num-conv" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "521739c6d2bac4aa25192232afe6841231376b2b26d4d9fae5ecf8ca5772e441" + +[[package]] +name = "objc2-core-foundation" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2a180dd8642fa45cdb7dd721cd4c11b1cadd4929ce112ebd8b9f5803cc79d536" +dependencies = [ + "bitflags 2.13.2", +] + +[[package]] +name = "objc2-system-configuration" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7216bd11cbda54ccabcab84d523dc93b858ec75ecfb3a7d89513fa22464da396" +dependencies = [ + "objc2-core-foundation", +] + +[[package]] +name = "once_cell" +version = "1.21.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" + +[[package]] +name = "openssl-probe" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e036b411754132fd6b74e94b74e9a13c5cf606fa93d1885c35860d3060820b1" + +[[package]] +name = "option-ext" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" + +[[package]] +name = "parking_lot" +version = "0.12.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93857453250e3077bd71ff98b6a65ea6621a19bb0f559a85248955ac12c45a1a" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2621685985a2ebf1c516881c026032ac7deafcda1a2c9b7850dc81e3dfcb64c1" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall", + "smallvec", + "windows-link", +] + +[[package]] +name = "percent-encoding" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + +[[package]] +name = "pin-project-lite" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" + +[[package]] +name = "pkg-config" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6b464fbc74e149a392436b17d523f769e057cb6877f6a5c4618bc6f11800548" + +[[package]] +name = "portable-atomic" +version = "1.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85" + +[[package]] +name = "portable-atomic-util" +version = "0.2.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10ab3eb7f3becc3a1cbc4f2c6f20267996cfc1a6467a873763411b136a122715" +dependencies = [ + "portable-atomic", +] + +[[package]] +name = "potential_utf" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d83eb9bc6d8e5cf568e7a1101d60ee05e81ed50ea106026f3d18deeb046d7661" +dependencies = [ + "zerovec", +] + +[[package]] +name = "powerfmt" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a6394b9e965e73d0a289ee54f589087e2c676aedf60885baf52c76b771e4958" + +[[package]] +name = "ppv-lite86" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" +dependencies = [ + "zerocopy", +] + +[[package]] +name = "proc-macro2" +version = "1.0.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "prodash" +version = "31.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf52d87428247c5aa3760ac8e7d8b13ec7b3579b955a8c3f311668b6860acba5" +dependencies = [ + "bytesize", + "human_format", + "parking_lot", +] + +[[package]] +name = "quinn" +version = "0.11.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4051e23e9185c255a7e33ef59cdbca87a22d359052eecd22fc6b901fb37d9d11" +dependencies = [ + "bytes", + "cfg_aliases", + "pin-project-lite", + "quinn-proto", + "quinn-udp", + "rustc-hash", + "rustls", + "socket2", + "thiserror", + "tokio", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-proto" +version = "0.11.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0e750cca55fe4f0439a15d0bb529da9651e79993e8e72c61a899a36d462befbe" +dependencies = [ + "aws-lc-rs", + "bytes", + "getrandom 0.4.3", + "lru-slab", + "rand 0.10.3", + "rand_pcg", + "ring", + "rustc-hash", + "rustls", + "rustls-pki-types", + "slab", + "thiserror", + "tinyvec", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-udp" +version = "0.5.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af66907df18639dcf4db56ca65490cabc4b27a97dbadd96f2926cca73298f016" +dependencies = [ + "cfg_aliases", + "libc", + "once_cell", + "socket2", + "tracing", + "windows-sys 0.61.2", +] + +[[package]] +name = "quote" +version = "1.0.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "r-efi" +version = "5.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f" + +[[package]] +name = "r-efi" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" + +[[package]] +name = "rand" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9ef1d0d795eb7d84685bca4f72f3649f064e6641543d3a8c415898726a57b41" +dependencies = [ + "rand_chacha", + "rand_core 0.9.5", +] + +[[package]] +name = "rand" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65c9fb96cbc91e3478eaae79a69fcd3f1ae4ad052e471fe6732fff548984b4af" +dependencies = [ + "chacha20", + "getrandom 0.4.3", + "rand_core 0.10.1", +] + +[[package]] +name = "rand_chacha" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb" +dependencies = [ + "ppv-lite86", + "rand_core 0.9.5", +] + +[[package]] +name = "rand_core" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "76afc826de14238e6e8c374ddcc1fa19e374fd8dd986b0d2af0d02377261d83c" +dependencies = [ + "getrandom 0.3.4", +] + +[[package]] +name = "rand_core" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63b8176103e19a2643978565ca18b50549f6101881c443590420e4dc998a3c69" + +[[package]] +name = "rand_pcg" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "caa0f4137e1c0a72f4c651489402276c8e8e1cf081f3b0ba156d2cbeef09e86a" +dependencies = [ + "rand_core 0.10.1", +] + +[[package]] +name = "redox_syscall" +version = "0.5.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed2bf2547551a7053d6fdfafda3f938979645c44812fbfcda098faae3f1a362d" +dependencies = [ + "bitflags 2.13.2", +] + +[[package]] +name = "redox_users" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60dc65c0ff1a7ae1294b0c67b9f14baf70b644404010370171787bfac1038fc0" +dependencies = [ + "libredox", + "thiserror", +] + +[[package]] +name = "regex" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f020237b6c8eed93db2e2cb53c00c60a8e1bc73da7d073199a1180401450218d" +dependencies = [ + "aho-corasick", + "memchr", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "regex-automata" +version = "0.4.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ad8553b9b26413251cbf30e620595c7a41b3887f03da04579c0e6b0d6a06b4b2" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.8.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4" + +[[package]] +name = "reqwest" +version = "0.13.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16a1cfa75cc186dd73d5818e510e042e40927bccc9c236b061cea97e1eb08029" +dependencies = [ + "base64 0.23.1", + "bytes", + "encoding_rs", + "futures-channel", + "futures-core", + "futures-util", + "h2", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-rustls", + "hyper-util", + "js-sys", + "log", + "mime", + "percent-encoding", + "pin-project-lite", + "quinn", + "rustls", + "rustls-pki-types", + "rustls-platform-verifier", + "sync_wrapper", + "tokio", + "tokio-rustls", + "tower", + "tower-http", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", +] + +[[package]] +name = "ring" +version = "0.17.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4689e6c2294d81e88dc6261c768b63bc4fcdb852be6d1352498b114f61383b7" +dependencies = [ + "cc", + "cfg-if", + "getrandom 0.2.17", + "libc", + "untrusted", + "windows-sys 0.52.0", +] + +[[package]] +name = "rlimit" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f35ee2729c56bb610f6dba436bf78135f728b7373bdffae2ec815b2d3eb98cc3" +dependencies = [ + "libc", +] + +[[package]] +name = "rustc-hash" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d" + +[[package]] +name = "rustc_version" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfcb3a22ef46e85b45de6ee7e79d063319ebb6594faafcf1c225ea92ab6e9b92" +dependencies = [ + "semver", +] + +[[package]] +name = "rustix" +version = "1.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5e76742e5294153d4dde1207dbec5bdd81eef6fabdc0d2118babadabfd858aa" +dependencies = [ + "bitflags 2.13.2", + "errno", + "libc", + "linux-raw-sys", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls" +version = "0.23.46" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "48e13bd8c0e9365c43cfa5c9e8f9ad49d3c8444926c9aac819e0e4dc503c8fdf" +dependencies = [ + "aws-lc-rs", + "once_cell", + "rustls-pki-types", + "rustls-webpki", + "subtle", + "zeroize", +] + +[[package]] +name = "rustls-native-certs" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a073f5dc7469f984c52ad2752b63b0807745133b6de880b7b64c1ac4c48aec4" +dependencies = [ + "openssl-probe", + "rustls-pki-types", + "schannel", + "security-framework", +] + +[[package]] +name = "rustls-pki-types" +version = "1.16.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "102f35f7de7b06d8c61f1cff6592f5253e0dea431c74867aad5dfd70f44663fb" +dependencies = [ + "web-time", + "zeroize", +] + +[[package]] +name = "rustls-platform-verifier" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1167586491e2b18b8bfbb293e8180ec17c201c4f076d7cb3070ca964e7598f98" +dependencies = [ + "core-foundation", + "core-foundation-sys", + "jni", + "log", + "once_cell", + "rustls", + "rustls-native-certs", + "rustls-platform-verifier-android", + "rustls-webpki", + "security-framework", + "security-framework-sys", + "webpki-root-certs", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls-platform-verifier-android" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eec689c0bc40ff2458a5977b6619cb718087084a18e02a131c599b62d05e1a5f" + +[[package]] +name = "rustls-webpki" +version = "0.103.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a0760a887c14823fca5a1c970b01d47c328c696c0c64829d1df50e8f853fd5" +dependencies = [ + "aws-lc-rs", + "ring", + "rustls-pki-types", + "untrusted", +] + +[[package]] +name = "rustversion" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f" + +[[package]] +name = "ryu" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9774ba4a74de5f7b1c1451ed6cd5285a32eddb5cccb8cc655a4e50009e06477f" + +[[package]] +name = "same-file" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "schannel" +version = "0.1.30" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9cb23c424d8ee841bb4d813677ca237e2a610067d594fec130f87d6093495ab5" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "scopeguard" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" + +[[package]] +name = "security-framework" +version = "3.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7f4bc775c73d9a02cde8bf7b2ec4c9d12743edf609006c7facc23998404cd1d" +dependencies = [ + "bitflags 2.13.2", + "core-foundation", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework-sys" +version = "2.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2691df843ecc5d231c0b14ece2acc3efb62c0a398c7e1d875f3983ce020e3" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "semver" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" + +[[package]] +name = "serde" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde_core" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", +] + +[[package]] +name = "serde_json" +version = "1.0.154" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7e9cc8b1b85264074fbcc02a88680c4096b1e47df8f739dceb03bf482f04bd6" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "serde_path_to_error" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10a9ff822e371bb5403e391ecd83e182e0e77ba7f6fe0160b795797109d1b457" +dependencies = [ + "itoa", + "serde", + "serde_core", +] + +[[package]] +name = "serde_spanned" +version = "1.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c187e0a369471c550af028cba56d4f4fa2a489ad28151ae95a4d340a2a8b782" +dependencies = [ + "serde_core", +] + +[[package]] +name = "serde_urlencoded" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3491c14715ca2294c4d6a88f15e84739788c1d030eed8c110436aafdaa2f3fd" +dependencies = [ + "form_urlencoded", + "itoa", + "ryu", + "serde", +] + +[[package]] +name = "sha1" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a978451301f4db1d02937a4ab3ccce137717b81826e79b7d49ffe3244a13c3b8" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "digest", +] + +[[package]] +name = "sha1-checked" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "89f599ac0c323ebb1c6082821a54962b839832b03984598375bff3975b804423" +dependencies = [ + "digest", + "sha1", +] + +[[package]] +name = "sharded-slab" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6" +dependencies = [ + "lazy_static", +] + +[[package]] +name = "shlex" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba" + +[[package]] +name = "signal-hook" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49f7447afd772ca79ad17ae0a3972a6b0df0cb4b80990fd82707593e9e012a74" +dependencies = [ + "libc", + "signal-hook-registry", +] + +[[package]] +name = "signal-hook-registry" +version = "1.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b" +dependencies = [ + "errno", + "libc", +] + +[[package]] +name = "simd_cesu8" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11031e251abf8611c80f460e19dbdeb54a66db918e49c65a7065b46ac7aec520" +dependencies = [ + "rustc_version", + "simdutf8", +] + +[[package]] +name = "simdutf8" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a9fe34e3e7a50316060351f37187a3f546bce95496156754b601a5fa71b76e" + +[[package]] +name = "slab" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5" + +[[package]] +name = "smallvec" +version = "1.16.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "149309498a5f7334b12ddae0cad8aba81ce785fe91755068867e017cf98fee46" + +[[package]] +name = "socket2" +version = "0.6.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d1e2c7f27f8d4cb10542a02c49005dbd6e93095799d6f3be745fae9f8fedd4" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "software-core" +version = "0.1.0" +dependencies = [ + "bytes", + "dirs", + "gix", + "ntp_usg-server", + "rlimit", + "serde", + "serde_json", + "tempfile", + "thiserror", + "tokio", + "tracing", + "tracing-appender", + "tracing-subscriber", + "whoami", +] + +[[package]] +name = "stable_deref_trait" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" + +[[package]] +name = "station" +version = "0.1.0" +dependencies = [ + "axum", + "serde", + "serde_json", + "software-core", + "thiserror", + "tokio", + "toml", + "tower", + "tower-http", + "tracing", + "tracing-subscriber", +] + +[[package]] +name = "subtle" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" + +[[package]] +name = "symlink" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7973cce6668464ea31f176d85b13c7ab3bba2cb3b77a2ed26abd7801688010a" + +[[package]] +name = "syn" +version = "2.0.119" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "3.0.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ae9ccbea3a7b0b09443036490c8f34a8b1b760fd345e5c0dae0aac718faea79" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "sync_wrapper" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" +dependencies = [ + "futures-core", +] + +[[package]] +name = "synstructure" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "901704edd0dfe137f1987838ee4f259e4e063c31371bdb423f7ae38ec6f77f02" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", +] + +[[package]] +name = "tempfile" +version = "3.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" +dependencies = [ + "fastrand", + "getrandom 0.4.3", + "once_cell", + "rustix", + "windows-sys 0.61.2", +] + +[[package]] +name = "thiserror" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09e52cb86a36cede5cb101bf8908837b3e4c6e5e59fe7fd85c23fb56200d189e" +dependencies = [ + "thiserror-impl", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fe5197923287db20a58125f0bc85c062f7f2c892de97b18c356f9efb14b28524" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", +] + +[[package]] +name = "thread_local" +version = "1.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ad99c4c6d32803332c548b1af0540b357b3f5fc0be8f6c6bfe8b2e6ae784070" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "time" +version = "0.3.55" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdb87b95ec50ddfa440816d227a17b2ccbdda963a316a727fda0fc4334f7d134" +dependencies = [ + "deranged", + "num-conv", + "powerfmt", + "serde_core", + "time-core", + "time-macros", +] + +[[package]] +name = "time-core" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e1c906769ad99c88eaa54e728060edef082f8e358ff32030cb7c7d315e81109" + +[[package]] +name = "time-macros" +version = "0.2.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e689342a48d2ea927c87ea50cabf8594854bf940e9310208848d680d668ed85" +dependencies = [ + "num-conv", + "time-core", +] + +[[package]] +name = "tinystr" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "abc840c238154d58f9e86b2792261edfde565a17696e1cda1a449de27979801a" +dependencies = [ + "displaydoc", + "zerovec", +] + +[[package]] +name = "tinyvec" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee" + +[[package]] +name = "tokio" +version = "1.54.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b52fd3255258d26fac7264ab5a76b53c13367136dc011d3d6ad4f8ed070396a3" +dependencies = [ + "bytes", + "libc", + "mio", + "pin-project-lite", + "signal-hook-registry", + "socket2", + "tokio-macros", + "windows-sys 0.61.2", +] + +[[package]] +name = "tokio-macros" +version = "2.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78773a2a397f451582ce068015985c33193cf6dea8b74d2a639fe457b2f07b0e" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", +] + +[[package]] +name = "tokio-rustls" +version = "0.26.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c9cc2678c2cdd569ef8215e2afd7954ada2ae20b4fdd2c5fe6139a3b02d105db" +dependencies = [ + "rustls", + "tokio", +] + +[[package]] +name = "tokio-tungstenite" +version = "0.29.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f72a05e828585856dacd553fba484c242c46e391fb0e58917c942ee9202915c" +dependencies = [ + "futures-util", + "log", + "tokio", + "tungstenite", +] + +[[package]] +name = "tokio-util" +version = "0.7.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e464cf451ba96ebfc6f9b6542f17ee8b8956e33f1e40d9690624e59d7a7f8a4b" +dependencies = [ + "bytes", + "futures-core", + "futures-sink", + "libc", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "toml" +version = "0.9.12+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf92845e79fc2e2def6a5d828f0801e29a2f8acc037becc5ab08595c7d5e9863" +dependencies = [ + "indexmap", + "serde_core", + "serde_spanned", + "toml_datetime", + "toml_parser", + "toml_writer", + "winnow 0.7.15", +] + +[[package]] +name = "toml_datetime" +version = "0.7.5+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92e1cfed4a3038bc5a127e35a2d360f145e1f4b971b551a2ba5fd7aedf7e1347" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_parser" +version = "1.1.5+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baa693a8032d7e1cada7d0041e96126df243179ff061456783ac7f12bda4744c" +dependencies = [ + "winnow 1.0.5", +] + +[[package]] +name = "toml_writer" +version = "1.2.0+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "009dbb7700f11c55ef83aebbe4c0e9cf1f1ac0844bd8d6f00dc38f302026e13a" + +[[package]] +name = "tower" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" +dependencies = [ + "futures-core", + "futures-util", + "pin-project-lite", + "sync_wrapper", + "tokio", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tower-http" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4cfcf7e2740e6fc6d4d688b4ef00650406bb94adf4731e43c096c3a19fe40840" +dependencies = [ + "bitflags 2.13.2", + "bytes", + "futures-util", + "http", + "http-body", + "pin-project-lite", + "tower", + "tower-layer", + "tower-service", + "url", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + +[[package]] +name = "tower-service" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" + +[[package]] +name = "tracing" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" +dependencies = [ + "log", + "pin-project-lite", + "tracing-attributes", + "tracing-core", +] + +[[package]] +name = "tracing-appender" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "050686193eb999b4bb3bc2acfa891a13da00f79734704c4b8b4ef1a10b368a3c" +dependencies = [ + "crossbeam-channel", + "symlink", + "thiserror", + "time", + "tracing-subscriber", +] + +[[package]] +name = "tracing-attributes" +version = "0.1.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7490cfa5ec963746568740651ac6781f701c9c5ea257c58e057f3ba8cf69e8da" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "tracing-core" +version = "0.1.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" +dependencies = [ + "once_cell", + "valuable", +] + +[[package]] +name = "tracing-log" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee855f1f400bd0e5c02d150ae5de3840039a3f54b025156404e34c23c03f47c3" +dependencies = [ + "log", + "once_cell", + "tracing-core", +] + +[[package]] +name = "tracing-serde" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "704b1aeb7be0d0a84fc9828cae51dab5970fee5088f83d1dd7ee6f6246fc6ff1" +dependencies = [ + "serde", + "tracing-core", +] + +[[package]] +name = "tracing-subscriber" +version = "0.3.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb7f578e5945fb242538965c2d0b04418d38ec25c79d160cd279bf0731c8d319" +dependencies = [ + "matchers", + "nu-ansi-term", + "once_cell", + "regex-automata", + "serde", + "serde_json", + "sharded-slab", + "smallvec", + "thread_local", + "tracing", + "tracing-core", + "tracing-log", + "tracing-serde", +] + +[[package]] +name = "try-lock" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" + +[[package]] +name = "tungstenite" +version = "0.29.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c01152af293afb9c7c2a57e4b559c5620b421f6d133261c60dd2d0cdb38e6b8" +dependencies = [ + "bytes", + "data-encoding", + "http", + "httparse", + "log", + "rand 0.9.5", + "sha1", + "thiserror", +] + +[[package]] +name = "typenum" +version = "1.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20" + +[[package]] +name = "uluru" +version = "3.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c8a2469e56e6e5095c82ccd3afb98dad95f7af7929aab6d8ba8d6e0f73657da" +dependencies = [ + "arrayvec", +] + +[[package]] +name = "unicode-bom" +version = "2.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7eec5d1121208364f6793f7d2e222bf75a915c19557537745b195b253dd64217" + +[[package]] +name = "unicode-ident" +version = "1.0.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563" + +[[package]] +name = "unicode-normalization" +version = "0.1.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75cd3fb03d5288b3ba9a1ee103ac7e9cbb59f0b03d64f8ddfcc04dd42758a85d" +dependencies = [ + "tinyvec", +] + +[[package]] +name = "untrusted" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" + +[[package]] +name = "url" +version = "2.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" +dependencies = [ + "form_urlencoded", + "idna", + "percent-encoding", + "serde", +] + +[[package]] +name = "utf8_iter" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af3bd9d3e571c26fcce9d033b87ea5ab061b8d2ffe9b7a5675d810d68f03edf0" +dependencies = [ + "utf_types", +] + +[[package]] +name = "utf_types" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a3b425286980a367278453f3b6d28cdcb134b574e5a35824a6ff5eebad50bb6" + +[[package]] +name = "valuable" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65" + +[[package]] +name = "version_check" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" + +[[package]] +name = "walkdir" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b" +dependencies = [ + "same-file", + "winapi-util", +] + +[[package]] +name = "want" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec4cdd0dd910afe868b7ef477227d8d538b46b3075031afee8a9f2acb0a2ed0b" +dependencies = [ + "try-lock", +] + +[[package]] +name = "wasi" +version = "0.11.1+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" + +[[package]] +name = "wasi" +version = "0.14.7+wasi-0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "883478de20367e224c0090af9cf5f9fa85bed63a95c1abf3afc5c083ebc06e8c" +dependencies = [ + "wasip2", +] + +[[package]] +name = "wasip2" +version = "1.0.4+wasi-0.2.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b67efb37e106e55ce722a510d6b5f9c17f083e5fc79afc2badeb12cc313d9487" +dependencies = [ + "wit-bindgen", +] + +[[package]] +name = "wasite" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "66fe902b4a6b8028a753d5424909b764ccf79b7a209eac9bf97e59cda9f71a42" +dependencies = [ + "wasi 0.14.7+wasi-0.2.4", +] + +[[package]] +name = "wasm-bindgen" +version = "0.2.130" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a0181c14ddd6c7b8b0b0132a5f1ea2f32be0d893cd3ea97b6e3b28886b8a3d1c" +dependencies = [ + "cfg-if", + "rustversion", + "wasm-bindgen-macro", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-futures" +version = "0.4.80" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e14e0327cb5368ad60ccb22d04a9827a693c95a926d8d125e9fa39e0baec501" +dependencies = [ + "js-sys", + "tokio", + "wasm-bindgen", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.130" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e931a02a39abdbf66966fc35902b5ed58344750a70885bed4ebb3d8eaf28ed9" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.130" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ca4b54280e455bd831e33a6b8e734baf432fe63fbc35c42ac14ce67a043a53a" +dependencies = [ + "bumpalo", + "proc-macro2", + "quote", + "syn 3.0.10", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.130" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b1f9c3798725016c6ee5f2f57869ec0831e8bbc0ab0310a86e787e97f41389e" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "web-sys" +version = "0.3.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7d179596ff5ec0f6de4db64d54011bde6289cc49603d3a6e4ce3f329207ab88" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "web-time" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "webpki-root-certs" +version = "1.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "293198dcebfb821155b5092ab94b5a82ff180eddd7241df3bd6e66a4ffd1a585" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "whoami" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "626c4bac6755d76ffc12cb01b2eac751db1996b9e0041de9aa02c8c211ddc82c" +dependencies = [ + "libc", + "libredox", + "objc2-system-configuration", + "wasite", + "web-sys", +] + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-sys" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +dependencies = [ + "windows-targets", +] + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-targets" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" +dependencies = [ + "windows_aarch64_gnullvm", + "windows_aarch64_msvc", + "windows_i686_gnu", + "windows_i686_gnullvm", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_gnullvm", + "windows_x86_64_msvc", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" + +[[package]] +name = "winnow" +version = "0.7.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df79d97927682d2fd8adb29682d1140b343be4ac0f08fd68b7765d9c059d3945" + +[[package]] +name = "winnow" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8c3b93199df0ab874cdf0c6a94f0a0dc3423fe41f1cafb62b8bd7b1deb277aef" + +[[package]] +name = "wit-bindgen" +version = "0.57.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ebf944e87a7c253233ad6766e082e3cd714b5d03812acc24c318f549614536e" + +[[package]] +name = "writeable" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ad82d2a33cdc9674dc7465672f271e096168fcdbe0f799d9e6db8c5892679dc" + +[[package]] +name = "yoke" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "417ef3fcf6c300b7dbd25c85531a746931c02ad536f3cf4786ed1e88223340b3" +dependencies = [ + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec8ebde2db3681e8c9980cc27822030e68752690ddfa9473e739aeb4dbde6d71" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", + "synstructure", +] + +[[package]] +name = "zerocopy" +version = "0.8.63" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5fe1f8f1b06191a00962174c61aa5005e0bb391a6d80d07e24d115c01a92ed8" +dependencies = [ + "zerocopy-derive", +] + +[[package]] +name = "zerocopy-derive" +version = "0.8.63" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "863ad3ac83293fb4d740aedbfdc9240dd8d1a50c1099acd76ce80ce7c7230c7f" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerofrom" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ec05a11813ea801ff6d75110ad09cd0824ddba17dfe17128ea0d5f68e6c5272" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f75b4683f6c7f45248d4d64056a24298c6281e0993356d7d1b4a1a962ef10d4a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", + "synstructure", +] + +[[package]] +name = "zeroize" +version = "1.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e13084392c5e4bc371903e2935a5eaeed24905a7511356b883835e18a78f6879" + +[[package]] +name = "zerotrie" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ea269c3bd32f0a32c321907a2ae912ba6f4649bb0fc764a15627e99a7095a3f" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + +[[package]] +name = "zerovec" +version = "0.11.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f58a2799cfe9a1670c7ea8edbd52ef8edb93cb37a7f83bf31ba9e35d9dae6a40" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.11.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3743ddbf47738d929cd1ae2e199d40d0162979dfe31aef8ae646d2bf00bf97a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.10", +] + +[[package]] +name = "zlib-rs" +version = "0.6.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b268e58e7c693d7c271f93ffc4ba3b380412554231c85bf61ca7af91042a4112" + +[[package]] +name = "zmij" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b" diff --git a/backend/Cargo.toml b/backend/Cargo.toml new file mode 100644 index 000000000..d14dd7807 --- /dev/null +++ b/backend/Cargo.toml @@ -0,0 +1,45 @@ +[workspace] +resolver = "3" +members = ["crates/core", "crates/station"] +default-members = ["crates/station"] + +[workspace.package] +edition = "2024" +rust-version = "1.98" +license = "MIT" +authors = [ + "Hyperloop UPV Software Subsystem", + "Javier Ribal del Río", + "Gazi Halawani", + "Pau Minguet Micó" +] +repository = "https://github.com/Hyperloop-UPV/software" + +# Shared dependency versions. Members opt in with `dep.workspace = true`. +[workspace.dependencies] +software-core = { path = "crates/core" } + +bytes = "1" +serde = { version = "1", features = ["derive"] } +serde_json = "1" +thiserror = "2" +tokio = { version = "1", features = ["rt-multi-thread", "macros", "net", "sync", "time", "signal"] } +toml = "0.9" +tracing = "0.1" +tracing-appender = "0.2" +tracing-subscriber = { version = "0.3", features = ["env-filter", "fmt", "json"] } + +[workspace.lints.rust] +unsafe_code = "forbid" +missing_debug_implementations = "warn" + +[workspace.lints.clippy] +all = { level = "warn", priority = -1 } +unwrap_used = "warn" +expect_used = "warn" +panic = "warn" + +[profile.release] +lto = "thin" +codegen-units = 1 +panic = "abort" diff --git a/backend/crates/core/Cargo.toml b/backend/crates/core/Cargo.toml new file mode 100644 index 000000000..ac855d65f --- /dev/null +++ b/backend/crates/core/Cargo.toml @@ -0,0 +1,78 @@ +[package] +name = "software-core" +version = "0.1.0" +description = "Generic Hyperloop UPV building blocks: ADJ model, packet protocol and transport" +edition.workspace = true +rust-version.workspace = true +license.workspace = true +authors.workspace = true +repository.workspace = true + +[features] +default = [] +# NTP server +ntp = ["dep:tokio", "dep:ntp_usg-server", "dep:tracing-subscriber"] +# TCP/UDP transport (pulls in tokio) +net = ["dep:tokio"] +# ADJ download through git +git = ["dep:tempfile", "dep:dirs", "dep:gix"] +# Packet sniffing through pcap (dependency added when the module is written) +pcap = ["net"] +# CSV data logger (records, sessions, subloggers) +logger = [] +# `logger::files`: copying, moving and removing files. No dependencies +# of its own: a tool that only wants to copy a file shouldn't have to +# take anything else with it, beyond the `logger` module it lives in. +files = ["logger"] +# `logger::host`: a snapshot of the machine, the user and the build, for +# the metadata of a recording. `rlimit` is only a dependency on unix, so +# on Windows this enables `whoami` alone and `logger::host::open_file_limit` +# reports nothing. +host = ["logger", "dep:whoami", "dep:rlimit"] +# Reusable tracing/diagnostics setup (console + non-blocking file + stderr layers) +trace = ["dep:tracing-subscriber", "dep:tracing-appender"] +# Structure responses for HTTP petitions +http = [] + +[dependencies] +bytes.workspace = true +serde.workspace = true +serde_json.workspace = true +thiserror.workspace = true +tracing.workspace = true +tokio = { workspace = true, optional = true, features = ["macros", "rt-multi-thread"] } +tracing-subscriber = { workspace = true, optional = true , features = ["env-filter", "fmt"]} +tracing-appender = { workspace = true, optional = true } +gix = { version = "0.87.1", optional = true, features = ["blocking-http-transport-reqwest-rust-tls", "blocking-network-client", "worktree-mutation"] } +dirs = { version = "7.0.0", optional = true } +tempfile = { version = "3.27", optional = true } +ntp_usg-server = { version = "5.0.0", optional = true, features = ["ipv4", "tokio"] } +# User, machine and OS metadata. Every call returns a `Result`, which is +# what makes a best-effort snapshot cheap to build. +whoami = { version = "2.1.3", optional = true } + +# `getrlimit` has no meaning on Windows, so the dependency isn't there +# either; `logger::host::open_file_limit` is `None` on that target. +[target.'cfg(unix)'.dependencies] +rlimit = { version = "0.11.0", optional = true } + +# The `logger` and `files` tests need a real directory to write into; +# `tempfile` is also an optional dependency of the `git` feature, which is +# why it shows up twice. +[dev-dependencies] +tempfile = "3.27" + +# `workspace = true` can't be combined with extra lints in the same table, +# so the workspace list is repeated here with `missing_docs` added: this is +# the crate meant to be reused by other projects, so its public API must be +# documented. +[lints.rust] +unsafe_code = "forbid" +missing_debug_implementations = "warn" +missing_docs = "warn" + +[lints.clippy] +all = { level = "warn", priority = -1 } +unwrap_used = "warn" +expect_used = "warn" +panic = "warn" diff --git a/backend/crates/core/README.md b/backend/crates/core/README.md new file mode 100644 index 000000000..22ced735d --- /dev/null +++ b/backend/crates/core/README.md @@ -0,0 +1,32 @@ +# software-core + +Piezas genéricas y reutilizables de Hyperloop UPV: modelo de datos, protocolo de +paquetes, lectura del ADJ y transporte de red. No depende de nada propio del +backend (`station`), así que también sirve de base para otras herramientas +como un sniffer o un simulador. + +Ver [`../../ARCHITECTURE.md`](../../ARCHITECTURE.md) para el diseño completo. + +## Módulos + +- `model` — identificadores, paquetes, valores, medidas y unidades. Siempre disponible. +- `protocol` — traduce bytes a paquetes y paquetes a bytes. Siempre disponible. +- `adj` — lee el ADJ y construye los descriptores para `protocol`. +- `net` *(feature `net`)* — conexiones TCP y UDP. +- `logger` *(feature `logger`)* — registro de datos en CSV. +- `trace` *(feature `trace`)* — configuración de trazas de diagnóstico. + +## Features + +```toml +software-core = { path = "...", features = ["net", "adj"] } +``` + +Por defecto no se activa ninguna: quien use el crate paga solo por lo que +necesita. Ver la tabla completa en `ARCHITECTURE.md`, apartado 12. + +## Ejemplo + +```rust +// Pendiente: añadir cuando exista el primer decodificador público. +``` diff --git a/backend/crates/core/src/adj.rs b/backend/crates/core/src/adj.rs new file mode 100644 index 000000000..d47286223 --- /dev/null +++ b/backend/crates/core/src/adj.rs @@ -0,0 +1,94 @@ +//! Parses an ADJ (Architecture Description JSON) directory into +//! [`crate::model::PodData`], plus backend-session metadata not modeled as +//! vehicle data ([`crate::adj::AdjInfo`]). +//! +//! [`load_from_dir`] loads an existing ADJ directory. With the `git` feature +//! enabled, `auto_adj` updates the ADJ repository before loading its data +//! and returns the checked-out commit hash. +//! +//! Loading is not specific to `station`: a sniffer, a simulator, or any +//! other tool that reads an ADJ needs exactly the same parsing. +//! +//! Scope for this iteration: no `sockets.json`, no +//! `period`/`period_type`/`socket` packet fields (matches +//! [`crate::model::PacketDef`]'s own omission), and no schema validation +//! (`adj::validate` is a separate, deliberately out-of-scope concern for +//! now). This module only surfaces structural errors it cannot avoid, +//! e.g. a packet referencing a measurement alias that doesn't exist. + +mod error; +mod info; +mod raw; + +// To activate this module the feature "http" is required +// The structures used in this module aren't used for any other reason +#[cfg(feature = "http")] +/// Strctures for the responses of the HTTP requests +pub mod http; + +// Imports for the "git" feature +#[cfg(feature = "git")] +use std::path::PathBuf; +#[cfg(feature = "git")] +use tracing::{info, instrument}; + +pub use error::{LoadError, MeasurementError, ProtectionError}; +pub use info::{AdjInfo, ProtectionTypeInfo}; +pub use raw::load_from_dir; + +#[cfg(feature = "git")] +use crate::git::{unwrap_repo_path, update_adj}; +use crate::model::PodData; + +/// The result of loading an ADJ: the vehicle's data (as [`crate::model`] +/// describes it) plus backend-session metadata. Built by +/// [`raw::load_from_dir`]. +#[derive(Debug, Clone, PartialEq, Default)] +pub struct Adj { + /// Every board and packet defined by the ADJ. + pub pod_data: PodData, + /// Backend-session metadata from `general_info.json`. + pub info: AdjInfo, +} + +/// The result of [`auto_adj`]: the loaded ADJ data and the checked-out commit hash. +#[cfg(feature = "git")] +#[derive(Debug, Clone)] +pub struct AutoAdj { + /// Vehicle data + pub adj: Adj, + /// Full commit hash of the repository checkout used to load the ADJ. + pub hash: String, +} + +/// Updates the ADJ repository and returns an [`AutoAdj`] containing the loaded +/// data and the full commit hash of the checkout used to load it. +/// +/// `path` identifies the repository directory, not its parent. If omitted, +/// the platform's user cache directory is used. +/// +/// Online, the repository is replaced and local edits and commits are discarded. +/// Offline, the current cached checkout is loaded without switching branches, +/// so it may differ from `branch`; `hash` is the full commit hash of its HEAD. +/// If no cached repository is available offline, or a Git operation fails, +/// returns [`LoadError::Git`] instead of an [`AutoAdj`], so no hash is returned. +/// Clone failures do not fall back to the cache. +/// +/// This performs blocking network and filesystem operations. Call during startup, +/// before readers use ADJ, with only one updater at a time. +/// +/// # Errors +/// +/// Returns [`LoadError::Git`] if path resolution or the update fails. +/// Other variants report failures loading the checked-out ADJ data. +/// Loading failures do not restore the previous cache. +#[cfg(feature = "git")] +#[instrument(level = "debug")] +pub fn auto_adj(path: Option, branch: &str) -> Result { + let repo_path = unwrap_repo_path(path)?; + let hash = update_adj(Some(repo_path.clone()), branch)?; + let adj = load_from_dir(&repo_path)?; + + info!(path = ?repo_path, %hash, "ADJ loaded"); + Ok(AutoAdj { adj, hash }) +} diff --git a/backend/crates/core/src/adj/README.md b/backend/crates/core/src/adj/README.md new file mode 100644 index 000000000..b60b6668a --- /dev/null +++ b/backend/crates/core/src/adj/README.md @@ -0,0 +1,119 @@ +# ADJ Module (`adj`) + +This module deserializes, validates, and loads ADJ JSON fixtures into the backend domain model. + +With the `http` feature enabled, `adj/http.rs` adds catalog-building methods to `Adj`. The serializable response types live separately in `model::http`; routes, middleware, and server setup belong to the application (`station`). See the [HTTP response models README](../model/http/README.md) for usage, JSON types, and examples. + +For schema specifications, packet/measurement ID conventions, and network requirements, refer directly to the official documentation in the **ADJ repository**. + +--- + +## The `Adj` Object Structure + +Calling `load_from_dir` produces a root `Adj` instance: + +```rust +pub struct Adj { + pub pod_data: PodData, + pub info: AdjInfo, +} +``` + +```text +Adj +├── pod_data (PodData) +│ └── boards: HashMap +│ └── packets: HashMap +│ ├── explicit (Data, Order, Message — declared in packets.json; +│ │ a "message"-type packet's own `name` must be one of +│ │ MessageLevel::ALL's four severities, resolved via +│ │ MessageLevel::from_name — UnknownMessageSeverity if not) +│ └── synthetic (Protection — one per declared protection, +│ derived from each measurement's own `protections`; +│ never declared directly in packets.json) +└── info (AdjInfo) + ├── ports: HashMap + ├── addresses: HashMap + ├── message_ids: HashMap -- name -> id, straight from the ADJ + ├── message_levels: HashMap -- id -> severity, the reverse + └── protection_types: HashMap +``` + +`Board` also carries its `id`, `name`, `ip`, and `mac`. There is no persistent +`Board::measurements` map: the loader uses a temporary alias-to-measurement map +to resolve packet variables, then stores the resolved measurements inside +`PacketType::Data`, `PacketType::Order`, and `PacketType::Protection`. + +`message_ids` is the ADJ's own direction: a name (e.g. `"fault"`) to its +id. Not every entry is one of `model::MessageLevel`'s four severities — +other reserved names (e.g. `add_state_order`) share this same map. + +`message_levels` is the direction decoding actually needs: a wire id +(all a decoder ever has) straight to its severity, with no name in +between. It's the reverse of `message_ids`, restricted to whichever of +`MessageLevel::ALL`'s four names `message_ids` declares — built once in +`adj::raw::types`'s `TryFrom for AdjInfo`, right after +`message_ids` itself, so the two maps agree when loaded: + +```rust +let message_levels: HashMap = MessageLevel::ALL + .into_iter() + .filter_map(|level| message_ids.get(level.name()).map(|&id| (id, level))) + .collect(); +``` + +Which ADJ name corresponds to which `MessageLevel` is **not** decided +here — `level.name()`/`MessageLevel::from_name` (see [model](../model/README.md) +§4.4) is the one place that association is spelled out, so `adj` +doesn't hardcode `"fault"`/`"warning"`/`"info"`/`"panic"` itself. + +**One layer up, `protocol::Index` is what actually turns +`message_levels` into something a decoder can look up a packet by.** +`Index::new(pod_data, message_levels)` takes `message_levels` as +`Option<&HashMap>` — `None` for callers with no +`AdjInfo` at all (most tests in this crate, which only build a bare +`PodData`) — and, for each entry, synthesizes a +`PacketDef { packet_type: PacketType::Message(level), board: BoardId(0), .. }` +into the very same `AdjId -> PacketDef` table every other packet lives +in. `BoardId(0)` (reserved, not validated — see `AdjId`/`BoardId`'s own +docs) because a severity isn't owned by any one board — any board's +free-text log frame can reuse the same `"fault"` id. See +`protocol/README.md`'s `index.rs` section for the full picture. + +--- + +## HTTP Catalog Builders (`http` feature) + +The methods implemented in `adj/http.rs` borrow `&self`; they do not consume or +modify the loaded ADJ: + +| Method | Return type (in `model::http`) | Contents | +| --- | --- | --- | +| `adj.data_response()` | `DataResponse` | Data definitions grouped by board, without protection metadata. | +| `adj.order_response()` | `OrderResponse` | Order definitions grouped by board, including parameters and their protections. | +| `adj.protection_response()` | `ProtectionResponse` | Flat catalog of synthetic protection packets, plus display metadata. | + +These methods return owned response models, not JSON bytes or HTTP responses. +The application chooses when to call them and serialize the results. They do +not configure routes, CORS, or caching. + +In the order and protection catalogs, protection IDs are compound IDs: +`(position << 13) | measurement_id`. The internal `Protection::id` remains the +one-based position (`1–7`) within its measurement. Empty lists are retained; +zero protection durations are omitted from JSON. See the +[HTTP contract](../model/http/README.md) for the complete serialized shapes. + +## Why It Is Structured This Way + +The `Adj` object enforces a clear architectural boundary between **vehicle topology** and **session configuration**: + +### 1. Separation of Concerns (`PodData` vs. `AdjInfo`) +* **`pod_data` (Vehicle Domain)**: Represents telemetry, controls, and board topology intrinsic to the physical vehicle. It contains only what exists on the vehicle bus (boards, packets, measurements). +* **`info` (Session & Tooling Domain)**: Captures session-level networking and station UI requirements (host addresses, local server port bindings, and alert format strings like `text` and `textTime`). +* **Design rationale**: The vehicle itself does not know or care about backend socket configurations or display strings. Separating them prevents UI and orchestration details from polluting the core telemetry model. + +### 2. Standalone Loader Submodule (`raw`) +The raw deserialization types and the loader logic live isolated inside `raw`. This enables non-station tools (such as bus sniffers, test runners, or simulators) to parse and ingest ADJ directories without dragging along application-level UI or station state logic. + +### 3. Unified Packet Map (`packets`) +Protections defined under measurements are materialized during loading as first-class `PacketType::Protection(Measurement)` packets alongside the explicit data, order and message packets declared in `packets.json`. Downstream networking layers can route and handle every wire event uniformly via `Board::packets` without needing specialized traversal logic for nested measurement alarms. `packets.json` itself never declares a `"type": "protection"` entry directly — that shape only exists synthesized, one per protection a measurement declares, never as a free-standing declaration with its own arbitrary variable list. diff --git a/backend/crates/core/src/adj/error.rs b/backend/crates/core/src/adj/error.rs new file mode 100644 index 000000000..04a1e0ba4 --- /dev/null +++ b/backend/crates/core/src/adj/error.rs @@ -0,0 +1,183 @@ +//! Errors produced while acquiring or loading an ADJ. +//! +//! Layered on purpose: [`LoadError`] is the only public error type here — +//! the one a composition root's own aggregate error would `#[from]`-chain +//! into — while [`MeasurementError`] and [`ProtectionError`] stay +//! crate-private. Nothing outside this crate needs to match past +//! `LoadError` into them; `.source()` still returns `&dyn Error` for +//! logging regardless of the concrete type's visibility. + +use std::net::AddrParseError; +use std::path::PathBuf; + +#[cfg(feature = "git")] +use crate::git::GitError; + +/// An error produced while acquiring or loading an [`crate::adj::Adj`]. +#[derive(Debug, thiserror::Error)] +pub enum LoadError { + /// Couldn't read a file. + #[error("couldn't read {path:?}")] + ReadFile { + /// The file that couldn't be read. + path: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// A file's contents weren't valid JSON for the shape expected there. + #[error("couldn't parse {path:?} as JSON")] + ParseJson { + /// The file that failed to parse. + path: PathBuf, + /// The underlying JSON error. + #[source] + source: serde_json::Error, + }, + + /// A board's `board_ip` isn't a valid IP address. + #[error("board {board:?}: invalid IP address {raw:?}")] + InvalidIp { + /// The board whose IP address is invalid. + board: String, + /// The text that failed to parse. + raw: String, + /// The underlying parse error. + #[source] + source: AddrParseError, + }, + + /// An address in `general_info.json`'s `addresses` isn't a valid IP + /// address. + #[error("address {name:?}: invalid IP address {raw:?}")] + InvalidAddress { + /// The address's name (e.g. `"backend"`). + name: String, + /// The text that failed to parse. + raw: String, + /// The underlying parse error. + #[source] + source: AddrParseError, + }, + + /// A board's `mac` isn't a valid MAC address. + #[error("board {board:?}: invalid MAC address {raw:?}")] + InvalidMac { + /// The board whose MAC address is invalid. + board: String, + /// The text that failed to parse. + raw: String, + }, + + /// A board has no `mac` field at all. + #[error("board {board:?}: missing MAC address")] + MissingMac { + /// The board missing its MAC address. + board: String, + }, + + /// A packet or order declares a `type` other than `"data", `"order"`, `"message"` or `"protection"`. + #[error("board {board:?}, packet {name:?}: unknown packet type {type_name:?}")] + UnknownPacketType { + /// The board the packet belongs to. + board: String, + /// The packet's name. + name: String, + /// The unrecognized type string. + type_name: String, + }, + + /// A `"type": "message"` packet's `name` isn't one of + /// [`crate::model::MessageLevel`]'s four severities. + #[error("board {board:?}, packet {name:?}: not a known message severity")] + UnknownMessageSeverity { + /// The board declaring this message packet. + board: String, + /// The packet's name — the text that failed to match a severity. + name: String, + }, + + /// A packet or order references a measurement alias that doesn't exist + /// among that board's own measurements. + #[error("board {board:?}, packet {name:?}: unknown measurement alias {alias:?}")] + UnknownAlias { + /// The board the packet belongs to. + board: String, + /// The packet's name. + name: String, + /// The alias that couldn't be resolved. + alias: String, + }, + + /// A measurement couldn't be converted into [`crate::model::Measurement`]. + #[error("board {board:?}, measurement {alias:?}: {source}")] + Measurement { + /// The board the measurement belongs to. + board: String, + /// The measurement's alias. + alias: String, + /// The underlying conversion error. + #[source] + source: MeasurementError, + }, + + /// Couldn't resolve the ADJ repository path or update its checkout. + #[cfg(feature = "git")] + #[error("couldn't prepare ADJ repository: {0}")] + Git(#[from] GitError), +} + +/// An error converting a raw measurement into [`crate::model::Measurement`]. +#[derive(Debug, thiserror::Error)] +pub enum MeasurementError { + /// The measurement has more than 7 protections. + #[error("measurement has {count} protections, maximum allowed is 7")] + TooManyProtections { + /// How many protections were declared. + count: usize, + }, + + /// The measurement's `type` isn't a recognized wire type, `"bool"` or + /// `"enum"`. + #[error("unknown measurement type {0:?}")] + UnknownType(String), + + /// The measurement's `type` is `"enum"` but no `enumValues` were given. + #[error("type is \"enum\" but no enumValues were given")] + MissingEnumValues, + + /// One of the measurement's declared protections failed to convert. + #[error("protection #{index}: {source}")] + Protection { + /// The protection's 1-based position within the measurement's list. + index: usize, + /// The underlying conversion error. + #[source] + source: ProtectionError, + }, +} + +/// An error converting a raw protection into [`crate::model::Protection`]. +#[derive(Debug, thiserror::Error)] +pub enum ProtectionError { + /// The protection's `type` isn't one of the five known kinds. + #[error("unknown protection type {0:?}")] + UnknownType(String), + + /// The protection's `value` array doesn't have the number of bounds its + /// `type` requires. + #[error("type {kind:?} needs {expected} bound(s), got {got}")] + WrongBoundCount { + /// The protection's type string. + kind: String, + /// How many bounds that type requires. + expected: u8, + /// How many bounds were actually given. + got: usize, + }, + + /// The protection's `time` string couldn't be parsed as a duration. + #[error("couldn't parse time {0:?}")] + InvalidTime(String), +} diff --git a/backend/crates/core/src/adj/http.rs b/backend/crates/core/src/adj/http.rs new file mode 100644 index 000000000..8fcc13af5 --- /dev/null +++ b/backend/crates/core/src/adj/http.rs @@ -0,0 +1,230 @@ +use crate::{ + adj::Adj, + model::{ + AdjId, MeasurementKind, PacketType, + http::{ + data::{ + DataBoardResponse, DataMeasurementKind, DataMeasurementResponse, + DataPacketResponse, DataResponse, + }, + order::{ + OrderBoardResponse, OrderMeasurementResponse, OrderPacketResponse, + OrderProtectionResponse, OrderResponse, + }, + protection::{ProtectionInfoResponse, ProtectionResponse, ProtectionTypeResponse}, + }, + }, +}; + +use std::time::Duration; + +impl Adj { + /// Builds the data catalog without modifying or consuming the ADJ. + /// + /// Boards and data packets are sorted by id. Boards without data packets are + /// retained with an empty list. Measurements keep their wire order and omit + /// protection metadata. + pub fn data_response(&self) -> DataResponse { + let mut boards: Vec = self + .pod_data + .boards + .values() + // For each board + .map(|board| { + let mut packets: Vec = board + .packets + .values() + // For each packet of this board + .filter_map(|packet| { + // If the PacketType is Data, return Some(DataPacketResponse) -> Will be a Vec + let PacketType::Data(measurements) = &packet.packet_type else { + return None; + }; + + Some(DataPacketResponse { + id: packet.id, + name: packet.name.clone(), + packet_type: "data".to_string(), + measurements: measurements + .iter() + .map(|measurement| DataMeasurementResponse { + id: measurement.id, + alias: measurement.alias.clone(), + name: measurement.name.clone(), + display_units: measurement.display_units.clone(), + kind: match_measurement_kind(&measurement.kind), + }) + .collect(), + }) + }) + .collect(); + packets.sort_unstable_by_key(|packet| packet.id.0); + + // Set up each packet + DataBoardResponse { + id: board.id, + name: board.name.clone(), + packets, + } + }) + // Obtain a Vec<> of all the packets + .collect(); + + // Sort the responses by board.id + boards.sort_unstable_by_key(|board| board.id.0); + + DataResponse { boards } + } + + /// Builds the order catalog without modifying or consuming the ADJ. + /// + /// Boards and orders are sorted by id. Boards without orders are retained with + /// an empty list. Parameters and their protections keep their ADJ order. + pub fn order_response(&self) -> OrderResponse { + let mut boards: Vec = self + .pod_data + .boards + .values() + // For each board + .map(|board| { + let mut orders: Vec = board + .packets + .values() + // For each order of this board + .filter_map(|packet| { + // If the packet is an Order... + let PacketType::Order(measurements) = &packet.packet_type else { + return None; + }; + + // Setup of the response + Some(OrderPacketResponse { + id: packet.id, + name: packet.name.clone(), + packet_type: "order".to_string(), + measurements: measurements + .iter() + // Convert each parameter into its HTTP response representation + .map(|measurement| OrderMeasurementResponse { + id: measurement.id, + alias: measurement.alias.clone(), + name: measurement.name.clone(), + display_units: measurement.display_units.clone(), + kind: match_measurement_kind(&measurement.kind), + protections: measurement + .protections + .iter() + // Convert each protection + .map(|protection| OrderProtectionResponse { + id: AdjId((protection.id.0 << 13) | measurement.id.0), + kind: protection.kind, + severity: protection.severity, + time: format_protection_time(protection.time), + }) + .collect(), + }) + .collect(), + }) + }) + // Collect all the OrderPacketResponses + .collect(); + orders.sort_unstable_by_key(|order| order.id.0); + + OrderBoardResponse { + id: board.id, + name: board.name.clone(), + orders, + } + }) + .collect(); + boards.sort_unstable_by_key(|board| board.id.0); + + OrderResponse { boards } + } + + /// Builds the flat protection catalog without modifying or consuming the ADJ. + /// + /// Protection packet ids and names are reused from the loader. The position in + /// each compound id selects its definition within the watched measurement. + /// Packets with no definition at that position are omitted. The resulting list + /// is sorted by packet id, then board id to break ties. + pub fn protection_response(&self) -> ProtectionResponse { + let mut protections: Vec = self + .pod_data + .boards + .values() + // For each board + .flat_map(|board| board.packets.values()) + .filter_map(|packet| { + // If the packet is of type Protection... + let PacketType::Protection(measurement) = &packet.packet_type else { + return None; + }; + + let index = usize::from(packet.id.protection_position()).checked_sub(1)?; + let protection = measurement.protections.get(index)?; + + Some(ProtectionInfoResponse { + id: packet.id, + name: packet.name.clone(), + board_id: packet.board, + measurement_id: measurement.id, + kind: protection.kind, + severity: protection.severity, + time: format_protection_time(protection.time), + }) + }) + .collect(); + protections.sort_unstable_by_key(|protection| (protection.id.0, protection.board_id.0)); + + let info = self + .info + .protection_types + .iter() + .map(|(name, metadata)| { + ( + name.clone(), + ProtectionTypeResponse { + is_range: metadata.is_range, + text: metadata.text.clone(), + text_time: metadata.text_time.clone(), + }, + ) + }) + .collect(); + + ProtectionResponse { protections, info } + } +} + +// Returns Some("(time)xs") if the time is not 0 +fn format_protection_time(time: Duration) -> Option { + if time == Duration::new(0, 0) { + None + } else { + // If the duration is in nanoseconds (default) + let ns = time.as_nanos(); + + // Adjust the result + if ns.is_multiple_of(1_000_000) { + Some(format!("{}ms", ns / 1_000_000)) + } else if ns.is_multiple_of(1_000) { + Some(format!("{}us", ns / 1_000)) + } else { + Some(format!("{}ns", ns)) + } + } +} + +// Matches the kind of measurement and returns the specific type/structure +fn match_measurement_kind(measurement: &MeasurementKind) -> DataMeasurementKind { + match measurement { + MeasurementKind::Numeric { wire_type } => DataMeasurementKind::Numeric { + wire_type: *wire_type, + }, + MeasurementKind::Boolean => DataMeasurementKind::Boolean, + MeasurementKind::Enum { options } => DataMeasurementKind::Enum { + options: options.clone(), + }, + } +} diff --git a/backend/crates/core/src/adj/info.rs b/backend/crates/core/src/adj/info.rs new file mode 100644 index 000000000..57ddc175e --- /dev/null +++ b/backend/crates/core/src/adj/info.rs @@ -0,0 +1,58 @@ +//! Backend-session metadata from `general_info.json`. +//! +//! This is not vehicle data — that's [`crate::model::PodData`] — but what +//! *this backend session* needs beyond the vehicle: known ports and +//! addresses, message-id conventions, and how to display a triggered +//! protection. + +use crate::model::{AdjId, MessageLevel, Port}; +use std::collections::HashMap; +use std::net::IpAddr; + +/// A protection type's display text, as declared in `general_info.json`'s +/// `protectionTypes`. +#[derive(Debug, Clone, PartialEq, Eq, Default)] +pub struct ProtectionTypeInfo { + /// Whether this protection type takes an interval (`[min, max]`) + /// instead of a single bound. + pub is_range: bool, + /// The message template shown at the control station; `{}` stands for + /// the protection's bound(s), `%` for the value that triggered it. + pub text: String, + /// The alternative template for time-accumulation protections, if one + /// was declared. + pub text_time: Option, +} + +/// Backend-session metadata parsed from `general_info.json`. +#[derive(Debug, Clone, PartialEq, Eq, Default)] +pub struct AdjInfo { + /// Known port numbers, by name (e.g. `"TCP_SERVER"` -> `Port(50500)`). + pub ports: HashMap, + /// Known addresses, by name (e.g. `"backend"` -> `192.168.0.9`). + pub addresses: HashMap, + /// Known message ids, by name (e.g. `"fault"` -> `AdjId(2)`) — these + /// live in the ADJ's own special reserved id range (`[0, 511]`, see + /// [`AdjId`]'s own docs), not a separate numbering of their own. + /// This is the ADJ's own direction: a severity's *name* to its id. + /// Not every entry here is one of [`MessageLevel`]'s four severities + /// — other reserved names (e.g. `add_state_order`) share this same + /// map — see [`MessageLevel::name`] for which ones are. + pub message_ids: HashMap, + /// The reverse of [`AdjInfo::message_ids`], and only for the four + /// entries that actually are a [`MessageLevel`]: a wire id straight + /// to its severity. + /// + /// Decoding a free-text log frame only ever has the raw id off the + /// wire, not its name — without this, every decoder would have to + /// search `message_ids` by value (or re-derive this same reverse + /// map itself) just to answer "which severity is id 2?". Built once + /// here, when the ADJ is loaded (see `adj::raw::types`'s + /// `TryFrom for AdjInfo`), + /// from `message_ids` and [`MessageLevel::ALL`]/[`MessageLevel::name`] + /// — never constructed by hand, and never out of sync with + /// `message_ids` since it's derived from it. + pub message_levels: HashMap, + /// Declared protection types, by name (e.g. `"Range"`). + pub protection_types: HashMap, +} diff --git a/backend/crates/core/src/adj/raw.rs b/backend/crates/core/src/adj/raw.rs new file mode 100644 index 000000000..7347e48af --- /dev/null +++ b/backend/crates/core/src/adj/raw.rs @@ -0,0 +1,12 @@ +//! Raw ADJ JSON shapes and the directory-walking loader. +//! +//! Kept together as their own submodule — unlike `error`/`info` — because +//! this whole module is the one piece of `adj` meant to be reused as-is by +//! a future non-`station` product (a sniffer, a simulator...). The +//! individual `RawX` shapes stay private; what's reusable is the +//! [`load_from_dir`] entry point, not picking apart its internals. + +mod loader; +mod types; + +pub use loader::load_from_dir; diff --git a/backend/crates/core/src/adj/raw/loader.rs b/backend/crates/core/src/adj/raw/loader.rs new file mode 100644 index 000000000..32216fc2b --- /dev/null +++ b/backend/crates/core/src/adj/raw/loader.rs @@ -0,0 +1,384 @@ +//! Walks an ADJ directory and builds an [`crate::adj::Adj`] from it. + +use super::types::{RawBoard, RawGeneralInfo, RawMeasurement, RawPacket}; +use crate::adj::error::LoadError; +use crate::adj::{Adj, AdjInfo}; +use crate::model::{ + AdjId, Board, BoardId, MacAddress, Measurement, MessageLevel, PacketDef, PacketType, PodData, +}; +use serde::de::DeserializeOwned; +use std::collections::HashMap; +use std::fs; +use std::net::IpAddr; +use std::path::Path; + +/// Loads an ADJ directory rooted at `path` (containing `general_info.json` +/// and `boards.json`) into an [`Adj`]. +/// +/// A board present on disk but absent from `boards.json` is never read; +/// that isn't an error. +pub fn load_from_dir(path: &Path) -> Result { + let general_info: RawGeneralInfo = read_json(&path.join("general_info.json"))?; + let board_paths: HashMap = read_json(&path.join("boards.json"))?; + + let mut boards = HashMap::new(); + for (name, rel_path) in &board_paths { + let board = load_board(path, name, rel_path)?; + boards.insert(board.id, board); + } + + Ok(Adj { + pod_data: PodData { boards }, + info: AdjInfo::try_from(general_info)?, + }) +} + +/// Reads a JSON file at `path` and deserializes it into `T`, returning a +/// [`LoadError`] on failure. +fn read_json(path: &Path) -> Result { + let text = fs::read_to_string(path).map_err(|source| LoadError::ReadFile { + path: path.to_path_buf(), + source, + })?; + serde_json::from_str(&text).map_err(|source| LoadError::ParseJson { + path: path.to_path_buf(), + source, + }) +} + +pub(crate) fn load_board(root: &Path, name: &str, rel_path: &str) -> Result { + // Read the board's JSON, then its measurements and packets, and build a `Board` from it + let board_file = root.join(rel_path); + let raw_board: RawBoard = read_json(&board_file)?; + let board_id = BoardId(raw_board.board_id); + let board_dir = board_file + .parent() + .map(Path::to_path_buf) + .unwrap_or_else(|| root.to_path_buf()); + + let mut measurements: HashMap = HashMap::new(); + let mut packets: HashMap = HashMap::new(); + + for measurements_path in &raw_board.measurements { + let raws: Vec = read_json(&board_dir.join(measurements_path))?; + for raw in raws { + let alias = raw.alias.clone(); + let measurement = + Measurement::try_from(raw).map_err(|source| LoadError::Measurement { + board: name.to_string(), + alias: alias.clone(), + source, + })?; + + for (idx, _protection) in measurement.protections.iter().enumerate() { + // The compound id's high 3 bits/low 13 bits split — see + // `AdjId::protection_position`/`AdjId::measurement_id` for + // the inverse of this composition. `pos` starts at 1, not + // 0: that's reserved for a normal, non-protection id. + let pos = idx as u16 + 1; + let protection_packet_id = (pos << 13) | measurement.id.0; + + let packet = PacketDef { + id: AdjId(protection_packet_id), + board: board_id, + name: format!("{}_{}_protection_{}", name, measurement.alias, idx + 1), + packet_type: PacketType::Protection(measurement.clone()), + }; + packets.insert(packet.id, packet); + } + measurements.insert(alias, measurement); + } + } + + for packets_path in &raw_board.packets { + let raws: Vec = read_json(&board_dir.join(packets_path))?; + for raw in raws { + let packet = build_packet_def(name, board_id, raw, &measurements)?; + packets.insert(packet.id, packet); + } + } + + let ip: IpAddr = raw_board + .board_ip + .parse() + .map_err(|source| LoadError::InvalidIp { + board: name.to_string(), + raw: raw_board.board_ip.clone(), + source, + })?; + + let mac_text = raw_board.mac.ok_or_else(|| LoadError::MissingMac { + board: name.to_string(), + })?; + let mac = parse_mac(&mac_text).ok_or_else(|| LoadError::InvalidMac { + board: name.to_string(), + raw: mac_text.clone(), + })?; + + Ok(Board { + id: board_id, + name: name.to_string(), + ip, + mac, + packets, + }) +} + +fn build_packet_def( + board: &str, + board_id: BoardId, + raw: RawPacket, + measurements: &HashMap, +) -> Result { + let packet_type = match raw.packet_type.as_str() { + "data" => PacketType::Data(resolve_measurements( + board, + &raw.name, + &raw.variables, + measurements, + )?), + "order" => PacketType::Order(resolve_measurements( + board, + &raw.name, + &raw.variables, + measurements, + )?), + // The packet's own `name` must be one of `MessageLevel`'s four + // severities (`"fault"`/`"warning"`/`"info"`/`"panic"`) — that's + // the only way a `"message"`-type packet in `packets.json` says + // which severity it is; nothing else in its JSON shape does. + "message" => PacketType::Message(MessageLevel::from_name(&raw.name).ok_or_else(|| { + LoadError::UnknownMessageSeverity { + board: board.to_string(), + name: raw.name.clone(), + } + })?), + other => { + return Err(LoadError::UnknownPacketType { + board: board.to_string(), + name: raw.name.clone(), + type_name: other.to_string(), + }); + } + }; + + Ok(PacketDef { + id: AdjId(raw.id), + board: board_id, + name: raw.name, + packet_type, + }) +} + +/// Resolves `variables` (a packet's declared measurement aliases) against +/// `measurements`, in order. +fn resolve_measurements( + board: &str, + packet_name: &str, + variables: &[String], + measurements: &HashMap, +) -> Result, LoadError> { + let mut resolved = Vec::with_capacity(variables.len()); + for alias in variables { + let measurement = + measurements + .get(alias) + .cloned() + .ok_or_else(|| LoadError::UnknownAlias { + board: board.to_string(), + name: packet_name.to_string(), + alias: alias.clone(), + })?; + resolved.push(measurement); + } + Ok(resolved) +} + +/// Parses a MAC address text form, e.g. `"aa:bb:cc:dd:ee:ff"` or the +/// unpadded `"0:0:0:0:0:0"` real ADJ fixtures actually use — each octet is +/// 1 or 2 hex digits. `None` on anything else. +fn parse_mac(raw: &str) -> Option { + let parts: Vec<&str> = raw.split(':').collect(); + if parts.len() != 6 { + return None; + } + + let mut octets = [0u8; 6]; + for (octet, part) in octets.iter_mut().zip(parts) { + if part.is_empty() || part.len() > 2 { + return None; + } + *octet = u8::from_str_radix(part, 16).ok()?; + } + Some(MacAddress(octets)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::adj::ProtectionTypeInfo; + use crate::model::{PacketType, Port, ProtectionKind, Severity}; + use std::path::Path; + use std::time::Duration; + + fn must_load(path: &Path) -> Adj { + let Ok(adj) = load_from_dir(path) else { + unreachable!("fixture directory should load cleanly"); + }; + adj + } + + #[test] + fn mac_address_accepts_padded_and_unpadded_octets() { + assert_eq!( + parse_mac("aa:bb:cc:dd:ee:ff"), + Some(MacAddress([0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff])) + ); + assert_eq!(parse_mac("0:0:0:0:0:0"), Some(MacAddress([0; 6]))); + } + + #[test] + fn mac_address_rejects_malformed_text() { + assert_eq!(parse_mac("aa:bb:cc:dd:ee"), None); + assert_eq!(parse_mac("aa:bb:cc:dd:ee:ff:00"), None); + assert_eq!(parse_mac("aaa:bb:cc:dd:ee:ff"), None); + assert_eq!(parse_mac("zz:bb:cc:dd:ee:ff"), None); + } + + #[test] + fn build_packet_def_rejects_unknown_packet_type() { + let raw = RawPacket { + id: 1, + packet_type: "status".to_string(), + name: "Status".to_string(), + variables: vec![], + }; + assert!(matches!( + build_packet_def("VCU", BoardId(3), raw, &HashMap::new()), + Err(LoadError::UnknownPacketType { .. }) + )); + } + + #[test] + fn build_packet_def_rejects_unknown_alias() { + let raw = RawPacket { + id: 1, + packet_type: "data".to_string(), + name: "Status".to_string(), + variables: vec!["missing".to_string()], + }; + assert!(matches!( + build_packet_def("VCU", BoardId(3), raw, &HashMap::new()), + Err(LoadError::UnknownAlias { .. }) + )); + } + + #[test] + fn build_packet_def_resolves_a_message_packets_severity_from_its_name() { + let raw = RawPacket { + id: 2, + packet_type: "message".to_string(), + name: "fault".to_string(), + variables: vec![], + }; + let Ok(packet) = build_packet_def("VCU", BoardId(3), raw, &HashMap::new()) else { + unreachable!("\"fault\" is a known message severity"); + }; + assert_eq!(packet.packet_type, PacketType::Message(MessageLevel::Fault)); + } + + #[test] + fn build_packet_def_rejects_a_message_whose_name_isnt_a_severity() { + let raw = RawPacket { + id: 2, + packet_type: "message".to_string(), + name: "not_a_severity".to_string(), + variables: vec![], + }; + assert!(matches!( + build_packet_def("VCU", BoardId(3), raw, &HashMap::new()), + Err(LoadError::UnknownMessageSeverity { .. }) + )); + } + + #[test] + fn loads_the_sample_adj_fixture() { + let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("src/adj/test/adj"); + let adj = must_load(&path); + + // `HashMap` iteration order is unspecified, so sort before comparing. + let mut board_names: Vec<&str> = adj + .pod_data + .boards + .values() + .map(|b| b.name.as_str()) + .collect(); + board_names.sort(); + assert_eq!(board_names, vec!["HVBMS", "LCU", "PCU", "VCU"]); + + let Some(vcu) = adj.pod_data.boards.get(&BoardId(3)) else { + unreachable!("VCU should be among the loaded boards"); + }; + assert_eq!(vcu.id, BoardId(3)); + assert_eq!(vcu.ip, IpAddr::from([192, 168, 1, 3])); + assert_eq!(vcu.mac, MacAddress([0; 6])); + assert_eq!(vcu.packets.len(), 18); + let Some(order) = vcu.packets.get(&AdjId(600)) else { + unreachable!("VCU should have order 600"); + }; + let PacketType::Order(_) = &order.packet_type else { + unreachable!("order 600 should be an Order"); + }; + assert_eq!(order.board, BoardId(3)); + let Some(data) = vcu.packets.get(&AdjId(625)) else { + unreachable!("VCU should have data packet 625"); + }; + let PacketType::Data(_) = &data.packet_type else { + unreachable!("data packet 625 should be Data"); + }; + + let Some(pcu) = adj.pod_data.boards.get(&BoardId(5)) else { + unreachable!("PCU should be among the loaded boards"); + }; + let Some(protected) = pcu + .packets + .values() + .flat_map(|p| p.packet_type.measurements()) + .find(|m| !m.protections.is_empty()) + else { + unreachable!("PCU should have a measurement with a protection"); + }; + assert_eq!(protected.protections.len(), 1); + let protection = &protected.protections[0]; + assert_eq!(protection.kind, ProtectionKind::Equal { target: 1.0 }); + assert_eq!(protection.severity, Severity::Fault); + assert_eq!(protection.time, Duration::ZERO); + assert_eq!(protection.id, AdjId(1)); + + assert_eq!(adj.info.ports["TCP_SERVER"], Port(50500)); + assert_eq!( + adj.info.addresses["backend"], + IpAddr::from([192, 168, 0, 9]) + ); + assert_eq!(adj.info.message_ids["fault"], AdjId(2)); + assert_eq!( + adj.info.protection_types["Range"], + ProtectionTypeInfo { + is_range: true, + text: "Value out of range {} (measured: %)".to_string(), + text_time: None, + } + ); + + // `protected` has exactly one protection (asserted above), at position 1, + // so its compound wire id is `(1 << 13) | protected.id.0`. + let Some(protection_packet) = pcu.packets.get(&AdjId((1u16 << 13) | protected.id.0)) else { + unreachable!("PCU should have a synthetic protection packet"); + }; + let PacketType::Protection(measurement) = &protection_packet.packet_type else { + unreachable!("protection_packet should be a Protection"); + }; + assert_eq!(measurement, protected); + assert_eq!(protection_packet.board, pcu.id); + } +} diff --git a/backend/crates/core/src/adj/raw/types.rs b/backend/crates/core/src/adj/raw/types.rs new file mode 100644 index 000000000..bac40de9f --- /dev/null +++ b/backend/crates/core/src/adj/raw/types.rs @@ -0,0 +1,646 @@ +//! Raw ADJ JSON shapes and their conversion into `model` types. +//! +//! These shapes mirror the JSON exactly — including the fields this crate +//! intentionally doesn't model yet (`sockets`, `period`, `period_type`, +//! `socket`, `units`, `podUnits`), which are simply absent from these +//! structs and therefore ignored by serde, not rejected. + +use crate::adj::error::{LoadError, MeasurementError, ProtectionError}; +use crate::adj::info::{AdjInfo, ProtectionTypeInfo}; +use crate::model::{ + AdjId, Measurement, MeasurementKind, MessageLevel, NumericKind, Port, Protection, + ProtectionKind, Severity, +}; +use serde::Deserialize; +use std::collections::HashMap; +use std::time::Duration; + +#[derive(Debug, Clone, PartialEq, Deserialize)] +pub(crate) struct RawGeneralInfo { + pub(crate) ports: HashMap, + pub(crate) addresses: HashMap, + #[serde(rename = "protectionTypes", default)] + pub(crate) protection_types: HashMap, + pub(crate) message_ids: HashMap, +} + +#[derive(Debug, Clone, PartialEq, Deserialize)] +pub(crate) struct RawProtectionType { + #[serde(default)] + pub(crate) range: bool, + pub(crate) text: String, + #[serde(default, rename = "textTime")] + pub(crate) text_time: Option, +} + +#[derive(Debug, Clone, PartialEq, Deserialize)] +pub(crate) struct RawBoard { + pub(crate) board_id: u16, + #[serde(default)] + pub(crate) mac: Option, + pub(crate) board_ip: String, + #[serde(default)] + pub(crate) measurements: Vec, + #[serde(default)] + pub(crate) packets: Vec, +} + +#[derive(Debug, Clone, PartialEq, Deserialize)] +pub(crate) struct RawMeasurement { + pub(crate) id: u16, + pub(crate) alias: String, + pub(crate) name: String, + #[serde(rename = "type")] + pub(crate) kind: String, + #[serde(default, rename = "displayUnits")] + pub(crate) display_units: String, + #[serde(default, rename = "enumValues")] + pub(crate) enum_values: Vec, + #[serde(default)] + pub(crate) protections: Vec, +} + +#[derive(Debug, Clone, PartialEq, Deserialize)] +pub(crate) struct RawProtection { + #[serde(rename = "type")] + pub(crate) kind: String, + pub(crate) value: Vec, + #[serde(default = "default_fault")] + pub(crate) fault: bool, + #[serde(default)] + pub(crate) time: Option, +} + +fn default_fault() -> bool { + true +} + +#[derive(Debug, Clone, PartialEq, Deserialize)] +pub(crate) struct RawPacket { + pub(crate) id: u16, + #[serde(rename = "type")] + pub(crate) packet_type: String, + pub(crate) name: String, + #[serde(default)] + pub(crate) variables: Vec, +} + +impl TryFrom for AdjInfo { + type Error = LoadError; + + fn try_from(raw: RawGeneralInfo) -> Result { + let mut addresses = HashMap::with_capacity(raw.addresses.len()); + for (name, raw_addr) in raw.addresses { + let addr = raw_addr + .parse() + .map_err(|source| LoadError::InvalidAddress { + name: name.clone(), + raw: raw_addr, + source, + })?; + addresses.insert(name, addr); + } + + let message_ids: HashMap = raw + .message_ids + .into_iter() + .map(|(name, id)| (name, AdjId(id))) + .collect(); + + // The reverse of `message_ids`, restricted to the four names + // that are actually a `MessageLevel` — see `AdjInfo::message_levels`'s + // own doc comment for why this is worth precomputing here rather + // than leaving every caller to search `message_ids` by value. + let message_levels: HashMap = MessageLevel::ALL + .into_iter() + .filter_map(|level| message_ids.get(level.name()).map(|&id| (id, level))) + .collect(); + + Ok(AdjInfo { + ports: raw + .ports + .into_iter() + .map(|(name, port)| (name, Port(port))) + .collect(), + addresses, + message_ids, + message_levels, + protection_types: raw + .protection_types + .into_iter() + .map(|(name, kind)| { + ( + name, + ProtectionTypeInfo { + is_range: kind.range, + text: kind.text, + text_time: kind.text_time, + }, + ) + }) + .collect(), + }) + } +} + +impl TryFrom for Measurement { + type Error = MeasurementError; + + fn try_from(raw: RawMeasurement) -> Result { + if raw.protections.len() > 7 { + return Err(MeasurementError::TooManyProtections { + count: raw.protections.len(), + }); + } + + let kind = parse_measurement_kind(&raw.kind, raw.enum_values)?; + + let mut protections = Vec::with_capacity(raw.protections.len()); + for (zero_based, raw_protection) in raw.protections.into_iter().enumerate() { + let position = (zero_based + 1) as u16; + let protection = + Protection::try_from((raw_protection, position)).map_err(|source| { + MeasurementError::Protection { + index: position as usize, + source, + } + })?; + protections.push(protection); + } + + Ok(Measurement { + id: AdjId(raw.id), + alias: raw.alias, + name: raw.name, + display_units: raw.display_units, + kind, + protections, + }) + } +} + +impl TryFrom<(RawProtection, u16)> for Protection { + type Error = ProtectionError; + + fn try_from((raw, position): (RawProtection, u16)) -> Result { + let kind = parse_protection_kind(&raw.kind, &raw.value)?; + let time = match &raw.time { + Some(text) => parse_duration(text)?, + None => Duration::ZERO, + }; + + Ok(Protection { + id: AdjId(position), + kind, + severity: if raw.fault { + Severity::Fault + } else { + Severity::Warning + }, + time, + }) + } +} + +fn parse_measurement_kind( + kind: &str, + enum_values: Vec, +) -> Result { + let numeric = |wire_type| MeasurementKind::Numeric { wire_type }; + + match kind { + "uint8" => Ok(numeric(NumericKind::U8)), + "uint16" => Ok(numeric(NumericKind::U16)), + "uint32" => Ok(numeric(NumericKind::U32)), + "uint64" => Ok(numeric(NumericKind::U64)), + "int8" => Ok(numeric(NumericKind::I8)), + "int16" => Ok(numeric(NumericKind::I16)), + "int32" => Ok(numeric(NumericKind::I32)), + "int64" => Ok(numeric(NumericKind::I64)), + "float32" => Ok(numeric(NumericKind::F32)), + "float64" => Ok(numeric(NumericKind::F64)), + "bool" => Ok(MeasurementKind::Boolean), + "enum" if !enum_values.is_empty() => Ok(MeasurementKind::Enum { + options: enum_values, + }), + "enum" => Err(MeasurementError::MissingEnumValues), + other => Err(MeasurementError::UnknownType(other.to_string())), + } +} + +fn parse_protection_kind(kind: &str, value: &[f64]) -> Result { + fn one(kind: &str, value: &[f64]) -> Result { + match value { + [bound] => Ok(*bound), + other => Err(ProtectionError::WrongBoundCount { + kind: kind.to_string(), + expected: 1, + got: other.len(), + }), + } + } + + fn two(kind: &str, value: &[f64]) -> Result<(f64, f64), ProtectionError> { + match value { + [min, max] => Ok((*min, *max)), + other => Err(ProtectionError::WrongBoundCount { + kind: kind.to_string(), + expected: 2, + got: other.len(), + }), + } + } + + match kind { + "Above" => Ok(ProtectionKind::Above { + limit: one(kind, value)?, + }), + "Below" => Ok(ProtectionKind::Below { + limit: one(kind, value)?, + }), + "Equal" => Ok(ProtectionKind::Equal { + target: one(kind, value)?, + }), + "NotEqual" => Ok(ProtectionKind::NotEqual { + target: one(kind, value)?, + }), + "Range" => { + let (min, max) = two(kind, value)?; + Ok(ProtectionKind::Range { min, max }) + } + other => Err(ProtectionError::UnknownType(other.to_string())), + } +} + +/// Parses a duration string like `"500ms"`, `"3s"` or `"10us"`. +/// +/// Rejects non-finite or negative numbers explicitly before handing them to +/// [`Duration::from_secs_f64`], which panics on either — this reads +/// externally-authored ADJ text, so a malformed `"time"` (e.g. `"-5ms"`) +/// must become an error, not a panic. +fn parse_duration(text: &str) -> Result { + let Some(split_at) = text.find(|c: char| c.is_ascii_alphabetic()) else { + return Err(ProtectionError::InvalidTime(text.to_string())); + }; + let (number, unit) = text.split_at(split_at); + + let value: f64 = number + .parse() + .map_err(|_| ProtectionError::InvalidTime(text.to_string()))?; + + if !value.is_finite() || value < 0.0 { + return Err(ProtectionError::InvalidTime(text.to_string())); + } + + let seconds = match unit { + "s" => value, + "ms" => value / 1_000.0, + "us" => value / 1_000_000.0, + _ => return Err(ProtectionError::InvalidTime(text.to_string())), + }; + + Ok(Duration::from_secs_f64(seconds)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::adj::raw::loader::load_board; + use crate::model::PacketType; + use std::net::IpAddr; + + fn raw_protection( + kind: &str, + value: Vec, + fault: bool, + time: Option<&str>, + ) -> RawProtection { + RawProtection { + kind: kind.to_string(), + value, + fault, + time: time.map(str::to_string), + } + } + + fn must_build_protection(raw: RawProtection, position: u16) -> Protection { + let Ok(protection) = Protection::try_from((raw, position)) else { + unreachable!("valid protection should convert cleanly"); + }; + protection + } + + #[test] + fn numeric_measurement_types_map_to_their_numeric_kind() { + let cases = [ + ("uint8", NumericKind::U8), + ("uint16", NumericKind::U16), + ("uint32", NumericKind::U32), + ("uint64", NumericKind::U64), + ("int8", NumericKind::I8), + ("int16", NumericKind::I16), + ("int32", NumericKind::I32), + ("int64", NumericKind::I64), + ("float32", NumericKind::F32), + ("float64", NumericKind::F64), + ]; + + for (type_name, expected) in cases { + assert!(matches!( + parse_measurement_kind(type_name, vec![]), + Ok(MeasurementKind::Numeric { wire_type }) if wire_type == expected + )); + } + } + + #[test] + fn bool_type_maps_to_boolean() { + assert!(matches!( + parse_measurement_kind("bool", vec![]), + Ok(MeasurementKind::Boolean) + )); + } + + #[test] + fn enum_type_with_values_keeps_their_order() { + let options = vec!["Idle".to_string(), "Fault".to_string()]; + assert!(matches!( + parse_measurement_kind("enum", options.clone()), + Ok(MeasurementKind::Enum { options: got }) if got == options + )); + } + + #[test] + fn enum_type_without_values_is_an_error() { + assert!(matches!( + parse_measurement_kind("enum", vec![]), + Err(MeasurementError::MissingEnumValues) + )); + } + + #[test] + fn unknown_measurement_type_is_an_error() { + assert!(matches!( + parse_measurement_kind("potato", vec![]), + Err(MeasurementError::UnknownType(t)) if t == "potato" + )); + } + + #[test] + fn one_bound_protection_kinds_take_a_single_value() { + assert!(matches!( + parse_protection_kind("Above", &[1.0]), + Ok(ProtectionKind::Above { limit }) if limit == 1.0 + )); + assert!(matches!( + parse_protection_kind("Below", &[2.0]), + Ok(ProtectionKind::Below { limit }) if limit == 2.0 + )); + assert!(matches!( + parse_protection_kind("Equal", &[3.0]), + Ok(ProtectionKind::Equal { target }) if target == 3.0 + )); + assert!(matches!( + parse_protection_kind("NotEqual", &[4.0]), + Ok(ProtectionKind::NotEqual { target }) if target == 4.0 + )); + } + + #[test] + fn range_protection_takes_two_values() { + assert!(matches!( + parse_protection_kind("Range", &[0.0, 48.0]), + Ok(ProtectionKind::Range { min, max }) if min == 0.0 && max == 48.0 + )); + } + + #[test] + fn wrong_bound_count_is_an_error() { + assert!(matches!( + parse_protection_kind("Above", &[1.0, 2.0]), + Err(ProtectionError::WrongBoundCount { + expected: 1, + got: 2, + .. + }) + )); + assert!(matches!( + parse_protection_kind("Range", &[1.0]), + Err(ProtectionError::WrongBoundCount { + expected: 2, + got: 1, + .. + }) + )); + } + + #[test] + fn unknown_protection_type_is_an_error() { + assert!(matches!( + parse_protection_kind("Potato", &[1.0]), + Err(ProtectionError::UnknownType(t)) if t == "Potato" + )); + } + + #[test] + fn fault_flag_selects_severity_default_true() { + let protection = must_build_protection(raw_protection("Equal", vec![1.0], true, None), 1); + assert_eq!(protection.severity, Severity::Fault); + + let protection = must_build_protection(raw_protection("Equal", vec![1.0], false, None), 1); + assert_eq!(protection.severity, Severity::Warning); + } + + #[test] + fn protection_id_is_its_position_not_a_global_id() { + let protection = must_build_protection(raw_protection("Equal", vec![1.0], true, None), 3); + assert_eq!(protection.id, AdjId(3)); + } + + #[test] + fn missing_time_defaults_to_zero() { + let protection = must_build_protection(raw_protection("Equal", vec![1.0], true, None), 1); + assert_eq!(protection.time, Duration::ZERO); + } + + #[test] + fn duration_strings_parse_with_their_unit() { + assert!(matches!(parse_duration("500ms"), Ok(d) if d == Duration::from_millis(500))); + assert!(matches!(parse_duration("3s"), Ok(d) if d == Duration::from_secs(3))); + assert!(matches!(parse_duration("10us"), Ok(d) if d == Duration::from_micros(10))); + } + + #[test] + fn invalid_duration_strings_are_rejected() { + assert!(matches!( + parse_duration("banana"), + Err(ProtectionError::InvalidTime(_)) + )); + assert!(matches!( + parse_duration("-5ms"), + Err(ProtectionError::InvalidTime(_)) + )); + assert!(matches!( + parse_duration("5"), + Err(ProtectionError::InvalidTime(_)) + )); + } + + #[test] + fn general_info_converts_into_adj_info() { + let mut protection_types = HashMap::new(); + protection_types.insert( + "Range".to_string(), + RawProtectionType { + range: true, + text: "Value out of range {} (measured: %)".to_string(), + text_time: None, + }, + ); + let raw = RawGeneralInfo { + ports: HashMap::from([("TCP_SERVER".to_string(), 50500u16)]), + addresses: HashMap::from([("backend".to_string(), "192.168.0.9".to_string())]), + protection_types, + message_ids: HashMap::from([ + ("fault".to_string(), 2u16), + // Not a `MessageLevel` — shares `message_ids` with the + // four severities, but shouldn't appear in `message_levels`. + ("add_state_order".to_string(), 5u16), + ]), + }; + + let Ok(info) = AdjInfo::try_from(raw) else { + unreachable!("a well-formed RawGeneralInfo should convert cleanly"); + }; + + assert_eq!(info.ports["TCP_SERVER"], Port(50500)); + assert_eq!(info.addresses["backend"], IpAddr::from([192, 168, 0, 9])); + assert_eq!(info.message_ids["fault"], AdjId(2)); + assert_eq!(info.message_ids["add_state_order"], AdjId(5)); + assert!(info.protection_types["Range"].is_range); + + // `message_levels` is the reverse of `message_ids`, but only for + // the one entry that's actually a `MessageLevel`. + assert_eq!(info.message_levels.len(), 1); + assert_eq!(info.message_levels[&AdjId(2)], MessageLevel::Fault); + } + + #[test] + fn general_info_rejects_an_invalid_address() { + let raw = RawGeneralInfo { + ports: HashMap::new(), + addresses: HashMap::from([("backend".to_string(), "not-an-ip".to_string())]), + protection_types: HashMap::new(), + message_ids: HashMap::new(), + }; + + assert!(matches!( + AdjInfo::try_from(raw), + Err(LoadError::InvalidAddress { .. }) + )); + } + + #[test] + fn measurement_with_too_many_protections() { + let mut raw = RawMeasurement { + id: 100, + alias: "too_many".to_string(), + name: "Too Many Protections".to_string(), + kind: "float32".to_string(), + display_units: "V".to_string(), + enum_values: vec![], + protections: vec![], + }; + + for _ in 0..8 { + raw.protections + .push(raw_protection("Equal", vec![1.0], true, None)); + } + + assert!(matches!( + Measurement::try_from(raw), + Err(MeasurementError::TooManyProtections { count: 8 }) + )) + } + + #[test] + fn board_incorporates_synthetic_protection_packets() { + // A scratch directory, unique per test invocation (pid + a counter) + // so parallel test runs never collide on the same path. + use std::sync::atomic::{AtomicU32, Ordering}; + static COUNTER: AtomicU32 = AtomicU32::new(0); + let unique = COUNTER.fetch_add(1, Ordering::Relaxed); + let dir = std::env::temp_dir().join(format!( + "software_core_adj_test_{}_{unique}", + std::process::id() + )); + + if std::fs::create_dir_all(&dir).is_err() { + unreachable!("should be able to create a scratch test directory"); + } + + let board_json = r#"{ + "board_id": 99, + "mac": "aa:bb:cc:dd:ee:ff", + "board_ip": "127.0.0.1", + "measurements": ["measurements.json"], + "packets": ["packets.json"] + }"#; + let measurements_json = r#"[ + { + "id": 100, + "alias": "mock_alias", + "name": "Mock Measurement", + "type": "float32", + "protections": [ + { "type": "Equal", "value": [1.0], "fault": true }, + { "type": "Equal", "value": [2.0], "fault": true } + ] + } + ]"#; + + if std::fs::write(dir.join("test_board.json"), board_json).is_err() { + unreachable!("should be able to write the mock board file"); + } + if std::fs::write(dir.join("measurements.json"), measurements_json).is_err() { + unreachable!("should be able to write the mock measurements file"); + } + if std::fs::write(dir.join("packets.json"), "[]").is_err() { + unreachable!("should be able to write the mock packets file"); + } + + let board_name = "H12_Test_Board"; + let result = load_board(&dir, board_name, "test_board.json"); + let _ = std::fs::remove_dir_all(&dir); + + let board = match result { + Ok(board) => board, + Err(err) => unreachable!("board loading should succeed: {err}"), + }; + + // We provided 0 standard packets and 2 protections, so the total + // synthetic packets injected into the board must equal 2. + let protection_count = board + .packets + .values() + .filter(|p| matches!(p.packet_type, PacketType::Protection(_))) + .count(); + assert_eq!( + protection_count, 2, + "board should contain exactly 2 protection packets" + ); + + // For protection index 0 (pos = 1): (1 << 13) | 100 = 8192 | 100 = 8292 + let Some(first) = board.packets.get(&AdjId(8292)) else { + unreachable!("first synthetic protection packet should be at id 8292"); + }; + assert_eq!(first.board, board.id); + assert_eq!(first.name, format!("{board_name}_mock_alias_protection_1")); + + // For protection index 1 (pos = 2): (2 << 13) | 100 = 16384 | 100 = 16484 + let Some(second) = board.packets.get(&AdjId(16484)) else { + unreachable!("second synthetic protection packet should be at id 16484"); + }; + assert_eq!(second.name, format!("{board_name}_mock_alias_protection_2")); + } +} diff --git a/backend/crates/core/src/adj/test/adj/boards.json b/backend/crates/core/src/adj/test/adj/boards.json new file mode 100644 index 000000000..9de2c650a --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards.json @@ -0,0 +1,6 @@ +{ + "VCU": "boards/VCU/VCU.json", + "LCU": "boards/LCU/LCU.json", + "PCU": "boards/PCU/PCU.json", + "HVBMS": "boards/HVBMS/HVBMS.json" +} diff --git a/backend/crates/core/src/adj/test/adj/boards/BLCU/BLCU.json b/backend/crates/core/src/adj/test/adj/boards/BLCU/BLCU.json new file mode 100644 index 000000000..2c98964c1 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/BLCU/BLCU.json @@ -0,0 +1,12 @@ +{ + "board_id": 27, + "board_ip": "192.168.0.27", + "measurements": ["BLCU_measurements.json"], + "packets": [ + "packets.json", + "orders.json" + ], + "sockets": [ + "sockets.json" + ] +} diff --git a/backend/crates/core/src/adj/test/adj/boards/BLCU/BLCU_measurements.json b/backend/crates/core/src/adj/test/adj/boards/BLCU/BLCU_measurements.json new file mode 100644 index 000000000..f44182d73 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/BLCU/BLCU_measurements.json @@ -0,0 +1,34 @@ +[ + { + "id": "target", + "name": "target", + "type": "enum", + "enumValues": [ + "VCU", + "HVBMS", + "LVBMS", + "PCU", + "LCU" + ] + }, + { + "id": "general_state_machine", + "name": "General State Machine", + "type": "enum", + "enumValues": [ + "Connecting", + "Operational", + "Fault" + ] + }, + { + "id": "operational_state_machine", + "name": "Operational state machine", + "type": "enum", + "enumValues": [ + "Idle", + "Flashing" + ] + } + +] diff --git a/backend/crates/core/src/adj/test/adj/boards/BLCU/orders.json b/backend/crates/core/src/adj/test/adj/boards/BLCU/orders.json new file mode 100644 index 000000000..1a7167d60 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/BLCU/orders.json @@ -0,0 +1,15 @@ +[ + { + "id": 701, + "type": "order", + "name": "Reset All" + }, + { + "id":700, + "type": "order", + "name":"Write Program", + "variables":[ + "target" + ] + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/BLCU/packets.json b/backend/crates/core/src/adj/test/adj/boards/BLCU/packets.json new file mode 100644 index 000000000..4674afdc2 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/BLCU/packets.json @@ -0,0 +1,28 @@ +[ + { + "id":3, + "type": "packet", + "name":"ack" + }, + { + "id":4, + "type": "packet", + "name":"nack" + }, + + { + "id": 1, + "type": "packet", + "name": "state_machine_state", + "variables": + [ + "general_state_machine", + "operational_state_machine" + ], + "period_type": "ms", + "period": 16.67, + "socket": "control_station_udp" + + } + +] diff --git a/backend/crates/core/src/adj/test/adj/boards/BLCU/sockets.json b/backend/crates/core/src/adj/test/adj/boards/BLCU/sockets.json new file mode 100644 index 000000000..173e674e2 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/BLCU/sockets.json @@ -0,0 +1,14 @@ +[ + { + "type": "ServerSocket", + "name": "control_station_tcp", + "port": 50500 + }, + + { + "type": "DatagramSocket", + "name": "control_station_udp", + "remote_ip":"backend", + "port": 50420 + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/HVBMS/HVBMS.json b/backend/crates/core/src/adj/test/adj/boards/HVBMS/HVBMS.json new file mode 100644 index 000000000..0022eb5ec --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/HVBMS/HVBMS.json @@ -0,0 +1,15 @@ +{ + "board_id": 7, + "mac": "0:0:0:0:0:0", + "board_ip": "192.168.1.7", + "measurements": [ + "HVBMS_measurements.json" + ], + "packets": [ + "packets.json", + "orders.json" + ], + "sockets": [ + "sockets.json" + ] +} \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/HVBMS/HVBMS_measurements.json b/backend/crates/core/src/adj/test/adj/boards/HVBMS/HVBMS_measurements.json new file mode 100644 index 000000000..d31af6972 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/HVBMS/HVBMS_measurements.json @@ -0,0 +1,1102 @@ +[ + { + "id": 2005, + "alias": "battery1_cell1", + "name": "Battery 1 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2006, + "alias": "battery1_cell2", + "name": "Battery 1 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2007, + "alias": "battery1_cell3", + "name": "Battery 1 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2008, + "alias": "battery1_cell4", + "name": "Battery 1 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2009, + "alias": "battery1_cell5", + "name": "Battery 1 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2010, + "alias": "battery1_cell6", + "name": "Battery 1 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2011, + "alias": "battery1_cell7", + "name": "Battery 1 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2012, + "alias": "battery1_cell8", + "name": "Battery 1 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2013, + "alias": "battery1_cell9", + "name": "Battery 1 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2014, + "alias": "battery1_cell10", + "name": "Battery 1 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2015, + "alias": "battery1_cell11", + "name": "Battery 1 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2016, + "alias": "battery1_cell12", + "name": "Battery 1 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2017, + "alias": "battery1_total_voltage", + "name": "Battery 1 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2018, + "alias": "battery1_temp1", + "name": "Battery 1 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2019, + "alias": "battery1_temp2", + "name": "Battery 1 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2020, + "alias": "battery1_temp3", + "name": "Battery 1 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2021, + "alias": "battery1_temp4", + "name": "Battery 1 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2022, + "alias": "battery2_cell1", + "name": "Battery 2 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2023, + "alias": "battery2_cell2", + "name": "Battery 2 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2024, + "alias": "battery2_cell3", + "name": "Battery 2 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2025, + "alias": "battery2_cell4", + "name": "Battery 2 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2026, + "alias": "battery2_cell5", + "name": "Battery 2 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2027, + "alias": "battery2_cell6", + "name": "Battery 2 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2028, + "alias": "battery2_cell7", + "name": "Battery 2 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2029, + "alias": "battery2_cell8", + "name": "Battery 2 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2030, + "alias": "battery2_cell9", + "name": "Battery 2 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2031, + "alias": "battery2_cell10", + "name": "Battery 2 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2032, + "alias": "battery2_cell11", + "name": "Battery 2 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2033, + "alias": "battery2_cell12", + "name": "Battery 2 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2034, + "alias": "battery2_total_voltage", + "name": "Battery 2 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2035, + "alias": "battery2_temp1", + "name": "Battery 2 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2036, + "alias": "battery2_temp2", + "name": "Battery 2 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2037, + "alias": "battery2_temp3", + "name": "Battery 2 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2038, + "alias": "battery2_temp4", + "name": "Battery 2 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2039, + "alias": "battery3_cell1", + "name": "Battery 3 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2040, + "alias": "battery3_cell2", + "name": "Battery 3 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2041, + "alias": "battery3_cell3", + "name": "Battery 3 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2042, + "alias": "battery3_cell4", + "name": "Battery 3 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2043, + "alias": "battery3_cell5", + "name": "Battery 3 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2044, + "alias": "battery3_cell6", + "name": "Battery 3 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2045, + "alias": "battery3_cell7", + "name": "Battery 3 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2046, + "alias": "battery3_cell8", + "name": "Battery 3 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2047, + "alias": "battery3_cell9", + "name": "Battery 3 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2048, + "alias": "battery3_cell10", + "name": "Battery 3 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2049, + "alias": "battery3_cell11", + "name": "Battery 3 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2050, + "alias": "battery3_cell12", + "name": "Battery 3 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2051, + "alias": "battery3_total_voltage", + "name": "Battery 3 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2052, + "alias": "battery3_temp1", + "name": "Battery 3 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2053, + "alias": "battery3_temp2", + "name": "Battery 3 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2054, + "alias": "battery3_temp3", + "name": "Battery 3 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2055, + "alias": "battery3_temp4", + "name": "Battery 3 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2056, + "alias": "battery4_cell1", + "name": "Battery 4 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2057, + "alias": "battery4_cell2", + "name": "Battery 4 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2058, + "alias": "battery4_cell3", + "name": "Battery 4 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2059, + "alias": "battery4_cell4", + "name": "Battery 4 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2060, + "alias": "battery4_cell5", + "name": "Battery 4 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2061, + "alias": "battery4_cell6", + "name": "Battery 4 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2062, + "alias": "battery4_cell7", + "name": "Battery 4 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2063, + "alias": "battery4_cell8", + "name": "Battery 4 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2064, + "alias": "battery4_cell9", + "name": "Battery 4 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2065, + "alias": "battery4_cell10", + "name": "Battery 4 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2066, + "alias": "battery4_cell11", + "name": "Battery 4 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2067, + "alias": "battery4_cell12", + "name": "Battery 4 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2068, + "alias": "battery4_total_voltage", + "name": "Battery 4 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2069, + "alias": "battery4_temp1", + "name": "Battery 4 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2070, + "alias": "battery4_temp2", + "name": "Battery 4 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2071, + "alias": "battery4_temp3", + "name": "Battery 4 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2072, + "alias": "battery4_temp4", + "name": "Battery 4 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2073, + "alias": "battery5_cell1", + "name": "Battery 5 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2074, + "alias": "battery5_cell2", + "name": "Battery 5 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2075, + "alias": "battery5_cell3", + "name": "Battery 5 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2076, + "alias": "battery5_cell4", + "name": "Battery 5 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2077, + "alias": "battery5_cell5", + "name": "Battery 5 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2078, + "alias": "battery5_cell6", + "name": "Battery 5 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2079, + "alias": "battery5_cell7", + "name": "Battery 5 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2080, + "alias": "battery5_cell8", + "name": "Battery 5 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2081, + "alias": "battery5_cell9", + "name": "Battery 5 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2082, + "alias": "battery5_cell10", + "name": "Battery 5 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2083, + "alias": "battery5_cell11", + "name": "Battery 5 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2084, + "alias": "battery5_cell12", + "name": "Battery 5 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2085, + "alias": "battery5_total_voltage", + "name": "Battery 5 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2086, + "alias": "battery5_temp1", + "name": "Battery 5 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2087, + "alias": "battery5_temp2", + "name": "Battery 5 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2088, + "alias": "battery5_temp3", + "name": "Battery 5 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2089, + "alias": "battery5_temp4", + "name": "Battery 5 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2090, + "alias": "battery6_cell1", + "name": "Battery 6 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2091, + "alias": "battery6_cell2", + "name": "Battery 6 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2092, + "alias": "battery6_cell3", + "name": "Battery 6 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2093, + "alias": "battery6_cell4", + "name": "Battery 6 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2094, + "alias": "battery6_cell5", + "name": "Battery 6 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2095, + "alias": "battery6_cell6", + "name": "Battery 6 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2096, + "alias": "battery6_cell7", + "name": "Battery 6 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2097, + "alias": "battery6_cell8", + "name": "Battery 6 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2098, + "alias": "battery6_cell9", + "name": "Battery 6 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2099, + "alias": "battery6_cell10", + "name": "Battery 6 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2100, + "alias": "battery6_cell11", + "name": "Battery 6 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2101, + "alias": "battery6_cell12", + "name": "Battery 6 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2102, + "alias": "battery6_total_voltage", + "name": "Battery 6 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2103, + "alias": "battery6_temp1", + "name": "Battery 6 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2104, + "alias": "battery6_temp2", + "name": "Battery 6 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2105, + "alias": "battery6_temp3", + "name": "Battery 6 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2106, + "alias": "battery6_temp4", + "name": "Battery 6 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2107, + "alias": "battery7_cell1", + "name": "Battery 7 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2108, + "alias": "battery7_cell2", + "name": "Battery 7 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2109, + "alias": "battery7_cell3", + "name": "Battery 7 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2110, + "alias": "battery7_cell4", + "name": "Battery 7 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2111, + "alias": "battery7_cell5", + "name": "Battery 7 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2112, + "alias": "battery7_cell6", + "name": "Battery 7 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2113, + "alias": "battery7_cell7", + "name": "Battery 7 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2114, + "alias": "battery7_cell8", + "name": "Battery 7 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2115, + "alias": "battery7_cell9", + "name": "Battery 7 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2116, + "alias": "battery7_cell10", + "name": "Battery 7 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2117, + "alias": "battery7_cell11", + "name": "Battery 7 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2118, + "alias": "battery7_cell12", + "name": "Battery 7 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2119, + "alias": "battery7_total_voltage", + "name": "Battery 7 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2120, + "alias": "battery7_temp1", + "name": "Battery 7 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2121, + "alias": "battery7_temp2", + "name": "Battery 7 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2122, + "alias": "battery7_temp3", + "name": "Battery 7 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2123, + "alias": "battery7_temp4", + "name": "Battery 7 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2124, + "alias": "battery8_cell1", + "name": "Battery 8 Cell 1", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2125, + "alias": "battery8_cell2", + "name": "Battery 8 Cell 2", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2126, + "alias": "battery8_cell3", + "name": "Battery 8 Cell 3", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2127, + "alias": "battery8_cell4", + "name": "Battery 8 Cell 4", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2128, + "alias": "battery8_cell5", + "name": "Battery 8 Cell 5", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2129, + "alias": "battery8_cell6", + "name": "Battery 8 Cell 6", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2130, + "alias": "battery8_cell7", + "name": "Battery 8 Cell 7", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2131, + "alias": "battery8_cell8", + "name": "Battery 8 Cell 8", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2132, + "alias": "battery8_cell9", + "name": "Battery 8 Cell 9", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2133, + "alias": "battery8_cell10", + "name": "Battery 8 Cell 10", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2134, + "alias": "battery8_cell11", + "name": "Battery 8 Cell 11", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2135, + "alias": "battery8_cell12", + "name": "Battery 8 Cell 12", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2136, + "alias": "battery8_total_voltage", + "name": "Battery 8 Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2137, + "alias": "battery8_temp1", + "name": "Battery 8 Temperature 1", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2138, + "alias": "battery8_temp2", + "name": "Battery 8 Temperature 2", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2139, + "alias": "battery8_temp3", + "name": "Battery 8 Temperature 3", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2140, + "alias": "battery8_temp4", + "name": "Battery 8 Temperature 4", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2141, + "alias": "batteries_voltage_reading", + "name": "Batteries Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2142, + "alias": "voltage_reading", + "name": "Voltage Sensor", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2143, + "alias": "current_reading", + "name": "Current Sensor", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 2144, + "alias": "sdc_status", + "name": "SDC Status", + "type": "enum", + "enumValues": [ + "ENGAGED", + "DISENGAGED" + ] + }, + { + "id": 2145, + "alias": "voltage_min", + "name": "Minimum Cell Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2146, + "alias": "voltage_max", + "name": "Maximum Cell Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 2147, + "alias": "temp_min", + "name": "Minimum Temperature", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2148, + "alias": "temp_max", + "name": "Maximum Temperature", + "type": "float32", + "displayUnits": "ºC" + }, + { + "id": 2149, + "alias": "imd_status", + "name": "IMD Status", + "type": "enum", + "enumValues": [ + "SHORTCIRCUIT", + "NORMAL", + "UNDERVOLTAGE", + "FAST_EVAL", + "EQUIPMENT_FAULT", + "GROUNDING_FAULT" + ] + }, + { + "id": 2150, + "alias": "imd_resistance", + "name": "IMD Resistance", + "type": "float32", + "displayUnits": "MOhm" + }, + { + "id": 2151, + "alias": "imd_is_ok", + "name": "IMD OK", + "type": "bool" + }, + { + "id": 2152, + "alias": "imd_duty", + "name": "IMD Duty", + "type": "float32" + }, + { + "id": 2153, + "alias": "imd_freq", + "name": "IMD Frequency", + "type": "float32" + }, + { + "id": 2154, + "alias": "contactor_precharge", + "name": "Contactor Precharge", + "type": "bool" + }, + { + "id": 2155, + "alias": "contactor_discharge", + "name": "Contactor Discharge", + "type": "bool" + }, + { + "id": 2156, + "alias": "contactor_high", + "name": "Contactor High", + "type": "bool" + }, + { + "id": 2157, + "alias": "contactor_low", + "name": "Contactor Low", + "type": "bool" + }, + { + "id": 2158, + "alias": "contactor_common_high", + "name": "Contactor Common High", + "type": "bool" + }, + { + "id": 2159, + "alias": "soc", + "name": "SOC", + "type": "float32" + }, + { + "id": 2160, + "alias": "sm_status", + "name": "State Machine Status", + "type": "enum", + "enumValues": [ + "Connecting", + "Idle", + "Ready To Precharge", + "Precharging", + "Energized", + "FAULT" + ] + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/HVBMS/orders.json b/backend/crates/core/src/adj/test/adj/boards/HVBMS/orders.json new file mode 100644 index 000000000..fe54b536a --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/HVBMS/orders.json @@ -0,0 +1,32 @@ +[ + { + "type": "order", + "name": "FAULT", + "variables": [], + "id": 2000 + }, + { + "type": "order", + "name": "Open Contactors", + "variables": [], + "id": 2001 + }, + { + "type": "order", + "name": "Cell Balance", + "variables": [], + "id": 2002 + }, + { + "type": "order", + "name": "Start Precharge", + "variables": [], + "id": 2003 + }, + { + "type": "order", + "name": "Check Faults", + "variables": [], + "id": 2004 + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/HVBMS/packets.json b/backend/crates/core/src/adj/test/adj/boards/HVBMS/packets.json new file mode 100644 index 000000000..01a841af3 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/HVBMS/packets.json @@ -0,0 +1,218 @@ +[ + { + "type": "data", + "name": "High Voltage System", + "variables": [ + "voltage_min", + "voltage_max", + "temp_min", + "temp_max", + "current_reading", + "voltage_reading", + "batteries_voltage_reading", + "sm_status" + ], + "id": 2161, + "period": 10, + "period_type": "ms", + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "SOC", + "variables": [ + "soc" + ], + "id": 2162, + "period": 50, + "period_type": "ms", + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "SDC", + "variables": [ + "sdc_status" + ], + "id": 2163, + "period": 50, + "period_type": "ms", + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "High Voltage Batteries", + "variables": [ + "battery1_cell1", + "battery1_cell2", + "battery1_cell3", + "battery1_cell4", + "battery1_cell5", + "battery1_cell6", + "battery1_cell7", + "battery1_cell8", + "battery1_cell9", + "battery1_cell10", + "battery1_cell11", + "battery1_cell12", + "battery1_total_voltage", + "battery1_temp1", + "battery1_temp2", + "battery1_temp3", + "battery1_temp4", + "battery2_cell1", + "battery2_cell2", + "battery2_cell3", + "battery2_cell4", + "battery2_cell5", + "battery2_cell6", + "battery2_cell7", + "battery2_cell8", + "battery2_cell9", + "battery2_cell10", + "battery2_cell11", + "battery2_cell12", + "battery2_total_voltage", + "battery2_temp1", + "battery2_temp2", + "battery2_temp3", + "battery2_temp4", + "battery3_cell1", + "battery3_cell2", + "battery3_cell3", + "battery3_cell4", + "battery3_cell5", + "battery3_cell6", + "battery3_cell7", + "battery3_cell8", + "battery3_cell9", + "battery3_cell10", + "battery3_cell11", + "battery3_cell12", + "battery3_total_voltage", + "battery3_temp1", + "battery3_temp2", + "battery3_temp3", + "battery3_temp4", + "battery4_cell1", + "battery4_cell2", + "battery4_cell3", + "battery4_cell4", + "battery4_cell5", + "battery4_cell6", + "battery4_cell7", + "battery4_cell8", + "battery4_cell9", + "battery4_cell10", + "battery4_cell11", + "battery4_cell12", + "battery4_total_voltage", + "battery4_temp1", + "battery4_temp2", + "battery4_temp3", + "battery4_temp4", + "battery5_cell1", + "battery5_cell2", + "battery5_cell3", + "battery5_cell4", + "battery5_cell5", + "battery5_cell6", + "battery5_cell7", + "battery5_cell8", + "battery5_cell9", + "battery5_cell10", + "battery5_cell11", + "battery5_cell12", + "battery5_total_voltage", + "battery5_temp1", + "battery5_temp2", + "battery5_temp3", + "battery5_temp4", + "battery6_cell1", + "battery6_cell2", + "battery6_cell3", + "battery6_cell4", + "battery6_cell5", + "battery6_cell6", + "battery6_cell7", + "battery6_cell8", + "battery6_cell9", + "battery6_cell10", + "battery6_cell11", + "battery6_cell12", + "battery6_total_voltage", + "battery6_temp1", + "battery6_temp2", + "battery6_temp3", + "battery6_temp4", + "battery7_cell1", + "battery7_cell2", + "battery7_cell3", + "battery7_cell4", + "battery7_cell5", + "battery7_cell6", + "battery7_cell7", + "battery7_cell8", + "battery7_cell9", + "battery7_cell10", + "battery7_cell11", + "battery7_cell12", + "battery7_total_voltage", + "battery7_temp1", + "battery7_temp2", + "battery7_temp3", + "battery7_temp4", + "battery8_cell1", + "battery8_cell2", + "battery8_cell3", + "battery8_cell4", + "battery8_cell5", + "battery8_cell6", + "battery8_cell7", + "battery8_cell8", + "battery8_cell9", + "battery8_cell10", + "battery8_cell11", + "battery8_cell12", + "battery8_total_voltage", + "battery8_temp1", + "battery8_temp2", + "battery8_temp3", + "battery8_temp4" + ], + "id": 2164, + "period": 50, + "period_type": "ms", + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "IMD", + "variables": [ + "imd_status", + "imd_resistance", + "imd_is_ok", + "imd_duty", + "imd_freq" + ], + "id": 2165, + "period": 50, + "period_type": "ms", + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Contactor Status", + "variables": [ + "contactor_discharge", + "contactor_precharge", + "contactor_low", + "contactor_high", + "contactor_common_high" + ], + "id": 2166, + "period": 50, + "period_type": "ms", + "socket": "control_station_udp" + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/HVBMS/sockets.json b/backend/crates/core/src/adj/test/adj/boards/HVBMS/sockets.json new file mode 100644 index 000000000..6c6e6b86f --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/HVBMS/sockets.json @@ -0,0 +1,13 @@ +[ + { + "type": "ServerSocket", + "name": "control_station_tcp", + "port": 50500 + }, + { + "type": "DatagramSocket", + "name": "control_station_udp", + "remote_ip": "192.168.0.9", + "port": 50400 + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/LCU/LCU.json b/backend/crates/core/src/adj/test/adj/boards/LCU/LCU.json new file mode 100644 index 000000000..2617f5ce6 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/LCU/LCU.json @@ -0,0 +1,15 @@ +{ + "board_id": 4, + "mac": "0:0:0:0:0:0", + "board_ip": "192.168.1.4", + "measurements": [ + "LCU_measurements.json" + ], + "packets": [ + "packets.json", + "orders.json" + ], + "sockets": [ + "sockets.json" + ] +} diff --git a/backend/crates/core/src/adj/test/adj/boards/LCU/LCU_measurements.json b/backend/crates/core/src/adj/test/adj/boards/LCU/LCU_measurements.json new file mode 100644 index 000000000..6e1ca1ec5 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/LCU/LCU_measurements.json @@ -0,0 +1,752 @@ +[ + { + "id": 819, + "alias": "master_state_machine", + "name": "Master SM", + "type": "enum", + "enumValues": [ + "Connecting", + "Idle", + "Levitating", + "Current Control", + "Debug", + "Fault" + ] + }, + { + "id": 820, + "alias": "slave_state_machine", + "name": "Slave SM", + "type": "enum", + "enumValues": [ + "SPI Connecting", + "Idle", + "Levitating", + "Current Control", + "Debug", + "Fault" + ] + }, + { + "id": 821, + "alias": "desired_current", + "name": "Desired Current", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 822, + "alias": "fixed_vbat", + "name": "Fixed VBAT", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 823, + "alias": "desired_distance", + "name": "Desired Distance", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 824, + "alias": "lpu_id", + "name": "LPU ID", + "type": "uint32" + }, + { + "id": 825, + "alias": "fixed_pwm_duty_cycle", + "name": "Fixed PWM Duty Cycle", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 826, + "alias": "pwm_duty_cycle_1", + "name": "Duty Cycle 1", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 827, + "alias": "pwm_duty_cycle_2", + "name": "Duty Cycle 2", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 828, + "alias": "pwm_duty_cycle_3", + "name": "Duty Cycle 3", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 829, + "alias": "pwm_duty_cycle_4", + "name": "Duty Cycle 4", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 830, + "alias": "pwm_duty_cycle_5", + "name": "Duty Cycle 5", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 831, + "alias": "pwm_duty_cycle_6", + "name": "Duty Cycle 6", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 832, + "alias": "pwm_duty_cycle_7", + "name": "Duty Cycle 7", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 833, + "alias": "pwm_duty_cycle_8", + "name": "Duty Cycle 8", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 834, + "alias": "pwm_duty_cycle_9", + "name": "Duty Cycle 9", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 835, + "alias": "pwm_duty_cycle_10", + "name": "Duty Cycle 10", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 836, + "alias": "coil_current_1", + "name": "Coil Current 1", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 837, + "alias": "coil_current_2", + "name": "Coil Current 2", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 838, + "alias": "coil_current_3", + "name": "Coil Current 3", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 839, + "alias": "coil_current_4", + "name": "Coil Current 4", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 840, + "alias": "coil_current_5", + "name": "Coil Current 5", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 841, + "alias": "coil_current_6", + "name": "Coil Current 6", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 842, + "alias": "coil_current_7", + "name": "Coil Current 7", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 843, + "alias": "coil_current_8", + "name": "Coil Current 8", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 844, + "alias": "coil_current_9", + "name": "Coil Current 9", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 845, + "alias": "coil_current_10", + "name": "Coil Current 10", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 846, + "alias": "airgap_1", + "name": "Airgap 1", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 847, + "alias": "airgap_2", + "name": "Airgap 2", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 848, + "alias": "airgap_3", + "name": "Airgap 3", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 849, + "alias": "airgap_4", + "name": "Airgap 4", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 850, + "alias": "airgap_5", + "name": "Airgap 5", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 851, + "alias": "airgap_6", + "name": "Airgap 6", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 852, + "alias": "airgap_7", + "name": "Airgap 7", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 853, + "alias": "airgap_8", + "name": "Airgap 8", + "type": "float32", + "displayUnits": "mm" + }, + { + "id": 854, + "alias": "cinema_current", + "name": "Cinema Current", + "type": "float32" + }, + { + "id": 855, + "alias": "ctrl_voltage_1", + "name": "Control Voltage 1", + "type": "float32" + }, + { + "id": 856, + "alias": "ctrl_voltage_2", + "name": "Control Voltage 2", + "type": "float32" + }, + { + "id": 857, + "alias": "ctrl_voltage_3", + "name": "Control Voltage 3", + "type": "float32" + }, + { + "id": 858, + "alias": "ctrl_voltage_4", + "name": "Control Voltage 4", + "type": "float32" + }, + { + "id": 859, + "alias": "ctrl_voltage_5", + "name": "Control Voltage 5", + "type": "float32" + }, + { + "id": 860, + "alias": "ctrl_voltage_6", + "name": "Control Voltage 6", + "type": "float32" + }, + { + "id": 861, + "alias": "ctrl_voltage_7", + "name": "Control Voltage 7", + "type": "float32" + }, + { + "id": 862, + "alias": "ctrl_voltage_8", + "name": "Control Voltage 8", + "type": "float32" + }, + { + "id": 863, + "alias": "ctrl_voltage_9", + "name": "Control Voltage 9", + "type": "float32" + }, + { + "id": 864, + "alias": "ctrl_voltage_10", + "name": "Control Voltage 10", + "type": "float32" + }, + { + "id": 865, + "alias": "ctrl_gap_local_1", + "name": "Control Gap Local 1", + "type": "float32" + }, + { + "id": 866, + "alias": "ctrl_gap_local_2", + "name": "Control Gap Local 2", + "type": "float32" + }, + { + "id": 867, + "alias": "ctrl_gap_local_3", + "name": "Control Gap Local 3", + "type": "float32" + }, + { + "id": 868, + "alias": "ctrl_gap_local_4", + "name": "Control Gap Local 4", + "type": "float32" + }, + { + "id": 869, + "alias": "ctrl_state_1", + "name": "Control State 1", + "type": "float32" + }, + { + "id": 870, + "alias": "ctrl_state_2", + "name": "Control State 2", + "type": "float32" + }, + { + "id": 871, + "alias": "ctrl_state_3", + "name": "Control State 3", + "type": "float32" + }, + { + "id": 872, + "alias": "ctrl_state_4", + "name": "Control State 4", + "type": "float32" + }, + { + "id": 873, + "alias": "ctrl_state_5", + "name": "Control State 5", + "type": "float32" + }, + { + "id": 874, + "alias": "ctrl_current_ref_1", + "name": "Control Current Ref 1", + "type": "float32" + }, + { + "id": 875, + "alias": "ctrl_current_ref_2", + "name": "Control Current Ref 2", + "type": "float32" + }, + { + "id": 876, + "alias": "ctrl_current_ref_3", + "name": "Control Current Ref 3", + "type": "float32" + }, + { + "id": 877, + "alias": "ctrl_current_ref_4", + "name": "Control Current Ref 4", + "type": "float32" + }, + { + "id": 878, + "alias": "ctrl_current_ref_5", + "name": "Control Current Ref 5", + "type": "float32" + }, + { + "id": 879, + "alias": "ctrl_current_ref_6", + "name": "Control Current Ref 6", + "type": "float32" + }, + { + "id": 880, + "alias": "ctrl_current_ref_7", + "name": "Control Current Ref 7", + "type": "float32" + }, + { + "id": 881, + "alias": "ctrl_current_ref_8", + "name": "Control Current Ref 8", + "type": "float32" + }, + { + "id": 882, + "alias": "ctrl_current_ref_9", + "name": "Control Current Ref 9", + "type": "float32" + }, + { + "id": 883, + "alias": "ctrl_current_ref_10", + "name": "Control Current Ref 10", + "type": "float32" + }, + { + "id": 884, + "alias": "ctrl_fe_1", + "name": "Control Fe 1", + "type": "float32" + }, + { + "id": 885, + "alias": "ctrl_fe_2", + "name": "Control Fe 2", + "type": "float32" + }, + { + "id": 886, + "alias": "ctrl_fe_3", + "name": "Control Fe 3", + "type": "float32" + }, + { + "id": 887, + "alias": "ctrl_fa_1", + "name": "Control Fa 1", + "type": "float32" + }, + { + "id": 888, + "alias": "ctrl_fa_2", + "name": "Control Fa 2", + "type": "float32" + }, + { + "id": 889, + "alias": "ctrl_fa_3", + "name": "Control Fa 3", + "type": "float32" + }, + { + "id": 890, + "alias": "ctrl_fa_4", + "name": "Control Fa 4", + "type": "float32" + }, + { + "id": 891, + "alias": "ctrl_ef_1", + "name": "Control Ef 1", + "type": "float32" + }, + { + "id": 892, + "alias": "ctrl_ef_2", + "name": "Control Ef 2", + "type": "float32" + }, + { + "id": 893, + "alias": "ctrl_ef_3", + "name": "Control Ef 3", + "type": "float32" + }, + { + "id": 894, + "alias": "ctrl_p_1", + "name": "Control P 1", + "type": "float32" + }, + { + "id": 895, + "alias": "ctrl_p_2", + "name": "Control P 2", + "type": "float32" + }, + { + "id": 896, + "alias": "ctrl_p_3", + "name": "Control P 3", + "type": "float32" + }, + { + "id": 897, + "alias": "ctrl_r_1", + "name": "Control R 1", + "type": "float32" + }, + { + "id": 898, + "alias": "ctrl_r_2", + "name": "Control R 2", + "type": "float32" + }, + { + "id": 899, + "alias": "ctrl_r_3", + "name": "Control R 3", + "type": "float32" + }, + { + "id": 900, + "alias": "ctrl_zz_1", + "name": "Control Zz 1", + "type": "float32" + }, + { + "id": 901, + "alias": "ctrl_zz_2", + "name": "Control Zz 2", + "type": "float32" + }, + { + "id": 902, + "alias": "ctrl_zz_3", + "name": "Control Zz 3", + "type": "float32" + }, + { + "id": 903, + "alias": "ctrl_fe_l_1", + "name": "Control Fe L 1", + "type": "float32" + }, + { + "id": 904, + "alias": "ctrl_fe_l_2", + "name": "Control Fe L 2", + "type": "float32" + }, + { + "id": 905, + "alias": "ctrl_fe_l_3", + "name": "Control Fe L 3", + "type": "float32" + }, + { + "id": 906, + "alias": "ctrl_referencia", + "name": "Control Referencia", + "type": "float32" + }, + { + "id": 907, + "alias": "ctrl_i_hems_out_1", + "name": "Control I HEMS Out 1", + "type": "float32" + }, + { + "id": 908, + "alias": "ctrl_i_hems_out_2", + "name": "Control I HEMS Out 2", + "type": "float32" + }, + { + "id": 909, + "alias": "ctrl_i_hems_out_3", + "name": "Control I HEMS Out 3", + "type": "float32" + }, + { + "id": 910, + "alias": "ctrl_i_hems_out_4", + "name": "Control I HEMS Out 4", + "type": "float32" + }, + { + "id": 911, + "alias": "ctrl_a_1", + "name": "Control A 1", + "type": "float32" + }, + { + "id": 912, + "alias": "ctrl_a_2", + "name": "Control A 2", + "type": "float32" + }, + { + "id": 913, + "alias": "ctrl_a_3", + "name": "Control A 3", + "type": "float32" + }, + { + "id": 914, + "alias": "ctrl_a_4", + "name": "Control A 4", + "type": "float32" + }, + { + "id": 915, + "alias": "ctrl_a_5", + "name": "Control A 5", + "type": "float32" + }, + { + "id": 916, + "alias": "ctrl_a_6", + "name": "Control A 6", + "type": "float32" + }, + { + "id": 917, + "alias": "ctrl_a_7", + "name": "Control A 7", + "type": "float32" + }, + { + "id": 918, + "alias": "ctrl_a_8", + "name": "Control A 8", + "type": "float32" + }, + { + "id": 919, + "alias": "ctrl_ak_1", + "name": "Control Ak 1", + "type": "float32" + }, + { + "id": 920, + "alias": "ctrl_ak_2", + "name": "Control Ak 2", + "type": "float32" + }, + { + "id": 921, + "alias": "ctrl_ak_3", + "name": "Control Ak 3", + "type": "float32" + }, + { + "id": 922, + "alias": "ctrl_ak_4", + "name": "Control Ak 4", + "type": "float32" + }, + { + "id": 923, + "alias": "ctrl_bk_1", + "name": "Control Bk 1", + "type": "float32" + }, + { + "id": 924, + "alias": "ctrl_bk_2", + "name": "Control Bk 2", + "type": "float32" + }, + { + "id": 925, + "alias": "ctrl_bk_3", + "name": "Control Bk 3", + "type": "float32" + }, + { + "id": 926, + "alias": "ctrl_pi_hems_1", + "name": "Control PI HEMS 1", + "type": "float32" + }, + { + "id": 927, + "alias": "ctrl_pi_hems_2", + "name": "Control PI HEMS 2", + "type": "float32" + }, + { + "id": 928, + "alias": "ctrl_pi_hems_3", + "name": "Control PI HEMS 3", + "type": "float32" + }, + { + "id": 929, + "alias": "ctrl_pi_hems_4", + "name": "Control PI HEMS 4", + "type": "float32" + }, + { + "id": 930, + "alias": "ctrl_pi_ems_1", + "name": "Control PI EMS 1", + "type": "float32" + }, + { + "id": 931, + "alias": "ctrl_pi_ems_2", + "name": "Control PI EMS 2", + "type": "float32" + }, + { + "id": 932, + "alias": "ctrl_pi_ems_3", + "name": "Control PI EMS 3", + "type": "float32" + }, + { + "id": 933, + "alias": "ctrl_pi_ems_4", + "name": "Control PI EMS 4", + "type": "float32" + }, + { + "id": 934, + "alias": "ctrl_pi_ems_5", + "name": "Control PI EMS 5", + "type": "float32" + }, + { + "id": 935, + "alias": "ctrl_pi_ems_6", + "name": "Control PI EMS 6", + "type": "float32" + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/LCU/orders.json b/backend/crates/core/src/adj/test/adj/boards/LCU/orders.json new file mode 100644 index 000000000..ad42d50c9 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/LCU/orders.json @@ -0,0 +1,142 @@ +[ + { + "type": "order", + "name": "FAULT", + "variables": [], + "id": 800 + }, + { + "type": "order", + "name": "Stop", + "variables": [], + "id": 801 + }, + { + "type": "order", + "name": "Set Fixed VBAT", + "variables": [ + "fixed_vbat" + ], + "id": 802 + }, + { + "type": "order", + "name": "Unset Fixed VBAT", + "variables": [], + "id": 803 + }, + { + "type": "order", + "name": "Levitate", + "variables": [ + "desired_distance" + ], + "id": 804 + }, + { + "type": "order", + "name": "Levitate Ramp", + "variables": [ + "desired_distance" + ], + "id": 805 + }, + { + "type": "order", + "name": "Set Desired Distance", + "variables": [ + "desired_distance" + ], + "id": 806 + }, + { + "type": "order", + "name": "Set Desired Distance Ramp", + "variables": [ + "desired_distance" + ], + "id": 807 + }, + { + "type": "order", + "name": "Stop Ramp", + "variables": [], + "id": 808 + }, + { + "type": "order", + "name": "Current Control", + "variables": [ + "lpu_id", + "desired_current" + ], + "id": 809 + }, + { + "type": "order", + "name": "All Current Control", + "variables": [ + "desired_current" + ], + "id": 810 + }, + { + "type": "order", + "name": "Stop Current Control", + "variables": [ + "lpu_id" + ], + "id": 811 + }, + { + "type": "order", + "name": "PWM", + "variables": [ + "lpu_id", + "fixed_pwm_duty_cycle" + ], + "id": 812 + }, + { + "type": "order", + "name": "All PWM", + "variables": [ + "fixed_pwm_duty_cycle" + ], + "id": 813 + }, + { + "type": "order", + "name": "Stop PWM", + "variables": [ + "lpu_id" + ], + "id": 814 + }, + { + "type": "order", + "name": "Reset All", + "variables": [], + "id": 815 + }, + { + "type": "order", + "name": "Reset Slave", + "variables": [], + "id": 816 + }, + { + "type": "order", + "name": "Cinema", + "variables": [ + "cinema_current" + ], + "id": 817 + }, + { + "type": "order", + "name": "Stop Cinema", + "variables": [], + "id": 818 + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/LCU/packets.json b/backend/crates/core/src/adj/test/adj/boards/LCU/packets.json new file mode 100644 index 000000000..6cfaf8900 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/LCU/packets.json @@ -0,0 +1,163 @@ +[ + { + "id": 936, + "type": "data", + "name": "LPU PWM Duties", + "variables": [ + "pwm_duty_cycle_1", + "pwm_duty_cycle_2", + "pwm_duty_cycle_3", + "pwm_duty_cycle_4", + "pwm_duty_cycle_5", + "pwm_duty_cycle_6", + "pwm_duty_cycle_7", + "pwm_duty_cycle_8", + "pwm_duty_cycle_9", + "pwm_duty_cycle_10" + ], + "period_type": "ms", + "period": 10.0, + "socket": "control_station_udp" + }, + { + "id": 937, + "type": "data", + "name": "LPU Coil Currents", + "variables": [ + "coil_current_1", + "coil_current_2", + "coil_current_3", + "coil_current_4", + "coil_current_5", + "coil_current_6", + "coil_current_7", + "coil_current_8", + "coil_current_9", + "coil_current_10" + ], + "period_type": "ms", + "period": 10.0, + "socket": "control_station_udp" + }, + { + "id": 938, + "type": "data", + "name": "Airgaps", + "variables": [ + "airgap_1", + "airgap_2", + "airgap_3", + "airgap_4", + "airgap_5", + "airgap_6", + "airgap_7", + "airgap_8" + ], + "period_type": "ms", + "period": 10.0, + "socket": "control_station_udp" + }, + { + "id": 939, + "type": "data", + "name": "State Machine", + "variables": [ + "master_state_machine", + "slave_state_machine" + ], + "period_type": "ms", + "period": 10.0, + "socket": "control_station_udp" + }, + { + "id": 940, + "type": "data", + "name": "General State", + "variables": [ + "ctrl_voltage_1", + "ctrl_voltage_2", + "ctrl_voltage_3", + "ctrl_voltage_4", + "ctrl_voltage_5", + "ctrl_voltage_6", + "ctrl_voltage_7", + "ctrl_voltage_8", + "ctrl_voltage_9", + "ctrl_voltage_10", + "ctrl_gap_local_1", + "ctrl_gap_local_2", + "ctrl_gap_local_3", + "ctrl_gap_local_4", + "ctrl_state_1", + "ctrl_state_2", + "ctrl_state_3", + "ctrl_state_4", + "ctrl_state_5", + "ctrl_current_ref_1", + "ctrl_current_ref_2", + "ctrl_current_ref_3", + "ctrl_current_ref_4", + "ctrl_current_ref_5", + "ctrl_current_ref_6", + "ctrl_current_ref_7", + "ctrl_current_ref_8", + "ctrl_current_ref_9", + "ctrl_current_ref_10", + "ctrl_fe_1", + "ctrl_fe_2", + "ctrl_fe_3", + "ctrl_fa_1", + "ctrl_fa_2", + "ctrl_fa_3", + "ctrl_fa_4", + "ctrl_ef_1", + "ctrl_ef_2", + "ctrl_ef_3", + "ctrl_p_1", + "ctrl_p_2", + "ctrl_p_3", + "ctrl_r_1", + "ctrl_r_2", + "ctrl_r_3", + "ctrl_zz_1", + "ctrl_zz_2", + "ctrl_zz_3", + "ctrl_fe_l_1", + "ctrl_fe_l_2", + "ctrl_fe_l_3", + "ctrl_referencia", + "ctrl_i_hems_out_1", + "ctrl_i_hems_out_2", + "ctrl_i_hems_out_3", + "ctrl_i_hems_out_4", + "ctrl_a_1", + "ctrl_a_2", + "ctrl_a_3", + "ctrl_a_4", + "ctrl_a_5", + "ctrl_a_6", + "ctrl_a_7", + "ctrl_a_8", + "ctrl_ak_1", + "ctrl_ak_2", + "ctrl_ak_3", + "ctrl_ak_4", + "ctrl_bk_1", + "ctrl_bk_2", + "ctrl_bk_3", + "ctrl_pi_hems_1", + "ctrl_pi_hems_2", + "ctrl_pi_hems_3", + "ctrl_pi_hems_4", + "ctrl_pi_ems_1", + "ctrl_pi_ems_2", + "ctrl_pi_ems_3", + "ctrl_pi_ems_4", + "ctrl_pi_ems_5", + "ctrl_pi_ems_6" + ], + "period_type": "ms", + "period": 10.0, + "socket": "control_station_udp" + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/LCU/sockets.json b/backend/crates/core/src/adj/test/adj/boards/LCU/sockets.json new file mode 100644 index 000000000..6c6e6b86f --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/LCU/sockets.json @@ -0,0 +1,13 @@ +[ + { + "type": "ServerSocket", + "name": "control_station_tcp", + "port": 50500 + }, + { + "type": "DatagramSocket", + "name": "control_station_udp", + "remote_ip": "192.168.0.9", + "port": 50400 + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/PCU/PCU.json b/backend/crates/core/src/adj/test/adj/boards/PCU/PCU.json new file mode 100644 index 000000000..ffacc86ef --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/PCU/PCU.json @@ -0,0 +1,15 @@ +{ + "board_id": 5, + "mac": "0:0:0:0:0:0", + "board_ip": "192.168.1.5", + "measurements": [ + "PCU_measurements.json" + ], + "packets": [ + "packets.json", + "orders.json" + ], + "sockets": [ + "sockets.json" + ] +} \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/PCU/PCU_measurements.json b/backend/crates/core/src/adj/test/adj/boards/PCU/PCU_measurements.json new file mode 100644 index 000000000..cd68d8b95 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/PCU/PCU_measurements.json @@ -0,0 +1,304 @@ +[ + { + "id": 559, + "alias": "frequency", + "name": "Frequency Commutation hz", + "type": "uint32", + "displayUnits": "Hz" + }, + { + "id": 560, + "alias": "modulation_frequency", + "name": "Modulation Frequency", + "type": "float32", + "displayUnits": "Hz" + }, + { + "id": 561, + "alias": "duty_u", + "name": "Duty U", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 562, + "alias": "duty_v", + "name": "Duty V", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 563, + "alias": "duty_w", + "name": "Duty W", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 564, + "alias": "voltage_battery_a", + "name": "Voltage Battery A", + "type": "float32" + }, + { + "id": 565, + "alias": "voltage_battery_b", + "name": "Voltage Battery B", + "type": "float32" + }, + { + "id": 566, + "alias": "v_ref", + "name": "Reference Voltage", + "type": "float32" + }, + { + "id": 567, + "alias": "frequency_to_send_svpwm", + "name": "Frequency Modulation hz", + "type": "float32", + "displayUnits": "Hz" + }, + { + "id": 568, + "alias": "frequency_to_send_pwm", + "name": "Frequency Commutation hz", + "type": "float32", + "displayUnits": "Hz" + }, + { + "id": 569, + "alias": "current_sensor_u_a", + "name": "Current Sensor U Connector A", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 570, + "alias": "current_sensor_u_b", + "name": "Current Sensor U Connector B", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 571, + "alias": "current_sensor_v_a", + "name": "Current Sensor V Connector A", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 572, + "alias": "current_sensor_v_b", + "name": "Current Sensor V Connector B", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 573, + "alias": "current_sensor_w_a", + "name": "Current Sensor W Connector A", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 574, + "alias": "current_sensor_w_b", + "name": "Current Sensor W Connector B", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 575, + "alias": "state", + "name": "State", + "type": "enum", + "enumValues": [ + "Connecting", + "Idle", + "Accelerating", + "Fault" + ] + }, + { + "id": 576, + "alias": "current_ref", + "name": "Current Ref", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 577, + "alias": "freq_to_send_svpwm", + "name": "Frequency Modulation hz", + "type": "float32", + "displayUnits": "Hz" + }, + { + "id": 578, + "alias": "freq_to_send_pwm", + "name": "Frequency Commutation hz", + "type": "float32", + "displayUnits": "Hz" + }, + { + "id": 579, + "alias": "current_Peak", + "name": "Max Current Peak", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 580, + "alias": "error_pi", + "name": "Actual Current Error", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 581, + "alias": "vf_control", + "name": "Variable frecuency control", + "type": "bool" + }, + { + "id": 582, + "alias": "slip_motor", + "name": "Slip Motor", + "type": "float32", + "displayUnits": "%" + }, + { + "id": 583, + "alias": "imu_speed_km_h", + "name": "Speed IMU", + "type": "float64", + "displayUnits": "km/h" + }, + { + "id": 584, + "alias": "imu_position_m", + "name": "IMU Position", + "type": "float32", + "displayUnits": "m" + }, + { + "id": 585, + "alias": "target_voltage", + "name": "Target Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 586, + "alias": "vmax", + "name": "Max Voltage", + "type": "float32", + "displayUnits": "V" + }, + { + "id": 587, + "alias": "speed_ref", + "name": "Reference Speed", + "type": "float32", + "displayUnits": "km/h" + }, + { + "id": 588, + "alias": "svpwm_time", + "name": "SVPWM Time", + "type": "float32", + "displayUnits": "s" + }, + { + "id": 589, + "alias": "target_speed", + "name": "Target Speed KM/H", + "type": "float32", + "displayUnits": "km/h" + }, + { + "id": 590, + "alias": "speed_error", + "name": "Speed Error", + "type": "float64", + "displayUnits": "km/h" + }, + { + "id": 591, + "alias": "actual_current_ref", + "name": "Control Current ref", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 592, + "alias": "imod", + "name": "Modulation Index", + "type": "float32" + }, + { + "id": 593, + "alias": "gd_fault_a", + "name": "GateDriver A Fault", + "type": "bool", + "displayUnits": "", + "protections": [ + { + "type": "Equal", + "value": [ + 1 + ], + "fault": true + } + ] + }, + { + "id": 594, + "alias": "gd_fault_b", + "name": "GateDriver B Fault", + "type": "bool", + "displayUnits": "", + "protections": [ + { + "type": "Equal", + "value": [ + 1 + ], + "fault": true + } + ] + }, + { + "id": 595, + "alias": "gd_ready_a", + "name": "GateDriver A Ready", + "type": "bool", + "displayUnits": "", + "protections": [ + { + "type": "Equal", + "value": [ + 1 + ], + "fault": true + } + ] + }, + { + "id": 596, + "alias": "gd_ready_b", + "name": "GateDriver B Ready", + "type": "bool", + "displayUnits": "", + "protections": [ + { + "type": "Equal", + "value": [ + 1 + ], + "fault": true + } + ] + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/PCU/orders.json b/backend/crates/core/src/adj/test/adj/boards/PCU/orders.json new file mode 100644 index 000000000..180437e93 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/PCU/orders.json @@ -0,0 +1,53 @@ +[ + { + "type": "order", + "name": "FAULT", + "variables": [], + "id": 512 + }, + { + "type": "order", + "name": "Start SVPWM", + "variables": [ + "frequency_to_send_svpwm", + "frequency_to_send_pwm", + "v_ref", + "vmax" + ], + "id": 513 + }, + { + "type": "order", + "name": "Stop Motor", + "variables": [], + "id": 514 + }, + { + "type": "order", + "name": "Send Reference Current", + "variables": [ + "freq_to_send_svpwm", + "freq_to_send_pwm", + "current_ref", + "vmax", + "vf_control" + ], + "id": 515 + }, + { + "type": "order", + "name": "Zeroing", + "variables": [], + "id": 516 + }, + { + "type": "order", + "name": "Send Reference Speed", + "variables": [ + "speed_ref", + "freq_to_send_pwm", + "vmax" + ], + "id": 517 + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/PCU/packets.json b/backend/crates/core/src/adj/test/adj/boards/PCU/packets.json new file mode 100644 index 000000000..64a4254e3 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/PCU/packets.json @@ -0,0 +1,91 @@ +[ + { + "type": "data", + "name": "PWM", + "variables": [ + "frequency", + "modulation_frequency", + "duty_u", + "duty_v", + "duty_w" + ], + "id": 550, + "period_type": "ms", + "period": 16.67, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Batteries Voltage", + "variables": [ + "voltage_battery_a", + "voltage_battery_b" + ], + "id": 551, + "period_type": "ms", + "period": 16.67, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Current Sensors", + "variables": [ + "current_sensor_u_a", + "current_sensor_v_a", + "current_sensor_w_a", + "current_sensor_u_b", + "current_sensor_v_b", + "current_sensor_w_b", + "current_Peak", + "error_pi", + "target_voltage", + "svpwm_time", + "imod" + ], + "id": 552, + "period_type": "ms", + "period": 16.67, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "State Machine States", + "variables": [ + "state" + ], + "id": 553, + "period_type": "ms", + "period": 16.67, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Speed Data", + "variables": [ + "target_speed", + "speed_error", + "actual_current_ref", + "slip_motor", + "imu_speed_km_h", + "imu_position_m" + ], + "id": 555, + "period_type": "ms", + "period": 16.67, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Gate Driver Reporting", + "variables": [ + "gd_fault_a", + "gd_fault_b", + "gd_ready_a", + "gd_ready_b" + ], + "id": 558, + "period_type": "ms", + "period": 16.67, + "socket": "control_station_udp" + } +] \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/PCU/sockets.json b/backend/crates/core/src/adj/test/adj/boards/PCU/sockets.json new file mode 100644 index 000000000..6c6e6b86f --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/PCU/sockets.json @@ -0,0 +1,13 @@ +[ + { + "type": "ServerSocket", + "name": "control_station_tcp", + "port": 50500 + }, + { + "type": "DatagramSocket", + "name": "control_station_udp", + "remote_ip": "192.168.0.9", + "port": 50400 + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/VCU/VCU.json b/backend/crates/core/src/adj/test/adj/boards/VCU/VCU.json new file mode 100644 index 000000000..7203dedeb --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/VCU/VCU.json @@ -0,0 +1,16 @@ +{ + "board_id": 3, + "mac": "0:0:0:0:0:0", + "board_ip": "192.168.1.3", + "measurements": [ + "VCU_measurements.json" + ], + "packets": [ + "orders.json", + "packets.json" + ], + "sockets":[ + "sockets.json" + ] + +} \ No newline at end of file diff --git a/backend/crates/core/src/adj/test/adj/boards/VCU/VCU_measurements.json b/backend/crates/core/src/adj/test/adj/boards/VCU/VCU_measurements.json new file mode 100644 index 000000000..d80dbeea9 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/VCU/VCU_measurements.json @@ -0,0 +1,95 @@ +[ + { + "id": 613, + "alias": "state", + "name": "State", + "type": "enum", + "enumValues": [ + "Idle", + "Connected", + "Maintenance", + "Precharging", + "HVActive", + "Ready", + "Propulsion", + "Static Levitation", + "Dynamic Levitation", + "Fault" + ] + }, + { + "id": 614, + "alias": "sdc_closed", + "name": "SDC Closed", + "type": "bool" + }, + { + "id": 615, + "alias": "high_pressure", + "name": "High Pressure", + "type": "float32", + "displayUnits": "bar" + }, + { + "id": 616, + "alias": "low_pressure", + "name": "Low Pressure", + "type": "float32", + "displayUnits": "bar" + }, + { + "id": 617, + "alias": "pressure_regulator_feedback", + "name": "Pressure Regulator Feedback", + "type": "float32", + "displayUnits": "bar" + }, + { + "id": 618, + "alias": "brakes_status", + "name": "Brakes Status", + "type": "enum", + "enumValues": [ + "BRAKED", + "UNBRAKED" + ] + }, + { + "id": 619, + "alias": "electrovalve_enabled", + "name": "Electrovalve Enabled", + "type": "bool" + }, + { + "id": 620, + "alias": "hvbms_connected", + "name": "HVBMS Connected", + "type": "bool" + }, + { + "id": 621, + "alias": "pcu_connected", + "name": "PCU Connected", + "type": "bool" + }, + { + "id": 622, + "alias": "lcu_connected", + "name": "LCU Connected", + "type": "bool" + }, + { + "id": 623, + "alias": "propulsion_current_reference", + "name": "Propulsion Current Reference", + "type": "float32", + "displayUnits": "A" + }, + { + "id": 624, + "alias": "levitation_target_height", + "name": "Levitation Target Height", + "type": "float32", + "displayUnits": "mm" + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/VCU/orders.json b/backend/crates/core/src/adj/test/adj/boards/VCU/orders.json new file mode 100644 index 000000000..338eb3cc8 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/VCU/orders.json @@ -0,0 +1,87 @@ +[ + { + "id": 600, + "name": "FAULT", + "type": "order", + "variables": [] + }, + { + "id": 601, + "name": "Stop", + "type": "order", + "variables": [] + }, + { + "id": 602, + "name": "Maintenance", + "type": "order", + "variables": [] + }, + { + "id": 603, + "name": "Precharge", + "type": "order", + "variables": [] + }, + { + "id": 604, + "name": "Open Contactors", + "type": "order", + "variables": [] + }, + { + "id": 605, + "name": "Unbrake", + "type": "order", + "variables": [] + }, + { + "id": 606, + "name": "Brake", + "type": "order", + "variables": [] + }, + { + "id": 607, + "name": "Static Levitation", + "type": "order", + "variables": [] + }, + { + "id": 608, + "name": "Propulsion", + "type": "order", + "variables": [] + }, + { + "id": 609, + "name": "Dynamic Levitation", + "type": "order", + "variables": [] + }, + { + "id": 610, + "name": "Propulsion Parameterized", + "type": "order", + "variables": [ + "propulsion_current_reference" + ] + }, + { + "id": 611, + "name": "Static Levitation Parameterized", + "type": "order", + "variables": [ + "levitation_target_height" + ] + }, + { + "id": 612, + "name": "Dynamic Levitation Parameterized", + "type": "order", + "variables": [ + "propulsion_current_reference", + "levitation_target_height" + ] + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/VCU/packets.json b/backend/crates/core/src/adj/test/adj/boards/VCU/packets.json new file mode 100644 index 000000000..c270f8762 --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/VCU/packets.json @@ -0,0 +1,62 @@ +[ + { + "type": "data", + "name": "VCU State", + "variables": [ + "state" + ], + "id": 625, + "period_type": "ms", + "period": 10, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Pressures", + "variables": [ + "high_pressure", + "low_pressure", + "pressure_regulator_feedback" + ], + "id": 626, + "period_type": "ms", + "period": 10, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Brake Status", + "variables": [ + "brakes_status" + ], + "id": 627, + "period_type": "ms", + "period": 10, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Outputs", + "variables": [ + "electrovalve_enabled" + ], + "id": 628, + "period_type": "ms", + "period": 10, + "socket": "control_station_udp" + }, + { + "type": "data", + "name": "Safety", + "variables": [ + "sdc_closed", + "hvbms_connected", + "pcu_connected", + "lcu_connected" + ], + "id": 629, + "period_type": "ms", + "period": 10, + "socket": "control_station_udp" + } +] diff --git a/backend/crates/core/src/adj/test/adj/boards/VCU/sockets.json b/backend/crates/core/src/adj/test/adj/boards/VCU/sockets.json new file mode 100644 index 000000000..20af9231b --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/boards/VCU/sockets.json @@ -0,0 +1,13 @@ +[ + { + "type": "ServerSocket", + "name": "control_station_tcp", + "port": 50500 + }, + { + "type": "DatagramSocket", + "name": "control_station_udp", + "remote_ip":"192.168.0.9", + "port": 50400 + } +] diff --git a/backend/crates/core/src/adj/test/adj/general_info.json b/backend/crates/core/src/adj/test/adj/general_info.json new file mode 100644 index 000000000..c0dfc21ba --- /dev/null +++ b/backend/crates/core/src/adj/test/adj/general_info.json @@ -0,0 +1,61 @@ +{ + "ports": { + "TCP_CLIENT": 50401, + "TCP_SERVER": 50500, + "UDP": 50400, + "SNTP": 123, + "TFTP": 69, + "BLCU_UDP": 50420, + "BLCU_TCP_CLIENT": 50421 + }, + "addresses": { + "backend": "192.168.0.9", + "hypervisor": "192.168.0.13" + }, + "protectionTypes": { + "Equal": { + "range": false, + "text": "Value is equal to {} (measured: %)" + }, + "Range": { + "range": true, + "text": "Value out of range {} (measured: %)" + }, + "Below": { + "range": false, + "text": "Value below {} (measured: %)" + } + }, + "units": { + "m/ss": "*1", + "Hz": "*1", + "MOhm": "*1000000", + "ºC": "+273.15", + "deg": "/57.2957", + "km/h": "*3.6", + "ns": "*1", + "m/s": "*1", + "rad": "*1", + "A": "*1", + "%": "/100", + "m": "*1", + "mrad": "/1000", + "KOhm": "*1000", + "V": "*1", + "mV": "/1000", + "Ohm": "*1", + "mm": "/1000", + "G": "*9.8", + "bar": "*1", + "s": "*1" + }, + "message_ids": { + "state_space": 7, + "fault": 2, + "info": 1, + "blcu_ack": 4, + "remove_state_order": 6, + "add_state_order": 5, + "warning": 3 + } +} diff --git a/backend/crates/core/src/git.rs b/backend/crates/core/src/git.rs new file mode 100644 index 000000000..3418342c0 --- /dev/null +++ b/backend/crates/core/src/git.rs @@ -0,0 +1,11 @@ +//! Blocking Git helpers for ADJ, an application-owned, replaceable data cache. + +mod clone; +mod error; +mod repository; +mod update; + +pub use error::{CloneError, GitError, RepositoryError}; +pub use repository::{branch_exists, list_remote_branches, open_repo}; +pub(crate) use update::unwrap_repo_path; +pub use update::update_adj; diff --git a/backend/crates/core/src/git/README.md b/backend/crates/core/src/git/README.md new file mode 100644 index 000000000..ef4cb55c4 --- /dev/null +++ b/backend/crates/core/src/git/README.md @@ -0,0 +1,82 @@ +# ADJ Git helpers + +This module downloads and updates the local [ADJ repository](https://github.com/Hyperloop-UPV/adj) using [`gix`](https://crates.io/crates/gix), with [`tracing`](https://crates.io/crates/tracing) for logging. It supports branch selection and offline use of an existing local checkout. + +## Workflow + +`update_adj(path, branch)` returns the full hash of the checked-out commit. +A custom path identifies the ADJ repository itself. The default is +`/hyperloop-control-station/adj`, using `dirs::cache_dir()`. +An existing invalid repository or inaccessible path returns an error. + +The existing connectivity check attempts a TCP connection to `1.1.1.1:443` +with a three-second timeout. This checks external TCP connectivity, not GitHub +availability. + +### Online + +Online updates require a non-empty branch. They replace the local checkout and +do not preserve local edits or commits. + +- Shallow-clone the requested branch into a temporary directory beside ADJ. +- Complete checkout and read its commit hash before touching the cache. +- Move the old cache aside and install the new checkout. +- Restore the old cache if installation fails. If restoration also fails, + preserve the backup and include its location in the error. +- Remove the old cache after successful installation. + +A clone error leaves the old cache untouched and is returned directly; it does +not automatically fall back to offline operation. No separate fetch of the +existing cache, merge, or branch switch is needed because the checkout is replaced. + +### Offline + +- If ADJ exists, return its current commit hash without updating or switching branches. +- Otherwise, return `ADJ is not available locally and cannot be downloaded`. + +The cached branch may differ from the requested branch when offline. + +### Empty Branch + +Passing `branch = ""` skips downloading and replacing ADJ, even when online. + +- If a cached repository exists, return its current commit hash without updating + or switching branches, preserving local edits and commits. +- Otherwise, return `GitError::UnavailableOffline`, even if connectivity is available. + +The connectivity probe still runs when the branch is empty. + +## Other Helpers + +- `open_repo` opens the custom or default repository path. +- `list_remote_branches(repo)` queries the default fetch remote and returns sorted short + branch names, without downloading objects or updating local references. It + requires remote access and does not fall back to cached branches on failure. +- `branch_exists(repo, name)` uses that listing to check an exact short branch + name. Query errors are propagated; `false` means a successful query did not + find the branch, not that the remote was unreachable. + +## Limitations + +Replacement is intended for startup, before the backend reads ADJ, with one +updater at a time. The backup and installation renames are not jointly atomic +across a process crash. The connectivity probe can succeed when GitHub is +unreachable, or fail when GitHub is reachable. + +## Errors + +Public helpers return `GitError` with five categories: `Path`, `Repository`, +`Clone`, `Replacement`, and `UnavailableOffline`. `RepositoryError` and +`CloneError` group the concrete `gix` causes inside the corresponding categories. +If rollback fails, `Replacement` also retains the restoration error and backup +path for recovery. + +## Verification + +Tests use temporary local Git repositories and the Git CLI to create fixtures; +they do not require external network access. Production Git operations use `gix`. + +```bash +cargo test -p software-core -F git +cargo doc --open -p software-core -F git --no-deps +``` diff --git a/backend/crates/core/src/git/clone.rs b/backend/crates/core/src/git/clone.rs new file mode 100644 index 000000000..bccc73c9f --- /dev/null +++ b/backend/crates/core/src/git/clone.rs @@ -0,0 +1,222 @@ +use super::{ + error::{CloneError, GitError}, + update::get_commit_hash, +}; +use gix::Repository; +use std::{fs, path::Path, sync::atomic::AtomicBool}; +use tracing::{debug, info, instrument, warn}; + +const GIT_REMOTE: &str = "origin"; + +// Fetch and check out the requested branch instead of switching an existing repo. +#[instrument(level = "debug", skip(url))] +fn git_clone(path: &Path, branch: &str, url: &str) -> Result { + // These synchronous startup operations do not currently expose cancellation. + let interrupt = AtomicBool::new(false); + + debug!(?path, branch, "preparing shallow ADJ clone"); + // A depth of one keeps the current snapshot without downloading full history. + let mut prepare = gix::prepare_clone(url, path) + .map_err(CloneError::from)? + .with_remote_name(GIT_REMOTE) + .map_err(CloneError::from)? + .with_ref_name(Some(branch)) + .map_err(CloneError::from)? + .with_shallow(gix::remote::fetch::Shallow::DepthAtRemote( + std::num::NonZeroU32::MIN, + )); + + let (mut checkout, _) = prepare + .fetch_then_checkout(gix::progress::Discard, &interrupt) + .map_err(CloneError::from)?; + debug!( + ?path, + branch, "ADJ fetch completed; checking out working tree" + ); + let (repo, _) = checkout + .main_worktree(gix::progress::Discard, &interrupt) + .map_err(CloneError::from)?; + + debug!(?path, branch, "ADJ clone and checkout completed"); + Ok(repo) +} + +// Stage beside ADJ so both installation and rollback use same-filesystem renames. +#[instrument(level = "debug", skip(url))] +pub(crate) fn git_replace(path: &Path, branch: &str, url: &str) -> Result { + // A relative path like "adj" has an empty parent; stage in the current directory. + let parent = path + .parent() + .filter(|p| !p.as_os_str().is_empty()) + .unwrap_or(Path::new(".")); + fs::create_dir_all(parent).map_err(GitError::Path)?; + let staging = tempfile::Builder::new() + .prefix(".adj-") + .tempdir_in(parent) + .map_err(GitError::Path)?; + let checkout = staging.path().join("new"); + let backup = staging.path().join("old"); + debug!(?checkout, ?backup, "created ADJ staging directory"); + + // Validate the new checkout and commit before touching the current cache. + // Early errors drop the staging directory, removing any incomplete clone. + let repo = git_clone(&checkout, branch, url)?; + let commit = get_commit_hash(&repo)?; + // The repository contains paths into staging and must not survive the move. + drop(repo); + + let had_cache = path.try_exists().map_err(GitError::Path)?; + if had_cache { + fs::rename(path, &backup).map_err(|source| GitError::Replacement { + source, + rollback: None, + })?; + debug!(?path, ?backup, "moved cached ADJ aside for replacement"); + } + if let Err(error) = fs::rename(&checkout, path) { + debug!(?path, %error, had_cache, "ADJ installation failed; restoring cache if present"); + if had_cache && let Err(rollback) = fs::rename(&backup, path) { + // Do not let temporary-directory cleanup delete the only remaining cache. + let saved = staging.keep(); + debug!(?backup, %rollback, "preserved ADJ backup after failed rollback"); + return Err(GitError::Replacement { + source: error, + rollback: Some((rollback, saved.join("old"))), + }); + } + if had_cache { + debug!(?path, "restored cached ADJ after installation failure"); + } + return Err(GitError::Replacement { + source: error, + rollback: None, + }); + } + + // Installation succeeded; cleanup now discards the old cache. A cleanup + // failure does not turn a successfully installed checkout into an error. + if let Err(error) = staging.close() { + warn!(?path, %error, "ADJ updated, but temporary directory cleanup failed"); + } + info!(?path, branch, commit = %commit, "ADJ updated"); + Ok(commit) +} + +#[cfg(test)] +mod tests { + use super::*; + use std::{io, process::Command}; + + fn git(path: &Path, args: &[&str]) -> Result<(), Box> { + // Fixture commits need identity; disable signing, hooks, and templates + // so tests do not depend on the user's normal Git setup. + let output = Command::new("git") + .current_dir(path) + .args([ + "-c", + "user.name=ADJ tests", + "-c", + "user.email=adj@example.test", + "-c", + "commit.gpgSign=false", + "-c", + "core.hooksPath=", + "-c", + "init.templateDir=", + ]) + .args(args) + .output()?; + if !output.status.success() { + return Err(io::Error::other(String::from_utf8_lossy(&output.stderr)).into()); + } + Ok(()) + } + + fn source_repo(path: &Path) -> Result<(), Box> { + fs::create_dir(path)?; + git(path, &["init", "--initial-branch=main"])?; + fs::write(path.join("data.txt"), "main")?; + git(path, &["add", "."])?; + git(path, &["commit", "-m", "main data"])?; + // Leave HEAD on another branch to verify explicit clone branch selection. + git(path, &["checkout", "-b", "testing"])?; + fs::write(path.join("data.txt"), "testing")?; + git(path, &["commit", "-am", "testing data"]) + } + + // Verify branch selection, newer commits, and removal of stale cache files. + #[test] + fn clones_and_replaces_with_requested_branch() + -> Result<(), Box> { + let temp = tempfile::tempdir()?; + let source = temp.path().join("source"); + let cache = temp.path().join("cache").join("adj"); + source_repo(&source)?; + let url = source.to_str().ok_or("non-UTF-8 test path")?; + + let first = git_replace(&cache, "main", url)?; + let main_hash = gix::open(&source)? + .find_reference("refs/heads/main")? + .id() + .to_string(); + assert_eq!(first, main_hash); + assert_eq!(fs::read_to_string(cache.join("data.txt"))?, "main"); + // Replacement must discard old cache files, not just update tracked ones. + fs::write(cache.join("stale.txt"), "discard this cache file")?; + + // Add a newer remote commit and request a different branch on replacement. + fs::write(source.join("data.txt"), "latest testing")?; + git(&source, &["commit", "-am", "updated testing data"])?; + let expected = get_commit_hash(&gix::open(&source)?)?; + assert_eq!(git_replace(&cache, "testing", url)?, expected); + assert_ne!(first, expected); + assert_eq!(get_commit_hash(&gix::open(&cache)?)?, expected); + assert_eq!( + fs::read_to_string(cache.join("data.txt"))?, + "latest testing" + ); + assert!(!cache.join("stale.txt").exists()); + // Successful replacement must also remove staging and backup directories. + assert_eq!( + fs::read_dir(cache.parent().ok_or("missing parent")?)?.count(), + 1 + ); + Ok(()) + } + + // Verify clone failures preserve cached ADJ and leave no staging debris. + #[test] + fn failed_clone_preserves_existing_cache() + -> Result<(), Box> { + let temp = tempfile::tempdir()?; + let source = temp.path().join("source"); + let cache = temp.path().join("adj"); + source_repo(&source)?; + let url = source.to_str().ok_or("non-UTF-8 test path")?; + + // A failed first clone must not install a partial checkout. + assert!(git_replace(&cache, "missing-branch", url).is_err()); + assert!(!cache.exists()); + let expected = git_replace(&cache, "main", url)?; + fs::write(cache.join("stale.txt"), "keep on failure")?; + // Both an invalid branch and an unavailable source must leave ADJ intact. + assert!(git_replace(&cache, "missing-branch", url).is_err()); + let missing = temp.path().join("missing-source"); + assert!( + git_replace( + &cache, + "main", + missing.to_str().ok_or("non-UTF-8 test path")? + ) + .is_err() + ); + assert_eq!(get_commit_hash(&gix::open(&cache)?)?, expected); + assert_eq!(fs::read_to_string(cache.join("data.txt"))?, "main"); + assert_eq!( + fs::read_to_string(cache.join("stale.txt"))?, + "keep on failure" + ); + assert_eq!(fs::read_dir(temp.path())?.count(), 2); + Ok(()) + } +} diff --git a/backend/crates/core/src/git/error.rs b/backend/crates/core/src/git/error.rs new file mode 100644 index 000000000..ec3c3f69b --- /dev/null +++ b/backend/crates/core/src/git/error.rs @@ -0,0 +1,121 @@ +/// Errors produced while reading, downloading, or replacing the ADJ cache. +/// +/// Five categories identify the failed operation and preserve its underlying +/// error as [`std::error::Error::source`]. [`RepositoryError`] and [`CloneError`] +/// retain concrete `gix` causes and are boxed to keep this enum small. +/// +/// A failed connectivity probe is not itself an error when cached ADJ exists. +/// If no cache exists, the operation returns [`GitError::UnavailableOffline`]. +#[derive(Debug, thiserror::Error)] +pub enum GitError { + /// Resolving, inspecting, or preparing the cache directory failed. + #[error("ADJ path operation failed: {0}")] + Path(#[source] std::io::Error), + + /// Opening the repository, reading HEAD, or querying local or remote refs failed. + /// A branch missing from a successful remote listing is not an error. + #[error("ADJ repository operation failed: {0}")] + Repository(#[source] Box), + + /// Preparing, downloading, or checking out the requested branch failed. + /// + /// This can indicate a network, configuration, or remote-reference failure; + /// it does not necessarily mean that internet connectivity is unavailable. + #[error("ADJ clone failed: {0}")] + Clone(#[source] Box), + + /// Moving the old cache aside or installing the new checkout failed. + /// + /// When restoration also fails, `rollback` holds its error and the preserved + /// backup's location. Otherwise, the old cache was restored or never moved. + #[error( + "ADJ cache replacement failed: {source}{recovery}", + recovery = .rollback.as_ref().map(|(error, path)| { + format!("; rollback failed: {error}; backup kept at {}", path.display()) + }).unwrap_or_default() + )] + Replacement { + /// The original error moving the old cache or installing the new checkout. + #[source] + source: std::io::Error, + /// Restoration error and preserved backup path, if rollback failed. + rollback: Option<(std::io::Error, std::path::PathBuf)>, + }, + + /// The connectivity probe failed and no local ADJ cache was available. + #[error("ADJ is not available locally and cannot be downloaded")] + UnavailableOffline, +} + +// Convert repository errors for '?' propagation, boxing the concrete error to keep GitError small. +impl From for GitError { + fn from(error: RepositoryError) -> Self { + Self::Repository(Box::new(error)) + } +} + +// Convert clone errors for '?' propagation, boxing the concrete error to keep GitError small. +impl From for GitError { + fn from(error: CloneError) -> Self { + Self::Clone(Box::new(error)) + } +} + +/// Concrete clone failures wrapped by [`GitError::Clone`]. +/// +/// Preparation, name validation, fetching, and checkout expose different `gix` +/// error types. These variants retain each original error as their source. +#[derive(Debug, thiserror::Error)] +pub enum CloneError { + /// Clone preparation failed before downloading repository data. + #[error("clone preparation failed: {0}")] + Prepare(#[from] gix::clone::Error), + + /// The configured remote name was invalid. + #[error("remote name is invalid: {0}")] + RemoteName(#[from] gix::remote::name::Error), + + /// The requested branch name was not a valid Git reference name. + #[error("branch name is invalid: {0}")] + BranchName(#[from] gix::validate::reference::name::Error), + + /// Fetching failed, including a missing requested branch. + /// This can indicate network, configuration, or remote-reference failures. + #[error("fetch failed: {0}")] + Fetch(#[from] gix::clone::fetch::Error), + + /// Downloaded data could not be checked out into the working tree. + #[error("checkout failed: {0}")] + Checkout(#[from] gix::clone::checkout::main_worktree::Error), +} + +/// Concrete repository failures wrapped by [`GitError::Repository`]. +/// +/// Variants identify local reads or remote-reference queries and preserve the +/// original `gix` error as their source. +#[derive(Debug, thiserror::Error)] +pub enum RepositoryError { + /// An existing repository could not be opened or validated. + #[error("repository could not be opened: {0}")] + Open(#[from] gix::open::Error), + + /// HEAD could not be resolved to a commit ID, including an unborn HEAD. + #[error("HEAD could not be resolved: {0}")] + Head(#[from] gix::reference::head_id::Error), + + /// No default fetch remote could be determined, including ambiguous configurations. + #[error("no default fetch remote could be determined")] + NoDefaultRemote, + + /// The selected default remote could not be loaded from repository configuration. + #[error("default fetch remote could not be loaded: {0}")] + FindDefaultRemote(#[from] gix::remote::find::existing::Error), + + /// A transport connection to the selected remote could not be prepared. + #[error("remote connection failed: {0}")] + RemoteConnect(#[from] gix::remote::connect::Error), + + /// The remote handshake or query of advertised references failed. + #[error("remote reference query failed: {0}")] + RemoteRefMap(#[from] gix::remote::ref_map::Error), +} diff --git a/backend/crates/core/src/git/repository.rs b/backend/crates/core/src/git/repository.rs new file mode 100644 index 000000000..22e16b294 --- /dev/null +++ b/backend/crates/core/src/git/repository.rs @@ -0,0 +1,254 @@ +use super::{ + error::{GitError, RepositoryError}, + update::unwrap_repo_path, +}; +use gix::Repository; +use std::path::PathBuf; +use tracing::{debug, instrument}; + +/// Opens an existing repository without fetching or changing its checkout. +/// +/// `path` is the repository directory. If omitted, it defaults to +/// `/hyperloop-control-station/adj`. This does not create ADJ. +/// +/// # Errors +/// +/// Returns [`GitError::Path`] if the cache directory cannot be resolved, or +/// [`GitError::Repository`] if the repository is missing, invalid, or inaccessible. +#[instrument(level = "debug", err(level = "warn"))] +pub fn open_repo(path: Option) -> Result { + let path = unwrap_repo_path(path)?; + + let repo = gix::open(path).map_err(RepositoryError::from)?; + + debug!(git_dir = ?repo.path(), "opened repository"); + Ok(repo) +} + +/// Lists the branch names advertised by the repository's default fetch remote. +/// +/// `repo` supplies the configuration used to select the default fetch remote. +/// Returns sorted short names such as `main` or `feature/example`, excluding tags +/// and `HEAD`. Queries the remote without downloading objects or updating local +/// references. Configured fetch refspecs do not limit the advertised branches. +/// This is a blocking operation and requires access to the remote. +/// +/// # Errors +/// +/// Returns [`GitError::Repository`] if no default remote can be determined, or +/// remote configuration, connection, or reference discovery fails. Does not fall +/// back to cached branches on failure. +#[instrument(level = "debug", skip(repo), err(level = "warn"))] +pub fn list_remote_branches(repo: &Repository) -> Result, GitError> { + let remote = repo + .find_default_remote(gix::remote::Direction::Fetch) + .ok_or(RepositoryError::NoDefaultRemote)? + .map_err(RepositoryError::from)?; + + debug!( + git_dir = ?repo.path(), + "querying branches advertised by the default fetch remote" + ); + let conexion = remote + .connect(gix::remote::Direction::Fetch) + .map_err(RepositoryError::from)?; + let (mapa, _handshake) = conexion + .ref_map( + gix::progress::Discard, + gix::remote::ref_map::Options { + // Protocol v2 must not restrict ls-refs to a single-branch refspec. + prefix_from_spec_as_filter_on_remote: false, + ..Default::default() + }, + ) + .map_err(RepositoryError::from)?; + + let mut ramas: Vec = mapa + .remote_refs + .iter() + .filter_map(|r| { + let (nombre, _, _) = r.unpack(); + nombre + .to_string() + .strip_prefix("refs/heads/") + .map(str::to_string) + }) + .collect(); + + ramas.sort(); + debug!( + git_dir = ?repo.path(), + count = ramas.len(), + "listed advertised remote branches" + ); + Ok(ramas) +} + +/// Checks whether the default fetch remote advertises the requested branch. +/// +/// `repo` selects the remote and `name` is its exact short branch name, such as +/// `main` or `feature/example`, without an `origin/` prefix. Calls +/// [`list_remote_branches`] and returns `true` if the name is in the result. +/// `false` means the query succeeded but the remote did not advertise that name. +/// This is a blocking remote query, not a check of cached references. +/// +/// # Errors +/// +/// Propagates the original [`GitError`] from [`list_remote_branches`]. A missing +/// remote or failed connection is an error, never `Ok(false)`. +// The delegated listing logs failures; do not emit the same warning twice. +#[instrument(level = "debug", skip(repo))] +pub fn branch_exists(repo: &Repository, name: &str) -> Result { + let branches = list_remote_branches(repo)?; + let exists = branches.iter().any(|branch| branch == name); + debug!(name, exists, "checked advertised remote branch"); + Ok(exists) +} + +#[cfg(test)] +mod tests { + use super::*; + use std::{fs, io, path::Path, process::Command}; + + type TestResult = Result>; + + fn git(path: &Path, args: &[&str]) -> TestResult { + // Provide fixture identity and disable user signing, hooks, and templates. + let output = Command::new("git") + .current_dir(path) + .args([ + "-c", + "user.name=ADJ tests", + "-c", + "user.email=adj@example.test", + "-c", + "commit.gpgSign=false", + "-c", + "tag.gpgSign=false", + "-c", + "core.hooksPath=", + "-c", + "init.templateDir=", + ]) + .args(args) + .output()?; + if !output.status.success() { + return Err(io::Error::other(String::from_utf8_lossy(&output.stderr)).into()); + } + Ok(()) + } + + fn local_remote() -> TestResult<(tempfile::TempDir, Repository)> { + let temp = tempfile::tempdir()?; + let remote = temp.path().join("remote"); + let client = temp.path().join("client"); + fs::create_dir(&remote)?; + fs::create_dir(&client)?; + git(&remote, &["init", "--initial-branch=main"])?; + fs::write(remote.join("data.txt"), "ADJ fixture")?; + git(&remote, &["add", "."])?; + git(&remote, &["commit", "-m", "fixture data"])?; + git(&remote, &["branch", "software"])?; + git(&remote, &["branch", "feature/example"])?; + git(&remote, &["tag", "v1"])?; + + // No clone or fetch: only main is tracked, and no remote refs are cached. + git(&client, &["init", "--initial-branch=main"])?; + git( + &client, + &[ + "remote", + "add", + "-t", + "main", + "origin", + remote.to_str().ok_or("non-UTF-8 test path")?, + ], + )?; + // Exercise ls-refs prefix filtering rather than protocol v1's full advertisement. + git(&client, &["config", "protocol.version", "2"])?; + let repo = gix::open(&client)?; + Ok((temp, repo)) + } + + // List all advertised branches despite a main-only refspec, without fetching. + #[test] + fn lists_all_remote_branches_without_fetching() -> TestResult { + let (temp, repo) = local_remote()?; + assert_eq!( + list_remote_branches(&repo)?, + ["feature/example", "main", "software"] + ); + for name in ["feature/example", "main", "software"] { + let reference = format!("refs/remotes/origin/{name}"); + assert!(repo.try_find_reference(reference.as_str())?.is_none()); + } + let remote_commit = gix::open(temp.path().join("remote"))?.head_id()?.detach(); + assert!(repo.find_object(remote_commit).is_err()); + Ok(()) + } + + // Remote existence must not depend on having the branch cached locally. + #[test] + fn finds_uncached_remote_branch() -> TestResult { + let (_temp, repo) = local_remote()?; + assert!( + repo.try_find_reference("refs/remotes/origin/feature/example")? + .is_none() + ); + assert!(branch_exists(&repo, "feature/example")?); + Ok(()) + } + + // Only exact short names match after a successful remote query. + #[test] + fn rejects_missing_and_remote_prefixed_branch_names() -> TestResult { + let (_temp, repo) = local_remote()?; + assert!(!branch_exists(&repo, "missing-branch")?); + assert!(!branch_exists(&repo, "origin/main")?); + Ok(()) + } + + // Missing remote configuration is an explicit error for both helpers. + #[test] + fn propagates_missing_default_remote() -> TestResult { + let temp = tempfile::tempdir()?; + let repo = gix::init(temp.path())?; + for result in [ + list_remote_branches(&repo).map(|_| ()), + branch_exists(&repo, "main").map(|_| ()), + ] { + assert!(matches!(result, Err(GitError::Repository(error)) + if matches!(*error, RepositoryError::NoDefaultRemote))); + } + Ok(()) + } + + // An unreachable source must remain an error, not false or an empty listing. + #[test] + fn propagates_inaccessible_remote() -> TestResult { + let (temp, _) = local_remote()?; + let client = temp.path().join("client"); + let missing = temp.path().join("missing-remote"); + git( + &client, + &[ + "remote", + "set-url", + "origin", + missing.to_str().ok_or("non-UTF-8 test path")?, + ], + )?; + // Reopen to pick up the changed remote URL instead of the old config snapshot. + let repo = gix::open(&client)?; + for result in [ + list_remote_branches(&repo).map(|_| ()), + branch_exists(&repo, "main").map(|_| ()), + ] { + assert!(matches!(result, Err(GitError::Repository(error)) + if matches!(*error, + RepositoryError::RemoteConnect(_) | RepositoryError::RemoteRefMap(_)))); + } + Ok(()) + } +} diff --git a/backend/crates/core/src/git/update.rs b/backend/crates/core/src/git/update.rs new file mode 100644 index 000000000..6e58684dc --- /dev/null +++ b/backend/crates/core/src/git/update.rs @@ -0,0 +1,146 @@ +use super::{GitError, RepositoryError, clone::git_replace}; +use gix::Repository; +use std::{ + io, + net::{Ipv4Addr, SocketAddr, TcpStream}, + path::PathBuf, + time::Duration, +}; +use tracing::{debug, info, instrument, warn}; + +const ADJ_URL: &str = "https://github.com/Hyperloop-UPV/adj.git"; + +/// Updates ADJ to the requested branch or uses the existing application-managed cache. +/// +/// `path` is the repository directory, not its parent. If omitted, it defaults to +/// `/hyperloop-control-station/adj`. `branch` selects the branch +/// to clone when non-empty and the connectivity probe succeeds. +/// +/// With a non-empty branch and connectivity, local edits and commits are discarded +/// only after a fresh checkout succeeds. Offline, the current cached checkout is +/// used without switching branches, so it may differ from `branch`. +/// +/// An empty `branch` ("") uses the cached checkout without updating or switching +/// branches, preserving local edits and commits regardless of connectivity. +/// The connectivity probe still runs. Returns the checked-out commit's full hash. +/// +/// This performs blocking network and filesystem operations. Call during startup, +/// before readers use ADJ, with only one updater at a time. Replacement uses two +/// renames and is not atomic across a process crash. +/// +/// # Errors +/// +/// Returns [`GitError::UnavailableOffline`] if ADJ is missing offline. Other +/// variants identify path, repository, cloning, checkout, or replacement failures. +/// Clone errors do not automatically fall back to the cache. If restoration fails, +/// [`GitError::Replacement`] preserves both errors and the backup's location. +// Log returned errors at the public boundary; helpers trace progress without duplicate warnings. +#[instrument(level = "debug", err(level = "warn"))] +pub fn update_adj(path: Option, branch: &str) -> Result { + let (repo, dir) = adj_exists_repo(path)?; + + if check_internet_connection() && !branch.is_empty() { + info!(path = ?dir, branch, "starting ADJ update"); + // Release repository handles before moving the existing cache directory. + drop(repo); + git_replace(&dir, branch, ADJ_URL) + } else if let Some(repo) = repo { + + if branch.is_empty() { + warn!(path = ?dir, requested_branch = branch, + "branch not specified; using cached ADJ with current branch"); + } else { + warn!(path = ?dir, requested_branch = branch, + "connectivity probe failed; using cached ADJ without switching branches"); + } + get_commit_hash(&repo) + } else { + Err(GitError::UnavailableOffline) + } +} + +// Checks external TCP connectivity with a three-second timeout, not GitHub availability. +#[instrument(level = "info")] +fn check_internet_connection() -> bool { + // Use a fixed IPv4 address to avoid a separate DNS lookup and its timeout. + let address = SocketAddr::from((Ipv4Addr::new(1, 1, 1, 1), 443)); + let timeout = Duration::from_secs(3); + + // Attempt only the TCP handshake; no application data is sent. + match TcpStream::connect_timeout(&address, timeout) { + Ok(_stream) => { + info!(%address, "connectivity probe succeeded"); + true + } + Err(error) => { + // Record why the probe failed without treating it as an application error. + info!(%address, %error, "connectivity probe failed"); + false + } + } +} + +// Preserve explicit paths; otherwise use the platform's user cache directory. +pub(crate) fn unwrap_repo_path(path: Option) -> Result { + let dir = match path { + Some(path) => path, + None => { + let path = dirs::cache_dir().ok_or_else(|| { + GitError::Path(io::Error::new( + io::ErrorKind::NotFound, + "cache directory not found", + )) + })?; + + path.join("hyperloop-control-station").join("adj") + } + }; + + debug!(path = ?dir, "resolved ADJ repository path"); + Ok(dir) +} + +// Only an absent directory is a cache miss; invalid repositories remain errors. +pub(crate) fn adj_exists_repo( + path: Option, +) -> Result<(Option, PathBuf), GitError> { + let dir = unwrap_repo_path(path)?; + + let res = if dir.try_exists().map_err(GitError::Path)? { + Some(gix::open(&dir).map_err(RepositoryError::from)?) + } else { + None + }; + + debug!(path = ?dir, exists = res.is_some(), "checked local ADJ repository"); + Ok((res, dir)) +} + +// Report the checked-out HEAD, which can differ from the requested branch offline. +pub(crate) fn get_commit_hash(repo: &Repository) -> Result { + let hash = repo.head_id().map_err(RepositoryError::from)?.to_string(); + + // Log only the commit ID, not potentially large or sensitive message text. + debug!(commit = %hash, "read checked-out ADJ commit"); + Ok(hash) +} + +#[cfg(test)] +mod tests { + use super::*; + use std::fs; + + // Distinguish missing, invalid, and valid local repositories. + #[test] + fn detects_missing_and_invalid_repositories() + -> Result<(), Box> { + let temp = tempfile::tempdir()?; + let path = temp.path().join("adj"); + assert!(adj_exists_repo(Some(path.clone()))?.0.is_none()); + fs::create_dir(&path)?; + assert!(adj_exists_repo(Some(path.clone())).is_err()); + gix::init(&path)?; + assert!(adj_exists_repo(Some(path))?.0.is_some()); + Ok(()) + } +} diff --git a/backend/crates/core/src/hello_world.rs b/backend/crates/core/src/hello_world.rs new file mode 100644 index 000000000..2c8b7da23 --- /dev/null +++ b/backend/crates/core/src/hello_world.rs @@ -0,0 +1,50 @@ +//! Demo de una API documentada con eventos y contexto de `tracing`. +//! +//! El ejecutable configura el subscriber; este módulo solo emite eventos. + +/// Construye un saludo para `name`, eliminando espacios exteriores. +/// +/// Si el nombre está vacío o solo contiene espacios, saluda a `World`. +/// Emite detalles a nivel `debug` y el saludo a nivel `info`, dentro de un +/// span que identifica al destinatario. +/// +/// # Ejemplo +/// +/// ``` +/// use software_core::hello_world::greet; +/// +/// assert_eq!(greet("Hyperloop"), "Hello, Hyperloop!"); +/// assert_eq!(greet(""), "Hello, World!"); +/// ``` +#[tracing::instrument(name = "hello_world", skip(name), fields(recipient = %name))] +pub fn greet(name: &str) -> String { + let trimmed = name.trim(); + let recipient = if trimmed.is_empty() { "World" } else { trimmed }; + + tracing::debug!(used_default = trimmed.is_empty(), "destinatario preparado"); + let greeting = format!("Hello, {recipient}!"); + tracing::info!(greeting = %greeting, "saludo generado"); + greeting +} + +#[cfg(test)] +mod tests { + use super::greet; + + #[test] + fn greets_named_recipient() { + assert_eq!(greet("Hyperloop"), "Hello, Hyperloop!"); + } + + #[test] + fn trims_whitespace_and_preserves_unicode() { + assert_eq!(greet(" Lucía 🚄 \n"), "Hello, Lucía 🚄!"); + } + + #[test] + fn defaults_to_world_for_empty_or_whitespace_names() { + for name in ["", " \t\n"] { + assert_eq!(greet(name), "Hello, World!"); + } + } +} diff --git a/backend/crates/core/src/lib.rs b/backend/crates/core/src/lib.rs new file mode 100644 index 000000000..d7d151506 --- /dev/null +++ b/backend/crates/core/src/lib.rs @@ -0,0 +1,38 @@ +//! Componentes reutilizables de Hyperloop UPV. + +pub mod hello_world; + +/// # Git module +/// Handles updates and changes within the ADJ. +/// Checks the ADJ Github repository and +#[cfg(feature = "git")] +pub mod git; + +/// NTP server +#[cfg(feature = "ntp")] +pub mod ntp; + +/// Basic domain types: identifiers, values, measurements, protections, +/// packets and boards. +pub mod model; + +/// Parses an ADJ (Architecture Description JSON) directory into +/// [`model::PodData`], plus backend-session metadata not modeled as +/// vehicle data. See [`adj::load_from_dir`]. +pub mod adj; + +/// Translates bytes into typed packets and back, using the shapes +/// [`adj`] declares as the schema. See [`protocol::wire`], +/// [`protocol::tcp`], [`protocol::udp`]. +pub mod protocol; + +// Utils module +pub(crate) mod utils; +/// Everything a recording needs on disk: writing CSV, text and JSON +/// files without knowing what is in them ([`logger::CsvFile`]), moving +/// those files around ([`logger::files`], feature `files`) and the +/// snapshot of the machine that produced them ([`logger::host`], +/// feature `host`). The policy — which files a recording has, what goes +/// in each row — belongs to whoever calls this. +#[cfg(feature = "logger")] +pub mod logger; diff --git a/backend/crates/core/src/logger.rs b/backend/crates/core/src/logger.rs new file mode 100644 index 000000000..6d2146c27 --- /dev/null +++ b/backend/crates/core/src/logger.rs @@ -0,0 +1,111 @@ +//! Plain, synchronous file writing: the one place that knows how to put +//! a CSV row, a line of text or a JSON document on disk without +//! corrupting it. +//! +//! Deliberately boring, and deliberately small. It knows nothing about +//! the vehicle — no [`crate::model`] types, no ADJ, no boards, no +//! recording session, no notion of a timestamp or of a log level. +//! Deciding *what* to write, *when*, and under which name is the job of +//! the backend's own `station::logging`, which will own the four +//! subloggers (data, protections, messages and orders), the session +//! directory and the hot enable/disable. This module only answers "how +//! do I write this file". +//! +//! What it buys over calling [`std::fs`] from each of those subloggers: +//! +//! - **Flushing is explicit.** [`crate::logger::CsvFile::close`] and [`crate::logger::CsvFile::flush`] +//! return a `Result`. A fatal error in the backend ends in +//! `std::process::exit`, which runs no destructor, so a file that only +//! flushes when it is dropped loses its tail exactly in the case the +//! log was there to explain. [`Drop`] is kept as a courtesy flush that +//! traces its own failure, never as the plan. *When* to flush stays +//! the caller's decision, but it doesn't have to keep its own tally to +//! make it: every file reports its `bytes_since_flush`, so "flush +//! every so many kilobytes, or every so often" is a couple of lines +//! over a map of open files. +//! - **Errors name the file.** A bare [`std::io::Error`] says what went +//! wrong but not where; every [`crate::logger::Error`] here carries the path or the +//! label of the file it happened on. +//! - **A row can't silently go out of step.** A [`crate::logger::CsvFile`] knows its +//! header, so a row with one field too few is an error, not a file +//! whose columns are shifted from that line on. +//! - **Quoting is done once, here.** A board's free-text message and the +//! path it came from can both contain commas, quotes and newlines. +//! [`crate::logger::Row::text`] quotes per RFC 4180; four subloggers formatting their +//! own lines would each get a chance to get that wrong. +//! - **A row allocates nothing.** Fields are formatted into a buffer the +//! file reuses, not into a `Vec` built and thrown away per +//! row — at telemetry rates that is tens of thousands of rows a +//! second. +//! +//! The three formats are *not* one abstraction, and that is deliberate. +//! What they share is how a file is **held** — the label it answers to +//! in its errors, the poisoning after a failed write, the explicit +//! flush, the courtesy flush on drop — and that lives in one private +//! place (`target`), so it is one behaviour instead of three copies of +//! it that drift apart. What they don't share is how a file is +//! **written**, because it genuinely isn't the same operation: a CSV row +//! is typed fields validated against a header, a text line is a string +//! taken verbatim, and a JSON document is a whole value serialized in +//! one go with no handle to keep. [`crate::logger::CsvFile`] and +//! [`crate::logger::TextFile`] therefore expose the same vocabulary — +//! `create`, `new`, `flush`, `close`, `get_ref`, `is_poisoned` — while +//! [`crate::logger::write_json`] stays a free function, since a file +//! written once and closed has no handle to give back. +//! +//! There is no public trait over the three. A trait would only pay for +//! itself once some caller needs to be generic over the format — the +//! same code path writing either CSV or JSON lines, say — and no caller +//! does today; reaching for one now would mean either flattening the +//! API down to "write these bytes", which throws away the field +//! validation and the quoting that are the point, or inventing an +//! open/write/close lifecycle for JSON that it doesn't have. Adding the +//! trait later is backwards compatible, so it can wait for the second +//! caller. +//! +//! Reading is in for JSON only ([`crate::logger::read_json`], +//! [`crate::logger::JsonDocument`]), and for one reason: a document that +//! gains properties over time can't be added to without being read +//! first. A CSV or a text log is appended to and never revisited, and +//! nothing here will read one back. +//! +//! Two neighbours live alongside the three formats, each behind its own +//! feature because neither is needed to write a file: +//! [`crate::logger::files`] (feature `files`) copies, moves and removes +//! them, which is what makes these types usable on a file that already +//! exists, and [`crate::logger::host`] (feature `host`) is the snapshot +//! of the machine that goes into a recording's metadata. Both are about +//! a recording's files rather than about a vehicle, which is why they +//! are here and not modules of their own; neither is used by `csv`, +//! `text` or `json`, which still know nothing about what they write. +//! +//! Not here, on purpose: reading a CSV or a text log back, sessions, timestamps, file +//! rotation, keeping a registry of many open files +//! (a `HashMap` with `entry().or_insert_with(...)` in the +//! caller is shorter and clearer than anything this module could wrap it +//! in), and anything asynchronous. These functions block; a caller +//! inside a `tokio` task is the one that decides whether to run them on +//! a thread of their own. + +mod csv; +mod error; +mod json; +mod target; +mod text; + +/// Copies, moves and removes files, creating the directories a +/// destination needs and naming the file in every error. See +/// [`files::copy_file`]. +#[cfg(feature = "files")] +pub mod files; + +/// A best-effort snapshot of the machine, the user and the build, for +/// the metadata of a recording. Nothing in it fails: what the system +/// won't say is left empty. See [`host::HostInfo`]. +#[cfg(feature = "host")] +pub mod host; + +pub use csv::{CsvFile, Row}; +pub use error::Error; +pub use json::{JsonDocument, read_json, write_json}; +pub use text::TextFile; diff --git a/backend/crates/core/src/logger/README.md b/backend/crates/core/src/logger/README.md new file mode 100644 index 000000000..c386b60a3 --- /dev/null +++ b/backend/crates/core/src/logger/README.md @@ -0,0 +1,408 @@ +# Logger Module (`logger`) + +Everything a recording needs on disk: writing CSV, text and JSON files +without knowing what is in them, moving those files around, and the +snapshot of the machine that produced them. + +Deliberately boring, and deliberately small. It knows nothing about the +vehicle — no `model` types, no ADJ, no boards, no session, no notion of a +timestamp or of a log level. Deciding **what** to write, **when**, and +under which name is the job of the backend's own `station::logging`, +which owns the subloggers (data, protections, messages and orders), the +session directory and the hot enable/disable. This module only answers +*"how do I write this file"*. + +Everything here blocks. A caller inside a `tokio` task is the one that +decides whether to run it on a thread of its own. + +--- + +## Directory Structure + +``` +logger/ +├── error.rs # `Error`: one variant per failure, every one naming its file +├── target.rs # private: the handle discipline the three formats share +├── csv.rs # `CsvFile`, `Row` — a CSV file that knows its header +├── text.rs # `TextFile` — one line at a time, verbatim +├── json.rs # `write_json`, `read_json`, `JsonDocument` +├── files.rs # `files` (feature `files`): copy, move, remove, size +│ └── error.rs # its own `Error`, naming both paths when there are two +└── host.rs # `host` (feature `host`): `HostInfo`, `open_file_limit` +``` + +Public API, re-exported at the module root: `CsvFile`, `Row`, `TextFile`, +`JsonDocument`, `read_json`, `write_json`, `Error`. The two submodules +stay namespaced (`logger::files`, `logger::host`) because they are used +far less often than the formats and read better qualified. + +--- + +## What It Buys Over Calling `std::fs` + +- **Flushing is explicit.** `close` and `flush` return a `Result`. A + fatal error in the backend ends in `std::process::exit`, which runs no + destructor, so a file that only flushes when it is dropped loses its + tail exactly in the case the log was there to explain. `Drop` is kept + as a courtesy flush that traces its own failure, never as the plan. + *When* to flush stays the caller's decision, but it doesn't have to + keep its own tally to make it: every file reports its + `bytes_since_flush`, so "flush every so many kilobytes, or every so + often" is a couple of lines over a map of open files. +- **Errors name the file.** A bare `std::io::Error` says what went wrong + but not where; every `Error` here carries the path or the label of the + file it happened on. +- **A row can't silently go out of step.** A `CsvFile` knows its header, + so a row with one field too few is an error, not a file whose columns + are shifted from that line on. +- **Quoting is done once, here.** A board's free-text message and the + path it came from can both contain commas, quotes and newlines; + `Row::text` quotes per RFC 4180. Four subloggers formatting their own + lines would each get a chance to get that wrong. +- **A row allocates nothing.** Fields are formatted into a buffer the + file reuses, not into a `Vec` built and thrown away per row — + at telemetry rates that is tens of thousands of rows a second. + +Nothing is traced per row, on purpose: that would be tens of thousands +of events per second. Only opening a file (`debug`), a copy or a move +(`debug`), and a failed flush on drop (`error`) are traced. + +--- + +## `target.rs` — The Shared Handle Discipline + +Private, and **not a trait**. `CsvFile` and `TextFile` differ in what +they put *in* a file (columns and quoting versus lines), not in how they +hold one, so the holding lives here once: + +| Behaviour | What it means | +| --- | --- | +| `label` | The name the file answers to in every `Error` — its path, or whatever a caller of `new` passed for an in-memory destination. | +| Poisoning | The first failed write or flush poisons the file: every later call returns `Error::Poisoned` instead of appending to something already inconsistent, or repeating the same I/O error once per row. | +| Explicit flush | `flush`/`close` report failure; `bytes_written` and `bytes_since_flush` are the counters a flush policy is built on. | +| Courtesy flush on drop | A file dropped without `close` is flushed best-effort, and a failure is traced (it cannot be returned, and the workspace lints rule out panicking). | + +It also owns the two ways a file is opened: + +- `create_file` — creates or truncates, creating parent directories, + behind a `BufWriter` of the default capacity (a bigger buffer is less + I/O but more lost if the process dies before the next flush, and that + trade is the caller's). +- `append_file` — opens for appending, creating the file and its parents + if needed, and reports how many bytes it already held. If that content + doesn't end in a newline, one is written first, so what gets appended + starts on its own line. That is the **only** thing looked at: what the + existing content *says* is never read or checked. + +--- + +## `csv.rs` — `CsvFile` and `Row` + +A CSV file written one row at a time, generic over its destination +(`CsvFile`, defaulting to `BufWriter`) so the format can +be exercised against an in-memory buffer. + +```rust +use software_core::logger::CsvFile; + +let mut csv = CsvFile::create("sessions/13/data/speed.csv", &["t_us", "origin", "value"])?; +csv.row().int(1_250).text("LCU, bay 2").num(53.2).end()?; +csv.flush()?; +csv.close()?; +``` + +**Constructors:** `create` (truncates, writes the header), `append` +(adds to the end; the header is written only if the file is new or +empty), `new` (wraps an already-open `W` with a label of its own). + +**A row:** `row()` starts one, then `int`, `num`, `bool` and `text` +append fields and `end()` validates and writes it. Every field method +keeps the first error it hits and returns `Self`, so a row reads as one +expression without a `?` per field; `end` is where that error — and the +field count — is reported. Nothing reaches the file until `end`, and a +row dropped without it writes nothing, so a row lands whole or not at +all, as a single `write_all`. + +**The header is the contract.** With a non-empty header, a row with a +different number of fields is an `Error::FieldCount` and is rejected +whole. An empty header writes no header line and leaves rows unchecked, +for a file whose columns aren't known up front. On `append`, the header +is *not* compared against what the file already holds — it is only taken +as a statement of how many fields a row has. The caller is the one who +knows that the file it opens is the file it thinks it is. + +**Formatting:** numbers and booleans are written with their `Display`, +i.e. the shortest form that round-trips (`1.0` is written `1`, and `NaN`, +`inf` and `-inf` are written as such rather than blanked — if a board +sent one, the log should say so). Only `text` can need quoting, and it is +the only one that does any: a field containing `,`, `"`, `\r` or `\n` is +wrapped in double quotes with inner quotes doubled, per RFC 4180. The +header goes through `Row` too, so a column name with a comma in it is +quoted the same way. + +**Also on the handle:** `flush`, `close`, `get_ref`, `is_poisoned`, +`label`, `bytes_written`, `bytes_since_flush` (see `target.rs` above). + +--- + +## `text.rs` — `TextFile` + +The same vocabulary as `CsvFile` — `create`, `append`, `new`, `flush`, +`close`, `get_ref`, `is_poisoned`, `label`, the byte counters, the same +`Error`, the same poisoning and the same courtesy flush — so there is +nothing to relearn moving between the two. `new` is the one that +differs: it can't fail, because there is no header to write. + +`write_line(line)` writes the line and its `\n` as a single write, so a +line lands whole or not at all. What `TextFile` does *not* have is +everything that only means something for columns: no header, no field +count, no quoting. A line is written exactly as given, and a line with a +comma or a quote in it is not special in any way — which also means a +text file can't tell you a line came out malformed. If the content has +fields in it, it wants `CsvFile` instead. + +--- + +## `json.rs` — Documents Written Whole + +Two ways in, for two different jobs: + +- **One-shot and typed.** `write_json(path, &value)` writes any + `Serialize` as pretty-printed JSON with a trailing newline, and + `read_json(path)` parses a whole document back as a `T`. Pretty, + because these are the files a person opens to find out what a + recording was. +- **A document that grows.** `JsonDocument` is for the file written when + a recording starts and added to when it stops: `new`/`open`/ + `open_or_new`, then `set`, `get`, `contains`, `remove`, `properties`, + `path` and `save`. It is held in memory as a `serde_json::Map`, so + properties this crate knows nothing about survive the round trip — the + document is edited, not rebuilt from a struct that would have dropped + them. `set` returns `&mut Self`, so several can be chained. + `open_or_new` forgives only a *missing* file; one that exists and is + broken still errors rather than quietly starting over and overwriting + it on the next save. + +```rust +use software_core::logger::JsonDocument; + +let mut session = JsonDocument::new("sessions/13/session.json"); +session.set("adj_commit", "4f1c3b0")?.set("time_unit", "us")?; +session.save()?; + +// Later, when the recording stops. +let mut session = JsonDocument::open("sessions/13/session.json")?; +session.set("rows", 128_000u64)?.set("stopped", true)?; +session.save()?; +``` + +**Every save is atomic.** The document is serialized into a `.tmp` +sibling, flushed, `sync_all`ed and then renamed over the destination, so +the file is never seen half-written: either the old contents or the new +ones. That matters more here than anywhere else in the module — a fatal +error in the backend ends in `std::process::exit`, and a session's +metadata truncated at that moment is what makes every CSV next to it +unreadable. The rename needs both files on one filesystem, which they +are by construction, being siblings. Not covered: the directory entry +isn't synced, so a power cut in the instant after the rename can still +lose it. + +**Properties come out in alphabetical order**, which is `serde_json`'s +own ordering for an object rather than something imposed here: the same +document always serializes the same way, which is what makes it readable +in a diff. + +Nothing is kept open between calls, which is why this file doesn't use +`Target` at all. Reading is in for JSON **only**, and for one reason: a +document that gains properties over time can't be added to without being +read first. A CSV or a text log is appended to and never revisited, and +nothing here will read one back. + +--- + +## `error.rs` — `logger::Error` + +One enum for the three formats. `Create`, `Read`, `Parse`, +`NotAnObject`, `Replace` and `Serialize` carry a `PathBuf`, since they +can only happen to a real file on disk; `Write`, `Flush`, `FieldCount` +and `Poisoned` carry a plain `label`, because a `CsvFile` can wrap any +`std::io::Write` and an in-memory buffer has no path. + +| Variant | When | +| --- | --- | +| `Create` | The file, or one of its parent directories, couldn't be created. | +| `Write` | A write to the file failed. The file is now poisoned. | +| `Flush` | The buffer couldn't be flushed, so what was written since the last flush may not have reached the disk. | +| `FieldCount` | A row didn't have as many fields as the header declares. Nothing was written. | +| `Poisoned` | An earlier write failed, so the file is no longer written to at all. | +| `Read` | The file couldn't be read (`read_json`, `JsonDocument::open`). | +| `Parse` | Not valid JSON, or a property isn't the type it was asked for. | +| `NotAnObject` | Valid JSON whose root isn't an object, so it has no properties. | +| `Replace` | The finished temporary file couldn't be renamed over its destination. | +| `Serialize` | A value couldn't be serialized as JSON, or its bytes couldn't be written. | + +`logger::files` has an `Error` of its own, listed below: a copy that +fails is not a failure of a file this module holds open, and its +variants name two paths rather than one. + +--- + +## `files.rs` — Moving Files Around *(feature `files`)* + +Plain `std::fs` with two things added, which is all it is for: the +destination's parent directories get created instead of the operation +failing, and every error names the file — both files, for the operations +that have two. + +| Function | Notes | +| --- | --- | +| `copy_file(from, to)` → `u64` | Replaces an existing `to` and returns the bytes copied. **Not atomic**: an interrupted copy leaves a partial file, so a reader that could see the destination mid-copy should be given a finished file under another name and then `move_file`d into place. | +| `copy_dir(from, to)` → `usize` | Recursive, returning how many files were copied. Directories are recreated as needed; a symbolic link is followed and its target copied as a plain file, so the result is real files rather than links pointing back at the original. | +| `move_file(from, to)` | A rename, atomic and free whatever the file's size. Across filesystems — a log directory on a USB stick — a rename is impossible, so it falls back to copy-then-remove, which is neither. | +| `remove_file(path)` | A file that isn't there is an error, as in `std::fs`: the caller is the one who knows whether that was expected. | +| `size(path)` → `u64` | How many bytes the file holds. | + +Its `Error` has `Copy`, `Move`, `CreateDir`, `Read` and `Remove`; +`Copy` and `Move` name both paths, since "couldn't copy" without saying +where to leaves the caller with nothing to act on. + +This is also what makes `CsvFile` and `JsonDocument` usable on a file +that already exists: copy it, then open the copy and carry on writing. + +```rust +use software_core::logger::{CsvFile, files}; + +files::copy_file("sessions/12/data/speed.csv", "sessions/13/data/speed.csv")?; +let mut speed = CsvFile::append("sessions/13/data/speed.csv", &["t_us", "value"])?; +speed.row().int(1_024).num(37.5).end()?; +speed.close()?; +``` + +Not wrapped: asking whether a file is there — that is `Path::exists`, +and a wrapper would only add a name to learn. Not here at all: anything +that walks a tree looking for something, rotation, quotas, watching for +changes, and anything asynchronous. + +--- + +## `host.rs` — Who Produced This *(feature `host`)* + +`HostInfo::collect()` takes one snapshot of the machine, the user and +the build, meant to be serialized straight into a recording's metadata +so that months later it is still possible to answer *which machine +produced this, running which build, and with whose clock and locale*. + +It is part of `logger` because it is part of a recording, but not of how +one is written: this is the **content** of a metadata file, not a way of +putting bytes on a disk. Nothing in `csv`, `text`, `json` or `files` +uses it; they still write files without knowing what is in them. + +**Nothing in it fails.** Every field is attempted on its own and left +empty if the system won't say, `collect` returns no `Result` and nothing +panics — a recording must never fail to start over a missing user name. +`Option` fields are skipped when serializing, so an unknown value is +absent from the JSON rather than `null`. + +What it reads: `user`, `real_name`, `git_name`, `email`, `host`, `os`, +`arch`, `distro`, `cpus`, `core_version`, `debug_build`, `pid`, `exe`, +`args`, `working_dir`, `timezone`, `locale`, `started_at_unix`, +`open_file_limit`. + +Three of those are worth their own note: + +- **`email`** is looked for in four places, in order: `user.email` in + the global git configuration, `$GIT_AUTHOR_EMAIL`, `$EMAIL`, then the + account name if it happens to look like an address. No operating + system exposes an email address portably, so git's own identity is + used instead — reliable on a developer's machine, and the identity the + person is already known by. The git configuration is only read with + the `git` feature on (global and system files only, never a + repository, so the result can't depend on which directory the backend + was started from); without it, the environment variables are all that + is left. +- **`timezone`** is a zone *name* (`Europe/Madrid`), not an offset, + because the offset depends on the date and a recording may straddle + the day summer time changes. It comes from `$TZ`, or from the target + of the `/etc/localtime` link. It is worth more than it looks: + protections and messages carry a time of day with no date or zone, so + without the recording machine's zone they can't be placed on a real + timeline or lined up against video. +- **`open_file_limit`** is also a free function, + `host::open_file_limit()`, worth calling before opening a file per + measurement: the soft limit is **256** by default on macOS and usually + 1024 on Linux, and past it opening a file starts failing in the middle + of a recording, which looks like a disk problem and isn't one. `None` + on Windows, honestly rather than as a failure — it has no equivalent + limit for the handles `std::fs::File` uses. + +`HostInfo::without_identity()` returns the same snapshot with the user +name, real name, git name, email and machine name removed, for a +recording that is going to be shared outside the team. + +`HostInfo` is `Serialize` only, on purpose: reading one back is reading +JSON, not rebuilding this struct, and a field like `os` is a +compile-time constant of the build that wrote it rather than something +to parse. Deliberately absent: free disk space and memory (another +dependency, and the disk is better checked by whoever is about to fill +it), the battery, and the network interfaces the backend bound to — +that last one belongs to whatever opened the sockets, the only thing +that actually knows. + +--- + +## Features + +| Feature | Enables | Dependencies | +| --- | --- | --- | +| `logger` | `CsvFile`, `TextFile`, the JSON API, `Error` | none beyond the crate's own `serde`/`serde_json`/`tracing` | +| `files` | `logger::files` (implies `logger`) | none of its own | +| `host` | `logger::host` (implies `logger`) | `whoami`, plus `rlimit` on unix | + +`files` and `host` are separate features because neither is needed to +write a file: a tool that only wants to put CSV rows on a disk shouldn't +have to take `whoami` with it. With the `git` feature also on, +`HostInfo` fills in the git identity as described above. + +--- + +## Why There Is No Trait Over The Three Formats + +What the formats share is how a file is **held**, and that is +`target.rs`. What they don't share is how a file is **written**, because +it genuinely isn't the same operation: a CSV row is typed fields +validated against a header, a text line is a string taken verbatim, and +a JSON document is a whole value serialized in one go with no handle to +keep. That is why `CsvFile` and `TextFile` expose the same vocabulary +while `write_json` stays a free function. + +A trait would only pay for itself once some caller needs to be generic +over the format — the same code path writing either CSV or JSON lines, +say — and no caller does today. Reaching for one now would mean either +flattening the API down to "write these bytes", which throws away the +field validation and the quoting that are the point, or inventing an +open/write/close lifecycle for JSON that it doesn't have. Adding the +trait later is backwards compatible, so it can wait for the second +caller. + +--- + +## Not Here, On Purpose + +Reading a CSV or a text log back, sessions, timestamps, file rotation, +quotas, keeping a registry of many open files (a `HashMap` +with `entry().or_insert_with(...)` in the caller is shorter and clearer +than anything this module could wrap it in), and anything asynchronous. + +--- + +## Verification + +```bash +cargo test -p software-core -F logger,files,host +cargo clippy -p software-core --features logger,files,host --all-targets -- -D warnings +cargo doc --open -p software-core -F logger,files,host --no-deps +``` + +The tests write into temporary directories (`tempfile`, a dev +dependency) and against in-memory buffers; none of them needs a network +or a real session directory. diff --git a/backend/crates/core/src/logger/csv.rs b/backend/crates/core/src/logger/csv.rs new file mode 100644 index 000000000..8c2fbd723 --- /dev/null +++ b/backend/crates/core/src/logger/csv.rs @@ -0,0 +1,707 @@ +//! A CSV file that knows its own header. + +use super::Error; +use super::target::{Target, append_file, create_file}; +use std::fmt; +use std::fs::File; +use std::io::{BufWriter, Write}; +use std::path::Path; +use tracing::debug; + +/// A CSV file being written to, one row at a time. +/// +/// Generic over its destination so the format can be exercised against +/// an in-memory buffer, but the common case is the default: a file on +/// disk behind a [`BufWriter`], built with [`CsvFile::create`]. +/// +/// Three things it guarantees, which are the reason this type exists +/// instead of a bare [`File`]: +/// +/// - **A row lands whole or not at all.** Fields are built up in a +/// buffer the file reuses, and only [`Row::end`] writes — so a row +/// rejected for having the wrong number of fields never reaches the +/// file, and a row that does reach it is a single +/// [`Write::write_all`] call. +/// - **A failed write stops the file.** The first failure that reaches +/// the file poisons it: every later call returns +/// [`Error::Poisoned`] instead of appending to something already +/// inconsistent, or repeating the same I/O error once per row. +/// - **Flushing is something you ask for.** [`CsvFile::flush`] and +/// [`CsvFile::close`] return a `Result`. [`Drop`] only does a +/// best-effort flush and traces the failure: a fatal error in the +/// backend ends in `std::process::exit`, which runs no destructor at +/// all, so a log that only flushes on drop loses its tail exactly +/// when it matters most. +/// +/// Nothing here is traced per row on purpose: at telemetry rates that +/// would be tens of thousands of events per second. Only opening a file +/// (`debug`) and a failed flush on drop (`error`) are traced. +/// +/// # Example +/// +/// ``` +/// use software_core::logger::CsvFile; +/// +/// let mut csv = CsvFile::new(Vec::new(), "in memory", &["t", "origin", "value"])?; +/// csv.row().int(1_250).text("LCU, bay 2").num(53.2).end()?; +/// +/// assert_eq!( +/// csv.get_ref().as_slice(), +/// b"t,origin,value\n1250,\"LCU, bay 2\",53.2\n", +/// ); +/// # Ok::<(), Box>(()) +/// ``` +#[derive(Debug)] +pub struct CsvFile> { + target: Target, + /// How many fields every row must have, or `None` when the file was + /// created with an empty header and there is nothing to check + /// against. + fields: Option, + /// The row currently being built, reused across rows so writing one + /// allocates nothing. + buf: Vec, +} + +impl CsvFile> { + /// Creates (or truncates) the file at `path`, creating its parent + /// directories, and writes `header` as its first line. + /// + /// An empty `header` writes no header line and leaves the row's + /// field count unchecked — see [`CsvFile::new`]. + pub fn create(path: impl AsRef, header: &[&str]) -> Result { + let path = path.as_ref(); + + // The file is created before the header is written so that a failure to write the header doesn't leave a partially written file. + let file = Self::new(create_file(path)?, path.display().to_string(), header)?; + debug!(path = %path.display(), fields = header.len(), "csv file created"); + Ok(file) + } + + /// Opens the file at `path` to add rows to the end of it, creating it + /// and its parent directories if they aren't there. + /// + /// `header` is written only when the file is empty or brand new. + /// Otherwise it is taken as a statement of how many fields a row has — + /// what [`Error::FieldCount`] is checked against — and **what the file + /// already contains is not looked at**: if its columns are not these + /// ones, both shapes end up in the same file and nothing says so. The + /// caller is the one who knows that the file it opens is the file it + /// thinks it is; copying one with [`CsvFile::create`]'s own header is + /// the way to be sure. + /// + /// The one thing that *is* checked is the line boundary: if the + /// existing content doesn't end in a newline, one is written first, so + /// the first new row can't be glued onto a half-finished line. + pub fn append(path: impl AsRef, header: &[&str]) -> Result { + let path = path.as_ref(); + let (writer, existing) = append_file(path)?; + + let file = if existing == 0 { + Self::new(writer, path.display().to_string(), header)? + } else { + Self { + target: Target::new(writer, path.display().to_string()), + // No header line to write, so the count is taken from the + // argument instead of from what was just written. An empty + // header leaves rows unchecked, as in `new`. + fields: (!header.is_empty()).then_some(header.len()), + buf: Vec::new(), + } + }; + + debug!( + path = %path.display(), + existing_bytes = existing, + fields = header.len(), + "csv file opened to append" + ); + Ok(file) + } +} + +impl CsvFile { + /// Wraps an already-open destination, writing `header` as its first + /// line. + /// + /// `label` is what this file is called in any [`Error`] it produces; + /// [`CsvFile::create`] uses the path for it. + /// + /// An empty `header` writes no header line, and leaves every row's + /// field count unchecked — for a file whose columns aren't known up + /// front. With a header, a row with a different number of fields is + /// an [`Error::FieldCount`]. + pub fn new(inner: W, label: impl Into, header: &[&str]) -> Result { + let mut file = Self { + target: Target::new(inner, label.into()), + fields: None, + buf: Vec::new(), + }; + + if !header.is_empty() { + // Written through `Row` like any other line, so a header + // with a comma or a quote in it is quoted the same way a + // field would be. The field count is still `None` here, so + // the header itself is what sets the count rather than being + // checked against it. + let mut row = file.row(); + for field in header { + row = row.text(field); + } + row.end()?; + file.fields = Some(header.len()); + } + + Ok(file) + } + + /// Starts a row. Add its fields, then call [`Row::end`]. + /// + /// Nothing is written to the file until `end`, and a row dropped + /// without it writes nothing at all. + pub fn row(&mut self) -> Row<'_, W> { + self.buf.clear(); + Row { + file: self, + count: 0, + error: None, + } + } + + /// Flushes everything written so far to the destination. + pub fn flush(&mut self) -> Result<(), Error> { + self.target.flush() + } + + /// Flushes and closes the file, reporting a failure instead of + /// swallowing it like [`Drop`] has to. + pub fn close(mut self) -> Result<(), Error> { + self.target.close() + } + + /// Borrows the destination, e.g. to read back what was written to an + /// in-memory buffer. + pub fn get_ref(&self) -> &W { + self.target.get_ref() + } + + /// Whether an earlier write or flush failed, leaving this file + /// closed to further writes. + pub fn is_poisoned(&self) -> bool { + self.target.is_poisoned() + } + + /// What this file is called in its errors: the path it was created + /// with, or the label it was given. + /// + /// Worth having beyond [`Error`]'s own text: a caller that notices a + /// file went [`CsvFile::is_poisoned`] has no error in hand any more, + /// and still needs to say which file stopped. + pub fn label(&self) -> &str { + self.target.label() + } + + /// Every byte handed to the destination so far, header included — + /// the file's size on disk, once flushed. + pub fn bytes_written(&self) -> u64 { + self.target.bytes_written() + } + + /// The bytes written since the last successful flush. + /// + /// This is what a flush policy is built on: "flush every so many + /// kilobytes, or every so often" is the caller's decision (see this + /// module's docs), and this saves it from keeping its own tally for + /// each of the hundreds of files it may have open. + pub fn bytes_since_flush(&self) -> u64 { + self.target.bytes_since_flush() + } + + /// Writes the row held in `buf`, terminator included, as one call. + fn write_row(&mut self) -> Result<(), Error> { + self.buf.push(b'\n'); + self.target.write_all(&self.buf) + } +} + +/// A single row being built, field by field. +/// +/// Every field method appends to the file's row buffer and keeps the +/// first error it hits, so a row reads as one expression without a `?` +/// per field; [`Row::end`] is where that error — and the field count — +/// is reported. +#[derive(Debug)] +pub struct Row<'a, W: Write> { + file: &'a mut CsvFile, + count: usize, + error: Option, +} + +impl Row<'_, W> { + /// Appends an integer field. + pub fn int(self, value: i64) -> Self { + self.number(format_args!("{value}")) + } + + /// Appends a floating point field. + /// + /// Written with its [`fmt::Display`], i.e. the shortest form that + /// round-trips back to the same `f64`: a value with no fractional + /// part has no decimal point (`1.0` is written `1`), and `NaN` and + /// the infinities are written as `NaN`, `inf` and `-inf` rather than + /// replaced by an empty field — if a board sent one, the log should + /// say so. + pub fn num(self, value: f64) -> Self { + self.number(format_args!("{value}")) + } + + /// Appends a boolean field, as `true` or `false`. + pub fn bool(self, value: bool) -> Self { + self.number(format_args!("{value}")) + } + + /// Appends a text field, quoted if it needs to be. + /// + /// A field containing a comma, a double quote, a carriage return or + /// a line feed is wrapped in double quotes, with every inner quote + /// doubled (RFC 4180). This is the only method that can need + /// quoting — a number or a boolean never contains any of those — and + /// the one that matters: a board's free-text message or the path it + /// came from can contain all four. + pub fn text(mut self, value: &str) -> Self { + if self.error.is_some() { + return self; + } + + let separated = self.count > 0; + match append_text(&mut self.file.buf, value, separated) { + Ok(()) => { + self.count += 1; + self + } + Err(source) => { + self.error = Some(Error::Write { + label: self.file.target.label().to_string(), + source, + }); + self + } + } + } + + /// Validates the row against the file's header and writes it. + /// + /// Errors with [`Error::FieldCount`] — writing nothing — if the row + /// doesn't have as many fields as the header declares. + pub fn end(mut self) -> Result<(), Error> { + if let Some(error) = self.error.take() { + return Err(error); + } + + if self.file.target.is_poisoned() { + return Err(self.file.target.poisoned_error()); + } + + if let Some(expected) = self.file.fields + && self.count != expected + { + return Err(Error::FieldCount { + label: self.file.target.label().to_string(), + expected, + got: self.count, + }); + } + + self.file.write_row() + } + + /// Appends a field that can't need quoting: every numeric and + /// boolean field goes through here, which is also what makes them + /// the cheap ones. + fn number(mut self, value: fmt::Arguments<'_>) -> Self { + if self.error.is_some() { + return self; + } + + let separator = if self.count > 0 { "," } else { "" }; + // Appending to a `Vec` can only fail by running out of + // memory, but `write!` is fallible all the same: keep the error + // rather than discard it, and let `end` be the one to report it. + match write!(self.file.buf, "{separator}{value}") { + Ok(()) => { + self.count += 1; + self + } + Err(source) => { + self.error = Some(Error::Write { + label: self.file.target.label().to_string(), + source, + }); + self + } + } + } +} + +/// Appends `value` to `buf`, preceded by a separator if `separated`, and +/// quoted per RFC 4180 if it contains anything that needs it. +fn append_text(buf: &mut Vec, value: &str, separated: bool) -> std::io::Result<()> { + if separated { + buf.write_all(b",")?; + } + + if !value.contains([',', '"', '\n', '\r']) { + return buf.write_all(value.as_bytes()); + } + + buf.write_all(b"\"")?; + let mut rest = value; + while let Some(quote) = rest.find('"') { + buf.write_all(&rest.as_bytes()[..quote])?; + buf.write_all(b"\"\"")?; + rest = &rest[quote + 1..]; + } + buf.write_all(rest.as_bytes())?; + buf.write_all(b"\"") +} + +#[cfg(test)] +mod tests { + use super::*; + use std::fs; + + type TestResult = Result>; + + fn in_memory(header: &[&str]) -> TestResult>> { + Ok(CsvFile::new(Vec::new(), "in memory", header)?) + } + + fn written(csv: &CsvFile>) -> String { + String::from_utf8_lossy(csv.get_ref()).into_owned() + } + + /// A destination that takes `ok_writes` writes and fails every one + /// after that — what a full disk looks like from in here. + #[derive(Debug)] + struct FailsAfter { + ok_writes: usize, + taken: Vec, + } + + impl Write for FailsAfter { + fn write(&mut self, buf: &[u8]) -> std::io::Result { + if self.ok_writes == 0 { + return Err(std::io::Error::other("disk full")); + } + self.ok_writes -= 1; + self.taken.extend_from_slice(buf); + Ok(buf.len()) + } + + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + #[test] + fn appending_continues_a_file_without_writing_the_header_again() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("data/lcu.csv"); + + let mut csv = CsvFile::create(&path, &["t", "value"])?; + csv.row().int(1).num(1.5).end()?; + csv.close()?; + + let mut csv = CsvFile::append(&path, &["t", "value"])?; + csv.row().int(2).num(2.5).end()?; + csv.close()?; + + assert_eq!(fs::read_to_string(&path)?, "t,value\n1,1.5\n2,2.5\n"); + Ok(()) + } + + #[test] + fn appending_to_a_file_that_is_not_there_yet_writes_the_header() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("data/lcu.csv"); + + let mut csv = CsvFile::append(&path, &["t", "value"])?; + csv.row().int(1).num(1.5).end()?; + csv.close()?; + + assert_eq!(fs::read_to_string(&path)?, "t,value\n1,1.5\n"); + Ok(()) + } + + #[test] + fn appending_to_content_that_lacks_its_last_newline_starts_a_fresh_line() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("copied.csv"); + // What a file copied from elsewhere can easily look like. + fs::write(&path, "t,value\n1,1.5")?; + + let mut csv = CsvFile::append(&path, &["t", "value"])?; + csv.row().int(2).num(2.5).end()?; + csv.close()?; + + assert_eq!(fs::read_to_string(&path)?, "t,value\n1,1.5\n2,2.5\n"); + Ok(()) + } + + #[test] + fn an_appended_row_is_still_checked_against_the_header_it_was_given() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("data.csv"); + fs::write(&path, "t,value\n")?; + + let mut csv = CsvFile::append(&path, &["t", "value"])?; + let Err(error) = csv.row().int(1).num(1.5).text("extra").end() else { + unreachable!("three fields where the header says two"); + }; + + assert!(matches!( + error, + Error::FieldCount { + expected: 2, + got: 3, + .. + } + )); + Ok(()) + } + + #[test] + fn the_header_is_the_files_first_line() -> TestResult { + let csv = in_memory(&["t", "value"])?; + assert_eq!(written(&csv), "t,value\n"); + Ok(()) + } + + #[test] + fn an_empty_header_writes_nothing_and_leaves_the_field_count_unchecked() -> TestResult { + let mut csv = in_memory(&[])?; + assert_eq!(written(&csv), ""); + + csv.row().int(1).end()?; + csv.row().int(1).int(2).int(3).end()?; + + assert_eq!(written(&csv), "1\n1,2,3\n"); + Ok(()) + } + + #[test] + fn a_text_field_is_quoted_only_when_it_has_to_be() -> TestResult { + let mut csv = in_memory(&[])?; + + csv.row().text("LCU").end()?; + csv.row().text("LCU, bay 2").end()?; + csv.row().text("say \"hi\"").end()?; + csv.row().text("two\nlines").end()?; + csv.row().text("carriage\rreturn").end()?; + + assert_eq!( + written(&csv), + "LCU\n\"LCU, bay 2\"\n\"say \"\"hi\"\"\"\n\"two\nlines\"\n\"carriage\rreturn\"\n" + ); + Ok(()) + } + + #[test] + fn a_header_field_is_quoted_like_any_other_text() -> TestResult { + let csv = in_memory(&["t", "value, raw"])?; + assert_eq!(written(&csv), "t,\"value, raw\"\n"); + Ok(()) + } + + #[test] + fn numbers_and_booleans_are_never_quoted() -> TestResult { + let mut csv = in_memory(&[])?; + csv.row() + .int(-1_250) + .num(53.2) + .bool(true) + .bool(false) + .end()?; + assert_eq!(written(&csv), "-1250,53.2,true,false\n"); + Ok(()) + } + + #[test] + fn a_float_is_written_as_the_shortest_form_that_round_trips() -> TestResult { + let mut csv = in_memory(&[])?; + csv.row() + .num(1.0) + .num(53.2) + .num(-0.5) + .num(f64::NAN) + .num(f64::INFINITY) + .end()?; + assert_eq!(written(&csv), "1,53.2,-0.5,NaN,inf\n"); + Ok(()) + } + + #[test] + fn a_row_with_the_wrong_number_of_fields_is_rejected_whole() -> TestResult { + let mut csv = in_memory(&["t", "value"])?; + + let too_few = csv.row().int(1).end(); + assert!(matches!( + too_few, + Err(Error::FieldCount { + expected: 2, + got: 1, + .. + }) + )); + + let too_many = csv.row().int(1).int(2).int(3).end(); + assert!(matches!( + too_many, + Err(Error::FieldCount { + expected: 2, + got: 3, + .. + }) + )); + + // Neither rejected row reached the file, and the file still + // takes a correct row afterwards. + assert_eq!(written(&csv), "t,value\n"); + csv.row().int(1).num(2.5).end()?; + assert_eq!(written(&csv), "t,value\n1,2.5\n"); + Ok(()) + } + + #[test] + fn a_row_dropped_without_end_writes_nothing() -> TestResult { + let mut csv = in_memory(&["t"])?; + + let _ = csv.row().int(7); + assert_eq!(written(&csv), "t\n"); + + csv.row().int(8).end()?; + assert_eq!(written(&csv), "t\n8\n"); + Ok(()) + } + + #[test] + fn a_failed_write_poisons_the_file_instead_of_reporting_once_per_row() -> TestResult { + // One write for the header, so the first row is what fails. + let destination = FailsAfter { + ok_writes: 1, + taken: Vec::new(), + }; + let mut csv = CsvFile::new(destination, "failing", &["t"])?; + + assert!(matches!(csv.row().int(1).end(), Err(Error::Write { .. }))); + assert!(csv.is_poisoned()); + + assert!(matches!( + csv.row().int(2).end(), + Err(Error::Poisoned { .. }) + )); + assert!(matches!(csv.flush(), Err(Error::Poisoned { .. }))); + + // Nothing past the header ever reached the destination. + assert_eq!(String::from_utf8_lossy(&csv.get_ref().taken), "t\n"); + Ok(()) + } + + #[test] + fn writing_rows_reuses_one_buffer_instead_of_allocating_per_row() -> TestResult { + let mut csv = in_memory(&["t", "origin", "value"])?; + + // Two identical passes: the first lets the row buffer grow to + // whatever the widest of these rows needs, the second must not + // make it grow at all. Comparing passes rather than asserting + // some size keeps this about reuse and not about how wide a + // formatted `f64` happens to be. + let mut after_first_pass = None; + for _pass in 0..2 { + for i in 0..10_000usize { + let origin = &"src/boards/lcu/main.cpp"[..(i % 23) + 1]; + csv.row().int(i as i64).text(origin).num(i as f64).end()?; + } + + match after_first_pass { + None => after_first_pass = Some(csv.buf.capacity()), + Some(grown) => assert_eq!( + csv.buf.capacity(), + grown, + "the row buffer grew again on the second pass" + ), + } + } + // And it is one row's worth, not every row appended: if `row()` + // ever stopped clearing it, this would be in the megabytes. + assert!( + csv.buf.capacity() < 256, + "row buffer grew to {} bytes", + csv.buf.capacity() + ); + Ok(()) + } + + #[test] + fn a_file_reports_the_name_it_answers_to_in_its_errors() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("current.csv"); + + let on_disk = CsvFile::create(&path, &["t"])?; + assert_eq!(on_disk.label(), path.display().to_string()); + + let in_memory = in_memory(&["t"])?; + assert_eq!(in_memory.label(), "in memory"); + Ok(()) + } + + #[test] + fn bytes_written_counts_the_header_and_every_row() -> TestResult { + let mut csv = in_memory(&["t", "value"])?; + assert_eq!(csv.bytes_written(), "t,value\n".len() as u64); + + csv.row().int(1).num(2.5).end()?; + assert_eq!(csv.bytes_written(), "t,value\n1,2.5\n".len() as u64); + Ok(()) + } + + #[test] + fn bytes_since_flush_is_what_a_flush_policy_reads_and_resets() -> TestResult { + let mut csv = in_memory(&["t"])?; + csv.row().int(1).end()?; + assert_eq!(csv.bytes_since_flush(), "t\n1\n".len() as u64); + + csv.flush()?; + assert_eq!(csv.bytes_since_flush(), 0); + // Flushing doesn't reset the total, only what is pending. + assert_eq!(csv.bytes_written(), "t\n1\n".len() as u64); + + csv.row().int(2).end()?; + assert_eq!(csv.bytes_since_flush(), "2\n".len() as u64); + Ok(()) + } + + #[test] + fn a_rejected_row_counts_no_bytes() -> TestResult { + let mut csv = in_memory(&["t", "value"])?; + let header = csv.bytes_written(); + + assert!(csv.row().int(1).end().is_err()); + assert_eq!(csv.bytes_written(), header); + Ok(()) + } + + #[test] + fn create_makes_the_parent_directories_and_close_persists_every_row() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("session/data/LCU/current.csv"); + + let mut csv = CsvFile::create(&path, &["t", "value"])?; + csv.row().int(0).num(1.5).end()?; + csv.row().int(1_000).num(2.5).end()?; + csv.close()?; + + assert_eq!(fs::read_to_string(&path)?, "t,value\n0,1.5\n1000,2.5\n"); + Ok(()) + } +} diff --git a/backend/crates/core/src/logger/error.rs b/backend/crates/core/src/logger/error.rs new file mode 100644 index 000000000..691f43e08 --- /dev/null +++ b/backend/crates/core/src/logger/error.rs @@ -0,0 +1,135 @@ +//! Errors produced while writing a file. +//! +//! Every variant names the file it happened on. A bare +//! [`std::io::Error`] says what went wrong but never where, and by the +//! time it reaches whoever decides whether to keep logging, the file is +//! the only thing that makes it actionable. +//! +//! [`Error::Create`] and [`Error::Serialize`] carry a [`PathBuf`], since +//! they can only happen to a real file on disk. The rest carry a plain +//! `label`, because a [`super::CsvFile`] can wrap any +//! [`std::io::Write`] — an in-memory buffer in a test has no path, just +//! the name its caller gave it. + +use std::path::PathBuf; + +/// An error writing a file. +#[derive(Debug, thiserror::Error)] +pub enum Error { + /// Couldn't create the file, or one of its parent directories. + #[error("couldn't create {path:?}")] + Create { + /// The file that couldn't be created. + path: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't write to the file. + #[error("couldn't write to {label}")] + Write { + /// The file that couldn't be written to. + label: String, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't flush the file's buffer, so what was written since the + /// last flush may not have reached the disk. + #[error("couldn't flush {label}")] + Flush { + /// The file that couldn't be flushed. + label: String, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// A row didn't have as many fields as the file's header declares. + /// + /// Nothing was written: the row is rejected whole, instead of + /// shifting every column of the file from that point on. + #[error("{label}: row needs {expected} field(s), got {got}")] + FieldCount { + /// The file the row was meant for. + label: String, + /// How many fields the header declares. + expected: usize, + /// How many fields the row actually had. + got: usize, + }, + + /// An earlier write to this file failed, so it is no longer written + /// to at all. + /// + /// Returned instead of retrying, because a write that failed halfway + /// already left the file inconsistent — and because a failing file + /// written at telemetry rates would otherwise report the same error + /// thousands of times per second. + #[error("{label} was left in a failed state by an earlier write")] + Poisoned { + /// The file that failed earlier. + label: String, + }, + + /// Couldn't read the file. + #[error("couldn't read {path:?}")] + Read { + /// The file that couldn't be read. + path: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't parse the file as JSON, or couldn't read one of its + /// properties as the type it was asked for. + #[error("couldn't parse {path:?} as JSON")] + Parse { + /// The file that failed to parse. + path: PathBuf, + /// The underlying `serde_json` error, which says where in the + /// document the problem is. + #[source] + source: serde_json::Error, + }, + + /// The file is valid JSON, but its root isn't an object, so it has + /// no properties to read or add to. + #[error("{path:?} is valid JSON but its root is not an object")] + NotAnObject { + /// The file whose root isn't an object. + path: PathBuf, + }, + + /// Couldn't put the finished file in place of the old one. + /// + /// A JSON document is built in a temporary file next to its + /// destination and renamed over it, so this is the last step of + /// [`super::write_json`] — and the only one that can fail with the + /// new content already complete on disk, under the temporary name + /// this error reports as its source path's sibling. + #[error("couldn't put the finished file in place of {path:?}")] + Replace { + /// The destination that couldn't be replaced. + path: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't serialize the value as JSON, or couldn't write the + /// serialized bytes out. + #[error("couldn't write {path:?} as JSON")] + Serialize { + /// The file being written. + path: PathBuf, + /// The underlying `serde_json` error — which wraps the I/O error + /// too, when the failure was in writing rather than in + /// serializing. + #[source] + source: serde_json::Error, + }, +} diff --git a/backend/crates/core/src/logger/files.rs b/backend/crates/core/src/logger/files.rs new file mode 100644 index 000000000..af15e325e --- /dev/null +++ b/backend/crates/core/src/logger/files.rs @@ -0,0 +1,366 @@ +//! Copying, moving and removing files. +//! +//! Plain [`std::fs`] with two things added, which is all this is for: +//! the destination's parent directories get created instead of the +//! operation failing, and every error names the file — both files, for +//! the operations that have two — which is what makes it actionable by +//! the time it has travelled up to whoever decides what to do about it. +//! +//! No dependencies, on purpose: a tool that wants to copy a file +//! shouldn't have to take anything else with it. +//! +//! Copying is also what makes the types in [`crate::logger`] usable on a +//! file that already exists: copy it, then open the copy and carry on +//! writing to it. +//! +//! ```no_run +//! use software_core::logger::files; +//! use software_core::logger::{CsvFile, JsonDocument}; +//! +//! // A recording that starts from the previous session's layout. +//! files::copy_file("sessions/12/session.json", "sessions/13/session.json")?; +//! +//! let mut session = JsonDocument::open("sessions/13/session.json")?; +//! session.set("started", true)?; +//! session.save()?; +//! +//! // And a CSV that is continued rather than started over. +//! files::copy_file("sessions/12/data/speed.csv", "sessions/13/data/speed.csv")?; +//! let mut speed = CsvFile::append("sessions/13/data/speed.csv", &["t_us", "value"])?; +//! speed.row().int(1_024).num(37.5).end()?; +//! speed.close()?; +//! # Ok::<(), Box>(()) +//! ``` +//! +//! Not wrapped: asking whether a file is there. That is +//! [`std::path::Path::exists`], and a wrapper around it would only add a +//! name to learn. +//! +//! Not here at all: anything that walks a tree looking for something, +//! rotation, quotas, watching for changes, and anything asynchronous. A +//! recording copies a handful of files at the start and at the end; when +//! that stops being true, whatever needs more can say so then. + +mod error; + +pub use error::Error; + +use std::fs; +use std::path::Path; +use tracing::debug; + +/// Copies `from` over `to`, creating `to`'s parent directories, and +/// returns how many bytes were copied. +/// +/// An existing `to` is replaced. The copy is not atomic: an interrupted +/// copy leaves a partial file behind, so a reader that could see the +/// destination mid-copy should be given a finished file under a +/// different name and then [`move_file`]d into place. +/// +/// # Example +/// +/// ```no_run +/// use software_core::logger::files; +/// +/// let bytes = files::copy_file("settings.json", "backup/settings.json")?; +/// # Ok::<(), software_core::logger::files::Error>(()) +/// ``` +pub fn copy_file(from: impl AsRef, to: impl AsRef) -> Result { + let (from, to) = (from.as_ref(), to.as_ref()); + create_parents(to)?; + + let bytes = fs::copy(from, to).map_err(|source| Error::Copy { + from: from.to_path_buf(), + to: to.to_path_buf(), + source, + })?; + + debug!(from = %from.display(), to = %to.display(), bytes, "file copied"); + Ok(bytes) +} + +/// Copies everything under `from` into `to`, recursively, and returns +/// how many files were copied. +/// +/// Directories are recreated as needed; existing files in `to` are +/// replaced. A symbolic link is followed and its target copied as a +/// plain file, so the result is a directory of real files rather than a +/// tree of links pointing back at the original. +pub fn copy_dir(from: impl AsRef, to: impl AsRef) -> Result { + let (from, to) = (from.as_ref(), to.as_ref()); + let copied = copy_dir_inner(from, to)?; + + debug!(from = %from.display(), to = %to.display(), files = copied, "directory copied"); + Ok(copied) +} + +/// The recursive half of [`copy_dir`], without the event per level. +fn copy_dir_inner(from: &Path, to: &Path) -> Result { + fs::create_dir_all(to).map_err(|source| Error::CreateDir { + path: to.to_path_buf(), + source, + })?; + + let entries = fs::read_dir(from).map_err(|source| Error::Read { + path: from.to_path_buf(), + source, + })?; + + let mut copied = 0; + for entry in entries { + let entry = entry.map_err(|source| Error::Read { + path: from.to_path_buf(), + source, + })?; + + let source_path = entry.path(); + let destination = to.join(entry.file_name()); + + // `file_type` is the entry's own kind, so a link to a directory + // is not a directory here; `metadata` below follows it. + let kind = entry.file_type().map_err(|source| Error::Read { + path: source_path.clone(), + source, + })?; + + let is_dir = if kind.is_symlink() { + fs::metadata(&source_path) + .map_err(|source| Error::Read { + path: source_path.clone(), + source, + })? + .is_dir() + } else { + kind.is_dir() + }; + + if is_dir { + copied += copy_dir_inner(&source_path, &destination)?; + } else { + fs::copy(&source_path, &destination).map_err(|source| Error::Copy { + from: source_path.clone(), + to: destination.clone(), + source, + })?; + copied += 1; + } + } + + Ok(copied) +} + +/// Moves `from` to `to`, creating `to`'s parent directories. +/// +/// A rename when both paths are on the same filesystem, which is atomic +/// and costs nothing whatever the file's size. When they are not — a log +/// directory on a USB stick, say — a rename can't be done at all, so the +/// file is copied and the original removed, which is neither atomic nor +/// free. +pub fn move_file(from: impl AsRef, to: impl AsRef) -> Result<(), Error> { + let (from, to) = (from.as_ref(), to.as_ref()); + create_parents(to)?; + + match fs::rename(from, to) { + Ok(()) => { + debug!(from = %from.display(), to = %to.display(), "file moved"); + Ok(()) + } + Err(source) if source.kind() == std::io::ErrorKind::CrossesDevices => { + copy_file(from, to)?; + remove_file(from)?; + debug!( + from = %from.display(), + to = %to.display(), + "file moved across filesystems by copying" + ); + Ok(()) + } + Err(source) => Err(Error::Move { + from: from.to_path_buf(), + to: to.to_path_buf(), + source, + }), + } +} + +/// Removes the file at `path`. +/// +/// A file that isn't there is an error, like it is in [`std::fs`]: the +/// caller is the one who knows whether that was expected. +pub fn remove_file(path: impl AsRef) -> Result<(), Error> { + let path = path.as_ref(); + + fs::remove_file(path).map_err(|source| Error::Remove { + path: path.to_path_buf(), + source, + })?; + + debug!(path = %path.display(), "file removed"); + Ok(()) +} + +/// How many bytes the file at `path` holds. +pub fn size(path: impl AsRef) -> Result { + let path = path.as_ref(); + + let metadata = fs::metadata(path).map_err(|source| Error::Read { + path: path.to_path_buf(), + source, + })?; + + Ok(metadata.len()) +} + +/// Creates the directories a file is going to live in. +fn create_parents(path: &Path) -> Result<(), Error> { + let Some(parent) = path.parent() else { + return Ok(()); + }; + + // An empty parent is what `Path::parent` gives for a bare file name: + // the current directory, which already exists. + if parent.as_os_str().is_empty() { + return Ok(()); + } + + fs::create_dir_all(parent).map_err(|source| Error::CreateDir { + path: parent.to_path_buf(), + source, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + type TestResult = Result>; + + #[test] + fn copying_creates_the_directories_the_destination_needs() -> TestResult { + let temp = tempfile::tempdir()?; + let from = temp.path().join("settings.json"); + let to = temp.path().join("backup/2026/settings.json"); + fs::write(&from, "{}\n")?; + + let bytes = copy_file(&from, &to)?; + + assert_eq!(bytes, 3); + assert_eq!(fs::read_to_string(&to)?, "{}\n"); + Ok(()) + } + + #[test] + fn copying_over_an_existing_file_replaces_it() -> TestResult { + let temp = tempfile::tempdir()?; + let from = temp.path().join("new.csv"); + let to = temp.path().join("old.csv"); + fs::write(&from, "new\n")?; + fs::write(&to, "a much longer old file\n")?; + + copy_file(&from, &to)?; + + assert_eq!(fs::read_to_string(&to)?, "new\n"); + Ok(()) + } + + #[test] + fn a_failed_copy_names_both_paths() -> TestResult { + let temp = tempfile::tempdir()?; + let from = temp.path().join("missing.csv"); + let to = temp.path().join("copy.csv"); + + let Err(error) = copy_file(&from, &to) else { + unreachable!("the source was never written"); + }; + + let Error::Copy { + from: named_from, + to: named_to, + .. + } = &error + else { + unreachable!("a failed copy is an Error::Copy, got {error:?}"); + }; + assert_eq!(named_from, &from); + assert_eq!(named_to, &to); + Ok(()) + } + + #[test] + fn copying_a_directory_walks_into_its_subdirectories() -> TestResult { + let temp = tempfile::tempdir()?; + let from = temp.path().join("session"); + let to = temp.path().join("copy"); + fs::create_dir_all(from.join("data/lcu"))?; + fs::write(from.join("session.json"), "{}\n")?; + fs::write(from.join("data/lcu/speed.csv"), "t,value\n")?; + fs::write(from.join("data/lcu/current.csv"), "t,value\n")?; + + let copied = copy_dir(&from, &to)?; + + assert_eq!(copied, 3); + assert_eq!(fs::read_to_string(to.join("session.json"))?, "{}\n"); + assert_eq!( + fs::read_to_string(to.join("data/lcu/speed.csv"))?, + "t,value\n" + ); + Ok(()) + } + + #[test] + fn copying_a_directory_that_is_not_there_names_it() -> TestResult { + let temp = tempfile::tempdir()?; + let from = temp.path().join("not-a-session"); + + let Err(error) = copy_dir(&from, temp.path().join("copy")) else { + unreachable!("that directory was never created"); + }; + + assert!(matches!(&error, Error::Read { path, .. } if path == &from)); + Ok(()) + } + + #[test] + fn moving_leaves_nothing_behind() -> TestResult { + let temp = tempfile::tempdir()?; + let from = temp.path().join("session.json"); + let to = temp.path().join("done/session.json"); + fs::write(&from, "{}\n")?; + + move_file(&from, &to)?; + + assert!(!from.exists()); + assert_eq!(fs::read_to_string(&to)?, "{}\n"); + Ok(()) + } + + #[test] + fn size_and_remove_report_which_file_was_missing() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("data.csv"); + fs::write(&path, "t,value\n")?; + + assert_eq!(size(&path)?, 8); + remove_file(&path)?; + + let Err(error) = size(&path) else { + unreachable!("the file was just removed"); + }; + assert!(matches!(&error, Error::Read { path: named, .. } if named == &path)); + + let Err(error) = remove_file(&path) else { + unreachable!("the file was just removed"); + }; + assert!(matches!(&error, Error::Remove { path: named, .. } if named == &path)); + Ok(()) + } + + #[test] + fn a_bare_file_name_has_no_directory_to_create() -> TestResult { + // `Path::parent` of a bare name is an empty path, which must not + // reach `create_dir_all` — it would fail, and the directory the + // file is going into (the current one) is already there. + create_parents(Path::new("bare.txt"))?; + Ok(()) + } +} diff --git a/backend/crates/core/src/logger/files/error.rs b/backend/crates/core/src/logger/files/error.rs new file mode 100644 index 000000000..bf3bfeb41 --- /dev/null +++ b/backend/crates/core/src/logger/files/error.rs @@ -0,0 +1,66 @@ +//! Errors produced by the operations in [`crate::logger::files`]. +//! +//! Every variant names the file it happened on, and the two that work on +//! a pair of paths name **both**: "couldn't copy" without saying where to +//! leaves the caller with nothing to act on, and the destination is the +//! half that is usually wrong. + +use std::path::PathBuf; + +/// An error working with a file. +#[derive(Debug, thiserror::Error)] +pub enum Error { + /// Couldn't copy the file. + #[error("couldn't copy {from:?} to {to:?}")] + Copy { + /// The file being copied. + from: PathBuf, + /// Where it was being copied to. + to: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't move the file. + #[error("couldn't move {from:?} to {to:?}")] + Move { + /// The file being moved. + from: PathBuf, + /// Where it was being moved to. + to: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't create a directory. + #[error("couldn't create the directory {path:?}")] + CreateDir { + /// The directory that couldn't be created. + path: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't read the file, the directory, or their metadata. + #[error("couldn't read {path:?}")] + Read { + /// The file or directory that couldn't be read. + path: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, + + /// Couldn't remove the file. + #[error("couldn't remove {path:?}")] + Remove { + /// The file that couldn't be removed. + path: PathBuf, + /// The underlying I/O error. + #[source] + source: std::io::Error, + }, +} diff --git a/backend/crates/core/src/logger/host.rs b/backend/crates/core/src/logger/host.rs new file mode 100644 index 000000000..68ffac93e --- /dev/null +++ b/backend/crates/core/src/logger/host.rs @@ -0,0 +1,480 @@ +//! What the operating system will say about who is running this and +//! where. +//! +//! Part of [`crate::logger`] because it is part of a recording, but +//! not of how one is written: this is the *content* of a recording's +//! metadata, not a way of putting bytes on a disk. Nothing in +//! `logger`'s three formats — nor in [`crate::logger::files`] — uses +//! this module; they still write files without knowing what is in them, +//! and that is worth keeping. +//! +//! One snapshot, [`crate::logger::host::HostInfo::collect`], meant to be written into a +//! recording's metadata so that months later it is still possible to +//! answer *which machine produced this, running which build, and with +//! whose clock and locale*. Every field is optional and nothing here +//! returns a [`Result`]: what the system won't say is simply absent, +//! because a recording must never fail to start over a missing user +//! name. +//! +//! What is deliberately not here: free disk space and memory (another +//! dependency, and the disk is better checked by whoever is about to +//! fill it), the battery, and the network interfaces the backend bound +//! to — that last one belongs to whatever opened the sockets, which is +//! the only thing that actually knows. + +use serde::Serialize; +use std::env; +use std::path::PathBuf; +use std::time::{SystemTime, UNIX_EPOCH}; +use tracing::debug; + +/// Who and what produced a recording. +/// +/// Built with [`HostInfo::collect`] and serialized straight into a +/// metadata file. It is a *snapshot*: the values are read once, when it +/// is built, and never refreshed. +/// +/// Serialize-only on purpose. Reading one back is reading JSON, not +/// rebuilding this struct, and a field like [`HostInfo::os`] is a +/// compile-time constant of the build that wrote it rather than +/// something to parse. +#[derive(Debug, Clone, Serialize)] +pub struct HostInfo { + /// The login name (`javier`), from the operating system. + #[serde(skip_serializing_if = "Option::is_none")] + pub user: Option, + + /// The user's full name as the operating system knows it + /// (`Javier Ribal del Río`), which is not the login name. + #[serde(skip_serializing_if = "Option::is_none")] + pub real_name: Option, + + /// `user.name` from the global git configuration. + #[serde(skip_serializing_if = "Option::is_none")] + pub git_name: Option, + + /// An email address for whoever is running this. See + /// [`HostInfo::collect`] for where it is looked for, and why no + /// operating system is one of the places. + #[serde(skip_serializing_if = "Option::is_none")] + pub email: Option, + + /// The machine's name: the one a person would recognize if the + /// system has one, and its network hostname otherwise. + #[serde(skip_serializing_if = "Option::is_none")] + pub host: Option, + + /// The operating system this was built for: `linux`, `macos`, + /// `windows`. + pub os: &'static str, + + /// The processor architecture this was built for: `x86_64`, + /// `aarch64`. + pub arch: &'static str, + + /// The operating system's own name for itself, with its version: + /// `Fedora Linux 44`, `macOS 15.1`, `Windows 11`. + #[serde(skip_serializing_if = "Option::is_none")] + pub distro: Option, + + /// How many threads the machine can actually run at once. + #[serde(skip_serializing_if = "Option::is_none")] + pub cpus: Option, + + /// The version of `software-core` that wrote this. The version of + /// the *binary* is the binary's own to add: this crate can only see + /// its own. + pub core_version: &'static str, + + /// Whether this was built without optimizations and with debug + /// assertions on, which is worth knowing before reading anything + /// into the timings of a recording. + pub debug_build: bool, + + /// The process id, for pairing a recording with whatever else was + /// logging at the time. + pub pid: u32, + + /// The binary that is running, which says which build this was far + /// more precisely than a version number does. + #[serde(skip_serializing_if = "Option::is_none")] + pub exe: Option, + + /// The arguments it was started with, without the program name + /// (which is [`HostInfo::exe`]). Usually this is where the + /// configuration file is named. + pub args: Vec, + + /// The directory it was started from, which is what any relative + /// path in those arguments was resolved against. + #[serde(skip_serializing_if = "Option::is_none")] + pub working_dir: Option, + + /// The time zone the machine is in, as a name like `Europe/Madrid`. + /// + /// Worth more here than it looks: protections and messages carry a + /// time of day and no date or zone, so without knowing the zone of + /// the machine that recorded them they can't be placed on a real + /// timeline, or lined up against video or another machine's log. + #[serde(skip_serializing_if = "Option::is_none")] + pub timezone: Option, + + /// The locale, which decides how dates and numbers get formatted by + /// anything that reads this with the system's settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub locale: Option, + + /// When the snapshot was taken, in seconds since the Unix epoch. + #[serde(skip_serializing_if = "Option::is_none")] + pub started_at_unix: Option, + + /// How many files this process is allowed to have open at once. See + /// [`open_file_limit`], which is the reason this field exists. + #[serde(skip_serializing_if = "Option::is_none")] + pub open_file_limit: Option, +} + +impl HostInfo { + /// Reads everything the system will say, right now. + /// + /// Never fails and never panics: each field is attempted on its own + /// and left empty if it can't be read. + /// + /// The email is looked for in four places, in this order: `user.email` + /// in the global git configuration, then `$GIT_AUTHOR_EMAIL`, then + /// `$EMAIL`, then the account name if it happens to look like an + /// address. **No operating system exposes an email address + /// portably** — macOS keeps one in Contacts and Windows only knows + /// one on a domain-joined machine — so git's own identity is used + /// instead, which is both reliable on a developer's machine and the + /// identity the person is already known by. The git configuration is + /// only read with the `git` feature on; without it, the environment + /// variables are all that is left. + /// + /// # Example + /// + /// ``` + /// use software_core::logger::host::HostInfo; + /// + /// let host = HostInfo::collect(); + /// println!("{}", serde_json::to_string_pretty(&host)?); + /// # Ok::<(), serde_json::Error>(()) + /// ``` + pub fn collect() -> Self { + let git = git_identity(); + + let info = Self { + user: whoami::username().ok(), + real_name: whoami::realname().ok(), + git_name: git.name, + email: git + .email + .or_else(|| var("GIT_AUTHOR_EMAIL")) + .or_else(|| var("EMAIL")) + .or_else(account_email), + host: device_name(), + os: env::consts::OS, + arch: env::consts::ARCH, + distro: whoami::distro().ok(), + cpus: std::thread::available_parallelism().ok().map(Into::into), + core_version: env!("CARGO_PKG_VERSION"), + debug_build: cfg!(debug_assertions), + pid: std::process::id(), + exe: env::current_exe().ok(), + // `args_os`, not `args`: the latter panics on an argument + // that isn't valid Unicode, and nothing in here is allowed + // to bring the process down. + args: env::args_os() + .skip(1) + .map(|arg| arg.to_string_lossy().into_owned()) + .collect(), + working_dir: env::current_dir().ok(), + timezone: timezone(), + locale: locale(), + started_at_unix: unix_seconds(), + open_file_limit: open_file_limit(), + }; + + debug!( + user = ?info.user, + host = ?info.host, + os = info.os, + open_file_limit = ?info.open_file_limit, + "host snapshot taken" + ); + info + } + + /// The same snapshot with everything that identifies a person + /// removed: the user name, the real name, the git name, the email + /// and the machine's name. + /// + /// For when a recording is going to be shared outside the team and + /// only the machine and the build matter. + pub fn without_identity(mut self) -> Self { + self.user = None; + self.real_name = None; + self.git_name = None; + self.email = None; + self.host = None; + self + } +} + +/// The soft limit on how many files this process may have open at once. +/// +/// Worth checking before opening a file per measurement: the default on +/// macOS is **256**, and on Linux usually 1024. Past it, opening a file +/// starts failing in the middle of a recording, which looks like a disk +/// problem and isn't one. +/// +/// `None` on Windows, honestly rather than as a failure: it has no +/// equivalent limit for the handles Rust's [`std::fs::File`] uses. +#[cfg(unix)] +pub fn open_file_limit() -> Option { + rlimit::getrlimit(rlimit::Resource::NOFILE) + .ok() + .map(|(soft, _hard)| soft) +} + +/// The soft limit on how many files this process may have open at once, +/// which Windows does not define for the handles [`std::fs::File`] uses. +#[cfg(not(unix))] +pub fn open_file_limit() -> Option { + None +} + +/// The machine's name. +/// +/// The pretty name first — what a desktop shows, from +/// `/etc/machine-info` on Linux and the sharing name on macOS and +/// Windows — and the network hostname when there isn't one, which on a +/// plain Linux install is the usual case. +fn device_name() -> Option { + whoami::devicename().or_else(|_| whoami::hostname()).ok() +} + +/// The time zone the machine is in, as a zone name. +/// +/// `$TZ` when it is set, which on Linux it usually isn't: the system zone +/// lives in `/etc/localtime`, a link into the zone database whose target +/// ends in the name (`/usr/share/zoneinfo/Europe/Madrid`). Reading the +/// link is how every other tool finds it. Windows keeps its zones under +/// different names entirely and isn't read here, so there it comes down +/// to `$TZ`. +/// +/// A *name* and not an offset on purpose: the offset depends on the date, +/// and the recording this ends up next to may well straddle the day +/// summer time changes. +fn timezone() -> Option { + if let Some(from_environment) = var("TZ") { + return Some(from_environment); + } + + let target = std::fs::read_link("/etc/localtime").ok()?; + + zone_from_link(&target.to_string_lossy()) +} + +/// The zone name at the end of a link into the zone database, or `None` +/// if the target doesn't look like one. +fn zone_from_link(target: &str) -> Option { + let (_, zone) = target.rsplit_once("zoneinfo/")?; + + (!zone.is_empty()).then(|| zone.to_string()) +} + +/// An environment variable, if it is set to something that isn't empty. +fn var(name: &str) -> Option { + let value = env::var_os(name)?; + let value = value.to_string_lossy().trim().to_string(); + + (!value.is_empty()).then_some(value) +} + +/// Seconds since the Unix epoch, or `None` if the clock is set before +/// 1970. +fn unix_seconds() -> Option { + SystemTime::now() + .duration_since(UNIX_EPOCH) + .ok() + .map(|since| since.as_secs()) +} + +/// The locale, from the environment first and from the operating +/// system's own language preferences otherwise — which is what a machine +/// with no `LANG` set, meaning most Windows and macOS desktops, needs. +fn locale() -> Option { + if let Some(from_environment) = var("LC_ALL").or_else(|| var("LANG")) { + return Some(from_environment); + } + + let preferences = whoami::lang_prefs().ok()?; + preferences.time_langs().next().map(|lang| lang.to_string()) +} + +/// Some accounts are named after an email address — a domain-joined +/// Windows account, a managed macOS one — and that is the one place an +/// operating system does hand one over. When the account name looks like +/// an address, take it as one. +fn account_email() -> Option { + whoami::account() + .ok() + .filter(|account| account.contains('@')) +} + +/// The name and email git would sign a commit with on this machine. +#[derive(Debug, Default)] +struct GitIdentity { + /// `user.name`, if it is set. + name: Option, + /// `user.email`, if it is set. + email: Option, +} + +/// Reads `user.name` and `user.email` from the git configuration. +/// +/// Global and system files only. No repository is opened: the identity +/// wanted here is the person's, and it must not depend on which +/// directory the backend happens to have been started from. A global +/// `includeIf` makes this fail, since resolving one needs a repository — +/// hence an empty identity rather than an error. +#[cfg(feature = "git")] +fn git_identity() -> GitIdentity { + let Ok(config) = gix::config::File::from_globals() else { + return GitIdentity::default(); + }; + + let value = |key| { + let raw = config.string(key)?; + let text = String::from_utf8_lossy(&raw).trim().to_string(); + (!text.is_empty()).then_some(text) + }; + + GitIdentity { + name: value("user.name"), + email: value("user.email"), + } +} + +/// Without the `git` feature there is no git configuration to read, so +/// the identity is left to the environment variables. +#[cfg(not(feature = "git"))] +fn git_identity() -> GitIdentity { + GitIdentity::default() +} + +#[cfg(test)] +mod tests { + use super::*; + + type TestResult = Result>; + + #[test] + fn a_snapshot_fills_in_what_the_build_already_knows() -> TestResult { + let host = HostInfo::collect(); + + // The fields that can't be missing, because they are decided at + // compile time or by the process itself. Everything else depends + // on the machine the tests run on and is not asserted here. + assert!(!host.os.is_empty()); + assert!(!host.arch.is_empty()); + assert!(!host.core_version.is_empty()); + assert!(host.pid > 0); + assert_eq!(host.debug_build, cfg!(debug_assertions)); + Ok(()) + } + + #[test] + fn a_snapshot_serializes_without_the_fields_it_could_not_read() -> TestResult { + let host = HostInfo { + user: None, + real_name: None, + git_name: None, + email: None, + host: None, + distro: None, + cpus: None, + exe: None, + working_dir: None, + timezone: None, + locale: None, + started_at_unix: None, + open_file_limit: None, + ..HostInfo::collect() + }; + + let json = serde_json::to_string(&host)?; + + assert!(!json.contains("null"), "{json}"); + assert!(json.contains("\"os\""), "{json}"); + Ok(()) + } + + #[test] + fn without_identity_leaves_the_machine_and_takes_the_person() -> TestResult { + let host = HostInfo { + user: Some("javier".into()), + real_name: Some("Javier".into()), + git_name: Some("Javier".into()), + email: Some("someone@example.test".into()), + host: Some("a-laptop".into()), + ..HostInfo::collect() + } + .without_identity(); + + assert_eq!(host.user, None); + assert_eq!(host.real_name, None); + assert_eq!(host.git_name, None); + assert_eq!(host.email, None); + assert_eq!(host.host, None); + + // The machine and the build survive, which is the point. + assert!(!host.os.is_empty()); + assert!(!host.core_version.is_empty()); + Ok(()) + } + + #[test] + fn unix_reports_a_file_limit_and_windows_says_nothing() -> TestResult { + let limit = open_file_limit(); + + if cfg!(unix) { + let Some(limit) = limit else { + unreachable!("every unix defines RLIMIT_NOFILE"); + }; + assert!(limit > 0); + } else { + assert_eq!(limit, None); + } + Ok(()) + } + + #[test] + fn a_zone_name_is_whatever_follows_the_zone_database() -> TestResult { + assert_eq!( + zone_from_link("/usr/share/zoneinfo/Europe/Madrid").as_deref(), + Some("Europe/Madrid") + ); + // Relative links are just as common as absolute ones. + assert_eq!( + zone_from_link("../usr/share/zoneinfo/UTC").as_deref(), + Some("UTC") + ); + + // Nothing that isn't a zone database link. + assert_eq!(zone_from_link("/etc/localtime"), None); + assert_eq!(zone_from_link("/usr/share/zoneinfo/"), None); + Ok(()) + } + + #[test] + fn a_variable_that_is_not_set_reads_as_none() -> TestResult { + // The other half of `var` — that a variable set to an empty or + // blank string also reads as `None` — can't be tested here: + // setting an environment variable is `unsafe` in this edition, + // and this crate forbids `unsafe`. + assert_eq!(var("SOFTWARE_CORE_UTILS_HOST_UNSET"), None); + Ok(()) + } +} diff --git a/backend/crates/core/src/logger/json.rs b/backend/crates/core/src/logger/json.rs new file mode 100644 index 000000000..b2b78510a --- /dev/null +++ b/backend/crates/core/src/logger/json.rs @@ -0,0 +1,619 @@ +//! JSON documents: written whole, read back whole, and updated by +//! being replaced. +//! +//! Two ways in, for two different jobs. [`write_json`] and [`read_json`] +//! are one-shot and typed: the caller has a type for the whole document +//! and hands it over, or gets it back. [`JsonDocument`] is for the file +//! that gains properties over time — a recording's metadata, written +//! when it starts and added to when it stops — which has to be read +//! before it can be added to, and whose properties this crate knows +//! nothing about have to survive the round trip all the same. +//! +//! Reading is deliberate here and nowhere else in the module: a JSON +//! document is small, whole and structured, so reading it back to change +//! it is the only way to change it. A CSV or a text log is appended to, +//! never revisited, and nothing here will read one back. +//! +//! None of this keeps a file open between calls, which is why nothing +//! here uses the `Target` that `csv` and `text` are built on: a document +//! lives in memory, and getting it onto the disk is one atomic +//! replacement, the same one [`write_json`] performs. + +use super::Error; +use super::target::create_file; +use serde::Serialize; +use serde::de::DeserializeOwned; +use serde_json::{Map, Value}; +use std::ffi::OsString; +use std::fs; +use std::io::Write; +use std::path::{Path, PathBuf}; +use tracing::debug; + +/// Writes `value` to `path` as pretty-printed JSON, creating its parent +/// directories and replacing whatever was there. +/// +/// Pretty-printed, with a trailing newline, because these are the files +/// a person opens to find out what a recording was: a session's +/// metadata, the ADJ commit it ran against, a dump of the configuration +/// in use. Anything appended to over time wants a CSV +/// ([`super::CsvFile`]) instead — this function writes the file once and +/// closes it. +/// +/// Written through a temporary file next to the destination, flushed to +/// the disk and then renamed over it, so `path` is never seen +/// half-written: either the old contents or the new ones, nothing in +/// between. That matters more here than anywhere else in this module — +/// a fatal error in the backend ends in `std::process::exit`, and a +/// session's metadata truncated at that moment is what makes every CSV +/// next to it unreadable. The rename needs both files on the same +/// filesystem, which they are by construction, being siblings. What +/// isn't covered: the directory entry itself isn't synced, so a power +/// cut in the instant after the rename can still lose it — surviving +/// that would mean syncing the directory too, which isn't worth it for +/// what this writes. +/// +/// # Example +/// +/// ``` +/// use software_core::logger::write_json; +/// use std::collections::BTreeMap; +/// +/// let path = std::env::temp_dir().join("software-core-logger-doc/write.json"); +/// let settings = BTreeMap::from([("adj_commit", "4f1c3b0"), ("time_unit", "us")]); +/// +/// write_json(&path, &settings)?; +/// +/// assert_eq!( +/// std::fs::read_to_string(&path)?, +/// "{\n \"adj_commit\": \"4f1c3b0\",\n \"time_unit\": \"us\"\n}\n", +/// ); +/// # std::fs::remove_file(&path)?; +/// # Ok::<(), Box>(()) +/// ``` +pub fn write_json(path: impl AsRef, value: &T) -> Result<(), Error> +where + T: Serialize + ?Sized, +{ + let path = path.as_ref(); + let temporary = temporary_path(path); + + // Anything that fails from here on leaves the destination untouched, + // so the temporary file is cleaned up and the error is about `path`, + // which is the file the caller asked for and the only one it knows. + match build(&temporary, path, value) { + Ok(()) => {} + Err(error) => { + // Best effort: the write already failed, and failing to + // remove the leftover is not what the caller needs to hear. + let _ = fs::remove_file(&temporary); + return Err(error); + } + } + + fs::rename(&temporary, path).map_err(|source| Error::Replace { + path: path.to_path_buf(), + source, + })?; + + debug!(path = %path.display(), "json file written"); + Ok(()) +} + +/// Serializes `value` into `temporary` and gets it onto the disk, with +/// every error reported against `path`, the destination it is about to +/// be renamed to. +fn build(temporary: &Path, path: &Path, value: &T) -> Result<(), Error> +where + T: Serialize + ?Sized, +{ + // `create_file` reports the file it actually tried to make: the + // temporary one, which the caller never named. Every error out of + // here is about the destination, so put its path back. + let mut writer = create_file(temporary).map_err(|error| match error { + Error::Create { source, .. } => Error::Create { + path: path.to_path_buf(), + source, + }, + other => other, + })?; + + serde_json::to_writer_pretty(&mut writer, value).map_err(|source| Error::Serialize { + path: path.to_path_buf(), + source, + })?; + + // `to_writer_pretty` leaves no terminator: add one so the file reads + // well with `cat` and behaves for anything line-oriented. + writer.write_all(b"\n").map_err(|source| Error::Write { + label: path.display().to_string(), + source, + })?; + + // The buffer is dropped with this function, and a drop swallows the + // flush error — so flush here, where it can still be reported. + writer.flush().map_err(|source| Error::Flush { + label: path.display().to_string(), + source, + })?; + + // Flushing only hands the bytes to the operating system. Syncing + // before the rename is what makes the swap meaningful: otherwise the + // rename can be on the disk while the contents it points at are + // still only in the page cache. Affordable here, where it happens + // once per file, in a way it wouldn't be per CSV row. + writer.get_ref().sync_all().map_err(|source| Error::Flush { + label: path.display().to_string(), + source, + }) +} + +/// The temporary name a document is built under: the destination's own +/// name plus `.tmp`, so it lands in the same directory — and therefore +/// the same filesystem, which [`fs::rename`] needs to be atomic. +fn temporary_path(path: &Path) -> PathBuf { + let mut name = OsString::from(path); + name.push(".tmp"); + PathBuf::from(name) +} + +/// Reads `path` and parses the whole document as `T`. +/// +/// The counterpart of [`write_json`], for a document whose shape the +/// caller has a type for. To read one property out of a document, or to +/// add properties to it, use [`JsonDocument`] instead. +/// +/// # Example +/// +/// ``` +/// use software_core::logger::{read_json, write_json}; +/// use std::collections::BTreeMap; +/// +/// let path = std::env::temp_dir().join("software-core-logger-doc/read.json"); +/// let written = BTreeMap::from([("time_unit".to_string(), "us".to_string())]); +/// write_json(&path, &written)?; +/// +/// let read: BTreeMap = read_json(&path)?; +/// assert_eq!(read, written); +/// # std::fs::remove_file(&path)?; +/// # Ok::<(), Box>(()) +/// ``` +pub fn read_json(path: impl AsRef) -> Result +where + T: DeserializeOwned, +{ + let path = path.as_ref(); + let text = read_text(path)?; + + serde_json::from_str(&text).map_err(|source| Error::Parse { + path: path.to_path_buf(), + source, + }) +} + +/// A JSON object held in memory, together with the file it came from. +/// +/// For the document that is added to over time instead of written once: +/// open it, set the properties that are known now, save, and later open +/// it again and set the ones that weren't. Properties nobody here knows +/// about are kept as they were — the document is edited, not rebuilt +/// from a struct that would have dropped them. +/// +/// Changes stay in memory until [`JsonDocument::save`], which replaces +/// the file atomically. Nothing is held open in between, so a document +/// can be opened, saved and forgotten without any flushing discipline. +/// +/// Properties come out in alphabetical order, which is `serde_json`'s +/// own ordering for an object and not something this type imposes: the +/// same document always serializes the same way, which is what makes it +/// readable in a diff. +/// +/// # Example +/// +/// ``` +/// use software_core::logger::JsonDocument; +/// +/// let path = std::env::temp_dir().join("software-core-logger-doc/document.json"); +/// +/// let mut session = JsonDocument::new(&path); +/// session +/// .set("adj_commit", "4f1c3b0")? +/// .set("time_unit", "us")?; +/// session.save()?; +/// +/// // Later, when the recording stops, by whoever has the path. +/// let mut session = JsonDocument::open(&path)?; +/// session.set("rows", 128_000u64)?.set("stopped", true)?; +/// session.save()?; +/// +/// let session = JsonDocument::open(&path)?; +/// assert_eq!(session.get::("adj_commit")?.as_deref(), Some("4f1c3b0")); +/// assert_eq!(session.get::("rows")?, Some(128_000)); +/// # std::fs::remove_file(&path)?; +/// # Ok::<(), Box>(()) +/// ``` +#[derive(Debug, Clone)] +pub struct JsonDocument { + path: PathBuf, + properties: Map, +} + +impl JsonDocument { + /// An empty document for `path`, which isn't touched until + /// [`JsonDocument::save`]. + pub fn new(path: impl Into) -> Self { + Self { + path: path.into(), + properties: Map::new(), + } + } + + /// Reads the document at `path`. + /// + /// Errors if the file isn't there ([`Error::Read`]), isn't valid + /// JSON ([`Error::Parse`]), or is valid JSON whose root isn't an + /// object and therefore has no properties + /// ([`Error::NotAnObject`]). Use [`JsonDocument::open_or_new`] when + /// a missing file just means there is nothing in it yet. + pub fn open(path: impl Into) -> Result { + let path = path.into(); + let text = read_text(&path)?; + + let value: Value = serde_json::from_str(&text).map_err(|source| Error::Parse { + path: path.clone(), + source, + })?; + + match value { + Value::Object(properties) => Ok(Self { path, properties }), + _ => Err(Error::NotAnObject { path }), + } + } + + /// Like [`JsonDocument::open`], but a file that isn't there yet + /// gives an empty document instead of an error. + /// + /// Only a missing file is forgiven: one that exists and is broken + /// still errors, rather than quietly starting over and overwriting + /// it on the next save. + pub fn open_or_new(path: impl Into) -> Result { + let path = path.into(); + + match Self::open(&path) { + Err(Error::Read { source, .. }) if source.kind() == std::io::ErrorKind::NotFound => { + Ok(Self::new(path)) + } + other => other, + } + } + + /// Sets `key`, replacing whatever was there. + /// + /// Takes anything serializable, so a property can be a number, a + /// string, a list or a whole struct. Returns `&mut Self` so several + /// can be chained: `doc.set("a", 1)?.set("b", 2)?;`. + pub fn set( + &mut self, + key: impl Into, + value: impl Serialize, + ) -> Result<&mut Self, Error> { + let value = serde_json::to_value(value).map_err(|source| Error::Serialize { + path: self.path.clone(), + source, + })?; + + self.properties.insert(key.into(), value); + Ok(self) + } + + /// Reads `key` as `T`, or `None` if the document has no such + /// property. + /// + /// Errors with [`Error::Parse`] if the property is there but isn't a + /// `T`. + pub fn get(&self, key: &str) -> Result, Error> + where + T: DeserializeOwned, + { + let Some(value) = self.properties.get(key) else { + return Ok(None); + }; + + serde_json::from_value(value.clone()) + .map(Some) + .map_err(|source| Error::Parse { + path: self.path.clone(), + source, + }) + } + + /// Whether the document has a `key` property. + pub fn contains(&self, key: &str) -> bool { + self.properties.contains_key(key) + } + + /// Removes `key`, reporting whether it was there. + pub fn remove(&mut self, key: &str) -> bool { + self.properties.remove(key).is_some() + } + + /// Every property, as they will be written. + pub fn properties(&self) -> &Map { + &self.properties + } + + /// The file this document is read from and saved to. + pub fn path(&self) -> &Path { + &self.path + } + + /// Writes the document back, replacing the file atomically. + pub fn save(&self) -> Result<(), Error> { + write_json(&self.path, &self.properties) + } +} + +/// Reads a whole file as text, naming it in the error. +fn read_text(path: &Path) -> Result { + fs::read_to_string(path).map_err(|source| Error::Read { + path: path.to_path_buf(), + source, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use serde::Serializer; + use std::collections::BTreeMap; + use std::fs; + + type TestResult = Result>; + + fn settings() -> BTreeMap { + BTreeMap::from([ + ("adj_commit".to_string(), "4f1c3b0".to_string()), + ("time_unit".to_string(), "us".to_string()), + ]) + } + + #[test] + fn writes_pretty_json_with_a_trailing_newline_creating_the_parents() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("session/others/settings.json"); + + write_json(&path, &settings())?; + + assert_eq!( + fs::read_to_string(&path)?, + "{\n \"adj_commit\": \"4f1c3b0\",\n \"time_unit\": \"us\"\n}\n" + ); + Ok(()) + } + + #[test] + fn what_was_written_parses_back_to_the_same_value() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("settings.json"); + + write_json(&path, &settings())?; + + let read: BTreeMap = serde_json::from_str(&fs::read_to_string(&path)?)?; + assert_eq!(read, settings()); + Ok(()) + } + + #[test] + fn writing_replaces_an_existing_file_rather_than_appending() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("settings.json"); + + write_json(&path, &settings())?; + write_json(&path, &BTreeMap::from([("time_unit", "ms")]))?; + + assert_eq!( + fs::read_to_string(&path)?, + "{\n \"time_unit\": \"ms\"\n}\n" + ); + Ok(()) + } + + /// A value that fails halfway through being serialized, to check + /// what the destination looks like when that happens. + #[derive(Debug)] + struct Unserializable; + + impl Serialize for Unserializable { + fn serialize(&self, _serializer: S) -> Result { + Err(serde::ser::Error::custom("not today")) + } + } + + #[test] + fn a_successful_write_leaves_no_temporary_file_behind() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("settings.json"); + + write_json(&path, &settings())?; + + assert!(path.exists()); + assert!(!temporary_path(&path).exists()); + Ok(()) + } + + #[test] + fn a_failed_write_leaves_the_previous_contents_untouched() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("settings.json"); + write_json(&path, &settings())?; + let before = fs::read_to_string(&path)?; + + let Err(error) = write_json(&path, &Unserializable) else { + unreachable!("this value can't be serialized"); + }; + assert!(matches!(error, Error::Serialize { .. })); + + // The destination still holds the old document, whole, and the + // half-written one is gone rather than left next to it. + assert_eq!(fs::read_to_string(&path)?, before); + assert!(!temporary_path(&path).exists()); + Ok(()) + } + + #[test] + fn the_temporary_file_is_a_sibling_so_the_rename_stays_atomic() { + let path = Path::new("/var/log/session/settings.json"); + let temporary = temporary_path(path); + + assert_eq!(temporary.parent(), path.parent()); + assert_eq!(temporary.file_name(), Some("settings.json.tmp".as_ref())); + } + + #[test] + fn read_json_gets_back_what_write_json_put_there() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("settings.json"); + write_json(&path, &settings())?; + + let read: BTreeMap = read_json(&path)?; + + assert_eq!(read, settings()); + Ok(()) + } + + #[test] + fn reading_names_the_file_when_it_is_missing_or_broken() -> TestResult { + let temp = tempfile::tempdir()?; + let missing = temp.path().join("not-there.json"); + let broken = temp.path().join("broken.json"); + fs::write(&broken, "{ not json")?; + + let Err(absent) = read_json::>(&missing) else { + unreachable!("that file was never written"); + }; + assert!(matches!(&absent, Error::Read { path, .. } if path == &missing)); + + let Err(malformed) = read_json::>(&broken) else { + unreachable!("that file is not valid JSON"); + }; + assert!(matches!(&malformed, Error::Parse { path, .. } if path == &broken)); + Ok(()) + } + + #[test] + fn a_document_takes_several_properties_and_reads_them_back() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("session.json"); + + let mut session = JsonDocument::new(&path); + session + .set("adj_commit", "4f1c3b0")? + .set("time_unit", "us")? + .set("rows", 128_000u64)?; + session.save()?; + + let session = JsonDocument::open(&path)?; + assert_eq!( + session.get::("adj_commit")?.as_deref(), + Some("4f1c3b0") + ); + assert_eq!(session.get::("rows")?, Some(128_000)); + assert_eq!(session.get::("never_set")?, None); + assert!(session.contains("time_unit")); + Ok(()) + } + + #[test] + fn adding_properties_keeps_the_ones_already_in_the_file() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("session.json"); + // A document with a property no type in this crate mentions. + fs::write(&path, "{\n \"written_by_someone_else\": [1, 2, 3]\n}\n")?; + + let mut session = JsonDocument::open(&path)?; + session.set("stopped", true)?; + session.save()?; + + let session = JsonDocument::open(&path)?; + assert_eq!( + session.get::>("written_by_someone_else")?, + Some(vec![1, 2, 3]) + ); + assert_eq!(session.get::("stopped")?, Some(true)); + Ok(()) + } + + #[test] + fn a_property_read_as_the_wrong_type_is_an_error_not_a_none() -> TestResult { + let path = Path::new("in-memory.json"); + let mut session = JsonDocument::new(path); + session.set("rows", "not a number")?; + + let Err(error) = session.get::("rows") else { + unreachable!("a string is not a u64"); + }; + + assert!(matches!(&error, Error::Parse { path: named, .. } if named == path)); + Ok(()) + } + + #[test] + fn removing_a_property_reports_whether_it_was_there() -> TestResult { + let mut session = JsonDocument::new("in-memory.json"); + session.set("time_unit", "us")?; + + assert!(session.remove("time_unit")); + assert!(!session.remove("time_unit")); + assert!(session.properties().is_empty()); + Ok(()) + } + + #[test] + fn open_or_new_forgives_a_missing_file_but_not_a_broken_one() -> TestResult { + let temp = tempfile::tempdir()?; + let missing = temp.path().join("session.json"); + let broken = temp.path().join("broken.json"); + fs::write(&broken, "{ not json")?; + + let mut session = JsonDocument::open_or_new(&missing)?; + assert!(session.properties().is_empty()); + session.set("time_unit", "us")?; + session.save()?; + assert!(missing.exists()); + + assert!(matches!( + JsonDocument::open_or_new(&broken), + Err(Error::Parse { .. }) + )); + Ok(()) + } + + #[test] + fn a_document_whose_root_is_not_an_object_has_no_properties_to_add_to() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("list.json"); + fs::write(&path, "[1, 2, 3]\n")?; + + let Err(error) = JsonDocument::open(&path) else { + unreachable!("the root of that document is an array"); + }; + + assert!(matches!(&error, Error::NotAnObject { path: named } if named == &path)); + Ok(()) + } + + #[test] + fn a_path_whose_parent_is_a_file_reports_which_file_it_was() -> TestResult { + let temp = tempfile::tempdir()?; + let blocking = temp.path().join("settings.json"); + write_json(&blocking, &settings())?; + + let path = blocking.join("nested.json"); + let Err(error) = write_json(&path, &settings()) else { + unreachable!("a file can't be used as a directory"); + }; + + assert!(matches!(&error, Error::Create { path: failed, .. } if failed == &path)); + Ok(()) + } +} diff --git a/backend/crates/core/src/logger/target.rs b/backend/crates/core/src/logger/target.rs new file mode 100644 index 000000000..f6bb33325 --- /dev/null +++ b/backend/crates/core/src/logger/target.rs @@ -0,0 +1,242 @@ +//! The handle discipline every file in this module shares: the label +//! that names it in its errors, the poisoning after a failed write, the +//! explicit flush, and the courtesy flush on drop. +//! +//! Private, and not a trait: [`super::CsvFile`] and [`super::TextFile`] +//! differ in what they put *in* a file (columns and quoting versus +//! lines), not in how they hold one. Keeping that part here is what +//! makes "flushing is explicit, and a failed write stops the file" one +//! behaviour rather than two copies of it that can drift. + +use super::Error; +use std::fs::{self, File, OpenOptions}; +use std::io::{BufWriter, Read, Seek, SeekFrom, Write}; +use std::path::Path; +use tracing::error; + +/// An open destination, plus the name it answers to in errors. +#[derive(Debug)] +pub(super) struct Target { + inner: W, // The actual file or buffer being written to. + label: String, // + poisoned: bool, // Whether a write or flush failed, so all future writes fail too. + closed: bool, // Whether the caller has called `close()`, so `Drop` doesn't flush again. + written: u64, // Total bytes written to the destination so far. + since_flush: u64, // Bytes written since the last successful flush, for the caller to decide when to flush. +} + +impl Target { + /// Takes over an already-open destination, to be called `label` in + /// any [`Error`] about it. + pub(super) fn new(inner: W, label: String) -> Self { + Self { + inner, + label, + poisoned: false, + closed: false, + written: 0, + since_flush: 0, + } + } + + /// What this destination is called in its errors. + pub(super) fn label(&self) -> &str { + &self.label + } + + /// Borrows the destination itself. + pub(super) fn get_ref(&self) -> &W { + &self.inner + } + + /// Whether an earlier write or flush failed. + pub(super) fn is_poisoned(&self) -> bool { + self.poisoned + } + + /// Every byte handed to the destination so far. + pub(super) fn bytes_written(&self) -> u64 { + self.written + } + + /// The bytes handed over since the last successful flush. + pub(super) fn bytes_since_flush(&self) -> u64 { + self.since_flush + } + + /// The error to return instead of touching a poisoned destination. + pub(super) fn poisoned_error(&self) -> Error { + Error::Poisoned { + label: self.label.clone(), + } + } + + /// Writes `bytes` in one call, poisoning the destination if it + /// fails: a write that failed halfway already left the file + /// inconsistent. + pub(super) fn write_all(&mut self, bytes: &[u8]) -> Result<(), Error> { + if self.poisoned { + return Err(self.poisoned_error()); + } + + match self.inner.write_all(bytes) { + Ok(()) => { + let bytes = bytes.len() as u64; + self.written += bytes; + self.since_flush += bytes; + Ok(()) + } + Err(source) => { + self.poisoned = true; + Err(Error::Write { + label: self.label.clone(), + source, + }) + } + } + } + + /// Flushes everything written so far. + pub(super) fn flush(&mut self) -> Result<(), Error> { + if self.poisoned { + return Err(self.poisoned_error()); + } + + match self.inner.flush() { + Ok(()) => { + self.since_flush = 0; + Ok(()) + } + Err(source) => { + self.poisoned = true; + Err(Error::Flush { + label: self.label.clone(), + source, + }) + } + } + } + + /// Flushes and marks the destination closed, so [`Drop`] neither + /// flushes again nor traces an error the caller is already getting. + pub(super) fn close(&mut self) -> Result<(), Error> { + let result = self.flush(); + self.closed = true; + result + } +} + +impl Drop for Target { + fn drop(&mut self) { + if self.closed || self.poisoned { + return; + } + + // A courtesy flush, nothing more: `Drop` can't return the error + // and the workspace lints rule out panicking, so all it can do + // is leave a trace saying this file's tail may be missing. + if let Err(source) = self.inner.flush() { + error!( + file = %self.label, + error = %source, + "file dropped without close() and its final flush failed" + ); + } + } +} + +/// Creates (or truncates) the file at `path`, creating its parent +/// directories, and wraps it in a buffer. +/// +/// The default [`BufWriter`] capacity is deliberate: a bigger buffer is +/// less I/O but more lost if the process dies before the next flush, and +/// how often to flush is a decision for whoever is writing. +pub(super) fn create_file(path: &Path) -> Result, Error> { + if let Some(parent) = path.parent() { + fs::create_dir_all(parent).map_err(|source| Error::Create { + path: path.to_path_buf(), + source, + })?; + } + + let file = File::create(path).map_err(|source| Error::Create { + path: path.to_path_buf(), + source, + })?; + + Ok(BufWriter::new(file)) +} + +/// Opens `path` to add to the end of it, creating the file and its parent +/// directories if they aren't there. +/// +/// Returns the destination together with how many bytes the file already +/// held, which is what tells a brand new (or empty) file from one that +/// has content in it. +/// +/// If that content doesn't end in a newline, one is written before +/// anything else, so what gets appended starts on its own line instead of +/// being glued onto the last one. That is the only thing looked at: what +/// the existing content *says* is never read or checked. +pub(super) fn append_file(path: &Path) -> Result<(BufWriter, u64), Error> { + if let Some(parent) = path.parent() { + fs::create_dir_all(parent).map_err(|source| Error::Create { + path: path.to_path_buf(), + source, + })?; + } + + let mut file = OpenOptions::new() + // Readable as well as appendable: the last byte has to be looked + // at to know whether a newline is owed. Appending still lands at + // the end of the file however the read leaves the cursor. + .read(true) + .append(true) + .create(true) + .open(path) + .map_err(|source| Error::Create { + path: path.to_path_buf(), + source, + })?; + + let existing = file + .metadata() + .map_err(|source| Error::Read { + path: path.to_path_buf(), + source, + })? + .len(); + + if !ends_with_newline(&mut file, existing, path)? { + // Opened in append mode, so this lands at the end of the file + // wherever the read above left the cursor. + file.write_all(b"\n").map_err(|source| Error::Write { + label: path.display().to_string(), + source, + })?; + } + + Ok((BufWriter::new(file), existing)) +} + +/// Whether the last byte of `file` is a newline. An empty file counts as +/// ending in one: there is no half-written line to finish. +fn ends_with_newline(file: &mut File, len: u64, path: &Path) -> Result { + let Some(last_byte) = len.checked_sub(1) else { + return Ok(true); + }; + + file.seek(SeekFrom::Start(last_byte)) + .map_err(|source| Error::Read { + path: path.to_path_buf(), + source, + })?; + + let mut last = [0u8; 1]; + file.read_exact(&mut last).map_err(|source| Error::Read { + path: path.to_path_buf(), + source, + })?; + + Ok(last[0] == b'\n') +} diff --git a/backend/crates/core/src/logger/text.rs b/backend/crates/core/src/logger/text.rs new file mode 100644 index 000000000..e27d4a8b2 --- /dev/null +++ b/backend/crates/core/src/logger/text.rs @@ -0,0 +1,300 @@ +//! A plain text file, written a line at a time. + +use super::Error; +use super::target::{Target, append_file, create_file}; +use std::fs::File; +use std::io::{BufWriter, Write}; +use std::path::Path; +use tracing::debug; + +/// A text file being written to, one line at a time. +/// +/// Deliberately the same vocabulary as [`crate::logger::CsvFile`] — +/// `create`, `new`, `flush`, `close`, `get_ref`, `is_poisoned`, the same +/// [`Error`], the same poisoning after a failed write and the same +/// courtesy flush on drop — so there is nothing to relearn moving +/// between the two. +/// +/// What it does *not* have is everything that only means something for +/// columns: no header, no field count, no quoting. A line is written +/// exactly as given, with a `\n` after it, and a line that contains a +/// comma or a quote is not special in any way. That also means a text +/// file can't tell you a line came out malformed — if the content has +/// fields in it, it wants [`crate::logger::CsvFile`] instead. +/// +/// # Example +/// +/// ``` +/// use software_core::logger::TextFile; +/// +/// let mut log = TextFile::new(Vec::new(), "in memory"); +/// log.write_line("session started")?; +/// log.write_line("board LCU connected")?; +/// +/// assert_eq!(log.get_ref().as_slice(), b"session started\nboard LCU connected\n"); +/// # Ok::<(), Box>(()) +/// ``` +#[derive(Debug)] +pub struct TextFile> { + target: Target, + /// The line currently being written, reused across lines so writing + /// one allocates nothing. + buf: Vec, +} + +impl TextFile> { + /// Creates (or truncates) the file at `path`, creating its parent + /// directories. + pub fn create(path: impl AsRef) -> Result { + let path = path.as_ref(); + let file = Self::new(create_file(path)?, path.display().to_string()); + debug!(path = %path.display(), "text file created"); + Ok(file) + } + + /// Opens the file at `path` to add lines to the end of it, creating it + /// and its parent directories if they aren't there. + /// + /// Nothing about what the file already contains is read, with one + /// exception: if it doesn't end in a newline, one is written first, so + /// the first new line can't continue a half-finished one. + pub fn append(path: impl AsRef) -> Result { + let path = path.as_ref(); + let (writer, existing) = append_file(path)?; + let file = Self::new(writer, path.display().to_string()); + debug!( + path = %path.display(), + existing_bytes = existing, + "text file opened to append" + ); + Ok(file) + } +} + +impl TextFile { + /// Wraps an already-open destination. + /// + /// `label` is what this file is called in any [`Error`] it produces; + /// [`TextFile::create`] uses the path for it. + /// + /// Unlike [`crate::logger::CsvFile::new`] this can't fail: there is + /// no header to write before the caller's first line. + pub fn new(inner: W, label: impl Into) -> Self { + Self { + target: Target::new(inner, label.into()), + buf: Vec::new(), + } + } + + /// Writes `line`, followed by a `\n`. + /// + /// The line and its terminator reach the destination as a single + /// write, so a line lands whole or not at all — the same guarantee + /// a CSV row gets. + pub fn write_line(&mut self, line: &str) -> Result<(), Error> { + self.buf.clear(); + self.buf.extend_from_slice(line.as_bytes()); + self.buf.push(b'\n'); + self.target.write_all(&self.buf) + } + + /// Flushes everything written so far to the destination. + pub fn flush(&mut self) -> Result<(), Error> { + self.target.flush() + } + + /// Flushes and closes the file, reporting a failure instead of + /// swallowing it like [`Drop`] has to. + pub fn close(mut self) -> Result<(), Error> { + self.target.close() + } + + /// Borrows the destination, e.g. to read back what was written to an + /// in-memory buffer. + pub fn get_ref(&self) -> &W { + self.target.get_ref() + } + + /// Whether an earlier write or flush failed, leaving this file + /// closed to further writes. + pub fn is_poisoned(&self) -> bool { + self.target.is_poisoned() + } + + /// What this file is called in its errors: the path it was created + /// with, or the label it was given. + /// + /// Worth having beyond [`Error`]'s own text: a caller that notices a + /// file went [`TextFile::is_poisoned`] has no error in hand any more, + /// and still needs to say which file stopped. + pub fn label(&self) -> &str { + self.target.label() + } + + /// Every byte handed to the destination so far, line terminators + /// included — the file's size on disk, once flushed. + pub fn bytes_written(&self) -> u64 { + self.target.bytes_written() + } + + /// The bytes written since the last successful flush. + /// + /// This is what a flush policy is built on: "flush every so many + /// kilobytes, or every so often" is the caller's decision (see this + /// module's docs), and this saves it from keeping its own tally for + /// each of the hundreds of files it may have open. + pub fn bytes_since_flush(&self) -> u64 { + self.target.bytes_since_flush() + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::fs; + + type TestResult = Result>; + + fn written(text: &TextFile>) -> String { + String::from_utf8_lossy(text.get_ref()).into_owned() + } + + /// A destination that takes `ok_writes` writes and fails every one + /// after that — what a full disk looks like from in here. + #[derive(Debug)] + struct FailsAfter { + ok_writes: usize, + } + + impl Write for FailsAfter { + fn write(&mut self, buf: &[u8]) -> std::io::Result { + if self.ok_writes == 0 { + return Err(std::io::Error::other("disk full")); + } + self.ok_writes -= 1; + Ok(buf.len()) + } + + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + #[test] + fn appending_keeps_the_lines_that_were_already_there() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("output/build.txt"); + + let mut log = TextFile::create(&path)?; + log.write_line("compiling")?; + log.close()?; + + let mut log = TextFile::append(&path)?; + log.write_line("done")?; + log.close()?; + + assert_eq!(fs::read_to_string(&path)?, "compiling\ndone\n"); + Ok(()) + } + + #[test] + fn appending_to_content_that_lacks_its_last_newline_starts_a_fresh_line() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("script.log"); + fs::write(&path, "the script stopped here")?; + + let mut log = TextFile::append(&path)?; + log.write_line("and this is ours")?; + log.close()?; + + assert_eq!( + fs::read_to_string(&path)?, + "the script stopped here\nand this is ours\n" + ); + Ok(()) + } + + #[test] + fn every_line_is_written_with_its_terminator() -> TestResult { + let mut text = TextFile::new(Vec::new(), "in memory"); + + text.write_line("session started")?; + text.write_line("board LCU connected")?; + + assert_eq!(written(&text), "session started\nboard LCU connected\n"); + Ok(()) + } + + #[test] + fn an_empty_line_is_just_a_terminator() -> TestResult { + let mut text = TextFile::new(Vec::new(), "in memory"); + + text.write_line("")?; + text.write_line("after the blank")?; + + assert_eq!(written(&text), "\nafter the blank\n"); + Ok(()) + } + + #[test] + fn a_line_is_written_verbatim_with_no_quoting() -> TestResult { + let mut text = TextFile::new(Vec::new(), "in memory"); + + text.write_line("LCU, bay 2: say \"hi\"")?; + + assert_eq!(written(&text), "LCU, bay 2: say \"hi\"\n"); + Ok(()) + } + + #[test] + fn a_failed_write_poisons_the_file() -> TestResult { + let mut text = TextFile::new(FailsAfter { ok_writes: 1 }, "failing"); + + text.write_line("this one gets through")?; + assert!(matches!( + text.write_line("this one doesn't"), + Err(Error::Write { .. }) + )); + assert!(text.is_poisoned()); + + assert!(matches!( + text.write_line("nor this one"), + Err(Error::Poisoned { .. }) + )); + assert!(matches!(text.flush(), Err(Error::Poisoned { .. }))); + Ok(()) + } + + #[test] + fn a_file_reports_the_name_it_answers_to_and_the_bytes_it_has_taken() -> TestResult { + let mut text = TextFile::new(Vec::new(), "in memory"); + assert_eq!(text.label(), "in memory"); + assert_eq!(text.bytes_written(), 0); + + text.write_line("session started")?; + assert_eq!(text.bytes_written(), "session started\n".len() as u64); + assert_eq!(text.bytes_since_flush(), "session started\n".len() as u64); + + text.flush()?; + assert_eq!(text.bytes_since_flush(), 0); + assert_eq!(text.bytes_written(), "session started\n".len() as u64); + Ok(()) + } + + #[test] + fn create_makes_the_parent_directories_and_close_persists_every_line() -> TestResult { + let temp = tempfile::tempdir()?; + let path = temp.path().join("session/others/session.log"); + + let mut text = TextFile::create(&path)?; + text.write_line("session started")?; + text.write_line("session stopped")?; + text.close()?; + + assert_eq!( + fs::read_to_string(&path)?, + "session started\nsession stopped\n" + ); + Ok(()) + } +} diff --git a/backend/crates/core/src/model.rs b/backend/crates/core/src/model.rs new file mode 100644 index 000000000..74b79b99a --- /dev/null +++ b/backend/crates/core/src/model.rs @@ -0,0 +1,31 @@ +//! Basic domain types: identifiers, packets, values, measurements, +//! protections and boards. No I/O and no networking here, just data and +//! the operations performed on it. +//! +//! - `id` — `AdjId`, `BoardId`, `MacAddress`, `Port`. +//! - `value` — `Value`, the result of decoding a measurement. +//! - `measurement` — `Measurement`: what a field of a packet looks like. +//! - `protections` — `Protection`: bounds declared for a measurement. +//! - `packet` — `Packet` and its variants: data, order, +//! protection packet, message. +//! - `board` — `PodData`, `Board`, `PacketDef`: the whole vehicle. + +mod board; +mod id; +mod measurement; +mod packet; +mod protections; +mod value; + +#[cfg(feature = "http")] +pub mod http; + +pub use board::{Board, PacketDef, PacketType, PodData}; +pub use id::{AdjId, BoardId, MacAddress, Port}; +pub use measurement::{Measurement, MeasurementKind, NumericKind, Range}; +pub use packet::{ + Data, DataOrderPacket, DataPacket, MessageLevel, MessagePacket, Order, OrderPacket, Packet, + PacketTypeTag, ProtectionPacket, ShortTimestamp, +}; +pub use protections::{Protection, ProtectionKind, Severity}; +pub use value::Value; diff --git a/backend/crates/core/src/model/README.md b/backend/crates/core/src/model/README.md new file mode 100644 index 000000000..40001c283 --- /dev/null +++ b/backend/crates/core/src/model/README.md @@ -0,0 +1,303 @@ +# Model Module + +## Introduction + +This module is meant to store and organize all the different structs, enums and other data structures necessary for the backend project. + +The domain types describe vehicle definitions and decoded packets. With the +`http` feature enabled, `model::http` also exposes separate, serializable catalog +response models; see [section 7](#7-http-http-feature). + +## 1. `board.rs` +All structs and enums needed for the Pod can be found defined in this file. +### 1.1 `PacketType` +Enum used to define what type of packet a `PacketDef` declares. Not every type carries the same shape, so each variant holds whatever measurement data is actually meaningful for it, instead of every packet being forced through one shared field. + +#### `Data(Vec)` +Telemetry sent by a board: one value per measurement, decoded positionally in this order. +#### `Protection(Measurement)` +The single measurement one of a board's declared protections watches. Always exactly one — never a list. +#### `Order(Vec)` +An order sent to a board. Many orders take no parameters at all, so this can be empty. +#### `Message(MessageLevel)` +A free-text log line of this severity. Never carries measurement data — the severity is the only thing that tells one `Message` `PacketDef` apart from another. Lives here, on `PacketType`, rather than as a separate field on `PacketDef`: a message's severity is as much part of "what type of packet is this" as a `Data` packet's measurement list is. + +`PacketType` also exposes a `measurements()` method that flattens any variant into a `&[Measurement]` slice, for code that just wants every measurement a packet references regardless of its type. + +### 1.2 `PacketDef` +Struct used to define the structure of a packet a board can send or recieve. + +#### `id` +ID of a packet, using the AdjId type which is a u16. Structure of ID is defined by the ADJ documentation. +#### `board` +The owning board's `BoardId`. Carried here too (not just reachable through the owning `Board`) so anything holding just a `&PacketDef` — e.g. a lookup table indexed by `AdjId` — knows which board it belongs to without a separate index back to it. +#### `name` +Human-readable String shown to the user to identify packet. +#### `packet_type` +`PacketType` enum: both what type of packet this is, and the measurement shape — if any — specific to that type. + +### 1.3 `Board` +Struct used to identify a single board in the vehicle. + +#### `id` +Board's unique Id in u16 format. +#### `name` +Boards name. Eg. "BSU". +#### `ip` +Board's IpAddress used to open TCP/UDP connections. +#### `mac` +Board's MAC address +#### `packets` +The packets this board can send or receive, as a `HashMap` keyed by id — the ADJ gives packets no meaningful order, so this is a map, not a list. + +### 1.4 `PodData` +Struct used to package all the structs of a vehicle. +#### `boards` +Every board of the vehicle, as a `HashMap` keyed by id — the ADJ doesn't give boards any meaningful order either. + + +## 2. `id.rs` +Defined as their own types (wrapping a `u16`) instead of using a plain `u16`, so the compiler won't let an `AdjId` be confused with a `BoardId` by mistake, even though both are just numbers underneath +### 2.1 `AdjId` +ID of an ADJ packet in u16. Structure of ID can be found in the ADJ documentation. + +For a protection's compound id (the high 3 bits are the protection's position, the low 13 bits the watched measurement's id — see the struct's own docs for the full range table), `AdjId` exposes the split as two methods instead of leaving every caller to redo the shift/mask: +- `protection_position() -> u8`: the high 3 bits (`0` for a normal, non-protection id). +- `measurement_id() -> AdjId`: the id with its high 3 bits zeroed out — the watched measurement's own id. +### 2.2 `BoardId` +Unique identifier of a board, defined by the ADJ documentation. +### 2.3 `MacAddress` +A board's physical MAC address, as 6 raw bytes. + + +## 3. `measurement.rs` +A `Measurement` describes a single field of a packet, as defined by the ADJ: whether it holds a number, a boolean, or the variant of an enum, and, for numeric measurements, its wire type and its safe and warning ranges. This is a *description*, not a decoded value — see`super::Value` for the value itself, once decoded. + +### 3.1 `NumericKind` +Enum used to classify every numerical value type a measurement can use. +- Unsigned 8-bit integer (`U8`) +- Unsigned 16-bit integer (`U16`) +- Unsigned 32-bit integer (`U32`) +- Unsigned 64-bit integer (`U64`) +- Signed 8-bit integer (`I8`) +- Signed 16-bit integer (`I16`) +- Signed 32-bit integer (`I32`) +- Signed 64-bit integer (`I64`) +- 32-bit floating point number (`F32`) +- 64-bit floating point number (`F64`) + +### 3.2 `Range` +An inclusive range with independently optional lower and upper bounds. This +helper is not a field of the current `MeasurementKind::Numeric` variant; +protection bounds are represented by `ProtectionKind` instead. +#### `min` +Optional lower bound (`Option`); `None` means no lower limit. +#### `max` +Optional upper bound (`Option`); `None` means no upper limit. + +### 3.3 `MeasurementKind` +Enum used to classify the kind of measurement. +#### `Numeric` +#### `Boolean` +#### `Enum` + +### 3.4 `Measurement` +Struct used to define a measurement. +#### `id` +The measurement's numeric ADJ id. +#### `alias` +The legacy textual identifier, used by code generation +#### `name` +The human-readable string shown to the user. +#### `display_units` +Name of the unit of measurement to display to user. Eg. "ºC". +#### `kind` +Usees MeasurementKind enum to classify what type this measurement holds. +#### `protections` +Vector list of protections. Maximum of 7 per measurement. + +## 4. `packet.rs` +- `Packet` is a single message actually sent or received over the wire, once decoded. This is the *instance* — as opposed to `super::Measurement` and `super::Protection`, which describe what a packet or a protection *can* look like, or `super::PacketDef`, which describes a whole packet. + +### 4.1 `ShortTimestamp` +A short timestamp carrying only the time of day: hour, minute, second and a sub-second fraction, each one byte. Used by `ProtectionPacket` and `MessagePacket`. Only records *when today* something happened; the date is assumed to be the day the packet was received. + +#### `hour` +Hour of Timestamp of values 0–23. +#### `minute` +Minute of Timestamp of values 0–59. +#### `second` +Second of Timestamp of values 0–59. +#### `subsecond` +The sub-second fraction, as the raw byte on the wire. Its exact unit (e.g. milliseconds, or 1/256ths of a second) hasn't been confirmed yet, so it is kept as a raw `u8` here instead of converted to something like a `Duration` — convert it once the unit is settled. + +### 4.2 `DataOrderPacket` — a phantom type +`DataPacket` and `OrderPacket` hold the exact same shape (`id: AdjId`, `values: Vec`, both positional — see below), so they're both built on one generic struct, `DataOrderPacket`, instead of being copy-pasted. The two used to just be `type` aliases for the very same concrete struct (`type OrderPacket = DataOrderPacket; type DataPacket = DataOrderPacket;`) — which meant they weren't actually distinct types at all: nothing stopped a `DataPacket` just decoded off the UDP socket from being passed to `protocol::tcp::encode_order` (which wants an *order* to send) by mistake, the compiler had no way to tell them apart. + +`Kind` fixes that. It's a *phantom* type parameter — `DataOrderPacket` doesn't actually store a `Kind` value (there's nothing to store, see `Data`/`Order` below), it only exists so the compiler tracks which one a given packet was built as: +```rust +pub struct DataOrderPacket { + pub id: AdjId, + pub values: Vec, + _marker: PhantomData, +} +``` +`_marker` is private, so a `DataOrderPacket` can't be built with struct-literal syntax from outside `packet.rs` — use `DataOrderPacket::new(id, values)` (or, through the aliases below, `DataPacket::new(...)`/`OrderPacket::new(...)`) instead. + +#### `Data` / `Order` +Two empty marker structs — the only two types `Kind` is ever instantiated with. Neither is ever actually constructed; they only ever appear as a type argument. That's what makes the whole thing *phantom*: the type parameter has no representation in the compiled struct, it's erased after type-checking, the same way `id.rs` (§2) uses distinct `AdjId`/`BoardId` types so the compiler won't confuse two different kinds of `u16`. + +#### `PacketTypeTag` +The compiler erases `Kind` after type-checking, so nothing at runtime can look at a `DataOrderPacket` and ask "is this actually a `Data` one?" — `PacketTypeTag` is how code that's generic over `Kind` answers that anyway, by asking the question of the *type* instead of the *value*: +```rust +pub trait PacketTypeTag { + fn matches(packet_type: &PacketType) -> bool; +} +``` +`Data`/`Order` each implement it by checking which `PacketType` (§1.1) variant they stand for (`matches!(packet_type, PacketType::Data(_))` / `PacketType::Order(_)`). This is the only thing `PacketTypeTag` decides — once a `PacketDef`'s type is confirmed to match, the actual measurement list still comes from the existing `PacketType::measurements()` (§1.1), not from `PacketTypeTag` itself. + +`protocol::packet::data_order`'s `encode`/`decode` use this to be generic over `Kind`: written once, they work for both `DataPacket` and `OrderPacket` instead of needing a near-duplicate pair of functions per type. + +#### `DataPacket` / `OrderPacket` +```rust +pub type DataPacket = DataOrderPacket; +pub type OrderPacket = DataOrderPacket; +``` +Now genuinely different types: a function that takes an `OrderPacket` cannot be called with a `DataPacket`, even though both just wrap the same `(AdjId, Vec)` underneath — the mix-up is a compile error instead of a bug waiting to happen. `DataOrderPacket`'s own doc comment has a `compile_fail` doctest proving exactly that (run by `cargo test`, like any other doctest). + +`DataPacket` holds the decoded values of the measurements a board just sent — positional, not individually tagged with their measurement ID, just written in the order their `Measurement`s appear in this packet's `PacketType::Data` list. + +`OrderPacket` holds an order sent from the backend to a board — positional the same way, matching `PacketType::Order`'s measurement list. + +#### `id` +Which packet/order definition this is an instance of (`AdjId`). +#### `values` +Vector list of decoded values (`Vec`) corresponding positionally to the packet definition's measurements. + +### 4.3 `ProtectionPacket` +Sent by a board when one of its declared protections triggers. + +#### `id` +The compound wire id this protection triggered under (`AdjId`). Use `id.measurement_id()` for the measurement it watches and `id.protection_position()` for which of that measurement's protections this is (see `Protection::id`). Kept as a single field rather than storing both halves separately — they're never independent of each other, so a second field would only add a second place for them to disagree. +#### `timestamp` +When the protection triggered (`ShortTimestamp`). +#### `value` +The value that triggered the protection (`Value`), decoded with the same wire type as the watched measurement. + +### 4.4 `MessageLevel` +Enum indicating how severe a message is (reusing `general_info.json`'s `message_ids`). Distinct from `Severity` because message and protection formats are separate in ADJv3. + +#### `Fault` +Stops the vehicle automatically. +#### `Warning` +Flags something unexpected, without stopping the vehicle. +#### `Info` +Informational message, no action implied. +#### `Panic` +An unrecoverable firmware error. + +`MessageLevel` also exposes: +- `ALL: [MessageLevel; 4]` — every severity, for code that needs to go through each one (e.g. building a lookup from a loaded ADJ's `message_ids`). +- `name(self) -> &'static str` — this severity's key in `general_info.json`'s `message_ids` (`"fault"`, `"warning"`, `"info"`, `"panic"`). +- `from_name(name: &str) -> Option` — the inverse of `name()`; `None` if `name` isn't one of the four. + +This is deliberately where the name↔severity association lives — in `model`, not `adj` or `protocol` — since it's domain knowledge about the severity itself. `adj::AdjInfo::message_levels` (see `adj/README.md`) calls into `name()`/`ALL` to build its id→severity lookup rather than hardcoding `"fault"`/`"warning"`/`"info"`/`"panic"` itself. + +### 4.5 `MessagePacket` +A free-text message sent by a board. + +#### `id` +The wire id this message was sent under — one of the severities declared in `general_info.json`'s `message_ids`. Not a `MessageLevel` directly, the same way `ProtectionPacket::id` isn't a `Protection`: resolving it to a severity means looking it up (`PacketType::Message`/`protocol::Index`), not storing a second, redundant copy of it here. +#### `timestamp` +When the message was sent (`ShortTimestamp`). +#### `origin` +Source identifier, such as a source file path (`String`). +#### `message` +The text contents of the message (`String`). + +### 4.6 `Packet` +Enum representing any packet actually sent or received over the wire, once decoded. + +#### `Data` +Wraps a `DataPacket` (measurement data sent by a board). +#### `Order` +Wraps an `OrderPacket` (command sent to a board). +#### `Protection` +Wraps a `ProtectionPacket` (triggered protection event). +#### `Message` +Wraps a `MessagePacket` (free-text log/diagnostic message). + +## 5. `protections.rs` +A `Protection` is a bound checked against a measurement's decoded value, as declared in the ADJ (`_measurements.json`). This defines the *declaration* (what to watch for, thresholds, and severity) rather than the runtime wire packet emitted when triggered (`ProtectionPacket` in `packet.rs`). In ADJv3, protections and messages are distinct formats with separate lifecycles. + +### 5.1 `ProtectionKind` +Enum defining the condition a protection evaluates and the associated threshold bound(s). Modeled as data-carrying variants to ensure compile-time validity instead of untyped lists. + +#### `Above` +Triggers when the value exceeds `limit` (`f64`). +#### `Below` +Triggers when the value drops below `limit` (`f64`). +#### `Equal` +Triggers when the value equals forbidden `target` (`f64`). +#### `NotEqual` +Triggers when the value deviates from expected `target` (`f64`). +#### `Range` +Triggers when the value leaves the closed `[min, max]` interval (`min: f64`, `max: f64`). Both bounds are strictly required. + +### 5.2 `Severity` +Enum indicating the operational severity level of a triggered protection. + +#### `Fault` +Critical error that stops the vehicle automatically. +#### `Warning` +Flags the condition as anomalous without halting vehicle operation. + +### 5.3 `Protection` +Struct defining a single protection rule attached to a measurement. + +#### `id` +The protection's relative slot index within its parent measurement's protection list, stored as an `AdjId` in the `1–7` range. This is a local index rather than a global ID; it forms the upper 3 bits of the compound wire identifier alongside the 13-bit measurement ID. + +Do not confuse this internal position with an HTTP protection ID: both +`OrderResponse` and `ProtectionResponse` expose the compound ID +`(position << 13) | measurement_id`, as does `ProtectionPacket` on the wire. +#### `kind` +The evaluation rule and threshold bounds (`ProtectionKind`). +#### `severity` +The operational impact level when triggered (`Severity`). +#### `time` +Duration the measured value must remain out of bounds before the protection trips (`Duration`). A value of `Duration::ZERO` indicates an instantaneous trigger. + +## 6. `value.rs` +Defines how the backend represents a piece of data once decoded, regardless of its original wire representation. While the ADJ supports various integer and floating-point types on the wire (captured during decoding by `NumericKind`), all numeric values normalize to `f64` once inside the backend. + +### 6.1 `Value` +Enum representing a single decoded measurement or field value. + +#### `Number(f64)` +A numeric measurement, regardless of its original wire type (`u8`, `i32`, `f32`, etc.). +#### `Bool(bool)` +A boolean measurement (`true` or `false`). +#### `Enum(String)` +The selected variant name of an enumerated measurement (e.g. `"Operational"`). + +## 7. `http` (`http` feature) + +`model/http.rs` publicly re-exports three response types: + +- `DataResponse`: data packet definitions grouped by board, without protections. +- `OrderResponse`: order definitions grouped by board, including parameter protections. +- `ProtectionResponse`: flat protection definitions and display metadata. + +Their nested response structs live in `model/http/data.rs`, `order.rs`, and +`protection.rs`. Those submodules are crate-visible, not public import paths. +The response models derive `serde::Serialize`; the domain types do not need to +adopt the HTTP representation. Shared custom serializers live in +`utils/serialize.rs`. + +The builders are methods of `Adj`, implemented in `adj/http.rs`: +`adj.data_response()`, `adj.order_response()`, and `adj.protection_response()`. +This module defines no HTTP server, routes, CORS, or cache policy. + +See the [HTTP response models README](http/README.md) for usage, JSON type +notation, field omission rules, and concrete examples. diff --git a/backend/crates/core/src/model/board.rs b/backend/crates/core/src/model/board.rs new file mode 100644 index 000000000..2dc56b6b7 --- /dev/null +++ b/backend/crates/core/src/model/board.rs @@ -0,0 +1,150 @@ +//! Boards and their packet definitions. +//! +//! [`PodData`] is the whole vehicle as described by the ADJ: every board, +//! and every packet each board can send or receive. +//! +//! This module only carries fields we have solid grounds for: `id`, +//! `name`, whether a packet is data or an order, and its +//! measurements. Framing details that might still apply per packet (cycle +//! time, raw byte count...) are not confirmed for ADJv3 yet, so they are +//! left out rather than guessed — add them once the packet-level JSON +//! shape is settled. + +use super::{AdjId, BoardId, MacAddress, Measurement, MessageLevel}; +use std::collections::HashMap; +use std::net::IpAddr; + +/// What type of packet a [`PacketDef`] declares, carrying whatever +/// measurement shape — if any — is specific to that type. Not every type +/// has measurements, so this says so in the type instead of forcing every +/// [`PacketDef`] through one shared `measurements: Vec` field +/// regardless of whether that's meaningful for it. +#[derive(Debug, Clone, PartialEq)] +pub enum PacketType { + /// A board's periodic telemetry: one value per measurement, decoded + /// positionally in this order. + Data(Vec), + /// The single measurement one of a board's declared protections + /// watches. + Protection(Measurement), + /// A command sent to a board. Many orders take no parameters at all. + Order(Vec), + /// A free-text log line of this severity. Never carries measurement + /// data — the severity is the only thing that tells one `Message` + /// `PacketDef` apart from another. + Message(MessageLevel), +} + +impl PacketType { + /// Every measurement this packet's type references, flattened — for + /// code that doesn't care which type this is, just what measurements + /// it touches. + pub fn measurements(&self) -> &[Measurement] { + match self { + PacketType::Data(measurements) | PacketType::Order(measurements) => measurements, + PacketType::Protection(measurement) => std::slice::from_ref(measurement), + PacketType::Message(_) => &[], + } + } +} + +/// The declaration of a single packet a board can send or receive, as +/// defined by the ADJ. +/// +/// This is the *declaration* — see [`super::Packet`] for a decoded +/// instance actually sent or received over the wire. +#[derive(Debug, Clone, PartialEq)] +pub struct PacketDef { + /// The packet's numeric ADJ id. + pub id: AdjId, + /// The board this packet belongs to. A `PacketDef` is always reached + /// through its owning [`Board`] already, but carrying the id here too + /// means anything holding just a `&PacketDef` (e.g. a lookup table + /// indexed by [`AdjId`]) knows which board it is without a second, + /// separate index back to it. + pub board: BoardId, + /// The human-readable name shown to the user. + pub name: String, + /// Whether this is data, order, protection or message — and the + /// measurement shape specific to that type, if any. + pub packet_type: PacketType, +} + +/// A single board of the vehicle, as defined by the ADJ. +#[derive(Debug, Clone, PartialEq)] +pub struct Board { + /// The board's unique id. + pub id: BoardId, + /// The board's name, e.g. `"BCU"`. + pub name: String, + /// The board's IP address, used to open its TCP/UDP connections. + pub ip: IpAddr, + /// The board's MAC address (ADJv3 spec, section 5). + pub mac: MacAddress, + /// The packets this board can send or receive, keyed by id — same + /// reasoning as [`PodData::boards`], the ADJ gives this list no + /// meaningful order either. + pub packets: HashMap, +} + +/// The whole vehicle, as described by the ADJ: every board and every +/// packet each one can send or receive. +#[derive(Debug, Clone, PartialEq, Default)] +pub struct PodData { + /// Every board of the vehicle, keyed by its id — the ADJ doesn't give + /// boards any meaningful order, so iterating this in some particular + /// sequence is never something to rely on. + pub boards: HashMap, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::MeasurementKind; + + fn sample_measurement() -> Measurement { + Measurement { + id: AdjId(3000), + alias: "temperature_1".to_string(), + name: "Temperature 1".to_string(), + display_units: "ºC".to_string(), + kind: MeasurementKind::Boolean, + protections: vec![], + } + } + + #[test] + fn an_empty_pod_data_has_no_boards() { + let pod_data = PodData::default(); + assert!(pod_data.boards.is_empty()); + } + + #[test] + fn a_board_groups_its_packets_and_their_measurements() { + let board = Board { + id: BoardId(1), + name: "BCU".to_string(), + ip: IpAddr::from([192, 168, 0, 10]), + mac: MacAddress([0x00, 0x11, 0x22, 0x33, 0x44, 0x55]), + packets: HashMap::from([( + AdjId(1000), + PacketDef { + id: AdjId(1000), + board: BoardId(1), + name: "bcu_data".to_string(), + packet_type: PacketType::Data(vec![sample_measurement()]), + }, + )]), + }; + + assert_eq!(board.packets.len(), 1); + let Some(packet) = board.packets.get(&AdjId(1000)) else { + unreachable!("the packet we just inserted should be there"); + }; + let PacketType::Data(measurements) = &packet.packet_type else { + unreachable!("packet should be Data"); + }; + assert_eq!(measurements.len(), 1); + assert_eq!(board.mac.to_string(), "00:11:22:33:44:55"); + } +} diff --git a/backend/crates/core/src/model/http.rs b/backend/crates/core/src/model/http.rs new file mode 100644 index 000000000..837d95618 --- /dev/null +++ b/backend/crates/core/src/model/http.rs @@ -0,0 +1,9 @@ +//! Models for HTTP response bodies. + +pub(crate) mod data; +pub(crate) mod order; +pub(crate) mod protection; + +pub use data::DataResponse; +pub use order::OrderResponse; +pub use protection::ProtectionResponse; diff --git a/backend/crates/core/src/model/http/README.md b/backend/crates/core/src/model/http/README.md new file mode 100644 index 000000000..1f500cb49 --- /dev/null +++ b/backend/crates/core/src/model/http/README.md @@ -0,0 +1,284 @@ +# HTTP Response Models (`model::http`) + +Serializable models for the data, order, and protection catalogs of a loaded +ADJ. These are definitions, not live telemetry, order execution requests, or +triggered protection events. + +The `http` feature enables both sides of the conversion: + +- `model/http.rs` and `model/http/`: response types and their JSON representation. +- `adj/http.rs`: methods on `Adj` that build those response types without + consuming or modifying the ADJ. + +Routes, middleware, and server execution belong to the application (`station`), +not to either of these core modules. Shared custom serializers are implemented +in `utils/serialize.rs`, leaving the internal domain representation unchanged. + +## Catalogs + +| `Adj` method | Public response type | Station GET route | JSON example | +| --- | --- | --- | --- | +| `adj.data_response()` | `model::http::DataResponse` | `/backend/adj/DataPackets` | [data.json](example/data.json) | +| `adj.order_response()` | `model::http::OrderResponse` | `/backend/adj/OrderPackets` | [order.json](example/order.json) | +| `adj.protection_response()` | `model::http::ProtectionResponse` | `/backend/adj/ProtectionPackets` | [protection.json](example/protection.json) | + +Each example is a standalone illustrative catalog, not a snapshot of the +bundled test ADJ or part of a shared vehicle fixture. + +## Usage + +Enable the `http` feature in the application's dependency: + +```bash +cargo add software-core -F http +``` + +With an already loaded `adj: Adj`: + +```rust +use software_core::model::http::{DataResponse, OrderResponse, ProtectionResponse}; + +let data: DataResponse = adj.data_response(); +let orders: OrderResponse = adj.order_response(); +let protections: ProtectionResponse = adj.protection_response(); +``` + +All three responses implement `serde::Serialize`, so the application can return +them as JSON using its HTTP framework. Only these three root types are publicly +re-exported; the nested Rust response types are in crate-visible submodules. + +## JSON Structure Templates + +These templates keep the JSON object and array structure, replacing values +with their types: `number`, `string`, or `boolean`. Quoted values such as +`"data"` are literals. Comments explain constraints and optional properties. +These are documentation templates, not valid JSON payloads; see the linked +`.json` files for concrete values. + +Each array shows one representative item but can contain zero or more items. +IDs are unsigned 16-bit integers, not strings or wrapper objects. +The catalog templates show numeric measurements and range protections; +the other possible `type` values are listed below. + +### Data Catalog (`DataResponse`) + +```jsonc +{ + "boards": [ + { + "id": number, + "name": string, + "packets": [ + { + "id": number, + "name": string, + "type": "data", + "measurements": [ + { + "id": number, + "alias": string, + "name": string, + "display_units": string, + "type": string // A numeric wire type, such as "float32", or "boolean"; see enum form below. + } + ] + } + ] + } + ] +} +``` + +Data measurements deliberately have no `protections` property, even if their +internal ADJ definitions declare protections. + +### Order Catalog (`OrderResponse`) + +```jsonc +{ + "boards": [ + { + "id": number, + "name": string, + "orders": [ + { + "id": number, + "name": string, + "type": "order", + "measurements": [ + { + "id": number, + "alias": string, + "name": string, + "display_units": string, + "type": string, // A numeric wire type, such as "float32", or "boolean"; see enum form below. + "protections": [ + { + "id": number, // Compound ID, not the local position (1–7). + "type": { + "type": "range", + "min": number, + "max": number + }, + "severity": string, // "fault" or "warning". + "time": string // Optional: omitted for a zero duration. + } + ] + } + ] + } + ] + } + ] +} +``` + +Only protections attached to an order's parameter measurements are included, +not every protection on its board. A parameterless order has `measurements: []`; +a parameter with no declared protections has `protections: []`. + +### Protection Catalog (`ProtectionResponse`) + +```jsonc +{ + "protections": [ + { + "id": number, // Compound ID. + "name": string, + "board_id": number, + "measurement_id": number, + "type": { + "type": "range", + "min": number, + "max": number + }, + "severity": string, // "fault" or "warning". + "time": string // Optional: omitted for a zero duration. + } + ], + "info": { + "": { + "range": boolean, + "text": string, + "text_time": string // Optional: only included when declared in the ADJ. + } + } +} +``` + +`info` comes from `general_info.json`'s `protectionTypes`. Its keys preserve the +ADJ names exactly, whereas the inner protection discriminator uses snake_case. +For example, a protection has `protection.type.type === "range"`, but the +metadata key may be `"Range"` or `"range"`, depending on the ADJ. +Direct access such as `response.info[protection.type.type]` only works when +those keys match: the builder does not normalize them. For the conventional +capitalized ADJ names, the correspondence is: + +| `protection.type.type` | Capitalized ADJ metadata key | +| --- | --- | +| `above` | `Above` | +| `below` | `Below` | +| `equal` | `Equal` | +| `not_equal` | `NotEqual` | +| `range` | `Range` | + +Metadata is not synthesized for missing ADJ entries. In its text templates, +`{}` represents protection bounds and `%` the measured value. `text_time` is +omitted when the ADJ does not declare an alternative time-based template. + +### Measurement `type` Values + +The Rust field is called `kind`, but is serialized as the JSON property `type` +in both data and order measurements. Its value is a string for numeric and +boolean measurements, or an object for enums. There is no separate `wire_type` +property in the JSON. + +Numeric measurement (field excerpt): + +```jsonc +{ + "type": string // One of the numeric wire types listed below, e.g. "float32". +} +``` + +Numeric `type` is one of `"uint8"`, `"uint16"`, `"uint32"`, `"uint64"`, +`"int8"`, `"int16"`, `"int32"`, `"int64"`, `"float32"`, or `"float64"`. + +Boolean measurement (field excerpt): + +```jsonc +{ + "type": "boolean" +} +``` + +Enum measurement (field excerpt): + +```jsonc +{ + "type": { + "type": "enum", + "options": [string] + } +} +``` + +Numeric measurements do not carry separate safe/warning ranges; protection +definitions carry conditions and severity instead. `display_units` remains +present even when it is `""`. + +### Protection `type` Values + +The Rust protection field is also called `kind`, but is serialized as `type`. +Unlike numeric and boolean measurement types, its JSON value is always an +object, with its own `type` discriminator and the condition's bound(s). +The following are field excerpts from a protection object: + +| Condition | JSON-shaped type template | +| --- | --- | +| Above a limit | `{"type": {"type": "above", "limit": number}}` | +| Below a limit | `{"type": {"type": "below", "limit": number}}` | +| Equal to a target | `{"type": {"type": "equal", "target": number}}` | +| Not equal to a target | `{"type": {"type": "not_equal", "target": number}}` | +| Outside a range | `{"type": {"type": "range", "min": number, "max": number}}` | + +The protection `range` variant always has both bounds. + +## IDs, Ordering, and Optional Fields + +- Protection IDs in both order and protection responses are composed as + `(position << 13) | measurement_id`: the high 3 bits hold the one-based + position (`1–7`), and the low 13 bits hold the measurement ID. For measurement + `3001`, the first two protections are `11193` and `19385`. The internal + `Protection::id` still stores only the local position. +- Boards are sorted by ID; their data packets or orders are sorted by ID. + Boards without matching packets/orders are retained with an empty array. +- Measurement order, enum option order, and order-parameter protection order + follow the ADJ. The flat protection catalog is sorted by compound packet ID, + then board ID; the keys of `info` have no guaranteed order. +- Catalog arrays remain present even when empty. An empty ADJ yields + `{"boards": []}` for data and orders, and + `{"protections": [], "info": {}}` for protections. + +### Protection Duration (`time`) + +`time` is a duration string, not a timestamp. It is omitted for +`Duration::ZERO`, not serialized as `null` or `"0ns"`. + +For positive durations, the formatter chooses an exact integer representation: + +1. Milliseconds (`ms`) when the nanosecond count is divisible by `1_000_000`. +2. Otherwise microseconds (`us`) when it is divisible by `1_000`. +3. Otherwise nanoseconds (`ns`). + +No precision is discarded during this formatting step. For example: + +| Duration | Serialized `time` | +| --- | --- | +| Zero | Property omitted | +| 1 second | `"1000ms"` | +| 1500 microseconds | `"1500us"` | +| 1500 nanoseconds | `"1500ns"` | + +This rule applies to protection `time`, not to the metadata template string +`text_time`, which is copied from the ADJ and omitted when absent. diff --git a/backend/crates/core/src/model/http/data.rs b/backend/crates/core/src/model/http/data.rs new file mode 100644 index 000000000..d739e82a2 --- /dev/null +++ b/backend/crates/core/src/model/http/data.rs @@ -0,0 +1,84 @@ +//! ADJ v3 data packet catalog returned by `/backend/adj/DataPackets`. + +use serde::Serialize; + +use crate::{ + model::{AdjId, BoardId, NumericKind}, + utils::serialize::{serialize_adj_id, serialize_board_id, serialize_data_measurement_type}, +}; + +/// Data packet definitions grouped by board. +/// +/// Serialized as a JSON object containing a `boards` array. +/// See `example/data.json` for the response shape. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct DataResponse { + /// Boards and their data packet definitions. + pub boards: Vec, +} + +/// A board and the data packets it declares. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct DataBoardResponse { + /// Numeric board id from the ADJ. + #[serde(serialize_with = "serialize_board_id")] + pub id: BoardId, + /// Human-readable board name. + pub name: String, + /// Data packet definitions, each carrying its own numeric id. + pub packets: Vec, +} + +/// A data packet's ADJ metadata, not its current telemetry values. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct DataPacketResponse { + /// Numeric packet id from the ADJ. + #[serde(serialize_with = "serialize_adj_id")] + pub id: AdjId, + /// Human-readable packet name. + pub name: String, + /// ADJ packet type: `data` for this endpoint. + #[serde(rename = "type")] + pub packet_type: String, + /// Measurement definitions in wire order, without protections. + pub measurements: Vec, +} + +/// A measurement's definition with protection metadata deliberately omitted. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct DataMeasurementResponse { + /// Numeric measurement id, distinct from its textual alias. + #[serde(serialize_with = "serialize_adj_id")] + pub id: AdjId, + /// Textual identifier declared in the ADJ. + pub alias: String, + /// Human-readable measurement name. + pub name: String, + /// Unit label displayed to the user. + pub display_units: String, + /// Measurement type metadata, serialized under the JSON key `type`. + /// Numeric and boolean types are strings; enums are objects with options. + #[serde(rename = "type", serialize_with = "serialize_data_measurement_type")] + pub kind: DataMeasurementKind, +} + +/// Measurement type metadata used by the custom response serializer. +/// +/// As a measurement's JSON `type` value, numeric types become their ADJ wire +/// type name, booleans become `"boolean"`, and enums become an object with +/// `"type": "enum"` and an `options` array. +#[derive(Debug, Clone, PartialEq)] +pub enum DataMeasurementKind { + /// Numeric measurement, serialized as a wire type string such as `"float32"`. + Numeric { + /// Selects the ADJ type name; no separate `wire_type` JSON field is emitted. + wire_type: NumericKind, + }, + /// Boolean measurement, serialized as the string `"boolean"`. + Boolean, + /// Enumeration, serialized as `{"type":"enum","options":[...]}`. + Enum { + /// Allowed variant names, preserved in ADJ order. + options: Vec, + }, +} diff --git a/backend/crates/core/src/model/http/example/data.json b/backend/crates/core/src/model/http/example/data.json new file mode 100644 index 000000000..08d2f8461 --- /dev/null +++ b/backend/crates/core/src/model/http/example/data.json @@ -0,0 +1,72 @@ +{ + "boards": [ + { + "id": 1, + "name": "LCU", + "packets": [ + { + "id": 936, + "name": "Temperatures", + "type": "data", + "measurements": [ + { + "id": 3000, + "alias": "temperature_1", + "name": "Motor temperature", + "display_units": "ºC", + "type": "float32" + } + ] + }, + { + "id": 967, + "name": "Levitation distance", + "type": "data", + "measurements": [ + { + "id": 3001, + "alias": "levitation_distance", + "name": "Levitation distance", + "display_units": "mm", + "type": "float32" + } + ] + } + ] + }, + { + "id": 2, + "name": "HVBMS", + "packets": [ + { + "id": 1200, + "name": "Battery voltage", + "type": "data", + "measurements": [ + { + "id": 3100, + "alias": "pack_voltage", + "name": "Pack voltage", + "display_units": "V", + "type": "float32" + } + ] + }, + { + "id": 1201, + "name": "Contactors status", + "type": "data", + "measurements": [ + { + "id": 3101, + "alias": "contactor_closed", + "name": "Contactor closed", + "display_units": "", + "type": "boolean" + } + ] + } + ] + } + ] +} diff --git a/backend/crates/core/src/model/http/example/order.json b/backend/crates/core/src/model/http/example/order.json new file mode 100644 index 000000000..63f9bedfb --- /dev/null +++ b/backend/crates/core/src/model/http/example/order.json @@ -0,0 +1,68 @@ +{ + "boards": [ + { + "id": 1, + "name": "LCU", + "orders": [ + { + "id": 1001, + "name": "Set target speed", + "type": "order", + "measurements": [ + { + "id": 3001, + "alias": "target_speed", + "name": "Target speed", + "display_units": "m/s", + "type": "float32", + "protections": [ + { + "id": 11193, + "type": { + "type": "range", + "min": 0.0, + "max": 50.0 + }, + "severity": "fault" + }, + { + "id": 19385, + "type": { + "type": "above", + "limit": 40.0 + }, + "severity": "warning", + "time": "200ms" + } + ] + } + ] + }, + { + "id": 1002, + "name": "Stop", + "type": "order", + "measurements": [] + } + ] + }, + { + "id": 2, + "name": "HVBMS", + "orders": [ + { + "id": 2001, + "name": "Open Contactors", + "type": "order", + "measurements": [] + }, + { + "id": 2003, + "name": "Start Precharge", + "type": "order", + "measurements": [] + } + ] + } + ] +} diff --git a/backend/crates/core/src/model/http/example/protection.json b/backend/crates/core/src/model/http/example/protection.json new file mode 100644 index 000000000..778e1a6d0 --- /dev/null +++ b/backend/crates/core/src/model/http/example/protection.json @@ -0,0 +1,55 @@ +{ + "protections": [ + { + "id": 11192, + "name": "LCU_temperature_1_protection_1", + "board_id": 1, + "measurement_id": 3000, + "type": { + "type": "range", + "min": 0.0, + "max": 100.0 + }, + "severity": "fault", + "time": "500ms" + }, + { + "id": 11292, + "name": "HVBMS_pack_voltage_protection_1", + "board_id": 2, + "measurement_id": 3100, + "type": { + "type": "range", + "min": 300.0, + "max": 500.0 + }, + "severity": "fault" + }, + { + "id": 19384, + "name": "LCU_temperature_1_protection_2", + "board_id": 1, + "measurement_id": 3000, + "type": { + "type": "below", + "limit": 10.0 + }, + "severity": "warning", + "time": "1000ms" + } + ], + "info": { + "equal": { + "range": false, + "text": "Value is equal to {} (measured: %)" + }, + "range": { + "range": true, + "text": "Value out of range {} (measured: %)" + }, + "below": { + "range": false, + "text": "Value below {} (measured: %)" + } + } +} diff --git a/backend/crates/core/src/model/http/order.rs b/backend/crates/core/src/model/http/order.rs new file mode 100644 index 000000000..964d442e6 --- /dev/null +++ b/backend/crates/core/src/model/http/order.rs @@ -0,0 +1,83 @@ +//! ADJ v3 order catalog returned by `/backend/adj/OrderPackets`. + +use serde::Serialize; + +use crate::{ + model::{AdjId, BoardId, ProtectionKind, Severity}, + utils::serialize::{ + serialize_adj_id, serialize_board_id, serialize_data_measurement_type, + serialize_protection_kind, serialize_severity, + }, +}; + +use super::data::DataMeasurementKind; + +/// Order definitions grouped by board, matching `example/order.json`. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct OrderResponse { + /// Boards and their order definitions. + pub boards: Vec, +} + +/// A board and the orders it declares. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct OrderBoardResponse { + /// Numeric board id from the ADJ. + #[serde(serialize_with = "serialize_board_id")] + pub id: BoardId, + /// Human-readable board name. + pub name: String, + /// Order definitions, each carrying its own numeric id. + pub orders: Vec, +} + +/// An order definition, not a request to execute that order. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct OrderPacketResponse { + /// Numeric order id from the ADJ. + #[serde(serialize_with = "serialize_adj_id")] + pub id: AdjId, + /// Human-readable order name. + pub name: String, + /// ADJ packet type: `order` for this endpoint. + #[serde(rename = "type")] + pub packet_type: String, + /// Parameters in wire order; empty for parameterless orders. + pub measurements: Vec, +} + +/// An order parameter's ADJ definition, including its protections. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct OrderMeasurementResponse { + /// Numeric measurement id, distinct from its textual alias. + #[serde(serialize_with = "serialize_adj_id")] + pub id: AdjId, + /// Textual identifier declared in the ADJ. + pub alias: String, + /// Human-readable parameter name. + pub name: String, + /// Unit label displayed to the user. + pub display_units: String, + /// Same numeric, boolean or enum metadata used by data measurements. + #[serde(rename = "type", serialize_with = "serialize_data_measurement_type")] + pub kind: DataMeasurementKind, + /// Protection definitions in ADJ order; empty when none are declared. + pub protections: Vec, +} + +/// A parameter protection's definition, not a triggered protection event. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct OrderProtectionResponse { + /// id of the protection, composed as specified + #[serde(serialize_with = "serialize_adj_id")] + pub id: AdjId, + /// Trigger condition, serialized with its type and named bounds. + #[serde(rename = "type", serialize_with = "serialize_protection_kind")] + pub kind: ProtectionKind, + /// Severity serialized as `fault` or `warning`. + #[serde(serialize_with = "serialize_severity")] + pub severity: Severity, + /// Optional duration. + #[serde(skip_serializing_if = "Option::is_none")] + pub time: Option, +} diff --git a/backend/crates/core/src/model/http/protection.rs b/backend/crates/core/src/model/http/protection.rs new file mode 100644 index 000000000..8e55e9477 --- /dev/null +++ b/backend/crates/core/src/model/http/protection.rs @@ -0,0 +1,61 @@ +//! Flat ADJ v3 protection catalog returned by `/backend/adj/ProtectionPackets`. + +use std::collections::HashMap; + +use serde::Serialize; + +use crate::{ + model::{AdjId, BoardId, ProtectionKind, Severity}, + utils::serialize::{ + serialize_adj_id, serialize_protection_kind, serialize_board_id, serialize_severity, + }, +}; + +/// Protection definitions and their display metadata, matching `example/protection.json`. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct ProtectionResponse { + /// Flat list of protections, not grouped by board or measurement. + pub protections: Vec, + /// Contents of the ADJ's `protectionTypes`, keyed by names such as `Range`. + pub info: HashMap, +} + +/// A single protection definition referencing its board and measurement by id. +#[derive(Debug, Clone, PartialEq, Serialize)] +pub struct ProtectionInfoResponse { + /// Compound packet id already assigned by the ADJ loader. + /// Its low 13 bits identify the measurement and its high 3 bits the + /// one-based protection position. This is not the position alone. + #[serde(serialize_with = "serialize_adj_id")] + pub id: AdjId, + /// Name assigned to the synthesized protection packet by the loader. + pub name: String, + /// Id of the board declaring this protection. + #[serde(serialize_with = "serialize_board_id")] + pub board_id: BoardId, + /// Id of the watched measurement, also encoded in the compound packet id. + #[serde(serialize_with = "serialize_adj_id")] + pub measurement_id: AdjId, + /// Trigger condition; `type` preserves the ADJ name to index `info` directly. + #[serde(rename = "type", serialize_with = "serialize_protection_kind")] + pub kind: ProtectionKind, + /// Severity serialized as `fault` or `warning`. + #[serde(serialize_with = "serialize_severity")] + pub severity: Severity, + /// Optional duration. + #[serde(skip_serializing_if = "Option::is_none")] + pub time: Option, +} + +/// Display metadata for one entry of `general_info.json`'s `protectionTypes`. +#[derive(Debug, Clone, PartialEq, Eq, Serialize)] +pub struct ProtectionTypeResponse { + /// Whether the protection takes an interval instead of a single bound. + #[serde(rename = "range")] + pub is_range: bool, + /// Display template; `{}` marks bounds and `%` the measured value. + pub text: String, + /// Optional time-related display template, omitted if absent from the ADJ. + #[serde(skip_serializing_if = "Option::is_none")] + pub text_time: Option, +} diff --git a/backend/crates/core/src/model/id.rs b/backend/crates/core/src/model/id.rs new file mode 100644 index 000000000..948e71b98 --- /dev/null +++ b/backend/crates/core/src/model/id.rs @@ -0,0 +1,117 @@ +//! Domain identifiers. +//! +//! Defined as their own types (wrapping a `u16`) instead of using a plain +//! `u16`, so the compiler won't let an [`AdjId`] be confused with a +//! [`BoardId`] by mistake, even though both are just numbers underneath. + +/// Unique identifier of a packet, order or protection, defined by the ADJ. +/// Ranges +/// - `[0, 511]` | `[0x0000, 0x01FF]` for special range +/// - `[512, 8191]` | `[0x0200, 0x1FFF]` for packets, orders and measurements +/// - `[8192, 65535]` | `[0x2000, 0xFFFF]` for protections: each protection is associated with a measurement, so the low 13 bits of the compound id are the measurement id, and the high 3 bits are the protection's position for that measurement (1-7; 0 is reserved for a normal, non-protection id) +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct AdjId(pub u16); + +impl AdjId { + /// The high 3 bits: `0` for a normal `packet`/`order`/`measurement` + /// id, `1`-`7` for which of the watched measurement's protections this + /// is. + pub fn protection_position(self) -> u8 { + (self.0 >> 13) as u8 + } + + /// The watched measurement's id: this id with its high 3 bits (the + /// protection's position) zeroed out. + /// + /// For a normal, non-protection id (`protection_position() == 0`), + /// this is just the id itself. + pub fn measurement_id(self) -> AdjId { + AdjId(self.0 & 0x1FFF) + } +} + +/// Unique identifier of a board, defined by the ADJ. +/// +/// `BoardId(0)` is reserved: no real board uses it. [`crate::protocol::Index`] +/// uses it as the `board` for a synthesized [`super::PacketDef`] that +/// isn't owned by any one board at all — a message severity, a +/// session-wide id any board's free-text log frame can reuse. Not +/// validated anywhere; just a convention, the same way `0` is excluded +/// from [`AdjId`]'s own special range above. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct BoardId(pub u16); + +/// A TCP/UDP port number, as declared in `general_info.json`'s `ports`. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct Port(pub u16); + +/// A board's physical MAC address, as 6 raw bytes. +/// +/// Kept as a fixed-size byte array instead of a `String` on purpose: a +/// malformed or miswritten address (the ADJv3 meeting notes mention a real +/// `67:67:67:67:67:67` that caused hours of debugging) should not be able +/// to reach this type at all. Parsing the usual `"aa:bb:cc:dd:ee:ff"` text +/// form is `adj`'s job, not this type's. +#[derive(Clone, Copy, PartialEq, Eq, Hash)] +pub struct MacAddress(pub [u8; 6]); + +impl std::fmt::Debug for MacAddress { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "MacAddress({self})") + } +} + +impl std::fmt::Display for MacAddress { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let [a, b, c, d, e, g] = self.0; + write!(f, "{a:02x}:{b:02x}:{c:02x}:{d:02x}:{e:02x}:{g:02x}") + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn two_packet_ids_with_the_same_number_are_equal() { + assert_eq!(AdjId(1000), AdjId(1000)); + } + + #[test] + fn a_port_and_a_board_id_cannot_be_compared_to_each_other() { + // This wouldn't compile if you tried it: Port(1) == BoardId(1) + let port = Port(50500); + let board = BoardId(50500); + assert_eq!(port.0, board.0); // only the inner numbers can be compared + } + + #[test] + fn a_mac_address_displays_as_colon_separated_lowercase_hex() { + let mac = MacAddress([0xaa, 0xbb, 0xcc, 0x0d, 0x0e, 0xff]); + assert_eq!(mac.to_string(), "aa:bb:cc:0d:0e:ff"); + } + + #[test] + fn packet_id_and_board_id_cannot_be_compared_to_each_other() { + // This wouldn't compile if you tried it: AdjId(1) == BoardId(1) + // That's the whole point of this file: the compiler protects us. + let packet = AdjId(1); + let board = BoardId(1); + assert_eq!(packet.0, board.0); // only the inner numbers can be compared + } + + #[test] + fn a_normal_ids_position_is_zero_and_it_is_its_own_measurement_id() { + let id = AdjId(3000); + assert_eq!(id.protection_position(), 0); + assert_eq!(id.measurement_id(), AdjId(3000)); + } + + #[test] + fn a_protections_compound_id_splits_into_position_and_measurement() { + // (3 << 13) | 100 = 24576 | 100 = 24676 + let compound = AdjId((3u16 << 13) | 100); + assert_eq!(compound.protection_position(), 3); + assert_eq!(compound.measurement_id(), AdjId(100)); + } +} diff --git a/backend/crates/core/src/model/measurement.rs b/backend/crates/core/src/model/measurement.rs new file mode 100644 index 000000000..198bed4ec --- /dev/null +++ b/backend/crates/core/src/model/measurement.rs @@ -0,0 +1,162 @@ +//! Measurement descriptions. +//! +//! A [`Measurement`] describes a single field of a packet, as defined by +//! the ADJ: whether it holds a number, a boolean, or the variant of an +//! enum, and, for numeric measurements, its wire type and its safe and +//! warning ranges. This is a *description*, not a decoded value — see +//! [`super::Value`] for the value itself, once decoded. + +use super::protections::Protection; +use crate::model::AdjId; + +/// The wire type of a numeric measurement: how many bytes it takes on the +/// wire and whether it is signed. +/// +/// This only matters while decoding. Once a number is decoded it is always +/// stored as a [`super::Value::Number`], regardless of its original wire +/// type. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum NumericKind { + /// Unsigned 8-bit integer. + U8, + /// Unsigned 16-bit integer. + U16, + /// Unsigned 32-bit integer. + U32, + /// Unsigned 64-bit integer. + U64, + /// Signed 8-bit integer. + I8, + /// Signed 16-bit integer. + I16, + /// Signed 32-bit integer. + I32, + /// Signed 64-bit integer. + I64, + /// 32-bit floating point number. + F32, + /// 64-bit floating point number. + F64, +} + +/// An inclusive range with an optional lower and upper bound. +/// +/// Either bound can be missing, meaning that side of the range is +/// unconstrained. For example, `Range { min: Some(0.0), max: None }` means +/// "any value of 0.0 or above". +#[derive(Debug, Clone, Copy, PartialEq, Default)] +pub struct Range { + /// The lower bound, if any. + pub min: Option, + /// The upper bound, if any. + pub max: Option, +} + +/// What kind of data a measurement holds, and the details specific to that +/// kind. +#[derive(Debug, Clone, PartialEq)] +pub enum MeasurementKind { + /// A numeric measurement. + Numeric { + /// How the value is encoded on the wire. + wire_type: NumericKind, + }, + /// A boolean measurement. + Boolean, + /// A measurement whose value is one of a fixed set of named variants. + Enum { + /// The variants this measurement can take, in ADJ order. + options: Vec, + }, +} + +/// The description of a single field of a packet, as defined by the ADJ. +#[derive(Debug, Clone, PartialEq)] +pub struct Measurement { + /// The measurement's numeric ADJ id, e.g. `3000`. + pub id: AdjId, + + /// The legacy textual identifier, used by code generation. + pub alias: String, + + /// The human-readable name shown to the user. + pub name: String, + + /// The name of the unit to display at the frontend, e.g. `"ºC"`. + pub display_units: String, + + /// What kind of data this measurement holds. + pub kind: MeasurementKind, + + /// The protections that are checked for this measurement, in ADJ + /// order. The ADJ limits this list to 7 entries per measurement, but + /// that limit is enforced by the ADJ validator, not by this type. + pub protections: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + + fn base(kind: MeasurementKind) -> Measurement { + Measurement { + id: AdjId(3000), + alias: "temperature_1".to_string(), + name: "Temperature 1".to_string(), + display_units: "ºC".to_string(), + kind, + protections: vec![], + } + } + + #[test] + fn a_numeric_measurement_carries_its_wire_type() { + let measurement = base(MeasurementKind::Numeric { + wire_type: NumericKind::F32, + }); + + let MeasurementKind::Numeric { wire_type } = measurement.kind else { + unreachable!("measurement was just constructed as Numeric above"); + }; + + assert_eq!(wire_type, NumericKind::F32); + } + + #[test] + fn an_enum_measurement_lists_its_options_in_adj_order() { + let measurement = base(MeasurementKind::Enum { + options: vec![ + "Idle".to_string(), + "Operational".to_string(), + "Fault".to_string(), + ], + }); + + let MeasurementKind::Enum { options } = measurement.kind else { + unreachable!("measurement was just constructed as Enum above"); + }; + + assert_eq!(options, vec!["Idle", "Operational", "Fault"]); + } + + #[test] + fn two_measurements_with_the_same_data_are_equal() { + let a = base(MeasurementKind::Boolean); + let b = a.clone(); + assert_eq!(a, b); + } + + #[test] + fn measurements_with_different_protections_are_not_equal() { + let a = base(MeasurementKind::Boolean); + let mut b = a.clone(); + b.protections.push(Protection { + id: AdjId(1), + kind: crate::model::ProtectionKind::Above { limit: 100.0 }, + severity: crate::model::Severity::Fault, + time: std::time::Duration::ZERO, + }); + + assert_ne!(a, b); + } +} diff --git a/backend/crates/core/src/model/packet.rs b/backend/crates/core/src/model/packet.rs new file mode 100644 index 000000000..c3dda408d --- /dev/null +++ b/backend/crates/core/src/model/packet.rs @@ -0,0 +1,374 @@ +//! Wire packets. +//! +//! A [`Packet`] is a single message actually sent or received over the +//! wire, once decoded. This is the *instance* — as opposed to +//! [`super::Measurement`] and [`super::Protection`], which describe what a +//! packet or a protection *can* look like, or [`super::PacketDef`], which +//! describes a whole packet. + +use super::{AdjId, PacketType, Value}; +use std::marker::PhantomData; + +/// A short timestamp carrying only the time of day: hour, minute, second +/// and a sub-second fraction, each one byte. +/// +/// Used by [`ProtectionPacket`] and [`MessagePacket`]. Unlike a full +/// calendar timestamp, this only records *when today* something happened; +/// the date is assumed to be the day the packet was received. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct ShortTimestamp { + /// The hour, 0–23. + pub hour: u8, + /// The minute, 0–59. + pub minute: u8, + /// The second, 0–59. + pub second: u8, + /// The sub-second fraction, as the raw byte on the wire. + /// + /// This byte was labeled `resv` ("reserved for alignment") at first, + /// but it is in fact used for sub-second resolution. Its exact unit + /// (e.g. milliseconds, or 1/256ths of a second) hasn't been confirmed + /// yet, so it is kept as a raw `u8` here instead of converted to + /// something like a `Duration` — convert it once the unit is settled. + pub subsecond: u8, +} + +/// Tags a [`DataOrderPacket`] as a board's periodic telemetry +/// ([`DataPacket`]) rather than a command sent to one. +/// +/// Carries no data — see [`DataOrderPacket`] for why it exists at all. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct Data; + +/// Tags a [`DataOrderPacket`] as a command sent to a board +/// ([`OrderPacket`]) rather than telemetry received from one. +/// +/// Carries no data — see [`DataOrderPacket`] for why it exists at all. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct Order; + +/// Bridges a [`DataOrderPacket`]'s phantom `Kind` to the runtime +/// [`PacketType`] variant it stands for. +/// +/// `protocol::packet::data_order`'s `encode`/`decode` are generic over +/// `Kind`: they're written once and work for both [`Data`] and [`Order`], +/// instead of needing a near-identical copy per type. This trait is the +/// one yes/no question that generic code can't answer on its own — +/// "is this `PacketDef`'s type actually the one I was asked to +/// encode/decode?" — everything after that (pulling out the +/// measurements) is already handled by [`PacketType::measurements`], +/// type-agnostic, so there's no need to redo that here. +pub trait PacketTypeTag { + /// Whether `packet_type` is the variant this `Kind` stands for. + fn matches(packet_type: &PacketType) -> bool; +} + +impl PacketTypeTag for Data { + fn matches(packet_type: &PacketType) -> bool { + matches!(packet_type, PacketType::Data(_)) + } +} + +impl PacketTypeTag for Order { + fn matches(packet_type: &PacketType) -> bool { + matches!(packet_type, PacketType::Order(_)) + } +} + +/// A Data/Order packet: the decoded values of the measurements a board just +/// sent, or that an order is about to send to one. +/// +/// The wire protocol is positional: values are not individually tagged +/// with their measurement's id, just written back to back in the order +/// their [`super::Measurement`]s appear in this packet's +/// [`super::PacketType::Data`] list. `values[i]` is the decoded value of +/// that list's `i`-th measurement — matching them up by position is +/// `protocol`'s job, this type just holds the result in that same order. +/// +/// `Kind` is a phantom type parameter (either [`Data`] or [`Order`], never +/// anything else — see [`DataPacket`]/[`OrderPacket`]): the struct stores +/// no `Kind` value, nothing to store (`Data`/`Order` carry no data), it +/// only exists so the compiler can tell a [`DataPacket`] apart from an +/// [`OrderPacket`], the same way [`super::AdjId`]/[`super::BoardId`] +/// (`id.rs`) are distinct types so the compiler won't let one be confused +/// with the other, even though both are just a `u16` underneath. Before +/// this, [`DataPacket`] and [`OrderPacket`] were both plain aliases for +/// the same concrete struct — nothing stopped a `DataPacket`, decoded off +/// the UDP socket, from being passed to [`crate::protocol::tcp::encode_order`] +/// by mistake; that mix-up is now a compile error: +/// +/// ```compile_fail +/// use software_core::model::{AdjId, DataPacket, OrderPacket}; +/// +/// fn send_order(_order: OrderPacket) {} +/// +/// let data = DataPacket::new(AdjId(1000), vec![]); +/// send_order(data); // doesn't compile: `DataPacket` isn't an `OrderPacket` +/// ``` +#[derive(Debug, Clone, PartialEq)] +pub struct DataOrderPacket { + /// The packet's id. + pub id: AdjId, + /// Each measurement's decoded value, in the same order as the + /// matching [`super::PacketType::Data`]/[`super::PacketType::Order`] + /// list. + pub values: Vec, + _marker: PhantomData, +} + +impl DataOrderPacket { + /// Builds a packet tagged as `Kind`, e.g. `DataPacket::new(id, values)` + /// or `OrderPacket::new(id, values)`. + pub fn new(id: AdjId, values: Vec) -> Self { + Self { + id, + values, + _marker: PhantomData, + } + } +} + +/// An order sent from the backend to a board. +/// +/// Positional, the same way [`DataPacket::values`] is: see its docs. +pub type OrderPacket = DataOrderPacket; +/// A set of measurements sent by a board. +/// +/// Positional, the same way [`DataOrderPacket::values`] is: see its docs. +pub type DataPacket = DataOrderPacket; + +/// A protection packet: sent by a board when one of its declared +/// [`super::Protection`]s triggers. +/// +/// `id` is the compound wire id: [`AdjId::measurement_id`] gives the +/// watched measurement, [`AdjId::protection_position`] which of that +/// measurement's protections triggered (see [`super::Protection::id`]). +/// Kept as a single field rather than storing both halves separately — +/// they're never independent of each other, so there's nothing a second +/// field would add beyond a second place for them to disagree. +#[derive(Debug, Clone, PartialEq)] +pub struct ProtectionPacket { + /// The compound id this protection triggered under. + pub id: AdjId, + /// When it triggered. + pub timestamp: ShortTimestamp, + /// The value that triggered it, decoded with the same wire type as the + /// watched measurement. + pub value: Value, +} + +/// How severe a message is (reusing `general_info.json`'s `message_ids`). +/// +/// Unlike [`super::Severity`], which only distinguishes fault from warning +/// for protections, a message has two extra levels: `messages` and +/// `protections` are unrelated wire formats as of ADJv3, so this is a +/// separate type on purpose, not a reuse of [`super::Severity`]. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum MessageLevel { + /// Stops the vehicle automatically. + Fault, + /// Flags something unexpected, without stopping the vehicle. + Warning, + /// Informational, no action implied. + Info, + /// An unrecoverable firmware error. + Panic, +} + +impl MessageLevel { + /// All four severities, in no particular order — for code that needs + /// to go through each one, e.g. building a lookup from a loaded + /// ADJ's `general_info.json` `message_ids` (see [`MessageLevel::name`]). + pub const ALL: [MessageLevel; 4] = [ + MessageLevel::Fault, + MessageLevel::Warning, + MessageLevel::Info, + MessageLevel::Panic, + ]; + + /// This severity's key in `general_info.json`'s `message_ids` map + /// (ADJv3: `"fault"`, `"warning"`, `"info"`, `"panic"`). That map + /// only gives a severity's *name*, not which `MessageLevel` it is — + /// this is the one place that association is spelled out, so + /// nothing else has to hardcode these four strings again. + pub fn name(self) -> &'static str { + match self { + MessageLevel::Fault => "fault", + MessageLevel::Warning => "warning", + MessageLevel::Info => "info", + MessageLevel::Panic => "panic", + } + } + + /// The inverse of [`MessageLevel::name`]: the severity named `name`, + /// or `None` if `name` isn't one of the four (e.g. `general_info.json` + /// declares other, unrelated reserved names in that same map). + pub fn from_name(name: &str) -> Option { + MessageLevel::ALL + .into_iter() + .find(|level| level.name() == name) + } +} + +/// A free-text message sent by a board. +#[derive(Debug, Clone, PartialEq)] +pub struct MessagePacket { + /// The wire id this message was sent under — one of the severities + /// declared in `general_info.json`'s `message_ids`. + /// + /// Not a [`MessageLevel`] directly, the same way [`ProtectionPacket::id`] + /// isn't a [`super::Protection`]: this is what was actually on the + /// wire, and resolving it to a severity means looking it up (see + /// [`PacketType::Message`]/[`crate::protocol::Index`]), not storing + /// a second, redundant copy of it here. + pub id: AdjId, + /// When it was sent. + pub timestamp: ShortTimestamp, + /// Where it came from, e.g. a source file path. + pub origin: String, + /// The message's contents. + pub message: String, +} + +/// Any packet actually sent or received over the wire, once decoded. +#[derive(Debug, Clone, PartialEq)] +pub enum Packet { + /// A set of measurements sent by a board. + Data(DataPacket), + /// An order sent to a board. + Order(OrderPacket), + /// A protection that triggered. + Protection(ProtectionPacket), + /// A free-text message sent by a board. + Message(MessagePacket), +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn two_timestamps_with_the_same_time_of_day_are_equal() { + let a = ShortTimestamp { + hour: 10, + minute: 30, + second: 0, + subsecond: 0, + }; + let b = ShortTimestamp { + hour: 10, + minute: 30, + second: 0, + subsecond: 0, + }; + assert_eq!(a, b); + } + + #[test] + fn two_timestamps_that_only_differ_in_subsecond_are_not_equal() { + let a = ShortTimestamp { + hour: 10, + minute: 30, + second: 0, + subsecond: 0, + }; + let b = ShortTimestamp { + hour: 10, + minute: 30, + second: 0, + subsecond: 128, + }; + assert_ne!(a, b); + } + + #[test] + fn a_protection_packets_id_splits_into_its_measurement_and_its_own_position() { + // (1 << 13) | 3000 = 8192 | 3000 = 11192 + let packet = ProtectionPacket { + id: AdjId((1u16 << 13) | 3000), + timestamp: ShortTimestamp { + hour: 12, + minute: 0, + second: 5, + subsecond: 0, + }, + value: Value::Number(53.2), + }; + + assert_eq!(packet.id.measurement_id(), AdjId(3000)); + assert_eq!(packet.id.protection_position(), 1); + } + + #[test] + fn message_level_has_four_distinct_values() { + let levels = [ + MessageLevel::Fault, + MessageLevel::Warning, + MessageLevel::Info, + MessageLevel::Panic, + ]; + + for (i, a) in levels.iter().enumerate() { + for (j, b) in levels.iter().enumerate() { + assert_eq!(a == b, i == j); + } + } + } + + #[test] + fn each_message_levels_name_matches_the_adj_and_is_distinct() { + let names: Vec<&str> = MessageLevel::ALL.iter().map(|level| level.name()).collect(); + assert_eq!(names, vec!["fault", "warning", "info", "panic"]); + } + + #[test] + fn from_name_is_the_inverse_of_name() { + for level in MessageLevel::ALL { + assert_eq!(MessageLevel::from_name(level.name()), Some(level)); + } + assert_eq!(MessageLevel::from_name("not_a_severity"), None); + } + + #[test] + fn data_packet_values_are_positional_not_tagged_with_an_id() { + // values[0] is whatever measurements[0] is in this packet's + // PacketDef — there is no id stored alongside each value here. + let packet = DataPacket::new(AdjId(1000), vec![Value::Number(53.2), Value::Bool(true)]); + + assert_eq!(packet.values[0], Value::Number(53.2)); + assert_eq!(packet.values[1], Value::Bool(true)); + } + + #[test] + fn packet_wraps_each_kind_without_mixing_them_up() { + let data = Packet::Data(DataPacket::new(AdjId(1000), vec![])); + let order = Packet::Order(OrderPacket::new(AdjId(2000), vec![])); + + assert_ne!(data, order); + match data { + Packet::Data(_) => {} + _ => unreachable!("this is a Packet::Data"), + } + } + + #[test] + fn two_data_packets_with_the_same_id_and_values_are_equal() { + let a = DataPacket::new(AdjId(1000), vec![Value::Number(1.0)]); + let b = DataPacket::new(AdjId(1000), vec![Value::Number(1.0)]); + assert_eq!(a, b); + } + + #[test] + fn an_order_packet_and_a_data_packet_built_from_the_same_id_and_values_are_different_types() { + // This is the whole point of tagging `DataOrderPacket` with a + // phantom `Kind`: `DataPacket` and `OrderPacket` used to be plain + // aliases for the same concrete struct, so nothing here would even + // have been a type error before. There's no runtime assertion to + // make for that — see this module's `compile_fail` doctest on + // `DataOrderPacket`, which proves the mix-up doesn't compile. + let data = DataPacket::new(AdjId(1000), vec![]); + let order = OrderPacket::new(AdjId(1000), vec![]); + assert_eq!(data.id, order.id); + assert_eq!(data.values, order.values); + } +} diff --git a/backend/crates/core/src/model/protections.rs b/backend/crates/core/src/model/protections.rs new file mode 100644 index 000000000..3159c107c --- /dev/null +++ b/backend/crates/core/src/model/protections.rs @@ -0,0 +1,171 @@ +//! Protection declarations. +//! +//! A [`Protection`] is a bound checked against a measurement's decoded +//! value, as declared for that measurement in the ADJ (see +//! `_measurements.json`, `protections` array). This describes the +//! *declaration*: what to watch for and how +//! severe it is. It is not the packet actually received over the wire when +//! a protection triggers; that belongs with the rest of the wire packets, +//! once `packet` exists. +//! +//! In ADJv2, a protection was just a `message` with a specific kind. +//! ADJv3 splits them into two unrelated wire formats, so from here on +//! `Protection` and a future `Message` type are not related at all. + +use crate::model::AdjId; +use std::time::Duration; + +/// What a protection checks, and the bound(s) it needs. +/// +/// Modeled as data-carrying variants instead of a flat `value: Vec` +/// plus a `range: bool` flag (as the ADJ JSON represents it), so a +/// protection with the wrong number of bounds for its kind — e.g. an +/// `Above` with two values, or a `Range` with only one — cannot be +/// represented at all. +#[derive(Debug, Clone, Copy, PartialEq)] +pub enum ProtectionKind { + /// Triggers when the value goes above `limit`. + Above { + /// The upper limit. + limit: f64, + }, + /// Triggers when the value goes below `limit`. + Below { + /// The lower limit. + limit: f64, + }, + /// Triggers when the value equals `target`. + Equal { + /// The value that must not occur. + target: f64, + }, + /// Triggers when the value is different from `target`. + NotEqual { + /// The value that is expected. + target: f64, + }, + /// Triggers when the value leaves the `[min, max]` interval. + /// + /// Unlike [`super::Range`], both bounds are mandatory here: the ADJ + /// always provides exactly two values for a `Range` protection, so + /// there is no "open-ended" case to represent. + Range { + /// The lower bound of the interval. + min: f64, + /// The upper bound of the interval. + max: f64, + }, +} + +/// How severe a triggered protection is. +/// +/// Only two values, unlike a message's severity: a protection is either a +/// [`Severity::Fault`], which stops the vehicle, or a [`Severity::Warning`], +/// which does not. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum Severity { + /// Stops the vehicle automatically. + Fault, + /// Flags the value as unexpected, without stopping the vehicle. + Warning, +} + +/// A single protection watching a measurement, as declared in the ADJ. +#[derive(Debug, Clone, Copy, PartialEq)] +pub struct Protection { + /// This protection's position within its measurement's `protections` + /// list, encoded as an [`AdjId`] in the 1–7 range. + /// + /// This is *not* an independently assigned id from the global ADJ id + /// space (`[0, 8191]`): a protection is only ever + /// addressed relative to the measurement that owns it. On the wire, + /// this position becomes the 3-bit `pos` field that, combined with the + /// owning measurement's 13-bit id, forms the compound id — that + /// combination is `protocol`'s job, not this type's. + pub id: AdjId, + /// What this protection checks and its bound(s). + pub kind: ProtectionKind, + /// How severe it is once triggered. + pub severity: Severity, + /// How long the value must stay out of bounds before this protection + /// triggers. `Duration::ZERO` (the ADJ's default) means it triggers + /// immediately. + pub time: Duration, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn a_range_protection_always_carries_both_bounds() { + let protection = Protection { + id: AdjId(1), + kind: ProtectionKind::Range { + min: 0.0, + max: 48.0, + }, + severity: Severity::Fault, + time: Duration::ZERO, + }; + + let ProtectionKind::Range { min, max } = protection.kind else { + unreachable!("protection was just constructed as Range above"); + }; + + assert_eq!(min, 0.0); + assert_eq!(max, 48.0); + } + + #[test] + fn two_protections_with_the_same_data_are_equal() { + let a = Protection { + id: AdjId(2), + kind: ProtectionKind::Above { limit: 100.0 }, + severity: Severity::Warning, + time: Duration::from_millis(500), + }; + let b = a; + assert_eq!(a, b); + } + + #[test] + fn zero_time_means_it_triggers_immediately() { + let protection = Protection { + id: AdjId(3), + kind: ProtectionKind::Equal { target: 0.0 }, + severity: Severity::Fault, + time: Duration::ZERO, + }; + + assert_eq!(protection.time, Duration::ZERO); + } + + #[test] + fn a_protections_id_is_its_position_not_a_global_id() { + // Two different measurements can each have a protection at + // position 1 — they are unrelated protections that happen to + // share the same "slot" id, disambiguated by their measurement. + let first_measurement_protection = Protection { + id: AdjId(1), + kind: ProtectionKind::Below { limit: -10.0 }, + severity: Severity::Warning, + time: Duration::ZERO, + }; + let second_measurement_protection = Protection { + id: AdjId(1), + kind: ProtectionKind::Above { limit: 90.0 }, + severity: Severity::Fault, + time: Duration::ZERO, + }; + + assert_eq!( + first_measurement_protection.id, + second_measurement_protection.id + ); + assert_ne!( + first_measurement_protection.kind, + second_measurement_protection.kind + ); + } +} diff --git a/backend/crates/core/src/model/value.rs b/backend/crates/core/src/model/value.rs new file mode 100644 index 000000000..5dcd7e62d --- /dev/null +++ b/backend/crates/core/src/model/value.rs @@ -0,0 +1,35 @@ +//! Decoded values. +//! +//! [`Value`] is how the backend represents a piece of data once it has been +//! decoded, regardless of what it looked like on the wire. Even though the +//! ADJ defines several numeric wire types (`uint8`, `float32`...), once a +//! number is decoded it is always stored as an `f64`: what matters from +//! here on is the number itself, not how many bytes it took on the wire. +//! The wire type only matters while decoding, and lives in `NumericKind` +//! instead. + +/// A single decoded value, of whichever shape the measurement defines. +#[derive(Debug, Clone, PartialEq)] +pub enum Value { + /// A numeric measurement, regardless of its original wire type. + Number(f64), + /// A boolean measurement. + Bool(bool), + /// The selected variant of an enum measurement, e.g. `"Operational"`. + Enum(String), +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn two_numbers_with_the_same_value_are_equal() { + assert_eq!(Value::Number(1.5), Value::Number(1.5)); + } + + #[test] + fn different_variants_are_never_equal_even_with_similar_data() { + assert_ne!(Value::Bool(true), Value::Enum("true".to_string())); + } +} diff --git a/backend/crates/core/src/ntp.rs b/backend/crates/core/src/ntp.rs new file mode 100644 index 000000000..7de54a6e5 --- /dev/null +++ b/backend/crates/core/src/ntp.rs @@ -0,0 +1,167 @@ +use crate::model::Port; +use ntp_server::{protocol::Stratum, server::NtpServer}; +use std::{ + io, + net::{Ipv4Addr, SocketAddrV4}, +}; +use tracing::{debug, info, instrument}; + +const NTP_DEFAULT_PORT: Port = Port(8123); + +/// Starts the NTP server with an interface and a port. +/// +/// Arguments: +/// - `interface`: IPv4 interface to bind to. If `None`, the default interface (`0.0.0.0`) is used. +/// - `port`: Port to listen on. If `None`, the default NTP port (`8123`) is used. +#[instrument(level = "info")] +pub async fn start_ntp_server(interface: Option, port: Option) -> io::Result<()> { + run_ntp_server(interface, port).await +} + +/// Starts the NTP server with a socket. +/// +/// Arguments: +/// - `socket`: Complete IPv4 socket address. If `None` the default `SocketAddrV4` is used (`0.0.0.0:8123`). +#[instrument(level = "info")] +pub async fn start_ntp_server_with_socket(socket: Option) -> io::Result<()> { + let (interface, port) = match socket { + Some(socket) => (Some(*socket.ip()), Some(Port(socket.port()))), + None => (None, None), + }; + + run_ntp_server(interface, port).await +} + +#[instrument(level = "info")] +async fn run_ntp_server(interface: Option, port: Option) -> io::Result<()> { + let server = build_ntp_server(interface, port).await?; + info!("Starting NTP server loop"); + // Any internal log of server.run() will be wrapped within this function Span + server.run().await +} + +async fn build_ntp_server( + interface: Option, + port: Option, +) -> io::Result { + let interface = interface.unwrap_or(Ipv4Addr::UNSPECIFIED); // Same as Ipv4Addr::new(0,0,0,0); + + let port = port.unwrap_or(NTP_DEFAULT_PORT); + + let socket_addr_v4 = SocketAddrV4::new(interface, port.0); + + // % -> use structured variables + debug!(%socket_addr_v4, "Building NTP server"); + + let server = NtpServer::builder() + .listen(socket_addr_v4.to_string()) + // Stratum indicates the server's distance from the source of the reference clock. + // This server synchronizes from a stratum 1 source, and advertises stratum 2 to its clients. + .stratum(Stratum(2)) + .build() + .await?; + + info!(%socket_addr_v4, "NTP server built successfully"); + + Ok(server) +} + +#[cfg(test)] +mod test { + + use super::*; + use ntp_server::protocol::{ + ConstPackedSizeBytes, FromBytes, Mode, Packet, TimestampFormat, ToBytes, Version, + }; + use std::time::Duration; + use tokio::net::UdpSocket; + use tracing_subscriber; + + // Initializes the subscriber for tests + fn init_tracing_for_tests() { + let _ = tracing_subscriber::fmt() + .with_env_filter("debug") + .with_test_writer() // Ensures that the logs are shown by cargo test + .try_init(); // Avoids the test failure if there is another test in parallel + } + + #[tokio::test] + // Verifies if the NTP server responds correctly to a client request + async fn ntp_server_responds_to_client_request() { + init_tracing_for_tests(); + + // Create the NTP server + let server = build_ntp_server(Some(Ipv4Addr::LOCALHOST), Some(Port(0))) + .await + .expect("NTP server should bind to an ephemeral local port"); + + // Get the address assigned by the OS + let server_addr = server + .local_addr() + .expect("NTP server should expose its bound address"); + + // Start the server on a thread + let server_task = tokio::spawn(server.run()); + + // Bind a UDP socket to send NTP requests + let socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0)) + .await + .expect("NTP client socket should bind to an ephemeral local port"); + + // Build NTP request packet for testing requests + let request = Packet { + transmit_timestamp: TimestampFormat { + // Random data for test purpose only, just to verify the server responds correctly + seconds: 0xE0000000, + fraction: 0x12345678, + }, + ..Packet::default() // Fills the rest of the packet with the default values + }; + + // Serialize the request into a fixed-size byte array. + let mut request_bytes = [0; Packet::PACKED_SIZE_BYTES]; + request + .to_bytes(&mut request_bytes) + .expect("NTP client request should serialize"); + + // Send the request + socket + .send_to(&request_bytes, server_addr) + .await + .expect("NTP client request should be sent"); + + // Waiting for the server to respond + let mut response_bytes = [0; 2048]; + let (response_len, source_addr) = tokio::time::timeout( + Duration::from_secs(2), + socket.recv_from(&mut response_bytes), + ) + .await + .expect("NTP server should respond before timeout") + .expect("NTP response should be received"); + + // Response should come from the same server address + assert_eq!(source_addr, server_addr); + // Response should have the same packet length + assert_eq!(response_len, Packet::PACKED_SIZE_BYTES); + + // Deserialize response and validate contents + let (response, bytes_read) = Packet::from_bytes(&response_bytes[..response_len]) + .expect("server response should be a valid NTP packet"); + assert_eq!(bytes_read, Packet::PACKED_SIZE_BYTES); + assert_eq!(response.mode, Mode::Server); + assert_eq!(response.version, Version::V4); + assert_eq!(response.stratum, Stratum(2)); + assert_eq!(response.origin_timestamp, request.transmit_timestamp); + assert_ne!(response.transmit_timestamp, TimestampFormat::default()); + + // Stop the server task and verify that it was cancelled. + server_task.abort(); + assert!( + server_task + .await + .expect_err("server task should be aborted") + .is_cancelled() + ); + } +} diff --git a/backend/crates/core/src/ntp/README.md b/backend/crates/core/src/ntp/README.md new file mode 100644 index 000000000..682784f52 --- /dev/null +++ b/backend/crates/core/src/ntp/README.md @@ -0,0 +1,31 @@ +# NTP module + +NTP (**Network Time Protocol**) is a protocol used to synchronize clocks between devices over a network. In this project, it is used to synchronize the boards in the pod, with the *backend*. + +There are two related concepts worth mentioning: + +- **SNTP (Simple Network Time Protocol):** a simplified subset of NTP intended for simpler synchronization scenarios, such as clients using a single time server. +- **NTS (Network Time Security):** an extension to NTP that adds authentication and cryptographic security to time synchronization (not used in this project). + +The boards in this project use **SNTP**. However, this module implements an **NTP server**, since NTP and SNTP use compatible protocol messages and are interoperable. An SNTP client can therefore communicate with this NTP server as defined by RFC 5905. + +## Implementation + +The server is implemented using the [`ntp_usg-server`](https://crates.io/crates/ntp_usg-server) crate with the **Tokio** runtime. It also uses [`tracing`](https://crates.io/crates/tracing) crate for logging. + +The crate handles the NTP protocol logic, including request parsing and response generation, while this module is responsible for configuring and starting the server. + +The server interface and port can be configured when starting it. By default, the server listens on: + +- Interface: `0.0.0.0` +- Port: `8123` + +The standard NTP port is `123`, but this project uses `8123` as its default port. + +## Documentation + +The module documentation can be generated and opened with: + +```bash +cargo doc --open -p software-core -F ntp --no-deps +``` \ No newline at end of file diff --git a/backend/crates/core/src/protocol.rs b/backend/crates/core/src/protocol.rs new file mode 100644 index 000000000..e89fe6064 --- /dev/null +++ b/backend/crates/core/src/protocol.rs @@ -0,0 +1,24 @@ +//! Translates bytes <-> typed packets ([`crate::model::Packet`] and +//! friends), using the shapes [`crate::adj`] already declared +//! (`PacketDef`, `Measurement`) as the schema. Never touches a real +//! socket — that's `core::net`'s job, which calls into this module's +//! functions and owns the actual `TcpStream`/`UdpSocket`. +//! +//! The TCP/UDP split lives in the *types* each submodule can produce: +//! [`crate::protocol::udp::decode_datagram`] can only ever return a +//! `DataPacket`, [`crate::protocol::tcp::decode_next`] only a +//! [`crate::protocol::tcp::TcpFrame`] (`Protection`/`Message`) — the +//! compiler enforces the separation the ADJ itself draws between what +//! travels over which transport, not runtime convention. `tcp`/`udp` +//! themselves are thin wrappers around [`crate::protocol::packet`], which +//! does the actual per-packet-type work independent of transport. + +mod error; +mod index; +pub mod packet; +pub mod tcp; +pub mod udp; +pub mod wire; + +pub use error::{DecodeError, EncodeError}; +pub use index::Index; diff --git a/backend/crates/core/src/protocol/README.md b/backend/crates/core/src/protocol/README.md new file mode 100644 index 000000000..f107da5d2 --- /dev/null +++ b/backend/crates/core/src/protocol/README.md @@ -0,0 +1,213 @@ +# Protocol Module + +This module handles encoding and decoding of packets for communication with hardware boards over TCP and UDP transports. It implements the ADJ protocol for telemetry data, commands, messages, and protection events. + +## Architecture + +The protocol module follows a layered architecture: + +``` +┌─────────────────────────────────────────┐ +│ Transport Layer │ +│ (tcp.rs, udp.rs) │ +├─────────────────────────────────────────┤ +│ Packet Layer │ +│ (packet/data_order.rs, │ +│ packet/message.rs, │ +│ packet/protection.rs) │ +├─────────────────────────────────────────┤ +│ Wire Layer │ +│ (wire.rs) │ +└─────────────────────────────────────────┘ +``` + +## Directory Structure + +``` +protocol/ +├── index.rs # Packet definition lookup table +├── error.rs # Decode and encode error types +├── wire.rs # Low-level byte ↔ value conversion +├── packet.rs # Packet-level encoding/decoding module +│ ├── data_order.rs # Data (telemetry) & Order (command) packets +│ ├── message.rs # Free-text log message packets +│ └── protection.rs # Protection trigger packets +├── tcp.rs # TCP transport framing +└── udp.rs # UDP transport framing +``` + +## Modules + +### `index.rs` - Packet Definition Lookup + +Provides a fast lookup table from packet IDs (`AdjId`) to their declarations (`PacketDef`). Built once from loaded ADJ configuration data (`PodData`), it owns cloned copies of packet definitions so it can be shared across async tasks via `Arc`. + +A message severity is not a separate lookup bolted onto `Index` — it's just another `PacketDef`. `Index::new(pod_data, message_levels)` takes `message_levels` as `Option<&HashMap>` (an ADJ's `adj::AdjInfo::message_levels` — `None` for callers with no `AdjInfo` at all, e.g. most tests here) and, for each entry, synthesizes a `PacketDef { packet_type: PacketType::Message(level), board: BoardId(0), .. }` into the very same `AdjId -> PacketDef` table as every board's own packets. `BoardId(0)` (reserved, not validated — see `AdjId`/`BoardId`'s own docs) because a severity isn't owned by any one board. Resolving a message is then `Index::packet(id)` + matching `PacketType::Message(level)`, exactly like `packet::protection` already does for `PacketType::Protection`. + +**Key types:** +- `Index` - HashMap-based lookup from `AdjId` to `PacketDef` (synthesized `Message` entries included) + +**Key functions:** +- `Index::new(pod_data, message_levels)` - Build an index from a loaded ADJ's `PodData` and, optionally, its `AdjInfo::message_levels` +- `Index::packet(id)` - Look up a packet's declaration by id — `Data`, `Order`, `Protection` or `Message` alike + +### `error.rs` - Error Types + +Defines errors that can occur during packet encoding and decoding. + +**Key types:** +- `DecodeError` - Errors when converting bytes to packets + - `UnknownId` - No packet declared with this ID + - `UnexpectedEof` - Ran out of bytes during decode + - `Io` - I/O error reading from stream (TCP only) + - `InvalidEnumValue` - Enum index out of range + - `UnterminatedString` - String field not null-terminated + - `InvalidUtf8` - String field's bytes weren't valid UTF-8 + - `WrongPacketType` - Packet exists but isn't expected type + +- `EncodeError` - Errors when converting packets to bytes + - `UnknownId` - No packet declared with this ID + - `WrongFieldCount` - Missing or extra fields in order + - `TypeMismatch` - Value doesn't match declared type + - `OutOfRange` - Numeric value doesn't fit wire type + - `WrongPacketType` - Packet exists but isn't expected type + - `StringTooLong` - String field + terminator doesn't fit the max length + - `EmbeddedNulByte` - String field contains a `\0` byte + +### `wire.rs` - Low-Level Byte Codec + +Handles conversion between raw bytes and `Value` types for individual measurements, based on their declared `MeasurementKind`. All numeric types use little-endian encoding. + +**Key functions:** +- `decode_value(bytes, kind)` - Decode a single value from bytes +- `encode_value(value, kind)` - Encode a single value to bytes +- `byte_width(kind)` - Get the wire width in bytes for a measurement kind + +**Supported types:** +- **Numeric** (U8, U16, U32, U64, I8, I16, I32, I64, F32, F64) - ✓ Implemented +- **Enum** (single byte index) - ✓ Implemented +- **Boolean** (single byte, zero = `false`, nonzero = `true`) - ✓ Implemented + +### `packet/` - Packet-Level Encoding/Decoding + +Contains per-packet-type encoding and decoding logic, independent of +transport. **Hard rule for this directory: all byte-level parsing for a +packet type lives in its own file here, never in `tcp.rs`/`udp.rs`.** +See **[`packet/README.md`](packet/README.md)** for the full design +rationale (the `Option` pattern below, and exactly what `tcp.rs` +is and isn't allowed to do). + +#### `data_order.rs` + +Handles the positional Data/Order wire shape shared by both packet types +(see `model::DataOrderPacket`'s phantom `Kind`). `encode`/`decode` are +generic over `Kind`, written once for both: +- **Order packets** (commands sent to boards) - sent over TCP +- **Data packets** (periodic telemetry from boards) - received over UDP + +Self-contained both ways: they always read/write the leading 2-byte id +themselves (there's no dispatch ambiguity to resolve first here). The +backend itself only ever calls `encode` with an Order packet (via +`tcp::encode_order`) and `decode::` (via `udp::decode_datagram`) - +that direction restriction lives at the transport layer, not here. + +**Key functions:** +- `encode(packet, index)` - Encode a Data or Order packet into bytes (`Kind` inferred from `packet`'s type) +- `decode::(bytes, index)` - Decode bytes into a Data or Order packet + +#### `message.rs` + +Decodes free-text log messages from boards over TCP (decode only — in +production this only ever travels board → backend). `encode` also +exists, but purely for test symmetry; nothing in the real backend calls +it. + +Unlike `data_order.rs`, a TCP dispatcher needs this frame's leading id +*before* it even knows to call this file (to tell a message apart from +a protection) — so, same as `protection.rs`, `id` is `Option`: +`Some` if the caller already read it (and `reader` starts right after +the id), `None` to have `decode` read it itself. Either way, `id` is +resolved against `index` to confirm it's actually a declared +`PacketType::Message` (`UnknownId`/`WrongPacketType` otherwise) — but unlike +`protection.rs`, the severity itself is never stored on the decoded +`MessagePacket`; it's metadata about the id, not about this particular +instance, so look it up again via `index.packet(id)` if it's needed. + +**Key functions:** +- `decode(reader, id: Option, index)` - Decode a message frame, resolving its id itself if not given one +- `encode(packet, index)` - Test-only: encode a complete `MessagePacket` frame, id included + +#### `protection.rs` + +Decodes protection trigger events from boards over TCP (decode only — +in production this only ever travels board → backend). `encode` also +exists, but purely for test symmetry; nothing in the real backend calls +it. + +Same `Option` pattern as `message.rs`, for the same reason: a TCP +dispatcher needs the leading id first to tell a protection apart from a +message. `compound_id: Option` - `Some` if the caller already +read it, `None` to have `decode` read it itself off `reader`'s first 2 +bytes. + +**Key functions:** +- `decode(reader, compound_id: Option, index)` - Decode a protection frame, resolving its id itself if not given one +- `encode(packet, index)` - Test-only: encode a complete `ProtectionPacket` frame, id included + +### `tcp.rs` - TCP Transport Framing + +Handles the dedicated TCP connection to each board. A TCP connection carries: +- Protection events (board → backend) +- Free-text messages (board → backend) +- Order commands (backend → board) + +`decode_next` reads the frame's leading 16-bit id itself (via `packet::read_id`, `pub(super)` so `tcp` — a sibling of `packet`, not a descendant — can reach it), then dispatches purely on the raw id: `id.0 >= 8192` (`1 << 13` — a protection's compound id always has its high 3 bits set, see `AdjId`'s own docs) goes to `packet::protection::decode(reader, Some(id), index)`, anything below that to `packet::message::decode(reader, Some(id), index)`. Neither branch does its own lookup first — each `decode` already resolves `UnknownId`/`WrongPacketType` against `index` itself. + +**Key types:** +- `TcpFrame` - Enum of frames that can be received over TCP (Protection, Message) + +**Key functions:** +- `decode_next(reader, index)` - ✓ Implemented - Decode the next frame from a TCP stream +- `encode_order(order, index)` - ✓ Implemented - Encode an order for sending + +### `udp.rs` - UDP Transport Framing + +Handles the shared UDP socket for periodic telemetry. UDP datagrams are complete, already-delimited buffers containing Data packets. + +**Key functions:** +- `decode_datagram(bytes, index)` - ✓ Implemented - Decode a UDP datagram into a DataPacket + +## Packet Types Summary + +| Packet Type | Direction | Transport | Status | +|-------------|-----------|-----------|--------| +| Data (telemetry) | Board → Backend | UDP | ✓ Implemented | +| Order (command) | Backend → Board | TCP | ✓ Implemented | +| Message (log) | Board → Backend | TCP | ✓ Implemented (decode is the only real direction; `encode` is test-only) | +| Protection (event) | Board → Backend | TCP | ✓ Implemented (decode is the only real direction; `encode` is test-only) | + +## Implementation Status + +- ✅ **Data packets** - Full encode/decode with tests +- ✅ **Order packets** - Full encode/decode with tests +- ✅ **Wire-level numeric types** - All numeric kinds supported with tests +- ✅ **Wire-level enum types** - Full encode/decode with tests +- ✅ **Wire-level boolean types** - Single byte, confirmed with firmware +- ✅ **Message packets** - decode implemented, with tests (encode exists for test symmetry only) +- ✅ **Protection packets** - decode implemented, with tests (encode exists for test symmetry only) +- ✅ **TCP framing** - `decode_next` implemented and tested (dispatches to protection/message by `id.0 >= 8192`) + +## Testing + +The module includes comprehensive unit tests for: +- Wire-level encoding/decoding for all numeric, boolean and enum types +- Order/Data packet encoding and decoding, including round trips +- Message/Protection packet decoding (timestamps, strings, values) and + their test-only encoding, including round trips +- Error propagation for unknown IDs, wrong packet types, type mismatches, + unterminated/invalid strings, and out-of-range values + +Run tests with: +```bash +cargo test -p core protocol +``` diff --git a/backend/crates/core/src/protocol/error.rs b/backend/crates/core/src/protocol/error.rs new file mode 100644 index 000000000..b6de39dea --- /dev/null +++ b/backend/crates/core/src/protocol/error.rs @@ -0,0 +1,135 @@ +//! Errors produced while translating bytes into packets and back. + +use crate::model::AdjId; + +/// An error decoding bytes into a packet. +#[derive(Debug, thiserror::Error)] +pub enum DecodeError { + /// No packet is declared with this id. + #[error("unknown packet id {0:?}")] + UnknownId(AdjId), + + /// Ran out of bytes before a complete value could be decoded. + #[error("not enough bytes to decode a value")] + UnexpectedEof, + + /// An I/O error while reading from a stream (TCP only — a UDP + /// datagram is decoded from an in-memory buffer, never a stream). + #[error("I/O error reading a frame")] + Io(#[from] std::io::Error), + + /// A decoded enum value's index doesn't match any of its declared + /// options. + #[error("enum value {index} is out of range for {options} option(s)")] + InvalidEnumValue { + /// The decoded index. + index: u32, + /// How many options the measurement declares. + options: usize, + }, + + /// A free-text field (`origin`/`message`) had no terminating `0` byte + /// within its maximum length. + #[error("string field wasn't terminated within {max} bytes")] + UnterminatedString { + /// The field's maximum length. + max: usize, + }, + + /// A free-text field's bytes weren't valid UTF-8. + #[error("string field wasn't valid UTF-8: {0:?}")] + InvalidUtf8(Vec), + + /// A looked-up packet exists, but isn't the type this function expects + /// (e.g. `packet::data::decode` found an id that resolves to an + /// `Order`). + #[error("packet {id:?} isn't the expected type")] + WrongPacketType { + /// The packet whose type didn't match. + id: AdjId, + }, +} + +impl PartialEq for DecodeError { + // `Io`'s `std::io::Error` doesn't implement `PartialEq`, so this can't + // be derived — compare by `ErrorKind` instead for that variant. + fn eq(&self, other: &Self) -> bool { + match (self, other) { + (Self::UnknownId(a), Self::UnknownId(b)) => a == b, + (Self::UnexpectedEof, Self::UnexpectedEof) => true, + (Self::Io(a), Self::Io(b)) => a.kind() == b.kind(), + ( + Self::InvalidEnumValue { + index: a_index, + options: a_options, + }, + Self::InvalidEnumValue { + index: b_index, + options: b_options, + }, + ) => a_index == b_index && a_options == b_options, + (Self::UnterminatedString { max: a }, Self::UnterminatedString { max: b }) => a == b, + (Self::InvalidUtf8(a), Self::InvalidUtf8(b)) => a == b, + (Self::WrongPacketType { id: a }, Self::WrongPacketType { id: b }) => a == b, + _ => false, + } + } +} + +/// An error encoding a packet into bytes. +#[derive(Debug, thiserror::Error, PartialEq)] +pub enum EncodeError { + /// No packet is declared with this id. + #[error("unknown packet id {0:?}")] + UnknownId(AdjId), + + /// The order didn't provide a value for every field its declaration + /// expects. + #[error("order needs {expected} field(s), got {got}")] + WrongFieldCount { + /// How many fields the order's `PacketDef` declares. + expected: usize, + /// How many fields were actually given. + got: usize, + }, + + /// A field's [`crate::model::Value`] doesn't match the kind its + /// [`crate::model::Measurement`] declares (e.g. a `Value::Bool` for a + /// numeric field). + #[error("value doesn't match its declared type")] + TypeMismatch, + + /// A numeric value doesn't fit the wire type's representable range + /// (or is NaN). + #[error("value {value} is out of range for this wire type ({min}..={max})")] + OutOfRange { + /// The value that didn't fit. + value: f64, + /// The wire type's minimum representable value. + min: f64, + /// The wire type's maximum representable value. + max: f64, + }, + + /// A looked-up packet exists, but isn't the type this function expects + /// (e.g. `packet::order::encode` found an id that resolves to a + /// `Data` packet). + #[error("packet {id:?} isn't the expected type")] + WrongPacketType { + /// The packet whose type didn't match. + id: AdjId, + }, + + /// A string field's content plus its terminator wouldn't fit in the + /// wire format's maximum length. + #[error("string content plus its terminator doesn't fit in {max} byte(s)")] + StringTooLong { + /// The field's maximum length, terminator included. + max: usize, + }, + + /// A string field contains an embedded NUL byte, which would be + /// misread as an early terminator on the wire. + #[error("string contains an embedded NUL byte")] + EmbeddedNulByte, +} diff --git a/backend/crates/core/src/protocol/index.rs b/backend/crates/core/src/protocol/index.rs new file mode 100644 index 000000000..0f9d5a5bd --- /dev/null +++ b/backend/crates/core/src/protocol/index.rs @@ -0,0 +1,127 @@ +//! The `id -> PacketDef` lookup `tcp`/`udp` decode against. + +use crate::model::{AdjId, BoardId, MessageLevel, PacketDef, PacketType, PodData}; +use std::collections::HashMap; + +/// A lookup table from a packet's [`AdjId`] to its declaration, built once +/// from a loaded ADJ's [`PodData`] — and, optionally, its message +/// severities too. +/// +/// Owns its own copy of every [`PacketDef`] (cloned out of `PodData` at +/// construction) rather than borrowing, so it carries no lifetime and can +/// be shared across `tokio::spawn`ed tasks via `Arc` without a +/// fight with the borrow checker. Knows nothing about networking (no +/// `IpAddr`/`SocketAddr`) — that bookkeeping belongs to `core::net`, not +/// here. +#[derive(Debug, Clone, PartialEq, Default)] +pub struct Index { + by_id: HashMap, +} + +impl Index { + /// Builds an index over every packet declared by every board in + /// `pod_data`, plus one synthesized [`PacketDef`] per entry in + /// `message_levels` (an ADJ's `general_info.json`-derived + /// [`crate::adj::AdjInfo::message_levels`]). + /// + /// `message_levels` is `Option` rather than a plain reference so + /// that callers with no [`crate::adj::AdjInfo`] at hand — most tests + /// in this crate, which only ever build a bare [`PodData`] — can + /// just pass `None` instead of having to construct an empty map. + /// + /// A message severity isn't declared by any one board (any board's + /// free-text log frame can reuse the same `"fault"` id), so its + /// synthesized `PacketDef` gets the reserved `BoardId(0)` — no real + /// board uses that id — instead of a real one. + pub fn new(pod_data: &PodData, message_levels: Option<&HashMap>) -> Self { + let mut by_id: HashMap = pod_data + .boards + .values() + .flat_map(|board| board.packets.values()) + .map(|packet| (packet.id, packet.clone())) + .collect(); + + if let Some(message_levels) = message_levels { + for (&id, &level) in message_levels { + by_id.insert( + id, + PacketDef { + id, + board: BoardId(0), + name: level.name().to_string(), + packet_type: PacketType::Message(level), + }, + ); + } + } + + Self { by_id } + } + + /// Looks up a packet's declaration by id — a message severity + /// resolves through here too, as a synthesized `PacketDef` with + /// `packet_type: PacketType::Message(level)`; see this type's doc + /// comment. + pub fn packet(&self, id: AdjId) -> Option<&PacketDef> { + self.by_id.get(&id) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::{Board, BoardId, MacAddress, PacketType}; + use std::net::IpAddr; + + fn sample_pod_data() -> PodData { + let packet = PacketDef { + id: AdjId(1000), + board: BoardId(1), + name: "bcu_data".to_string(), + packet_type: PacketType::Data(vec![]), + }; + let board = Board { + id: BoardId(1), + name: "BCU".to_string(), + ip: IpAddr::from([192, 168, 0, 10]), + mac: MacAddress([0; 6]), + packets: HashMap::from([(packet.id, packet)]), + }; + PodData { + boards: HashMap::from([(board.id, board)]), + } + } + + #[test] + fn finds_a_packet_declared_on_any_board() { + let index = Index::new(&sample_pod_data(), None); + let Some(packet) = index.packet(AdjId(1000)) else { + unreachable!("packet 1000 was declared in the sample pod data"); + }; + assert_eq!(packet.name, "bcu_data"); + } + + #[test] + fn unknown_id_is_not_found() { + let index = Index::new(&sample_pod_data(), None); + assert!(index.packet(AdjId(9999)).is_none()); + } + + #[test] + fn a_message_severity_resolves_as_a_synthesized_packet_def() { + let message_levels = HashMap::from([(AdjId(2), MessageLevel::Fault)]); + let index = Index::new(&sample_pod_data(), Some(&message_levels)); + + let Some(packet) = index.packet(AdjId(2)) else { + unreachable!("the \"fault\" severity was declared at id 2"); + }; + assert_eq!(packet.packet_type, PacketType::Message(MessageLevel::Fault)); + assert_eq!(packet.board, BoardId(0)); + } + + #[test] + fn with_no_message_levels_given_only_board_packets_resolve() { + let index = Index::new(&sample_pod_data(), None); + assert_eq!(index.packet(AdjId(2)), None); + } +} diff --git a/backend/crates/core/src/protocol/packet.rs b/backend/crates/core/src/protocol/packet.rs new file mode 100644 index 000000000..3e061e44d --- /dev/null +++ b/backend/crates/core/src/protocol/packet.rs @@ -0,0 +1,41 @@ +//! Encode/decode for one specific type of packet, independent of which +//! transport carries it — that mapping lives in [`super::tcp`]/ +//! [`super::udp`], which are thin wrappers around these. +//! +//! [`data_order`]'s `encode`/`decode` are generic over `Kind` +//! ([`crate::model::PacketTypeTag`]), so they work for both `Data` and +//! `Order` alike; the backend itself only ever exercises one direction per +//! type (an order is only ever sent, data only ever received), but that's +//! a restriction `tcp`/`udp` apply, not something baked into the codec. +//! +//! [`message`]/[`protection`] are genuinely one-directional in +//! production — a board only ever sends these, never receives them — +//! but both also expose an `encode`, purely so tests can build +//! well-formed frames without hand-written byte arrays; see each +//! module's own doc comment. + +pub mod data_order; +pub mod message; +pub mod protection; + +use crate::model::AdjId; +use crate::protocol::DecodeError; +use std::io::Read; + +/// Reads a raw little-endian 16-bit id off the front of `reader`. +/// +/// Shared by [`message`]/[`protection`] — the only two types whose +/// `decode` ever needs to read its own leading id, when the caller +/// doesn't already know it (see each module's own doc comment on why) — +/// and by [`super::tcp::decode_next`], which needs the id *before* it +/// can even decide which of the two to call. `pub(super)` (visible to +/// `protocol` and everything under it) rather than private, for that +/// last caller: `tcp` is `packet`'s sibling, not its descendant, so +/// private wouldn't reach it. [`data_order`] doesn't need this: it reads +/// its id a different way, straight out of an in-memory byte slice, +/// never a `Read` stream. +pub(super) fn read_id(reader: &mut impl Read) -> Result { + let mut bytes = [0u8; 2]; + reader.read_exact(&mut bytes)?; + Ok(AdjId(u16::from_le_bytes(bytes))) +} diff --git a/backend/crates/core/src/protocol/packet/README.md b/backend/crates/core/src/protocol/packet/README.md new file mode 100644 index 000000000..b55d7556b --- /dev/null +++ b/backend/crates/core/src/protocol/packet/README.md @@ -0,0 +1,94 @@ +# `packet/` — Per-Packet-Type Codecs + +Each file here owns **all** the byte-level parsing for one packet type — +how many bytes a field takes, in what order, what terminates a string, +what the leading id means. That parsing never gets split out into +`tcp.rs`/`udp.rs` (the transport layer) or anywhere else. A transport +module is only ever allowed to do the one thing it structurally has no +choice about — see "The dispatcher's one unavoidable read" below — and +then hands the rest straight to one of these files. + +## `data_order.rs` + +Self-contained both ways: `encode`/`decode` always read/write the +leading 2-byte id themselves, since there's no dispatch ambiguity to +resolve first — a UDP datagram is unambiguously `Data`, and an order is +only ever something the backend already decided to send. Generic over +`Kind` (`model::PacketTypeTag`), written once for both `Data` and `Order` — +see its own module doc and `model/README.md`'s §4.2 for why. + +## `message.rs` / `protection.rs` + +These two are different: over TCP, a `Protection` frame and a `Message` +frame share the same leading 16-bit id space, so **something** has to +read that id before it even knows which of the two decoders to call. +That something is `tcp::decode_next`. To keep that reality from leaking +actual decoding logic into `tcp.rs`, both files take their id as +`Option` — the exact same shape: + +```rust +// protection.rs +pub fn decode(reader: impl Read, compound_id: Option, index: &Index) -> Result; +pub fn encode(packet: &ProtectionPacket, index: &Index) -> Result, EncodeError>; + +// message.rs +pub fn decode(reader: impl Read, id: Option, index: &Index) -> Result; +pub fn encode(packet: &MessagePacket, index: &Index) -> Result, EncodeError>; +``` + +- **`Some(known_value)`** — the caller already read it, typically + because it had to read the leading id anyway to decide which of these + two functions to call in the first place. In this case `reader` must + already be positioned *right after* the id (byte 2 onward). +- **`None`** — the caller doesn't know it and isn't going to try. In + this case `reader` must start at byte 0 of the frame, id included, and + `decode` reads those 2 bytes itself. Either way, the id is then + resolved against `index` — `index.packet(id)` + matching + `PacketType::Protection`/`PacketType::Message` — to confirm it's + actually the declared type (`UnknownId`/`WrongPacketType` otherwise). A + message's severity is just another `PacketDef` by the time it gets + here (see `index.rs`'s own docs) — there's no separate lookup for it. + +One real difference between the two: `ProtectionPacket` stores its +`id` *and* the triggering `value` (which needs the watched measurement's +wire type, from `PacketType::Protection(measurement)`, to decode at +all). `MessagePacket` only stores `id` — its severity is metadata +*about* that id, not part of the frame's own byte layout, so `decode` +only uses `PacketType::Message(level)` to confirm the type and discards +`level` immediately; nothing about `timestamp`/`origin`/`message`'s +bytes depends on which severity it is. Look the severity up again via +`index.packet(id)` if it's needed later — it's never stored redundantly +on the decoded instance. + +Either way, **every byte of this frame is parsed inside the file that +owns that packet type** — `tcp.rs` never touches a timestamp, a `resv` +byte, a measurement's wire width, or a NUL-terminated string. `encode` +always writes the leading id back out too (from `packet.id`, after +confirming via `index` it resolves to the right type), so its output is +a complete, self-contained frame — feed it straight into +`decode(reader, None, index)` and get the same packet back; that's +exactly what each file's round-trip test does. + +### The dispatcher's one unavoidable read + +`tcp::decode_next` still has to read the raw 2-byte id itself once, to +decide *which* of `protection::decode`/`message::decode` to call — there +is no way around this for a non-seekable stream: once those bytes are +consumed, there's no handing them to the other function's `None` path +instead. That single mechanical "read a `u16`" is the one piece of +byte-handling that's expected to exist in `tcp.rs` — it calls the exact +same private `read_id` helper `protection.rs`/`message.rs` use for their +own `None` path (defined once in `packet.rs`, `pub(super)` so `tcp.rs` +can reach it too, rather than duplicated a third time). It is not +decoding — nothing is validated or interpreted by it beyond a single +`id.0 >= 8192` comparison (a protection's compound id always has its +high 3 bits set, see `AdjId`'s own docs) — and its result is +immediately handed to the matching function as `Some(id)`, which then +resolves it against `index` itself and does everything else. + +## Tests + +Every file's test module proves both `Some` and `None` work, plus a +round trip through its own `encode`/`decode` (`protection.rs`, +`message.rs`) or through `encode::`/`decode::` +(`data_order.rs`). See each file's own tests for the exact byte layouts. diff --git a/backend/crates/core/src/protocol/packet/data_order.rs b/backend/crates/core/src/protocol/packet/data_order.rs new file mode 100644 index 000000000..caca99161 --- /dev/null +++ b/backend/crates/core/src/protocol/packet/data_order.rs @@ -0,0 +1,426 @@ +//! Encodes and decodes a positional Data/Order packet — see +//! [`crate::model::DataOrderPacket`] for why both share this one wire +//! shape under a phantom `Kind`. +//! +//! [`encode`]/[`decode`] are generic over that `Kind` via +//! [`crate::model::PacketTypeTag`], so they're written once and work for +//! either [`crate::model::Data`] or [`crate::model::Order`] — the backend +//! itself only ever calls `encode::` (via [`super::super::tcp`]) +//! and `decode::` (via [`super::super::udp`]), but that restriction +//! lives at the transport layer, not here. [`crate::model::PacketTypeTag`] +//! only answers whether a `PacketDef`'s type matches `Kind` at all; the +//! actual measurement list comes from +//! [`crate::model::PacketType::measurements`] either way. + +use crate::model::{AdjId, DataOrderPacket, PacketTypeTag}; +use crate::protocol::{DecodeError, EncodeError, Index, wire}; + +/// Encodes `packet` into the bytes to write to a board's connection, +/// resolving its field shapes against `index`. +pub fn encode( + packet: &DataOrderPacket, + index: &Index, +) -> Result, EncodeError> { + // Look up the packet definition for this packet's id + let packet_def = index + .packet(packet.id) + .ok_or(EncodeError::UnknownId(packet.id))?; + + // Check that the packet is an order or data, as expected by the generic PacketTypeTag + if !Kind::matches(&packet_def.packet_type) { + return Err(EncodeError::WrongPacketType { id: packet.id }); + } + + // Get the measurements for this packet + let measurements = packet_def.packet_type.measurements(); + + // Check that the number of values that we want to encode matches the number of measurements in the packet definition + if packet.values.len() != measurements.len() { + return Err(EncodeError::WrongFieldCount { + expected: measurements.len(), + got: packet.values.len(), + }); + } + + // Encode the packet id as little-endian u16 + let mut bytes = Vec::new(); + bytes.extend_from_slice(&packet.id.0.to_le_bytes()); + + // for each value in the packet encode it according to the corresponding measurements + for (field, measurement) in packet.values.iter().zip(measurements) { + // Encode the field value according to the measurement's kind + let field_bytes = wire::encode_value(field, &measurement.kind)?; + + // Append the encoded field bytes to the output vector + bytes.extend(field_bytes); + } + + Ok(bytes) +} + +/// Decodes a complete, already-delimited buffer into a +/// [`DataOrderPacket`], resolving its field shapes against `index`. +pub fn decode( + bytes: &[u8], + index: &Index, +) -> Result, DecodeError> { + // The first two bytes are the packet id, in little-endian u16 + if bytes.len() < 2 { + return Err(DecodeError::UnexpectedEof); + } + + // generate the packet id from the first two bytes + let id: [u8; 2] = bytes[0..2] + .try_into() + .map_err(|_| DecodeError::UnexpectedEof)?; + + // generate ADJ id from the little-endian bytes + let adj_id = AdjId(u16::from_le_bytes(id)); + + // Look up the packet definition for this id if not found return an UnknownId error + let packet_def = index.packet(adj_id).ok_or(DecodeError::UnknownId(adj_id))?; + + // Check that the packet is an order or data, as expected by the generic PacketTypeTag + if !Kind::matches(&packet_def.packet_type) { + return Err(DecodeError::WrongPacketType { id: adj_id }); + } + // Get the measurements for this packet + let measurements = packet_def.packet_type.measurements(); + + // Prepare a vector to hold the decoded values and a pointer to track the current position in the byte slice + let mut values = Vec::with_capacity(measurements.len()); + let mut pointer = 2; + + // For each measurement, decode the corresponding bytes from the input slice + for measurement in measurements { + let width = wire::byte_width(&measurement.kind); + let next = pointer + width; + + // Check if there are enough bytes to decode the field + if bytes.len() < next { + return Err(DecodeError::UnexpectedEof); + } + + // Slice the bytes for the current field and decode it according to the measurement's kind + let field = &bytes[pointer..next]; + let value = wire::decode_value(field, &measurement.kind)?; // Append the decoded value to the values vector + values.push(value); + + pointer = next; + } + + Ok(DataOrderPacket::new(adj_id, values)) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::{ + Board, BoardId, Data, DataPacket, MacAddress, Measurement, MeasurementKind, NumericKind, + Order, OrderPacket, PacketDef, PacketType, PodData, Value, + }; + use std::collections::HashMap; + use std::net::IpAddr; + + // Auxiliar function to create a sample measurement for testing + + fn sample_measurement(id: u16, kind: MeasurementKind) -> Measurement { + Measurement { + id: AdjId(id), + alias: format!("field_{id}"), + name: format!("Field {id}"), + display_units: String::new(), + kind, + protections: vec![], + } + } + + fn sample_packet_def(id: AdjId, packet_type: PacketType) -> PacketDef { + PacketDef { + id, + board: BoardId(1), + name: "TestPacket".into(), + packet_type, + } + } + + fn make_test_index(defs: Vec) -> Index { + let packets: HashMap = defs.into_iter().map(|p| (p.id, p)).collect(); + let board = Board { + id: BoardId(1), + name: "TestBoard".to_string(), + ip: IpAddr::from([127, 0, 0, 1]), + mac: MacAddress([0; 6]), + packets, + }; + let pod_data = PodData { + boards: HashMap::from([(board.id, board)]), + }; + Index::new(&pod_data, None) + } + + // --- ENCODE TESTS --- + + #[test] + fn encode_success_little_endian_and_positional_fields() { + let order_id = AdjId(1001); + let packet_def = sample_packet_def( + order_id, + PacketType::Order(vec![ + sample_measurement( + 1, + MeasurementKind::Numeric { + wire_type: NumericKind::U16, + }, + ), + sample_measurement( + 2, + MeasurementKind::Enum { + options: vec!["Off".to_string(), "On".to_string()], + }, + ), + ]), + ); + + let index = make_test_index(vec![packet_def]); + + let packet = OrderPacket::new(order_id, vec![Value::Number(300.0), Value::Number(1.0)]); + + let Ok(encoded) = encode(&packet, &index) else { + unreachable!("encoding a well-formed order should succeed"); + }; + + // 1001 in little-endian u16: [0xE9, 0x03] + // 300 in little-endian u16: [0x2C, 0x01] + // enum index 1: [0x01] + assert_eq!(encoded, vec![0xE9, 0x03, 0x2C, 0x01, 0x01]); + } + + #[test] + fn encode_fails_on_unknown_id() { + let index = make_test_index(vec![]); + let packet = OrderPacket::new(AdjId(9999), vec![]); + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding an unknown id should fail"); + }; + assert_eq!(err, EncodeError::UnknownId(AdjId(9999))); + } + + #[test] + fn encode_fails_on_wrong_packet_type() { + let data_id = AdjId(2001); + let packet_def = sample_packet_def(data_id, PacketType::Data(vec![])); + + let index = make_test_index(vec![packet_def]); + let packet = OrderPacket::new(data_id, vec![]); + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding the wrong packet type should fail"); + }; + assert_eq!(err, EncodeError::WrongPacketType { id: data_id }); + } + + #[test] + fn encode_fails_on_wrong_field_count() { + let order_id = AdjId(1002); + let packet_def = sample_packet_def( + order_id, + PacketType::Order(vec![ + sample_measurement( + 1, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ), + sample_measurement( + 2, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ), + ]), + ); + + let index = make_test_index(vec![packet_def]); + let packet = OrderPacket::new(order_id, vec![Value::Number(10.0)]); + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding with the wrong field count should fail"); + }; + assert_eq!( + err, + EncodeError::WrongFieldCount { + expected: 2, + got: 1, + } + ); + } + + // --- DECODE TESTS --- + + #[test] + fn decode_success_little_endian_and_values() { + let data_id = AdjId(3001); + let packet_def = sample_packet_def( + data_id, + PacketType::Data(vec![ + sample_measurement( + 1, + MeasurementKind::Numeric { + wire_type: NumericKind::U16, + }, + ), + sample_measurement( + 2, + MeasurementKind::Enum { + options: vec!["Off".to_string(), "On".to_string()], + }, + ), + ]), + ); + + let index = make_test_index(vec![packet_def]); + + // 3001 in little-endian u16: [0xB9, 0x0B] + // 500 in little-endian u16: [0xF4, 0x01] + // enum index 0: [0x00] + let raw_bytes = [0xB9, 0x0B, 0xF4, 0x01, 0x00]; + + let Ok(decoded) = decode::(&raw_bytes, &index) else { + unreachable!("decoding a well-formed data packet should succeed"); + }; + + assert_eq!(decoded.id, data_id); + assert_eq!( + decoded.values, + vec![Value::Number(500.0), Value::Enum("Off".to_string())] + ); + } + + #[test] + fn decode_fails_when_buffer_is_shorter_than_header() { + let index = make_test_index(vec![]); + let Err(err) = decode::(&[0x01], &index) else { + unreachable!("decoding a buffer shorter than the header should fail"); + }; + assert_eq!(err, DecodeError::UnexpectedEof); + } + + #[test] + fn decode_fails_on_unexpected_eof_in_payload() { + let data_id = AdjId(3002); + let packet_def = sample_packet_def( + data_id, + PacketType::Data(vec![sample_measurement( + 1, + MeasurementKind::Numeric { + wire_type: NumericKind::U32, + }, + )]), + ); + + let index = make_test_index(vec![packet_def]); + + let raw_bytes = [0xBA, 0x0B, 0x01, 0x02]; + let Err(err) = decode::(&raw_bytes, &index) else { + unreachable!("decoding a truncated payload should fail"); + }; + assert_eq!(err, DecodeError::UnexpectedEof); + } + + #[test] + fn decode_fails_on_unknown_id() { + let index = make_test_index(vec![]); + let raw_bytes = [0x88, 0x13]; + + let Err(err) = decode::(&raw_bytes, &index) else { + unreachable!("decoding an unknown id should fail"); + }; + assert_eq!(err, DecodeError::UnknownId(AdjId(5000))); + } + + #[test] + fn decode_fails_on_wrong_packet_type() { + let order_id = AdjId(4001); + let packet_def = sample_packet_def(order_id, PacketType::Order(vec![])); + + let index = make_test_index(vec![packet_def]); + let raw_bytes = [0xA1, 0x0F]; + + let Err(err) = decode::(&raw_bytes, &index) else { + unreachable!("decoding the wrong packet type should fail"); + }; + assert_eq!(err, DecodeError::WrongPacketType { id: order_id }); + } + + // --- ROUND-TRIP TESTS --- + // + // `encode`/`decode` are generic over `Kind`, so the same `PacketDef` + // works for both directions here — that genericity is the whole + // point of giving `DataOrderPacket` a phantom `Kind` in the first + // place, instead of writing one hardcoded pair of functions per type. + // + // Enum fields are left out of both: `encode_enum` takes an + // already-selected index (`Value::Number`) but `decode_enum` returns + // the option's text (`Value::Enum`) — see `wire.rs` — so an enum + // field's `Value` is never expected to round-trip unchanged, only its + // underlying byte. + + fn numeric_measurements() -> Vec { + vec![ + sample_measurement( + 1, + MeasurementKind::Numeric { + wire_type: NumericKind::U16, + }, + ), + sample_measurement( + 2, + MeasurementKind::Numeric { + wire_type: NumericKind::I8, + }, + ), + ] + } + + #[test] + fn an_order_packet_round_trips_through_encode_then_decode() { + let id = AdjId(6001); + let index = make_test_index(vec![sample_packet_def( + id, + PacketType::Order(numeric_measurements()), + )]); + let original = OrderPacket::new(id, vec![Value::Number(1234.0), Value::Number(-5.0)]); + + let Ok(bytes) = encode(&original, &index) else { + unreachable!("encoding this well-formed order should succeed"); + }; + let Ok(decoded) = decode::(&bytes, &index) else { + unreachable!("decoding what we just encoded should succeed"); + }; + + assert_eq!(decoded.id, original.id); + assert_eq!(decoded.values, original.values); + } + + #[test] + fn a_data_packet_round_trips_through_encode_then_decode() { + let id = AdjId(6002); + let index = make_test_index(vec![sample_packet_def( + id, + PacketType::Data(numeric_measurements()), + )]); + let original = DataPacket::new(id, vec![Value::Number(42.0), Value::Number(-1.0)]); + + let Ok(bytes) = encode(&original, &index) else { + unreachable!("encoding this well-formed data packet should succeed"); + }; + let Ok(decoded) = decode::(&bytes, &index) else { + unreachable!("decoding what we just encoded should succeed"); + }; + + assert_eq!(decoded.id, original.id); + assert_eq!(decoded.values, original.values); + } +} diff --git a/backend/crates/core/src/protocol/packet/message.rs b/backend/crates/core/src/protocol/packet/message.rs new file mode 100644 index 000000000..ec20e16e3 --- /dev/null +++ b/backend/crates/core/src/protocol/packet/message.rs @@ -0,0 +1,444 @@ +//! Decodes a `Message` packet: a board's free-text log line. Only ever +//! received, over TCP. Also provides `encode`, purely so tests can build +//! well-formed frames without hand-written byte arrays — nothing in the +//! real backend calls it, since a message never travels backend -> board. +//! +//! Wire structure (whole frame, including the leading id): +//! ```text +//! | byte(s) | 0-1 | 2 | 3 | 4 | 5 | 6.. | .. | +//! |---------|-----|------|-----|-----|--------|-----------|-----------| +//! | field | id | hora | min | seg | subseg | origin\0 | message\0 | +//! ``` +//! `id` (2 bytes) is normally read by a TCP dispatcher before it even +//! knows to call [`decode`] (it needs the id first, to decide this is a +//! message and not a protection) — when that's the case, pass it as +//! `Some`, and `reader` should start right at byte 2 above. Otherwise +//! pass `None`: `reader` should then start at byte 0, id included, and +//! `decode` reads it itself — all of this frame's byte parsing stays in +//! this file either way, never split out into whatever dispatches here. +//! Unlike [`super::protection`], there's no `resv` padding — the +//! timestamp is followed directly by `origin`, a NUL-terminated string +//! of at most `ORIGIN_MAX` bytes (terminator included), then `message`, +//! at most `MESSAGE_MAX` bytes the same way. Both are variable-length — +//! there's no fixed byte range for either. +//! +//! Unlike [`super::protection`] too, [`MessagePacket`] doesn't carry its +//! own severity — `id` is resolved against `index` to confirm it's +//! actually a declared [`crate::model::PacketType::Message`] (so a +//! `WrongPacketType`/`UnknownId` frame is rejected), but the severity +//! itself is never stored redundantly on the decoded instance; look it up +//! via `index.packet(id)` again if it's needed. + +use crate::model::{AdjId, MessagePacket, PacketType, ShortTimestamp}; +use crate::protocol::{DecodeError, EncodeError, Index}; +use std::io::Read; + +// `origin`/`message` max lengths, content + NUL terminator included +// (docu_backend/Comunicaciones_Reunion01.qmd, lines 207-237). +const ORIGIN_MAX: usize = 48; +const MESSAGE_MAX: usize = 320; + +/// Decodes a message frame, resolving its id against `index` to confirm +/// it's actually a declared message. +/// +/// `id`: `Some` if the caller already read it (see this module's doc +/// comment); `None` to have `decode` read it itself off `reader`'s first +/// 2 bytes. +pub fn decode( + mut reader: impl Read, + id: Option, + index: &Index, +) -> Result { + let id = match id { + Some(id) => id, + None => super::read_id(&mut reader)?, + }; + + // Look up the packet definition for this id, and ensure it's a + // message packet. If not, the frame is malformed and we can't decode it. + let packet_def = index.packet(id).ok_or(DecodeError::UnknownId(id))?; + + let PacketType::Message(_) = &packet_def.packet_type else { + return Err(DecodeError::WrongPacketType { id }); + }; + + let mut header = [0u8; 4]; + reader.read_exact(&mut header)?; + let timestamp = ShortTimestamp { + hour: header[0], + minute: header[1], + second: header[2], + subsecond: header[3], + }; + + let origin = read_null_terminated_string(&mut reader, ORIGIN_MAX)?; + let message = read_null_terminated_string(&mut reader, MESSAGE_MAX)?; + + Ok(MessagePacket { + id, + timestamp, + origin, + message, + }) +} + +/// Reads bytes up to the first `0x00` (exclusive) or `max` bytes total, +/// whichever comes first — [`DecodeError::UnterminatedString`] if no +/// terminator shows up within `max` bytes. +fn read_null_terminated_string(reader: &mut impl Read, max: usize) -> Result { + // Byte by byte via `read_exact`, not `.bytes()` — that iterator warns + // under clippy for being unbuffered, and `reader` here can be any + // `impl Read`, not necessarily a buffered one. + let mut bytes = Vec::new(); + for _ in 0..max { + let mut byte = [0u8; 1]; + reader.read_exact(&mut byte)?; + if byte[0] == 0 { + return String::from_utf8(bytes).map_err(|e| DecodeError::InvalidUtf8(e.into_bytes())); + } + bytes.push(byte[0]); + } + Err(DecodeError::UnterminatedString { max }) +} + +/// Encodes a [`MessagePacket`] back into the bytes [`decode`] expects — +/// a complete, self-contained frame, leading id included. +/// +/// Nothing in the real backend calls this — per the ADJ spec, message +/// packets only ever travel board -> backend. This exists purely so +/// tests can build well-formed frames without hand-written byte arrays, +/// and to prove `decode` recovers exactly what was encoded. +pub fn encode(packet: &MessagePacket, index: &Index) -> Result, EncodeError> { + let packet_def = index + .packet(packet.id) + .ok_or(EncodeError::UnknownId(packet.id))?; + + let PacketType::Message(_) = &packet_def.packet_type else { + return Err(EncodeError::WrongPacketType { id: packet.id }); + }; + + let mut bytes = packet.id.0.to_le_bytes().to_vec(); + bytes.extend([ + packet.timestamp.hour, + packet.timestamp.minute, + packet.timestamp.second, + packet.timestamp.subsecond, + ]); + + write_null_terminated_string(&mut bytes, &packet.origin, ORIGIN_MAX)?; + write_null_terminated_string(&mut bytes, &packet.message, MESSAGE_MAX)?; + + Ok(bytes) +} + +/// Appends `value` to `bytes` as a NUL-terminated string, erroring if it +/// can't be represented that way: an embedded `\0` would be misread as +/// an early terminator, and the content plus its terminator must still +/// fit within `max` bytes. +fn write_null_terminated_string( + bytes: &mut Vec, + value: &str, + max: usize, +) -> Result<(), EncodeError> { + if value.contains('\0') { + return Err(EncodeError::EmbeddedNulByte); + } + if value.len() >= max { + return Err(EncodeError::StringTooLong { max }); + } + + bytes.extend_from_slice(value.as_bytes()); + bytes.push(0); + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::{Board, BoardId, MacAddress, MessageLevel, PacketDef, PodData}; + use std::collections::HashMap; + use std::io::Cursor; + use std::net::IpAddr; + + /// Builds an `Index` declaring one message severity: `id` as + /// `MessageLevel::Fault`, exactly as `protocol::Index::new` would + /// synthesize it from a loaded ADJ's `message_levels`. + fn index_with_message(id: AdjId, level: MessageLevel) -> Index { + let message_levels = HashMap::from([(id, level)]); + Index::new(&PodData::default(), Some(&message_levels)) + } + + #[test] + fn decodes_timestamp_and_both_strings() { + let index = index_with_message(AdjId(11), MessageLevel::Warning); + let mut bytes = vec![12, 30, 5, 0]; // hour, minute, second, subsecond + bytes.extend(b"main.c"); + bytes.push(0); + bytes.extend(b"something went wrong"); + bytes.push(0); + + let Ok(packet) = decode(Cursor::new(bytes), Some(AdjId(11)), &index) else { + unreachable!("decoding a well-formed message frame should succeed"); + }; + + assert_eq!(packet.id, AdjId(11)); + assert_eq!(packet.timestamp.hour, 12); + assert_eq!(packet.timestamp.minute, 30); + assert_eq!(packet.timestamp.second, 5); + assert_eq!(packet.origin, "main.c"); + assert_eq!(packet.message, "something went wrong"); + } + + #[test] + fn decode_treats_a_leading_terminator_as_an_empty_string() { + let index = index_with_message(AdjId(12), MessageLevel::Info); + let mut bytes = vec![0, 0, 0, 0]; + bytes.push(0); // origin: empty + bytes.push(0); // message: empty + + let Ok(packet) = decode(Cursor::new(bytes), Some(AdjId(12)), &index) else { + unreachable!("decoding a well-formed message frame should succeed"); + }; + + assert_eq!(packet.origin, ""); + assert_eq!(packet.message, ""); + } + + #[test] + fn decode_fails_when_origin_has_no_terminator_within_max() { + let index = index_with_message(AdjId(10), MessageLevel::Fault); + let mut bytes = vec![0, 0, 0, 0]; + bytes.extend(vec![b'a'; ORIGIN_MAX]); // no terminator anywhere + + let Err(err) = decode(Cursor::new(bytes), Some(AdjId(10)), &index) else { + unreachable!("decoding an unterminated origin should fail"); + }; + assert_eq!(err, DecodeError::UnterminatedString { max: ORIGIN_MAX }); + } + + #[test] + fn decode_fails_when_message_has_no_terminator_within_max() { + let index = index_with_message(AdjId(13), MessageLevel::Panic); + let mut bytes = vec![0, 0, 0, 0]; + bytes.push(0); // origin: empty, terminated + bytes.extend(vec![b'a'; MESSAGE_MAX]); // message: no terminator + + let Err(err) = decode(Cursor::new(bytes), Some(AdjId(13)), &index) else { + unreachable!("decoding an unterminated message should fail"); + }; + assert_eq!(err, DecodeError::UnterminatedString { max: MESSAGE_MAX }); + } + + #[test] + fn decode_fails_on_invalid_utf8() { + let index = index_with_message(AdjId(12), MessageLevel::Info); + let mut bytes = vec![0, 0, 0, 0]; + bytes.push(0x80); // lone continuation byte: not valid UTF-8 on its own + bytes.push(0); + + let Err(err) = decode(Cursor::new(bytes), Some(AdjId(12)), &index) else { + unreachable!("decoding invalid UTF-8 should fail"); + }; + assert_eq!(err, DecodeError::InvalidUtf8(vec![0x80])); + } + + #[test] + fn decode_fails_on_truncated_header() { + let index = index_with_message(AdjId(12), MessageLevel::Info); + let Err(err) = decode(Cursor::new(vec![0, 0]), Some(AdjId(12)), &index) else { + unreachable!("decoding a truncated header should fail"); + }; + assert!(matches!(err, DecodeError::Io(_))); + } + + #[test] + fn decode_reads_the_id_itself_when_not_given_one() { + let index = index_with_message(AdjId(11), MessageLevel::Warning); + let mut bytes = AdjId(11).0.to_le_bytes().to_vec(); + bytes.extend([12, 30, 5, 0]); // hour, minute, second, subsecond + bytes.push(0); // origin: empty + bytes.push(0); // message: empty + + let Ok(packet) = decode(Cursor::new(bytes), None, &index) else { + unreachable!("decoding a well-formed message frame should succeed"); + }; + + assert_eq!(packet.id, AdjId(11)); + } + + #[test] + fn decode_fails_on_an_unknown_id() { + let index = index_with_message(AdjId(11), MessageLevel::Warning); + let bytes = 9999u16.to_le_bytes().to_vec(); + + let Err(err) = decode(Cursor::new(bytes), None, &index) else { + unreachable!("decoding an unknown message id should fail"); + }; + assert_eq!(err, DecodeError::UnknownId(AdjId(9999))); + } + + #[test] + fn decode_fails_when_the_id_resolves_to_a_non_message_packet() { + let data_id = AdjId(2000); + let packet = PacketDef { + id: data_id, + board: BoardId(1), + name: "bcu_data".to_string(), + packet_type: PacketType::Data(vec![]), + }; + let board = Board { + id: BoardId(1), + name: "BCU".to_string(), + ip: IpAddr::from([127, 0, 0, 1]), + mac: MacAddress([0; 6]), + packets: HashMap::from([(packet.id, packet)]), + }; + let pod_data = PodData { + boards: HashMap::from([(board.id, board)]), + }; + let index = Index::new(&pod_data, None); + + let bytes = data_id.0.to_le_bytes().to_vec(); + let Err(err) = decode(Cursor::new(bytes), None, &index) else { + unreachable!("decoding an id that resolves to a Data packet should fail"); + }; + assert_eq!(err, DecodeError::WrongPacketType { id: data_id }); + } + + // --- ENCODE TESTS --- + + #[test] + fn encode_then_decode_round_trips_timestamp_and_strings() { + let index = index_with_message(AdjId(10), MessageLevel::Fault); + let original = MessagePacket { + id: AdjId(10), + timestamp: ShortTimestamp { + hour: 23, + minute: 59, + second: 58, + subsecond: 200, + }, + origin: "board/src/main.c".to_string(), + message: "overcurrent detected".to_string(), + }; + + let Ok(bytes) = encode(&original, &index) else { + unreachable!("encoding a well-formed message packet should succeed"); + }; + // `encode` writes the id too, so `decode` can read it back itself — + // proves the full frame round-trips, not just the body. + let Ok(decoded) = decode(Cursor::new(bytes), None, &index) else { + unreachable!("decoding what we just encoded should succeed"); + }; + + assert_eq!(decoded, original); + } + + #[test] + fn encode_fails_on_unknown_id() { + let index = index_with_message(AdjId(10), MessageLevel::Fault); + let packet = MessagePacket { + id: AdjId(9999), + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + origin: String::new(), + message: String::new(), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding an unknown id should fail"); + }; + assert_eq!(err, EncodeError::UnknownId(AdjId(9999))); + } + + #[test] + fn encode_fails_on_wrong_packet_type() { + let data_id = AdjId(2000); + let packet_def = PacketDef { + id: data_id, + board: BoardId(1), + name: "bcu_data".to_string(), + packet_type: PacketType::Data(vec![]), + }; + let board = Board { + id: BoardId(1), + name: "BCU".to_string(), + ip: IpAddr::from([127, 0, 0, 1]), + mac: MacAddress([0; 6]), + packets: HashMap::from([(packet_def.id, packet_def)]), + }; + let pod_data = PodData { + boards: HashMap::from([(board.id, board)]), + }; + let index = Index::new(&pod_data, None); + + let packet = MessagePacket { + id: data_id, + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + origin: String::new(), + message: String::new(), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding into a non-message packet's id should fail"); + }; + assert_eq!(err, EncodeError::WrongPacketType { id: data_id }); + } + + #[test] + fn encode_rejects_a_too_long_origin() { + let index = index_with_message(AdjId(12), MessageLevel::Info); + let packet = MessagePacket { + id: AdjId(12), + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + origin: "a".repeat(ORIGIN_MAX), + message: String::new(), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding an origin with no room for its terminator should fail"); + }; + assert_eq!(err, EncodeError::StringTooLong { max: ORIGIN_MAX }); + + let fits = MessagePacket { + origin: "a".repeat(ORIGIN_MAX - 1), + ..packet + }; + assert!(encode(&fits, &index).is_ok()); + } + + #[test] + fn encode_rejects_an_embedded_nul_byte() { + let index = index_with_message(AdjId(12), MessageLevel::Info); + let packet = MessagePacket { + id: AdjId(12), + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + origin: "ab\0cd".to_string(), + message: String::new(), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding a string with an embedded NUL byte should fail"); + }; + assert_eq!(err, EncodeError::EmbeddedNulByte); + } +} diff --git a/backend/crates/core/src/protocol/packet/protection.rs b/backend/crates/core/src/protocol/packet/protection.rs new file mode 100644 index 000000000..d3a4e1e4e --- /dev/null +++ b/backend/crates/core/src/protocol/packet/protection.rs @@ -0,0 +1,463 @@ +//! Decodes a `Protection` packet: a board reporting one of its declared +//! protections triggered. Only ever received, over TCP. Also provides +//! `encode`, purely so tests can build well-formed frames without +//! hand-written byte arrays — nothing in the real backend calls it, since +//! a protection never travels backend -> board. +//! +//! Wire structure (whole frame, including the leading id): +//! ```text +//! | byte(s) | 0-1 | 2 | 3 | 4 | 5 | 6-7 | 8.. | +//! |---------|-----|------|-----|-----|--------|------|--------------| +//! | field | id | hora | min | seg | subseg | resv | value | +//! ``` +//! `id` (2 bytes) is normally read by a TCP dispatcher before it even +//! knows to call [`decode`] (it needs the id first, to decide this is a +//! protection and not a message) — when that's the case, pass it as +//! `Some`, and `reader` should start right at byte 2 above. Otherwise +//! pass `None`: `reader` should then start at byte 0, id included, and +//! `decode` reads it itself — all of this frame's byte parsing stays in +//! this file either way, never split out into whatever dispatches here. +//! `resv` (2 bytes) only exists to align `value` to an 8-byte offset; +//! it's read and discarded, never stored. `value`'s width is whatever +//! [`crate::protocol::wire::byte_width`] says for the watched +//! measurement's kind — not fixed, unlike every other field here. + +use crate::model::{AdjId, PacketType, ProtectionPacket, ShortTimestamp}; +use crate::protocol::{DecodeError, EncodeError, Index, wire}; +use std::io::Read; + +/// Decodes a protection frame, resolving the watched measurement's wire +/// type against `index`. +/// +/// `compound_id`: `Some` if the caller already read it (see this +/// module's doc comment); `None` to have `decode` read it itself off +/// `reader`'s first 2 bytes. +pub fn decode( + mut reader: impl Read, + compound_id: Option, + index: &Index, +) -> Result { + let compound_id = match compound_id { + Some(id) => id, + None => super::read_id(&mut reader)?, + }; + + // Look up the packet definition for this compound id, and ensure it's a + // protection packet. If not, the frame is malformed and we can't decode it. + let packet_def = index + .packet(compound_id) + .ok_or(DecodeError::UnknownId(compound_id))?; + + let PacketType::Protection(measurement) = &packet_def.packet_type else { + return Err(DecodeError::WrongPacketType { id: compound_id }); + }; + + // `hora`/`min`/`seg`/`subseg` (1 byte each), then 2 bytes of `resv` + // padding that only exist to align `value` to an 8-byte offset — read + // and discarded, there's nowhere to put them in `ProtectionPacket`. + let mut header = [0u8; 6]; + reader.read_exact(&mut header)?; + let timestamp = ShortTimestamp { + hour: header[0], + minute: header[1], + second: header[2], + subsecond: header[3], + }; + + // Read the `value` bytes, whose length is determined by the measurement's wire type, and decode them into a `Value`. + let mut value_bytes = vec![0u8; wire::byte_width(&measurement.kind)]; + reader.read_exact(&mut value_bytes)?; + let value = wire::decode_value(&value_bytes, &measurement.kind)?; + + Ok(ProtectionPacket { + id: compound_id, + timestamp, + value, + }) +} + +/// Encodes a [`ProtectionPacket`] back into the bytes [`decode`] expects +/// — a complete, self-contained frame, leading id included. +/// +/// Nothing in the real backend calls this — per the ADJ spec, protection +/// packets only ever travel board -> backend. This exists purely so +/// tests can build well-formed frames without hand-written byte arrays, +/// and to prove `decode` recovers exactly what was encoded. +pub fn encode(packet: &ProtectionPacket, index: &Index) -> Result, EncodeError> { + let packet_def = index + .packet(packet.id) + .ok_or(EncodeError::UnknownId(packet.id))?; + + let PacketType::Protection(measurement) = &packet_def.packet_type else { + return Err(EncodeError::WrongPacketType { id: packet.id }); + }; + + let mut bytes = packet.id.0.to_le_bytes().to_vec(); + // `hora`/`min`/`seg`/`subseg` (1 byte each), then 2 bytes of `resv` + // — decode discards these, nothing to round-trip. + bytes.extend([ + packet.timestamp.hour, + packet.timestamp.minute, + packet.timestamp.second, + packet.timestamp.subsecond, + 0, + 0, + ]); + bytes.extend(wire::encode_value(&packet.value, &measurement.kind)?); + + Ok(bytes) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::{ + AdjId, Board, BoardId, MacAddress, Measurement, MeasurementKind, NumericKind, PacketDef, + PodData, Value, + }; + use std::collections::HashMap; + use std::io::Cursor; + use std::net::IpAddr; + + fn sample_measurement(id: u16, kind: MeasurementKind) -> Measurement { + Measurement { + id: AdjId(id), + alias: "mock_alias".to_string(), + name: "Mock Measurement".to_string(), + display_units: String::new(), + kind, + protections: vec![], + } + } + + fn index_with_protection(measurement: Measurement, position: u16) -> (Index, AdjId) { + let compound_id = AdjId((position << 13) | measurement.id.0); + let packet = PacketDef { + id: compound_id, + board: BoardId(1), + name: "mock_protection".to_string(), + packet_type: PacketType::Protection(measurement), + }; + let board = Board { + id: BoardId(1), + name: "MOCK".to_string(), + ip: IpAddr::from([127, 0, 0, 1]), + mac: MacAddress([0; 6]), + packets: HashMap::from([(packet.id, packet)]), + }; + let pod_data = PodData { + boards: HashMap::from([(board.id, board)]), + }; + (Index::new(&pod_data, None), compound_id) + } + + #[test] + fn decodes_a_numeric_protections_timestamp_and_value() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::F32, + }, + ); + let (index, compound_id) = index_with_protection(measurement, 1); + + let mut bytes = vec![12, 30, 5, 0, 0, 0]; // hora, min, seg, subseg, resv(2) + bytes.extend(53.2f32.to_le_bytes()); + let reader = Cursor::new(bytes); + + let Ok(packet) = decode(reader, Some(compound_id), &index) else { + unreachable!("decoding a well-formed protection frame should succeed"); + }; + + assert_eq!(packet.id.measurement_id(), AdjId(100)); + assert_eq!(packet.id.protection_position(), 1); + assert_eq!(packet.timestamp.hour, 12); + assert_eq!(packet.timestamp.minute, 30); + assert_eq!(packet.timestamp.second, 5); + assert_eq!(packet.value, Value::Number(f64::from(53.2f32))); + } + + #[test] + fn decode_reads_the_id_itself_when_not_given_one() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::F32, + }, + ); + let (index, compound_id) = index_with_protection(measurement, 1); + + // Full frame, id included — nobody's pre-read it for us. + let mut bytes = compound_id.0.to_le_bytes().to_vec(); + bytes.extend([12, 30, 5, 0, 0, 0]); // hora, min, seg, subseg, resv(2) + bytes.extend(53.2f32.to_le_bytes()); + + let Ok(packet) = decode(Cursor::new(bytes), None, &index) else { + unreachable!("decoding a well-formed protection frame should succeed"); + }; + + assert_eq!(packet.id, compound_id); + assert_eq!(packet.timestamp.hour, 12); + assert_eq!(packet.value, Value::Number(f64::from(53.2f32))); + } + + #[test] + fn unknown_compound_id_is_an_error() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ); + let (index, _) = index_with_protection(measurement, 1); + let unknown_id = AdjId((2 << 13) | 100); + + assert!(matches!( + decode(Cursor::new(vec![]), Some(unknown_id), &index), + Err(DecodeError::UnknownId(id)) if id == unknown_id + )); + } + + #[test] + fn a_non_protection_packet_at_that_id_is_the_wrong_packet_type() { + let measurement = sample_measurement( + 200, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ); + let compound_id = AdjId(200); // pos = 0: a normal, non-protection id + let packet = PacketDef { + id: compound_id, + board: BoardId(1), + name: "mock_data".to_string(), + packet_type: PacketType::Data(vec![measurement]), + }; + let board = Board { + id: BoardId(1), + name: "MOCK".to_string(), + ip: IpAddr::from([127, 0, 0, 1]), + mac: MacAddress([0; 6]), + packets: HashMap::from([(packet.id, packet)]), + }; + let pod_data = PodData { + boards: HashMap::from([(board.id, board)]), + }; + let index = Index::new(&pod_data, None); + + assert!(matches!( + decode(Cursor::new(vec![]), Some(compound_id), &index), + Err(DecodeError::WrongPacketType { id }) if id == compound_id + )); + } + + #[test] + fn truncated_frame_is_unexpected_eof() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::U32, + }, + ); + let (index, compound_id) = index_with_protection(measurement, 1); + + // Header alone, no value bytes at all. + let reader = Cursor::new(vec![0u8; 6]); + + assert!(matches!( + decode(reader, Some(compound_id), &index), + Err(DecodeError::Io(_)) + )); + } + + // --- ENCODE TESTS --- + + #[test] + fn encode_then_decode_round_trips_timestamp_and_value() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::F32, + }, + ); + let (index, compound_id) = index_with_protection(measurement, 1); + + let original = ProtectionPacket { + id: compound_id, + timestamp: ShortTimestamp { + hour: 12, + minute: 30, + second: 5, + subsecond: 0, + }, + value: Value::Number(f64::from(53.2f32)), + }; + + let Ok(bytes) = encode(&original, &index) else { + unreachable!("encoding a well-formed protection packet should succeed"); + }; + // `encode` writes the id too, so `decode` can read it back itself — + // proves the full frame round-trips, not just the body. + let Ok(decoded) = decode(Cursor::new(bytes), None, &index) else { + unreachable!("decoding what we just encoded should succeed"); + }; + + assert_eq!(decoded, original); + } + + #[test] + fn encode_zeroes_the_reserved_bytes() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ); + let (index, compound_id) = index_with_protection(measurement, 1); + + let packet = ProtectionPacket { + id: compound_id, + timestamp: ShortTimestamp { + hour: 1, + minute: 2, + second: 3, + subsecond: 4, + }, + value: Value::Number(7.0), + }; + + let Ok(bytes) = encode(&packet, &index) else { + unreachable!("encoding a well-formed protection packet should succeed"); + }; + + // bytes[0..2] = id, [2..6] = timestamp, [6..8] = resv. + assert_eq!(bytes[6], 0); + assert_eq!(bytes[7], 0); + } + + #[test] + fn encode_fails_on_unknown_id() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ); + let (index, _) = index_with_protection(measurement, 1); + let unknown_id = AdjId((2 << 13) | 100); + + let packet = ProtectionPacket { + id: unknown_id, + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + value: Value::Number(0.0), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding an unknown id should fail"); + }; + assert_eq!(err, EncodeError::UnknownId(unknown_id)); + } + + #[test] + fn encode_fails_on_wrong_packet_type() { + let measurement = sample_measurement( + 200, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ); + let compound_id = AdjId(200); // pos = 0: a normal, non-protection id + let packet_def = PacketDef { + id: compound_id, + board: BoardId(1), + name: "mock_data".to_string(), + packet_type: PacketType::Data(vec![measurement]), + }; + let board = Board { + id: BoardId(1), + name: "MOCK".to_string(), + ip: IpAddr::from([127, 0, 0, 1]), + mac: MacAddress([0; 6]), + packets: HashMap::from([(packet_def.id, packet_def)]), + }; + let pod_data = PodData { + boards: HashMap::from([(board.id, board)]), + }; + let index = Index::new(&pod_data, None); + + let packet = ProtectionPacket { + id: compound_id, + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + value: Value::Number(0.0), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding the wrong packet type should fail"); + }; + assert_eq!(err, EncodeError::WrongPacketType { id: compound_id }); + } + + #[test] + fn encode_bubbles_up_type_mismatch() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ); + let (index, compound_id) = index_with_protection(measurement, 1); + + let packet = ProtectionPacket { + id: compound_id, + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + value: Value::Bool(true), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding a value of the wrong variant should fail"); + }; + assert_eq!(err, EncodeError::TypeMismatch); + } + + #[test] + fn encode_bubbles_up_out_of_range() { + let measurement = sample_measurement( + 100, + MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + ); + let (index, compound_id) = index_with_protection(measurement, 1); + + let packet = ProtectionPacket { + id: compound_id, + timestamp: ShortTimestamp { + hour: 0, + minute: 0, + second: 0, + subsecond: 0, + }, + value: Value::Number(300.0), + }; + + let Err(err) = encode(&packet, &index) else { + unreachable!("encoding an out-of-range value should fail"); + }; + assert!(matches!(err, EncodeError::OutOfRange { .. })); + } +} diff --git a/backend/crates/core/src/protocol/tcp.rs b/backend/crates/core/src/protocol/tcp.rs new file mode 100644 index 000000000..d4becf3fb --- /dev/null +++ b/backend/crates/core/src/protocol/tcp.rs @@ -0,0 +1,162 @@ +//! Transport-level TCP framing: a board's dedicated connection carries +//! triggered protections and free-text messages from the board, and +//! orders to it. Never a `Data` packet — see the module doc on +//! [`super`]. +//! +//! Both functions here are thin: the actual per-type decoding lives in +//! [`super::packet::protection`]/[`super::packet::message`]/ +//! [`super::packet::data_order`], independent of TCP. This module only adds +//! the transport-level guarantee — [`decode_next`] can only ever return +//! a [`TcpFrame`], never a `DataPacket`. + +use super::{DecodeError, EncodeError, Index, packet}; +use crate::model::{MessagePacket, OrderPacket, ProtectionPacket}; +use std::io::Read; + +/// A decoded TCP frame — everything a board can send to the backend over +/// its dedicated TCP connection. +#[derive(Debug, Clone, PartialEq)] +pub enum TcpFrame { + /// A protection triggered. + Protection(ProtectionPacket), + /// A free-text message. + Message(MessagePacket), +} + +/// Reads and decodes the next complete frame from `reader`, resolving +/// field shapes against `index`. +/// +/// Reads the frame's leading 16-bit id first — the one piece of byte +/// handling this function does itself, since it has no way to decide +/// which of [`super::packet::protection::decode`]/ +/// [`super::packet::message::decode`] to call otherwise (see +/// `packet/README.md`'s "dispatcher's one unavoidable read"). A +/// protection's compound id always has its high 3 bits set to a nonzero +/// position (see [`crate::model::AdjId`]'s own docs on its ranges), so +/// `id.0 >= 8192` (`1 << 13`) is a protection; anything below that hands +/// off to `message::decode` instead — `message::decode` resolves it +/// against `index` itself (`UnknownId`/`WrongPacketType` if it isn't +/// actually a declared message), so there's no separate lookup to do here +/// first. +/// Either call's result is wrapped in the matching [`TcpFrame`] variant. +pub fn decode_next(mut reader: impl Read, index: &Index) -> Result { + let id = packet::read_id(&mut reader)?; + + if id.0 >= 8192 { + let protection = packet::protection::decode(reader, Some(id), index)?; + Ok(TcpFrame::Protection(protection)) + } else { + let message = packet::message::decode(reader, Some(id), index)?; + Ok(TcpFrame::Message(message)) + } +} + +/// Encodes `order` into the bytes to write to the board's connection. +pub fn encode_order(order: &OrderPacket, index: &Index) -> Result, EncodeError> { + packet::data_order::encode(order, index) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::{ + AdjId, Board, BoardId, MacAddress, Measurement, MeasurementKind, MessageLevel, NumericKind, + PacketDef, PacketType, PodData, ShortTimestamp, Value, + }; + use std::collections::HashMap; + use std::io::Cursor; + use std::net::IpAddr; + + /// A board with one protection (position 1 on measurement 100, wire + /// type `U8`) and one declared message severity (`id` 10 = `Fault`). + fn sample_index() -> Index { + let measurement = Measurement { + id: AdjId(100), + alias: "temp".to_string(), + name: "Temp".to_string(), + display_units: String::new(), + kind: MeasurementKind::Numeric { + wire_type: NumericKind::U8, + }, + protections: vec![], + }; + let compound_id = AdjId((1u16 << 13) | measurement.id.0); + let packet_def = PacketDef { + id: compound_id, + board: BoardId(1), + name: "temp_protection".to_string(), + packet_type: PacketType::Protection(measurement), + }; + let board = Board { + id: BoardId(1), + name: "MOCK".to_string(), + ip: IpAddr::from([127, 0, 0, 1]), + mac: MacAddress([0; 6]), + packets: HashMap::from([(packet_def.id, packet_def)]), + }; + let pod_data = PodData { + boards: HashMap::from([(board.id, board)]), + }; + let message_levels = HashMap::from([(AdjId(10), MessageLevel::Fault)]); + Index::new(&pod_data, Some(&message_levels)) + } + + #[test] + fn decode_next_dispatches_a_protection_frame() { + let index = sample_index(); + let compound_id = AdjId((1u16 << 13) | 100); + + let mut bytes = compound_id.0.to_le_bytes().to_vec(); + bytes.extend([12, 30, 5, 0, 0, 0]); // hora, min, seg, subseg, resv(2) + bytes.push(42); // value, U8 + + let Ok(frame) = decode_next(Cursor::new(bytes), &index) else { + unreachable!("decoding a well-formed protection frame should succeed"); + }; + + let TcpFrame::Protection(protection) = frame else { + unreachable!("a non-zero protection_position should dispatch to Protection"); + }; + assert_eq!(protection.id, compound_id); + assert_eq!(protection.value, Value::Number(42.0)); + } + + #[test] + fn decode_next_dispatches_a_message_frame() { + let index = sample_index(); + + let mut bytes = AdjId(10).0.to_le_bytes().to_vec(); + bytes.extend([1, 2, 3, 4]); // hora, min, seg, subseg + bytes.push(0); // origin: empty + bytes.push(0); // message: empty + + let Ok(frame) = decode_next(Cursor::new(bytes), &index) else { + unreachable!("decoding a well-formed message frame should succeed"); + }; + + let TcpFrame::Message(message) = frame else { + unreachable!("a zero protection_position should dispatch to Message"); + }; + assert_eq!(message.id, AdjId(10)); + assert_eq!( + message.timestamp, + ShortTimestamp { + hour: 1, + minute: 2, + second: 3, + subsecond: 4, + } + ); + } + + #[test] + fn decode_next_propagates_an_unknown_message_id() { + let index = sample_index(); + let bytes = 9999u16.to_le_bytes().to_vec(); + + let Err(err) = decode_next(Cursor::new(bytes), &index) else { + unreachable!("decoding an id that's neither a protection nor a message should fail"); + }; + assert_eq!(err, DecodeError::UnknownId(AdjId(9999))); + } +} diff --git a/backend/crates/core/src/protocol/udp.rs b/backend/crates/core/src/protocol/udp.rs new file mode 100644 index 000000000..05c44c3c0 --- /dev/null +++ b/backend/crates/core/src/protocol/udp.rs @@ -0,0 +1,17 @@ +//! Transport-level UDP framing: the shared socket carries periodic +//! telemetry (`Data` packets) from any board. Receive-only — the backend +//! never sends anything over this socket. +//! +//! The actual decoding lives in [`super::packet::data_order`], independent of +//! UDP — this module only adds the transport-level guarantee: a UDP +//! datagram is a complete, already-delimited buffer (the OS preserves +//! datagram boundaries even on a socket shared by every board), unlike +//! [`super::tcp::decode_next`]'s stream. + +use super::{DecodeError, Index, packet}; +use crate::model::DataPacket; + +/// Decodes a single UDP datagram's bytes into a [`DataPacket`]. +pub fn decode_datagram(bytes: &[u8], index: &Index) -> Result { + packet::data_order::decode(bytes, index) +} diff --git a/backend/crates/core/src/protocol/wire.rs b/backend/crates/core/src/protocol/wire.rs new file mode 100644 index 000000000..9ebe6ab8b --- /dev/null +++ b/backend/crates/core/src/protocol/wire.rs @@ -0,0 +1,414 @@ +//! Byte <-> [`Value`] codec for a single measurement, given its declared +//! [`MeasurementKind`]. The one piece of `protocol` with no framing or id +//! lookup — just "this type, these bytes, that value" and back. `tcp`/ +//! `udp` build their packet-level decoding on top of this. +//! +//! Every wire width here is fixed by the measurement's own `kind` (a +//! `NumericKind` always has a known byte width; booleans and enums are +//! fixed-width too), so decoding never needs to report back how many +//! bytes it consumed — [`byte_width`] derives it straight from the +//! `MeasurementKind`, for a caller that needs to advance through a buffer +//! or know how much to read off a stream before decoding. +//! +//! [`decode_value`]/[`encode_value`] are thin dispatchers: they only pick +//! which per-kind function to call. All the actual work lives in its own +//! public function (`decode_numeric`, `decode_boolean`, `decode_enum`...), +//! each independently implementable and testable. + +use super::{DecodeError, EncodeError}; +use crate::model::{MeasurementKind, NumericKind, Value}; + +/// Decodes a single value from the front of `bytes`, according to `kind`. +pub fn decode_value(bytes: &[u8], kind: &MeasurementKind) -> Result { + match kind { + MeasurementKind::Numeric { wire_type } => decode_numeric(bytes, *wire_type), + MeasurementKind::Boolean => decode_boolean(bytes), + MeasurementKind::Enum { options } => decode_enum(bytes, options), + } +} + +/// Encodes a single value according to `kind`. +pub fn encode_value(value: &Value, kind: &MeasurementKind) -> Result, EncodeError> { + match kind { + MeasurementKind::Numeric { wire_type } => encode_numeric(value, *wire_type), + MeasurementKind::Boolean => encode_boolean(value), + MeasurementKind::Enum { options } => encode_enum(value, options), + } +} + +/// How many bytes `kind` takes on the wire. +pub fn byte_width(kind: &MeasurementKind) -> usize { + match kind { + MeasurementKind::Numeric { wire_type } => match wire_type { + NumericKind::U8 | NumericKind::I8 => 1, + NumericKind::U16 | NumericKind::I16 => 2, + NumericKind::U32 | NumericKind::I32 | NumericKind::F32 => 4, + NumericKind::U64 | NumericKind::I64 | NumericKind::F64 => 8, + }, + MeasurementKind::Boolean => 1, + MeasurementKind::Enum { .. } => 1, + } +} + +/// Decodes a numeric value of the given wire type, little-endian. +pub fn decode_numeric(bytes: &[u8], wire_type: NumericKind) -> Result { + fn take(bytes: &[u8]) -> Result<[u8; N], DecodeError> { + bytes + .get(..N) + .and_then(|slice| slice.try_into().ok()) + .ok_or(DecodeError::UnexpectedEof) + } + + let number: f64 = match wire_type { + NumericKind::U8 => f64::from(u8::from_le_bytes(take::<1>(bytes)?)), + NumericKind::U16 => f64::from(u16::from_le_bytes(take::<2>(bytes)?)), + NumericKind::U32 => f64::from(u32::from_le_bytes(take::<4>(bytes)?)), + NumericKind::U64 => u64::from_le_bytes(take::<8>(bytes)?) as f64, + NumericKind::I8 => f64::from(i8::from_le_bytes(take::<1>(bytes)?)), + NumericKind::I16 => f64::from(i16::from_le_bytes(take::<2>(bytes)?)), + NumericKind::I32 => f64::from(i32::from_le_bytes(take::<4>(bytes)?)), + NumericKind::I64 => i64::from_le_bytes(take::<8>(bytes)?) as f64, + NumericKind::F32 => f64::from(f32::from_le_bytes(take::<4>(bytes)?)), + NumericKind::F64 => f64::from_le_bytes(take::<8>(bytes)?), + }; + + Ok(Value::Number(number)) +} + +/// Encodes a numeric value as the given wire type, little-endian. +/// +/// Errors with [`EncodeError::OutOfRange`] if `value` doesn't fit the +/// wire type's representable range (this also rejects NaN, which compares +/// false to every bound). +pub fn encode_numeric(value: &Value, wire_type: NumericKind) -> Result, EncodeError> { + let Value::Number(number) = value else { + return Err(EncodeError::TypeMismatch); + }; + let number = *number; + + let (min, max) = numeric_range(wire_type); + if !(min..=max).contains(&number) { + return Err(EncodeError::OutOfRange { + value: number, + min, + max, + }); + } + + Ok(match wire_type { + NumericKind::U8 => vec![number as u8], // no need to call `to_le_bytes` for a single byte + NumericKind::U16 => (number as u16).to_le_bytes().to_vec(), + NumericKind::U32 => (number as u32).to_le_bytes().to_vec(), + NumericKind::U64 => (number as u64).to_le_bytes().to_vec(), + NumericKind::I8 => (number as i8).to_le_bytes().to_vec(), + NumericKind::I16 => (number as i16).to_le_bytes().to_vec(), + NumericKind::I32 => (number as i32).to_le_bytes().to_vec(), + NumericKind::I64 => (number as i64).to_le_bytes().to_vec(), + NumericKind::F32 => (number as f32).to_le_bytes().to_vec(), + NumericKind::F64 => number.to_le_bytes().to_vec(), + }) +} + +/// The `[min, max]` range a wire type can represent, as `f64` bounds. +fn numeric_range(wire_type: NumericKind) -> (f64, f64) { + match wire_type { + NumericKind::U8 => (f64::from(u8::MIN), f64::from(u8::MAX)), + NumericKind::U16 => (f64::from(u16::MIN), f64::from(u16::MAX)), + NumericKind::U32 => (f64::from(u32::MIN), f64::from(u32::MAX)), + NumericKind::U64 => (u64::MIN as f64, u64::MAX as f64), + NumericKind::I8 => (f64::from(i8::MIN), f64::from(i8::MAX)), + NumericKind::I16 => (f64::from(i16::MIN), f64::from(i16::MAX)), + NumericKind::I32 => (f64::from(i32::MIN), f64::from(i32::MAX)), + NumericKind::I64 => (i64::MIN as f64, i64::MAX as f64), + NumericKind::F32 => (f64::from(f32::MIN), f64::from(f32::MAX)), + NumericKind::F64 => (f64::MIN, f64::MAX), + } +} + +/// Decodes a boolean value: a single byte, zero for `false`, any other +/// value for `true`. +pub fn decode_boolean(bytes: &[u8]) -> Result { + let &byte = bytes.first().ok_or(DecodeError::UnexpectedEof)?; + Ok(Value::Bool(byte != 0)) +} + +/// Encodes a boolean value as a single byte: `0x00` for `false`, `0x01` +/// for `true`. +pub fn encode_boolean(value: &Value) -> Result, EncodeError> { + let Value::Bool(value) = value else { + return Err(EncodeError::TypeMismatch); + }; + Ok(vec![u8::from(*value)]) +} + +/// Decodes an enum value: a single `uint8` byte, the index into +/// `options`. Returns the option's text, not its index — see +/// [`encode_enum`] for why that's not symmetric. +pub fn decode_enum(bytes: &[u8], options: &[String]) -> Result { + let &index = bytes.first().ok_or(DecodeError::UnexpectedEof)?; + let Some(option) = options.get(usize::from(index)) else { + return Err(DecodeError::InvalidEnumValue { + index: u32::from(index), + options: options.len(), + }); + }; + Ok(Value::Enum(option.clone())) +} + +/// Encodes an enum value as a single `uint8` byte. +/// +/// `value` is the already-selected index (e.g. a frontend dropdown +/// already resolved to its position in `options`), **not** the option's +/// text — unlike [`decode_enum`], which produces the text. Errors with +/// [`EncodeError::OutOfRange`] if the index isn't a whole number or +/// doesn't fall within `options`. +pub fn encode_enum(value: &Value, options: &[String]) -> Result, EncodeError> { + let Value::Number(index) = value else { + return Err(EncodeError::TypeMismatch); + }; + let index = *index; + let max = options.len().saturating_sub(1) as f64; + + let in_range = !options.is_empty() && index.fract() == 0.0 && (0.0..=max).contains(&index); + if !in_range { + return Err(EncodeError::OutOfRange { + value: index, + min: 0.0, + max, + }); + } + + Ok(vec![index as u8]) // no need to call `to_le_bytes` for a single byte +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn byte_width_matches_each_numeric_kinds_wire_size() { + let cases = [ + (NumericKind::U8, 1), + (NumericKind::I8, 1), + (NumericKind::U16, 2), + (NumericKind::I16, 2), + (NumericKind::U32, 4), + (NumericKind::I32, 4), + (NumericKind::F32, 4), + (NumericKind::U64, 8), + (NumericKind::I64, 8), + (NumericKind::F64, 8), + ]; + + for (wire_type, expected) in cases { + assert_eq!( + byte_width(&MeasurementKind::Numeric { wire_type }), + expected + ); + } + } + + #[test] + fn byte_width_of_an_enum_is_always_one() { + assert_eq!( + byte_width(&MeasurementKind::Enum { + options: vec!["Idle".to_string(), "Fault".to_string()] + }), + 1 + ); + } + + #[test] + fn byte_width_of_a_boolean_is_one() { + assert_eq!(byte_width(&MeasurementKind::Boolean), 1); + } + + #[test] + fn decodes_a_zero_byte_as_false() { + let Ok(value) = decode_boolean(&[0x00]) else { + unreachable!("decoding a zero byte should succeed"); + }; + assert_eq!(value, Value::Bool(false)); + } + + #[test] + fn decodes_any_nonzero_byte_as_true() { + let Ok(value) = decode_boolean(&[0xFF]) else { + unreachable!("decoding a nonzero byte should succeed"); + }; + assert_eq!(value, Value::Bool(true)); + } + + #[test] + fn decode_boolean_rejects_empty_input() { + assert!(matches!( + decode_boolean(&[]), + Err(DecodeError::UnexpectedEof) + )); + } + + #[test] + fn boolean_round_trips_through_encode_then_decode() { + for value in [true, false] { + let Ok(bytes) = encode_boolean(&Value::Bool(value)) else { + unreachable!("encoding a well-formed boolean should succeed"); + }; + let Ok(decoded) = decode_boolean(&bytes) else { + unreachable!("decoding what we just encoded should succeed"); + }; + assert_eq!(decoded, Value::Bool(value)); + } + } + + #[test] + fn encode_boolean_rejects_the_wrong_value_variant() { + assert!(matches!( + encode_boolean(&Value::Number(1.0)), + Err(EncodeError::TypeMismatch) + )); + } + + #[test] + fn decodes_an_unsigned_integer_little_endian() { + let Ok(value) = decode_numeric(&[0x34, 0x12], NumericKind::U16) else { + unreachable!("decoding a well-formed U16 should succeed"); + }; + assert_eq!(value, Value::Number(0x1234 as f64)); + } + + #[test] + fn decodes_a_signed_integer_little_endian() { + let Ok(value) = decode_numeric(&[0xFF], NumericKind::I8) else { + unreachable!("decoding a well-formed I8 should succeed"); + }; + assert_eq!(value, Value::Number(-1.0)); + } + + #[test] + fn decodes_floats_little_endian() { + let bytes = 1.5f32.to_le_bytes(); + let Ok(value) = decode_numeric(&bytes, NumericKind::F32) else { + unreachable!("decoding a well-formed F32 should succeed"); + }; + assert_eq!(value, Value::Number(1.5)); + } + + #[test] + fn decode_numeric_rejects_short_input() { + assert!(matches!( + decode_numeric(&[0x00], NumericKind::U32), + Err(DecodeError::UnexpectedEof) + )); + } + + #[test] + fn numeric_round_trips_through_encode_then_decode() { + let value = Value::Number(1234.0); + let Ok(bytes) = encode_numeric(&value, NumericKind::U16) else { + unreachable!("encoding a well-formed value should succeed"); + }; + let Ok(decoded) = decode_numeric(&bytes, NumericKind::U16) else { + unreachable!("decoding what we just encoded should succeed"); + }; + assert_eq!(decoded, value); + } + + #[test] + fn encode_numeric_rejects_the_wrong_value_variant() { + assert!(matches!( + encode_numeric(&Value::Bool(true), NumericKind::U8), + Err(EncodeError::TypeMismatch) + )); + } + + #[test] + fn encode_numeric_rejects_out_of_range_values() { + assert!(matches!( + encode_numeric(&Value::Number(300.0), NumericKind::U8), + Err(EncodeError::OutOfRange { .. }) + )); + assert!(matches!( + encode_numeric(&Value::Number(-1.0), NumericKind::U8), + Err(EncodeError::OutOfRange { .. }) + )); + } + + #[test] + fn encode_numeric_accepts_the_exact_boundary_values() { + assert!(encode_numeric(&Value::Number(0.0), NumericKind::U8).is_ok()); + assert!(encode_numeric(&Value::Number(255.0), NumericKind::U8).is_ok()); + } + + #[test] + fn encode_numeric_rejects_nan() { + assert!(matches!( + encode_numeric(&Value::Number(f64::NAN), NumericKind::F32), + Err(EncodeError::OutOfRange { .. }) + )); + } + + #[test] + fn decodes_an_enum_value_by_index_into_its_text() { + let options = vec!["Idle".to_string(), "Fault".to_string()]; + let Ok(value) = decode_enum(&[1], &options) else { + unreachable!("decoding a valid enum index should succeed"); + }; + assert_eq!(value, Value::Enum("Fault".to_string())); + } + + #[test] + fn decode_enum_rejects_an_out_of_range_index() { + let options = vec!["Idle".to_string()]; + assert!(matches!( + decode_enum(&[5], &options), + Err(DecodeError::InvalidEnumValue { + index: 5, + options: 1 + }) + )); + } + + #[test] + fn decode_enum_rejects_empty_input() { + assert!(matches!( + decode_enum(&[], &[]), + Err(DecodeError::UnexpectedEof) + )); + } + + #[test] + fn encodes_an_enum_value_from_its_already_selected_index() { + let options = vec!["Idle".to_string(), "Fault".to_string()]; + let Ok(bytes) = encode_enum(&Value::Number(1.0), &options) else { + unreachable!("encoding a valid index should succeed"); + }; + assert_eq!(bytes, vec![1]); + } + + #[test] + fn encode_enum_rejects_an_out_of_range_index() { + let options = vec!["Idle".to_string()]; + assert!(matches!( + encode_enum(&Value::Number(1.0), &options), + Err(EncodeError::OutOfRange { .. }) + )); + } + + #[test] + fn encode_enum_rejects_a_fractional_index() { + let options = vec!["Idle".to_string(), "Fault".to_string()]; + assert!(matches!( + encode_enum(&Value::Number(0.5), &options), + Err(EncodeError::OutOfRange { .. }) + )); + } + + #[test] + fn encode_enum_rejects_the_wrong_value_variant() { + let options = vec!["Idle".to_string()]; + assert!(matches!( + encode_enum(&Value::Enum("Idle".to_string()), &options), + Err(EncodeError::TypeMismatch) + )); + } +} diff --git a/backend/crates/core/src/utils.rs b/backend/crates/core/src/utils.rs new file mode 100644 index 000000000..0063520a7 --- /dev/null +++ b/backend/crates/core/src/utils.rs @@ -0,0 +1 @@ +pub(crate) mod serialize; \ No newline at end of file diff --git a/backend/crates/core/src/utils/serialize.rs b/backend/crates/core/src/utils/serialize.rs new file mode 100644 index 000000000..cb61543b9 --- /dev/null +++ b/backend/crates/core/src/utils/serialize.rs @@ -0,0 +1,111 @@ +use crate::model::{AdjId, BoardId, NumericKind, ProtectionKind, Severity}; +use serde::{Serialize, Serializer}; + +#[cfg(feature = "http")] +use crate::model::http::data::DataMeasurementKind; + +// EXPLANATION OF THE OBJECT SERIALIZER +// When using the macro #[serde(serialize_with = "")] you specify a function +// which takes to arguments: +// - 1st with the type of the atribute you apply the object +// - 2nd with the type `Serializer` +// The second one is just for setting the specified value obtained in the function +// when the serialization occurs. Very simple. +// +// Serialize delegates the value's representation to a generic Serializer. + +// Serialize domain types locally without changing the internal model. +pub(crate) fn serialize_board_id( + id: &BoardId, + serializer: S, +) -> Result { + serializer.serialize_u16(id.0) +} + +pub(crate) fn serialize_adj_id( + id: &AdjId, + serializer: S, +) -> Result { + serializer.serialize_u16(id.0) +} + +// Serialize numeric kind to match ADJv3 types. +pub(crate) fn get_numeric_kind(kind: &NumericKind) -> &str { + match kind { + NumericKind::U8 => "uint8", + NumericKind::U16 => "uint16", + NumericKind::U32 => "uint32", + NumericKind::U64 => "uint64", + NumericKind::I8 => "int8", + NumericKind::I16 => "int16", + NumericKind::I32 => "int32", + NumericKind::I64 => "int64", + NumericKind::F32 => "float32", + NumericKind::F64 => "float64", + } +} + +// A remote derive keeps the JSON representation here, without changing model. +#[derive(Serialize)] +// Mirroring the struct `ProtectionKind`, we our rules for serialization. +#[serde(remote = "ProtectionKind", tag = "type", rename_all = "snake_case")] +enum ProtectionKindDef { + Above { limit: f64 }, + Below { limit: f64 }, + Equal { target: f64 }, + NotEqual { target: f64 }, + Range { min: f64, max: f64 }, +} + +pub(crate) fn serialize_protection_kind( + kind: &ProtectionKind, + serializer: S, +) -> Result { + // We apply the serialization to this specific enum, with rules setted in the definition + ProtectionKindDef::serialize(kind, serializer) +} + +pub(crate) fn serialize_severity( + severity: &Severity, + serializer: S, +) -> Result { + serializer.serialize_str(match severity { + Severity::Fault => "fault", + Severity::Warning => "warning", + }) +} + +// Little helper for serialize the data measurement type +#[derive(Serialize)] +struct EnumKind { + #[serde(rename = "type")] + type_kind: String, + options: Vec, +} + +#[cfg(feature = "http")] +// Serializes the type of the data of the measurement, depends on each kind of measurement +pub(crate) fn serialize_data_measurement_type( + kind: &DataMeasurementKind, + serializer: S, +) -> Result { + match kind { + // for example: NumericKind::F32 -> "type": "float32" + DataMeasurementKind::Numeric { wire_type } => { + serializer.serialize_str(get_numeric_kind(wire_type)) + } + // "type": "boolean" + DataMeasurementKind::Boolean => serializer.serialize_str("boolean"), + // Enum types become an object containing "type": "enum" and the declared options. + DataMeasurementKind::Enum { options } => { + let options = options.clone(); + + let enum_kind = EnumKind { + type_kind: "enum".to_string(), + options, + }; + + EnumKind::serialize(&enum_kind, serializer) + } + } +} diff --git a/backend/crates/station/Cargo.toml b/backend/crates/station/Cargo.toml new file mode 100644 index 000000000..9eed62cbe --- /dev/null +++ b/backend/crates/station/Cargo.toml @@ -0,0 +1,25 @@ +[package] +name = "station" +version = "0.1.0" +description = "Hyperloop UPV control station backend, built on software-core" +edition.workspace = true +rust-version.workspace = true +license.workspace = true +authors.workspace = true +repository.workspace = true + +[dependencies] +software-core = { workspace = true, features = ["net", "git", "http"] } +serde.workspace = true +thiserror.workspace = true +tokio.workspace = true +toml.workspace = true +tracing.workspace = true +tracing-subscriber.workspace = true +serde_json.workspace = true +tower = "0.5.3" +axum = { version = "0.8.9", features = ["ws", "http1", "http2"] } +tower-http = { version = "0.6.11", features = ["cors", "set-header"] } + +[lints] +workspace = true diff --git a/backend/crates/station/README.md b/backend/crates/station/README.md new file mode 100644 index 000000000..00e8661df --- /dev/null +++ b/backend/crates/station/README.md @@ -0,0 +1,17 @@ +# station + +El backend de la Control Station de Hyperloop UPV: escucha a las placas del +pod, decodifica sus paquetes, los reenvía a los frontends y guarda un +registro en disco. Construido sobre [`software-core`](../core/README.md). + +Ver [`../../ARCHITECTURE.md`](../../ARCHITECTURE.md) para el diseño completo. + +## Arrancar + +```sh +cargo run -p station -- --config ./dev-config.toml +``` + +*(Pendiente: crear `dev-config.toml` y `config.toml`, portados de +`backend_old/cmd/`.)* + diff --git a/backend/crates/station/src/http.rs b/backend/crates/station/src/http.rs new file mode 100644 index 000000000..30c91003a --- /dev/null +++ b/backend/crates/station/src/http.rs @@ -0,0 +1,25 @@ +//! Station HTTP API: ADJ catalogs and incoming WebSocket connections. +//! +//! This module only negotiates WebSocket upgrades and hands sockets to a +//! channel. Message handling and client management belong to the future +//! WebSocket module, which will own the channel's receiver. + +use std::io; + +use axum::extract::ws::WebSocket; +use software_core::adj::Adj; +use tokio::{net::TcpListener, sync::mpsc}; + +use crate::http::server::setup_router; + +mod handlers; +mod server; + +/// Serves the ADJ catalogs and the WebSocket upgrade endpoint. +pub async fn serve( + listener: TcpListener, + adj: &Adj, + ws: Option>, +) -> io::Result<()> { + axum::serve(listener, setup_router(adj, ws)?).await +} diff --git a/backend/crates/station/src/http/README.md b/backend/crates/station/src/http/README.md new file mode 100644 index 000000000..9c905dbd2 --- /dev/null +++ b/backend/crates/station/src/http/README.md @@ -0,0 +1,166 @@ +# HTTP + +Station's Axum server exposes the ADJ catalogs and accepts WebSocket upgrades +from the frontend. It does not load the ADJ or handle WebSocket messages. + +## Files + +| File | Responsibility | +| --- | --- | +| [`../http.rs`](../http.rs) | Module entry points, with or without a WebSocket consumer. | +| [`configure.rs`](configure.rs) | Provisional HTTP configuration, validation, server preparation, and configuration tests. | +| [`server.rs`](server.rs) | Router construction, server execution, and route/WebSocket tests. | +| [`handlers.rs`](handlers.rs) | Shared state, pre-serialized catalog responses, and WebSocket handoff. | + +The response models and transformations from `Adj` belong to +[`software_core::adj`](../../../core/src/adj.rs). Their JSON examples are in +[`core/src/adj/http/example`](../../../core/src/adj/http/example). + +## Routes + +| Method | Path | Response | +| --- | --- | --- | +| GET | `/backend/adj/DataPackets` | Boards and data packet definitions, without measurement protections. | +| GET | `/backend/adj/OrderPackets` | Boards and order definitions, including parameter protections. | +| GET | `/backend/adj/ProtectionPackets` | Flat protection catalog and protection-type display metadata. | +| GET with WebSocket upgrade headers | `/backend` | Upgrades the connection and hands the socket to the configured channel. | + +Catalog responses return `200 OK` with `Content-Type: application/json`. + +## Catalog lifecycle + +When the router is built, the server: + +1. Builds the three response structures from the already-loaded `Adj`. +2. Serializes each response once into `Bytes`. +3. Stores the bytes in shared `Arc` state. + +Each request clones the relevant `Bytes` handle and sends the existing JSON +buffer. It does not rebuild the catalog, copy the whole buffer, or serialize +the response again. No application-level mutex is needed for these reads. + +The catalogs are a snapshot of the ADJ at startup; they are not refreshed +automatically. Serialization errors are propagated before requests are served. +This in-memory reuse is separate from browser caching. `configure_server` +applies the configured `Cache-Control` policy to the catalog routes. The older +listener-based entry points do not set an explicit cache policy. + +## Starting the server + +The caller supplies a bound `tokio::net::TcpListener` and an already-loaded +`&Adj`. The listener determines the address and port. Both entry points are +async and run until the server stops. + +Without a WebSocket consumer: + +```rust +http::serve(listener, &adj).await?; +``` + +With a bounded `tokio::sync::mpsc::Sender` whose +receiver belongs to the future WebSocket module: + +```rust +http::serve_with_websocket(listener, &adj, Some(sender)).await?; +``` + +Passing `None` to `serve_with_websocket` has the same behavior as `serve`. + +## WebSocket handoff + +The HTTP handler only performs the handshake and transfers ownership of the +socket. It does not read messages, manage clients, implement subscriptions, +broadcast telemetry, or execute orders. + +Before approving an upgrade, it reserves a slot in the bounded channel: + +- With an available slot, it completes the handshake (`101 Switching Protocols` + for HTTP/1.1) and places the socket in the channel. +- Without a configured channel, with a closed receiver, or with no available + capacity, it returns `503 Service Unavailable` instead of upgrading. +- Invalid upgrade requests are rejected by Axum's `WebSocketUpgrade` extractor. + +The future WebSocket module must consume the receiver and manage each socket's +lifetime, messages, and closure. Keeping a receiver alive without reading it +does not provide a functioning WebSocket service; the queue will eventually +fill. If the receiver disappears during the handoff, the socket is dropped. + +## Configuration + +`HttpConfig` is defined provisionally in `configure.rs` and reexported by `http`. +It does not depend on the future application configuration module or read files +and environment variables. + +| Field | Purpose | +| --- | --- | +| `bind_addr` | Explicit IP address and port to bind; port zero requests an available port. | +| `allowed_origins` | Exact HTTP(S) origins allowed by CORS; an empty list allows none. | +| `cache_policy` | Catalog policy: `NoStore`, `NoCache`, or `Unspecified`. | + +`HttpConfig::new(bind_addr)` uses no allowed CORS origins and defaults to +`CachePolicy::NoStore` (`Cache-Control: no-store`). `NoCache` allows storage +but requires revalidation before reuse; `Unspecified` sets no Cache-Control +header. These policies do not affect the server's reusable JSON buffers and +are not applied to WebSocket upgrades. + +The configuration path prepares the server without starting it: + +```rust +let mut config = http::HttpConfig::new("127.0.0.1:8080".parse()?); +config.allowed_origins = vec!["http://localhost:9000".into()]; + +let (listener, router) = http::configure_server(&config, &adj, None).await?; +axum::serve(listener, router).await?; +``` + +`configure_server` validates origins and serializes the catalogs before binding +the listener. Invalid settings and binding errors are returned to the caller; +there is no fallback to another address or port. To enable socket handoff, +replace `None` with `Some(sender)` as described above. + +CORS permits GET and HEAD from explicitly listed origins, handles preflight +requests, and does not enable credentials. Wildcards and origin URLs with +embedded credentials, paths (including a trailing slash), queries, fragments, +or invalid ports are rejected. The opaque origin `null` can be explicitly +listed for local-file clients, but it is not exclusive to Electron: other +opaque origins share it too. + +CORS controls browser access to responses; it is not HTTP authentication. +WebSocket Origin validation is still not implemented and is independent of +CORS. The existing `serve` and `serve_with_websocket` entry points remain +available for the current test startup and do not apply `HttpConfig` policies. + +## Manual checks + +From the backend workspace root, the current `main.rs` test startup can be run +with: + +```sh +cargo run -p station --locked +``` + +It currently loads the ADJ fixture and listens on `127.0.0.1:8080`. These are +temporary test settings, not configuration defaults. It uses `http::serve`, so +valid WebSocket upgrade requests receive `503` until a consumer is integrated. + +In another terminal: + +```sh +curl -i http://127.0.0.1:8080/backend/adj/DataPackets +curl -i http://127.0.0.1:8080/backend/adj/OrderPackets +curl -i http://127.0.0.1:8080/backend/adj/ProtectionPackets +``` + +## Tests + +From the backend workspace root: + +```sh +cargo test -p station http:: --locked +``` + +The tests cover catalog contents and repeated responses, empty catalogs, +configuration validation, binding errors, cache headers, CORS and preflight +handling, WebSocket upgrade and socket delivery over a real TCP connection, +unavailable channels (missing, closed, or full), and requests without upgrade +headers. diff --git a/backend/crates/station/src/http/handlers.rs b/backend/crates/station/src/http/handlers.rs new file mode 100644 index 000000000..aabd23741 --- /dev/null +++ b/backend/crates/station/src/http/handlers.rs @@ -0,0 +1,95 @@ +//! Handlers for precomputed catalogs and WebSocket upgrades. + +use std::sync::Arc; + +use axum::{ + body::Bytes, + extract::{State, WebSocketUpgrade, ws::WebSocket}, + http::{StatusCode, header}, + response::{IntoResponse, Response}, +}; +use software_core::adj::Adj; +use tokio::sync::mpsc; + +/// Immutable state shared by all requests without a mutex. +pub(super) struct HttpState { + // the three response JSON pre-serialized + responses: Responses, + // the websocket channel + websocket_connections: Option>, +} + +impl HttpState { + pub(super) fn new( + adj: &Adj, + websocket_connections: Option>, + ) -> Result { + Ok(Self { + responses: Responses::new(adj)?, + websocket_connections, + }) + } +} + +/// Pre-serialized JSON. Each Bytes clone shares the same underlying content. +struct Responses { + data_response: Bytes, + order_response: Bytes, + protection_response: Bytes, +} + +impl Responses { + // ADJ transformation and serialization happen only at startup. + fn new(adj: &Adj) -> Result { + Ok(Self { + data_response: serde_json::to_vec(&adj.data_response())?.into(), + order_response: serde_json::to_vec(&adj.order_response())?.into(), + protection_response: serde_json::to_vec(&adj.protection_response())?.into(), + }) + } +} + +pub(super) async fn data_packet(State(state): State>) -> Response { + json_response(state.responses.data_response.clone()) +} + +pub(super) async fn order_packet(State(state): State>) -> Response { + json_response(state.responses.order_response.clone()) +} + +pub(super) async fn protection_packet(State(state): State>) -> Response { + json_response(state.responses.protection_response.clone()) +} + +/// Negotiates the connection without reading messages or implementing the frontend protocol. +pub(super) async fn websocket( + State(state): State>, + upgrade: WebSocketUpgrade, +) -> Response { + let Some(connections) = &state.websocket_connections else { + return StatusCode::SERVICE_UNAVAILABLE.into_response(); + }; + + // Reserve a slot before returning 101: a closed or full channel must reject + // the request rather than accept a socket that cannot be handed off. + let permit = match connections.clone().try_reserve_owned() { + Ok(permit) => permit, + Err(_) => return StatusCode::SERVICE_UNAVAILABLE.into_response(), + }; + + upgrade + .on_failed_upgrade(|error| { + tracing::warn!(%error, "WebSocket upgrade failed"); + }) + .on_upgrade(move |socket| async move { + // The receiver now owns the socket and manages its lifetime and + // closure. If the receiver disappears, the socket is dropped. + permit.send(socket); + }) +} + +// Builds an HTTP JSON response from already serialized bytes. +fn json_response(body: Bytes) -> Response { + // Do not wrap these bytes in Json: that would serialize the content again. + ([(header::CONTENT_TYPE, "application/json")], body).into_response() +} diff --git a/backend/crates/station/src/http/server.rs b/backend/crates/station/src/http/server.rs new file mode 100644 index 000000000..0bb27dedf --- /dev/null +++ b/backend/crates/station/src/http/server.rs @@ -0,0 +1,332 @@ +//! Router construction and server execution using an existing listener. + +use std::{io, sync::Arc}; + +use axum::{ + Router, + extract::ws::WebSocket, + http::{HeaderValue, header}, + routing::get, +}; +use software_core::adj::Adj; +use tokio::sync::mpsc; +use tower_http::{cors::CorsLayer, set_header::SetResponseHeaderLayer}; + +use super::handlers::{HttpState, data_packet, order_packet, protection_packet, websocket}; + +/// Serves the catalogs and hands connections to the future WebSocket module. +/// +/// The caller chooses the address and port when binding the listener. To enable +/// WebSocket, pass `Some(sender)` from a bounded channel and keep its receiver +/// in the module that will manage the sockets. With `None`, a closed receiver, +/// or a full channel, upgrade requests receive `503`. +/// +/// This future runs until the server stops; await it or spawn it on Tokio. +/// +/// # Errors +/// +/// Propagates errors serializing the catalogs or running the Axum server. +pub(super) fn setup_router( + adj: &Adj, + websocket_connections: Option>, +) -> io::Result { + // Build and serialize the catalogs once, before accepting requests. The + // state retains the bytes even after the Adj is dropped. + let state = Arc::new(HttpState::new(adj, websocket_connections).map_err(io::Error::other)?); + + Ok(Router::new() + .route("/backend/adj/DataPackets", get(data_packet)) + .route("/backend/adj/OrderPackets", get(order_packet)) + .route("/backend/adj/ProtectionPackets", get(protection_packet)) + .route("/backend/ws", get(websocket)) + .layer(CorsLayer::permissive()) + .layer(SetResponseHeaderLayer::overriding( + header::CACHE_CONTROL, + HeaderValue::from_static("no-cache"), + )) + .with_state(state)) +} + +#[cfg(test)] +pub(super) mod tests { + use std::{io, path::Path, time::Duration}; + + use axum::{ + body::{Body, to_bytes}, + http::{Method, Request, StatusCode, header}, + }; + use software_core::adj::{Adj, load_from_dir}; + use tokio::{ + io::{AsyncBufReadExt, AsyncWriteExt, BufReader}, + net::{TcpListener, TcpStream}, + sync::{mpsc, oneshot}, + time::timeout, + }; + use tower::ServiceExt; + + use super::setup_router; + + pub(in crate::http) const PATHS: [&str; 3] = [ + "/backend/adj/DataPackets", + "/backend/adj/OrderPackets", + "/backend/adj/ProtectionPackets", + ]; + + #[tokio::test] + async fn catalogs_return_precomputed_json() -> Result<(), Box> { + let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("../core/src/adj/test/adj"); + let adj = load_from_dir(&path)?; + let expected = [ + serde_json::to_value(&adj.data_response())?, + serde_json::to_value(&adj.order_response())?, + serde_json::to_value(&adj.protection_response())?, + ]; + let app = setup_router(&adj, None)?; + drop(adj); + + for (path, expected) in PATHS.into_iter().zip(expected) { + let mut previous_body = None; + for _ in 0..2 { + let response = app + .clone() + .oneshot(Request::builder().uri(path).body(Body::empty())?) + .await?; + + assert_eq!(response.status(), StatusCode::OK); + assert_eq!(response.headers()[header::CONTENT_TYPE], "application/json"); + let body = to_bytes(response.into_body(), usize::MAX).await?; + let actual: serde_json::Value = serde_json::from_slice(&body)?; + assert_eq!(actual, expected); + if let Some(previous) = previous_body { + assert_eq!(body, previous); + } + previous_body = Some(body); + } + } + Ok(()) + } + + #[tokio::test] + async fn empty_catalogs_return_json_objects() -> Result<(), Box> { + let app = setup_router(&Adj::default(), None)?; + let expected = [ + serde_json::json!({"boards": []}), + serde_json::json!({"boards": []}), + serde_json::json!({"protections": [], "info": {}}), + ]; + + for (path, expected) in PATHS.into_iter().zip(expected) { + let response = app + .clone() + .oneshot(Request::builder().uri(path).body(Body::empty())?) + .await?; + assert_eq!(response.status(), StatusCode::OK); + let body = to_bytes(response.into_body(), 1024).await?; + let actual: serde_json::Value = serde_json::from_slice(&body)?; + assert_eq!(actual, expected); + } + Ok(()) + } + + #[tokio::test] + async fn all_routes_return_no_cache_and_allow_any_origin() + -> Result<(), Box> { + let app = setup_router(&Adj::default(), None)?; + + for path in PATHS.into_iter().chain(["/backend/ws"]) { + for origin in ["http://localhost:3000", "https://example.com"] { + let response = app + .clone() + .oneshot( + Request::builder() + .uri(path) + .header(header::ORIGIN, origin) + .body(Body::empty())?, + ) + .await?; + + let expected_status = if path == "/backend/ws" { + StatusCode::BAD_REQUEST + } else { + StatusCode::OK + }; + assert_eq!(response.status(), expected_status); + assert_eq!(response.headers()[header::CACHE_CONTROL], "no-cache"); + assert_eq!(response.headers()[header::ACCESS_CONTROL_ALLOW_ORIGIN], "*"); + assert!( + !response + .headers() + .contains_key(header::ACCESS_CONTROL_ALLOW_CREDENTIALS) + ); + } + } + Ok(()) + } + + #[tokio::test] + async fn all_routes_allow_cors_preflight_with_no_cache() + -> Result<(), Box> { + let app = setup_router(&Adj::default(), None)?; + + for path in PATHS.into_iter().chain(["/backend/ws"]) { + let response = app + .clone() + .oneshot( + Request::builder() + .method(Method::OPTIONS) + .uri(path) + .header(header::ORIGIN, "http://localhost:3000") + .header(header::ACCESS_CONTROL_REQUEST_METHOD, "GET") + .header(header::ACCESS_CONTROL_REQUEST_HEADERS, "x-client-id") + .body(Body::empty())?, + ) + .await?; + + assert_eq!(response.status(), StatusCode::OK); + assert_eq!(response.headers()[header::CACHE_CONTROL], "no-cache"); + assert_eq!(response.headers()[header::ACCESS_CONTROL_ALLOW_ORIGIN], "*"); + assert_eq!( + response.headers()[header::ACCESS_CONTROL_ALLOW_METHODS], + "*" + ); + assert_eq!( + response.headers()[header::ACCESS_CONTROL_ALLOW_HEADERS], + "*" + ); + } + Ok(()) + } + + // Upgrades require a real HTTP connection: oneshot does not provide Hyper's + // OnUpgrade extension. The server only runs for the duration of the test. + async fn handshake( + app: axum::Router, + ) -> Result<(String, TcpStream), Box> { + let listener = TcpListener::bind("127.0.0.1:0").await?; + handshake_on(listener, app).await + } + + pub(in crate::http) async fn handshake_on( + listener: TcpListener, + app: axum::Router, + ) -> Result<(String, TcpStream), Box> { + let address = listener.local_addr()?; + let (shutdown, stopped) = oneshot::channel(); + let server = tokio::spawn(async move { + axum::serve(listener, app) + .with_graceful_shutdown(async move { + let _ = stopped.await; + }) + .await + }); + + let response = timeout(Duration::from_secs(5), async { + let mut stream = TcpStream::connect(address).await?; + let request = format!( + "GET /backend/ws HTTP/1.1\r\n\ + Host: {address}\r\n\ + Origin: http://localhost:3000\r\n\ + Connection: Upgrade\r\n\ + Upgrade: websocket\r\n\ + Sec-WebSocket-Version: 13\r\n\ + Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\n\r\n" + ); + stream.write_all(request.as_bytes()).await?; + + let mut reader = BufReader::new(stream); + let mut headers = String::new(); + while !headers.ends_with("\r\n\r\n") { + if reader.read_line(&mut headers).await? == 0 { + return Err(io::Error::from(io::ErrorKind::UnexpectedEof)); + } + } + Ok((headers, reader.into_inner())) + }) + .await; + + let _ = shutdown.send(()); + timeout(Duration::from_secs(5), server).await???; + Ok(response??) + } + + #[tokio::test] + async fn websocket_upgrade_delivers_the_socket() -> Result<(), Box> { + let (connections, mut receiver) = mpsc::channel(1); + let app = setup_router(&Adj::default(), Some(connections.clone()))?; + let (headers, _client) = handshake(app).await?; + + assert!(headers.starts_with("HTTP/1.1 101 Switching Protocols\r\n")); + assert!( + headers + .to_ascii_lowercase() + .contains("sec-websocket-accept: s3pplmbitxaq9kygzzhzrbk+xoo=\r\n") + ); + assert!( + headers + .to_ascii_lowercase() + .contains("cache-control: no-cache\r\n") + ); + assert!( + headers + .to_ascii_lowercase() + .contains("access-control-allow-origin: *\r\n") + ); + let socket = timeout(Duration::from_secs(5), receiver.recv()) + .await? + .ok_or_else(|| io::Error::other("no se entregó el socket"))?; + assert_eq!(connections.capacity(), 1); + drop(socket); + Ok(()) + } + + #[tokio::test] + async fn websocket_without_a_consumer_returns_unavailable() + -> Result<(), Box> { + let app = setup_router(&Adj::default(), None)?; + let (headers, _client) = handshake(app).await?; + assert!(headers.starts_with("HTTP/1.1 503 Service Unavailable\r\n")); + Ok(()) + } + + #[tokio::test] + async fn websocket_with_a_closed_channel_returns_unavailable() + -> Result<(), Box> { + let (connections, receiver) = mpsc::channel(1); + drop(receiver); + let app = setup_router(&Adj::default(), Some(connections))?; + let (headers, _client) = handshake(app).await?; + assert!(headers.starts_with("HTTP/1.1 503 Service Unavailable\r\n")); + Ok(()) + } + + #[tokio::test] + async fn websocket_with_a_full_channel_returns_unavailable() + -> Result<(), Box> { + let (connections, _receiver) = mpsc::channel(1); + // Simulate an occupied slot without requiring another test socket. + let reservation = connections.clone().try_reserve_owned()?; + let app = setup_router(&Adj::default(), Some(connections))?; + let (headers, _client) = handshake(app).await?; + assert!(headers.starts_with("HTTP/1.1 503 Service Unavailable\r\n")); + drop(reservation); + Ok(()) + } + + #[tokio::test] + async fn websocket_rejects_requests_without_upgrade_headers() + -> Result<(), Box> { + let (connections, mut receiver) = mpsc::channel(1); + let app = setup_router(&Adj::default(), Some(connections.clone()))?; + let response = app + .oneshot(Request::builder().uri("/backend/ws").body(Body::empty())?) + .await?; + + assert_eq!(response.status(), StatusCode::BAD_REQUEST); + assert_eq!(connections.capacity(), 1); + assert!(matches!( + receiver.try_recv(), + Err(mpsc::error::TryRecvError::Empty) + )); + Ok(()) + } +} diff --git a/backend/crates/station/src/main.rs b/backend/crates/station/src/main.rs new file mode 100644 index 000000000..d872008d1 --- /dev/null +++ b/backend/crates/station/src/main.rs @@ -0,0 +1,13 @@ +//! Ejecutable mínimo para demostrar la integración con `software-core`. + +use tracing_subscriber::EnvFilter; + +fn main() { + let filter = EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new("info")); + tracing_subscriber::fmt().with_env_filter(filter).init(); + + tracing::info!("iniciando demo de station"); + let name = std::env::args().nth(1).unwrap_or_else(|| "World".into()); + let _greeting = software_core::hello_world::greet(&name); + tracing::info!("demo finalizada"); +} diff --git a/backend/crates/station/src/vehicle.rs b/backend/crates/station/src/vehicle.rs new file mode 100644 index 000000000..e69de29bb diff --git a/backend/package.json b/backend/package.json index ae867cc7e..cd65355be 100644 --- a/backend/package.json +++ b/backend/package.json @@ -2,12 +2,14 @@ "name": "backend", "version": "1.0.0", "private": true, - "author": "Hyperloop UPV Team", + "author": "Hyperloop UPV", "license": "MIT", "scripts": { - "dev": "go run ./cmd --config ./cmd/dev-config.toml", - "dev:main": "go run ./cmd --config ./cmd/config.toml", - "build": "go build -o bin/backend ./cmd", - "build:ci": "go build" + "dev": "cargo run -p station -- --config ./crates/station/dev-config.toml", + "dev:main": "cargo run -p station --release -- --config ./crates/station/config.toml", + "build": "cargo build -p station --release", + "build:ci": "cargo build --workspace --release", + "lint": "cargo clippy --workspace --all-targets -- -D warnings", + "fmt": "cargo fmt --all" } } diff --git a/backend/readme-demo.md b/backend/readme-demo.md new file mode 100644 index 000000000..050e911ac --- /dev/null +++ b/backend/readme-demo.md @@ -0,0 +1,41 @@ +# Demo: core → station + tracing + +Desde `software/backend`, con Rust 1.98.0 y Cargo instalados (la primera +ejecución descarga las dependencias): + +```sh +# Ejecutar: muestra el saludo y el ciclo de vida a nivel INFO. +cargo run -p station +cargo run -p station -- "Hyperloop UPV" + +# Mostrar también DEBUG del módulo, manteniendo INFO en station. +RUST_LOG=info,software_core::hello_world=debug cargo run -p station -- "Lucía" + +# Filtrar todos los eventos de esta demo (no emite errores). +RUST_LOG=error cargo run -p station + +# Tests unitarios y ejemplo de documentación ejecutable (doctest). +cargo test --workspace + +# Generar documentación HTML de la API. +cargo doc --workspace --no-deps + +# Comprobaciones de formato y lints. +cargo fmt --all -- --check +cargo clippy --workspace --all-targets -- -D warnings +``` + +Abre `target/doc/software_core/hello_world/index.html` para ver la API. + +- `crates/core/src/hello_world.rs`: `greet(&str) -> String`, con rustdoc, +- `crates/core/src/lib.rs`: exporta el módulo público. +- `crates/station/src/main.rs`: inicializa el subscriber una sola vez y llama a `greet`. +- `#[tracing::instrument]` crea el span `hello_world`; los eventos incluyen + el destinatario y campos estructurados como `greeting` o `used_default`. + `INFO` muestra el saludo; `DEBUG` permite inspeccionar la elección del destinatario. +- Core solo emite eventos: sin subscriber, devuelve igualmente el saludo. + Los tests comprueban ese resultado sin configurar logging global. + +Esta demo termina tras saludar; todavía no arranca servidores ni carga TOML. +Usa los comandos Cargo de arriba: los scripts `pnpm dev` están preparados para +la futura configuración del backend, que esta demo no interpreta. diff --git a/backend/rust-toolchain.toml b/backend/rust-toolchain.toml new file mode 100644 index 000000000..aa20bc990 --- /dev/null +++ b/backend/rust-toolchain.toml @@ -0,0 +1,3 @@ +[toolchain] +channel = "1.98.0" +components = ["rustfmt", "clippy"] diff --git a/backend/rustfmt.toml b/backend/rustfmt.toml new file mode 100644 index 000000000..4937083a4 --- /dev/null +++ b/backend/rustfmt.toml @@ -0,0 +1,3 @@ +edition = "2024" +max_width = 100 +use_field_init_shorthand = true diff --git a/backend_old/.gitignore b/backend_old/.gitignore new file mode 100644 index 000000000..384729b1f --- /dev/null +++ b/backend_old/.gitignore @@ -0,0 +1,22 @@ +log +trace.json + +/bin + +# Test coverage +*testfile + +# Build artifacts +/bin/ +backend +trace.json + +# Test data +*.out +c.out + +# Logs +cmd/logger/ +cmd/cmd +cmd/adj +/logger/ \ No newline at end of file diff --git a/backend/captures/IP_in_IP.cap b/backend_old/captures/IP_in_IP.cap similarity index 100% rename from backend/captures/IP_in_IP.cap rename to backend_old/captures/IP_in_IP.cap diff --git a/backend/captures/README.md b/backend_old/captures/README.md similarity index 100% rename from backend/captures/README.md rename to backend_old/captures/README.md diff --git a/backend/captures/path_MTU_discovery.cap b/backend_old/captures/path_MTU_discovery.cap similarity index 100% rename from backend/captures/path_MTU_discovery.cap rename to backend_old/captures/path_MTU_discovery.cap diff --git a/backend/captures/telnet.cap b/backend_old/captures/telnet.cap similarity index 100% rename from backend/captures/telnet.cap rename to backend_old/captures/telnet.cap diff --git a/backend/cmd/config.toml b/backend_old/cmd/config.toml similarity index 100% rename from backend/cmd/config.toml rename to backend_old/cmd/config.toml diff --git a/backend/cmd/dev-config.toml b/backend_old/cmd/dev-config.toml similarity index 100% rename from backend/cmd/dev-config.toml rename to backend_old/cmd/dev-config.toml diff --git a/backend/cmd/main.go b/backend_old/cmd/main.go similarity index 100% rename from backend/cmd/main.go rename to backend_old/cmd/main.go diff --git a/backend/cmd/orchestrator.go b/backend_old/cmd/orchestrator.go similarity index 100% rename from backend/cmd/orchestrator.go rename to backend_old/cmd/orchestrator.go diff --git a/backend/cmd/setup_transport.go b/backend_old/cmd/setup_transport.go similarity index 100% rename from backend/cmd/setup_transport.go rename to backend_old/cmd/setup_transport.go diff --git a/backend/cmd/setup_vehicle.go b/backend_old/cmd/setup_vehicle.go similarity index 100% rename from backend/cmd/setup_vehicle.go rename to backend_old/cmd/setup_vehicle.go diff --git a/backend/go.mod b/backend_old/go.mod similarity index 100% rename from backend/go.mod rename to backend_old/go.mod diff --git a/backend/go.sum b/backend_old/go.sum similarity index 100% rename from backend/go.sum rename to backend_old/go.sum diff --git a/backend/internal/common/chan.go b/backend_old/internal/common/chan.go similarity index 100% rename from backend/internal/common/chan.go rename to backend_old/internal/common/chan.go diff --git a/backend/internal/common/errors.go b/backend_old/internal/common/errors.go similarity index 100% rename from backend/internal/common/errors.go rename to backend_old/internal/common/errors.go diff --git a/backend/internal/common/io.go b/backend_old/internal/common/io.go similarity index 100% rename from backend/internal/common/io.go rename to backend_old/internal/common/io.go diff --git a/backend/internal/common/map.go b/backend_old/internal/common/map.go similarity index 100% rename from backend/internal/common/map.go rename to backend_old/internal/common/map.go diff --git a/backend/internal/common/moving_average.go b/backend_old/internal/common/moving_average.go similarity index 100% rename from backend/internal/common/moving_average.go rename to backend_old/internal/common/moving_average.go diff --git a/backend/internal/common/net.go b/backend_old/internal/common/net.go similarity index 100% rename from backend/internal/common/net.go rename to backend_old/internal/common/net.go diff --git a/backend/internal/common/numbers.go b/backend_old/internal/common/numbers.go similarity index 100% rename from backend/internal/common/numbers.go rename to backend_old/internal/common/numbers.go diff --git a/backend/internal/common/ring_buf.go b/backend_old/internal/common/ring_buf.go similarity index 100% rename from backend/internal/common/ring_buf.go rename to backend_old/internal/common/ring_buf.go diff --git a/backend/internal/common/set.go b/backend_old/internal/common/set.go similarity index 100% rename from backend/internal/common/set.go rename to backend_old/internal/common/set.go diff --git a/backend/internal/common/slice.go b/backend_old/internal/common/slice.go similarity index 100% rename from backend/internal/common/slice.go rename to backend_old/internal/common/slice.go diff --git a/backend/internal/common/types.go b/backend_old/internal/common/types.go similarity index 100% rename from backend/internal/common/types.go rename to backend_old/internal/common/types.go diff --git a/backend/internal/config/config.go b/backend_old/internal/config/config.go similarity index 100% rename from backend/internal/config/config.go rename to backend_old/internal/config/config.go diff --git a/backend/internal/config/config_types.go b/backend_old/internal/config/config_types.go similarity index 100% rename from backend/internal/config/config_types.go rename to backend_old/internal/config/config_types.go diff --git a/backend/internal/flags/flags.go b/backend_old/internal/flags/flags.go similarity index 100% rename from backend/internal/flags/flags.go rename to backend_old/internal/flags/flags.go diff --git a/backend/internal/pod_data/measurement.go b/backend_old/internal/pod_data/measurement.go similarity index 100% rename from backend/internal/pod_data/measurement.go rename to backend_old/internal/pod_data/measurement.go diff --git a/backend/internal/pod_data/models.go b/backend_old/internal/pod_data/models.go similarity index 100% rename from backend/internal/pod_data/models.go rename to backend_old/internal/pod_data/models.go diff --git a/backend/internal/pod_data/pod_data.go b/backend_old/internal/pod_data/pod_data.go similarity index 100% rename from backend/internal/pod_data/pod_data.go rename to backend_old/internal/pod_data/pod_data.go diff --git a/backend/internal/pod_data/sortable_packets.go b/backend_old/internal/pod_data/sortable_packets.go similarity index 100% rename from backend/internal/pod_data/sortable_packets.go rename to backend_old/internal/pod_data/sortable_packets.go diff --git a/backend/internal/server/config.go b/backend_old/internal/server/config.go similarity index 100% rename from backend/internal/server/config.go rename to backend_old/internal/server/config.go diff --git a/backend/internal/update_factory/models/update.go b/backend_old/internal/update_factory/models/update.go similarity index 100% rename from backend/internal/update_factory/models/update.go rename to backend_old/internal/update_factory/models/update.go diff --git a/backend/internal/update_factory/update_factory.go b/backend_old/internal/update_factory/update_factory.go similarity index 100% rename from backend/internal/update_factory/update_factory.go rename to backend_old/internal/update_factory/update_factory.go diff --git a/backend/internal/utils/units.go b/backend_old/internal/utils/units.go similarity index 100% rename from backend/internal/utils/units.go rename to backend_old/internal/utils/units.go diff --git a/backend/internal/vehicle/config.go b/backend_old/internal/vehicle/config.go similarity index 100% rename from backend/internal/vehicle/config.go rename to backend_old/internal/vehicle/config.go diff --git a/backend/internal/vehicle/models/order_data.go b/backend_old/internal/vehicle/models/order_data.go similarity index 100% rename from backend/internal/vehicle/models/order_data.go rename to backend_old/internal/vehicle/models/order_data.go diff --git a/backend/internal/vehicle/packet_parser/config.go b/backend_old/internal/vehicle/packet_parser/config.go similarity index 100% rename from backend/internal/vehicle/packet_parser/config.go rename to backend_old/internal/vehicle/packet_parser/config.go diff --git a/backend/package-lock.json b/backend_old/package-lock.json similarity index 100% rename from backend/package-lock.json rename to backend_old/package-lock.json diff --git a/backend_old/package.json b/backend_old/package.json new file mode 100644 index 000000000..ae867cc7e --- /dev/null +++ b/backend_old/package.json @@ -0,0 +1,13 @@ +{ + "name": "backend", + "version": "1.0.0", + "private": true, + "author": "Hyperloop UPV Team", + "license": "MIT", + "scripts": { + "dev": "go run ./cmd --config ./cmd/dev-config.toml", + "dev:main": "go run ./cmd --config ./cmd/config.toml", + "build": "go build -o bin/backend ./cmd", + "build:ci": "go build" + } +} diff --git a/backend/pkg/abstraction/board.go b/backend_old/pkg/abstraction/board.go similarity index 100% rename from backend/pkg/abstraction/board.go rename to backend_old/pkg/abstraction/board.go diff --git a/backend/pkg/abstraction/broker.go b/backend_old/pkg/abstraction/broker.go similarity index 100% rename from backend/pkg/abstraction/broker.go rename to backend_old/pkg/abstraction/broker.go diff --git a/backend/pkg/abstraction/logger.go b/backend_old/pkg/abstraction/logger.go similarity index 100% rename from backend/pkg/abstraction/logger.go rename to backend_old/pkg/abstraction/logger.go diff --git a/backend/pkg/abstraction/packet.go b/backend_old/pkg/abstraction/packet.go similarity index 100% rename from backend/pkg/abstraction/packet.go rename to backend_old/pkg/abstraction/packet.go diff --git a/backend/pkg/abstraction/transport.go b/backend_old/pkg/abstraction/transport.go similarity index 100% rename from backend/pkg/abstraction/transport.go rename to backend_old/pkg/abstraction/transport.go diff --git a/backend/pkg/adj/adj.go b/backend_old/pkg/adj/adj.go similarity index 100% rename from backend/pkg/adj/adj.go rename to backend_old/pkg/adj/adj.go diff --git a/backend/pkg/adj/boards.go b/backend_old/pkg/adj/boards.go similarity index 100% rename from backend/pkg/adj/boards.go rename to backend_old/pkg/adj/boards.go diff --git a/backend/pkg/adj/git.go b/backend_old/pkg/adj/git.go similarity index 100% rename from backend/pkg/adj/git.go rename to backend_old/pkg/adj/git.go diff --git a/backend/pkg/adj/models.go b/backend_old/pkg/adj/models.go similarity index 100% rename from backend/pkg/adj/models.go rename to backend_old/pkg/adj/models.go diff --git a/backend/pkg/adj/validator.go b/backend_old/pkg/adj/validator.go similarity index 100% rename from backend/pkg/adj/validator.go rename to backend_old/pkg/adj/validator.go diff --git a/backend/pkg/boards/errors.go b/backend_old/pkg/boards/errors.go similarity index 100% rename from backend/pkg/boards/errors.go rename to backend_old/pkg/boards/errors.go diff --git a/backend/pkg/boards/events.go b/backend_old/pkg/boards/events.go similarity index 100% rename from backend/pkg/boards/events.go rename to backend_old/pkg/boards/events.go diff --git a/backend/pkg/broker/broker.go b/backend_old/pkg/broker/broker.go similarity index 100% rename from backend/pkg/broker/broker.go rename to backend_old/pkg/broker/broker.go diff --git a/backend/pkg/broker/errors.go b/backend_old/pkg/broker/errors.go similarity index 100% rename from backend/pkg/broker/errors.go rename to backend_old/pkg/broker/errors.go diff --git a/backend/pkg/broker/topics/connection/connection_test.go b/backend_old/pkg/broker/topics/connection/connection_test.go similarity index 100% rename from backend/pkg/broker/topics/connection/connection_test.go rename to backend_old/pkg/broker/topics/connection/connection_test.go diff --git a/backend/pkg/broker/topics/connection/push.go b/backend_old/pkg/broker/topics/connection/push.go similarity index 100% rename from backend/pkg/broker/topics/connection/push.go rename to backend_old/pkg/broker/topics/connection/push.go diff --git a/backend/pkg/broker/topics/connection/update.go b/backend_old/pkg/broker/topics/connection/update.go similarity index 100% rename from backend/pkg/broker/topics/connection/update.go rename to backend_old/pkg/broker/topics/connection/update.go diff --git a/backend/pkg/broker/topics/data/data_test.go b/backend_old/pkg/broker/topics/data/data_test.go similarity index 100% rename from backend/pkg/broker/topics/data/data_test.go rename to backend_old/pkg/broker/topics/data/data_test.go diff --git a/backend/pkg/broker/topics/data/push.go b/backend_old/pkg/broker/topics/data/push.go similarity index 100% rename from backend/pkg/broker/topics/data/push.go rename to backend_old/pkg/broker/topics/data/push.go diff --git a/backend/pkg/broker/topics/data/update.go b/backend_old/pkg/broker/topics/data/update.go similarity index 100% rename from backend/pkg/broker/topics/data/update.go rename to backend_old/pkg/broker/topics/data/update.go diff --git a/backend/pkg/broker/topics/errors.go b/backend_old/pkg/broker/topics/errors.go similarity index 100% rename from backend/pkg/broker/topics/errors.go rename to backend_old/pkg/broker/topics/errors.go diff --git a/backend/pkg/broker/topics/logger/enable.go b/backend_old/pkg/broker/topics/logger/enable.go similarity index 100% rename from backend/pkg/broker/topics/logger/enable.go rename to backend_old/pkg/broker/topics/logger/enable.go diff --git a/backend/pkg/broker/topics/logger/logger_test.go b/backend_old/pkg/broker/topics/logger/logger_test.go similarity index 100% rename from backend/pkg/broker/topics/logger/logger_test.go rename to backend_old/pkg/broker/topics/logger/logger_test.go diff --git a/backend/pkg/broker/topics/message/message_test.go b/backend_old/pkg/broker/topics/message/message_test.go similarity index 100% rename from backend/pkg/broker/topics/message/message_test.go rename to backend_old/pkg/broker/topics/message/message_test.go diff --git a/backend/pkg/broker/topics/message/update.go b/backend_old/pkg/broker/topics/message/update.go similarity index 100% rename from backend/pkg/broker/topics/message/update.go rename to backend_old/pkg/broker/topics/message/update.go diff --git a/backend/pkg/broker/topics/order/order_test.go b/backend_old/pkg/broker/topics/order/order_test.go similarity index 100% rename from backend/pkg/broker/topics/order/order_test.go rename to backend_old/pkg/broker/topics/order/order_test.go diff --git a/backend/pkg/broker/topics/order/send.go b/backend_old/pkg/broker/topics/order/send.go similarity index 100% rename from backend/pkg/broker/topics/order/send.go rename to backend_old/pkg/broker/topics/order/send.go diff --git a/backend/pkg/broker/topics/order/state.go b/backend_old/pkg/broker/topics/order/state.go similarity index 100% rename from backend/pkg/broker/topics/order/state.go rename to backend_old/pkg/broker/topics/order/state.go diff --git a/backend/pkg/broker/topics/tests_functions/tests_functions.go b/backend_old/pkg/broker/topics/tests_functions/tests_functions.go similarity index 100% rename from backend/pkg/broker/topics/tests_functions/tests_functions.go rename to backend_old/pkg/broker/topics/tests_functions/tests_functions.go diff --git a/backend/pkg/broker/topics/topic.go b/backend_old/pkg/broker/topics/topic.go similarity index 100% rename from backend/pkg/broker/topics/topic.go rename to backend_old/pkg/broker/topics/topic.go diff --git a/backend/pkg/http/handlers.go b/backend_old/pkg/http/handlers.go similarity index 100% rename from backend/pkg/http/handlers.go rename to backend_old/pkg/http/handlers.go diff --git a/backend/pkg/http/mux.go b/backend_old/pkg/http/mux.go similarity index 100% rename from backend/pkg/http/mux.go rename to backend_old/pkg/http/mux.go diff --git a/backend/pkg/http/server.go b/backend_old/pkg/http/server.go similarity index 100% rename from backend/pkg/http/server.go rename to backend_old/pkg/http/server.go diff --git a/backend/pkg/logger/.gitignore b/backend_old/pkg/logger/.gitignore similarity index 100% rename from backend/pkg/logger/.gitignore rename to backend_old/pkg/logger/.gitignore diff --git a/backend/pkg/logger/base/logger.go b/backend_old/pkg/logger/base/logger.go similarity index 100% rename from backend/pkg/logger/base/logger.go rename to backend_old/pkg/logger/base/logger.go diff --git a/backend/pkg/logger/base/logger_test.go b/backend_old/pkg/logger/base/logger_test.go similarity index 100% rename from backend/pkg/logger/base/logger_test.go rename to backend_old/pkg/logger/base/logger_test.go diff --git a/backend/pkg/logger/data/.gitignore b/backend_old/pkg/logger/data/.gitignore similarity index 100% rename from backend/pkg/logger/data/.gitignore rename to backend_old/pkg/logger/data/.gitignore diff --git a/backend/pkg/logger/data/logger.go b/backend_old/pkg/logger/data/logger.go similarity index 100% rename from backend/pkg/logger/data/logger.go rename to backend_old/pkg/logger/data/logger.go diff --git a/backend/pkg/logger/data/logger_test.go b/backend_old/pkg/logger/data/logger_test.go similarity index 100% rename from backend/pkg/logger/data/logger_test.go rename to backend_old/pkg/logger/data/logger_test.go diff --git a/backend/pkg/logger/errors.go b/backend_old/pkg/logger/errors.go similarity index 100% rename from backend/pkg/logger/errors.go rename to backend_old/pkg/logger/errors.go diff --git a/backend/pkg/logger/file/csv.go b/backend_old/pkg/logger/file/csv.go similarity index 100% rename from backend/pkg/logger/file/csv.go rename to backend_old/pkg/logger/file/csv.go diff --git a/backend/pkg/logger/file/csv_test.go b/backend_old/pkg/logger/file/csv_test.go similarity index 100% rename from backend/pkg/logger/file/csv_test.go rename to backend_old/pkg/logger/file/csv_test.go diff --git a/backend/pkg/logger/logger.go b/backend_old/pkg/logger/logger.go similarity index 100% rename from backend/pkg/logger/logger.go rename to backend_old/pkg/logger/logger.go diff --git a/backend/pkg/logger/logger_test.go b/backend_old/pkg/logger/logger_test.go similarity index 100% rename from backend/pkg/logger/logger_test.go rename to backend_old/pkg/logger/logger_test.go diff --git a/backend/pkg/logger/order/logger.go b/backend_old/pkg/logger/order/logger.go similarity index 100% rename from backend/pkg/logger/order/logger.go rename to backend_old/pkg/logger/order/logger.go diff --git a/backend/pkg/logger/order/logger_test.go b/backend_old/pkg/logger/order/logger_test.go similarity index 100% rename from backend/pkg/logger/order/logger_test.go rename to backend_old/pkg/logger/order/logger_test.go diff --git a/backend/pkg/logger/protection/logger.go b/backend_old/pkg/logger/protection/logger.go similarity index 100% rename from backend/pkg/logger/protection/logger.go rename to backend_old/pkg/logger/protection/logger.go diff --git a/backend/pkg/logger/state/logger.go b/backend_old/pkg/logger/state/logger.go similarity index 100% rename from backend/pkg/logger/state/logger.go rename to backend_old/pkg/logger/state/logger.go diff --git a/backend/pkg/logger/time.go b/backend_old/pkg/logger/time.go similarity index 100% rename from backend/pkg/logger/time.go rename to backend_old/pkg/logger/time.go diff --git a/backend/pkg/logger/time_test.go b/backend_old/pkg/logger/time_test.go similarity index 100% rename from backend/pkg/logger/time_test.go rename to backend_old/pkg/logger/time_test.go diff --git a/backend/pkg/logger/trace/trace.go b/backend_old/pkg/logger/trace/trace.go similarity index 100% rename from backend/pkg/logger/trace/trace.go rename to backend_old/pkg/logger/trace/trace.go diff --git a/backend/pkg/logger/validator/validator.go b/backend_old/pkg/logger/validator/validator.go similarity index 100% rename from backend/pkg/logger/validator/validator.go rename to backend_old/pkg/logger/validator/validator.go diff --git a/backend/pkg/transport/constructor.go b/backend_old/pkg/transport/constructor.go similarity index 100% rename from backend/pkg/transport/constructor.go rename to backend_old/pkg/transport/constructor.go diff --git a/backend/pkg/transport/errors.go b/backend_old/pkg/transport/errors.go similarity index 100% rename from backend/pkg/transport/errors.go rename to backend_old/pkg/transport/errors.go diff --git a/backend/pkg/transport/keepalive.go b/backend_old/pkg/transport/keepalive.go similarity index 100% rename from backend/pkg/transport/keepalive.go rename to backend_old/pkg/transport/keepalive.go diff --git a/backend/pkg/transport/messages.go b/backend_old/pkg/transport/messages.go similarity index 100% rename from backend/pkg/transport/messages.go rename to backend_old/pkg/transport/messages.go diff --git a/backend/pkg/transport/network/payload.go b/backend_old/pkg/transport/network/payload.go similarity index 100% rename from backend/pkg/transport/network/payload.go rename to backend_old/pkg/transport/network/payload.go diff --git a/backend/pkg/transport/network/sniffer/errors.go b/backend_old/pkg/transport/network/sniffer/errors.go similarity index 100% rename from backend/pkg/transport/network/sniffer/errors.go rename to backend_old/pkg/transport/network/sniffer/errors.go diff --git a/backend/pkg/transport/network/tcp/client.go b/backend_old/pkg/transport/network/tcp/client.go similarity index 100% rename from backend/pkg/transport/network/tcp/client.go rename to backend_old/pkg/transport/network/tcp/client.go diff --git a/backend/pkg/transport/network/tcp/config.go b/backend_old/pkg/transport/network/tcp/config.go similarity index 100% rename from backend/pkg/transport/network/tcp/config.go rename to backend_old/pkg/transport/network/tcp/config.go diff --git a/backend/pkg/transport/network/tcp/conn.go b/backend_old/pkg/transport/network/tcp/conn.go similarity index 100% rename from backend/pkg/transport/network/tcp/conn.go rename to backend_old/pkg/transport/network/tcp/conn.go diff --git a/backend/pkg/transport/network/tcp/server.go b/backend_old/pkg/transport/network/tcp/server.go similarity index 100% rename from backend/pkg/transport/network/tcp/server.go rename to backend_old/pkg/transport/network/tcp/server.go diff --git a/backend/pkg/transport/network/tcp/tcp_test.go b/backend_old/pkg/transport/network/tcp/tcp_test.go similarity index 100% rename from backend/pkg/transport/network/tcp/tcp_test.go rename to backend_old/pkg/transport/network/tcp/tcp_test.go diff --git a/backend/pkg/transport/network/udp/server.go b/backend_old/pkg/transport/network/udp/server.go similarity index 100% rename from backend/pkg/transport/network/udp/server.go rename to backend_old/pkg/transport/network/udp/server.go diff --git a/backend/pkg/transport/notifications.go b/backend_old/pkg/transport/notifications.go similarity index 100% rename from backend/pkg/transport/notifications.go rename to backend_old/pkg/transport/notifications.go diff --git a/backend/pkg/transport/packet/data/codec.go b/backend_old/pkg/transport/packet/data/codec.go similarity index 100% rename from backend/pkg/transport/packet/data/codec.go rename to backend_old/pkg/transport/packet/data/codec.go diff --git a/backend/pkg/transport/packet/data/converter.go b/backend_old/pkg/transport/packet/data/converter.go similarity index 100% rename from backend/pkg/transport/packet/data/converter.go rename to backend_old/pkg/transport/packet/data/converter.go diff --git a/backend/pkg/transport/packet/data/decoder.go b/backend_old/pkg/transport/packet/data/decoder.go similarity index 100% rename from backend/pkg/transport/packet/data/decoder.go rename to backend_old/pkg/transport/packet/data/decoder.go diff --git a/backend/pkg/transport/packet/data/descriptors.go b/backend_old/pkg/transport/packet/data/descriptors.go similarity index 100% rename from backend/pkg/transport/packet/data/descriptors.go rename to backend_old/pkg/transport/packet/data/descriptors.go diff --git a/backend/pkg/transport/packet/data/encoder.go b/backend_old/pkg/transport/packet/data/encoder.go similarity index 100% rename from backend/pkg/transport/packet/data/encoder.go rename to backend_old/pkg/transport/packet/data/encoder.go diff --git a/backend/pkg/transport/packet/data/errors.go b/backend_old/pkg/transport/packet/data/errors.go similarity index 100% rename from backend/pkg/transport/packet/data/errors.go rename to backend_old/pkg/transport/packet/data/errors.go diff --git a/backend/pkg/transport/packet/data/packet.go b/backend_old/pkg/transport/packet/data/packet.go similarity index 100% rename from backend/pkg/transport/packet/data/packet.go rename to backend_old/pkg/transport/packet/data/packet.go diff --git a/backend/pkg/transport/packet/data/value.go b/backend_old/pkg/transport/packet/data/value.go similarity index 100% rename from backend/pkg/transport/packet/data/value.go rename to backend_old/pkg/transport/packet/data/value.go diff --git a/backend/pkg/transport/packet/order/codec.go b/backend_old/pkg/transport/packet/order/codec.go similarity index 100% rename from backend/pkg/transport/packet/order/codec.go rename to backend_old/pkg/transport/packet/order/codec.go diff --git a/backend/pkg/transport/packet/order/decoder.go b/backend_old/pkg/transport/packet/order/decoder.go similarity index 100% rename from backend/pkg/transport/packet/order/decoder.go rename to backend_old/pkg/transport/packet/order/decoder.go diff --git a/backend/pkg/transport/packet/order/errors.go b/backend_old/pkg/transport/packet/order/errors.go similarity index 100% rename from backend/pkg/transport/packet/order/errors.go rename to backend_old/pkg/transport/packet/order/errors.go diff --git a/backend/pkg/transport/packet/order/packet.go b/backend_old/pkg/transport/packet/order/packet.go similarity index 100% rename from backend/pkg/transport/packet/order/packet.go rename to backend_old/pkg/transport/packet/order/packet.go diff --git a/backend/pkg/transport/packet/protection/decoder.go b/backend_old/pkg/transport/packet/protection/decoder.go similarity index 100% rename from backend/pkg/transport/packet/protection/decoder.go rename to backend_old/pkg/transport/packet/protection/decoder.go diff --git a/backend/pkg/transport/packet/protection/errors.go b/backend_old/pkg/transport/packet/protection/errors.go similarity index 100% rename from backend/pkg/transport/packet/protection/errors.go rename to backend_old/pkg/transport/packet/protection/errors.go diff --git a/backend/pkg/transport/packet/protection/kind.go b/backend_old/pkg/transport/packet/protection/kind.go similarity index 100% rename from backend/pkg/transport/packet/protection/kind.go rename to backend_old/pkg/transport/packet/protection/kind.go diff --git a/backend/pkg/transport/packet/protection/packet.go b/backend_old/pkg/transport/packet/protection/packet.go similarity index 100% rename from backend/pkg/transport/packet/protection/packet.go rename to backend_old/pkg/transport/packet/protection/packet.go diff --git a/backend/pkg/transport/packet/state/decoder.go b/backend_old/pkg/transport/packet/state/decoder.go similarity index 100% rename from backend/pkg/transport/packet/state/decoder.go rename to backend_old/pkg/transport/packet/state/decoder.go diff --git a/backend/pkg/transport/packet/state/packet.go b/backend_old/pkg/transport/packet/state/packet.go similarity index 100% rename from backend/pkg/transport/packet/state/packet.go rename to backend_old/pkg/transport/packet/state/packet.go diff --git a/backend/pkg/transport/presentation/decoder.go b/backend_old/pkg/transport/presentation/decoder.go similarity index 100% rename from backend/pkg/transport/presentation/decoder.go rename to backend_old/pkg/transport/presentation/decoder.go diff --git a/backend/pkg/transport/presentation/decoder_test.go b/backend_old/pkg/transport/presentation/decoder_test.go similarity index 100% rename from backend/pkg/transport/presentation/decoder_test.go rename to backend_old/pkg/transport/presentation/decoder_test.go diff --git a/backend/pkg/transport/presentation/encoder.go b/backend_old/pkg/transport/presentation/encoder.go similarity index 100% rename from backend/pkg/transport/presentation/encoder.go rename to backend_old/pkg/transport/presentation/encoder.go diff --git a/backend/pkg/transport/presentation/encoder_test.go b/backend_old/pkg/transport/presentation/encoder_test.go similarity index 100% rename from backend/pkg/transport/presentation/encoder_test.go rename to backend_old/pkg/transport/presentation/encoder_test.go diff --git a/backend/pkg/transport/presentation/errors.go b/backend_old/pkg/transport/presentation/errors.go similarity index 100% rename from backend/pkg/transport/presentation/errors.go rename to backend_old/pkg/transport/presentation/errors.go diff --git a/backend/pkg/transport/session/buffer.go b/backend_old/pkg/transport/session/buffer.go similarity index 100% rename from backend/pkg/transport/session/buffer.go rename to backend_old/pkg/transport/session/buffer.go diff --git a/backend/pkg/transport/transport.go b/backend_old/pkg/transport/transport.go similarity index 100% rename from backend/pkg/transport/transport.go rename to backend_old/pkg/transport/transport.go diff --git a/backend/pkg/vehicle/constructor.go b/backend_old/pkg/vehicle/constructor.go similarity index 100% rename from backend/pkg/vehicle/constructor.go rename to backend_old/pkg/vehicle/constructor.go diff --git a/backend/pkg/vehicle/errors.go b/backend_old/pkg/vehicle/errors.go similarity index 100% rename from backend/pkg/vehicle/errors.go rename to backend_old/pkg/vehicle/errors.go diff --git a/backend/pkg/vehicle/notification.go b/backend_old/pkg/vehicle/notification.go similarity index 100% rename from backend/pkg/vehicle/notification.go rename to backend_old/pkg/vehicle/notification.go diff --git a/backend/pkg/vehicle/vehicle.go b/backend_old/pkg/vehicle/vehicle.go similarity index 100% rename from backend/pkg/vehicle/vehicle.go rename to backend_old/pkg/vehicle/vehicle.go diff --git a/backend/pkg/websocket/client.go b/backend_old/pkg/websocket/client.go similarity index 100% rename from backend/pkg/websocket/client.go rename to backend_old/pkg/websocket/client.go diff --git a/backend/pkg/websocket/errors.go b/backend_old/pkg/websocket/errors.go similarity index 100% rename from backend/pkg/websocket/errors.go rename to backend_old/pkg/websocket/errors.go diff --git a/backend/pkg/websocket/pool.go b/backend_old/pkg/websocket/pool.go similarity index 100% rename from backend/pkg/websocket/pool.go rename to backend_old/pkg/websocket/pool.go diff --git a/backend/pkg/websocket/upgrader.go b/backend_old/pkg/websocket/upgrader.go similarity index 100% rename from backend/pkg/websocket/upgrader.go rename to backend_old/pkg/websocket/upgrader.go diff --git a/backend/scripts/analyze_trace.py b/backend_old/scripts/analyze_trace.py similarity index 100% rename from backend/scripts/analyze_trace.py rename to backend_old/scripts/analyze_trace.py