viperproject / viperproject/VerifiedSCION
`router/dataplane.go`: information hiding and refactoring
Open
Nobody has claimed this yet.
- #122 by @jcp19 — closed without merging
maintainability
performance
router
- Dominant language
- Go
- Stars
- 12
- Forks
- 5
- Avg merge
- 13h 2m
- Merged PRs (30d)
- 4
Description
Improvements:
- drop
isComparablefrom initialization spec - drop
keyfield and have a predicate WithKey(key) instead (or a second predicate altogether that reveals the state of the router, while still requiring the dataplaneMutexInvariant to modify the dataplane)- instead, implement it as a ghost field
- drop all wildcards wherever possible (specially in predicates and method spec)
- use const perm instead of hardcoded permissions everywhere
- Bring changes from PR #122
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in router/dataplane.go and inspect the remaining unchecked items around predicates and method specifications. Review PR #122 for changes that still need to be brought in, then verify that wildcards are removed where possible and the dataplane invariants remain enforced.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- networking
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100