voodoo-store 0.1.0__tar.gz

voodoo_store-0.1.0/Cargo.lock

@@ -0,0 +1,325 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[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 = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "cpufeatures"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "crc32fast"
+version = "1.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "01a7799fd6b852db0e61728dde9a204c423b44d689dbd432522543614b490e78"
+dependencies = [
+ "cfg-if",
+]
+
+[[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 = "digest"
+version = "0.10.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
+dependencies = [
+ "block-buffer",
+ "crypto-common",
+]
+
+[[package]]
+name = "fs2"
+version = "0.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9564fc758e15025b46aa6643b1b77d047d1a56a1aea6e01002ac0c7026876213"
+dependencies = [
+ "libc",
+ "winapi",
+]
+
+[[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.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "300e883d756b2e4ec94e02791f39b04b522276138852cfc41d9fb7e904106099"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "r-efi",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "libc"
+version = "0.2.189"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2"
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85"
+
+[[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 = "pyo3"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91fd8e38a3b50ed1167fb981cd6fd60147e091784c427b8f7183a7ee32c31c12"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e368e7ddfdeb98c9bca7f8383be1648fd84ab466bf2bc015e94008db6d35611e"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7f29e10af80b1f7ccaf7f69eace800a03ecd13e883acfacc1e5d0988605f651e"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "df6e520eff47c45997d2fc7dd8214b25dd1310918bbb2642156ef66a67f29813"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn 2.0.119",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c4cdc218d835738f81c2338f822078af45b4afdf8b2e33cbb5916f108b813acb"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn 2.0.119",
+]
+
+[[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 = "6.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf"
+
+[[package]]
+name = "sha2"
+version = "0.10.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283"
+dependencies = [
+ "cfg-if",
+ "cpufeatures",
+ "digest",
+]
+
+[[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.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "12df2e0110f65b775f769bb17ef989067a1d931b2eb822bd4346631eeada89f9"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "thiserror"
+version = "2.0.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec86235f5fcc2a73650310756d2ac5b138a5780bbbdfae3eeccec992c435ba4f"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bc04cd3e1236dd4a98afca4569f2deb3f120e5422a4023be2cb683f8486292af"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 3.0.5",
+]
+
+[[package]]
+name = "typenum"
+version = "1.20.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "version_check"
+version = "0.9.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
+
+[[package]]
+name = "voodoo-store-cli"
+version = "0.1.0"
+dependencies = [
+ "voodoo-store-core",
+]
+
+[[package]]
+name = "voodoo-store-core"
+version = "0.1.0"
+dependencies = [
+ "crc32fast",
+ "fs2",
+ "getrandom",
+ "sha2",
+ "thiserror",
+]
+
+[[package]]
+name = "voodoo-store-ffi"
+version = "0.1.0"
+dependencies = [
+ "voodoo-store-core",
+]
+
+[[package]]
+name = "voodoo-store-python"
+version = "0.1.0"
+dependencies = [
+ "pyo3",
+ "voodoo-store-core",
+]
+
+[[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-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"

voodoo_store-0.1.0/Cargo.toml

@@ -0,0 +1,16 @@
+[workspace]
+members = ["crates/voodoo-store-core", "crates/voodoo-store-python"]
+resolver = "2"
+
+[workspace.package]
+edition = "2024"
+license = "Apache-2.0"
+repository = "https://github.com/helderperez-dev/voodoo-store"
+rust-version = "1.85"
+
+[workspace.dependencies]
+crc32fast = "1.4"
+fs2 = "0.4"
+getrandom = "0.4"
+sha2 = "0.10"
+thiserror = "2"

voodoo_store-0.1.0/PKG-INFO

@@ -0,0 +1,302 @@
+Metadata-Version: 2.4
+Name: voodoo-store
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Rust
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
+Summary: Embedded application state engine for Python, backed by Voodoo Store Rust core
+Keywords: embedded,database,state,runtime,rust
+Author: Helder Perez
+License-Expression: Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/helderperez-dev/voodoo-store
+Project-URL: Issues, https://github.com/helderperez-dev/voodoo-store/issues
+Project-URL: Repository, https://github.com/helderperez-dev/voodoo-store
+
+# Voodoo Store
+
+> **Application infrastructure in a store.**
+
+Voodoo Store is a **standalone, 100% Rust embedded application-state engine** built around one goal:
+
+> **A Voodoo application should be able to run robustly with Voodoo + Voodoo Store and no mandatory external infrastructure by default.**
+
+It is being built for the Voodoo ecosystem, but the core is not coupled to Voodoo Framework. The engine and `.vstore` format are designed to remain language-neutral and independently usable.
+
+**SQLite made the database a file. Voodoo Store aims to make application infrastructure a store.**
+
+## Status
+
+**v0.1 usable single-node development release.**
+
+Voodoo Store is pre-1.0, but it is now suitable for controlled single-node development and production experiments where its current compatibility and operational limits are understood.
+
+The current engine includes:
+
+- versioned, checksummed `.vstore` files and strong persistent Store identity;
+- checksummed append-only logging, atomic transactions and deterministic crash recovery;
+- Linux/macOS/Windows single-writer locking and explicit durability modes;
+- byte-oriented KV, CAS, counters, prefix scans and TTL;
+- Collections with schema/codec metadata and secondary/unique indexes;
+- durable Queues with leases, delay, priority, retry/NACK, dead state and stale-ACK protection;
+- durable Jobs with 128-bit IDs, idempotency, retry/backoff, deadlines and execution history;
+- one-shot, interval and deterministic UTC Cron scheduling;
+- durable Triggers;
+- Topics, Streams, replay, durable subscriptions and Consumer Groups;
+- durable request/reply correlation and RPC state;
+- transactional Outbox events;
+- content-addressed SHA-256 object storage, deduplication, verification, references and orphan GC;
+- durable Workflow/HITL state with waits, signals, timers and history;
+- verify, backup, create-only restore, logical snapshots and compact-copy;
+- structured health/storage accounting;
+- standalone `voodoo-store` CLI;
+- C ABI v2 foundation with transactions, `last_error` and panic containment;
+- deterministic corruption, torn-write and process-crash testing;
+- CI across Format, Clippy, Linux, macOS, Windows and Rust 1.85 MSRV.
+
+This is **not yet a production 1.0**. File/API compatibility should still be considered pre-1.0, and important data should be backed up before upgrading experimental deployments.
+
+## Start here
+
+Build and test:
+
+```bash
+cargo build --workspace
+cargo test --workspace
+```
+
+Run the executable application-state example:
+
+```bash
+cargo run -p voodoo-store-core --example application_state -- application.vstore
+```
+
+The example commits application state, a durable Job and an Outbox Event through one transaction:
+
+```text
+BEGIN
+  PUT order:42:status = paid
+  ENQUEUE JOB email.send_receipt(order:42)
+  EMIT EVENT order.paid(order:42)
+COMMIT
+```
+
+If that transaction does not commit, none of those staged mutations become visible after recovery.
+
+See `docs/QUICKSTART.md` for the full walkthrough.
+
+## North Star
+
+The standard Voodoo deployment is intentionally small:
+
+```text
+Application
+    |
+    +-- Voodoo Runtime
+    |
+    `-- application.vstore
+```
+
+A normal application should not need Redis, PostgreSQL, RabbitMQ, Kafka, Celery, a separate cron service, or a separate local object service merely to get robust application infrastructure.
+
+External infrastructure remains available as optional adapters when scale or deployment topology genuinely requires it.
+
+## Architecture
+
+```text
+Applications / Frameworks
+        |
+        +-- Voodoo Runtime / Framework
+        +-- Rust
+        +-- C / native bindings
+        +-- future Python / Node / Go / Swift bindings
+        |
+Stable APIs / bindings
+        |
+voodoo-store-core
+        |
+        +-- Data: KV / TTL / Collections / Indexes
+        +-- Work: Queues / Jobs / Scheduler / Cron / Triggers
+        +-- Messaging: Topics / Streams / Consumer Groups / RPC / Outbox
+        +-- Objects
+        +-- Workflow state
+        +-- Operations / health / lifecycle
+        |
+Transaction / Commit Layer
+        |
+Append-only Checksummed Log
+        |
+Recovery / Verification
+        |
+Versioned .vstore Header
+        |
+Filesystem + File Locking
+```
+
+The Store persists durable semantics. Voodoo Runtime executes application code, HTTP handlers, AI inference, external calls and Identity/Auth behavior.
+
+## Cross-domain transactions
+
+A major Voodoo Store goal is to remove the split-brain normally created by a database plus external work infrastructure.
+
+Current typed transaction primitives already allow application state, Jobs, Outbox Events and durable RPC Requests to share a Store transaction.
+
+```rust
+use voodoo_store_core::{JobSpec, Store};
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let mut store = Store::open("application.vstore")?;
+
+    let mut tx = store.begin()?;
+    tx.put(b"order:42:status", b"paid")?;
+    tx.enqueue_job(JobSpec::new(b"email.send_receipt", b"order:42"), 1_000)?;
+    tx.emit_event(b"order.paid", b"order:42", 1_000)?;
+    tx.request_rpc(b"payments.capture", b"order:42", 1_000, Some(31_000))?;
+    tx.commit()?;
+
+    Ok(())
+}
+```
+
+The public cross-domain transaction surface will continue expanding to additional primitives before 1.0.
+
+## Durability
+
+```rust
+use voodoo_store_core::{Durability, Store, StoreOptions};
+
+let store = Store::open_with_options(
+    "application.vstore",
+    StoreOptions {
+        durability: Durability::Strict,
+        repair_torn_tail: true,
+    },
+)?;
+```
+
+- `Strict` uses `sync_all()` on commit.
+- `Data` uses `sync_data()` on commit and is the default.
+- `Relaxed` relies on later operating-system flushing.
+
+Only an incomplete physical tail is automatically repairable. Corruption inside the durable prefix is surfaced as an error rather than silently discarded.
+
+## Current good-fit workloads
+
+v0.1 is a reasonable target for controlled use in:
+
+- Voodoo Runtime development;
+- SaaS/internal-tool prototypes and early deployments;
+- desktop/local-first applications;
+- AI agent and automation state;
+- edge gateways and robotics controllers;
+- single-node APIs that want durable Jobs/Queues without deploying an infrastructure stack.
+
+Pin the exact Store version and keep backups for important pre-1.0 stores.
+
+## Known pre-1.0 limits
+
+The main remaining work before a 1.0 claim includes:
+
+- continuous fuzzing and long-running durability soak tests;
+- identity-preserving checkpoints/log generations and atomic in-place compaction;
+- richer Collection query/range/composite-index support;
+- CDC, change feeds and live-query/watch APIs;
+- complete cross-domain transaction coverage for all Store primitives;
+- quotas, richer metrics and tracing;
+- streaming object I/O and lifecycle policies;
+- complete C ABI coverage and first-class language bindings;
+- encryption-at-rest/key-rotation design;
+- later replication/sync and Voodoo Protocol integration.
+
+Store Studio and distributed operation are later milestones and do not block controlled single-node use.
+
+## CLI
+
+The workspace includes the standalone `voodoo-store` binary. Examples:
+
+```bash
+cargo run -p voodoo-store-cli -- put application.vstore hello world
+cargo run -p voodoo-store-cli -- get application.vstore hello
+cargo run -p voodoo-store-cli -- health application.vstore
+cargo run -p voodoo-store-cli -- verify application.vstore
+cargo run -p voodoo-store-cli -- backup application.vstore application.backup.vstore
+```
+
+The CLI also exposes lifecycle, Queue, Collection, Messaging, Object, Job, Scheduler, Cron, Trigger and Workflow operations. See `docs/QUICKSTART.md` for usage guidance.
+
+## C ABI
+
+`voodoo-store-ffi` is the portability foundation for non-Rust bindings. The current ABI includes Store handles, KV operations, buffered transactions, thread-local `last_error` reporting and panic containment. Higher-level primitive coverage is still expanding before the ABI is considered complete.
+
+Public header:
+
+```text
+include/voodoo_store.h
+```
+
+## Workspace
+
+```text
+crates/
+  voodoo-store-core/   # correctness-critical embedded engine
+  voodoo-store-ffi/    # C ABI portability layer
+  voodoo-store-cli/    # standalone inspection and operation CLI
+
+include/
+  voodoo_store.h
+
+docs/
+  ARCHITECTURE.md
+  SPEC.md
+  INVARIANTS.md
+  ROADMAP.md
+  QUICKSTART.md
+```
+
+## Voodoo integration
+
+Voodoo Framework/Runtime will consume Store behind higher-level primitives while the engine stays independently usable.
+
+```text
+Voodoo Model       -> Store Collections / data
+Voodoo @task       -> Store Jobs / Queues
+Voodoo Scheduler   -> Store schedules / Cron
+Voodoo events      -> Store Topics / Streams / Outbox
+Voodoo ObjectStore -> Store Objects
+Execution / HITL   -> Store Workflow state
+Runtime Identity   -> durable state persisted through Store
+```
+
+Identity/Auth semantics remain in Voodoo Runtime, not in Voodoo Store.
+
+## Compatibility principle
+
+The lowest-level durable contract is bytes. Voodoo Store does not persist host-specific Python pickle, Java serialization, V8 objects or Go gob as its core format. Typed codecs and schemas are layered above the engine so a compatible Store can be accessed from multiple runtimes.
+
+## Development principle
+
+Correctness comes before feature count and benchmarks:
+
+```text
+SPEC
+  -> INVARIANTS
+  -> IMPLEMENTATION
+  -> TESTS
+  -> FAULT INJECTION
+  -> FUZZING
+  -> BENCHMARKS
+  -> OPTIMIZATION
+```
+
+## License
+
+Apache-2.0
+