DM-30869: Modernize MetricTask for better Gen 3 workflow #105
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
This case was never supported by Gen 3 Middleware (i.e., it never came up in pipeline execution) and made concrete task implementations more complicated than they otherwise needed to be.
Now that MetricTask no longer requires that MetadataMetricTask supports `None` datasets, the corresponding code can be removed from MetadataMetricTask. Note that the task still guards against missing keys, as the content of a metadata object is something that Middleware cannot guarantee.
Now that MetricTask no longer requires that ApdbMetricTask supports `None` datasets, the corresponding code can be removed from ApdbMetricTask. Note that the task still guards against missing information inside the config, as the content of a dataset is something that Middleware cannot guarantee.
When a metric does not apply, MetricTask can now *either* raise NoWorkFound or return None. This is standard behavior for PipelineTasks, though the documentation emphasizes in which circumstances this is appropriate as opposed to MetricComputationError.
This change allows for slightly simpler code and more idiomatic error handling. MetadataMetricTask acknowledges NoWorkFound but does not require it.
This change simplifies the code and makes error handling more idiomatic.
Exceptions are now better handled by the Middleware framework, so it's counterproductive for MetricTasks to do it themselves. MetricTasks must still handle None output themselves, though.
Exceptions are now better handled by the Middleware framework, though MetricTasks to support None output themselves. However, the simplified runQuantum still reduces maintenance for subclasses that override runQuantum themselves.
TallJimbo
approved these changes
Sep 20, 2022
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.
This PR removes some unused features from
MetricTask, namely the requirements that subclasses acceptNoneinput and built-in handling ofMetricComputationError. These changes significantly simplify subclass code and bringMetricTaskcloser in line with currentPipelineTaskconventions.