refactor(all): improve SummaryKeys management #1491
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
Lots of errors and bugfixes still needed but let's publish the branch first and then continue hammering it. See ooni/probe#2667
bassosimone
commented
Feb 6, 2024
| // SummaryKeys contains summary keys for this experiment. | ||
| // | ||
| // Note that this structure is part of the ABI contract with ooniprobe | ||
| // therefore we should be careful when changing it. |
There was a problem hiding this comment.
We can safely remove this comment because we have moved the implicit requirement that every structure that implements summary MUST contain a field called IsAnomaly with boolean type.
bassosimone
commented
Feb 6, 2024
| // GetSummaryKeys implements model.ExperimentMeasurer.GetSummaryKeys. | ||
| func (m *Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error) { | ||
| return SummaryKeys{IsAnomaly: false}, nil | ||
| } |
There was a problem hiding this comment.
Now we implicitly provide the correct always-returning-false implementation when an experiment does not implement the MeasurementSummaryKeysProvider interface. So, we can safely zap the boilerplate code concerning the summary keys for each experiment that always returned false.
bassosimone
commented
Feb 6, 2024
bassosimone
changed the title
Murphy-OrangeMud
pushed a commit
to Murphy-OrangeMud/probe-cli
that referenced
this pull request
Feb 13, 2024
While approaching ooni/probe#2667, I recognized that the approach we're using to generate `SummaryKeys` is redundant, verbose, and fragile. This diff attempts to improve our implementation. We define new types for generating summary keys and `engine.MeasurementSummaryKeys` to either return the proper summary keys, if the experiment `TestKeys` support that or return a default value. While there, disable the flaky `throttlingWithHTTP` QA check (see ooni/probe#2668).
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.
While approaching ooni/probe#2667, I recognized that the approach we're using to generate
SummaryKeysis redundant, verbose, and fragile. This diff attempts to improve our implementation.We define new types for generating summary keys and
engine.MeasurementSummaryKeysto either return the proper summary keys, if the experimentTestKeyssupport that or return a default value.While there, disable the flaky
throttlingWithHTTPQA check (see ooni/probe#2668).