envoyproxy/envoy

filters: improve docs & protections around callbacks

Open

#13.737 aperta il 23 ott 2020

Vedi su GitHub
 (11 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/httphelp wantedtech debt

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

We recently ran into an internal problem where an in-house filter was returning a local reply and immediately after returning FilterHeaderStatus::Continue, which ends up confusing the Router filter machinery.

A few things can be done to improve the experience for filter developers:

  1. improve docs around the contract with filters (e.g.: #13678, I'll send another one for docs/root/faq/extensions/contract.rst as well)

  2. enforce more checks to ensure callbacks cannot be called after a local reply has been sent

  3. more assertions around the filter chain state machine

cc: @alyssawilk @mattklein123

Guida contributor

Direzione di ricerca
Studia la documentazione esistente sulle callback dei filtri e il contratto nel codice sorgente di Envoy. Identifica dove le risposte locali e le callback si intersecano e proponi miglioramenti alla documentazione e controlli nel codice.
Tech stack
cpp
Dominio
backend
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
C++Envoy filter development
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65