feat(pubsub/v2): add new v2 samples #5344
Conversation
* feat(pubsub): add v2 topic and publishing samples * address code review comments
* feat(pubsub): add v2 subscription samples * fix issue with line length * update quickstart * address gemini code review comments * Add doc comments to client.Subscriber calls Clarify that client.Subscriber accepts either a resource ID or a fully qualified name for the subscription. If a resource ID is used, the project ID from the client is assumed. * fix region tag issue --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
* feat(pubsub): add v2 rewritten schema samples * resolve gemini review comments
* docs(pubsub): add comments for publisher instantiation * update comments and var names * change more variable naming
There was a problem hiding this comment.
Summary of Changes
Hello @hongalex, 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 comprehensive update to the Google Cloud Pub/Sub Go samples, transitioning them to utilize the new v2 client library. The changes refactor the sample code to integrate with the updated API design, providing current and idiomatic examples for Pub/Sub operations.
Highlights
- Client Library Upgrade: All Google Cloud Pub/Sub Go samples have been migrated from the
v1to thev2client library (cloud.google.com/go/pubsub/v2), ensuring they demonstrate the latest client features and API patterns. - API Surface Alignment: The sample code has been updated to align with the
v2client's API surface, which includes using dedicated admin clients (e.g.,TopicAdminClient,SubscriptionAdminClient,SchemaClient) for management operations andPublisher/Subscriberfor data plane interactions. This also involves adopting protobuf-based request and response types (pubsubpb). - Dependency Management: The
go.modandgo.sumfiles have been updated to reflect the newv2Pub/Sub client dependency and other related Go module version bumps.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request migrates the Pub/Sub samples from the v1 Go client to the v2 client. The changes are extensive and touch almost all sample files for topics, subscriptions, and schemas. The migration correctly adopts new v2 API patterns, such as using separate admin clients for resource management and Publisher/Subscriber for data plane operations. I've identified a critical issue in pubsub/topics/publish_retry.go where an incorrect type is used, which will cause a compilation failure. I also found several high-severity issues related to behavioral changes (missing AckDeadline in subscription creation) and incomplete test cleanup logic that could lead to resource leaks. Additionally, there are several medium-severity issues regarding reduced test coverage and minor inconsistencies in the samples. Overall, the migration is on the right track, but these issues should be addressed to ensure the correctness and quality of the new v2 samples.
| PublisherCallOptions: &vkit.TopicAdminCallOptions{ | ||
| Publish: []gax.CallOption{ |
There was a problem hiding this comment.
The PublisherCallOptions field in pubsub.ClientConfig is being set with vkit.TopicAdminCallOptions. This is incorrect and will cause a compilation error as the field expects a *vkit.PublisherCallOptions.
| PublisherCallOptions: &vkit.TopicAdminCallOptions{ | |
| Publish: []gax.CallOption{ | |
| PublisherCallOptions: &vkit.PublisherCallOptions{ | |
| Publish: []gax.CallOption{ |
All code has been pre-approved in the individual PRs that made up this trunk branch:
Topics: #5336
Subscriptions: #5339
Schemas: #5340
Misc comments: #5343