activerecord-spanner-adapter 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1a935693a8621d55fd7f51a17ba93dcc598f97789e6b7825ca7c916fbc0c9e1
-  data.tar.gz: 671717a9df5b2d7b6bbf388faea2c9ec6f982906a6456271a8696c2980d62684
+  metadata.gz: 4b10ee1d169ad72da934b5d726114d5b9ac215103c54b607a0fe0c18b2ed4876
+  data.tar.gz: 3a2e65fd406507987da6a38cbcc38130da9a3200e7ad1f2b5909701916903ab8
 SHA512:
-  metadata.gz: 5fa701ba551c2072ad60e6a7aadde8a4c4e20e3262d091c4854fd37d3663cfa353595017a8de229404c37dc7145ef5852c4ac16f531655c54462e419b217d86b
-  data.tar.gz: 24733bae08d92cd3ad8c7ae4cbbdbf016dc845f3f8b1a962bdde535b8df2627c9dc8a62d4d41cad3ec58a295c22de9ccb01924f95c985d1bf6741d647a0fcf4d
+  metadata.gz: 1a842880cf43a9316cb76dba5a9ef0ecf576db7102a1d03a9ecd14308232801bb296701e6b8d1506a78d7895b61eec14f7e9b887e1d44dc075ba576076c2a6c5
+  data.tar.gz: c2c9af94b3d25a19098edfe18c2bb479826ec6996e76ec0c8a3e50280988a0aee694decb8df6452d1a1bb2bee6be1e8338ace5f4bf588d96fa6781de44c13f74

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

@@ -18,7 +18,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1", "3.2"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
         ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4"]
         # Exclude combinations that are not supported.
         exclude:
@@ -28,12 +28,10 @@ jobs:
             ar: "~> 6.0.6"
           - ruby: "3.2"
             ar: "~> 6.0.6"
-          - ruby: "2.6"
-            ar: "~> 7.0.4"
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby
     # (see https://github.com/ruby/setup-ruby#versioning):

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

@@ -26,7 +26,7 @@ jobs:
       matrix:
         ruby: [3.0]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby
     # (see https://github.com/ruby/setup-ruby#versioning):

data/.github/workflows/ci.yaml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1", "3.2"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
         ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4"]
         # Exclude combinations that are not supported.
         exclude:
@@ -20,12 +20,10 @@ jobs:
             ar: "~> 6.0.6"
           - ruby: "3.2"
             ar: "~> 6.0.6"
-          - ruby: "2.6"
-            ar: "~> 7.0.4"
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby
     # (see https://github.com/ruby/setup-ruby#versioning):

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

@@ -19,7 +19,7 @@ jobs:
       max-parallel: 4
       matrix:
         # Run acceptance tests all supported combinations of Ruby and ActiveRecord.
-        ruby: [2.6, 2.7, 3.0, 3.1, 3.2]
+        ruby: [2.7, 3.0, 3.1, 3.2]
         ar: [6.0.0, 6.0.1, 6.0.2.2, 6.0.3.7, 6.0.4, 6.1.3.2, 6.1.4.7, 6.1.5.1, 6.1.6.1, 7.0.2.4, 7.0.3.1, 7.0.4, 7.0.5, 7.0.6, 7.0.7]
         # Exclude combinations that are not supported.
         exclude:
@@ -53,22 +53,10 @@ jobs:
             ar: 6.0.3.7
           - ruby: 3.2
             ar: 6.0.4
-          - ruby: 2.6
-            ar: 7.0.2.4
-          - ruby: 2.6
-            ar: 7.0.3.1
-          - ruby: 2.6
-            ar: 7.0.4
-          - ruby: 2.6
-            ar: 7.0.5
-          - ruby: 2.6
-            ar: 7.0.6
-          - ruby: 2.6
-            ar: 7.0.7
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/nightly-acceptance-tests-on-production.yaml

@@ -12,7 +12,7 @@ jobs:
       matrix:
         ruby: [3.0]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby
     # (see https://github.com/ruby/setup-ruby#versioning):

data/.github/workflows/nightly-unit-tests.yaml

@@ -11,7 +11,7 @@ jobs:
       max-parallel: 4
       matrix:
         # Run unit tests all supported combinations of Ruby and ActiveRecord.
-        ruby: [2.6, 2.7, 3.0, 3.1, 3.2]
+        ruby: [2.7, 3.0, 3.1, 3.2]
         ar: [6.0.0, 6.0.1, 6.0.2.2, 6.0.3.7, 6.0.4, 6.1.3.2, 6.1.4.7, 6.1.5.1, 6.1.6.1, 7.0.2.4, 7.0.3.1, 7.0.4, 7.0.5]
         # Exclude combinations that are not supported.
         exclude:
@@ -45,18 +45,10 @@ jobs:
             ar: 6.0.3.7
           - ruby: 3.2
             ar: 6.0.4
-          - ruby: 2.6
-            ar: 7.0.2.4
-          - ruby: 2.6
-            ar: 7.0.3.1
-          - ruby: 2.6
-            ar: 7.0.4
-          - ruby: 2.6
-            ar: 7.0.5
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/release-please.yml

@@ -18,13 +18,13 @@ jobs:
       RELEASE_PLEASE_DISABLE: ${{ secrets.RELEASE_PLEASE_DISABLE }}
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.0"
       - name: Install NodeJS 16.x
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: "16.x"
       - name: Install tools

data/.github/workflows/rubocop.yaml

@@ -12,7 +12,7 @@ jobs:
     timeout-minutes: 10
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: setup ruby
       uses: ruby/setup-ruby@v1
       with:

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.4.4"
+  ".": "1.5.0"
 }

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+### 1.5.0 (2023-11-03)
+
+#### Features
+
+* Drop support for Ruby 2.6 ([#270](https://github.com/googleapis/ruby-spanner-activerecord/issues/270)) 
+* translate annotate to tags ([#267](https://github.com/googleapis/ruby-spanner-activerecord/issues/267)) 
+#### Documentation
+
+* update README to reference PGAdapter for PG ([#263](https://github.com/googleapis/ruby-spanner-activerecord/issues/263)) 
+* update README to reference PGAdapter for PG ([#263](https://github.com/googleapis/ruby-spanner-activerecord/issues/263)) ([#268](https://github.com/googleapis/ruby-spanner-activerecord/issues/268)) 
+
 ### 1.4.4 (2023-09-06)
 
 #### Bug Fixes

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "activerecord", ENV.fetch("AR_VERSION", "~> 6.1.6.1")
-gem "minitest", "~> 5.18.0"
+gem "minitest", "~> 5.19.0"
 gem "pry", "~> 0.13.0"
 gem "pry-byebug", "~> 3.9.0"
 

data/README.md

@@ -5,12 +5,14 @@
 ![rubocop](https://github.com/googleapis/ruby-spanner-activerecord/workflows/rubocop/badge.svg)
 
 __This adapter only supports GoogleSQL-dialect Cloud Spanner databases. PostgreSQL-dialect
-databases are not supported.__
+databases are not supported. You can use the standard PostgreSQL ActiveRecord adapter in
+[combination with PGAdapter](https://github.com/GoogleCloudPlatform/pgadapter/blob/-/samples/ruby/activerecord)
+for Cloud Spanner PostgreSQL-dialect databases.__
 
 This project provides a Cloud Spanner adapter for ActiveRecord. It supports the following versions:
 
-- ActiveRecord 6.0.x with Ruby 2.6 and 2.7.
-- ActiveRecord 6.1.x with Ruby 2.6 and higher.
+- ActiveRecord 6.0.x with Ruby 2.7.
+- ActiveRecord 6.1.x with Ruby 2.7 and higher.
 - ActiveRecord 7.0.x with Ruby 2.7 and higher.
 
 Known limitations are listed in the [Limitations](#limitations) section.

data/activerecord-spanner-adapter.gemspec

@@ -22,9 +22,9 @@ 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.5"
+  spec.required_ruby_version = ">= 2.7"
 
-  spec.add_dependency "google-cloud-spanner", "~> 2.10"
+  spec.add_dependency "google-cloud-spanner", "~> 2.18"
   spec.add_runtime_dependency "activerecord", [">= 6.0.0", "< 7.1"]
 
   spec.add_development_dependency "autotest-suffix", "~> 1.1"

data/examples/snippets/tags/README.md

@@ -0,0 +1,29 @@
+# Sample - Request tags and Transaction tags
+
+Queries can be annotated with request tags and transaction tags. These can be used to give
+you more insights in your queries and transactions.
+See https://cloud.google.com/spanner/docs/introspection/troubleshooting-with-tags for more
+information about request and transaction tags in Cloud Spanner.
+
+You can use the [`annotate`](https://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-annotate)
+method in Ruby ActiveRecord to add a request and/or transaction tag to a __query__. You must
+prefix the annotation with either `request_tag:` or `transaction_tag:` to instruct the
+Cloud Spanner ActiveRecord provider to recognize the annotation as a tag.
+
+__NOTE:__ Ruby ActiveRecord does not add comments for `INSERT`, `UPDATE` and `DELETE` statements
+when you add annotations to a model. This means that these statements will not be tagged.
+
+Example:
+
+```ruby
+
+```
+
+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/tags/Rakefile

@@ -0,0 +1,13 @@
+# Copyright 2023 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 tag queries on Cloud Spanner with ActiveRecord."
+task :run do
+  Dir.chdir("..") { sh "bundle exec rake run[tags]" }
+end

data/examples/snippets/tags/application.rb

@@ -0,0 +1,32 @@
+# Copyright 2023 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
+    puts ""
+    puts "Query all Albums and include a request tag"
+    albums = Album.annotate("request_tag: query-all-albums").all
+    puts "Queried #{albums.length} albums using a request tag"
+
+    puts ""
+    puts "Query all Albums in a transaction and include a request tag and a transaction tag"
+    Album.transaction do
+      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
+
+Application.run

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

@@ -0,0 +1,8 @@
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  pool: 5
+  timeout: 5000

data/examples/snippets/tags/db/migrate/01_create_tables.rb

@@ -0,0 +1,21 @@
+# Copyright 2023 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.references :singer, index: false, foreign_key: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 1) do
+  connection.start_batch_ddl
+
+  create_table "albums", id: { limit: 8 }, force: :cascade do |t|
+    t.string "title"
+    t.integer "singer_id", limit: 8
+  end
+
+  create_table "singers", id: { limit: 8 }, force: :cascade do |t|
+    t.string "first_name"
+    t.string "last_name"
+  end
+
+  add_foreign_key "albums", "singers"
+  connection.run_batch
+rescue
+  abort_batch
+  raise
+end

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

@@ -0,0 +1,24 @@
+# Copyright 2023 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.rb"
+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"]
+
+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}", singer_id: singer_id
+end

data/examples/snippets/tags/models/album.rb

@@ -0,0 +1,9 @@
+# Copyright 2023 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/tags/models/singer.rb

@@ -0,0 +1,9 @@
+# Copyright 2023 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

@@ -34,6 +34,10 @@ module ActiveRecord
               selector = Google::Cloud::Spanner::Session.single_use_transaction staleness_hint.value
               binds.delete staleness_hint
             end
+            request_options = binds.find { |b| b.is_a? Google::Cloud::Spanner::V1::RequestOptions }
+            if request_options
+              binds.delete request_options
+            end
 
             log_args = [sql, name]
             log_args.concat [binds, type_casted_binds(binds)] if log_statement_binds
@@ -43,10 +47,11 @@ module ActiveRecord
               ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
                 if transaction_required
                   transaction do
-                    @connection.execute_query sql, params: params, types: types
+                    @connection.execute_query sql, params: params, types: types, request_options: request_options
                   end
                 else
-                  @connection.execute_query sql, params: params, types: types, single_use_selector: selector
+                  @connection.execute_query sql, params: params, types: types, single_use_selector: selector,
+                                            request_options: request_options
                 end
               end
             end

data/lib/activerecord_spanner_adapter/connection.rb

@@ -200,7 +200,7 @@ module ActiveRecordSpannerAdapter
 
     # DQL, DML Statements
 
-    def execute_query sql, params: nil, types: nil, single_use_selector: nil
+    def execute_query sql, params: nil, types: nil, single_use_selector: nil, request_options: nil
       if params
         converted_params, types = \
           Google::Cloud::Spanner::Convert.to_input_params_and_types(
@@ -214,15 +214,16 @@ module ActiveRecordSpannerAdapter
       end
 
       selector = transaction_selector || single_use_selector
-      execute_sql_request sql, converted_params, types, selector
+      execute_sql_request sql, converted_params, types, selector, request_options
     end
 
-    def execute_sql_request sql, converted_params, types, selector
+    def execute_sql_request sql, converted_params, types, selector, request_options = nil
       res = session.execute_query \
         sql,
         params: converted_params,
         types: types,
         transaction: selector,
+        request_options: request_options,
         seqno: (current_transaction&.next_sequence_number)
       current_transaction.grpc_transaction = res.metadata.transaction \
           if current_transaction && res&.metadata&.transaction

data/lib/activerecord_spanner_adapter/version.rb

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

data/lib/arel/visitors/spanner.rb

@@ -36,6 +36,7 @@ module Arel # :nodoc: all
 
         if binds
           binds << collector.hints[:staleness] if collector.hints[:staleness]
+          binds << collector.hints[:request_options] if collector.hints[:request_options]
           [sql, binds]
         else
           sql
@@ -94,6 +95,26 @@ module Arel # :nodoc: all
         collector
       end
 
+      def visit_Arel_Nodes_Comment o, collector
+        o.values.each do |v|
+          if v.start_with?("request_tag:") || v.start_with?("transaction_tag:")
+            collector.hints[:request_options] ||= \
+              Google::Cloud::Spanner::V1::RequestOptions.new
+          end
+
+          if v.start_with? "request_tag:"
+            collector.hints[:request_options].request_tag = v.delete_prefix("request_tag:").strip
+            next
+          end
+          if v.start_with? "transaction_tag:"
+            collector.hints[:request_options].transaction_tag = v.delete_prefix("transaction_tag:").strip
+            next
+          end
+        end
+        # Also include the annotations as comments by calling the super implementation.
+        super
+      end
+
       def visit_Arel_Table o, collector
         return super unless collector.table_hints[o.name]
         if o.table_alias

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.18'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -478,6 +478,15 @@ files:
 - examples/snippets/stale-reads/db/seeds.rb
 - examples/snippets/stale-reads/models/album.rb
 - examples/snippets/stale-reads/models/singer.rb
+- examples/snippets/tags/README.md
+- examples/snippets/tags/Rakefile
+- examples/snippets/tags/application.rb
+- examples/snippets/tags/config/database.yml
+- examples/snippets/tags/db/migrate/01_create_tables.rb
+- examples/snippets/tags/db/schema.rb
+- examples/snippets/tags/db/seeds.rb
+- examples/snippets/tags/models/album.rb
+- examples/snippets/tags/models/singer.rb
 - examples/snippets/timestamp-data-type/README.md
 - examples/snippets/timestamp-data-type/Rakefile
 - examples/snippets/timestamp-data-type/application.rb
@@ -532,7 +541,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="