chroma-core/chroma

[ENH] Client / Server versioning compatibility

オープン

#2,524 opened on 2024/07/16

GitHub で見る
 (4 件のコメント) (0 件のリアクション) (0 人の担当者)Rust (2,247 件のフォーク)batch import
by-chromadeploymentgood first issue

Repository metrics

Stars
 (27,958 個のスター)
PR merge metrics
 (平均マージ 1d 16h) (30d で 80 merged PRs)

説明

It's possible for users to not keep upgrades of clients and servers for Chroma in sync (e.g. https://github.com/chroma-core/chroma/issues/2510)

This can lead to confusing errors. In general, we don't want to support mismatched client and server versions, though we do have limited backward compatibility between older client versions (which may be distributed to user machines and might not receive upgrades) and newer servers.

We should:

  • Add a way for clients and servers to communicate their versions to each other
  • Add logic to check for version compatibility
  • Throw friendly error messages explaining the upgrade path, including any commands or utilities which need to be run.

コントリビューターガイド

調査方針
クライアントとサーバー間の既存の通信プロトコル（おそらく HTTP または gRPC）をレビューし、バージョン情報を追加できる場所を特定します。現在のバージョン設定（例：サーバーの Cargo.toml、クライアントの package.json または setup.py）を確認します。参照されている issue #2510 を確認して、一般的なエラーシナリオを把握します。クライアントの初期化またはサーバーのリクエスト処理でバージョンチェックを実装し、互換性ポリシー（例：メジャーバージョンの不一致はエラー、マイナー/パッチバージョンの不一致は警告）を定義することを検討します。アップグレード手順を含む明確なエラーメッセージを作成します。
技術スタック
rust
領域
backendapi
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
RustHTTP/gRPCVersioning concepts
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
45