Skip to content

ARCHITECTURE.md

Latest commit

 

History

History
108 lines (86 loc) · 3.8 KB

ARCHITECTURE.md

File metadata and controls

108 lines (86 loc) · 3.8 KB
Raw

アーキテクチャ

設計理念

notecli = Misskey クライアントライブラリ + CLI ツール（単一クレート）

  • lib.rs でライブラリとして公開、main.rs で CLI バイナリを提供する単一クレート構成
  • コアロジック（api, models, db, streaming）がライブラリの本体。CLI と HTTP daemon はその消費者
  • NoteDeck が最大の消費者であり、Rust crate 依存としてコアモジュールを直接利用している
  • CLI は独立したフロントエンドとして、ライブラリと同じクレート内に同居する

判断基準

変更を加えるとき：

  • Misskey クライアントとして汎用的か？ → Yes ならコアモジュール（api, models, db, streaming）に入れる
  • CLI 固有の機能か？ → main.rs / cli.rs に入れる
  • NoteDeck 固有の機能か？ → NoteDeck 側で実装する（build_core_routes() 等の拡張ポイントを利用）

レイヤー構成

block-beta
  columns 3

  block:frontend:3
    columns 3
    CLI["CLI\n(main.rs)"]
    daemon["HTTP daemon\n(http_server)"]
    lib["lib.rs\n(crate)"]
  end

  block:core:3
    columns 3
    api["api.rs\nMisskey HTTP API"]
    models["models.rs\nデータ型 Raw→Norm"]
    streaming["streaming.rs\nWebSocket + 自動再接続"]
    db["db.rs\nSQLite"]
    keychain["keychain.rs\nOS認証"]
    event_bus["event_bus.rs\nbroadcast"]
  end

  block:foundation:3
    error["error.rs (統一エラー型)"]
  end

  CLI --> api
  daemon --> api
  lib --> db
  lib --> keychain
  streaming --> event_bus
  streaming --> db
Loading

モジュール責務

モジュール 責務 依存先
api.rs Misskey HTTP API のラッパー。ステートレス models, error
models.rs Raw（API応答）→ Normalized（内部表現）変換 -
db.rs SQLite 永続化（accounts, cache, servers） models, error
streaming.rs WebSocket 接続管理、自動再接続、イベント発行 models, db, event_bus, error
event_bus.rs tokio broadcast ベースの pub/sub -
http_server.rs Axum REST API + SSE。build_core_routes() で外部から構築可能 api, db, models, event_bus, error
keychain.rs OS ネイティブ keychain 抽象化 error
error.rs NotecliError 統一エラー型。トークン漏洩防止 -
cli.rs clap コマンド定義 -
main.rs CLI ディスパッチ + daemon 起動 + 出力フォーマット 全モジュール
lib.rs ライブラリ公開 API + get_credentials() db, keychain

データフロー

CLI コマンド実行

flowchart LR
  input[ユーザー入力] --> cli["cli.rs\n(parse)"]
  cli --> main["main.rs\n(dispatch)"]
  main --> api["api.rs\n(HTTP request)"]
  api --> models["models.rs\n(Raw → Normalized)"]
  models --> output["main.rs\n(format & print)"]
Loading

Streaming（daemon モード）

flowchart LR
  ws[Misskey WebSocket] --> streaming["streaming.rs\n(parse)"]
  streaming --> db["db.rs\n(cache update)"]
  streaming --> bus["event_bus.rs\n(broadcast)"]
  bus --> sse["http_server.rs\n(SSE to clients)"]
Loading

認証情報の解決

flowchart TD
  start[認証情報の取得] --> keychain["keychain.rs\n(OS keychain)"]
  keychain -->|成功| use[トークンを使用]
  keychain -->|失敗| db["db.rs\n(legacy token)"]
  db --> migrate[keychain に移行]
  migrate --> use
Loading

今後の改善方針

  1. main.rs の分割: 出力フォーマットを output.rs に、daemon 起動を daemon.rs に分離
  2. テスト追加: models.rs の変換ロジック、api.rs のレスポンスパース、認証フォールバック
  3. ライブラリ API の安定化: lib.rs の公開 API を整理し、semver に従う