First Internal Alpha build per DEC-001. Closes the milestone of
'Flutter UI calls Rust via the typed bridge, Rust connects to a
TeamSpeak-compatible server through tsclientlib, returns a typed
snapshot, and disconnects cleanly.' Audio remains Beta scope.
Promotions from PoC:
poc/tsclientlib-connect-spike → crates/chanora_protocol/
New product code:
crates/chanora_protocol/src/{dto.rs,adapter.rs} — typed boundary
over tsclientlib. Tokio task owns the Connection; public
handle communicates via mpsc/oneshot. No tsclientlib types
cross out of the crate (SAD-067 / SysDes-011 / SysDes-029).
core/chanora_core/src/lib.rs — ChanoraSession composes the
protocol crate, enforces the DEC-006 single-connection
invariant.
crates/chanora_bridge/src/{api.rs,frb_generated.rs} — FRB 2.12.0
bridge per DEC-014. cdylib + staticlib + rlib. Typed
BridgeSnapshot / BridgeChannel / BridgeClient / BridgeError
DTOs. Process-wide OnceLock<Runtime> + OnceLock<ChanoraSession>.
flutter_rust_bridge.yaml at repo root.
apps/chanora_flutter/lib/main.dart — Alpha UI: server form,
connect button, channel tree, disconnect.
apps/chanora_flutter/lib/l10n/app_{en,zh}.arb expanded with the
Alpha key set; ARB metadata reaffirms ADR-008 for
server-provided content.
Generated Dart bindings under apps/chanora_flutter/lib/src/rust/.
Empirical verification (2026-05-14):
Workspace: cargo check + cargo test clean
(workspace tests: all green).
Bridge cdylib: target/release/libchanora_bridge.so produced
(~15 MB).
Flutter: flutter analyze clean; flutter test runs 3/3 green
including the alpha_e2e_test that drives the full
Dart → FRB → chanora_bridge → chanora_core → chanora_protocol
→ tsclientlib → UDP → cn.teamspeak.app
path. The captured logcat/stdout shows the tsproto resender
transitioning Connected → Disconnecting → Disconnected on
clean teardown.
Architecture changes:
- Removed the chanora_core ↔ chanora_bridge cyclic dependency.
chanora_core no longer knows the bridge exists; the bridge
maps from CoreError.
- chanora_bridge crate's #![forbid(unsafe_code)] lint relaxed
because FRB-generated glue legitimately uses unsafe at the
FFI boundary. Hand-written code remains unsafe-free.
Open follow-ups (NOT in this Alpha):
- Audio capture/playback wiring into chanora_audio
(Beta scope per DEC-001).
- Identity persistence via chanora_storage
(currently regenerated on every connect).
- Per-message diagnostics + redaction
(chanora_diagnostics still scaffold).
- Reconnect / network-loss recovery.
- Mobile (Android) build of the bridge cdylib + UI verification.
11 KiB
Changelog
All notable changes to Chanora will be documented in this file.
This project is expected to follow a Conventional Commits style workflow.
[Unreleased]
Added — Alpha build (v0.1.0-alpha.1)
- First Alpha build wires the connect → snapshot → disconnect cycle end-to-end from the Flutter UI to a live TeamSpeak-compatible server via the typed Flutter/Rust bridge. Per DEC-001 this is the Internal Alpha milestone; Audio (voice in/out) is deferred to Beta.
crates/chanora_protocol/promoted from a scaffold to a working adapter. Public surface:ConnectConfig,ProtocolClient,ProtocolError.- DTO module exposing
ChannelId,ClientId,ChannelInfo,ClientInfo,ServerSnapshot— all owned primitives andStrings; notsclientlib::*types leak (SAD-067). - Tokio task owns the
tsclientlib::Connection; public handle communicates viampscrequests +oneshotreplies. - Connect waits for the initial
BookEventssnapshot, then pumps events for ~2 s so the subscribed channel tree settles before the first snapshot is served. - Promoted from
poc/tsclientlib-connect-spike.
core/chanora_core::ChanoraSessionnow drives the protocol crate with a typedconnect/snapshot/is_connected/disconnectAPI. Enforces the DEC-006 single-connection invariant via an internaltokio::sync::Mutex<Option<ProtocolClient>>.crates/chanora_bridge/wired againstflutter_rust_bridge2.12.0 (DEC-014). Compiled ascdylib + staticlib + rlib. Exposes:bridge_init()(FRB lifecycle),connect(),snapshot(),disconnect(),is_connected().- Typed
BridgeChannel,BridgeClient,BridgeSnapshotDTOs;BridgeErrorwithFrom<chanora_core::CoreError>. - A process-wide
tokio::Runtime+ChanoraSessionviaOnceLock, used by every async command. - The crate's
#![forbid(unsafe_code)]lint was lifted to#![warn(missing_docs)]only, with a doc-comment explanation that the FRB-generated glue legitimately uses unsafe at the FFI boundary; hand-written code in the crate is still expected to avoidunsafe.
flutter_rust_bridge.yamlat the repo root drives codegen for the bridge.- Generated Dart bindings under
apps/chanora_flutter/lib/src/rust/{api.dart,frb_generated*.dart,lib*.dart}. - Generated Rust glue under
crates/chanora_bridge/src/frb_generated.rs. apps/chanora_flutter/lib/main.dartrewritten as the Alpha UI:- Form: server address + nickname, both pre-populated for convenience.
- Connect button → calls FRB → enters connecting state → shows snapshot.
- Snapshot view: server welcome banner (preserved verbatim per
ADR-008),
N channels • M onlinecount, ordered channel list with clients indented under their channel. - Refresh and Disconnect actions in the app bar.
apps/chanora_flutter/lib/l10n/app_{en,zh}.arbexpanded with the Alpha key set:homeNotProductionReadyBanner(now says "Alpha build"),fieldServerHost,fieldNickname,connectAction,disconnectAction,refreshAction,statusIdle,statusConnecting,statusConnected,statusError,channelsHeading,clientsHeading,countChannelsAndClients.flutter_localizations,intl,flutter_rust_bridge,freezed_annotationadded to dependencies;freezedandbuild_runneradded to dev_dependencies.apps/chanora_flutter/test/alpha_e2e_test.dartruns the full Dart → FRB → Rust → tsclientlib → network → server path againstcn.teamspeak.app. Verifies the snapshot contains a non-empty server name and a non-empty channel list, thatisConnected()flips true → false across the disconnect, and that a re-fetched snapshot agrees on the server name. Passes in ~2.5 s.core/chanora_core/tests/alpha_smoke.rsruns the same path from the Rust side; tagged#[ignore]socargo test --workspacedoesn't hit the network by default. Run with--ignored alpha_smoke.
Changed
chanora_core::CoreErrorno longer wrapschanora_bridge::BridgeError; the relationship is the other way around (bridge maps from core). This removes a cyclicchanora_core↔chanora_bridgedependency introduced when the bridge crate gainedchanora_coreas a dep.chanora_bridgelints relaxed from#![forbid(unsafe_code)]to#.
LICENSE files (carry-over from earlier in this branch)
LICENSE-APACHE— Apache License Version 2.0 text (DEC-020).LICENSE-MIT— MIT License text (DEC-020).- Initial repository foundation files.
- Documentation-first project structure.
justfilewithformat,lint,test,verify-docs, andsecurity-scantargets, completingrepository-bootstrap-planv0.1.0 §3.poc/tsclientlib-connect-spike/— PoC proving protocol feasibility viatsclientlib. Verified againstcn.teamspeak.appon 2026-05-13.poc/flutter_rust_bridge_hello/— PoC proving the Flutter↔Rust command and event-stream boundary viaflutter_rust_bridge2.12.0. Verified on Linux desktop on 2026-05-13.poc/secure-storage-spike/— PoC proving platform secure storage via a typedSecretStorageRepositorytrait and a Linux adapter selecting between Secret Service (libsecret) and kernel keyutils. Audit checks SS-AUD-001/002/003/005/006 and SS-TC-003 verified on 2026-05-13.poc/sqlite-storage-spike/— PoC proving SRS-089's "embedded data store + migration mechanism" acceptance criteria: forward-only schema migrator tracked viaPRAGMA user_version, repository pattern withBookmarkRepository/SettingsRepositorytraits overLocalDatabaseRepository. 11/11 tests verified on 2026-05-13.poc/diagnostics-redaction-spike/— PoC proving the diagnostic redaction policy fromdiagnostic-redaction-audit-report.md: typed policy + regex rules + literal known-secret registry + bundle redaction. Audit cases REDACT-TC-001..010 verified on 2026-05-13.poc/audio-capture-playback-spike/— PoC proving platform audio capture/playback via cpal. Desktop half (Linux + PipeWire) empirically verified end-to-end on 2026-05-13; mobile half closed separately bypoc/audio-capture-playback-android-spike.poc/audio-capture-playback-android-spike/— PoC closing the mobile half of the audio capture/playback PoC plan entry. Rust cdylib + JNI + Kotlin Android app; cpal targets Android's Oboe backend (AAudio). Verified end-to-end on a physical Motorola Moto G Stylus 5G (2023) running Android 14 arm64-v8a on 2026-05-13: 500 ms 440 Hz sine wave driven out the device speaker (22,050 frames at 44.1 kHz) and 1 s captured from the microphone into a valid 85,292-byte RIFF/WAVE mono 16-bit PCM file pulled viaadb exec-out run-as.poc/README.mdsummarising PoC status againstdocs/architecture/proof-of-concept-plan.md.
Changed
-
DEC-020 license resolved. Chanora is now dual-licensed under Apache-2.0 OR MIT (recipient's choice), the standard Rust-ecosystem permissive model. Compatible with every direct dependency (
tsclientlib,flutter_rust_bridge,cpal,rusqlite,keyring, etc.) and with the Flutter framework's BSD-3-Clause.LICENSErewritten as a dual-license aggregator pointing atLICENSE-APACHEandLICENSE-MIT.NOTICErewritten with current direct-dependency attributions.README.md§License updated. -
docs/governance/product-decision-register.mdbumped to v0.9.6: DEC-020 status promoted from Open to Accepted. §4 license row updated. §6 collapsed: there is no longer any open decision — DEC-012 legal review remains as a work item, not a pending decision. Change-history entry added. -
docs/governance/poc-results-summary.mdbumped to v0.4.0: RISK-PoC-003 closed. DEC-020 row moved from the "Still open" section into the closed table. -
docs/governance/product-decision-register.mdbumped to v0.9.5: owner confirmation on all 17 previously-Proposed decisions (DEC-001..010, 012, 015..019, 021). Sixteen were Accepted as recommended; two were modified by the owner — DEC-004 Android minimum raised from API 24 to API 28, and DEC-015 product language for MVP expanded from English-only to English + Chinese (Simplified). DEC-020 license remains Open / Deferred and is now the only public-release-gating decision outstanding. §4 renamed "Recommended" → "Accepted MVP Defaults" with MODIFIED rows annotated. §6 collapsed to the single remaining DEC-020 item. §7 dated and statused for every decision. -
docs/governance/poc-results-summary.mdbumped to v0.3.0: RISK-PoC-004 closed by the owner-confirmation pass; new RISK-PoC-006 (AndroidminSdkmove 24 → 28 for product code) and RISK-PoC-007 (MVP language expansion to en + zh-Hans) added. -
docs/architecture/proof-of-concept-plan.mdbumped to v0.3.0 to promote the audio PoC from PARTIAL PASS to PASS after the Android mobile half was closed; all six PoC plan entries are now PASS. -
docs/governance/product-decision-register.mdbumped to v0.9.4 to promote DEC-011.1 mobile half from Deferred to Accepted (Android), keeping iOS Deferred. -
docs/governance/poc-results-summary.mdbumped to v0.2.0: audio row promoted to PASS, RISK-PoC-001 narrowed from "mobile audio" to "iOS audio only", Android toolchain added to the toolchain table. -
poc/audio-capture-playback-spike/VERIFICATION.mdupdated to point at the Android spike for the mobile half. -
poc/README.mdupdated to list both audio spike directories. -
docs/architecture/proof-of-concept-plan.mdbumped to v0.2.0 to record PoC outcomes (5 PASS, 1 PARTIAL) and add a Status column. -
docs/security/secure-storage-audit-report.mdbumped to v0.9.3: SS-AUD-001/002/003/005/006 status set to PoC Pass with evidence pointers; SS-TC-003 (Linux) Actual Result populated and Status set to PoC Pass; findings SS-FIND-001..003 added; non-Linux test cases marked Deferred. -
docs/security/diagnostic-redaction-audit-report.mdbumped to v0.9.3: REDACT-TC-001..010 status set to PoC Pass with evidence pointers; export bundle policy §5 populated; findings REDACT-FIND-001..003 added. -
docs/governance/product-decision-register.mdbumped to v0.9.3: owner-confirmed decisions recorded — DEC-014 Accepted (flutter_rust_bridge2.x pinned), DEC-013.1 Accepted (rusqlitebundled), DEC-013.2 Accepted (Linux Secret Service preferred, keyutils fallback), DEC-011.1 Accepted (desktopcpal) / Deferred (mobile), DEC-022 Accepted (canonical implementation directory layout per README sketch + SAD §7.2), DEC-020 explicitly Deferred and remains a public-release blocker.
Added (governance)
docs/governance/poc-results-summary.mdv0.1.0 — single-page reviewer-facing summary of the PoC phase, the toolchain exercised, the owner decisions taken, the audit coverage, and the open risks RISK-PoC-001..005.
Fixed
- N/A
Security
- N/A
Versioning note
The project implementation has not reached a public release version yet.