-
Notifications
You must be signed in to change notification settings - Fork 2.2k
fix(instigation logger): stringify non-json objects #32867
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -2,7 +2,10 @@ | |||||||||||||||||
| from unittest import mock | ||||||||||||||||||
|
|
||||||||||||||||||
| import dagster as dg | ||||||||||||||||||
| from dagster._core.definitions.instigation_logger import InstigationLogger | ||||||||||||||||||
| from dagster._core.definitions.instigation_logger import ( | ||||||||||||||||||
| InstigationLogger, | ||||||||||||||||||
| get_instigation_log_records, | ||||||||||||||||||
| ) | ||||||||||||||||||
| from dagster._core.storage.noop_compute_log_manager import NoOpComputeLogManager | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
@@ -74,3 +77,43 @@ def test_instigation_logger_log_failure(capsys): | |||||||||||||||||
| captured.err.count("Exception closing logger write stream: Exception: OOPS ON EXIT") | ||||||||||||||||||
| == 1 | ||||||||||||||||||
| ) | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
| def test_instigation_logger_logs_weird_record_ok(capsys): | ||||||||||||||||||
| class NonJsonSerializable: | ||||||||||||||||||
| """A class that json.dumps doesn't know what to do with (by default).""" | ||||||||||||||||||
|
|
||||||||||||||||||
| def __str__(self): | ||||||||||||||||||
| return "non-jsonable-object" | ||||||||||||||||||
|
|
||||||||||||||||||
| log_key = ["test-repo", "test-instigator", "123"] | ||||||||||||||||||
|
|
||||||||||||||||||
| with dg.instance_for_test() as instance: | ||||||||||||||||||
| with InstigationLogger( | ||||||||||||||||||
| log_key=log_key, | ||||||||||||||||||
| instance=instance, | ||||||||||||||||||
| repository_name="test-repo", | ||||||||||||||||||
| instigator_name="test-instigator", | ||||||||||||||||||
| ) as logger: | ||||||||||||||||||
| logger.info("log without extras") | ||||||||||||||||||
| logger.info("log with extras", extra={"non_json": NonJsonSerializable()}) | ||||||||||||||||||
|
|
||||||||||||||||||
| assert logger.has_captured_logs() | ||||||||||||||||||
|
|
||||||||||||||||||
| captured = capsys.readouterr() | ||||||||||||||||||
|
|
||||||||||||||||||
| assert "Exception initializing logger write stream" not in captured.err | ||||||||||||||||||
| assert "Exception writing to logger event stream" not in captured.err | ||||||||||||||||||
| assert "Exception closing logger write stream" not in captured.err | ||||||||||||||||||
| assert "NonJsonSerializable is not JSON serializable" not in captured.err | ||||||||||||||||||
|
|
||||||||||||||||||
| records = get_instigation_log_records(instance, log_key) | ||||||||||||||||||
|
|
||||||||||||||||||
| assert len(records) >= 2 | ||||||||||||||||||
| assert "test-repo - test-instigator - log with extras" in { | ||||||||||||||||||
| record.get("msg") for record in records if record.get("msg") | ||||||||||||||||||
| } | ||||||||||||||||||
|
Comment on lines
+112
to
+115
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
| matching_records = [record for record in records if record.get("non_json")] | ||||||||||||||||||
| assert matching_records and matching_records[0]["non_json"] == "non-jsonable-object" | ||||||||||||||||||
|
|
||||||||||||||||||
| instance.compute_log_manager.delete_logs(log_key=log_key) | ||||||||||||||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
strict=Falseis redundant on this read path.json.dumpsalways escapes control characters in strings (e.g., a newline in a str value becomesin the JSON output), so the data written byCapturedLogHandler.emitis already strictly conformant JSON and will parse withoutstrict=False. The parameter adds no protection here and makes the code misleadingly imply that the stored JSON might contain raw control characters.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!