activerecord-spanner-adapter 1.6.3 → 2.0.0

data/acceptance/cases/migration/schema_dumper_test.rb

@@ -17,15 +17,27 @@ module ActiveRecord
         ActiveRecord::gem_version >= Gem::Version.create('7.1.0')
       end
 
+      def is_7_2_or_higher?
+        ActiveRecord::gem_version >= Gem::Version.create('7.2.0')
+      end
+
+      def pool_or_connection
+        if is_7_2_or_higher?
+          ActiveRecord::Base.connection_pool
+        else
+          ActiveRecord::Base.connection
+        end
+      end
+
       def test_dump_schema_contains_start_batch_ddl
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert schema.string.include?("connection.start_batch_ddl")
       end
 
       def test_dump_schema_contains_run_batch
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert schema.string.include?("  connection.run_batch\n"\
@@ -35,7 +47,7 @@ module ActiveRecord
       end
 
       def test_dump_schema_contains_albums_table
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         sql = schema.string
@@ -47,42 +59,42 @@ module ActiveRecord
       end
 
       def test_dump_schema_contains_interleaved_index
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert schema.string.include?("t.index [\"singerid\", \"albumid\", \"title\"], name: \"index_tracks_on_singerid_and_albumid_and_title\", order: { singerid: :asc, albumid: :asc, title: :asc }, null_filtered: true, interleave_in: \"albums\""), schema.string
       end
 
       def test_dump_schema_should_not_contain_id_limit
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert !schema.string.include?("id: { limit: 8 }")
       end
 
       def test_dump_schema_contains_commit_timestamp
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert schema.string.include?("t.time \"last_updated\", allow_commit_timestamp: true"), schema.string
       end
 
       def test_dump_schema_contains_virtual_column
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert schema.string.include?("t.virtual \"full_name\", type: :string, as: \"COALESCE(first_name || ' ', '') || last_name\", stored: true"), schema.string
       end
 
       def test_dump_schema_contains_string_array
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert schema.string.include?("t.string \"col_array_string\", array: true"), schema.string
       end
 
       def test_dump_schema_index_storing
-        connection = ActiveRecord::Base.connection
+        connection = pool_or_connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
         assert schema.string.include?("t.index [\"last_name\"], name: \"index_singers_on_last_name\", order: { last_name: :asc }, storing: [\"first_name\", \"tracks_count\"]"), schema.string

data/acceptance/cases/models/binary_identifiers.rb

@@ -0,0 +1,97 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "test_helpers/with_separate_database"
+require_relative "../../models/user"
+require_relative "../../models/binary_project"
+
+module Models
+  class DefaultValueTest < SpannerAdapter::TestCase
+    include TestHelpers::WithSeparateDatabase
+
+    def setup
+      super
+
+      connection.create_table :users, id: :binary do |t|
+        t.string :email, null: false
+        t.string :full_name, null: false
+      end
+      connection.create_table :binary_projects, id: :binary do |t|
+        t.string :name, null: false
+        t.string :description, null: false
+        t.binary :owner_id, null: false
+        t.foreign_key :users, column: :owner_id
+      end
+    end
+
+    def test_includes_works
+      user = User.create!(
+        email: "test@example.com",
+        full_name: "Test User"
+      )
+      3.times do |i|
+        Project.create!(
+          name: "Project #{i}",
+          description: "Description #{i}",
+          owner: user
+        )
+      end
+
+      # First verify the association works without includes
+      projects = Project.all
+      assert_equal 3, projects.count
+
+      # Compare the base64 content instead of the StringIO objects
+      first_project = projects.first
+      assert_equal to_base64(user.id), to_base64(first_project.owner_id)
+
+      # Now verify includes is working
+      query_count = count_queries do
+        loaded_projects = Project.includes(:owner).to_a
+        loaded_projects.each do |project|
+          # Access the owner to ensure it's preloaded
+          assert_equal user.full_name, project.owner.full_name
+        end
+        assert_equal 3, loaded_projects.count
+      end
+
+      # Spanner should execute 2 queries: one for projects and one for users
+      assert_equal 2, query_count
+
+      user = User.all.includes(:projects).first
+      assert user
+      project_count = 0
+      user.projects.each do |_|
+        project_count += 1
+      end
+      assert_equal 3, project_count
+      assert_equal 3, user.projects.count
+    end
+
+    private
+
+    def to_base64 buffer
+      buffer.rewind
+      value = buffer.read
+      Base64.strict_encode64 value.force_encoding("ASCII-8BIT")
+    end
+
+    def count_queries(&block)
+      count = 0
+      counter_fn = ->(name, started, finished, unique_id, payload) {
+        unless %w[CACHE SCHEMA].include?(payload[:name])
+          count += 1
+        end
+      }
+
+      ActiveSupport::Notifications.subscribed(counter_fn, "sql.active_record", &block)
+      count
+    end
+  end
+end

data/acceptance/cases/models/insert_all_test.rb

@@ -30,13 +30,24 @@ module ActiveRecord
           { id: Author.next_sequence_value, name: "Carol" },
         ]
 
-        assert_raise(NotImplementedError) { Author.insert_all(values) }
+        Author.insert_all(values)
+
+        authors = Author.all.order(:name)
+
+        assert_equal "Alice", authors[0].name
+        assert_equal "Bob", authors[1].name
+        assert_equal "Carol", authors[2].name
       end
 
       def test_insert
         value = { id: Author.next_sequence_value, name: "Alice" }
 
-        assert_raise(NotImplementedError) { Author.insert(value) }
+        Author.insert(value)
+
+        authors = Author.all.order(:name)
+
+        assert_equal 1, authors.length
+        assert_equal "Alice", authors[0].name
       end
 
       def test_insert_all!
@@ -136,12 +147,16 @@ module ActiveRecord
           { id: Author.next_sequence_value, name: "Carol" },
         ]
 
-        err = assert_raise(NotImplementedError) do
-          ActiveRecord::Base.transaction do
-            Author.upsert_all(values)
-          end
+        ActiveRecord::Base.transaction do
+          Author.upsert_all(values)
         end
-        assert_match "Use upsert outside a transaction block", err.message
+
+        authors = Author.all.order(:name)
+
+        assert_equal 3, authors.length
+        assert_equal "Alice", authors[0].name
+        assert_equal "Bob", authors[1].name
+        assert_equal "Carol", authors[2].name
       end
 
       def test_upsert_all_with_buffered_mutation_transaction

data/acceptance/cases/sessions/session_not_found_test.rb

@@ -51,6 +51,8 @@ module ActiveRecord
         sessions.each do |session|
           client.delete_session Google::Cloud::Spanner::V1::DeleteSessionRequest.new name: session.name
         end
+        # Wait a bit to ensure that the sessions are really deleted.
+        sleep 5 unless ENV["SPANNER_EMULATOR_HOST"]
       end
 
       def test_single_read

data/acceptance/cases/tasks/database_tasks_test.rb

@@ -48,6 +48,7 @@ module ActiveRecord
       end
 
       def teardown
+        drop_database
         ActiveRecord::Base.connection_pool.disconnect!
         FileUtils.rm_rf ActiveRecord::Tasks::DatabaseTasks.db_dir
         ActiveRecord::Tasks::DatabaseTasks.db_dir = @original_db_dir

data/acceptance/models/binary_project.rb

@@ -0,0 +1,20 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+require_relative 'string_io'
+
+class BinaryProject < ActiveRecord::Base
+  belongs_to :owner, class_name: 'User'
+
+  before_create :set_uuid
+  private
+
+  def set_uuid
+    self.id ||= StringIO.new(SecureRandom.random_bytes(16))
+  end
+end

data/acceptance/models/string_io.rb

@@ -0,0 +1,28 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+# Add equality and hash functions to StringIO to use it for sets.
+class StringIO
+  def ==(o)
+    o.class == self.class && self.to_base64 == o.to_base64
+  end
+
+  def eql?(o)
+    self == o
+  end
+
+  def hash
+    to_base64.hash
+  end
+
+  def to_base64
+    self.rewind
+    value = self.read
+    Base64.strict_encode64 value.force_encoding("ASCII-8BIT")
+  end
+end

data/acceptance/models/user.rb

@@ -0,0 +1,20 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+require_relative 'string_io'
+
+class User < ActiveRecord::Base
+  has_many :binary_projects, foreign_key: :owner_id
+
+  before_create :set_uuid
+  private
+
+  def set_uuid
+    self.id ||= StringIO.new(SecureRandom.random_bytes(16))
+  end
+end

data/acceptance/test_helper.rb

@@ -5,9 +5,11 @@
 # https://opensource.org/licenses/MIT.
 
 gem "minitest"
+require "logger" # https://github.com/rails/rails/issues/54260
 require "minitest/autorun"
 require "minitest/focus"
 require "minitest/rg"
+require "ostruct"
 require "active_support"
 require "google/cloud/spanner"
 require "active_record"
@@ -18,7 +20,10 @@ require "securerandom"
 require "composite_primary_keys" if ActiveRecord::gem_version < Gem::Version.create('7.1.0')
 
 # rubocop:disable Style/GlobalVars
-
+#
+if ActiveRecord.gem_version >= Gem::Version.create("7.2.0")
+  ActiveRecord::ConnectionAdapters.register("spanner", "ActiveRecord::ConnectionAdapters::SpannerAdapter")
+end
 $spanner_test_database = "ar-test-#{SecureRandom.hex 4}"
 
 def connector_config

data/activerecord-spanner-adapter.gemspec

@@ -22,16 +22,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename f }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.7"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.add_dependency "google-cloud-spanner", "~> 2.18"
   # Pin gRPC to 1.64.3, as 1.65 and 1.66 cause test runs to hang randomly.
   spec.add_dependency "grpc", "1.64.3"
-  spec.add_runtime_dependency "activerecord", [">= 6.0.0", "< 7.2"]
+  spec.add_runtime_dependency "activerecord", [">= 6.1", "< 9"]
 
   spec.add_development_dependency "autotest-suffix", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "google-style", "~> 1.24.0"
+  spec.add_development_dependency "google-style", "~> 1.30.1"
   spec.add_development_dependency "minitest", "~> 5.10"
   spec.add_development_dependency "minitest-autotest", "~> 1.0"
   spec.add_development_dependency "minitest-focus", "~> 1.1"

data/benchmarks/application.rb

@@ -63,7 +63,7 @@ class Application
 
     puts ""
     puts "Press any key to end the application"
-    STDIN.getch
+    $stdin.getch
   end
 
   def self.execute_individual_benchmarks singer, client
@@ -120,9 +120,7 @@ class Application
       sql = "SELECT * FROM Singers WHERE id=@id"
       params = { id: singer[:id] }
       param_types = { id: :INT64 }
-      client.execute(sql, params: params, types: param_types).rows.each do |row|
-        return row
-      end
+      client.execute(sql, params: params, types: param_types).rows.first(1)
     else
       Singer.find singer.id
     end
@@ -134,9 +132,7 @@ class Application
       sql = "SELECT * FROM Singers WHERE id=@id"
       params = { id: singer[:id] }
       param_types = { id: :INT64 }
-      client.execute(sql, params: params, types: param_types).rows.each do |row|
-        return row
-      end
+      client.execute(sql, params: params, types: param_types).rows.first(1)
     else
       singer.reload
     end

data/examples/snippets/Rakefile

@@ -7,19 +7,37 @@
 require_relative "config/environment"
 require "docker"
 
-desc "Lists all available samples."
-task :list do
-  samples = Dir.entries(".").select do |entry|
+def fetch_samples
+  Dir.entries(".").select do |entry|
     File.directory?(File.join(".", entry)) \
-     && !%w[. ..].include?(entry) \
-     && File.exist?(File.join(".", entry, "application.rb"))
+      && !%w[. ..].include?(entry) \
+      && File.exist?(File.join(".", entry, "application.rb"))
   end
+end
+
+desc "Lists all available samples."
+task :list do
+  samples = fetch_samples
   puts "Available samples: "
   samples.sort.each { |dir| puts "  #{dir}" }
   puts ""
   puts "Run a sample with the command `bundle exec rake run\\[<sample-name>\\]`"
 end
 
+desc "Runs all samples."
+task :all do
+  samples = fetch_samples
+  ar_version = ENV.fetch "AR_VERSION", "~> 7.1.0"
+  less_than_7_1 = ar_version.dup.to_s.sub("~>", "").strip < "7.1.0"
+  samples.delete "interleaved-tables" if less_than_7_1
+  samples.delete "interleaved-tables-before-7.1" unless less_than_7_1
+  samples.delete "bit-reversed-sequence" if less_than_7_1
+  samples.delete "query-logs" if less_than_7_1
+  samples.each do |sample|
+    run_sample sample
+  end
+end
+
 desc "Runs a simple ActiveRecord tutorial on a Spanner emulator."
 task :run, [:sample] do |_t, args|
   sample = args[:sample]
@@ -28,7 +46,11 @@ task :run, [:sample] do |_t, args|
     puts ""
     sample = "quickstart"
   end
+  run_sample sample
+end
 
+def run_sample sample
+  puts "Running #{sample}"
   puts "Downloading Spanner emulator image..."
   Docker::Image.create "fromImage" => "gcr.io/cloud-spanner-emulator/emulator:latest"
   puts "Creating Spanner emulator container..."

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

@@ -9,7 +9,7 @@ require_relative "../config/environment"
 require_relative "models/entity_with_array_types"
 
 class Application
-  def self.run # rubocop:disable Metrics/AbcSize
+  def self.run
     # Create a record with all array types.
     record = EntityWithArrayTypes.create \
       col_array_string: ["value1", "value2", "value3"],
@@ -35,10 +35,6 @@ class Application
     puts "Bytes array: #{record.col_array_bytes.map(&:read)}"
     puts "Date array: #{record.col_array_date}"
     puts "Timestamp array: #{record.col_array_timestamp}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

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

data/examples/snippets/bit-reversed-sequence/application.rb

@@ -22,10 +22,6 @@ class Application
 
     # List all singers, albums and tracks.
     list_singers_albums
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 
   def self.find_album singerid, albumid

data/examples/snippets/bit-reversed-sequence/config/database.yml

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

data/examples/snippets/bit-reversed-sequence/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"
 
@@ -14,7 +14,7 @@ last_names = %w[Wendelson Allison Peterson Johnson Henderson Ericsson Aronson Te
 adjectives = %w[daily happy blue generous cooked bad open]
 nouns = %w[windows potatoes bank street tree glass bottle]
 
-# Note: We do not use mutations to insert these rows, because letting the database generate the primary key means that
+# NOTE: We do not use mutations to insert these rows, because letting the database generate the primary key means that
 # we rely on a `THEN RETURN id` clause in the insert statement. This is only supported for DML statements, and not for
 # mutations.
 ActiveRecord::Base.transaction do

data/examples/snippets/bulk-insert/application.rb

@@ -46,7 +46,7 @@ class Application
       ]
     end
     puts ""
-    puts "Created a batch of #{singers.length} singers and #{albums.length} "\
+    puts "Created a batch of #{singers.length} singers and #{albums.length} " \
          "albums using a transaction with buffered mutations:"
     singers.each do |s|
       puts "  Created singer #{s.first_name} #{s.last_name} with id #{s.id}"
@@ -54,10 +54,6 @@ class Application
         puts "    with album #{a.title} with id #{a.id}"
       end
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/bulk-insert/config/database.yml

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

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

@@ -43,10 +43,6 @@ class Application
     puts "Singer and album updated:"
     puts "#{singer.first_name} #{singer.last_name} (Last updated: #{singer.last_updated.strftime format})"
     puts "   #{album.title} (Last updated: #{album.last_updated.strftime format})"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

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

data/examples/snippets/config/environment.rb

@@ -4,11 +4,16 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
+require "logger" # https://github.com/rails/rails/issues/54260
 require "active_record"
 require "bundler"
 
 Dir["../../lib/*.rb"].each { |file| require file }
 
+if ActiveRecord.version >= Gem::Version.create("7.2.0")
+  ActiveRecord::ConnectionAdapters.register "spanner", "ActiveRecord::ConnectionAdapters::SpannerAdapter"
+end
+
 Bundler.require
 
 ActiveRecord::Base.establish_connection(

data/examples/snippets/create-records/application.rb

@@ -13,7 +13,7 @@ class Application
   def self.run
     # Creating a single record without an explicit transaction will automatically save it to the database.
     # It is not recommended to call Entity.create repeatedly to insert multiple records, as each call will
-    # use a separate Spanner transaction. Instead multiple records should be created by passing an array of
+    # use a separate Spanner transaction. Instead, multiple records should be created by passing an array of
     # entities to the Entity.create method.
     singer = Singer.create first_name: "Dave", last_name: "Allison"
     puts ""
@@ -32,10 +32,6 @@ class Application
     singers.each do |s|
       puts "  Created singer #{s.first_name} #{s.last_name} with id #{s.id}"
     end
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/create-records/config/database.yml

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

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

@@ -17,7 +17,7 @@ class Application
       puts "#{"#{singer.first_name} #{singer.last_name}".ljust 30}#{singer.birth_date}"
     end
 
-    # Update the birth date of a random singer using the current system time. Any time and timezone information will be
+    # Update the birthdate of a random singer using the current system time. Any time and timezone information will be
     # lost after saving the record as a DATE only contains the year, month and day-of-month information.
     singer = Singer.all.sample
     singer.update birth_date: Time.now
@@ -25,10 +25,6 @@ class Application
     puts ""
     puts "Updated birth date to current system time:"
     puts "#{"#{singer.first_name} #{singer.last_name}".ljust 30}#{singer.birth_date}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

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

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

data/examples/snippets/date-data-type/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"
 
 first_names = %w[Nelson Todd William Alex Dominique Adenoid Steve Nathan Beverly Annie Amy Norma Diana Regan Phyllis]

data/examples/snippets/generated-column/application.rb

@@ -27,10 +27,6 @@ class Application
     singer.reload
     puts ""
     puts "Singer updated: #{singer.full_name}"
-
-    puts ""
-    puts "Press any key to end the application"
-    STDIN.getch
   end
 end
 

data/examples/snippets/generated-column/config/database.yml

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