Skip to content

Conversation

@atheendre130505
Copy link

Fix json_utils.py object validation logic and mangled error messages
This PR addresses critical bugs in Apache Beam's YAML JSON utility that led to silent validation passes or internal crashes when handling object-type schemas.

Changes: Corrected Object Validation: Fixed logic in _validate_compatible where weak_schema == 'object' was always false (comparing dict to string). It now correctly checks weak_schema['type'] == 'object'.
Fixed Iteration Crash: Added .items() to dictionary iteration in _validate_compatible to prevent ValueError: not enough values to unpack. Restored F-Strings: Added missing f prefixes to multiple ValueError and TypeError calls, ensuring error messages like Expected object type, got {json_type} correctly interpolate variables.
Fixed Formatting Bug: Corrected a ValueError in _validate_compatible
where a boolean expression was passed to a format string expecting the type names.
Added Regression Tests: Updated json_utils_test.py with tests verifying that incompatible object schemas are caught and that error messages are properly formatted.

unit tests implemented.
fixes #37576

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @atheendre130505, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses several critical bugs within Apache Beam's json_utils.py module, specifically impacting the validation and error reporting for object-type schemas. The changes improve the robustness of schema validation, prevent runtime crashes during dictionary iteration, and ensure that error messages are correctly formatted and informative, thereby enhancing the reliability of the YAML JSON utility.

Highlights

  • Object Validation Logic: Corrected the _validate_compatible function to properly check for 'object' type in weak_schema['type'] instead of comparing weak_schema directly to the string 'object', resolving silent validation passes.
  • Dictionary Iteration Crash: Prevented ValueError: not enough values to unpack by adding .items() when iterating over dictionary properties in _validate_compatible.
  • Error Message Formatting: Restored missing f-string prefixes to several ValueError and TypeError calls, ensuring variables are correctly interpolated into error messages.
  • Incompatible Type Error Formatting: Fixed a ValueError in _validate_compatible where a boolean expression was incorrectly passed to a format string expecting type names, leading to mangled error messages.
  • Regression Tests: Added new unit tests in json_utils_test.py to verify that incompatible object schemas are correctly caught and that error messages are properly formatted.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • sdks/python/apache_beam/yaml/json_utils.py
    • Converted ValueError messages in maybe_nullable to f-strings for correct variable interpolation.
    • Corrected the logic in _validate_compatible to check weak_schema['type'] == 'object' instead of weak_schema == 'object'.
    • Modified the property iteration in _validate_compatible to use .items() to prevent unpacking errors.
    • Updated the ValueError message for prohibited properties in _validate_compatible to use an f-string.
    • Fixed the ValueError format string in _validate_compatible to correctly pass weak_schema['type'] and strong_schema['type'] instead of a boolean comparison result.
  • sdks/python/apache_beam/yaml/json_utils_test.py
    • Added test_row_validator_compatibility_error to verify that row_validator correctly raises ValueError for incompatible object schemas.
    • Added test_json_schema_to_beam_schema_errors to test error handling for invalid object types and missing properties in json_schema_to_beam_schema.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Beam YAML JSON Schema validation silent failure and internal crashes in json_utils.py

1 participant