Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

feat(server): register standard gRPC reflection on the primary listener

Ouverte
  • Quelque chose ne va pas ?
#3,058 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@2000krysztof y travaille déjà.

Depuis le 3/9/2026.

  • #3161 par @2000krysztof — ouverte

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
52/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
grpc, rust
Domaine
api, authentication, backend, documentation, testing

Piste de recherche

Commencez par le contournement de l’authentification pour /grpc.reflection. et les tests de listeners qui couvrent les listeners primaires et uniquement de callback, puis examinez openshell_core::FILE_DESCRIPTOR_SET et le point d’entrée de l’enregistrement du serveur gateway. Vérifiez le comportement du service de reflection avec un gateway en cours d’exécution et un client de reflection, notamment les services attendus, l’authentification et le rejet des listeners de callback. Terminez en ajoutant la documentation grpcurl demandée, tout en gardant séparé le travail sur le service health dans #2569.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

help wanted

User Story

As an API developer or operator, I want the gateway to serve standard gRPC reflection on its primary listener, so that supported tools can discover services and message descriptors without a separately distributed descriptor file.

Problem Statement

The gateway authentication and listener-routing code recognizes gRPC reflection paths as unauthenticated on the primary listener, and the build already produces a complete descriptor set. The server does not register a standard reflection service, so requests routed through that exception reach no implementation.

Impact / Why This Matters

Tools such as grpcurl, schema browsers, and integration diagnostics cannot discover the live gateway API. The existing unauthenticated routing rule suggests reflection is supported when it is not. Developers must locate matching source protos or descriptor artifacts and ensure they correspond to the running gateway version.

Proposed Design

Register the standard gRPC reflection v1 service on the primary gateway listener using the descriptor set produced by the existing protobuf build. Reflection remains unavailable on callback-only listeners and follows the existing unauthenticated primary-listener policy.

Expose all intentionally discoverable public services while excluding any service that is not actually routed by that listener. Document the security and deployment behavior.

Acceptance Criteria

  • Standard gRPC reflection v1 is served on the primary listener.
  • Reflection returns descriptors for every intentionally discoverable service routed by that listener.
  • Callback-only listeners reject reflection using their existing protocol-appropriate response.
  • Reflection does not require OIDC or mTLS user authentication on the primary listener, matching the documented policy.
  • An integration test uses a reflection client against a running gateway and enumerates expected services.
  • Documentation includes a minimal grpcurl discovery example and explains listener/auth behavior.
  • Standard health service work remains independently tracked in #2569.

Alternatives Considered

Remove reflection from the unauthenticated routing allowlist and distribute descriptor files only. This avoids serving reflection but provides a poorer diagnostics workflow and requires artifact/version coordination. Implement a custom schema endpoint. Standard reflection already has broad tooling support and avoids another OpenShell-specific contract.

Agent Investigation

The auth bypass includes /grpc.reflection., listener tests expect reflection on the primary listener and reject it on callback-only listeners, and openshell_core::FILE_DESCRIPTOR_SET contains the compiled descriptors. No reflection service dependency or registration is present.

Related: #2565, #2569. Source audit: https://gist.github.com/mrunalp/e80942c1544a0225ee588796a41ab30b.

Langage dominant
Rust
Étoiles
15.4k
Forks
1.7k
Merge moyen
1 j 19 h
PR mergées (30 j)
347

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de NVIDIA/OpenShell

Toutes les issues de NVIDIA/OpenShell

Issues similaires

Plus d'issues Rust

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.