envoyproxy/envoy

Clean up proliferation of std::chrono duration types

Open

#12,384 opened on Jul 30, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
help wantedtech debt

Repository metrics

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

Description

https://github.com/envoyproxy/envoy/pull/12225 ensured that arbitrary std::chrono::{clock_type}::duration constructors cannot be used as it introduces differences in time representation/units between different platforms. @lizan suggested also ensuring that TimeSystem (used in test infrastructure) should provide a concrete duration type to reduce the proliferation of std::chrono duration types. Concrete duration aliases were added in that class but all usages of std::chrono duration types are not yet converted to TimeSystem::Nanosecond etc.

This issue is a placeholder to denote that std::chrono duration types should be replaced with TimeSystem aliases and introduce a format check to prevent their re-addition in the future.

Contributor guide

Research direction
Find all usages of std::chrono duration types (e.g., std::chrono::nanoseconds) in the Envoy codebase and replace them with TimeSystem aliases (e.g., TimeSystem::Nanosecond). Use grep or a static analysis tool to locate the occurrences. Also, introduce a format check (e.g., in the CI pipeline) to prevent future re addition of raw std::chrono duration types.
Tech stack
cpp
Domain
backendinfrastructure
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70