cloudflare/boringtun

Keeping timers relative to start of tunnel initiation is confusing

Open

#309 opened on Aug 24, 2022

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)Rust (321 forks)batch import
code qualitygood first issue

Repository metrics

Stars
 (4,849 stars)
PR merge metrics
 (PR metrics pending)

Description

Keeping timers this way means that for example update_session_timers takes a time_now param that's a Duration instead of an Instant. All entries in Tunn::timers are Durations when many of them are "the time that something happened" and idiomatically I think these would be better expressed as Instants.

Contributor guide

Research direction
Understand the current timer implementation in boringtun, focusing on how `Duration` is used to represent absolute times. Investigate the `Tunn::timers` field and the `update session timers` function. Consider refactoring to use `Instant` for absolute timestamps, ensuring all comparisons and arithmetic are adjusted accordingly.
Tech stack
rust
Domain
backendnetworking
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65