-
Notifications
You must be signed in to change notification settings - Fork 33
[P2P] Add contexts to method signatures #595
Copy link
Copy link
Open
Labels
code healthNice to have code improvementNice to have code improvementp2pP2P specific changesP2P specific changes
Milestone
Description
Objective
Add context.Context arguments to all method signatures requiring downstream context and push context creation up the call stack as high as possible to align with Go conventions and best practices, and support future distributed tracing efforts.
Origin Document
... (lost)
Goals
- Align
context.Contextusage with go conventions / best practices - Support future distributed tracing efforts ([Telemetry] Distributed Tracing in a V1 Node #143)
- We will likely need fairly ubiquitous access to context objects everywhere we want to measure
Deliverable
- Add
context.Contextarguments to all method signatures which require a context downstream (at least). - Push context creation up the call stack as high as possible / reasonable (i.e.
context.Background()).
Non-goals / Non-deliverables
- Refactoring, simplifying or otherwise changing method signatures outside the scope of passing
context.Contexts.
General issue deliverables
- Update the appropriate CHANGELOG(s)
- Update any relevant local/global README(s)
- Update relevant source code tree explanations
- Add or update any relevant or supporting mermaid diagrams
Testing Methodology
- Task specific tests or benchmarks:
make ... - New tests or benchmarks:
make ... - All tests:
make test_all - LocalNet: verify a
LocalNetis still functioning correctly by following the instructions at docs/development/README.md
Creator: @bryanchriswhite
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
code healthNice to have code improvementNice to have code improvementp2pP2P specific changesP2P specific changes
Type
Projects
Status
Rescope