activerecord-spanner-adapter 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f8199e1af804baf47d382e53404f88329478d35958f71fcaec34f73921de987
-  data.tar.gz: b2bc3919e5cc4d675d539806c27e0dda7b16d676ca349aa95a11370c4ec145b7
+  metadata.gz: 0b6dba891089af7c51b13f3b80ce8342b691d31cd0e31181dbd5799c240a2e9c
+  data.tar.gz: 54a6079aa300d4e31bb8f47630857e624e94995dc713aae60aa848ac3da41ca0
 SHA512:
-  metadata.gz: 22ed1bd5840aa615681a7af2a4f87ceb31a5ec5a772d3260740ed520f99269b1ecdc0022aa1bcbf703afe01d99a04bb6181d546c5d6690bef20c17142281eb47
-  data.tar.gz: b9d65faf249175397de04b003a612ed10f89302ba545ffe09208b43414e9e8291feb9240aae3850f5f97d6f6b0bfd9c6134176316ebf6cc520d487e8d9700447
+  metadata.gz: d5f05cd6a79976d974d3d5aa472d514146b5367dae7a4c334913627acc0c98154c8a247c0225a42f235c976b9d3e28cd8c29c46a3c1e876eda6c181619e11617
+  data.tar.gz: b943df790fa40955c31b5e9df89396a84d5f9b0499e8d610758238a249de1cc693b53f87f9b5d134b6595be5677222b04685206b8ca5d28472e6f9fbdac20ad9

data/.github/CODEOWNERS

@@ -4,4 +4,4 @@
 # For syntax help see:
 # https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
 
-*     @googleapis/ruby-team @skuruppu @hengfengli @olavloite @xiangshen-dk
+*     @googleapis/ruby-team @olavloite @rahul2393 @ansh0l

data/.github/blunderbuss.yml

@@ -1,2 +1,2 @@
 assign_issues:
-  - hengfengli
+  - olavloite

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.2.1"
+  ".": "1.3.1"
 }

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+### 1.3.1 (2022-12-15)
+
+#### Bug Fixes
+
+* build error for ruby 2.5 ([#216](https://github.com/googleapis/ruby-spanner-activerecord/issues/216)) 
+
+### 1.3.0 (2022-12-08)
+
+#### Features
+
+* add check constraint support to migrations ([#205](https://github.com/googleapis/ruby-spanner-activerecord/issues/205)) 
+* allows passing of type parameter when creating parent_key column ([#195](https://github.com/googleapis/ruby-spanner-activerecord/issues/195)) 
+* include index options in the output of SchemaDumper ([#203](https://github.com/googleapis/ruby-spanner-activerecord/issues/203)) 
+* schema_dumper should use DDL batch ([#207](https://github.com/googleapis/ruby-spanner-activerecord/issues/207)) 
+* support column DEFAULT expressions in migrations ([#196](https://github.com/googleapis/ruby-spanner-activerecord/issues/196)) 
+#### Bug Fixes
+
+* ignore no database when recreating ([#208](https://github.com/googleapis/ruby-spanner-activerecord/issues/208)) 
+#### Documentation
+
+* fix typo in example of interleaved-tables ([#209](https://github.com/googleapis/ruby-spanner-activerecord/issues/209)) 
+
+### 1.2.2 (2022-08-29)
+
+#### Documentation
+
+* add ActiveRecord 7 as a supported version to the README ([#189](https://github.com/googleapis/ruby-spanner-activerecord/issues/189)) 
+* update limitation on interleaved tables and default column values ([#190](https://github.com/googleapis/ruby-spanner-activerecord/issues/190)) 
+
 ### 1.2.1 (2022-08-28)
 
 #### Bug Fixes

data/README.md

@@ -8,10 +8,14 @@ This project provides a Cloud Spanner adapter for ActiveRecord. It supports the
 
 - ActiveRecord 6.0.x with Ruby 2.6 and 2.7.
 - ActiveRecord 6.1.x with Ruby 2.6 and higher.
+- ActiveRecord 7.0.x with Ruby 2.7 and higher.
 
 Known limitations are listed in the [Limitations](#limitations) section.
 Please report any problems that you might encounter by [creating a new issue](https://github.com/googleapis/ruby-spanner-activerecord/issues/new).
 
+This adapter only supports GoogleSQL-dialect Cloud Spanner databases. PostgreSQL-dialect
+databases are not supported.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -70,18 +74,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).
 
 ## Limitations
 
 Limitation|Comment|Resolution
 ---|---|---
-Interleaved tables are not supported|Cloud Spanner requires to use composite primary keys for interleaved tables, but Active Record does not support composite primary keys. More details: [#160](https://github.com/googleapis/ruby-spanner-activerecord/issues/160) |Use non-interleaved tables.
-Lack of DEFAULT for columns [change_column_default](https://apidock.com/rails/v5.2.3/ActiveRecord/ConnectionAdapters/SchemaStatements/change_column_default)|Cloud Spanner does not support DEFAULT values for columns. The use of default must be enforced in your controller logic| Always set a value in your model or controller logic.
+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.
 
 ## Contributing
 

data/acceptance/cases/migration/schema_dumper_test.rb

@@ -0,0 +1,69 @@
+# Copyright 2022 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"
+
+module ActiveRecord
+  class Migration
+    class IndexTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Migration::TestHelper
+
+      def test_dump_schema_contains_start_batch_ddl
+        connection = ActiveRecord::Base.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
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("  connection.run_batch\n"\
+                                      "rescue\n"\
+                                      "  abort_batch\n"\
+                                      "  raise")
+      end
+
+      def test_dump_schema_contains_albums_table
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("create_table \"albums\", primary_key: \"albumid\"")
+      end
+
+      def test_dump_schema_contains_interleaved_index
+        connection = ActiveRecord::Base.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
+        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
+        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
+        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
+    end
+  end
+end

data/acceptance/cases/models/generated_column_test.rb

@@ -76,13 +76,24 @@ module ActiveRecord
         end
       end
 
+      VERSION_7 = ActiveRecord.gem_version >= Gem::Version.create("7.0.0")
+
+      def assert_raises_below_ar_7(ex, &test)
+        if VERSION_7
+          assert_nothing_raised &test
+        else
+          assert_raises ex, &test
+        end
+      end
+
       def test_create_with_value_for_generated_column
         # Note: The statement itself will not fail for an explicit transaction that uses buffered transactions.
         # Instead, the commit will fail. That is tested in a separate test case.
         [nil, :serializable].each do |isolation|
           run_in_transaction isolation do
-            assert_raises ActiveRecord::StatementInvalid do
-              Singer.create first_name: "Pete", last_name: "Allison", full_name: "Alice Peterson"
+            assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
+              singer = Singer.create first_name: "Pete", last_name: "Allison", full_name: "Alice Peterson"
+              assert_equal "Pete Allison", singer.reload.full_name
             end
           end
         end
@@ -90,10 +101,11 @@ module ActiveRecord
 
       def test_create_with_value_for_generated_column_buffered_mutations
         # The transaction itself will raise an error, as the failure occurs during the commit.
-        assert_raises ActiveRecord::StatementInvalid do
-          Singer.transaction isolation: :buffered_mutations do
+        assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
+          singer = run_in_transaction :buffered_mutations do
             Singer.create first_name: "Pete", last_name: "Allison", full_name: "Alice Peterson"
           end
+          assert_equal "Pete Allison", singer.reload.full_name
         end
       end
 
@@ -104,10 +116,11 @@ module ActiveRecord
           singer = Singer.create first_name: "Pete", last_name: "Allison"
           singer.reload # reload to ensure the full_name attribute is populated.
           run_in_transaction isolation do
-            assert_raises ActiveRecord::StatementInvalid do
+            assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
               Singer.update full_name: "Alice Peterson"
             end
           end
+          assert_equal "Pete Allison", singer.reload.full_name
         end
       end
 
@@ -115,11 +128,12 @@ module ActiveRecord
         singer = Singer.create first_name: "Pete", last_name: "Allison"
         singer.reload # reload to ensure the full_name attribute is populated.
         # The transaction itself will raise an error, as the failure occurs during the commit.
-        assert_raises ActiveRecord::StatementInvalid do
-          Singer.transaction isolation: :buffered_mutations do
+        assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
+          run_in_transaction :buffered_mutations do
             Singer.update full_name: "Alice Peterson"
           end
         end
+        assert_equal "Pete Allison", singer.reload.full_name
       end
     end
   end

data/acceptance/cases/models/interleave_test.rb

@@ -0,0 +1,36 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "models/singer"
+require "models/album_partial_disabled"
+
+module ActiveRecord
+  module Model
+    class InterleaveTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Associations::TestHelper
+
+      attr_accessor :singer
+
+      def setup
+        super
+
+        @singer = Singer.create first_name: "FirstName", last_name: "LastName"
+      end
+
+      def teardown
+        Album.destroy_all
+        Singer.destroy_all
+      end
+
+      def test_with_partial_inserts_disabled
+        AlbumPartialDisabled.create! title: "Title3", singer: singer
+      end
+    end
+  end
+end

data/acceptance/cases/models/logging_test.rb

@@ -0,0 +1,53 @@
+# Copyright 2022 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 "active_support/log_subscriber/test_helper"
+require "test_helper"
+require "models/post"
+
+module ActiveRecord
+  module Model
+    class LoggingTest < SpannerAdapter::TestCase
+      include ActiveSupport::LogSubscriber::TestHelper
+
+      setup do
+        ActiveRecord::LogSubscriber.attach_to(:active_record)
+      end
+
+      def test_logs_without_binds
+        published_time = Time.new(2016, 05, 11, 19, 0, 0)
+        Post.where(published_time: published_time, title: 'Title - 1').first
+
+        wait
+        assert @logger.logged(:debug).length >= 1
+        assert_no_match "[[\"published_time\", \"#{published_time.utc.iso8601(9)}\"], [\"title\", \"Title - 1\"]",
+                        @logger.logged(:debug).last
+      end
+
+      def test_logs_with_binds
+        ActiveRecord::ConnectionAdapters::SpannerAdapter.log_statement_binds = true
+
+        published_time = Time.new(2016, 05, 11, 19, 0, 0)
+        Post.where(published_time: published_time, title: 'Title - 1').first
+
+        wait
+        assert @logger.logged(:debug).length >= 1
+        assert_match "[[\"published_time\", \"#{published_time.utc.iso8601(9)}\"], [\"title\", \"Title - 1\"]",
+                     @logger.logged(:debug).last
+      ensure
+        ActiveRecord::ConnectionAdapters::SpannerAdapter.log_statement_binds = false
+      end
+
+      private
+
+      def set_logger(logger)
+        ActiveRecord::Base.logger = logger
+      end
+    end
+  end
+end

data/acceptance/cases/models/query_test.rb

@@ -166,6 +166,11 @@ module ActiveRecord
         assert_nil post.id
         assert_equal "Title - 1", post.title
       end
+
+      def test_to_sql
+        assert_equal "SELECT `comments`.* FROM `comments` WHERE `comments`.`comment` = 'Comment - 2'",
+                     Comment.where(comment: 'Comment - 2').to_sql
+      end
     end
   end
-end
+end