feat(storage): Soft deleted Bucket Restore #28138

shubhangi-google · 2024-12-19T13:03:47Z

Add support for restoring soft deleted bucket.

Operation Supported:

Get Bucket Generation
Get a Soft Deleted Bucket (Also soft-delete time and hard-delete time)
List Soft Deleted Buckets
Restore a Soft Deleted Bucket

@example
require "google/cloud/storage"
storage = Google::Cloud::Storage.new
bucket = storage.bucket "my-bucket"
bucket.delete
##fetch bucket generation
 generation= bucket.generation
## list soft_deleted buckets
deleted_buckets= storage.buckets soft_deleted: true
## restore bucket
bucket = storage.restore_bucket "my-bucket", generation

bajajneha27

Mark the PR ready for review once you're ready for it to be reviewed. Also please check the CI job failures.

google-cloud-storage/lib/google/cloud/storage/bucket.rb

google-cloud-storage/lib/google/cloud/storage/project.rb

google-cloud-storage/samples/Gemfile

google-cloud-storage/samples/acceptance/buckets_test.rb

bajajneha27 · 2024-12-20T09:20:58Z

google-cloud-storage/test/google/cloud/storage/project_test.rb

  def object_retention_param enable_object_retention
    enable_object_retention ? Google::Apis::StorageV1::Bucket::ObjectRetention.new(mode: "Enabled") : nil
  end
-end


You probably want to revert this change back and add the newline character back.

did not understand your concerns here

google-cloud-storage/test/helper.rb

snippet-bot · 2024-12-21T05:52:30Z

Here is the summary of changes.

You are about to add 3 region tags.

google-cloud-storage/samples/storage_get_soft_deleted_bucket.rb:15, tag storage_get_soft_deleted_bucket
google-cloud-storage/samples/storage_list_soft_deleted_buckets.rb:15, tag storage_list_soft_deleted_buckets
google-cloud-storage/samples/storage_restore_bucket.rb:15, tag storage_restore_bucket

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
/~https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

bajajneha27

Overall LGTM. Please fix the CI issues.

bajajneha27 · 2024-12-23T06:14:17Z

google-cloud-storage/lib/google/cloud/storage/project.rb

@@ -223,6 +232,10 @@ def buckets prefix: nil, token: nil, max: nil, user_project: nil
        #   account, transit costs will be billed to the given project. This
        #   parameter is required with requester pays-enabled buckets. The
        #   default is `nil`.
+        # @param [Integer] generation generation no of bucket


Suggested change

# @param [Integer] generation generation no of bucket

# @param [Integer] generation Generation of the bucket

google-cloud-storage/lib/google/cloud/storage/project.rb

shubhangi-google · 2024-12-23T15:34:35Z

Hi @bajajneha27 @JesseLovelace can you please take a look at the sample failure
getting permission error on sample run

Google::Cloud::PermissionDeniedError: forbidden: 542339357638-cr0dserr2evg7sv1meghqeu703274f3h@developer.gserviceaccount.com does not have storage.buckets.get access to the Google Cloud Storage bucket. Permission 'storage.buckets.get' denied on resource (or it may not exist).

JesseLovelace · 2025-01-07T19:26:09Z

google-cloud-storage/samples/storage_get_soft_deleted_bucket.rb

+  require "google/cloud/storage"
+
+  storage = Google::Cloud::Storage.new
+  bucket_name = bucket_name.gsub(/[^a-zA-Z0-9\- ]/, "")


We shouldn't do validation like this in a sample, remove this line

I think this may have something to do with the PermissionDenied error you're getting, this may be causing you to check two different bucket names

hi @bajajneha27 @JesseLovelace
I have removed the suspected line of code but still getting same failure

bajajneha27 · 2025-01-08T07:05:06Z

@shubhangi-google Does the yard / rubocop ci work in your local?

bajajneha27 · 2025-01-08T07:13:03Z

google-cloud-storage/samples/storage_get_soft_deleted_bucket.rb

+  bucket_name = bucket_name.gsub(/[^a-zA-Z0-9\- ]/, "")
+
+  # fetching soft deleted bucket with soft_delete_time and hard_delete_time
+  deleted_bucket_fetch = storage.bucket bucket_name, generation: generation, soft_deleted: true


Error occurs at this line. This could be because the bucket_name is modified in the previous line and the new bucket doesn't exist.
Like Jesse said, try removing the above line. We shouldn't be modifying the bucket_name passed.

bajajneha27 · 2025-01-15T11:46:37Z

Can you please double check that the APIARY i.e. google-apis-storage_v1 has soft delete changes? We might have to bump the storage_v1 version in storage gemspec

shubhangi-google · 2025-01-17T06:07:07Z

Can you please double check that the APIARY i.e. google-apis-storage_v1 has soft delete changes? We might have to bump the storage_v1 version in storage gemspec

updating the version in gemspec did not help will debug this further

bajajneha27 · 2025-01-17T07:03:39Z

google-cloud-storage/google-cloud-storage.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
  gem.add_dependency "google-cloud-core", "~> 1.6"
  gem.add_dependency "google-apis-core", "~> 0.13"
  gem.add_dependency "google-apis-iamcredentials_v1", "~> 0.18"
-  gem.add_dependency "google-apis-storage_v1", "~> 0.38"
+  gem.add_dependency "google-apis-storage_v1", "~> 0.40"


The soft_deleted field on get_bucket was introduced in storage_v1 0.42 version. Ref
Which version were you using in local?
Also generally, just update to the latest version of the dependency when you do this.
This should solve the issue.

current gem version present on KOKORO is 0.49 (as seen in sample logs)

"~> 0.40" will specify that we want to use a version of the gem that is at least 0.40, but less than 0.5.

bajajneha27 requested changes Dec 20, 2024

View reviewed changes

shubhangi-google marked this pull request as ready for review December 21, 2024 05:52

shubhangi-google requested review from yoshi-approver and a team as code owners December 21, 2024 05:52

shubhangi-google requested a review from bajajneha27 December 23, 2024 04:35

bajajneha27 reviewed Dec 23, 2024

View reviewed changes

JesseLovelace reviewed Jan 7, 2025

View reviewed changes

bajajneha27 requested changes Jan 8, 2025

View reviewed changes

shubhangi-google force-pushed the soft_deleted_bucket_restore_samples_new3 branch from 209b570 to 59a3f9c Compare January 17, 2025 05:41

bajajneha27 reviewed Jan 17, 2025

View reviewed changes

bajajneha27 added the kokoro:run Add this label to force Kokoro to re-run the tests. label Jan 17, 2025

yoshi-kokoro removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Jan 17, 2025

shubhangi-google added 12 commits January 17, 2025 13:06

WIP- able to fetch generation and list of soft deleted bucket

0f5b378

wip- fetch soft deleted bucket and restore bucket

c13c271

refactor

703a74f

adding unit tests

113e074

refactor

d8389ee

update

4805dcf

fixing lint issues

4628b57

refactor

331713a

removing unwanted changes

7bb513c

removing commented code

fd595ed

removing unwanted file change

5876b21

refactor

8bb3590

shubhangi-google added 25 commits January 17, 2025 13:06

refactor

0c7316a

WIP-samples

dc22c71

adding samples and tests

45c0bc7

refactor

2e96036

refactor

3728dcf

updating comments

4265f54

fix lint issues

3c89fef

fix lint issues

d3e3db6

fix review comments

36fbf02

removing pry

69a242b

fix lint

46b987e

try cli issue fix

0d902d5

fix lint

b187c21

removing unwanted code

b608825

adding check to see if bucket is deleted or not

cc5dd1e

debugging

6700876

debugging

9538c91

debugging

ae9e2af

debugging

dbdbe58

debugging

d67ebf4

debugging

f30c889

debugging

8040fab

updating gemspec

88438a3

debugging

70236f7

debugging

b2f67ad

shubhangi-google force-pushed the soft_deleted_bucket_restore_samples_new3 branch from 582f12a to b2f67ad Compare January 17, 2025 13:06

shubhangi-google added 3 commits January 17, 2025 13:12

undo adding static email

6108636

updating gemspec -- debugging

04a56f1

updating gem spec -- debugging

dcb47e7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(storage): Soft deleted Bucket Restore #28138

feat(storage): Soft deleted Bucket Restore #28138

shubhangi-google commented Dec 19, 2024

bajajneha27 left a comment

bajajneha27 Dec 20, 2024

shubhangi-google Dec 21, 2024

snippet-bot bot commented Dec 21, 2024 •

edited

Loading

bajajneha27 left a comment

bajajneha27 Dec 23, 2024

shubhangi-google commented Dec 23, 2024

JesseLovelace Jan 7, 2025

JesseLovelace Jan 7, 2025

shubhangi-google Jan 15, 2025

bajajneha27 commented Jan 8, 2025

bajajneha27 Jan 8, 2025

bajajneha27 commented Jan 15, 2025

shubhangi-google commented Jan 17, 2025

bajajneha27 Jan 17, 2025

shubhangi-google Jan 17, 2025

	# @param [Integer] generation generation no of bucket
	# @param [Integer] generation Generation of the bucket

feat(storage): Soft deleted Bucket Restore #28138

Are you sure you want to change the base?

feat(storage): Soft deleted Bucket Restore #28138

Conversation

shubhangi-google commented Dec 19, 2024

bajajneha27 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snippet-bot bot commented Dec 21, 2024 • edited Loading

bajajneha27 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shubhangi-google commented Dec 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bajajneha27 commented Jan 8, 2025

Choose a reason for hiding this comment

bajajneha27 commented Jan 15, 2025

shubhangi-google commented Jan 17, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snippet-bot bot commented Dec 21, 2024 •

edited

Loading