GCS client library migration in Java SDK - part 2c

[shunping]

Some more clean-up on the public API module for GcsUtil.

• Removed test-only functions in GcsUtil. Those functions are for V1 only and they are not part of the public APIs.
• Also modified the related tests accordingly.

[gemini-code-assist]

Summary of Changes

Hello @shunping, I'm Gemini Code Assist¹! 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 continues the migration to the new GCS client library by cleaning up the GcsUtil class. It removes outdated V1-specific test-only functions and refactors the core utility to better integrate with GcsUtilV2. The changes introduce more controlled and robust file manipulation capabilities (copy, move, remove) by leveraging new strategies for handling missing files and overwriting existing ones, ultimately improving the reliability and maintainability of GCS interactions within the SDK.

Highlights

• GcsUtil Refactoring and V2 Integration: The GcsUtil class has been significantly refactored to streamline its constructor, remove V1-specific test-only functions, and integrate new copy, move, and remove methods that leverage the GcsUtilV2 implementation. This change simplifies the GcsUtil API and promotes the use of the newer GCS client library.
• Enhanced GcsUtilV2 Functionality: The GcsUtilV2 class now includes robust implementations for remove, copy, and move operations. These methods support new MissingStrategy and OverwriteStrategy enums, allowing for more granular control over file operations, including batch processing and improved error handling for file not found or already exists scenarios.
• Comprehensive Integration Tests: New integration tests have been added in GcsUtilParameterizedIT to thoroughly validate the copy, remove, and rename functionalities of GcsUtilV2. These tests cover various scenarios, including handling existing and non-existent files, and different overwrite/missing strategies.
• Deprecation and Delegation of V1 Methods: Several V1-specific utility methods within GcsUtil, such as getNonWildcardPrefix and isWildcard, have been deprecated and now delegate to GcsPath. Additionally, internal V1-specific batching and bucket management functions have been removed or made accessible only through the delegate object in GcsUtilTest.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .github/trigger_files/beam_PostCommit_Java.json
  • Updated the modification number to trigger CI.
• sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/GcsUtil.java
  • Removed deprecated V1 GCS client imports.
  • Simplified the GcsUtil constructor to delegate GcsUtilV1 and GcsUtilV2 creation.
  • Deprecated getNonWildcardPrefix and isWildcard methods, delegating to GcsPath.
  • Removed several V1-specific and test-only methods, including setStorageClient, setBatchRequestSupplier, getUploadBufferSizeBytes, getObject (with BackOff/Sleeper), fileSizes, and various bucket management methods.
  • Introduced new copyV2, copy (with OverwriteStrategy), renameV2, rename (with MissingStrategy/OverwriteStrategy), removeV2, and remove (with MissingStrategy) methods that utilize GcsUtilV2.
• sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/GcsUtilV2.java
  • Added imports for BlobId, BlobInfo, CopyWriter, CopyRequest and checkArgument.
  • Introduced MEGABYTES_COPIED_PER_CHUNK constant for copy operations.
  • Enhanced translateStorageException to handle FileNotFoundException (HTTP 404).
  • Defined MissingStrategy and OverwriteStrategy enums for file operations.
  • Implemented remove method with batch deletion and MissingStrategy support.
  • Implemented rewriteHelper as a core utility for copy and move operations, supporting various overwrite and missing strategies.
  • Added copy and move methods that leverage rewriteHelper for robust file manipulation.
• sdks/java/extensions/google-cloud-platform-core/src/test/java/org/apache/beam/sdk/extensions/gcp/util/GcsUtilParameterizedIT.java
  • Added imports for MissingStrategy, OverwriteStrategy, and MoveOptions.
  • Introduced createTestBucketHelper and tearDownTestBucketHelper for managing test resources, adapting to GcsUtilV2.
  • Added new integration tests (testCopy, testRemove, testRename) to verify GcsUtilV2 functionalities with different strategies.
• sdks/java/extensions/google-cloud-platform-core/src/test/java/org/apache/beam/sdk/extensions/gcp/util/GcsUtilTest.java
  • Updated existing unit tests to access V1-specific methods through the gcsUtil.delegate object, reflecting the refactoring in GcsUtil.
  • Simplified the GcsUtilMock constructor to align with the updated GcsUtil constructor.
• sdks/java/extensions/google-cloud-platform-core/src/test/java/org/apache/beam/sdk/extensions/gcp/util/gcsfs/GcsPathTest.java
  • Added test cases for GcsPath.isWildcard and GcsPath.getNonWildcardPrefix to cover the gs://bucket/* pattern.

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