Skip to content
This repository was archived by the owner on Jul 14, 2026. It is now read-only.

Commit 49bdb13

Browse files
committed
Address review comments
1 parent ba565d3 commit 49bdb13

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

libraries-bom/releaseNotes.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
### Upgrade Overview
2-
The `Libraries-Bom` and its managed libraries have been upgraded to use **Protobuf v4.33.2**. All Protobuf gen code included in the managed libraries has been regenerated using `protoc v33.2`. Please note that this update necessitates a minimum Protobuf runtime of **v4.33.2**.
2+
The `Libraries-Bom` and its managed libraries have been upgraded to use **Protobuf v4.33.2**. All Protobuf gen code included in the managed libraries has been regenerated using `protoc v33.2`.
33

44
---
55
### ✅ Backward Compatibility
6-
The new protobuf-java v4.33.2 runtime is fully backward-compatible with protoc gen code 3.x. You should not experience any runtime incompatibilities from using older gen code with the new runtime.
7-
If you encounter any compatibility issues after this upgrade, please create an issue in our [GitHub repository](https://github.com/googleapis/sdk-platform-java/tree/main) or contact our support team through the [support console](https://cloud.google.com/support-hub) for assistance.
6+
The new protobuf-java v4.33.2 runtime is fully backward-compatible with protoc gen code 3.x. You should not experience any incompatibilities from using older gen code with the new runtime.
7+
Should you experience compatibility issues, please consult the [Known Incompatibilities & Mitigations](#known-incompatibilities-mitigations). If the issue persists, please file a report via the [support console](https://cloud.google.com/support-hub) or our [GitHub repository](https://github.com/googleapis/sdk-platform-java/tree/main)
88

99
---
1010
### ⚠️ Advisory: Vulnerability Warnings
@@ -18,19 +18,20 @@ For a detailed explanation and mitigation steps, please refer to Java section in
1818
While rare, the following incompatibilities may occur due to the version update:
1919

2020
#### 1. Runtime Version Mismatch
21-
* **Issue:** The minimum required `protobuf-java` runtime version is now **v4.33.2**. Starting with the 4.x runtime, [validations](https://github.com/protocolbuffers/protobuf/blob/1082da2da37a0887d0cfd70abf4a00e8973cd8bf/java/core/src/main/java/com/google/protobuf/RuntimeVersion.java#L55-L73) ensure the runtime version is higher than the gen code version.
21+
* **Issue:** The minimum required `protobuf-java` runtime version is now **v4.33.2**. Starting with the 4.x runtime, [validations](https://github.com/protocolbuffers/protobuf/blob/1082da2da37a0887d0cfd70abf4a00e8973cd8bf/java/core/src/main/java/com/google/protobuf/RuntimeVersion.java#L55-L73) ensure the runtime version is higher than the gen code version. Using a lower version of protobuf-java will produce errors below.
2222
* **Symptoms:**
2323
* `java.lang.NoClassDefFoundError: com/google/protobuf/RuntimeVersion$RuntimeDomain` (when using 3.x versions).
2424
* `com.google.protobuf.RuntimeVersion$ProtobufRuntimeVersionException` (when using older 4.x versions).
25-
* **Mitigation:** Upgrade `protobuf-java` to **v4.33.2**.
25+
* **Mitigation:** Upgrade the version of `protobuf-java` to be greater than or equal to **v4.33.2**.
2626

2727
#### 2. Class Hierarchy Changes (`GeneratedMessageV3`)
2828
* **Issue:** `GeneratedMessageV3` is no longer a parent class of gen code.
29-
* **Symptoms:** Runtime errors will occur if attempting to cast Proto 4.x gen code to `GeneratedMessageV3`. For example, `DeleteInstanceRequest` now extends [GeneratedMessage](https://github.com/googleapis/google-cloud-java/blob/d7a49aa9502012df1209b55ec741b1d4ac639361/java-compute/proto-google-cloud-compute-v1/src/main/java/com/google/cloud/compute/v1/DeleteInstanceRequest.java#L33) instead of [GeneratedMessageV3](https://github.com/googleapis/google-cloud-java/blob/1b56d017b4f93b5037f7261c488e008ac59897d8/java-compute/proto-google-cloud-compute-v1/src/main/java/com/google/cloud/compute/v1/DeleteInstanceRequest.java#L31).
29+
* **Symptoms:** Runtime errors will occur if attempting to cast Proto 4.x gen code to `GeneratedMessageV3`. For example, `DeleteInstanceRequest` now extends [GeneratedMessage](https://github.com/googleapis/google-cloud-java/blob/d7a49aa9502012df1209b55ec741b1d4ac639361/java-compute/proto-google-cloud-compute-v1/src/main/java/com/google/cloud/compute/v1/DeleteInstanceRequest.java#L33) instead of [GeneratedMessageV3](https://github.com/googleapis/google-cloud-java/blob/1b56d017b4f93b5037f7261c488e008ac59897d8/java-compute/proto-google-cloud-compute-v1/src/main/java/com/google/cloud/compute/v1/DeleteInstanceRequest.java#L31). You will run into `java.lang.ClassCastException` when trying to run `(GeneratedMessageV3)DeleteInstanceRequest`.
3030
* **Mitigation:** Migrate usages of `GeneratedMessageV3` to its parent interface, `Message`.
3131

3232
#### 3. Descriptor Syntax APIs
3333
* **Issue:** Certain internal methods in [Descriptors](https://github.com/protocolbuffers/protobuf/commit/1aeacd4f4eb4e0aa05d6336e2988a565e475e9a0) are no longer available.
34+
* **Symptoms:** `java.lang.NoSuchMethodError` when calling `Syntax`, `getSyntax()`, `hasOptionalKeyword()` or `isSynthetic()`.
3435
* **Mitigation:** There are no direct alternative methods; it is suggested to stop using them.
3536

3637
#### 4. Legacy Generated Code (v2.x)

0 commit comments

Comments
 (0)