Disambiguate whether a revalidator recognized a request when checking for a need to revalidate #87
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
aarshkshah1992
approved these changes
Sep 29, 2020
manager.go
Outdated
| // for a given pull request. It should return a VoucherResult + ErrPause to | ||
| // for a given pull request. The first value indicates whether the request was | ||
| // recognized by this revalidator and should be considered 'handled'. If true, | ||
| // the remaining to values are interpreted. If 'false' the request is passed on |
There was a problem hiding this comment.
This typo needs to be fixed below as well.
| return err | ||
| handled, result, err = revalidator.OnPushDataReceived(chid, size) | ||
| if handled { | ||
| return errors.New("stop processing") |
There was a problem hiding this comment.
Why do we need to return this error ? So that we break the m.revalidators.Each loop ?
Is there any other significance of this error ?
There was a problem hiding this comment.
yea that's what it does -- it stops the loop -- note that it's ignored in the return
Previously, the revalidators were very ambiguous in identifying if they had actually handled a request for a revalidation check or not -- a "nil, nil" or "voucher result, nil" was interpreted as not being handled. This is unfortunate, cause particularly a "voucher result, nil" is an indication the request is handled by this check, and we should stop processing other revalidators that might override the value with "nil, nil". We now add a boolean to disambiguate whether the revalidator "recognized" this request --- if true, processing stops.
hannahhoward
force-pushed
the
feat/add-bool-to-revalidator-interfaces
branch
from
f7d85bd
to
a400317
Compare
hannahhoward
added a commit
that referenced
this pull request
Sep 29, 2020
* Disambiguate whether a revalidator recognized a request when checking for a need to revalidate (#87) * feat(revalidator): add handled bool Previously, the revalidators were very ambiguous in identifying if they had actually handled a request for a revalidation check or not -- a "nil, nil" or "voucher result, nil" was interpreted as not being handled. This is unfortunate, cause particularly a "voucher result, nil" is an indication the request is handled by this check, and we should stop processing other revalidators that might override the value with "nil, nil". We now add a boolean to disambiguate whether the revalidator "recognized" this request --- if true, processing stops. * style(comments): fix types * feat(impl): cleanup errors cleanup errors -- move more error codes to proper types and insure single error dispatched * test(impl): add unit test for incomplete response
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
Previously, the revalidators were very ambiguous in identifying if they had actually handled a
request for a revalidation check or not -- a "nil, nil" or "voucher result, nil" was interpreted as
not being handled. This is unfortunate, cause particularly a "voucher result, nil" is an indication
the request is handled by this check, and we should stop processing other revalidators that might
override the value with "nil, nil". While we could technically stop on a "voucher result, nil" -- it seems best to just make explicit whether we did or did not handle the request.
Implementation
Add a boolean to disambiguate whether the revalidator "recognized" a request for
OnPushDateReceived,OnPullDataSent, andOnComplete