Skip to content

Conversation

@diegomarquezp
Copy link
Contributor

No description provided.

diegomarquezp and others added 13 commits December 4, 2025 15:53
#4252)

* fix: Refine connecitivity metrics to capture RPCs with no response headers

* test fix
Most transactions that exceed the mutation limit for an atomic transaction will fail with the error "The transaction contains too many mutations.". However, it is also possible that the transaction fails with the more generic error message "Transaction resource limits exceeded". This error did not trigger a retry of the statement using a PDML transaction.

Fixes #4253
- Send a RequestID to Spanner for each request
- Make sure that the attempt number of the RequestID is increased
  if the RPC is retried.
- Include the RequestID in every error that is thrown due to an error
  that is returned by Spanner.
This PR enables the gRPC-GCP channel pool extension by default for Cloud Spanner Java client.

**What's Changing for Customers**

**Before this change**

- gRPC-GCP extension was disabled by default
- Default number of channels: 4
- Channel pooling was handled by GAX

**After this change**

- gRPC-GCP extension is enabled by default
- Default number of channels: 8
- Channel pooling is handled by gRPC-GCP extension

**Benefits of gRPC-GCP**

- **Improved resilience:** When a network connection fails on a particular channel, operations can be automatically retried on a different gRPC channel
- **Better channel management:** gRPC-GCP provides more sophisticated channel affinity and load balancing

**How to Disable gRPC-GCP (Switch Back to GAX Channel Pool)**

If you need to disable gRPC-GCP and use the previous GAX channel pooling behavior, use the `disableGrpcGcpExtension()` method:
```
SpannerOptions options = SpannerOptions.newBuilder()
    .setProjectId("my-project")
    .disableGrpcGcpExtension()
    .build();
```

When disabled, the default number of channels reverts to 4 (the previous default).

**When You Might Want to Disable gRPC-GCP**

- **Maintaining previous behavior:** If you want to keep the exact same behavior as before this change (GAX channel pool with 4 default channels).
- **Troubleshooting**: If you experience any unexpected behavior, disabling gRPC-GCP can help isolate whether the issue is related to the channel pooling mechanism.
🤖 I have created a release *beep* *boop*
---


### Updating meta-information for bleeding-edge SNAPSHOT release.

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
* feat: add support of dynamic channel pooling

* set initial pool size to 0 make dynamic channel pool work

* chore: generate libraries at Tue Dec 16 06:00:50 UTC 2025

* bump grpc-gcp-java version

* fix test

* incorporate suggestions

* chore: generate libraries at Tue Dec 16 09:56:45 UTC 2025

* make dynamic channel pool default disabled

* add verifySameChannelId back and fix partitionDML test

* support setting GcpChannelPoolOptions directly

---------

Co-authored-by: cloud-java-bot <[email protected]>
* chore(main): release 6.105.0

* chore: generate libraries at Tue Dec 16 17:46:24 UTC 2025

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: cloud-java-bot <[email protected]>
🤖 I have created a release *beep* *boop*
---


### Updating meta-information for bleeding-edge SNAPSHOT release.

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
@diegomarquezp diegomarquezp requested review from a team as code owners December 17, 2025 01:29
@product-auto-label product-auto-label bot added size: l Pull request size is large. api: spanner Issues related to the googleapis/java-spanner API. labels Dec 17, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @diegomarquezp, 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 integrates the latest changes from the main development branch, introducing a new version of the client library. The primary focus of these updates is to enhance the client's internal architecture for improved performance, observability, and resilience. Key changes include the introduction of dynamic channel pooling, making the gRPC-GCP extension the default, and a comprehensive refactoring of how request identifiers are generated, propagated, and utilized for metrics and error reporting.

Highlights

  • Version Update: The project has been updated to version 6.105.0, incorporating several new features, bug fixes, and dependency updates as detailed in the CHANGELOG.
  • Dynamic Channel Pooling: Added support for dynamic channel pooling, allowing the client to automatically scale the number of gRPC channels based on load. This feature is enabled by default when the gRPC-GCP extension is active.
  • gRPC-GCP Enabled by Default: The gRPC-GCP extension is now enabled by default, enhancing connectivity and performance for Google Cloud Spanner clients.
  • Request ID Handling Refactoring: Significant refactoring of the X-Goog-Spanner-Request-Id generation and propagation mechanism. Request IDs are now managed more centrally within the RPC layer, removing direct parameters from many exception constructors and internal client methods. New interceptors and creators are introduced for this.
  • Improved Metrics and Exception Details: Refined the recording of server timing header metrics (GFE/AFE latencies and missing counts) to be more robust and conditional. Request IDs are now consistently extracted from gRPC trailers and included in Spanner exceptions for better debugging.
Ignored Files
  • Ignored by pattern: .github/workflows/** (2)
    • .github/workflows/hermetic_library_generation.yaml
    • .github/workflows/unmanaged_dependency_check.yaml
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request appears to be an automated release-please PR, bumping the version and updating the changelog with new features, bug fixes, and dependency updates. The core changes include enabling dynamic channel pooling, making grpc-gcp enabled by default, and a significant refactoring of how request IDs are handled, moving towards a more automated and centralized approach using gRPC interceptors. The changes are extensive but seem well-structured. I've identified one potential issue in the channel number calculation logic that could lead to incorrect behavior in an edge case.

Comment on lines +2146 to 2154
private int convertToRequestIdChannelNumber(@Nullable Long affinity) {
if (affinity == null) {
return 0;
}
int requestIdChannel = affinity.intValue();
requestIdChannel = requestIdChannel == Integer.MAX_VALUE ? 0 : Math.abs(requestIdChannel);
// Start counting at 1, to distinguish between '0 == Unknown and >0 == known'.
return requestIdChannel % this.numChannels + 1;
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The current implementation for converting an affinity hint to a channel number has a potential issue with integer overflow. When affinity.intValue() returns Integer.MIN_VALUE, Math.abs() will also return Integer.MIN_VALUE (a negative number). The subsequent modulo operation (%) on this negative number can produce a negative result, leading to a negative channel number. This is likely not the intended behavior, as XGoogSpannerRequestId#hasChannelId considers only positive channel IDs as valid.

A safer approach is to work with long to prevent overflow or use bitwise operations to ensure a non-negative value before the modulo operation.

Suggested change
private int convertToRequestIdChannelNumber(@Nullable Long affinity) {
if (affinity == null) {
return 0;
}
int requestIdChannel = affinity.intValue();
requestIdChannel = requestIdChannel == Integer.MAX_VALUE ? 0 : Math.abs(requestIdChannel);
// Start counting at 1, to distinguish between '0 == Unknown and >0 == known'.
return requestIdChannel % this.numChannels + 1;
}
private int convertToRequestIdChannelNumber(@Nullable Long affinity) {
if (affinity == null) {
return 0;
}
// Use `& Long.MAX_VALUE` to get a non-negative value and avoid issues with `Math.abs(Long.MIN_VALUE)`.
long nonNegativeAffinity = affinity & Long.MAX_VALUE;
// Start counting at 1, to distinguish between '0 == Unknown and >0 == known'.
return (int) (nonNegativeAffinity % this.numChannels) + 1;
}

@blakeli0 blakeli0 merged commit 10c6c11 into protobuf-4.x-rc Dec 17, 2025
58 of 59 checks passed
@blakeli0 blakeli0 deleted the protobuf-4.x-merge-main branch December 17, 2025 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: spanner Issues related to the googleapis/java-spanner API. size: l Pull request size is large.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants