HN 日本語サマリー

← 一覧へ戻る
プログラミング

Show HN: Syncular – TypeScriptとRustコアによるオフラインファーストSQL同期

Show HN: Syncular – offline-first SQL sync with TypeScript and Rust cores (github.com)

68 pointsby quambo24 コメント

要約

Syncularは、サーバー権威型でオフラインファーストのSQL同期システムです。クライアントはローカルSQLiteデータベースを使用し、書き込みは楽観的アウトボックスを経由します。サーバー上の順序付けされたコミットログが真実の源となります。TypeScriptとRustのコアを持ち、仕様駆動で開発されています。

全文翻訳

syncular

[画像: Animated syncular ASCII singularity]

Syncularは、各クライアントにSQLiteデータベースを持ち、サーバー所有のコミットログを通じて同期します。アプリはローカルのSQLiteから読み込み、オフラインでも動作し続けます。書き込みはローカル状態を即座に更新し、アウトボックスに入り、サーバーが同期する際にチェックされます。

ブラウザクライアントはOPFS上でSQLiteを実行します。ネイティブ統合は、Rust、Swift、Kotlin、Flutter、React Native、Tauri全体でRustコアとネイティブSQLiteを共有します。サーバーはBun、Node、またはCloudflare Workers上でSQLite、Postgres、またはD1と共に実行されます。バックエンドサービスとワーカーは、永続的なSQLiteを持つserver-side SyncClient(ヘッドレスクライアントと呼ばれることもあります)を実行できます。データベースを持たないSyncRemoteClientは、コミットを送信し、登録されたサーバー操作を呼び出します。アプリケーションは、関連する書き込みと共に、domain actions as event rowsとしてドメインアクションをイベント行として保存できます。

ドキュメント ・ クイックスタート ・ ライブデモ ・ ベンチマーク ・ ブログ

試してみる

bun create syncular-app my-app --template minimal

minimalテンプレートは、サーバー、スキーマ、2つの独立したクライアント、およびスモークテストを作成します。5分でできるクイックスタートでは、生成されたプロジェクトを walkthrough し、2つのクライアントを互いに実行します。

プロジェクトステータス

Syncularは1.0未満であり、現在は私、Benjamin Knifflerによってメンテナンスされています。ワイヤープロトコルは文書化されており、2つの実装でチェックされています。公開APIとプロトコル詳細は、1.0まで変更される可能性があります。変更はdocs/RELEASE.mdに記録されています。

動作の確認方法

docs/SPEC.mdは同期ワイヤープロトコルを定義し、docs/REMOTE.mdは登録されたリモート操作を定義し、spec/vectors/にはバイトレベルのフィクスチャが含まれています。TypeScriptとRustのコアは、同じ実装に依存しない準拠カタログを実行します。両方のコアに影響する動作変更は、仕様を更新し、準拠シナリオを追加する必要があります。

統合テストは、決定論的なフォールトインジェクションを備えたインメモリトランスポートを使用します。それらは明示的な準備完了シグナルを待ちます。スリープは禁止されています。少数のアダプターテストが実際のソケットをテストします。詳細はpackages/conformanceにあります。

リポジトリマップ

パス内容
packages/coreプロトコルコーデック、共有型、ベクトルラウンドトリップ
packages/serverサーバープロトコルハンドラ、ストレージおよび承認インターフェース
packages/server-hono, packages/server-workersHonoおよびCloudflare Workersバインディング
packages/web-client@syncular/client、SQLite上のTypeScriptクライアントコア
packages/reactクライアント上のReactフック
packages/typegenスキーマおよびクエリコンパイラ(TypeScript、Swift、Kotlin、Dart、Rust出力付き)
packages/crypto, packages/crdt-yjs列暗号化およびYjs CRDT統合
packages/testing@syncular/testkit、インプロセスサーバーおよびクライアント
packages/conformance両コアが実行するシナリオカタログ
rust/Rustクライアントコア、コマンドサーフェス、C FFI
bindings/Tauri、React Native、Swift、Kotlin、Flutterバインディング
apps/docssyncular.devソース

開発

bun install
bun run check   # typecheck + lint + test

コントリビュートする前にAGENTS.mdをお読みください。これには、メンテナーの作業と外部からのコントリビューションに適用されるルールが含まれています。

LLM

このREADMEにはLLMの助けが多く使われています。プロジェクトの他の部分(ドキュメント、テスト、ベンチマーク、本番コード)も同様です。しかし、Syncular自体はプロンプトで生まれたわけではありません。私はオフラインファーストの問題に長年取り組み、2019年にdebeを構築し、このエンジンを書く前にPowerSync、Zero、Electric、Replicache、Turso、LiveStore、Jazzを綿密に研究しました。概念とその最初の実装は手書きされており、上記のチェックは、それがどこから来たかにかかわらず、すべてのdiffに適用されます。全容はブログにあります。エージェントへのドキュメントエントリはsyncular.dev/llmsにあります。

LLMの助けによるコントリビューションは歓迎します。モデルがドラフトまたは書き直したものがプルリクエストに残っている場合は、説明にその旨を記載してください。自分のdiffを読み、説明できるように準備してください。モデルから直接貼り付けられたプルリクエストは、コメントなしで閉じられます。