[FEATURE] Add GRPC/Protobuf support to Java client

Aperta
  • Qualcosa non va?
#1,709 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
grpc, java
Ambito
api, backend

Direzione di ricerca

Inizia con il trasporto HTTP esistente nell'OpenSearch Java client, quindi leggi common.proto in opensearch-protobufs e la voce transport-grpc di build.gradle in OpenSearch. Chiarisci se il client debba riutilizzare le classi esistenti, generare un percorso gRPC separato o fornire un supporto parziale. Il lavoro è completato quando sarà stato concordato un approccio al trasporto Java gRPC, con la compatibilità dell'API e il comportamento della migrazione definiti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement
Is your feature request related to a problem?

https://github.com/opensearch-project/OpenSearch/issues/16787 introduces GRPC/Protobuf as a new protocol/schema for client-server APIs, which has shown great performance improvements compared to traditional HTTP/REST APIs. This feature is now moving towards maturity and stabilization.

To further this feature's integration within the OpenSearch ecosystem, we would like to propose adding GRPC/Protobuf as a supported protocol in OpenSearch language clients. This will allow:

  • users to more easily be able to use this feature, rather than raw protobuf generated code
  • have shared common utilities which all clients can benefit from
  • maintain parity with the HTTP/JSON user experience.
  • Offer a more seamless transition from HTTP APIs to GRPC ones (e.g. through adding a flag to toggle --protocol={grpc,http})
What solution would you like?

Add gRPC transport support to the OpenSearch Java client, providing a high-performance alternative to the existing HTTP transport while maintaining full API compatibility.

Some questions/challenges to consider are:

  1. Reuse HTTP java classes vs. build new ones: Whether the existing java classes can be refactored to support GRPC as well. If not possible, another option is to build a new GRPC Java code path which gets generated differently from the HTTP ones, which
  2. Handwritten vs. auto-generated client If the GRPC code path is separate from the HTTP code path, should we handwrite the java client for GRPC, or is there a way to autogenerate it similar to the HTTP one? There could be divergences from spec and protobufs (due to protobuf best practices), so how can autogeneration work? Should it be generated from the API spec or opensearch-protobufs?
  3. Full support vs. partial support: Depending on the challenges for supporting a fully fledged GRPC client, shall we opt to provide support only on utilities for common patterns? Can we fallback on using the default generated protobuf language client for APIs which are not supported by the client yet?
  4. Protocol specific considerations: Is there a way for the Java client support gRPC-protocol-specific features, such as streaming? On the other hand, how can the client properly convert HTTP-specific features, like the bulk NDJSON format?
  5. User migration: How should users transition from HTTP to gRPC (e.g. --protocol={grpc,http} flag for a seamless transition, or would they have to rewrite their code to adhere to the GRPC client?
What alternatives have you considered?

Using the generated Java code for protobufs directly, rather than integrating into the existing client architecture.

Do you have any additional context?
Lingua principale
Java
Stelle
164
Fork
260
Merge medio
20h 4m
PR unite (30g)
53

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di opensearch-project/opensearch-java

Tutte le issue di opensearch-project/opensearch-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.