activerecord-spanner-adapter 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 539c47de17139481981cfaaaf2b65d43d8f0b27642ad68663658123d0053a8fb
-  data.tar.gz: c4eb45d075689d08da773ebc11bd1e24df9c6cb7b6ab79a2a352c5c4f4442fbf
+  metadata.gz: cef9bfb6f1e3665c69a3d256455af031c38907bf03d0e2567f9910a2c06b308c
+  data.tar.gz: 2111cd2b6ae24a0f9c7aab481a94228503e3324e517891c0cde832565f60c7ec
 SHA512:
-  metadata.gz: a7d32fa8e2aeeb7785a35f4d11c2dd1ae2db7298d030b6d0da3f08ef5acb2c19833f4f80bc4b5e4b3b174ff9a34121fe97f50ddae902a3af1505eacec311b790
-  data.tar.gz: 1ec5e7a0370d3bbcc3dd8b0c2b7412f81a57f03703784a0b20476d20d9016d409efcd4f3dc8ecd234e64d1cbedcfe804497fd6b65fd277d7feca014393627edf
+  metadata.gz: f2acaa0e795fa93b2681bc039df21517798a289b7dd71e3d02e10eab411684d0716f7b749145c73d6bf195bd1f803fbe90149130bb9c13612a03b55ebff69f93
+  data.tar.gz: fbd6cfe74223e2755c671eca16672dfd2558cb5bb43bdfd87536e1fa4a34be45c5f946e96be48e77391dcf646d8293b0d3d1249068d53fd61eb55908a0530884

data/.github/workflows/acceptance-tests-on-emulator.yaml

@@ -38,7 +38,7 @@ jobs:
     - name: Install dependencies
       run: bundle install
     - name: Run acceptance tests on emulator
-      run: bundle exec rake acceptance
+      run: bundle exec rake acceptance TESTOPTS="-v"
       env:
         SPANNER_EMULATOR_HOST: localhost:9010
         SPANNER_TEST_PROJECT: test-project

data/.github/workflows/ci.yaml

@@ -30,4 +30,4 @@ jobs:
     - name: Install dependencies
       run: bundle install
     - name: Run tests
-      run: bundle exec rake test
+      run: bundle exec rake test TESTOPTS="-v"

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.1.0"
+  ".": "2.2.0"
 }

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 2.2.0 (2025-04-03)
+
+#### Features
+
+* transaction isolation level ([#355](https://github.com/googleapis/ruby-spanner-activerecord/issues/355)) 
+
 ### 2.1.0 (2025-03-17)
 
 #### Features

data/Gemfile

@@ -9,7 +9,7 @@ gem "ostruct"
 gem "minitest", "~> 5.25.0"
 gem "minitest-rg", "~> 5.3.0"
 gem "pry", "~> 0.14.2"
-gem "pry-byebug", "~> 3.10.1"
+gem "pry-byebug", "~> 3.11.0"
 # Add sqlite3 for testing for compatibility with other adapters.
 gem 'sqlite3'
 

data/acceptance/cases/tasks/database_tasks_test.rb

@@ -65,9 +65,9 @@ module ActiveRecord
       end
 
       def drop_database
+        spanner_instance.database(@database_id)&.drop
         ActiveRecord::Base.connection_pool.disconnect!
         ActiveRecordSpannerAdapter::Connection.reset_information_schemas!
-        spanner_instance.database(@database_id)&.drop
       end
 
       def test_structure_dump_and_load

data/acceptance/test_helper.rb

@@ -188,6 +188,7 @@ module SpannerAdapter
         unless @skip_test_table_create
           connection.drop_table :test_models, if_exists: true
         end
+        ActiveRecord::Base.connection_pool.disconnect!
 
         super
       end
@@ -273,8 +274,19 @@ module SpannerAdapter
   ActiveSupport::Notifications.subscribe("sql.active_record", SQLCounter.new)
 end
 
+module Kernel
+  # Monkey-patch Kernel.exit to call exit! instead.
+  # This prevents the tests from getting stuck after running (probably) due to
+  # gRPC connections that have not been closed yet.
+  def exit status = true
+    exit! status
+  end
+end
+
 Minitest.after_run do
   drop_test_database
+  ActiveRecord::Base.connection_pool.disconnect!
+  ActiveRecordSpannerAdapter::Connection.reset_information_schemas!
 end
 
 create_test_database

data/activerecord-spanner-adapter.gemspec

@@ -24,9 +24,8 @@ Gem::Specification.new do |spec|
 
   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_dependency "google-cloud-spanner", "~> 2.25"
+  spec.add_dependency "google-cloud-spanner-v1", "~> 1.7"
   spec.add_runtime_dependency "activerecord", [">= 7.0", "< 9"]
 
   spec.add_development_dependency "autotest-suffix", "~> 1.1"

data/examples/snippets/isolation-level/README.md

@@ -0,0 +1,39 @@
+# Sample - Isolation Level
+
+This example shows how to use a specific isolation level for read/write transactions
+using the Spanner ActiveRecord adapter.
+
+You can specify the isolation level in two ways:
+
+1. Set a default in the database configuration:
+
+```yaml
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  isolation_level: :serializable,
+  pool: 5
+  timeout: 5000
+  schema_dump: false
+```
+
+2. Specify the isolation level for a specific transaction. This will override any
+   default that is set in the database configuration.
+
+```ruby
+ActiveRecord::Base.transaction isolation: :repeatable_read do
+  # Execute transaction code...
+end
+```
+
+The sample will automatically start a Spanner Emulator in a Docker container and execute the sample
+against that emulator. The emulator will automatically be stopped when the application finishes.
+
+Run the application with the command
+
+```bash
+bundle exec rake run
+```

data/examples/snippets/isolation-level/Rakefile

@@ -0,0 +1,13 @@
+# 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.
+
+require_relative "../config/environment"
+require "sinatra/activerecord/rake"
+
+desc "Sample showing how to specify a transaction isolation level for Spanner with ActiveRecord."
+task :run do
+  Dir.chdir("..") { sh "bundle exec rake run[isolation-level]" }
+end

data/examples/snippets/isolation-level/application.rb

@@ -0,0 +1,36 @@
+# 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.
+
+require "io/console"
+require_relative "../config/environment"
+require_relative "models/singer"
+require_relative "models/album"
+
+class Application
+  def self.run # rubocop:disable Metrics/AbcSize
+    from_album = nil
+    to_album = nil
+    # Execute a read/write transaction using isolation level repeatable read.
+    puts "Executing a read/write transaction using isolation level repeatable read"
+    ActiveRecord::Base.transaction isolation: :repeatable_read do
+      # Transfer a marketing budget of 10,000 from one album to another.
+      from_album = Album.all.sample
+      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}) " \
+           "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
+    end
+    puts ""
+    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}"
+  end
+end
+
+Application.run

data/examples/snippets/isolation-level/config/database.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  isolation_level: :serializable,
+  pool: 5
+  timeout: 5000
+  schema_dump: false

data/examples/snippets/isolation-level/db/migrate/01_create_tables.rb

@@ -0,0 +1,22 @@
+# Copyright 2021 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.
+
+class CreateTables < ActiveRecord::Migration[6.0]
+  def change
+    connection.ddl_batch do
+      create_table :singers do |t|
+        t.string :first_name
+        t.string :last_name
+      end
+
+      create_table :albums do |t|
+        t.string :title
+        t.numeric :marketing_budget
+        t.references :singer, index: false, foreign_key: true
+      end
+    end
+  end
+end

data/examples/snippets/isolation-level/db/seeds.rb

@@ -0,0 +1,25 @@
+# Copyright 2021 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.
+
+require_relative "../../config/environment"
+require_relative "../models/singer"
+require_relative "../models/album"
+
+first_names = ["Pete", "Alice", "John", "Ethel", "Trudy", "Naomi", "Wendy", "Ruben", "Thomas", "Elly"]
+last_names = ["Wendelson", "Allison", "Peterson", "Johnson", "Henderson", "Ericsson", "Aronson", "Tennet", "Courtou"]
+
+adjectives = ["daily", "happy", "blue", "generous", "cooked", "bad", "open"]
+nouns = ["windows", "potatoes", "bank", "street", "tree", "glass", "bottle"]
+budgets = [15000, 25000, 10000, 20000, 30000, 12000, 13000]
+
+5.times do
+  Singer.create first_name: first_names.sample, last_name: last_names.sample
+end
+
+20.times do
+  singer_id = Singer.all.sample.id
+  Album.create title: "#{adjectives.sample} #{nouns.sample}", marketing_budget: budgets.sample, singer_id: singer_id
+end

data/examples/snippets/isolation-level/models/album.rb

@@ -0,0 +1,9 @@
+# Copyright 2021 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.
+
+class Album < ActiveRecord::Base
+  belongs_to :singer
+end

data/examples/snippets/isolation-level/models/singer.rb

@@ -0,0 +1,9 @@
+# Copyright 2021 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.
+
+class Singer < ActiveRecord::Base
+  has_many :albums
+end

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

@@ -292,7 +292,7 @@ module ActiveRecord
               if isolation.count != 1
           else
             raise "Unsupported isolation level: #{isolation}" unless
-              [:serializable, :read_only, :buffered_mutations, :pdml].include? isolation
+              [:serializable, :repeatable_read, :read_only, :buffered_mutations, :pdml].include? isolation
           end
 
           log "BEGIN #{isolation}" do

data/lib/active_record/connection_adapters/spanner_adapter.rb

@@ -150,7 +150,8 @@ module ActiveRecord
       end
 
       # Spanner Connection API
-      delegate :ddl_batch, :ddl_batch?, :start_batch_ddl, :abort_batch, :run_batch, to: :@connection
+      delegate :ddl_batch, :ddl_batch?, :start_batch_ddl, :abort_batch, :run_batch,
+               :isolation_level, :isolation_level=, to: :@connection
 
       def current_spanner_transaction
         @connection.current_transaction
@@ -170,6 +171,10 @@ module ActiveRecord
         false
       end
 
+      def supports_transaction_isolation?
+        true
+      end
+
       def supports_foreign_keys?
         true
       end

data/lib/activerecord_spanner_adapter/connection.rb

@@ -14,10 +14,12 @@ module ActiveRecordSpannerAdapter
     attr_reader :database_id
     attr_reader :spanner
     attr_accessor :current_transaction
+    attr_accessor :isolation_level
 
     def initialize config
       @instance_id = config[:instance]
       @database_id = config[:database]
+      @isolation_level = config[:isolation_level]
       @spanner = self.class.spanners config
     end
 
@@ -42,6 +44,9 @@ module ActiveRecordSpannerAdapter
     # Call this method if you drop and recreate a database with the same name
     # to prevent the cached information to be used for the new database.
     def self.reset_information_schemas!
+      @information_schemas.each_value do |info_schema|
+        info_schema.connection.disconnect!
+      end
       @information_schemas = {}
     end
 
@@ -271,7 +276,7 @@ module ActiveRecordSpannerAdapter
 
     def begin_transaction isolation = nil
       raise "Nested transactions are not allowed" if current_transaction&.active?
-      self.current_transaction = Transaction.new self, isolation
+      self.current_transaction = Transaction.new self, isolation || @isolation_level
       current_transaction.begin
       current_transaction
     end

data/lib/activerecord_spanner_adapter/transaction.rb

@@ -55,11 +55,12 @@ module ActiveRecordSpannerAdapter
         when :pdml
           @grpc_transaction = @connection.session.create_pdml
         else
+          grpc_isolation = _transaction_isolation_level_to_grpc @isolation
           @begin_transaction_selector = Google::Cloud::Spanner::V1::TransactionSelector.new \
             begin: Google::Cloud::Spanner::V1::TransactionOptions.new(
-              read_write: Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite.new
+              read_write: Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite.new,
+              isolation_level: grpc_isolation
             )
-
         end
         @state = :STARTED
       rescue Google::Cloud::NotFoundError => e
@@ -75,6 +76,15 @@ module ActiveRecordSpannerAdapter
       end
     end
 
+    def _transaction_isolation_level_to_grpc isolation
+      case isolation
+      when :serializable
+        Google::Cloud::Spanner::V1::TransactionOptions::IsolationLevel::SERIALIZABLE
+      when :repeatable_read
+        Google::Cloud::Spanner::V1::TransactionOptions::IsolationLevel::REPEATABLE_READ
+      end
+    end
+
     # Forces a BeginTransaction RPC for a read/write transaction. This is used by a
     # connection if the first statement of a transaction failed.
     def force_begin_read_write

data/lib/activerecord_spanner_adapter/version.rb

@@ -5,5 +5,5 @@
 # https://opensource.org/licenses/MIT.
 
 module ActiveRecordSpannerAdapter
-  VERSION = "2.1.0".freeze
+  VERSION = "2.2.0".freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Google LLC
 bindir: exe
 cert_chain: []
-date: 2025-03-17 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.25'
 - !ruby/object:Gem::Dependency
-  name: grpc
+  name: google-cloud-spanner-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.3
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.3
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -439,6 +439,14 @@ files:
 - examples/snippets/interleaved-tables/models/album.rb
 - examples/snippets/interleaved-tables/models/singer.rb
 - examples/snippets/interleaved-tables/models/track.rb
+- examples/snippets/isolation-level/README.md
+- examples/snippets/isolation-level/Rakefile
+- examples/snippets/isolation-level/application.rb
+- examples/snippets/isolation-level/config/database.yml
+- examples/snippets/isolation-level/db/migrate/01_create_tables.rb
+- examples/snippets/isolation-level/db/seeds.rb
+- examples/snippets/isolation-level/models/album.rb
+- examples/snippets/isolation-level/models/singer.rb
 - examples/snippets/migrations/README.md
 - examples/snippets/migrations/Rakefile
 - examples/snippets/migrations/application.rb