opensearch-project/OpenSearch

[Feature Request] Upgrade google-cloud-storage to v2

Open

#16,156 opened on Oct 1, 2024

View on GitHub
 (4 comments) (2 reactions) (1 assignee)Java (8,123 stars) (1,505 forks)batch import
Pluginsenhancementgood first issue

Description

Is your feature request related to a problem? Please describe

Coming from conversation on https://github.com/opensearch-project/OpenSearch/pull/16072

The repository-gcs plugin currently depends on v1 of the google-cloud-storage dependencies. Dependabot has been creating automatic updates which consistently fail precommit and tests and cannot be merged without further modifications.

I have tried to upgrade this dependency, but consistently receive errors on GoogleCloudStorageBlobContainerRetriesTests.testWriteLargeBlob post-upgrade which uses the resumable upload feature of google cloud storage.

The test can be run using ./gradlew :plugins:repository-gcs:test --tests GoogleCloudStorageBlobContainerRetriesTests.testWriteLargeBlob -i. When running that test, I have to add an image: tag to test/fixtures/gcs-fixture/docker-compose.yml in all services in order to bring up the containers successfully.

Describe the solution you'd like

Update to v2 for com.google.cloud:google-cloud-storage dependency.

Related component

Plugins

Describe alternatives you've considered

No response

Additional context

There were lines added to dependabot.yml to prevent dependabot from making PRs on a major version update for this dependency. After upgrading to v2, make sure to remove these lines from dependabot.yml.

Contributor guide

Tech stack
javagcp
Domain
backendcloud
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaGradleOpenSearch plugin developmentGoogle Cloud Storage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review the repository gcs plugin structure in plugins/repository gcs. Examine the failing test GoogleCloudStorageBlobContainerRetriesTests.testWriteLargeBlob. Investigate the resumable upload API changes between v1 and v2 of google cloud storage. Modify the dependency version in build.gradle and update the test fixture docker compose.yml as needed. Remove the dependabot exclusion lines from .github/dependabot.yml after upgrade.
[Feature Request] Upgrade google-cloud-storage to v2 · opensearch-project/OpenSearch#16156 | Good First Issue