fix(core): Emit structured warning for skipped zero-baseline metrics - #26
Open
khatayondev wants to merge 1 commit into
Open
fix(core): Emit structured warning for skipped zero-baseline metrics#26khatayondev wants to merge 1 commit into
khatayondev wants to merge 1 commit into
Conversation
This file contains hidden or 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
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.
Description
This PR resolves Issue #13 where metrics with a
0.0baseline were being silently skipped during comparison, resulting in them being completely missing from the final JSON report and console summary.What was changed?
SkippedMetricdata class model to explicitly track skipped metrics.ComparisonResultto include askippedlist.compare_snapshotslogic inflameiq/core/comparator.pyto catchComparisonErrorexceptions (thrown bycompute_change_percent) and append the skipped metric to theskippedlist with a detailed reason, rather than just ignoring it.to_dict()so the skipped metrics are included in the serialized JSON output.All 2 metric(s) within threshold. (1 skipped)).Testing
test_zero_baseline_skipped_metricstotests/unit/test_core/test_comparator.py.make test.Closes #13