You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Context:
When a gRPC call fails with grpc.StatusCode.UNIMPLEMENTED but the error details string includes "Received http2 header with status: 404", the google-api-core library currently translates this into google.api_core.exceptions.MethodNotImplemented. This scenario often happens due to client-side configuration errors like an incorrect api_endpoint or a malformed resource path, not because the method is actually unimplemented.
Actual Behavior:
The library raises google.api_core.exceptions.MethodNotImplemented: 501 Received http2 header with status: 404. This exception is misleading because the primary issue indicated by the underlying error is related to the 404 (Not Found), not that the method is unimplemented (501). This makes debugging difficult for users.
Expected Behavior:
google-api-core should raise an exception that better reflects the underlying HTTP 404. Suggested improvements:
Prioritize the 404 status when present in the details, raising google.api_core.exceptions.NotFound (404).
The goal is to provide a more actionable error message to the user, guiding them to check the endpoint or resource path.
Thanks! I edited the PR description to remove the alternative suggestion of raising ServiceUnavailable (503). Your actual code implementation of keeping the exception type but enriching the error message is much better.
⚠️ One Small Caveat to Keep in Mind
This is technically a weak breaking change for exception messages. While substring assertions (e.g., assert "404" in str(e)) will continue to pass because we prepend the original message, any brittle test suites in downstream projects doing exact string equality matches on this exception message will fail.
Given how much this improves developer troubleshooting, I think this soft risk is entirely acceptable, but it is worth noting.
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
kokoro:force-runAdd this label to force Kokoro to re-run the tests.kokoro:runAdd this label to force Kokoro to re-run the tests.
5 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.
Summary of the issue:
Context:
When a gRPC call fails with grpc.StatusCode.UNIMPLEMENTED but the error details string includes "Received http2 header with status: 404", the google-api-core library currently translates this into google.api_core.exceptions.MethodNotImplemented. This scenario often happens due to client-side configuration errors like an incorrect api_endpoint or a malformed resource path, not because the method is actually unimplemented.
Actual Behavior:
The library raises google.api_core.exceptions.MethodNotImplemented: 501 Received http2 header with status: 404. This exception is misleading because the primary issue indicated by the underlying error is related to the 404 (Not Found), not that the method is unimplemented (501). This makes debugging difficult for users.
Expected Behavior:
google-api-core should raise an exception that better reflects the underlying HTTP 404. Suggested improvements:
Prioritize the 404 status when present in the details, raising google.api_core.exceptions.NotFound (404).
The goal is to provide a more actionable error message to the user, guiding them to check the endpoint or resource path.
Fixes b/362438722