Objective
Partial refactor, cleanup, and code improvement of the utility module to set a foundation for M3.
Origin Document
Follow-up work to part 2/3 #504. Address the items not refactored in #504 as noted on PR #550.
When work on #443 started, while also looking at #325, it became evident that the logic in the utility module is hard to follow and understand while also being filled with minor hard-to-find bugs.
Goals
- Unblock development: Create a foundation on which we design utility protocols and implement new features
- Reduce cognitive overhead: Improve code readability and navigation for both internal and external contributors
- Enable onboarding other engineers: Clarify both source code and tests through comment and source code improvements
Deliverable
Non-goals / Non-deliverables
- Updating the entire module in a single PR (PR would be too large)
- Adding new features to the utility module
- Increasing/improving the test coverage to the po
General issue deliverables
Testing Methodology
Creator: @jessicadaugherty
Co-owner: @Olshansk
Objective
Partial refactor, cleanup, and code improvement of the utility module to set a foundation for M3.
Origin Document
Follow-up work to part 2/3 #504. Address the items not refactored in #504 as noted on PR #550.
When work on #443 started, while also looking at #325, it became evident that the logic in the utility module is hard to follow and understand while also being filled with minor hard-to-find bugs.
Goals
Deliverable
utility
Non-goals / Non-deliverables
General issue deliverables
Testing Methodology
make test_allLocalNetis still functioning correctly by following the instructions at docs/development/README.mdCreator: @jessicadaugherty
Co-owner: @Olshansk