feat(aci): schema validation for DataCondition.comparison #83457
+82
−34
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
github-actions
bot
added
the
Scope: Backend
cathteng
commented
Jan 14, 2025
src/sentry/workflow_engine/types.py
Outdated
| @@ -55,6 +55,11 @@ def bulk_get_query_object(data_sources) -> dict[int, T | None]: | |||
|
|
|||
|
|
|||
| class DataConditionHandler(Generic[T]): | |||
| @staticmethod | |||
| def comparison_json_schema() -> dict[str, Any]: | |||
There was a problem hiding this comment.
not sure how to have an abstract static property 🤔
There was a problem hiding this comment.
🤔 does it need to be static? could we do something like this: https://github.com/getsentry/sentry/pull/83276/files#diff-3f0b18159f9863fd3bbfdce5d8d8374a8a7473fc4808031dd520f4a83e75dd66R65-R67 ?
There was a problem hiding this comment.
i think i assumed we don't want to initialize the handler, but we can! added abstract property
❌ 3 Tests Failed:
View the top 2 failed tests by shortest run time
View the full list of 1 ❄️ flaky tests
To view more test analytics, go to the Test Analytics Dashboard |
cathteng
commented
Jan 15, 2025
Comment on lines
128
to
151
| @receiver(pre_save, sender=DataCondition) | ||
| def enforce_comparison_schema(sender, instance: DataCondition, **kwargs): | ||
| from jsonschema import ValidationError, validate | ||
|
|
||
| condition_type = Condition(instance.type) | ||
| if condition_type in condition_ops: | ||
| # don't enforce schema for default ops, this can be any type | ||
| return | ||
|
|
||
| try: | ||
| handler = condition_handler_registry.get(instance.type) | ||
| except NoRegistrationExistsError: | ||
| logger.exception( | ||
| "No registration exists for condition", | ||
| extra={"type": instance.type, "id": instance.id}, | ||
| ) | ||
| return None | ||
|
|
||
| schema = handler.comparison_json_schema | ||
|
|
||
| try: | ||
| validate(instance.comparison, schema) | ||
| except ValidationError as e: | ||
| raise ValidationError(f"Invalid config: {e.message}") |
ceorourke
reviewed
Jan 15, 2025
| "time": "hour", | ||
| } | ||
| assert dc.condition_result is True | ||
| assert dc.condition_group == dcg | ||
|
|
||
| def test_json_schema(self): | ||
| with pytest.raises(ValidationError): | ||
| self.dc.comparison.update({"time": "asdf"}) |
There was a problem hiding this comment.
the validation error is raised on save, right? maybe you can put the update outside of the pytest raise here to make that more clear
ceorourke
reviewed
Jan 15, 2025
ceorourke
reviewed
Jan 15, 2025
| from jsonschema import ValidationError, validate | ||
|
|
||
| condition_type = Condition(instance.type) | ||
| if condition_type in condition_ops: |
There was a problem hiding this comment.
nit but it would be nice for condition ops to be capitalized
ceorourke
reviewed
Jan 15, 2025
ceorourke
reviewed
Jan 15, 2025
ceorourke
approved these changes
Jan 15, 2025
saponifi3d
approved these changes
Jan 15, 2025
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.
Add schema validation for
DataCondition'scomparisonJSONField. We need this to be absolutely sure the comparison field contains the correct information to be able to evaluate the condition in processors.This PR adds the schema validation for the
AgeComparisoncondition as an example.