Refactor revalidators v2 #322
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rvagg
reviewed
May 4, 2022
rvagg
reviewed
May 4, 2022
rvagg
approved these changes
May 4, 2022
hannahhoward
force-pushed
the
refactor-revalidators-v2
branch
from
8d028dc
to
8b01cdb
Compare
Codecov Report
@@ Coverage Diff @@
## v2 #322 +/- ##
==========================================
- Coverage 65.26% 64.88% -0.39%
==========================================
Files 30 30
Lines 3501 3528 +27
==========================================
+ Hits 2285 2289 +4
- Misses 850 868 +18
- Partials 366 371 +5
|
hannahhoward
force-pushed
the
refactor-revalidators
branch
from
86b6976
to
1601129
Compare
move to all revalidation being asynchronous
causes datalimit exceeded and requires finalization to leave request paused, regardless of where LeaveRequestPaused is set
reorder validation events so all get record when transfer finishes
Co-authored-by: Rod Vagg <rod@vagg.org>
hannahhoward
force-pushed
the
refactor-revalidators-v2
branch
from
6f23c82
to
4cffb16
Compare
hannahhoward
added a commit
that referenced
this pull request
Oct 7, 2022
* refactor(validators): remove revalidation move to all revalidation being asynchronous * feat(validators): implied pauses causes datalimit exceeded and requires finalization to leave request paused, regardless of where LeaveRequestPaused is set * refactor(events): reorder events reorder validation events so all get record when transfer finishes * Update impl/impl.go Co-authored-by: Rod Vagg <rod@vagg.org> Co-authored-by: Rod Vagg <rod@vagg.org>
hannahhoward
added a commit
that referenced
this pull request
Oct 8, 2022
* chore(v2): setup the v2 release given the expected breaking changes, it's time to setup the v2 release BREAKING CHANGE: v2 modules * Refactor revalidators (#308) * feat(revalidators): initial refactor refactor revalidation process -- removing independent revalidations, making validations results more clear * refactor(rename): RevalidateToComplete -> RequiresFinalization * refactor(datatransfer): enhance validator comments * refactor(message): revert message response changes * refactor(impl): comment and refactor on events add comments to event processing and also extract functions for receiving requests to a new file * refactor(message): s/IsVoucherResult/IsValidationResult rename the IsVoucherResult to is 'IsValidationResult' also add a method for generating messages from validation results * feat(events): only dispatch events on change Only dispatch Pause, Resume, SetDataLimit, and RequiresFinalization on change * style(imports): fix imports * feat(events): add DataLimitExceeded event * Update channels/channel_state.go Co-authored-by: dirkmc <dirkmdev@gmail.com> * Update manager.go Co-authored-by: dirkmc <dirkmdev@gmail.com> * Update manager.go Co-authored-by: dirkmc <dirkmdev@gmail.com> * Update statuses.go Co-authored-by: Rod Vagg <rod@vagg.org> Co-authored-by: dirkmc <dirkmdev@gmail.com> Co-authored-by: Rod Vagg <rod@vagg.org> * Refactor revalidators v2 (#322) * refactor(validators): remove revalidation move to all revalidation being asynchronous * feat(validators): implied pauses causes datalimit exceeded and requires finalization to leave request paused, regardless of where LeaveRequestPaused is set * refactor(events): reorder events reorder validation events so all get record when transfer finishes * Update impl/impl.go Co-authored-by: Rod Vagg <rod@vagg.org> Co-authored-by: Rod Vagg <rod@vagg.org> * chore(message): delete old message format code (#330) * feat(ipld): vouchers as plain ipld.Node (#325) * feat(ipld): vouchers as plain ipld.Node * feat: add ValidationResult#Equals() utility * feat(ipld): introduce TypedVoucher tuple type * chore(ipld): ipld.Node -> datamodel.Node * chore: remove RegisterVoucherResultType * fix: minor staticcheck fixes * refactor(channelstate): use cborgencompatiblenode (#336) use cborgencomptaiblenode to simply channelstate interface * feat(ipld): use bindnode/registry (#340) * chore(deps): update libp2p v0.19.4 (#341) * feat(ipld): use bindnode/registry Co-authored-by: Hannah Howard <hannah@hannahhoward.net> * refactor(v2): port graphsync w/o transport refactor Ports state machine and graphsync changes without the big transport refactor * fix(pr): respond to pr comments * chore(deps): upgrade libp2p v0.22 also upgrades graphsync and removes go-libp2p-core paths * fix(deps): use tagged go-ipld-prime Co-authored-by: dirkmc <dirkmdev@gmail.com> Co-authored-by: Rod Vagg <rod@vagg.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals
This PR was written during the course of implementing the voucher refactor in go-fil-markets.
Implementation
The main goal in refactoring the go-fil-markets retrieval provider was to drive towards clear, easy to reason about logic with very clear event structure and idempotent code that restarts easily.
What became clear is that fundamentally, voucher revalidation needs to happen asynchronously. So now, the consuming library simply monitors data transfer events and updates validation status as new vouchers come in. We changed Revalidate to ValidateRestart -- so that it only covers restarts, while removing synchronous revalidation entirely. Now, we simply save new vouchers, and we've added an UpdateValidationStatus method to change validation parameters when the markets software processes all vouchers.
Moreover, the idea of Pausing in validation needs to be separated from DataLimits and Finalization. The way to unpause a request held on a data limit is to increase the data limit. The way to end finalization is to set RequiresFinalization to false. The pause property is renamed from LeaveRequestPaused to ForcePause, clearly identifying that the markets library is explicitly applying it's own logic around pausing -- in this case, pausing to Unseal.
Finally I did a minor reorderng of validation events to promote more predictable behavior near the end of a transfer (not accidentally completing the channel before events get processed)