chroma-core/chroma

[ENH] Client / Server versioning compatibility

Aperta

#2524 aperta il 16 lug 2024

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)Rust (2247 fork)batch import
by-chromadeploymentgood first issue

Metriche repository

Star
 (27.958 stelle)
Metriche merge PR
 (Merge medio 1g 16h) (80 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedere il protocollo di comunicazione esistente tra client e server (probabilmente HTTP o gRPC) per determinare dove è possibile aggiungere informazioni sulla versione. Esaminare l'attuale configurazione di versioning (ad esempio, Cargo.toml per il server, package.json o setup.py per il client). Controllare l'issue di riferimento #2510 per gli scenari di errore comuni. Considerare l'implementazione di controlli di versione nell'inizializzazione del client o nella gestione delle richieste del server e definire una politica di compatibilità (ad esempio, una mancata corrispondenza della versione principale dovrebbe generare un errore, una mancata corrispondenza della versione secondaria/patch dovrebbe generare un avviso). Scrivere messaggi di errore chiari con istruzioni per l'aggiornamento.
Tech stack
rust
Dominio
backendapi
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
RustHTTP/gRPCVersioning concepts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45