google-cloud-bigtable 2.9.1 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 869ab13c901934adc004a44d5db261a522ec046f0d041e7c4459e547553f09fd
-  data.tar.gz: 0f8695ea7333b81550cb133821688cecc27659a198d5f8d33080a87380c06416
+  metadata.gz: bb8ed222ed2c24d4b39856180ede2faa2f861759a8166bcd86f1c76a969d8c24
+  data.tar.gz: 6a3575d2c69f0820899d14727a76bdeeeb89d05fde99abe90ff1b068ced220b0
 SHA512:
-  metadata.gz: 94f86b473863ecfdada6caf7233b6bfcae87560703e40c0333df435422ea84d56382772eab6bc409e479838bf0710a65a7e54ce753a210fe80736bd7876fcabc
-  data.tar.gz: e488a6e549ba34f836edb8b50e6c1eb3925af84d59f9bd0d19c9d4a7f664f042f37815df40388bf2b1f9dd8c0b728dcf06c9f80969ac0e1ff982ec65b8c092ce
+  metadata.gz: d1cd0db63088866f0aaf1ee4829b5d6af9a7f9b30ae0b2315cba9e3f6a2ccfb6171820970fb6bc8a2f3c8628c946a7dc37df5665c58b1eb0614337118b94831b
+  data.tar.gz: c56bd73b38d3f8b031200f78228c018d9c59d81e170067755204983b8f51c162f31c7183e09cde5be27be89b69cfef3d1c221db31d0247343bf68d03d6bde5e9

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 2.10.1 (2024-03-19)
+
+#### Bug Fixes
+
+* fix read rows retry so it doesn't trigger a full table scan in t… ([#25391](https://github.com/googleapis/google-cloud-ruby/issues/25391)) 
+
+### 2.10.0 (2024-03-07)
+
+#### Features
+
+* Update minimum supported Ruby version to 2.7 ([#25298](https://github.com/googleapis/google-cloud-ruby/issues/25298)) 
+
 ### 2.9.1 (2024-02-09)
 
 #### Documentation

data/lib/google/cloud/bigtable/chunk_processor.rb

@@ -76,11 +76,11 @@ module Google
         def validate_reset_row
           return unless chunk.reset_row
 
-          value = (!chunk.row_key.empty? ||
-              chunk.family_name ||
-              chunk.qualifier ||
-              !chunk.value.empty? ||
-              chunk.timestamp_micros.positive?)
+          value = !chunk.row_key.empty? ||
+                  chunk.family_name ||
+                  chunk.qualifier ||
+                  !chunk.value.empty? ||
+                  chunk.timestamp_micros.positive?
 
           raise_if value, "A reset should have no data"
         end

data/lib/google/cloud/bigtable/column_family_map.rb

@@ -370,8 +370,7 @@ module Google
           added_keys = @column_families.keys - comparison_map.keys
 
           added_keys.map do |name|
-            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
-            Modification.new(
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification.new(
               id:     name,
               create: @column_families[name]
             )
@@ -394,8 +393,7 @@ module Google
           end
 
           updated_keys.map do |name|
-            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
-            Modification.new(
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification.new(
               id:     name,
               update: @column_families[name]
             )
@@ -415,8 +413,7 @@ module Google
           dropped_keys = comparison_map.keys - @column_families.keys
 
           dropped_keys.map do |name|
-            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
-            Modification.new(
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification.new(
               id:   name,
               drop: true
             )

data/lib/google/cloud/bigtable/read_operations.rb

@@ -159,8 +159,10 @@ module Google
           rescue *RowsReader::RETRYABLE_ERRORS => e
             rows_reader.retry_count += 1
             raise Google::Cloud::Error.from_error(e) unless rows_reader.retryable?
-            rows_limit, row_set = rows_reader.retry_options limit, row_set
-            retry
+            resumption_option = rows_reader.retry_options limit, row_set
+            rows_limit = resumption_option.rows_limit
+            row_set = resumption_option.row_set
+            retry unless resumption_option.complete?
           end
         end
 
@@ -320,6 +322,11 @@ module Google
             row_set[:row_ranges] = row_ranges.map(&:to_grpc)
           end
 
+          # Set the row range to full table scan if the row set is empty
+          if row_set.empty?
+            row_set[:row_ranges] = [Google::Cloud::Bigtable::V2::RowRange.new]
+          end
+
           Google::Cloud::Bigtable::V2::RowSet.new row_set
         end
       end

data/lib/google/cloud/bigtable/rows_reader.rb

@@ -75,6 +75,7 @@ module Google
         #   Array of row or yield block for each processed row.
         #
         def read rows: nil, filter: nil, rows_limit: nil
+          @rows_count = 0
           response = @table.service.read_rows(
             @table.instance_id,
             @table.table_id,
@@ -116,40 +117,54 @@ module Google
         #   If not specified, reads from all rows.
         #   A hash of the same form as `Google::Cloud::Bigtable::V2::RowSet`
         #   can also be provided.
-        # @return [Integer, Google::Cloud::Bigtable::V2::RowSet]
+        # @return ResumptionOption
         #
         def retry_options rows_limit, row_set
-          return [rows_limit, row_set] unless last_key
+          return ResumptionOption.new false, rows_limit, row_set unless last_key
+
+          # Check if we've already read read rows_limit number of rows.
+          # If true, mark ResumptionOption is_complete to true.
+          return ResumptionOption.new true, nil, nil if rows_limit && rows_limit == @rows_count
 
-          # 1. Reduce the limit by the number of already returned responses.
+          # Reduce the limit by the number of already returned responses.
           rows_limit -= @rows_count if rows_limit
 
-          # 2. Remove ranges that have already been read, and reduce ranges that
+          reset_row_set rows_limit, row_set
+        end
+
+        ##
+        # Calculate the new row_set for the retry request
+        # @param rows_limit [Integer]
+        #    the updated rows_limit
+        # @param row_set [Google::Cloud::Bigtable::V2::RowSet]
+        #    original row_set
+        # @return ResumptionOption
+        def reset_row_set rows_limit, row_set
+          # 1. Remove ranges that have already been read, and reduce ranges that
           # include the last read rows
           if last_key
-            delete_indexes = []
-
-            row_set.row_ranges.each_with_index do |range, i|
-              if end_key_read? range
-                delete_indexes << i
-              elsif start_key_read? range
+            row_set.row_ranges.reject! { |r| end_key_read? r }
+            row_set.row_ranges.each do |range|
+              if start_key_read? range
                 range.start_key_open = last_key
               end
             end
-
-            delete_indexes.each { |i| row_set.row_ranges.delete_at i }
-          end
-
-          if row_set.row_ranges.empty?
-            row_set.row_ranges <<
-              Google::Cloud::Bigtable::V2::RowRange.new(start_key_open: last_key)
           end
 
-          # 3. Remove all individual keys before and up to the last read key
+          # 2. Remove all individual keys before and up to the last read key
           row_set.row_keys.select! { |k| k > last_key }
 
+          # 3. In read_operations, we always add an empty row_range if row_ranges and
+          # row_keys are not defined. So if both row_ranges and row_keys are empty,
+          # it means that we've already read all the ranges and keys, set ResumptionOption
+          # is_complete to true to indicate that this read is successful.
+          if last_key && row_set.row_ranges.empty? && row_set.row_keys.empty?
+            return ResumptionOption.new true, nil, nil
+          end
+
           @chunk_processor.reset_to_new_row
-          [rows_limit, row_set]
+
+          ResumptionOption.new false, rows_limit, row_set
         end
 
         ##
@@ -170,13 +185,14 @@ module Google
         # @return [Boolean]
         #
         def start_key_read? range
-          start_key = if range.start_key_closed.empty?
-                        range.start_key_open
-                      else
-                        range.start_key_closed
-                      end
-
-          start_key.empty? || last_key >= start_key
+          if !range.start_key_closed.empty?
+            last_key >= range.start_key_closed
+          elsif !range.start_key_open.empty?
+            last_key > range.start_key_closed
+          else
+            # start is unbounded
+            true
+          end
         end
 
         ##
@@ -186,13 +202,42 @@ module Google
         # @return [Boolean]
         #
         def end_key_read? range
-          end_key = if range.end_key_closed.empty?
-                      range.end_key_open
-                    else
-                      range.end_key_closed
-                    end
+          if !range.end_key_closed.empty?
+            range.end_key_closed <= last_key
+          elsif !range.end_key_open.empty?
+            range.end_key_open <= last_key
+          else
+            # end is unbounded
+            false
+          end
+        end
+      end
 
-          end_key && end_key <= last_key
+      # @private
+      # ResumptionOption
+      # Helper class returned by retry_options
+      class ResumptionOption
+        # @private
+        # Creates a ResumptionOption instance
+        # @param is_complete [Boolean]
+        #    marks if the current read is complete
+        # @param rows_limit [Integer]
+        #    limit of the retry request
+        # @param row_set [Google::Cloud::Bigtable::V2::RowSet]
+        #    row_set of the retry request
+        def initialize is_complete, rows_limit, row_set
+          @is_complete = is_complete
+          @rows_limit = rows_limit
+          @row_set = row_set
+        end
+
+        attr_reader :rows_limit
+        attr_reader :row_set
+
+        ##
+        # returns if this operation should be retried
+        def complete?
+          @is_complete
         end
       end
     end

data/lib/google/cloud/bigtable/service.rb

@@ -658,13 +658,11 @@ module Google
 
         def read_rows instance_id, table_id, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil
           client(table_path(instance_id, table_id), app_profile_id).read_rows(
-            **{
-              table_name:     table_path(instance_id, table_id),
-              rows:           rows,
-              filter:         filter,
-              rows_limit:     rows_limit,
-              app_profile_id: app_profile_id
-            }
+            table_name:     table_path(instance_id, table_id),
+            rows:           rows,
+            filter:         filter,
+            rows_limit:     rows_limit,
+            app_profile_id: app_profile_id
           )
         end
 

data/lib/google/cloud/bigtable/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigtable
-      VERSION = "2.9.1".freeze
+      VERSION = "2.10.1".freeze
     end
   end
 end

data/lib/google-cloud-bigtable.rb

@@ -65,11 +65,13 @@ module Google
     #   bigtable = gcloud.bigtable
     #
     def bigtable scope: nil, timeout: nil, credentials: nil
+      credentials ||= @keyfile
+      timeout ||= @timeout
       Google::Cloud.bigtable(
         project_id:  @project,
-        credentials: (credentials || @keyfile),
+        credentials: credentials,
         scope:       scope,
-        timeout:     (timeout || @timeout)
+        timeout:     timeout
       )
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.10.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -66,118 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: google-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.1
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
 description: google-cloud-bigtable is the official library for Cloud Bigtable API.
 email: googleapis-packages@google.com
 executables: []
@@ -256,14 +144,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Cloud Bigtable API