[yaml] : fix validate compatible method

[derrickaw]

fix #37575 #37576

---

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

• Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
• Update CHANGES.md with noteworthy changes.
• If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

[gemini-code-assist]

Summary of Changes

Hello @derrickaw, I'm Gemini Code Assist¹! 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 refines the YAML/JSON schema compatibility validation logic by fixing several bugs related to error message formatting, object type identification, and the handling of additional properties. It also includes new test cases to ensure the robustness and correctness of the updated validation mechanism, addressing issues with schema comparisons and property iteration.

Highlights

• Error Message Formatting: Updated several ValueError messages within the json_utils.py module to use f-strings for improved readability and correct variable interpolation, fixing instances where boolean results were printed instead of actual type names.
• Object Schema Validation Logic: Corrected the conditional check for object types in the _validate_compatible method from weak_schema == 'object' to weak_schema['type'] == 'object', ensuring proper validation of object schemas.
• Additional Properties Handling: Enhanced the _validate_compatible method to correctly handle additionalProperties within object schemas, preventing incompatible map vs. object type mismatches and recursively validating their schemas.
• Property Iteration Fix: Modified the iteration over properties in _validate_compatible from for name, spec in weak_schema.get('properties', {}) to for name, spec in weak_schema.get('properties', {}).items(), ensuring correct traversal of dictionary items.
• New Test Cases: Added comprehensive unit tests for the _validate_compatible function, covering various scenarios including compatible schemas, incompatible types, missing properties, incompatible property types, and map-specific compatibility checks.

🧠 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
  • Updated ValueError messages to use f-strings for clearer error reporting and corrected variable interpolation.
  • Fixed a bug in _validate_compatible where object type check was incorrect.
  • Implemented logic to validate additionalProperties in object schemas during compatibility checks.
  • Corrected the iteration method for properties within object schemas in _validate_compatible.
• sdks/python/apache_beam/yaml/json_utils_test.py
  • Added new test cases for _validate_compatible to cover various compatibility scenarios, including object and map type validations.

Activity

• The pull request description includes standard contribution guidelines and CI status badges, but no specific human comments or reviews have been recorded yet.

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. ↩

[derrickaw]

Run Python PreCommit 3.10