envoyproxy/envoy

Create a machine-consumable lists for deprecated fields

Open

#9.842 aberto em 27 de jan. de 2020

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
area/configurationhelp wanted

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

Description

When minor API versions deprecate fields or mark them fatal-by-default, config needs to be updated (or overidden in the Runtime). Newly deprecated and newly fatal fields can be difficult to reliably detect.

As suggested by @htuch, could we add a protoc plugin to produce machine-consumable lists for deprecated and fatal fields to make things easier?

Guia do colaborador

Direção de pesquisa
Primeiro, entenda a interface do plugin protoc revisando a documentação do protobuf e os exemplos existentes no repositório do Envoy (por exemplo, tools/protoplasm ou similar). Investigue como os arquivos protobuf do Envoy são estruturados para identificar campos obsoletos. O plugin deve gerar listas legíveis por máquina (por exemplo, JSON) de campos marcados como obsoletos ou fatais por padrão. Considere começar com um modelo simples de plugin protoc e iterar com base no feedback dos mantenedores.
Pilha de tecnologia
cpp
Domain
backendapitooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C++Protocol Buffers
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45