activerecord-cockroachdb-adapter 7.0.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8f39021d1353c56c2830adac978ec3336f993bdb46e670f4c975be8d2c307c5
-  data.tar.gz: 8ea587bc12a5e5bc806901d28c7e67e9f63a0c2f5dfc769f2370ab4dd3f20c65
+  metadata.gz: 829d7c6d923f6d2949dfcca1c946be01286b79f643987696b0d271c696e3c55d
+  data.tar.gz: 558689db88c43aaa1fe4d10216796ee2754d9b206cc56feb846b0ca2e05e745c
 SHA512:
-  metadata.gz: 6c7fca690e7203047ffeac709b9a62165c96f3ccb7ec26f3fe412daffc979f62ec392117912e15af15865aacf9f2b09bf2ff4d2efc155ee1f3dcbef1b2a213bb
-  data.tar.gz: 55cf42b3a055eabbec2045dac6650d50a96a085794dc2ef6bbb08efb44182daff7664720292f720099c3b08239edafbe1ae668779aa975426d9d8905fe98620b
+  metadata.gz: 6b3ad08b9912080c5f324ef1b244e5f9d1ed22cd1e63f3c9ee9623399e5c92e12000681b0988e533a19e4e403325a13a419e534499c2d3fd6316b36525be57d9
+  data.tar.gz: c77f0016087842bdcfd7d8cbb0989b687653dcc4e6ce3e5c618b2fe2f1a44e1c995b84836235ba497f7623713987180796c1d07ae639f16dd4be6af747c1e9a4

data/.github/workflows/docker.yml

@@ -0,0 +1,57 @@
+# This workflow is based off of the example at
+# https://github.com/docker/metadata-action
+#
+# Multi-platform configuration from
+# https://github.com/docker/build-push-action/blob/master/docs/advanced/multi-platform.md
+#
+# Caching from
+# https://github.com/docker/build-push-action/blob/master/docs/advanced/cache.md
+name: Docker
+permissions:
+  contents: read
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - 'build/Dockerfile'
+  # Only build, but don't push, on a PR if it touches the Dockerfile,
+  # since this takes a while to execute.
+  pull_request:
+    paths:
+      - 'build/Dockerfile'
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: cockroachdb/activerecord_test_container
+          labels: |
+            org.opencontainers.image.title=Active Record CockroachDB Adapter Test Image
+            org.opencontainers.image.vendor=Cockroach Labs Inc.
+            org.opencontainers.image.description=Environment for running tests
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: build/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

data/.gitignore

@@ -8,3 +8,10 @@
 /spec/reports/
 /tmp/
 *.gem
+/debug.log
+/cockroach-url
+/cockroach-data/
+/cockroach-*.linux-amd64/
+/docker_root/
+/ruby-build/
+/test/db/

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 7.0.1 - 2023-03-24
+
+- Reconnect on retryable connection errors.
+
 ## 7.0.0 - 2022-06-02
 
 - Add support for Active Record 7.0.3

data/CONTRIBUTING.md

@@ -25,22 +25,39 @@ CREATE DATABASE activerecord_unittest2;
 ```
 
 It is best to have a Ruby environment manager installed, such as
-[rvm](https://rvm.io/), as Rails has varying Ruby version requirements.
-If you are using rvm, you then install and use the required Ruby
-version.  The current tests use Rails 5.2.0 beta and Ruby >= 2.2.2.
+[rbenv](https://github.com/rbenv/rbenv), as Rails has varying Ruby version
+requirements. If you are using rbenv, you then install and use the required
+Ruby version.
 
 (Alternatively, one can use `./docker.sh build/teamcity-test.sh` to run
-tests similarily to TeamCity. The database is destroyed between each
+tests similarly to TeamCity. The database is destroyed between each
 test file.)
 
+Install rbenv with ruby-build on MacOS:
 
 ```bash
-rvm install 2.2.5
-# This only makes Ruby 2.2.5 active for the length of the terminal session.
-rvm use 2.2.5
+brew install rbenv ruby-build
+echo 'eval "$(rbenv init - zsh)"' >> ~/.profile
 ```
 
-Using [bundler](http://bundler.io/), install the dependancies of Rails.
+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
 bundle install
@@ -52,13 +69,13 @@ Then, to run the full test suite with an active CockroachDB instance:
 bundle exec rake test
 ```
 
-To run specific ActiveRecord tests, set environemnt variable `TEST_FILES_AR`. For example, to run ActiveRecord tests `test/cases/associations_test.rb` and `test/cases/ar_schema_test.rb.rb`
+To run specific ActiveRecord tests, set environment variable `TEST_FILES_AR`. For example, to run ActiveRecord tests `test/cases/associations_test.rb` and `test/cases/ar_schema_test.rb.rb`
 
 ```bash
 TEST_FILES_AR="test/cases/associations_test.rb,test/cases/ar_schema_test.rb" bundle exec rake test
 ```
 
-To run specific CockroachDB Adapter tests, set environemnt variable `TEST_FILES`. For example, to run CockroachDB Adpater tests `test/cases/adapter_test.rb` and `test/cases/associations/left_outer_join_association_test.rb`
+To run specific CockroachDB Adapter tests, set environment variable `TEST_FILES`. For example, to run CockroachDB Adpater tests `test/cases/adapter_test.rb` and `test/cases/associations/left_outer_join_association_test.rb`
 
 ```bash
 TEST_FILES="test/cases/adapter_test.rb,test/cases/associations/left_outer_join_association_test.rb" bundle exec rake test
@@ -104,7 +121,7 @@ And the `activerecord_unittest` database will use the `RESTORE` command to load
 ## Support past Rails versions
 
 Currently, only a beta version of Rails is tested. This means that the
-adapter has been modified in to accomodate unreleased changes. In order
+adapter has been modified in to accommodate unreleased changes. In order
 to run the tests for Rails 5.1 or 4.2, the test changes will need to be
 cherry-picked back. Conflicts are mostly only expected for tests that
 have not yet been added.
@@ -129,7 +146,7 @@ against different versions of CockroachDB.
 
 As CockroachDB improves, so do the features that can be supported in
 ActiveRecord. Many of them are gated by conditions the
-CockroachDBAdapter has overrided. As these features are completed, these
+CockroachDBAdapter has overridden. As these features are completed, these
 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.
@@ -231,10 +248,10 @@ need to be cleaned up.
 # Notes for the non-Rubyer
 
 rvm is an environment manager that lets you manage and swap between
-multiple verisons of Ruby and their dependancies.
+multiple versions of Ruby and their dependencies.
 
-bundle is dependancy manager that uses a projects `Gemfile` (and often
-`<project>.gemspec`) to manage and load dependancies and their required
+bundle is dependency manager that uses a projects `Gemfile` (and often
+`<project>.gemspec`) to manage and load dependencies and their required
 versions. When using projects commands are prefixed with
-`bundle exec ...`. Bundle will ensure that all depenedncies are fetched
+`bundle exec ...`. Bundle will ensure that all dependencies are fetched
 and used.

data/Gemfile

@@ -47,7 +47,7 @@ else
     )
   end
 
-  # Get Rails from source beacause the gem doesn't include tests
+  # Get Rails from source because the gem doesn't include tests
   version = ENV['RAILS_VERSION'] || get_version_from_gemspec
   gem 'rails', git: "https://github.com/rails/rails.git", tag: "v#{version}"
 end

data/build/Dockerfile

@@ -8,10 +8,7 @@ RUN apt-get --allow-releaseinfo-change update -y && apt-get install -y \
   libxslt-dev \
   libxml2-dev \
   libsqlite3-dev \
+  rbenv \
   && rm -rf /var/lib/apt/lists/*
 
-# Ruby testing dependencies.
-RUN gem install bundle rake
-
-# Add global Gem binaries to the path.
-ENV PATH /usr/local/lib/ruby/gems/2.4.0::$PATH
+RUN rm -rf ~/ruby-build; git clone https://github.com/sstephenson/ruby-build.git ~/ruby-build; sh ~/ruby-build/install.sh

data/build/local-test.sh

@@ -11,7 +11,6 @@ rm -f "$urlfile"
 # canceled on an agent.
 rm -rf $HOME/tmp/rails &
 # Start CockroachDB.
-cockroach quit --insecure || true
 cockroach start --insecure --host=localhost --listening-url-file="$urlfile" --store=path=$HOME/tmp/rails &
 trap "echo 'Exit routine: Killing CockroachDB.' && kill -9 $! &> /dev/null" EXIT
 for i in {0..3}
@@ -31,8 +30,3 @@ echo "Rebuilding database"
 (cd rails/activerecord && bundle exec rake db:cockroachdb:rebuild)
 echo "Starting tests"
 (cd rails/activerecord && bundle exec rake test:cockroachdb TESTFILES=$1)
-
-# Attempt a clean shutdown for good measure. We'll force-kill in the atexit
-# handler if this fails.
-cockroach quit --insecure
-trap - EXIT

data/build/teamcity-test.sh

@@ -2,9 +2,17 @@
 
 set -euox pipefail
 
+eval "$(rbenv init -)"
+
+rbenv install --skip-existing --verbose
+
+rbenv rehash
+
+ruby -v
+
 # Download CockroachDB
-VERSION=v22.1.0
-wget -qO- https://binaries.cockroachdb.com/cockroach-$VERSION.linux-amd64.tgz | tar  xvz
+VERSION=v22.2.6
+wget -qO- https://binaries.cockroachdb.com/cockroach-$VERSION.linux-amd64.tgz | tar xvz
 readonly COCKROACH=./cockroach-$VERSION.linux-amd64/cockroach
 
 # Make sure cockroach can be found on the path. This is required for the
@@ -16,9 +24,6 @@ run_cockroach() {
   # Start a CockroachDB server, wait for it to become ready, and arrange
   # for it to be force-killed when the script exits.
   rm -f "$urlfile"
-  # Clean out a past CockroachDB instance. This will clean out leftovers
-  # from the build agent, and also between CockroachDB runs.
-  cockroach quit --insecure || true
   rm -rf cockroach-data
   # Start CockroachDB.
   cockroach start-single-node --max-sql-memory=25% --cache=25% --insecure --host=localhost --spatial-libs=./cockroach-$VERSION.linux-amd64/lib --listening-url-file="$urlfile" >/dev/null 2>&1 &
@@ -54,8 +59,11 @@ run_cockroach() {
   cockroach sql --insecure -e "SET CLUSTER SETTING sql.defaults.experimental_temporary_tables.enabled = 'true';"
 }
 
+gem env
+
 # Install ruby dependencies.
-gem install bundler:2.3.14
+gem install bundler:2.4.9 rake:13.0.6
+
 bundle install
 
 run_cockroach
@@ -68,11 +76,6 @@ else
     HAS_FAILED=0
 fi
 
-# Attempt a clean shutdown for good measure. We'll force-kill in the
-# exit trap if this script fails.
-cockroach quit --insecure
-trap - EXIT
-
 if [ $HAS_FAILED -eq 1 ]; then
   exit 1
 fi

data/docker.sh

@@ -4,7 +4,7 @@
 
 set -euox pipefail
 
-DOCKER_IMAGE_TAG=cockroachdb/activerecord_test_container:20210914
+DOCKER_IMAGE_TAG=cockroachdb/activerecord_test_container:master
 
 # Absolute path to this repository.
 repo_root=$(cd "$(dirname "${0}")" && pwd)

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

@@ -10,21 +10,44 @@ module ActiveRecord
         # exceeded.
         def within_new_transaction(isolation: nil, joinable: true, attempts: 0)
           super(isolation: isolation, joinable: joinable)
+        rescue ActiveRecord::ConnectionNotEstablished => error
+          raise unless retryable? error
+          raise if attempts >= @connection.max_transaction_retries
+
+          sleep_rand_seconds(attempts)
+
+          unless @connection.active?
+            warn "connection isn't active, reconnecting"
+            @connection.reconnect!
+          end
+
+          within_new_transaction(isolation: isolation, joinable: joinable, attempts: attempts + 1) { yield }
         rescue ActiveRecord::StatementInvalid => error
           raise unless retryable? error
           raise if attempts >= @connection.max_transaction_retries
 
-          attempts += 1
-          sleep_seconds = (2 ** attempts + rand) / 10
-          sleep(sleep_seconds)
-          within_new_transaction(isolation: isolation, joinable: joinable, attempts: attempts) { yield }
+          sleep_rand_seconds(attempts)
+
+          within_new_transaction(isolation: isolation, joinable: joinable, attempts: attempts + 1) { yield }
         end
 
         def retryable?(error)
+          return true if serialization_error?(error)
           return true if error.is_a? ActiveRecord::SerializationFailure
           return retryable? error.cause if error.cause
           false
         end
+
+        def serialization_error?(error)
+          errors = [error]
+          errors << error.cause if error.cause
+          errors.any? {|e| e.is_a? PG::TRSerializationFailure }
+        end
+
+        def sleep_rand_seconds(attempts)
+          sleep_seconds = (2 ** attempts + rand) / 10
+          sleep(sleep_seconds)
+        end
       end
     end
 

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  COCKROACH_DB_ADAPTER_VERSION = "7.0.0"
+  COCKROACH_DB_ADAPTER_VERSION = "7.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cockroachdb-adapter
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.0.1
 platform: ruby
 authors:
 - Cockroach Labs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -74,8 +74,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/docker.yml"
 - ".gitignore"
 - ".gitmodules"
+- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -134,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: CockroachDB adapter for ActiveRecord.