Release PR for 2025-12-07 14:07#27
Merged
Merged
Conversation
- Refined the GitHub Actions workflow for synchronizing the main branch with the release branch. Updated fetch commands to ensure the latest state is retrieved and enhanced checks for fast-forwarding or rebasing. This ensures a more robust and accurate update process for the main branch after releases. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
…ation errors - Modified the error handling in SchemaLogger and schema validation functions to log validation errors in a structured JSON format. This change enhances machine readability and consistency in error reporting. - Updated the README to reflect the new error message format, replacing the previous string format with a JSON structure that includes field, error, and value information. - Adjusted tests to verify the new JSON error message format is correctly logged and processed. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
… and serialization - Added defensive error handling in the SchemaLogger to manage potential JSON parsing and serialization issues when logging validation errors. This ensures that even if unexpected data corruption occurs, the logger can still produce a meaningful error message. - Implemented fallback mechanisms to create structured error objects when parsing or serialization fails, improving the robustness of the logging system. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
## [0.1.3-rc.1](v0.1.2...v0.1.3-rc.1) (2025-12-07) ### Bug Fixes * **logging:** enhance error handling in SchemaLogger for JSON parsing and serialization ([0417dc9](0417dc9)) Signed-off-by: Release Bot <noreply@github.com>
- Expanded the README to include information on the library's caching mechanisms, detailing the path cache and compiled schema cache. This addition clarifies how the library handles schema file changes and caching behavior, ensuring users understand the implications of schema file modifications on caching. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
- Updated the README to provide comprehensive information on schema validation processes, including the creation of `SchemaLogger` instances, error handling for schema problems, and the implications of schema structure on logging behavior. - Added sections on schema root key restrictions and clarified the handling of validation errors, ensuring users understand how the library manages schema-related issues and the conditions under which fields are included in log records. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
- Expanded the `SchemaProblem` and `DataProblem` classes to provide detailed descriptions of validation errors, including examples for better clarity. - Improved the `_create_validation_error_json` function to ensure consistent JSON serialization of error messages, enhancing security and readability. - Updated the `SchemaLogger` to log validation errors in a structured JSON format, allowing for easier parsing and analysis by consumers of the log data. - Added performance considerations and limitations in the schema compilation and validation processes to improve documentation and user understanding. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
…nations - Revised the README to clarify the role of the JSON schema in validating `extra` fields for logging, emphasizing its importance as a contract between log producers and consumers. - Enhanced sections on strictness guarantees, schema structure, and error handling to provide clearer guidance on how the library manages logging behavior and validation errors. - Updated examples to illustrate the expected behavior when logging with valid and invalid data, ensuring users understand the implications of schema compliance. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
- Added a note regarding the caching of the schema, specifying that it is compiled once per process and requires an application restart for changes to take effect. - Emphasized the thread safety of the library, ensuring users understand the implications of concurrent access to the schema. Signed-off-by: Dmitrii Safronov <zimniy@cyberbrain.cc>
Owner
Author
|
🎉 This PR is included in version 0.1.3 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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
2 participants
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.
Changelog (#27)
🐛 Bug Fixes
📚 Documentation
♻️ Refactoring
🧹 Chores