chore(librarian): temporarily switch protobuf backend from upb to python #15006
Conversation
Summary of ChangesHello @parthea, 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 introduces a temporary modification to the test runner configuration, switching the protobuf backend from 'upb' to 'python' for unit tests. This is a stop-gap measure to mitigate a persistent unit testing crash in 'google-cloud-compute' that is proving difficult to diagnose, especially since it only occurs within cloud build environments. The change includes a clear indication that it is a temporary workaround, with plans to revert once the underlying issue is resolved. Highlights
🧠 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. Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request temporarily switches the protobuf backend from upb to python as a workaround for a crash during unit testing. The change is straightforward and well-commented. I've added a couple of suggestions to improve code maintainability. One is to extract the protobuf implementation string into a variable in cli.py to make the temporary change more explicit and easier to revert. The other is to address a duplicated string in the test file test_cli.py by extracting it into a variable to improve readability and reduce redundancy.
| # TODO(https://github.com/googleapis/google-cloud-python/issues/14992): Switch the protobuf | ||
| # implementation back to upb once we identify the root cause of the crash that occurs during testing. | ||
| # It's not trivial to debug this since it only happens in cloud build. | ||
| sessions = [ | ||
| f"unit-{session_runtime}(protobuf_implementation='upb')", | ||
| f"unit-{session_runtime}(protobuf_implementation='python')", | ||
| ] |
There was a problem hiding this comment.
To make this temporary change more explicit and easier to revert, consider extracting the protobuf_implementation value into a variable. This isolates the temporary value and makes the code's intent clearer.
| # TODO(https://github.com/googleapis/google-cloud-python/issues/14992): Switch the protobuf | |
| # implementation back to upb once we identify the root cause of the crash that occurs during testing. | |
| # It's not trivial to debug this since it only happens in cloud build. | |
| sessions = [ | |
| f"unit-{session_runtime}(protobuf_implementation='upb')", | |
| f"unit-{session_runtime}(protobuf_implementation='python')", | |
| ] | |
| # TODO(https://github.com/googleapis/google-cloud-python/issues/14992): Switch the protobuf | |
| # implementation back to upb once we identify the root cause of the crash that occurs during testing. | |
| # It's not trivial to debug this since it only happens in cloud build. | |
| protobuf_implementation = "python" # Revert to "upb" once the issue is resolved. | |
| sessions = [ | |
| f"unit-{session_runtime}(protobuf_implementation='{protobuf_implementation}')", | |
| ] |
| f"unit-{nox_session_python_runtime}(protobuf_implementation='python')", | ||
| ] | ||
| _run_nox_sessions("mock-library", "repo", is_mono_repo) | ||
|
|
||
| assert mock_run_individual_session.call_count == len(sessions_to_run) | ||
| mock_run_individual_session.assert_has_calls( | ||
| [ | ||
| mocker.call( | ||
| f"unit-{nox_session_python_runtime}(protobuf_implementation='upb')", | ||
| f"unit-{nox_session_python_runtime}(protobuf_implementation='python')", |
There was a problem hiding this comment.
The session string f"unit-{nox_session_python_runtime}(protobuf_implementation='python')" is duplicated here and on line 805. To improve maintainability and avoid potential inconsistencies, consider extracting it into a variable.
For example:
session_name = f"unit-{nox_session_python_runtime}(protobuf_implementation='python')"
sessions_to_run = [session_name]
# ...
mocker.call(session_name, ...)There was a problem hiding this comment.
Ack. I'm going to skip this for now as I want to minimize changes while debugging #14992
2 participants
This is a temporary workaround to address #14992 where a crash happens during unit testing of
google-cloud-computeuntil we can identify the root cause. This is not trivial to debug since I don't see the problem locally. It only happens in cloud build.