activerecord-cockroachdb-adapter 6.1.0 → 6.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e75b02ff521bc6e8988549a1ceaa7bbd8ed3eddb138e3fdd6f0d7f91b50e23
-  data.tar.gz: f67eac0c8dce552a8c5270d6c0740281fb9853ccde09ed53ebfc4bac21904cc7
+  metadata.gz: ee61867492cc8b0c28f58b9090625a08914e610e6a1732924a2b4d925a01a714
+  data.tar.gz: d7ae4281ca3738f92e84df29243c687693cf8aed64ba006d9c44541c25ba2029
 SHA512:
-  metadata.gz: 5ee1478689e350aeb60b9397c106c3576582d9ac8d33af80b4e721f5dfb6aa1509c149250f16869db85fe5ff5b3db3542da0575ad95517681d55fa77db815b19
-  data.tar.gz: 57ba40b8ca956807626b147592f55b1b193fffbcc5947ea47a11e1830f42a231a08dc0393c3f80fded3035b1897b0fa5579f37da27e97f83809946c692156766
+  metadata.gz: c61ca3b032274dc8cc5063e55465fdc2b418bbda7c6d8a4093405d61c5c2b49758faaf77f95a76eb0c46101e3ec0a4f9c1442744abe49bcc747a0b86de64bec9
+  data.tar.gz: f91ea52d72dcef0c50e87186b12f10c7118882e48e10ef667c64e59da159493ea8dd23b5bbb4256c9222d703afaf89d7554831d2ef523096151af9fdf9faaf9f

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 6.1.4 - 2021-12-09
+
+- Add support for CockroachDB v21.2.
+
+## 6.1.3 - 2021-07-28
+
+- Santitize the input to the telemetry query that is issued on startup.
+
+## 6.1.2 - 2021-05-20
+
+- Fix a bug where starting the driver can result in a ConnectionNotEstablished error.
+
+## 6.1.1 - 2021-05-14
+
+- Fix a bug where starting the driver can result in a NoDatabaseError. 
+
 ## 6.1.0 - 2021-04-26
 
 - Add a telemetry query on start-up. This helps the Cockroach Labs team

data/README.md

@@ -1,16 +1,18 @@
 # ActiveRecord CockroachDB Adapter
 
-CockroachDB adapter for ActiveRecord 4 and 5. This is a lightweight extension of the PostgreSQL adapter that establishes compatibility with [CockroachDB](https://github.com/cockroachdb/cockroach).
+CockroachDB adapter for ActiveRecord 5 and 6. 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', '~> 5.2.0'
+gem 'activerecord-cockroachdb-adapter', '~> 6.1.0'
 ```
 
-If you're using Rails 4.x, use the `0.1.x` versions of this gem.
+If you're using Rails 5.2, use the `5.2.x` versions of this gem.
+
+If you're using Rails 6.0, use the `6.0.x` versions of this gem.
 
 In `database.yml`, use the following adapter setting:
 

data/activerecord-cockroachdb-adapter.gemspec

@@ -1,10 +1,14 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require './lib/version.rb'
+version = ActiveRecord::COCKROACH_DB_ADAPTER_VERSION
+
 Gem::Specification.new do |spec|
   spec.name          = "activerecord-cockroachdb-adapter"
-  spec.version       = "6.1.0"
+  spec.version       = version
   spec.licenses      = ["Apache-2.0"]
   spec.authors       = ["Cockroach Labs"]
   spec.email         = ["cockroach-db@googlegroups.com"]

data/build/Dockerfile

@@ -4,7 +4,7 @@
 FROM cockroachdb/example-orms-builder:20200413-1918
 
 # Native dependencies for libxml-ruby and sqlite3.
-RUN apt-get update -y && apt-get install -y \
+RUN apt-get --allow-releaseinfo-change update -y && apt-get install -y \
   libxslt-dev \
   libxml2-dev \
   libsqlite3-dev \

data/build/teamcity-test.sh

@@ -3,7 +3,7 @@
 set -euox pipefail
 
 # Download CockroachDB
-VERSION=v20.2.3
+VERSION=v21.2.0
 wget -qO- https://binaries.cockroachdb.com/cockroach-$VERSION.linux-amd64.tgz | tar  xvz
 readonly COCKROACH=./cockroach-$VERSION.linux-amd64/cockroach
 
@@ -36,6 +36,7 @@ run_cockroach() {
   cockroach sql --insecure -e 'SET CLUSTER SETTING sql.stats.automatic_collection.enabled = false;'
   cockroach sql --insecure -e 'SET CLUSTER SETTING sql.stats.histogram_collection.enabled = false;'
   cockroach sql --insecure -e "SET CLUSTER SETTING jobs.retention_time = '180s';"
+  cockroach sql --insecure -e "SET CLUSTER SETTING sql.defaults.experimental_temporary_tables.enabled = 'true'"
 }
 
 # Install ruby dependencies.

data/docker.sh

@@ -4,10 +4,7 @@
 
 set -euox pipefail
 
-DOCKER_IMAGE_TAG=activerecord_test_container
-
-# Build the docker image to use.
-docker build -t ${DOCKER_IMAGE_TAG} build/
+DOCKER_IMAGE_TAG=cockroachdb/activerecord_test_container:20210914
 
 # Absolute path to this repository.
 repo_root=$(cd "$(dirname "${0}")" && pwd)
@@ -26,7 +23,7 @@ container_root=${repo_root}/docker_root
 mkdir -p "${container_root}"/{etc,home,home/"${username}"/activerecord-cockroachdb-adapter,home/.gems}
 echo "${username}:x:${uid_gid}::/home/${username}:/bin/bash" > "${container_root}/etc/passwd"
 
-docker run \
+exec docker run \
   --volume="${container_root}/etc/passwd:/etc/passwd" \
   --volume="${container_root}/home/${username}:/home/${username}" \
   --volume="${repo_root}:/home/${username}/activerecord-cockroachdb-adapter" \

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

@@ -22,7 +22,7 @@ module ActiveRecord
 
           foreign_keys.each do |foreign_key|
             begin
-              add_foreign_key(foreign_key.from_table, foreign_key.to_table, foreign_key.options)
+              add_foreign_key(foreign_key.from_table, foreign_key.to_table, **foreign_key.options)
             rescue ActiveRecord::StatementInvalid => error
               if error.cause.class == PG::DuplicateObject
                 # This error is safe to ignore because the yielded caller

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

@@ -32,6 +32,41 @@ module ActiveRecord
           end
         end
 
+        # override
+        # Modified version of the postgresql foreign_keys method.
+        # Replaces t2.oid::regclass::text with t2.relname since this is
+        # more efficient in CockroachDB.
+        def foreign_keys(table_name)
+          scope = quoted_scope(table_name)
+          fk_info = exec_query(<<~SQL, "SCHEMA")
+            SELECT t2.relname AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete, c.convalidated AS valid
+            FROM pg_constraint c
+            JOIN pg_class t1 ON c.conrelid = t1.oid
+            JOIN pg_class t2 ON c.confrelid = t2.oid
+            JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
+            JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
+            JOIN pg_namespace t3 ON c.connamespace = t3.oid
+            WHERE c.contype = 'f'
+              AND t1.relname = #{scope[:name]}
+              AND t3.nspname = #{scope[:schema]}
+            ORDER BY c.conname
+          SQL
+
+          fk_info.map do |row|
+            options = {
+              column: row["column"],
+              name: row["name"],
+              primary_key: row["primary_key"]
+            }
+
+            options[:on_delete] = extract_foreign_key_action(row["on_delete"])
+            options[:on_update] = extract_foreign_key_action(row["on_update"])
+            options[:validate] = row["valid"]
+
+            ForeignKeyDefinition.new(table_name, row["to_table"], options)
+          end
+        end
+
         # CockroachDB uses unique_rowid() for primary keys, not sequences. It's
         # possible to force a table to use sequences, but since it's not the
         # default behavior we'll always return nil for default_sequence_name.

data/lib/active_record/connection_adapters/cockroachdb_adapter.rb

@@ -17,6 +17,7 @@ require "active_record/connection_adapters/cockroachdb/oid/type_map_initializer"
 require "active_record/connection_adapters/cockroachdb/oid/spatial"
 require "active_record/connection_adapters/cockroachdb/oid/interval"
 require "active_record/connection_adapters/cockroachdb/arel_tosql"
+require_relative "../../version"
 
 # Run to ignore spatial tables that will break schemna dumper.
 # Defined in ./setup.rb
@@ -45,7 +46,9 @@ module ActiveRecord
     # This rescue flow appears in new_client, but it is needed here as well
     # since Cockroach will sometimes not raise until a query is made.
     rescue ActiveRecord::StatementInvalid => error
-      if conn_params && conn_params[:dbname] && error.cause.message.include?(conn_params[:dbname])
+      no_db_err_check1 = conn_params && conn_params[:dbname] && error.cause.message.include?(conn_params[:dbname])
+      no_db_err_check2 = conn_params && conn_params[:dbname] && error.cause.message.include?("pg_type")
+      if no_db_err_check1 || no_db_err_check2
         raise ActiveRecord::NoDatabaseError
       else
         raise ActiveRecord::ConnectionNotEstablished, error.message
@@ -63,18 +66,28 @@ module ActiveRecord
         adapter = pool_config.db_config.configuration_hash[:adapter]
         return if disable_telemetry || adapter != "cockroachdb"
 
-        with_connection do |conn|
-          if conn.active?
-            begin
-              query = "SELECT crdb_internal.increment_feature_counter('ActiveRecord %d.%d')"
-              conn.execute(query % [ActiveRecord::VERSION::MAJOR, ActiveRecord::VERSION::MINOR])
-            rescue ActiveRecord::StatementInvalid
-              # The increment_feature_counter built-in is not supported on this
-              # CockroachDB version. Ignore.
-            rescue StandardError => e
-              conn.logger.warn "Unexpected error when incrementing feature counter: #{e}"
+        begin
+          with_connection do |conn|
+            if conn.active?
+              begin
+                ar_version = conn.quote("ActiveRecord %d.%d" % [ActiveRecord::VERSION::MAJOR,
+                                                                ActiveRecord::VERSION::MINOR])
+                ar_query = "SELECT crdb_internal.increment_feature_counter(%s)" % ar_version
+                adapter_version = conn.quote("activerecord-cockroachdb-adapter #{ActiveRecord::COCKROACH_DB_ADAPTER_VERSION}")
+                adapter_query = "SELECT crdb_internal.increment_feature_counter(%s)" % adapter_version
+
+                conn.execute(ar_query)
+                conn.execute(adapter_query)
+              rescue ActiveRecord::StatementInvalid
+                # The increment_feature_counter built-in is not supported on this
+                # CockroachDB version. Ignore.
+              rescue StandardError => e
+                conn.logger.warn "Unexpected error when incrementing feature counter: #{e}"
+              end
             end
           end
+        rescue StandardError
+          # Prevent failures on db creation and parallel testing.
         end
       end
     end
@@ -98,7 +111,7 @@ module ActiveRecord
           st_polygon:          {},
         }
 
-      # http://postgis.17.x6.nabble.com/Default-SRID-td5001115.html      
+      # http://postgis.17.x6.nabble.com/Default-SRID-td5001115.html
       DEFAULT_SRID = 0
 
       include CockroachDB::SchemaStatements
@@ -162,12 +175,11 @@ module ActiveRecord
       end
 
       def supports_partial_index?
-        @crdb_version >= 202
+        @crdb_version >= 2020
       end
 
       def supports_expression_index?
-        # See cockroachdb/cockroach#9682
-        false
+        @crdb_version >= 2122
       end
 
       def supports_datetime_with_precision?
@@ -175,12 +187,10 @@ module ActiveRecord
       end
 
       def supports_comments?
-        # See cockroachdb/cockroach#19472.
-        false
+        @crdb_version >= 2010
       end
 
       def supports_comments_in_create?
-        # See cockroachdb/cockroach#19472.
         false
       end
 
@@ -189,12 +199,11 @@ module ActiveRecord
       end
 
       def supports_virtual_columns?
-        # See cockroachdb/cockroach#20882.
         false
       end
 
       def supports_string_to_array_coercion?
-        @crdb_version >= 202
+        @crdb_version >= 2020
       end
 
       def supports_partitioned_indexes?
@@ -225,15 +234,31 @@ module ActiveRecord
         elsif crdb_version_string.include? "v2."
           version_num 2
         elsif crdb_version_string.include? "v19.1."
-          version_num = 191
+          version_num = 1910
         elsif crdb_version_string.include? "v19.2."
-          version_num = 192
+          version_num = 1920
         elsif crdb_version_string.include? "v20.1."
-          version_num = 201
+          version_num = 2010
+        elsif crdb_version_string.include? "v20.2."
+          version_num = 2020
+        elsif crdb_version_string.include? "v21.1."
+          version_num = 2110
+        elsif crdb_version_string.include? "v21.2.0"
+          version_num = 2120
         else
-          version_num = 202
+          version_num = 2121
         end
         @crdb_version = version_num
+
+        # NOTE: this is normally in configure_connection, but that is run
+        # before crdb_version is determined. Once all supported versions
+        # of CockroachDB support SET intervalstyle it can safely be moved
+        # back.
+        # Set interval output format to ISO 8601 for ease of parsing by ActiveSupport::Duration.parse
+        if @crdb_version >= 2120
+          execute("SET intervalstyle_enabled = true", "SCHEMA")
+          execute("SET intervalstyle = iso_8601", "SCHEMA")
+        end
       end
 
       def self.database_exists?(config)
@@ -272,12 +297,9 @@ module ActiveRecord
             precision = extract_precision(sql_type)
             scale = extract_scale(sql_type)
 
-            # TODO(#178) this should never use DecimalWithoutScale since scale
-            # is assumed to be 0 if it is not explicitly defined.
-            #
             # If fmod is -1, that means that precision is defined but not
             # scale, or neither is defined.
-            if fmod && fmod == -1
+            if fmod && fmod == -1 && !precision.nil?
               # Below comment is from ActiveRecord
               # FIXME: Remove this class, and the second argument to
               # lookups on PG
@@ -344,7 +366,8 @@ module ActiveRecord
           super ||
             extract_escaped_string_from_default(default) ||
             extract_time_from_default(default) ||
-            extract_empty_array_from_default(default)
+            extract_empty_array_from_default(default) ||
+            extract_decimal_from_default(default)
         end
 
         # Both PostgreSQL and CockroachDB use C-style string escapes under the
@@ -390,11 +413,19 @@ module ActiveRecord
         # In general, it is hard to parse that, but it is easy to handle the common
         # case of an empty array.
         def extract_empty_array_from_default(default)
-          return unless supports_string_to_array_coercion? 
+          return unless supports_string_to_array_coercion?
           return unless default =~ /\AARRAY\[\]\z/
           return "{}"
         end
 
+        # This method exists to extract the decimal defaults (e.g. scientific notation)
+        # that don't get parsed correctly
+        def extract_decimal_from_default(default)
+          Float(default).to_s
+        rescue
+          nil
+        end
+
         # override
         # This method makes a query to gather information about columns
         # in a table. It returns an array of arrays (one for each col) and
@@ -408,7 +439,21 @@ module ActiveRecord
         #
         # @see: https://github.com/rails/rails/blob/8695b028261bdd244e254993255c6641bdbc17a5/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L829
         def column_definitions(table_name)
-          fields = super
+          fields = query(<<~SQL, "SCHEMA")
+              SELECT a.attname, format_type(a.atttypid, a.atttypmod),
+                     pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod,
+                     c.collname, NULL AS comment,
+                     #{supports_virtual_columns? ? 'attgenerated' : quote('')} as attgenerated
+                FROM pg_attribute a
+                LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
+                LEFT JOIN pg_type t ON a.atttypid = t.oid
+                LEFT JOIN pg_collation c ON a.attcollation = c.oid AND a.attcollation <> t.typcollation
+               WHERE a.attrelid = #{quote(quote_table_name(table_name))}::regclass
+                 AND a.attnum > 0 AND NOT a.attisdropped
+               ORDER BY a.attnum
+          SQL
+
+          crdb_fields = crdb_column_definitions(table_name)
 
           # Use regex comparison because if a type is an array it will
           # have [] appended to the end of it.
@@ -418,32 +463,33 @@ module ActiveRecord
             /interval/,
             /numeric/
           ]
+
           re = Regexp.union(target_types)
           fields.map do |field|
             dtype = field[1]
-            if re.match(dtype)
-              crdb_column_definition(field, table_name)
-            else
-              field
-            end
+            field[1] = crdb_fields[field[0]][2].downcase if re.match(dtype)
+            field[7] = crdb_fields[field[0]][1]&.gsub!(/^\'|\'?$/, '')
+            field
           end
         end
 
+        # Fetch the column comment because it's faster this way
         # Use the crdb_sql_type instead of the sql_type returned by
         # column_definitions. This will include limit,
         # precision, and scale information in the type.
         # Ex. geometry -> geometry(point, 4326)
-        def crdb_column_definition(field, table_name)
-          col_name = field[0]
-          data_type = \
+        def crdb_column_definitions(table_name)
+          fields = \
           query(<<~SQL, "SCHEMA")
-            SELECT c.crdb_sql_type
+            SELECT c.column_name, c.column_comment, c.crdb_sql_type
               FROM information_schema.columns c
             WHERE c.table_name = #{quote(table_name)}
-              AND c.column_name = #{quote(col_name)}
           SQL
-          field[1] = data_type[0][0].downcase
-          field
+
+          fields.reduce({}) do |a, e|
+            a[e[0]] = e
+            a
+          end
         end
 
         # override

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cockroachdb-adapter
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.4
 platform: ruby
 authors:
 - Cockroach Labs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -95,6 +95,7 @@ files:
 - lib/active_record/connection_adapters/cockroachdb/type.rb
 - lib/active_record/connection_adapters/cockroachdb_adapter.rb
 - lib/activerecord-cockroachdb-adapter.rb
+- lib/version.rb
 homepage: https://github.com/cockroachdb/activerecord-cockroachdb-adapter
 licenses:
 - Apache-2.0
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: CockroachDB adapter for ActiveRecord.