プロダクトの意味的な pillar 正本(目的・スコープ・技術方針のハブ)。
OKF の版索引は index.md(okf_version のみ)。本文はここに書く。
実装前の構想を含む。現行の振る舞い仕様は specs/(Options / State / Tx / Snapshot / Recovery / Es4 Server)。これからやる内容は roadmap.md と plans/ を参照。
- Redis/Valkeyを導入するほどではないが、しかし一定の機能を備えたサーバーサイドステートを持ちたい
- Redisの永続化層のように、インメモリではあるが揮発しない機能が欲しい
- 組み込みと独立、ケースバイケースで実装を選べるようにしたい
- 各層で様々なサービスを選択できるようにしたい(Adapter化)
- Go(初期実装)
- Node.js(TypeScript: Go版の実装後)
- インメモリのステートストアと、そのAPI口
- ステートをリカバリするための永続化層
- 上記2層は、アダプター化され、複数のドライバーを設定できる
実装済みの現行仕様ではなく、PO が決めた構想図である。
flowchart TB
APP["Application"]
subgraph ES4["Es4"]
API["State API"]
subgraph STATE["State Store"]
MEMJSON["Memory JSON"]
FILESQL["File SQLite"]
OTHER["Other State Backend"]
end
SNAP["Snapshot Manager"]
API --> STATE
STATE --> SNAP
end
APP --> API
subgraph RECOVERY["Recovery Storage"]
FILE["File"]
OBJECT["Object Storage\nS3 / GCS"]
LIBSQL["libSQL"]
OTHER_REC["Other Adapter"]
end
SNAP --> FILE
SNAP --> OBJECT
SNAP --> LIBSQL
SNAP --> OTHER_REC
sequenceDiagram
participant App
participant Es4
participant State as State Store
participant Recovery as Recovery Storage
App->>Es4: SET / GET / DELETE / EXISTS / CLEAR
Es4->>State: Update / Read
State-->>Es4: Current State
Es4-->>App: Result
Note over Es4,Recovery: Snapshot interval
Es4->>State: Create Snapshot
State-->>Es4: Snapshot
Es4->>Recovery: Save Snapshot
Note over App,Recovery: Process / Instance failure
Es4->>Recovery: Load Snapshot
Recovery-->>Es4: Snapshot
Es4->>State: Restore
State-->>Es4: Ready
flowchart LR
STATE["Current State\n揮発してよい"]
SNAP["Snapshot"]
REC["Recovery Point\n復旧のために残す"]
STATE -->|periodic / explicit| SNAP
SNAP --> REC
REC -->|restart / failure| STATE
- ライブラリとしての組み込み
- 単独アプリケーション
の両利用を想定
flowchart LR
subgraph EMBEDDED["Embedded"]
APP1["Application"]
ES41["Es4 Library"]
MEM1["In-process State"]
REC1["Recovery Storage"]
APP1 --> ES41
ES41 --> MEM1
ES41 --> REC1
end
subgraph SERVER["Server"]
APP2["Application"]
ES42["Es4 Server\nDocker"]
MEM2["Server-local State"]
REC2["Recovery Storage"]
APP2 -->|HTTP| ES42
ES42 --> MEM2
ES42 --> REC2
end
- roadmap — マイルストーン(現行線 v0.10.0:キー
:+Scan) - plans — これからやる内容
- Phase 0 決定事項 — スキャフォールド完了・module path・最初の Git タグ方針
- Phase 1 仕様 — State / Snapshot / Recovery / Options(
v0.2.0実装完了・plans から移動済み) - Phase 2 仕様 — SQLite State / Tx / Snapshot / Options(
v0.3.0実装完了・plans から移動済み) - Phase 3 Recovery / Options — libSQL / Object・世代 TTL・GCS=S3 互換
- Phase 4 仕様 — HTTP Es4 Server・Docker・Health(末尾
/なし。v0.5.0実装完了・Git タグ済み・plans から移動済み) - Phase 5 仕様 — Adapter(
Store)境界・Export deep copy・Replace 原子性・最適化境界(Redis/Valkey Unscheduled。v0.6.0実装完了・Git タグ済み・完了注記) - Phase 6 E2E — Object Recovery × RustFS(
v0.7.0)+ File/Memory(v0.7.1)+ libSQL(v0.7.3· 完了注記)+ Actions(v0.7.2) - open-questions — 未決プロダクト論点(残件なし)
- wishlist — PO メモ(未整理)
- specs — 現行仕様
- tests — テスト仕様
- 憲章 — 開発ルール
以上