fix(internal/godocfx): make friendlyAPIName tolerant of missing packages#14194
Merged
hongalex merged 3 commits intogoogleapis:mainfrom Mar 19, 2026
Merged
fix(internal/godocfx): make friendlyAPIName tolerant of missing packages#14194hongalex merged 3 commits intogoogleapis:mainfrom
hongalex merged 3 commits intogoogleapis:mainfrom
Conversation
…ng behavior friendlyAPIName was recently changed to return an empty string instead of an error when a package or metadata is not found. This update aligns the tests with that behavior by: - Removing the test case for malformed metadata. - Updating the pubsub test to use a fallback to verify submodule avoidance. - Removing the unused wantErr field from the test struct.
Contributor
There was a problem hiding this comment.
Code Review
This pull request makes friendlyAPIName more robust by returning an empty string instead of an error when API metadata is not found. This is a sensible change that aligns with the previous behavior and fixes issues with packages lacking metadata files. The changes in internal/godocfx/parse.go and the test adjustments in internal/godocfx/godocfx_test.go are correct. I have one suggestion to enhance the test coverage to more explicitly validate the new error-tolerant logic, aligning with the rule to add tests for potential future errors.
shollyman
approved these changes
Mar 19, 2026
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
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.
friendlyAPIName was recently changed to return an empty string instead of an error when a package or metadata is not found.
This matches the old behavior prior to when fixes were made to account for individual .json files.
Without this change, our tests for alloydbconn, cloudqlconn will fail since they don't .repo-metadata.json files, and also don't live in this repository. In addition, the auth library generation also fails. None of these packages required a friendly API namer in the old behavior.