activerecord-spanner-adapter 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b10ee1d169ad72da934b5d726114d5b9ac215103c54b607a0fe0c18b2ed4876
-  data.tar.gz: 3a2e65fd406507987da6a38cbcc38130da9a3200e7ad1f2b5909701916903ab8
+  metadata.gz: 2ad2384bb1890bb224c89a146c42f615f89c6e2892848da5e701a091d90fa95b
+  data.tar.gz: 0e8a9c608068ff30011bc9bca68b10ab0d22b910260a37a6d4a492365adf78b0
 SHA512:
-  metadata.gz: 1a842880cf43a9316cb76dba5a9ef0ecf576db7102a1d03a9ecd14308232801bb296701e6b8d1506a78d7895b61eec14f7e9b887e1d44dc075ba576076c2a6c5
-  data.tar.gz: c2c9af94b3d25a19098edfe18c2bb479826ec6996e76ec0c8a3e50280988a0aee694decb8df6452d1a1bb2bee6be1e8338ace5f4bf588d96fa6781de44c13f74
+  metadata.gz: 1894765bbc1e3dfac270d73199a4f235ae95724ca18145d6850cce27c38ef2018b59e9035cf2fa91bc30d3f650e080b8eea58c3e91a66035db3a4d07c35ca1be
+  data.tar.gz: 4a9b93d7990fa78f901864bed816e75ff5d0f9da34a530c7107f475d8fd06dc71817fbf8b2c1e0262e4656bf7ab363917ecf7b7c82315b6d5fa84cce0d22489d

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

@@ -19,7 +19,7 @@ jobs:
       max-parallel: 4
       matrix:
         ruby: ["2.7", "3.0", "3.1", "3.2"]
-        ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4"]
+        ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4", "~> 7.1.0"]
         # Exclude combinations that are not supported.
         exclude:
           - ruby: "3.0"

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

@@ -34,12 +34,14 @@ jobs:
       with:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
+    - name: Authenticate Google Cloud
+      uses: google-github-actions/auth@v2
+      with:
+        credentials_json: ${{ secrets.GCP_SA_KEY }}
     - name: Setup GCloud
-      uses: google-github-actions/setup-gcloud@v0
+      uses: google-github-actions/setup-gcloud@v2
       with:
         project_id: ${{ secrets.GCP_PROJECT_ID }}
-        service_account_key: ${{ secrets.GCP_SA_KEY }}
-        export_default_credentials: true
     - name: Install dependencies
       run: bundle install
     - name: Run acceptance tests on production

data/.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ jobs:
       max-parallel: 4
       matrix:
         ruby: ["2.7", "3.0", "3.1", "3.2"]
-        ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4"]
+        ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4", "~> 7.1.0"]
         # Exclude combinations that are not supported.
         exclude:
           - ruby: "3.0"

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

@@ -20,7 +20,7 @@ jobs:
       matrix:
         # Run acceptance tests all supported combinations of Ruby and ActiveRecord.
         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]
+        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, 7.1.0, 7.1.1, 7.1.2]
         # Exclude combinations that are not supported.
         exclude:
           - ruby: 3.0

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

@@ -20,12 +20,14 @@ jobs:
       with:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
+    - name: Authenticate Google Cloud
+      uses: google-github-actions/auth@v2
+      with:
+        credentials_json: ${{ secrets.GCP_SA_KEY }}
     - name: Setup GCloud
-      uses: google-github-actions/setup-gcloud@v0
+      uses: google-github-actions/setup-gcloud@v2
       with:
         project_id: ${{ secrets.GCP_PROJECT_ID }}
-        service_account_key: ${{ secrets.GCP_SA_KEY }}
-        export_default_credentials: true
     - name: Install dependencies
       run: bundle install
     - name: Run acceptance tests on production

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

@@ -12,7 +12,7 @@ jobs:
       matrix:
         # Run unit tests all supported combinations of Ruby and ActiveRecord.
         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]
+        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.1.0, 7.1.1, 7.1.2]
         # Exclude combinations that are not supported.
         exclude:
           - ruby: 3.0

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

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ReleaseLabel
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           github-token: ${{secrets.YOSHI_APPROVER_TOKEN}}
           script: |

data/.release-please-manifest.json

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

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+### 1.6.0 (2023-12-20)
+
+#### Features
+
+* interleaved tables with built-in composite pk ([#282](https://github.com/googleapis/ruby-spanner-activerecord/issues/282)) 
+* support Query Logs ([#291](https://github.com/googleapis/ruby-spanner-activerecord/issues/291)) 
+* support Rails 7.1 ([#278](https://github.com/googleapis/ruby-spanner-activerecord/issues/278)) 
+
+### 1.5.1 (2023-12-12)
+
+#### Bug Fixes
+
+* more permissive arg passthrough for insert_all and upsert_all ([#283](https://github.com/googleapis/ruby-spanner-activerecord/issues/283)) 
+
 ### 1.5.0 (2023-11-03)
 
 #### Features

data/Gemfile

@@ -4,12 +4,15 @@ source "https://rubygems.org"
 gemspec
 
 gem "activerecord", ENV.fetch("AR_VERSION", "~> 6.1.6.1")
-gem "minitest", "~> 5.19.0"
+gem "minitest", "~> 5.20.0"
+gem "minitest-rg", "~> 5.3.0"
 gem "pry", "~> 0.13.0"
 gem "pry-byebug", "~> 3.9.0"
 
 # Required for samples and testing.
-gem "composite_primary_keys"
+install_if -> { ENV.fetch("AR_VERSION", "~> 6.1.6.1").dup.to_s.sub!("~>", "").strip < "7.1.0" && !ENV["SKIP_COMPOSITE_PK"] } do
+  gem "composite_primary_keys"
+end
 
 # Required for samples
 gem "docker-api"

data/README.md

@@ -84,19 +84,19 @@ Some noteworthy examples in the snippets directory:
   for inserting, updating and deleting data in a Cloud Spanner database. Mutations can have a significant performance
   advantage compared to DML statements, but do not allow read-your-writes semantics during a transaction.
 - [array-data-type](examples/snippets/array-data-type): Shows how to work with `ARRAY` data types.
-- [interleaved-tables](examples/snippets/interleaved-tables): Shows how to work with [Interleaved Tables](https://cloud.google.com/spanner/docs/schema-and-data-model#create-interleaved-tables).
+- [interleaved-tables](examples/snippets/interleaved-tables-before-7.1): Shows how to work with [Interleaved Tables](https://cloud.google.com/spanner/docs/schema-and-data-model#create-interleaved-tables).
 
 ## Limitations
 
-Limitation|Comment|Resolution
----|---|---
-Interleaved tables require composite primary keys| Cloud Spanner requires composite primary keys for interleaved tables. See {file:examples/snippets/interleaved-tables/README.md this example} for an example on how to use interleaved tables with ActiveRecord |Use composite primary keys.
-Lack of sequential and auto-assigned IDs|Cloud Spanner doesn't autogenerate IDs and this integration instead creates UUID4 to avoid [hotspotting](https://cloud.google.com/spanner/docs/schema-design#uuid_primary_key) so you SHOULD NOT rely on IDs being sorted| UUID4s are automatically generated for primary keys.
-Table without Primary Key| Cloud Spanner support does not support tables without a primary key.| Always define a primary key for your table.
-Table names CANNOT have spaces within them whether back-ticked or not|Cloud Spanner DOES NOT support tables with spaces in them for example `Entity ID`|Ensure that your table names don't contain spaces.
-Table names CANNOT have punctuation marks and MUST contain valid UTF-8|Cloud Spanner DOES NOT support punctuation marks e.g. periods ".", question marks "?" in table names|Ensure that your table names don't contain punctuation marks.
-Index with fields length [add_index](https://apidock.com/rails/v5.2.3/ActiveRecord/ConnectionAdapters/SchemaStatements/add_index)|Cloud Spanner does not support index with fields length | Ensure that your database definition does not include index definitions with field lengths.
-Only GoogleSQL-dialect databases| Cloud Spanner supports both GoogleSQL- and PostgreSQL-dialect databases. This adapter only supports GoogleSQL-dialect databases. | Ensure that your database uses the GoogleSQL dialect.
+| Limitation                                                                                                                        | Comment                                                                                                                                                                                                                           | Resolution                                                                                  |
+|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
+| Interleaved tables require composite primary keys                                                                                 | Cloud Spanner requires composite primary keys for interleaved tables. See {file:examples/snippets/interleaved-tables/README.md this example} for an example on how to use interleaved tables with ActiveRecord                        | Use composite primary keys.                                                                 |
+| Lack of sequential IDs                                                                                                            | Cloud Spanner uses either using bit-reversed sequences or UUID4 to generated primary keys to avoid [hotspotting](https://cloud.google.com/spanner/docs/schema-design#uuid_primary_key) so you SHOULD NOT rely on IDs being sorted | Use either UUID4s or bit-reversed sequences to automatically generate primary keys.         |
+| Table without Primary Key                                                                                                         | Cloud Spanner support does not support tables without a primary key.                                                                                                                                                              | Always define a primary key for your table.                                                 |
+| Table names CANNOT have spaces within them whether back-ticked or not                                                             | Cloud Spanner DOES NOT support tables with spaces in them for example `Entity ID`                                                                                                                                                 | Ensure that your table names don't contain spaces.                                          |
+| Table names CANNOT have punctuation marks and MUST contain valid UTF-8                                                            | Cloud Spanner DOES NOT support punctuation marks e.g. periods ".", question marks "?" in table names                                                                                                                              | Ensure that your table names don't contain punctuation marks.                               |
+| Index with fields length [add_index](https://apidock.com/rails/v5.2.3/ActiveRecord/ConnectionAdapters/SchemaStatements/add_index) | Cloud Spanner does not support index with fields length                                                                                                                                                                           | Ensure that your database definition does not include index definitions with field lengths. |
+| Only GoogleSQL-dialect databases                                                                                                  | Cloud Spanner supports both GoogleSQL- and PostgreSQL-dialect databases. This adapter only supports GoogleSQL-dialect databases.                                                                                                  | Ensure that your database uses the GoogleSQL dialect.                                       |
 
 ## Contributing
 

data/acceptance/cases/interleaved_associations/has_many_associations_using_interleaved_test.rb

@@ -6,6 +6,12 @@
 
 # frozen_string_literal: true
 
+# ActiveRecord 7.1 introduced native support for composite primary keys.
+# This deprecates the https://github.com/composite-primary-keys/composite_primary_keys gem that was previously used in
+# this library to support composite primary keys, which again are needed for interleaved tables. These tests use the
+# third-party composite primary key gem and are therefore not executed for Rails 7.1 and higher.
+return if ActiveRecord::gem_version >= Gem::Version.create('7.1.0')
+
 require "test_helper"
 require "models/singer"
 require "models/album"

data/acceptance/cases/migration/change_schema_test.rb

@@ -196,8 +196,14 @@ module ActiveRecord
             end
           end
         end
+        expected = if ActiveRecord::gem_version < Gem::Version.create('7.1.0')
+          "you can't redefine the primary key column 'id'. To define a custom primary key, pass { id: false } to create_table."
+        else
+          "you can't redefine the primary key column 'id' on 'testings'. To define a custom primary key, pass { id: false } to create_table."
+        end
+
 
-        assert_equal "you can't redefine the primary key column 'id'. To define a custom primary key, pass { id: false } to create_table.", error.message
+        assert_equal expected, error.message
       end
 
       def test_create_table_raises_when_redefining_custom_primary_key_column
@@ -209,7 +215,12 @@ module ActiveRecord
           end
         end
 
-        assert_equal "you can't redefine the primary key column 'testing_id'. To define a custom primary key, pass { id: false } to create_table.", error.message
+        expected = if ActiveRecord::gem_version < Gem::Version.create('7.1.0')
+          "you can't redefine the primary key column 'testing_id'. To define a custom primary key, pass { id: false } to create_table."
+        else
+          "you can't redefine the primary key column 'testing_id' on 'testings'. To define a custom primary key, pass { id: false } to create_table."
+        end
+        assert_equal expected, error.message
       end
 
       def test_create_table_raises_when_defining_existing_column
@@ -222,7 +233,12 @@ module ActiveRecord
           end
         end
 
-        assert_equal "you can't define an already defined column 'testing_column'.", error.message
+        expected = if ActiveRecord::gem_version < Gem::Version.create('7.1.0')
+          "you can't define an already defined column 'testing_column'."
+        else
+          "you can't define an already defined column 'testing_column' on 'testings'."
+        end
+        assert_equal expected, error.message
       end
 
       def test_create_table_with_timestamps_should_create_datetime_columns

data/acceptance/cases/migration/schema_dumper_test.rb

@@ -13,6 +13,10 @@ module ActiveRecord
     class IndexTest < SpannerAdapter::TestCase
       include SpannerAdapter::Migration::TestHelper
 
+      def is_7_1_or_higher?
+        ActiveRecord::gem_version >= Gem::Version.create('7.1.0')
+      end
+
       def test_dump_schema_contains_start_batch_ddl
         connection = ActiveRecord::Base.connection
         schema = StringIO.new
@@ -34,7 +38,12 @@ module ActiveRecord
         connection = ActiveRecord::Base.connection
         schema = StringIO.new
         ActiveRecord::SchemaDumper.dump connection, schema
-        assert schema.string.include?("create_table \"albums\", primary_key: \"albumid\"")
+        sql = schema.string
+        if is_7_1_or_higher?
+          assert schema.string.include?("create_table \"albums\", primary_key: [\"singerid\", \"albumid\"]"), sql
+        else
+          assert schema.string.include?("create_table \"albums\", primary_key: \"albumid\""), sql
+        end
       end
 
       def test_dump_schema_contains_interleaved_index

data/acceptance/cases/models/insert_all_test.rb

@@ -33,6 +33,12 @@ module ActiveRecord
         assert_raise(NotImplementedError) { Author.insert_all(values) }
       end
 
+      def test_insert
+        value = { id: Author.next_sequence_value, name: "Alice" }
+
+        assert_raise(NotImplementedError) { Author.insert(value) }
+      end
+
       def test_insert_all!
         values = [
           { id: Author.next_sequence_value, name: "Alice" },
@@ -85,6 +91,22 @@ module ActiveRecord
         assert_equal "Carol", authors[2].name
       end
 
+      def test_upsert
+        Author.create id: 1, name: "David"
+        authors = Author.all.order(:name)
+        assert_equal 1, authors.length
+        assert_equal "David", authors[0].name
+
+        value = { id: 1, name: "Alice" }
+
+        Author.upsert(value)
+
+        authors = Author.all.order(:name)
+
+        assert_equal 1, authors.length
+        assert_equal "Alice", authors[0].name
+      end
+
       def test_upsert_all
         Author.create id: 1, name: "David"
         authors = Author.all.order(:name)

data/acceptance/cases/models/interleave_test.rb

@@ -6,6 +6,12 @@
 
 # frozen_string_literal: true
 
+# ActiveRecord 7.1 introduced native support for composite primary keys.
+# This deprecates the https://github.com/composite-primary-keys/composite_primary_keys gem that was previously used in
+# this library to support composite primary keys, which again are needed for interleaved tables. These tests use the
+# third-party composite primary key gem and are therefore not executed for Rails 7.1 and higher.
+return if ActiveRecord::gem_version >= Gem::Version.create('7.1.0')
+
 require "test_helper"
 require "test_helpers/with_separate_database"