activerecord-spanner-adapter 1.8.0 → 2.0.0

data/examples/snippets/read-write-transactions/application.rb

@@ -10,7 +10,7 @@ require_relative "models/singer"
 require_relative "models/album"
 
 class Application
-  def self.run # rubocop:disable Metrics/AbcSize
+  def self.run
     from_album = nil
     to_album = nil
     # Use a read/write transaction to execute multiple statements as an atomic unit.
@@ -20,7 +20,7 @@ class Application
       to_album = Album.where.not(id: from_album.id).sample
 
       puts ""
-      puts "Transferring 10,000 marketing budget from #{from_album.title} (#{from_album.marketing_budget}) "\
+      puts "Transferring 10,000 marketing budget from #{from_album.title} (#{from_album.marketing_budget}) " \
            "to #{to_album.title} (#{to_album.marketing_budget})"
       from_album.update marketing_budget: from_album.marketing_budget - 10000
       to_album.update marketing_budget: to_album.marketing_budget + 10000
@@ -29,10 +29,6 @@ class Application
     puts "Budgets after update:"
     puts "Marketing budget #{from_album.title}: #{from_album.reload.marketing_budget}"
     puts "Marketing budget #{to_album.title}: #{to_album.reload.marketing_budget}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/read-write-transactions/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/read-write-transactions/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/stale-reads/application.rb

@@ -53,10 +53,6 @@ class Application
     puts ""
     puts "Updated album title: #{album.title}"
     puts "Title somewhere during the last 10 seconds: #{album_max_staleness&.title}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/stale-reads/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/stale-reads/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/tags/application.rb

@@ -22,10 +22,6 @@ class Application
       albums = Album.annotate("request_tag: query-all-albums", "transaction_tag: sample-transaction").all
       puts "Queried #{albums.length} albums using a request and a transaction tag"
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/tags/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/examples/snippets/tags/db/seeds.rb

@@ -4,7 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
-require_relative "../../config/environment.rb"
+require_relative "../../config/environment"
 require_relative "../models/singer"
 require_relative "../models/album"
 

data/examples/snippets/timestamp-data-type/application.rb

@@ -32,10 +32,6 @@ class Application
     # Simulate that the application is now running in the timezone America/Los_Angeles.
     Time.zone = "America/Los_Angeles"
     puts "#{'Meeting time in the local timezone (America/Los_Angeles):'.ljust 60} #{meeting.local_meeting_time}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/timestamp-data-type/config/database.yml

@@ -6,3 +6,4 @@ development:
   database: testdb
   pool: 5
   timeout: 5000
+  schema_dump: false

data/lib/active_record/connection_adapters/spanner/column.rb

@@ -10,16 +10,16 @@ module ActiveRecord
   module ConnectionAdapters
     module Spanner
       class Column < ConnectionAdapters::Column
-        # rubocop:disable Style/MethodDefParentheses
+        # rubocop:disable Style/OptionalBooleanParameter
         def initialize(name, default, sql_type_metadata = nil, null = true,
                        default_function = nil, collation: nil, comment: nil,
                        primary_key: false, **)
-          # rubocop:enable Style/MethodDefParentheses
+          # rubocop:enable Style/OptionalBooleanParameter
           super
           @primary_key = primary_key
         end
 
-        def has_default? # rubocop:disable Naming/PredicateName
+        def has_default?
           super && !virtual?
         end
 

data/lib/active_record/connection_adapters/spanner/database_statements.rb

@@ -29,7 +29,7 @@ module ActiveRecord
         end
 
         def internal_execute sql, name = "SQL", binds = [],
-                             prepare: false, async: false, allow_retry: false # rubocop:disable Lint/UnusedMethodArgument, Metrics/LineLength
+                             prepare: false, async: false, allow_retry: false # rubocop:disable Lint/UnusedMethodArgument, /
           statement_type = sql_statement_type sql
           # Call `transform` to invoke any query transformers that might have been registered.
           sql = transform sql
@@ -65,7 +65,7 @@ module ActiveRecord
           end
 
           log_args = [sql, name]
-          log_args.concat [binds, type_casted_binds(binds)] if log_statement_binds
+          log_args.push binds, type_casted_binds(binds) if log_statement_binds
 
           log(*log_args) do
             types, params = to_types_and_params binds
@@ -83,12 +83,16 @@ module ActiveRecord
         end
 
         def append_request_tag_from_query_logs sql, binds
-          legacy_formatter_prefix = "/*request_tag:true,"
-          sql_commenter_prefix = "/*request_tag='true',"
-          if sql.start_with? legacy_formatter_prefix
-            append_request_tag_from_query_logs_with_format sql, binds, legacy_formatter_prefix
-          elsif sql.start_with? sql_commenter_prefix
-            append_request_tag_from_query_logs_with_format sql, binds, sql_commenter_prefix
+          possible_prefixes = [
+            "/*request_tag:true,",
+            "/*_request_tag='true',",
+            "/*_request_tag:true,",
+            "/*_request_tag='true',"
+          ]
+          possible_prefixes.each do |prefix|
+            if sql.start_with? prefix
+              append_request_tag_from_query_logs_with_format sql, binds, prefix
+            end
           end
         end
 
@@ -101,7 +105,7 @@ module ActiveRecord
           if options.request_tag == ""
             options.request_tag = request_tag
           else
-            options.request_tag += "," + request_tag
+            options.request_tag += ",#{request_tag}"
           end
 
           binds.append options
@@ -192,7 +196,7 @@ module ActiveRecord
           # and this RPC can return multiple partial result sets for DML as well. Only the last partial
           # result set will contain the statistics. Although there will never be any rows, this makes
           # sure that the stream is fully consumed.
-          result.rows.each { |_| }
+          result.rows.each { |_| } # rubocop:disable Lint/EmptyBlock
           return result.row_count if result.row_count
 
           raise ActiveRecord::StatementInvalid.new(
@@ -282,12 +286,12 @@ module ActiveRecord
         #
         def begin_isolated_db_transaction isolation
           if isolation.is_a? Hash
-            raise "Unsupported isolation level: #{isolation}" unless \
+            raise "Unsupported isolation level: #{isolation}" unless
               isolation[:timestamp] || isolation[:staleness] || isolation[:strong]
             raise "Only one option is supported. It must be one of `timestamp`, `staleness` or `strong`." \
               if isolation.count != 1
           else
-            raise "Unsupported isolation level: #{isolation}" unless \
+            raise "Unsupported isolation level: #{isolation}" unless
               [:serializable, :read_only, :buffered_mutations, :pdml].include? isolation
           end
 
@@ -312,26 +316,35 @@ module ActiveRecord
 
         # Translates binds to Spanner types and params.
         def to_types_and_params binds
-          types = binds.enum_for(:each_with_index).map do |bind, i|
+          types = to_types binds
+          params = to_params binds
+          [types, params]
+        end
+
+        def to_types binds
+          binds.enum_for(:each_with_index).to_h do |bind, i|
             type = :INT64
             if bind.respond_to? :type
               type = ActiveRecord::Type::Spanner::SpannerActiveRecordConverter
                      .convert_active_model_type_to_spanner(bind.type)
-            elsif bind.class == Symbol
+            elsif bind.instance_of? Symbol
               # This ensures that for example :environment is sent as the string 'environment' to Cloud Spanner.
               type = :STRING
-            elsif bind.class == TrueClass || bind.class == FalseClass
+            elsif bind.instance_of?(TrueClass) || bind.instance_of?(FalseClass)
               type = :BOOL
             end
             [
               # Generates binds for named parameters in the format `@p1, @p2, ...`
               "p#{i + 1}", type
             ]
-          end.to_h
-          params = binds.enum_for(:each_with_index).map do |bind, i|
+          end
+        end
+
+        def to_params binds
+          binds.enum_for(:each_with_index).to_h do |bind, i|
             type = if bind.respond_to? :type
                      bind.type
-                   elsif bind.class == Symbol
+                   elsif bind.instance_of? Symbol
                      # This ensures that for example :environment is sent as the string 'environment' to Cloud Spanner.
                      :STRING
                    else
@@ -343,8 +356,7 @@ module ActiveRecord
                     .serialize_with_transaction_isolation_level(type, bind_value, :dml)
 
             ["p#{i + 1}", value]
-          end.to_h
-          [types, params]
+          end
         end
 
         # An insert/update/delete statement could use mutations in some specific circumstances.
@@ -353,7 +365,7 @@ module ActiveRecord
         def should_use_mutation arel
           !@connection.current_transaction.nil? \
             && @connection.current_transaction.isolation == :buffered_mutations \
-            && can_use_mutation(arel) \
+            && can_use_mutation(arel)
         end
 
         def can_use_mutation arel
@@ -383,7 +395,7 @@ module ActiveRecord
           )
         end
 
-        COMMENT_REGEX = %r{(?:--.*\n)*|/\*(?:[^*]|\*[^/])*\*/}m.freeze \
+        COMMENT_REGEX = %r{(?:--.*\n)*|/\*(?:[^*]|\*[^/])*\*/}m \
             unless defined? ActiveRecord::ConnectionAdapters::AbstractAdapter::COMMENT_REGEX
         COMMENT_REGEX = ActiveRecord::ConnectionAdapters::AbstractAdapter::COMMENT_REGEX \
             if defined? ActiveRecord::ConnectionAdapters::AbstractAdapter::COMMENT_REGEX

data/lib/active_record/connection_adapters/spanner/quoting.rb

@@ -45,6 +45,7 @@ module ActiveRecord
         end
       end
     end
+
     module Spanner
       module Quoting
         def quote_column_name name
@@ -55,7 +56,7 @@ module ActiveRecord
           QUOTED_TABLE_NAMES[name] ||= "`#{name.to_s.gsub '.', '`.`'}`".freeze
         end
 
-        STR_ESCAPE_REGX = /[\n\r'\\]/.freeze
+        STR_ESCAPE_REGX = /[\n\r'\\]/
         STR_ESCAPE_VALUES = {
           "\n" => "\\n", "\r" => "\\r", "'" => "\\'", "\\" => "\\\\"
         }.freeze

data/lib/active_record/connection_adapters/spanner/schema_creation.rb

@@ -44,10 +44,7 @@ module ActiveRecord
                                      else
                                        [o.options[:primary_key]]
                                      end
-                           pk_names = []
-                           columns.each do |c|
-                             pk_names.append c.to_s
-                           end
+                           pk_names = columns.map(&:to_s)
                            PrimaryKeyDefinition.new pk_names
                          else
                            pk_names = o.columns.each_with_object [] do |c, r|
@@ -93,8 +90,8 @@ module ActiveRecord
         end
 
         def visit_DropColumnDefinition o
-          "ALTER TABLE #{quote_table_name o.table_name} DROP" \
-           " COLUMN #{quote_column_name o.name}"
+          "ALTER TABLE #{quote_table_name o.table_name} DROP " \
+            "COLUMN #{quote_column_name o.name}"
         end
 
         def visit_ChangeColumnDefinition o
@@ -143,7 +140,7 @@ module ActiveRecord
 
           if !options[:allow_commit_timestamp].nil? &&
              options[:column].sql_type == "TIMESTAMP"
-            sql << " OPTIONS (allow_commit_timestamp = "\
+            sql << " OPTIONS (allow_commit_timestamp = " \
                    "#{options[:allow_commit_timestamp]})"
           end
 
@@ -153,8 +150,9 @@ module ActiveRecord
             sql << " STORED" if options[:stored]
             unless options[:stored]
               raise ArgumentError, "" \
-                "Cloud Spanner currently does not support generated columns without the STORED option." \
-                "Specify 'stored: true' option for `#{options[:column].name}`"
+                                   "Cloud Spanner currently does not support generated columns" \
+                                   "without the STORED option." \
+                                   "Specify 'stored: true' option for `#{options[:column].name}`"
             end
           end
 

data/lib/active_record/connection_adapters/spanner/schema_definitions.rb

@@ -5,7 +5,7 @@
 # https://opensource.org/licenses/MIT.
 
 module ActiveRecord
-  module ConnectionAdapters #:nodoc:
+  module ConnectionAdapters # :nodoc:
     module Spanner
       class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
         attr_reader :interleave_in_parent
@@ -62,6 +62,9 @@ module ActiveRecord
       DropIndexDefinition = Struct.new :name
 
       class ReferenceDefinition < ActiveRecord::ConnectionAdapters::ReferenceDefinition
+        # This constructor intentionally does not call super to prevent ActiveRecord
+        # from creating an additional secondary index for the foreign key.
+        # rubocop:disable Lint/MissingSuper
         def initialize \
             name,
             polymorphic: false,
@@ -81,6 +84,7 @@ module ActiveRecord
           return unless polymorphic && foreign_key
           raise ArgumentError, "Cannot add a foreign key to a polymorphic relation"
         end
+        # rubocop:enable Lint/MissingSuper
 
         private
 
@@ -96,8 +100,13 @@ module ActiveRecord
       end
 
       class IndexDefinition < ActiveRecord::ConnectionAdapters::IndexDefinition
-        attr_reader :null_filtered, :interleave_in, :storing, :orders
+        attr_reader :null_filtered
+        attr_reader :interleave_in
+        attr_reader :storing
+        attr_reader :orders
 
+        # This constructor intentionally does not call super.
+        # rubocop:disable Lint/MissingSuper
         def initialize \
             table_name,
             name,
@@ -123,6 +132,7 @@ module ActiveRecord
 
           @orders = @orders.symbolize_keys
         end
+        # rubocop:enable Lint/MissingSuper
 
         def columns_with_order
           columns.each_with_object({}) do |c, result|

data/lib/active_record/connection_adapters/spanner/schema_statements.rb

@@ -109,8 +109,7 @@ module ActiveRecord
         end
 
         def rename_table _table_name, _new_name
-          raise ActiveRecordSpannerAdapter::NotSupportedError, \
-                "rename_table is not implemented"
+          raise ActiveRecordSpannerAdapter::NotSupportedError, "rename_table is not implemented"
         end
 
         # Column
@@ -168,20 +167,14 @@ module ActiveRecord
           execute_schema_statements statements
         end
 
-        if ActiveRecord.gem_version < VERSION_6_1_0
-          def remove_columns table_name, *column_names
-            _remove_columns table_name, *column_names
-          end
-        else
-          def remove_columns table_name, *column_names, _type: nil, **_options
-            _remove_columns table_name, *column_names
-          end
+        def remove_columns table_name, *column_names, _type: nil, **_options
+          _remove_columns table_name, *column_names
         end
 
         def _remove_columns table_name, *column_names
           if column_names.empty?
-            raise ArgumentError, "You must specify at least one column name. "\
-              "Example: remove_columns(:people, :first_name)"
+            raise ArgumentError, "You must specify at least one column name. " \
+                                 "Example: remove_columns(:people, :first_name)"
           end
 
           statements = []
@@ -193,14 +186,8 @@ module ActiveRecord
           execute_schema_statements statements
         end
 
-        if ActiveRecord.gem_version < VERSION_6_1_0
-          def change_column table_name, column_name, type, options = {}
-            _change_column table_name, column_name, type, **options
-          end
-        else
-          def change_column table_name, column_name, type, **options
-            _change_column table_name, column_name, type, **options
-          end
+        def change_column table_name, column_name, type, **options
+          _change_column table_name, column_name, type, **options
         end
 
         def change_column_null table_name, column_name, null, _default = nil
@@ -208,14 +195,12 @@ module ActiveRecord
         end
 
         def change_column_default _table_name, _column_name, _default_or_changes
-          raise ActiveRecordSpannerAdapter::NotSupportedError, \
-                "change column with default value not supported."
+          raise ActiveRecordSpannerAdapter::NotSupportedError, "change column with default value not supported."
         end
 
         def rename_column table_name, column_name, new_column_name
           if ActiveRecord::Base.connection.ddl_batch?
-            raise ActiveRecordSpannerAdapter::NotSupportedError, \
-                  "rename_column in a DDL Batch is not supported."
+            raise ActiveRecordSpannerAdapter::NotSupportedError, "rename_column in a DDL Batch is not supported."
           end
           column = information_schema do |i|
             i.table_column table_name, column_name
@@ -280,16 +265,9 @@ module ActiveRecord
           execute_schema_statements schema_creation.accept(id)
         end
 
-        if ActiveRecord.gem_version < VERSION_6_1_0
-          def remove_index table_name, options = {}
-            index_name = index_name_for_remove table_name, options
-            execute "DROP INDEX #{quote_table_name index_name}"
-          end
-        else
-          def remove_index table_name, column_name = nil, **options
-            index_name = index_name_for_remove table_name, column_name, options
-            execute "DROP INDEX #{quote_table_name index_name}"
-          end
+        def remove_index table_name, column_name = nil, **options
+          index_name = index_name_for_remove table_name, column_name, options
+          execute "DROP INDEX #{quote_table_name index_name}"
         end
 
         def rename_index table_name, old_name, new_name
@@ -358,14 +336,8 @@ module ActiveRecord
           end
         end
 
-        if ActiveRecord.gem_version < VERSION_6_0_3
-          def add_foreign_key from_table, to_table, options = {}
-            _add_foreign_key from_table, to_table, **options
-          end
-        else
-          def add_foreign_key from_table, to_table, **options
-            _add_foreign_key from_table, to_table, **options
-          end
+        def add_foreign_key from_table, to_table, **options
+          _add_foreign_key from_table, to_table, **options
         end
 
         def _add_foreign_key from_table, to_table, **options
@@ -508,8 +480,8 @@ module ActiveRecord
           type ||= column.type
           options[:null] = column.null unless options.key? :null
 
-          if ["STRING", "BYTES"].include? type
-            options[:limit] = column.limit unless options.key? :limit
+          if ["STRING", "BYTES"].include?(type) && !options.key?(:limit)
+            options[:limit] = column.limit
           end
 
           # Only timestamp type can set commit timestamp
@@ -642,8 +614,7 @@ module ActiveRecord
         end
 
         def information_schema
-          info_schema = \
-            ActiveRecordSpannerAdapter::Connection.information_schema @config
+          info_schema = ActiveRecordSpannerAdapter::Connection.information_schema @config
 
           return info_schema unless block_given?
 

data/lib/active_record/connection_adapters/spanner/type_metadata.rb

@@ -14,7 +14,9 @@ module ActiveRecord
 
         include Deduplicable if defined?(Deduplicable)
 
-        attr_reader :ordinal_position, :allow_commit_timestamp, :generated
+        attr_reader :ordinal_position
+        attr_reader :allow_commit_timestamp
+        attr_reader :generated
 
         def initialize type_metadata, ordinal_position: nil, allow_commit_timestamp: nil, generated: nil
           super type_metadata
@@ -33,11 +35,7 @@ module ActiveRecord
         alias eql? ==
 
         def hash
-          TypeMetadata.hash ^
-            __getobj__.hash ^
-            ordinal_position.hash ^
-            allow_commit_timestamp.hash ^
-            generated.hash
+          [TypeMetadata.name, __getobj__, ordinal_position, allow_commit_timestamp, generated].hash
         end
 
         private

data/lib/active_record/connection_adapters/spanner_adapter.rb

@@ -276,7 +276,9 @@ module ActiveRecord
       end
 
       def transform sql
-        if ActiveRecord::VERSION::MAJOR >= 7
+        if ActiveRecord::VERSION::MAJOR >= 8
+          preprocess_query sql
+        elsif ActiveRecord::VERSION::MAJOR == 7
           transform_query sql
         else
           sql
@@ -284,12 +286,23 @@ module ActiveRecord
       end
 
       # Overwrite the standard log method to be able to translate exceptions.
-      def log sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil, *args
-        super
-      rescue ActiveRecord::StatementInvalid
-        raise
-      rescue StandardError => e
-        raise translate_exception_class(e, sql, binds)
+      # sql, name = "SQL", binds = [], type_casted_binds = [], async: false, &block
+      if ActiveRecord::VERSION::MAJOR >= 8
+        def log sql, name = "SQL", binds = [], type_casted_binds = [], async: false, &block
+          super
+        rescue ActiveRecord::StatementInvalid
+          raise
+        rescue StandardError => e
+          raise translate_exception_class(e, sql, binds)
+        end
+      else
+        def log sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil, *args
+          super
+        rescue ActiveRecord::StatementInvalid
+          raise
+        rescue StandardError => e
+          raise translate_exception_class(e, sql, binds)
+        end
       end
 
       def translate_exception exception, message:, sql:, binds:

data/lib/active_record/tasks/spanner_database_tasks.rb

@@ -31,7 +31,7 @@ module ActiveRecord
       def purge
         begin
           drop
-        rescue ActiveRecord::NoDatabaseError # rubocop:disable Lint/HandleExceptions
+        rescue ActiveRecord::NoDatabaseError
           # ignored; create the database
         end
 
@@ -51,8 +51,8 @@ module ActiveRecord
         ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
 
         if ignore_tables.any?
-          index_regx = /^CREATE(.*)INDEX(.*)ON (#{ignore_tables.join "|"})\(/
-          table_regx = /^CREATE TABLE (#{ignore_tables.join "|"})/
+          index_regx = /^CREATE(.*)INDEX(.*)ON (#{ignore_tables.join '|'})\(/
+          table_regx = /^CREATE TABLE (#{ignore_tables.join '|'})/
         end
 
         @connection.database.ddl(force: true).each do |statement|
@@ -66,7 +66,7 @@ module ActiveRecord
       end
 
       def structure_load filename, _extra_flags
-        statements = File.read(filename).split(/;/).map(&:strip).reject(&:empty?)
+        statements = File.read(filename).split(";").map(&:strip).reject(&:empty?)
         ddls = statements.select { |s| s =~ /^(CREATE|ALTER|DROP|GRANT|REVOKE|ANALYZE)/ }
         @connection.execute_ddl ddls
 

data/lib/active_record/type/spanner/array.rb

@@ -9,11 +9,15 @@ module ActiveRecord
     module Spanner
       class Array < Type::Value
         attr_reader :element_type
+
         delegate :type, :user_input_in_time_zone, :limit, :precision, :scale, to: :element_type
 
+        # This constructor intentionally does not call super.
+        # rubocop:disable Lint/MissingSuper
         def initialize element_type
           @element_type = element_type
         end
+        # rubocop:enable Lint/MissingSuper
 
         def cast value
           return super if value.nil?

data/lib/active_record/type/spanner/bytes.rb

@@ -10,6 +10,16 @@ module ActiveRecord
   module Type
     module Spanner
       class Bytes < ActiveRecord::Type::Binary
+        def deserialize value
+          # Set this environment variable to disable de-serializing BYTES
+          # to a StringIO instance.
+          return super if ENV["SPANNER_BYTES_DESERIALIZE_DISABLED"]
+
+          return super value if value.nil?
+          return StringIO.new Base64.strict_decode64(value) if value.is_a? ::String
+          value
+        end
+
         def serialize value
           return super value if value.nil?