feat(internal/gengapic): move operations & iterators to aux.go #1428
Conversation
This file contains 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
codyoss
approved these changes
Oct 13, 2023
| // auxTypes gathers details of types we need to generate along with the client | ||
| type auxTypes struct { | ||
| // Map of RPC descriptor to assigned operationWrapper. | ||
| methodToWrapper map[*descriptorpb.MethodDescriptorProto]operationWrapper |
There was a problem hiding this comment.
Someday we should create a lightweight generic sorted map impl. We always be sorting in generator because of key randomness today.
There was a problem hiding this comment.
Oo that would be great, and fun :)
If you want to, we could start one in this repo's internal package, then potentially give it its own repo? Would be good practice with generics...
quartzmo
reviewed
Oct 13, 2023
quartzmo
approved these changes
Oct 13, 2023
quartzmo
approved these changes
Oct 13, 2023
|
Ready to release this now. merging. |
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Nov 1, 2023
🤖 I have created a release *beep* *boop* --- ## [0.39.0](https://togithub.com/googleapis/gapic-generator-go/compare/v0.38.2...v0.39.0) (2023-11-01) ### Features * **internal/gengapic:** Move operations & iterators to aux.go ([#1428](https://togithub.com/googleapis/gapic-generator-go/issues/1428)) ([e8ad272](https://togithub.com/googleapis/gapic-generator-go/commit/e8ad27239eca2cb09623812e1bb0bf88f5f7a5c1)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
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.
Generate all
IteratorandOperationwrapper types into a single file -aux.go. The auxiliary types can be shared across the entire client package when certain criteria are met.For
Iteratorwrappers, it is simply a matching repeated type, common when multiple RPCs paginate over the same message.For
Operationwrappers, the RPC name must be the same, as well as the response and metadata types declared inside of the operation returned. This is less common, but can happen if two proto services in the same package share an RPC name and types. This introduces a new generator error mode when the aforementioned conditions are not met. This is good because previously the generator would succeed, but the generated code would not compile (colliding type names) and not provide a clear reason to debug.The operation "builder" methods that are generated onto a service client type surface remain in the same place - in the service client file. These are specific to each client, even if they are mostly the same in surface between clients, so we keep them generated in the client file.
An example of the changes can be found in #8703. Building all Go gapic targets under google/cloud worked.
Note: Thus undoes #1398, which will result in a breaking change in the beta client it address a collision in. This is OK because the client is marked as beta/unstable, and it is more true to the surface.
Fixes #156.
Updates #1399.