Skip to content

Bind Ditto's C ABI directly instead of the Rust SDK crate #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alycda wants to merge 1 commit into
base: claude/ditto-custom-backend-erfn80
Choose a base branch
from
Draft

Bind Ditto's C ABI directly instead of the Rust SDK crate #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,21 +51,16 @@ jobs:
run: cargo test --workspace

ditto:
# The optional Ditto backend links a prebuilt native library downloaded
# by the dittolive-ditto-sys build script; keep it in its own job so the
# default build stays small.
#
# Pinned toolchain: dittolive-ditto-sys 4.14.7 (via safer-ffi 0.2.0-rc1)
# generates a #[repr(transparent)] struct that Rust 1.98+ rejects with
# E0690 (rust-lang/rust#155299). Bump once Ditto ships a fixed SDK.
# The optional Ditto backend links a prebuilt native library that the
# crate's build script downloads (see crates/taskbook-client/build.rs);
# keep it in its own job so the default build stays small.
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Install Rust
uses: dtolnay/rust-toolchain@master
uses: dtolnay/rust-toolchain@stable
with:
toolchain: 1.97.0
components: clippy

- name: Cache dependencies
Expand Down
11 changes: 7 additions & 4 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ cargo test
# Check for issues
cargo clippy

# Build/test with the optional Ditto backend (downloads a ~165 MB native lib on first build).
# Needs Rust 1.85..=1.97 until Ditto fixes an E0690 in its bindings; CI pins 1.97.0.
# Build/test with the optional Ditto backend (build.rs downloads a ~165 MB native
# lib on first build, or set DITTO_SDK_DIR to a directory holding libdittoffi.a).
cargo build --package taskbook-client --features ditto
cargo test --package taskbook-client --features ditto -- --test-threads=1
```
Expand Down Expand Up @@ -78,7 +78,10 @@ crates/
│ │ ├── mod.rs # StorageBackend trait + config-driven factory
│ │ ├── local.rs # LocalStorage (file-based)
│ │ ├── remote.rs # RemoteStorage (HTTP + encryption)
│ │ └── ditto.rs # DittoStorage (peer-to-peer CRDT sync, feature "ditto")
│ │ └── ditto/ # DittoStorage (peer-to-peer CRDT sync, feature "ditto")
│ │ ├── mod.rs # backend: document model, diff writes, id renumbering
│ │ ├── sdk.rs # safe wrapper over the C ABI (open, DQL, observers, presence)
│ │ └── ffi.rs # hand-written extern "C" bindings to libdittoffi (see build.rs)
│ └── tui/ # Interactive TUI (ratatui + crossterm)
│
└── taskbook-server/ # Server binary (tb-server)
Expand Down Expand Up @@ -259,7 +262,7 @@ All under `/api/v1/` unless noted:
- `base64` - Encoding encrypted data
- `rpassword` - Secure password input
- `fs2` - File locking for local storage
- `dittolive-ditto` (optional, feature `ditto`) - Ditto peer-to-peer sync SDK
- `ciborium` + `libc` (optional, feature `ditto`) - CBOR for Ditto's C ABI; the native `libdittoffi.a` is fetched by `build.rs` (`scripts/ditto-abi-check.sh` diffs the ABI across SDK releases)

### Common (taskbook-common)
- `aes-gcm` - AES-256-GCM encryption
Expand Down
Loading
Loading