activerecord-cockroachdb-adapter 7.1.1 → 7.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 672289521537934d4b9ed2d707c3faf55b4761c8d2b4e9e12cd8622166963ae7
-  data.tar.gz: 345a84d7c5bca0d574aa65eb0fb0e30986a23fcc2830f422e5b1d80ffa971076
+  metadata.gz: c28f723090995949b4ca82645717432e09a8d71d9c5e714bea958432af87b0cc
+  data.tar.gz: 4855cb4a35acad52324f86833777b9b9f0f74d5a0fbade33fad8f0f5c5fb67fa
 SHA512:
-  metadata.gz: 4ce6d2119bfc27192630c32ec488b3e7f533cc64963fc04035609122e5bdbc33e75b83766ca68e3eb73e2592b2fe0a1bae53a74389527762f790b16bda687da9
-  data.tar.gz: 42e10ab1106e4ffc4df89bbbf98f8ddbd05b6bccf97b062a9445ebf874a8bfef9e628dce8b39c3287424a7094f70790457293a2766a849bd39ac0e20c7a684fe
+  metadata.gz: 9a75bb056071fc5ced4b3df285a74e42d2c4bbfd4ae34a21aa860702e88e5dae51ede402be1ff24664d1cee95f5d9c182a26106473a486f6b65591212a82a067
+  data.tar.gz: cb96f815a2d9970ca62006bded80d5d57b5ba6b8ce43be5dae0bfe0d9d610cbe5394d7f321c5605df9bc806fd87fb26105a97c448ba58dd1486528bc3409282f

data/.github/workflows/ci.yml

@@ -40,8 +40,8 @@ jobs:
       fail-fast: false
       matrix:
         # https://www.cockroachlabs.com/docs/releases/release-support-policy
-        crdb: [v22.2, v23.1, v23.2]
-        ruby: [head]
+        crdb: [v23.2, v24.1, v24.2]
+        ruby: [3.4]
     name: Test (crdb=${{ matrix.crdb }} ruby=${{ matrix.ruby }})
     steps:
       - name: Set Up Actions
@@ -88,4 +88,7 @@ jobs:
           done
           cat ${{ github.workspace }}/setup.sql | cockroach sql --insecure
       - name: Test
-        run: bundle exec rake test TESTOPTS='--profile=3'
+        run: bundle exec rake test
+        env:
+          TESTOPTS: "--profile=5"
+          RAILS_MINITEST_PLUGIN: "1" # Make sure that we use the minitest plugin for profiling.

data/.gitignore

@@ -15,3 +15,4 @@
 /docker_root/
 /ruby-build/
 /test/db/
+/.ruby-version

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## Ongoing
+## 7.2.1 - 2025-03-26
+
+- Fix transaction state on rollback ([#364](https://github.com/cockroachdb/activerecord-cockroachdb-adapter/pull/364))
+
+## 7.2.0 - 2024-09-24
+
+- Add support for Rails 7.2 ([#337](https://github.com/cockroachdb/activerecord-cockroachdb-adapter/pull/337))
 
 ## 7.1.1 - 2024-05-01
 

data/CONTRIBUTING.md

@@ -1,18 +1,5 @@
 # Getting started
 
-
-## ActiveRecord adapters and you
-
-There are two repositories for the ActiveRecord adapter. The one you're in
-currently, [activerecord-cockroachdb-adapter], is the CockroachDB specific
-ActiveRecord code. Users install this alongside ActiveRecord then use
-CockroachDBAdapter to initialize ActiveRecord for their projects.
-
-This adapter extends the PostgreSQL ActiveRecord adapter in order to
-override and monkey-patch functionality.
-
-[activerecord-cockroachdb-adapter]: https://github.com/cockroachdb/activerecord-cockroachdb-adapter/
-
 ## Setup and running tests
 
 ### CockroachDB
@@ -23,6 +10,7 @@ create two databases to be used by the ActiveRecord test suite:
 activerecord_unittest and activerecord_unittest2.
 
 ```sql
+-- See /setup.sql file for the whole setup.
 CREATE DATABASE activerecord_unittest;
 CREATE DATABASE activerecord_unittest2;
 ```
@@ -36,30 +24,6 @@ Ruby version.
 tests similarly to TeamCity. The database is destroyed between each
 test file.)
 
-Install rbenv with ruby-build on MacOS:
-
-```bash
-brew install rbenv ruby-build
-echo 'eval "$(rbenv init - zsh)"' >> ~/.profile
-```
-
-Install rbenv with ruby-build on Ubuntu:
-
-```bash
-sudo apt-get install rbenv
-echo 'eval "$(rbenv init - zsh)"' >> ~/.profile
-
-git clone https://github.com/sstephenson/ruby-build.git ~/ruby-build
-sh ~/ruby-build/install.sh
-```
-
-Use rbenv to install version of Ruby specified by `.ruby-version`.
-
-```bash
-rbenv install
-rbenv rehash
-```
-
 Using [bundler](http://bundler.io/), install the dependencies of Rails.
 
 ```bash
@@ -87,9 +51,12 @@ TEST_FILES="test/cases/adapter_test.rb,test/cases/associations/left_outer_join_a
 To run a specific test case, use minitest's `-n` option to run tests that match a given pattern. All minitest options are set via the `TESTOPTS` environemnt variable. For example, to run `test_indexes` from CockroachDB's `test/cases/adapter_test.rb` file
 
 ```bash
-TEST_FILES="test/cases/adapter_test.rb" TESTOPTS=`-n=/test_indexes/` bundle exec rake test
+TEST_FILES="test/cases/adapter_test.rb" TESTOPTS=`--name=/test_indexes/` bundle exec rake test
 ```
 
+You can also use the constant `COCKROACH_SKIP_LOAD_SCHEMA` to avoid reloading the schema every time (faster).
+Only do it if you know the schema was left in a correct state.
+
 `test/config.yml` assumes CockroachDB will be running at localhost:26257 with a root user. Make changes to `test/config.yml` as needed.
 
 ### Run Tests from a Backup
@@ -121,7 +88,6 @@ master branch, with an alpha build of CockroachDB. it would be even
 better to be able to test multiple versions of the adapter, and do so
 against different versions of CockroachDB.
 
-
 ## Adding feature support
 
 As CockroachDB improves, so do the features that can be supported in
@@ -131,15 +97,40 @@ gates should be toggled. Something that would help this process would be
 linking those issues back to this adapter so that part of the feature
 completing includes updating the adapter.
 
-
-## Execute only tests that run with a connection
-
-I have not investigated if this is already possible, but I would assume
-no.
-
-A possible way to approach this would be to add a shim to cause any
-tests that use it to fail, and grep the tests that pass and then skip
-them.
+## Upgrading Rails
+
+Whenever you upgrade rails version, loads of things will change.
+This section intent to help you with a checklist.
+
+- Check for TODO or NOTE tags that are referencing the old or new version of
+  rails.
+  ```bash
+  rg 'TODO|NOTE' --after-context=2
+  ```
+- Check postgresql_specific_schema.rb changelog in rails, and apply the changes
+  you want. Ex:
+  ```bash
+  git diff v7.1.4..v7.2.1 -- $(fd postgresql_specific_schema)
+  ```
+- Verify the written text at the beginning of the test suite, there are likely
+  some changes in excluded tests.
+- Check for some important methods, some will change for sure:
+  - [x] `def new_column_from_field(`
+  - [x] `def column_definitions(`
+  - [x] # `def pk_and_sequence_for(`
+  - [ ] `def new_column_from_field(`
+  - [ ] `def column_definitions(`
+  - [ ] `def pk_and_sequence_for(`
+  - [ ] `def foreign_keys(` and `def all_foreign_keys(`
+  - [ ] ...
+- Check for setups containing `drop_table` in the test suite.
+  Especially if you have tons of failure, this is likely the cause.
+- In the same way, run `test/cases/fixtures_test.rb` first, and check
+  if this corrupted the test database for other tests.
+- For both of the above, the diff of `schema.rb` can be useful:
+  ```bash
+  git diff v7.1.2..v7.2.1 -- activerecord/test/schema/schema.rb
+  ```
 
 ## Publishing to Rubygems
 
@@ -151,7 +142,6 @@ gem build ...
 gem publish <output file>
 ```
 
-
 # Notes
 
 When executing the test suite, each test file will reload fixtures. This
@@ -182,49 +172,8 @@ cleaned up, or skipped until passing.
 The purpose of these was to make the tests grep-able while going through
 all the failures.
 
-
 [cockroachdb/cockroach#20753]: https://github.com/cockroachdb/cockroach/issues/20753#issuecomment-352810425
 
-
-## Tracked test failures
-
-Some of the skipped failures are:
-
-- `default:` key is not working for columns in table schema
-  definitions. This causes tests to fail due to unexpected data.
-
-- `array:` key is not working for columns in table schema definitions.
-
-- `"Salary is not appearing in list"` is being raised in a number of
-  places. Likely during fixture setup.
-
-- `sum` function seems to result in a different type in ActiveRecord.
-  Instead of returning a Ruby `int`, it returns a Ruby `string`. It
-  appears that MySQL2 also does this. A suspected cause might be how
-  `Decimal` is handled if `sum` consumes integers and return a
-  decimal.
-
-- Potentially fork the PostgreSQL::SchemaDumper to handle anything
-  specific to CockroachDB, like primary keys or bigints.
-
-- You can call `@connection.create_table(..., id: :bigint)`, but this
-  will not changes things for CockroachDB (I think...), so it would be
-  not allowed. Even better, our adapter could interpret this and
-  generate the appropriate explicit pkey column. Not sure what string
-  pkeys look like...
-
-- `string` types are introspected to `text` types.
-
-- A user can do an update, delete, and insert on views.
-
-- Postgres specific bit strings are not properly supported.
-
-Grepping for `FIXME(joey)`, `TODO(joey)`, and `NOTE(joey)` will yeild
-most of the touchpoints including test failures and temporary monkey
-patches. Some monkey patches were made directly to Rails, which will
-need to be cleaned up.
-
-
 # Notes for the non-Rubyer
 
 rbenv is an environment manager that lets you manage and swap between

data/Gemfile

@@ -50,6 +50,7 @@ group :development, :test do
 
   # Needed for the test suite
   gem "msgpack", ">= 1.7.0"
+  gem "mutex_m", "~> 0.2.0"
 
   gem "rake"
   gem "debug"
@@ -61,9 +62,8 @@ group :development, :test do
   gem "parser"
 
   # Gems used by the ActiveRecord test suite
-  gem "bcrypt", "~> 3.1.18"
-  gem "mocha", "~> 1.14.0"
-  gem "sqlite3", "~> 1.4.4"
+  gem "bcrypt", "~> 3.1"
+  gem "sqlite3", "~> 1.4"
 
-  gem "minitest", "~> 5.15.0"
+  gem "minitest", "~> 5.15"
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Apache License
+                                 Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
@@ -199,4 +199,3 @@ Apache License
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-

data/README.md

@@ -1,20 +1,22 @@
 # ActiveRecord CockroachDB Adapter
 
-CockroachDB adapter for ActiveRecord 5, 6, and 7. This is a lightweight extension of the PostgreSQL adapter that establishes compatibility with [CockroachDB](https://github.com/cockroachdb/cockroach).
+CockroachDB adapter for ActiveRecord. This is a lightweight extension
+of the PostgreSQL adapter that establishes compatibility with [CockroachDB](https://github.com/cockroachdb/cockroach).
 
 ## Installation
 
 Add this line to your project's Gemfile:
 
 ```ruby
-gem 'activerecord-cockroachdb-adapter', '~> 7.0.0'
+gem 'activerecord-cockroachdb-adapter', '~> 7.2.0'
 ```
 
-If you're using Rails 5.2, use the `5.2.x` versions of this gem.
+If you're using Rails 7.0, use the `7.0.x` versions of this gem.
 
-If you're using Rails 6.0, use the `6.0.x` versions of this gem.
+If you're using Rails 7.1, use the `7.1.x` versions of this gem.
 
-If you're using Rails 7.0, use the `7.0.x` versions of this gem.
+If you're using Rails 7.2, use the `7.2.x` versions of this gem.
+The minimal CockroachDB version required is 23.1.12 for this version.
 
 In `database.yml`, use the following adapter setting:
 

data/activerecord-cockroachdb-adapter.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   spec.description   = "Allows the use of CockroachDB as a backend for ActiveRecord and Rails apps."
   spec.homepage      = "https://github.com/cockroachdb/activerecord-cockroachdb-adapter"
 
-  spec.add_dependency "activerecord", "~> 7.1.0"
-  spec.add_dependency "pg", "~> 1.2"
+  spec.add_dependency "activerecord", "~> 7.2.0"
+  spec.add_dependency "pg", "~> 1.5"
   spec.add_dependency "rgeo-activerecord", "~> 7.0.0"
 
   spec.add_development_dependency "benchmark-ips", "~> 2.9.1"

data/bin/console

@@ -5,27 +5,29 @@ $:.unshift(File.expand_path("../lib", __dir__))
 # require "bundler/setup"
 # Bundler.require :development
 
-require "active_record"
+require "activerecord-cockroachdb-adapter"
 # This allows playing with the rake task as well. Ex:
 #
 #     ActiveRecord::Tasks::DatabaseTasks.
 #       structure_load(Post.connection_db_config, "awesome-file.sql")
 require "active_record/connection_adapters/cockroachdb/database_tasks"
 
+DB_NAME = "ar_crdb_console"
+
 schema_kind = ENV.fetch("SCHEMA_KIND", ENV.fetch("SCHEMA", "default"))
 
-system("cockroach sql --insecure --host=localhost:26257 --execute='drop database if exists ar_crdb_console'",
+system("cockroach sql --insecure --host=localhost:26257 --execute='drop database if exists #{DB_NAME}'",
   exception: true)
-system("cockroach sql --insecure --host=localhost:26257 --execute='create database ar_crdb_console'",
+system("cockroach sql --insecure --host=localhost:26257 --execute='create database #{DB_NAME}'",
   exception: true)
 
 ActiveRecord::Base.establish_connection(
-  #Alternative version:  "cockroachdb://root@localhost:26257/ar_crdb_console"
+  #Alternative version:  "cockroachdb://root@localhost:26257/#{DB_NAME}"
   adapter: "cockroachdb",
   host: "localhost",
   port: 26257,
   user: "root",
-  database: "ar_crdb_console"
+  database: DB_NAME
 )
 
 load "#{__dir__}/console_schemas/#{schema_kind}.rb"

data/bin/console_schemas/default.rb

@@ -6,4 +6,6 @@ ActiveRecord::Schema.define do
     t.string :title
     t.text :body
   end
+
+  add_index("posts", ["title"], name: "index_posts_on_title", unique: true)
 end

data/lib/active_record/connection_adapters/cockroachdb/arel_tosql.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module RGeo
   module ActiveRecord
     ##

data/lib/active_record/connection_adapters/cockroachdb/attribute_methods.rb

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module ActiveRecord
   module CockroachDB
     module AttributeMethodsMonkeyPatch

data/lib/active_record/connection_adapters/cockroachdb/column.rb

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module ActiveRecord
   module ConnectionAdapters
     module CockroachDB

data/lib/active_record/connection_adapters/cockroachdb/column_methods.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module ActiveRecord
   module ConnectionAdapters
     module CockroachDB

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

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module ActiveRecord
   module ConnectionAdapters
     module CockroachDB
@@ -8,9 +24,17 @@ module ActiveRecord
           table_deletes = tables_to_delete.map { |table| "DELETE FROM #{quote_table_name(table)}" }
           statements = table_deletes + fixture_inserts
 
-          with_multi_statements do
-            disable_referential_integrity do
-              execute_batch(statements, "Fixtures Load")
+          begin # much faster without disabling referential integrity, worth trying.
+            with_multi_statements do
+              transaction(requires_new: true) do
+                execute_batch(statements, "Fixtures Load")
+              end
+            end
+          rescue
+            with_multi_statements do
+              disable_referential_integrity do
+                execute_batch(statements, "Fixtures Load")
+              end
             end
           end
         end

data/lib/active_record/connection_adapters/cockroachdb/database_tasks.rb

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require "active_record/base"
 
 module ActiveRecord
@@ -21,14 +37,14 @@ module ActiveRecord
               ActiveRecord.dump_schemas
             end
 
-          conn = ActiveRecord::Base.connection
+          conn = ActiveRecord::Base.lease_connection
           begin
             old_search_path = conn.schema_search_path
             conn.schema_search_path = search_path
             File.open(filename, "w") do |file|
               # NOTE: There is no issue with the crdb_internal schema, it is ignored by SHOW CREATE.
               %w(SCHEMAS TYPES).each do |object_kind|
-                ActiveRecord::Base.connection.execute("SHOW CREATE ALL #{object_kind}").each_row { file.puts _1 }
+                conn.execute("SHOW CREATE ALL #{object_kind}").each_row { file.puts _1 }
               end
 
               ignore_tables = ActiveRecord::SchemaDumper.ignore_tables.to_set

data/lib/active_record/connection_adapters/cockroachdb/oid/date_time.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module ActiveRecord
   module ConnectionAdapters
     module CockroachDB

data/lib/active_record/connection_adapters/cockroachdb/oid/interval.rb

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # frozen-string-literal: true
 
 require "active_support/duration"

data/lib/active_record/connection_adapters/cockroachdb/oid/spatial.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module ActiveRecord
   module ConnectionAdapters
     module CockroachDB

data/lib/active_record/connection_adapters/cockroachdb/quoting.rb

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2024 The Cockroach Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module ActiveRecord
   module ConnectionAdapters
     module CockroachDB