envoyproxy/envoy

network: address interface should pair port:proto

Open

#17,429 opened on Jul 20, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/listenerhelp wantedtech debt

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

As per the discussion here: https://github.com/envoyproxy/envoy/pull/17414

In a perfect world our Address interface should include proto with port, as the operating system treats TCP:1234 differently from UDP:1234. Unfortunately, this will have very large implications on the overall code structure. There are a few things we might consider here:

  1. Remove port from the primary Address interface, as certain use cases do not actually care about port and proto. For example DNS, IP tagging, etc.
  2. Introduce a AddressAndPort interface which includes an address as well as a port/proto pair. Then, any port must have an associated proto with it as well.

Either way this needs some thinking and prototyping.

Contributor guide

Research direction
Study the current Address interface in the codebase. Review the linked PR discussion (#17414) for context. Identify all usages of the Address interface and assess impact of adding port:proto. Prototype one of the proposed approaches, starting with a minimal change to understand implications.
Tech stack
cpp
Domain
infrastructure
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++GitComputer networks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25