Error inspection #4660

samcowger · 2023-08-26T00:54:17Z

Description

This PR contains results of Galois's inspection of the use of error in ouroboros-network packages. It consists of an enumeration of error uses and my notes on each. I was able to document, modify, or remove some errors immediately; others would benefit from more information or clarification from someone more familiar with this codebase.

Viewers/reviewers may examine the diff first and my notes (currently at 3836/3836.md) second, or vice versa. Everything in the diff should have a corresponding entry in the notes, but not every entry in the notes has a corresponding diff.

This is marked as a draft because there are a couple of changes that may warrant additional unit tests, and because I recognize my notes will need to be relocated or removed before merging, but I wanted to get eyes on this work sooner rather than later. I'll be going through this to annotate (in Github) items that I feel especially warrant another set of eyes.

Fixes #3836.

cc @coot @mtullsen

Checklist

Branch
- Updated changelog files.
- Commit sequence broadly makes sense
- Commits have useful messages
- The documentation has been properly updated
- New tests are added if needed and existing tests are updated
- [N/A] If serialization changes, user-facing consequences (e.g. replay from genesis) are confirmed to be intentional.
Pull Request
- Self-reviewed the diff
- Useful pull request description at least containing the following information:
  - What does this PR change?
  - Why these changes were needed?
  - How does this affect downstream repositories and/or end-users?
  - Which ticket does this PR close (if any)? If it does, is it linked?
- Reviewer requested

ouroboros-network/src/Ouroboros/Network/PeerSelection/Governor/Types.hs

ouroboros-network/src/Ouroboros/Network/Diffusion/P2P.hs

ouroboros-network/src/Ouroboros/Network/TxSubmission/Outbound.hs

network-mux/src/Network/Mux/Types.hs

ouroboros-network-mock/src/Ouroboros/Network/Mock/ConcreteBlock.hs

ouroboros-network-mock/src/Ouroboros/Network/Mock/Chain.hs

ouroboros-network-api/src/Ouroboros/Network/AnchoredFragment.hs

ouroboros-network-api/src/Ouroboros/Network/AnchoredSeq.hs

ouroboros-network-framework/src/Ouroboros/Network/Protocol/Handshake/Version.hs

ouroboros-network-testing/src/Ouroboros/Network/Testing/Data/Script.hs

ouroboros-network/src/Ouroboros/Network/BlockFetch/ClientRegistry.hs

3836/3836.md

network-mux/src/Network/Mux/Types.hs

network-mux/src/Network/Mux/Ingress.hs

ouroboros-network-api/src/Ouroboros/Network/AnchoredFragment.hs

ouroboros-network-framework/src/Ouroboros/Network/Protocol/Handshake/Version.hs

ouroboros-network-mock/src/Ouroboros/Network/Mock/Chain.hs

ouroboros-network-testing/src/Ouroboros/Network/Testing/Data/Script.hs

ouroboros-network/src/Ouroboros/Network/BlockFetch/ClientRegistry.hs

ouroboros-network/src/Ouroboros/Network/KeepAlive.hs

ouroboros-network/src/Ouroboros/Network/PeerSelection/Governor.hs

coot

LGTM, thank you for a thorough review :).

ouroboros-network-api/src/Ouroboros/Network/AnchoredFragment.hs

ouroboros-network-api/src/Ouroboros/Network/AnchoredSeq.hs

See IntersectMBO#4660 Co-authored-by: Marcin Szamotulski <coot@coot.me>

Made redundant by cb018d9, in IntersectMBO#4660.

…ure compile-time" This reverts commit be97f46.

…`guardedDecisions`" This reverts commit 2614b70.

…tern" This reverts commit 3930912.

…c resolution Before, we would find the domain that corresponded to an async action only after the action completed/errored, by looking it up in the original list of actions. Now, we carry the domain through the process of awaiting the async's completion/erroring.

…ure mode" This reverts commit 18f498b.

This reverts commit c61f9b4.

…esult constructor" This reverts commit 2425803.

See IntersectMBO#4677 and IntersectMBO#4678.

Co-authored-by: Marcin Szamotulski <coot@coot.me>

See IntersectMBO#4660 Co-authored-by: Marcin Szamotulski <coot@coot.me>

The document this deletes has been migrated to issue IntersectMBO#3836.

Made redundant by cb018d9, in IntersectMBO#4660.

coot · 2023-10-27T10:29:07Z

@samcowger I rebased your PR.