oxidecomputer / oxidecomputer/maghemite

Type consolidation: remove/consolidate redundant types similar to bgp::session::SessionInfo

Open
#564 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bgp mgd want
Dominant language
Rust
Stars
94
Forks
6
Avg merge
1d 8h
Merged PRs (30d)
12

Description

There look to be at least 5 unique types that all have similar contents/uses, which is to represent a BGP neighbor and/or its configuration:

  • rdb::types::BgpNeighborInfo
  • bgp::session::SessionInfo
  • bgp::params::BgpPeerConfig
  • bgp::config::PeerConfig
  • bgp::params::Neighbor

These should be cleaned up to the extent that is reasonable.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing usages of rdb::types::BgpNeighborInfo, bgp::session::SessionInfo, bgp::params::BgpPeerConfig, bgp::config::PeerConfig, and bgp::params::Neighbor. Compare their contents and responsibilities before defining a reasonable consolidation boundary. Done means redundant BGP neighbor or configuration types have been removed or consolidated and their usages are updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
networking
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.