Validate reserved metadata value types #26746
Open
+100
−8
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
clairelin135
force-pushed
the
12-27-claire/validate-reserved-metadata-types
branch
3 times, most recently
from
854f327 to
4755709
Compare
clairelin135
force-pushed
the
12-27-claire/validate-reserved-metadata-types
branch
from
4755709 to
7ed489e
Compare
clairelin135
force-pushed
the
12-27-claire/validate-reserved-metadata-types
branch
from
7ed489e to
ebb59a7
Compare
gibsondan
reviewed
Dec 27, 2024
|
IMO it's an invalid state and from backend search we know that it affects very few users. When users are emitting invalid metadata types like this they also can't see table schema metadata in the UI etc. so we should block this behavior. |
gibsondan
approved these changes
Dec 30, 2024
Comment on lines
+135
to
+156
| def test_error_on_invalid_reserved_metadata_value(): | ||
| with pytest.raises( | ||
| CheckError, match="Value for metadata key 'dagster/column_schema' must be a TableSchema" | ||
| ): | ||
|
|
||
| @asset( | ||
| metadata={ | ||
| "dagster/column_schema": "invalid", | ||
| } | ||
| ) | ||
| def foo(): | ||
| pass | ||
|
|
||
| @asset() | ||
| def bar(): | ||
| yield MaterializeResult(metadata={"dagster/column_schema": "invalid"}) | ||
|
|
||
| defs = Definitions(assets=[bar]) | ||
| with pytest.raises( | ||
| CheckError, match="Value for metadata key 'dagster/column_schema' must be a TableSchema" | ||
| ): | ||
| defs.get_implicit_global_asset_job_def().execute_in_process() |
There was a problem hiding this comment.
should we include tests that cover the other values we added validation for?
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.
Summary & Motivation
Validate dagster-reserved metadata value types upon construction. Our code assumes that reserved metadata values have the correct type (i.e.
dagster/column_schemais aTableSchemaobject), let's enforce that.How I Tested These Changes
BK
Changelog
Adds type validation for reserved metadata keys defined in asset definitions and
MaterializeResult.