activerecord-sqlserver-adapter 5.2.1 → 6.0.0.rc1

data/docker-compose.ci.yml

@@ -1,11 +1,13 @@
 version: "2.2"
 services:
-  database:
+  sqlserver:
     image: metaskills/mssql-server-linux-rails
   ci:
     environment:
-      - ACTIVERECORD_UNITTEST_HOST=database
-    build: .
-    command: wait-for database:1433 -- bundle exec rake test
+      - ACTIVERECORD_UNITTEST_HOST=sqlserver
+    build:
+      context: .
+      dockerfile: Dockerfile.ci
+    command: wait-for sqlserver:1433 -- bundle exec rake test
     depends_on:
-      - "database"
+      - "sqlserver"

data/guides/RELEASING.md

@@ -0,0 +1,11 @@
+# Releasing
+
+## Building locally
+
+If you want to build the gem to test it locally run `bundle exec rake build`.
+
+This command will build the gem in `pkg/activerecord-sqlserver-adapter-A.B.C.gem`, where `A.B.C` is the version in `VERSION` file.
+
+## Releasing to RubyGems
+
+Run `bundle exec rake release` to build the gem locally and push the `gem` file to RubyGems.

data/lib/active_record/connection_adapters/sqlserver/core_ext/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer

data/lib/active_record/connection_adapters/sqlserver/core_ext/attribute_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record/attribute_methods'
 
 module ActiveRecord

data/lib/active_record/connection_adapters/sqlserver/core_ext/calculations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record/relation'
 require 'active_record/version'
 

data/lib/active_record/connection_adapters/sqlserver/core_ext/explain.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module CoreExt
         module Explain
 
-          SQLSERVER_STATEMENT_PREFIX = 'EXEC sp_executesql '.freeze
+          SQLSERVER_STATEMENT_PREFIX = 'EXEC sp_executesql '
           SQLSERVER_STATEMENT_REGEXP = /N'(.+)', N'(.+)', (.+)/
 
           def exec_explain(queries)

data/lib/active_record/connection_adapters/sqlserver/core_ext/explain_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ActiveSupport.on_load(:active_record) do
   silence_warnings do
     # Already defined in Rails

data/lib/active_record/connection_adapters/sqlserver/core_ext/finder_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record/relation'
 require 'active_record/version'
 
@@ -11,13 +13,13 @@ module ActiveRecord
 
           # Same as original except we order by values in distinct select if present.
           def construct_relation_for_exists(conditions)
-            if distinct_value && offset_value
-              relation = limit!(1)
+            conditions = sanitize_forbidden_attributes(conditions)
 
+            if distinct_value && offset_value
               if select_values.present?
-                relation = relation.order(*select_values)
+                relation = order(*select_values).limit!(1)
               else
-                relation = relation.except(:order)
+                relation = except(:order).limit!(1)
               end
             else
               relation = except(:select, :distinct, :order)._select!(::ActiveRecord::FinderMethods::ONE_AS_ONE).limit!(1)

data/lib/active_record/connection_adapters/sqlserver/core_ext/preloader.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "active_record/associations/preloader"
+
+module ActiveRecord
+  module ConnectionAdapters
+    module SQLServer
+      module CoreExt
+        module Preloader
+          private
+
+          def records_for(ids)
+            ids.each_slice(in_clause_length).flat_map do |slice|
+              scope.where(association_key_name => slice).load do |record|
+                # Processing only the first owner
+                # because the record is modified but not an owner
+                owner = owners_by_key[convert_key(record[association_key_name])].first
+                association = owner.association(reflection.name)
+                association.set_inverse_instance(record)
+              end.records
+            end
+          end
+
+          def in_clause_length
+            10_000
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  mod = ActiveRecord::ConnectionAdapters::SQLServer::CoreExt::Preloader
+  ActiveRecord::Associations::Preloader::Association.prepend(mod)
+end

data/lib/active_record/connection_adapters/sqlserver/core_ext/query_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record/relation'
 require 'active_record/version'
 
@@ -9,7 +11,8 @@ module ActiveRecord
 
           private
 
-          # Copy of original from Rails master. This patch can be removed when adapter supports Rails 6.
+          # Copy of original from Rails master.
+          # This patch can be removed when adapter supports Rails version greater than 6.0.2.2
           def table_name_matches?(from)
             table_name = Regexp.escape(table.name)
             quoted_table_name = Regexp.escape(connection.quote_table_name(table.name))

data/lib/active_record/connection_adapters/sqlserver/database_limits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
@@ -9,10 +11,12 @@ module ActiveRecord
         def column_name_length
           128
         end
+        deprecate :column_name_length
 
         def table_name_length
           128
         end
+        deprecate :table_name_length
 
         def index_name_length
           128
@@ -21,14 +25,17 @@ module ActiveRecord
         def columns_per_table
           1024
         end
+        deprecate :columns_per_table
 
         def indexes_per_table
           999
         end
+        deprecate :indexes_per_table
 
         def columns_per_multicolumn_index
           16
         end
+        deprecate :columns_per_multicolumn_index
 
         def in_clause_length
           10_000
@@ -37,10 +44,12 @@ module ActiveRecord
         def sql_query_length
           65_536 * 4_096
         end
+        deprecate :sql_query_length
 
         def joins_per_query
           256
         end
+        deprecate :joins_per_query
 
         private
 

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

@@ -1,9 +1,23 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module DatabaseStatements
+        READ_QUERY = ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(:begin, :commit, :dbcc, :explain, :save, :select, :set, :rollback) # :nodoc:
+        private_constant :READ_QUERY
+
+        def write_query?(sql) # :nodoc:
+          !READ_QUERY.match?(sql)
+        end
 
         def execute(sql, name = nil)
+          if preventing_writes? && write_query?(sql)
+            raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+          end
+
+          materialize_transactions
+
           if id_insert_table_name = query_requires_identity_insert?(sql)
             with_identity_insert_enabled(id_insert_table_name) { do_execute(sql, name) }
           else
@@ -12,6 +26,12 @@ module ActiveRecord
         end
 
         def exec_query(sql, name = 'SQL', binds = [], prepare: false)
+          if preventing_writes? && write_query?(sql)
+            raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+          end
+
+          materialize_transactions
+
           sp_executesql(sql, name, binds, prepare: prepare)
         end
 
@@ -71,9 +91,11 @@ module ActiveRecord
         def release_savepoint(name = current_savepoint_name)
         end
 
-        def case_sensitive_comparison(table, attribute, column, value)
+        def case_sensitive_comparison(attribute, value)
+          column = column_for_attribute(attribute)
+
           if column.collation && !column.case_sensitive?
-            table[attribute].eq(Arel::Nodes::Bin.new(value))
+            attribute.eq(Arel::Nodes::Bin.new(value))
           else
             super
           end
@@ -89,12 +111,12 @@ module ActiveRecord
             end
           end
 
-          table_deletes = tables_to_delete.map { |table| "DELETE FROM #{quote_table_name table}".dup }
-          total_sql = Array.wrap(combine_multi_statements(table_deletes + fixture_inserts))
+          table_deletes = tables_to_delete.map { |table| "DELETE FROM #{quote_table_name table}" }
+          total_sqls = Array.wrap(table_deletes + fixture_inserts)
 
           disable_referential_integrity do
             transaction(requires_new: true) do
-              total_sql.each do |sql|
+              total_sqls.each do |sql|
                 execute sql, "Fixtures Load"
                 yield if block_given?
               end
@@ -107,11 +129,6 @@ module ActiveRecord
         end
         private :can_perform_case_insensitive_comparison_for?
 
-        def combine_multi_statements(total_sql)
-          total_sql
-        end
-        private :combine_multi_statements
-
         def default_insert_value(column)
           if column.is_identity?
             table_name = quote(quote_table_name(column.table_name))
@@ -122,9 +139,22 @@ module ActiveRecord
         end
         private :default_insert_value
 
+        def build_insert_sql(insert) # :nodoc:
+          sql = +"INSERT #{insert.into}"
+
+          if returning = insert.send(:insert_all).returning
+            sql << " OUTPUT " << returning.map {|column| "INSERTED.#{quote_column_name(column)}" }.join(", ")
+          end
+
+          sql << " #{insert.values_list}"
+          sql
+        end
+
         # === SQLServer Specific ======================================== #
 
         def execute_procedure(proc_name, *variables)
+          materialize_transactions
+
           vars = if variables.any? && variables.first.is_a?(Hash)
                    variables.first.map { |k, v| "@#{k} = #{quote(v)}" }
                  else
@@ -221,18 +251,20 @@ module ActiveRecord
 
         protected
 
-        def sql_for_insert(sql, pk, id_value, sequence_name, binds)
+        def sql_for_insert(sql, pk, binds)
           if pk.nil?
             table_name = query_requires_identity_insert?(sql)
             pk = primary_key(table_name)
           end
+
           sql = if pk && use_output_inserted? && !database_prefix_remote_server?
                   quoted_pk = SQLServer::Utils.extract_identifiers(pk).quoted
                   table_name ||= get_table_name(sql)
                   exclude_output_inserted = exclude_output_inserted_table_name?(table_name, sql)
+
                   if exclude_output_inserted
                     id_sql_type = exclude_output_inserted.is_a?(TrueClass) ? 'bigint' : exclude_output_inserted
-                    <<-SQL.strip_heredoc
+                    <<~SQL.squish
                       DECLARE @ssaIdInsertTable table (#{quoted_pk} #{id_sql_type});
                       #{sql.dup.insert sql.index(/ (DEFAULT )?VALUES/), " OUTPUT INSERTED.#{quoted_pk} INTO @ssaIdInsertTable"}
                       SELECT CAST(#{quoted_pk} AS #{id_sql_type}) FROM @ssaIdInsertTable
@@ -257,6 +289,8 @@ module ActiveRecord
         # === SQLServer Specific (Executing) ============================ #
 
         def do_execute(sql, name = 'SQL')
+          materialize_transactions
+
           log(sql, name) { raw_connection_do(sql) }
         end
 
@@ -310,7 +344,7 @@ module ActiveRecord
             types = quote(types.join(', '))
             params = params.map.with_index{ |p, i| "@#{i} = #{p}" }.join(', ') # Only p is needed, but with @i helps explain regexp.
             sql = "EXEC sp_executesql #{quote(sql)}"
-            sql << ", #{types}, #{params}" unless params.empty?
+            sql += ", #{types}, #{params}" unless params.empty?
           end
           sql
         end
@@ -318,7 +352,14 @@ module ActiveRecord
         def raw_connection_do(sql)
           case @connection_options[:mode]
           when :dblib
-            @connection.execute(sql).do
+            result = @connection.execute(sql)
+
+            # TinyTDS returns false instead of raising an exception if connection fails.
+            # Getting around this by raising an exception ourselves while this PR
+            # https://github.com/rails-sqlserver/tiny_tds/pull/469 is not released.
+            raise TinyTds::Error, 'failed to execute statement' if result.is_a?(FalseClass)
+
+            result.do
           end
         ensure
           @update_sql = false

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer

data/lib/active_record/connection_adapters/sqlserver/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
 
   class DeadlockVictim < WrappedDatabaseException

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
@@ -68,6 +70,42 @@ module ActiveRecord
           end
         end
 
+        def column_name_matcher
+          COLUMN_NAME
+        end
+
+        def column_name_with_order_matcher
+          COLUMN_NAME_WITH_ORDER
+        end
+
+        COLUMN_NAME = /
+          \A
+          (
+            (?:
+              # [table_name].[column_name] | function(one or no argument)
+              ((?:\w+\.|\[\w+\]\.)?(?:\w+|\[\w+\])) | \w+\((?:|\g<2>)\)
+            )
+            (?:\s+AS\s+(?:\w+|\[\w+\]))?
+          )
+          (?:\s*,\s*\g<1>)*
+          \z
+        /ix
+
+        COLUMN_NAME_WITH_ORDER = /
+          \A
+          (
+            (?:
+              # [table_name].[column_name] | function(one or no argument)
+              ((?:\w+\.|\[\w+\]\.)?(?:\w+|\[\w+\])) | \w+\((?:|\g<2>)\)
+            )
+            (?:\s+ASC|\s+DESC)?
+            (?:\s+NULLS\s+(?:FIRST|LAST))?
+          )
+          (?:\s*,\s*\g<1>)*
+          \z
+        /ix
+
+        private_constant :COLUMN_NAME, :COLUMN_NAME_WITH_ORDER
 
         private
 

data/lib/active_record/connection_adapters/sqlserver/schema_creation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
@@ -6,15 +8,26 @@ module ActiveRecord
         private
 
         def visit_TableDefinition(o)
+          if_not_exists = o.if_not_exists
+
           if o.as
             table_name = quote_table_name(o.temporary ? "##{o.name}" : o.name)
             query = o.as.respond_to?(:to_sql) ? o.as.to_sql : o.as
             projections, source = query.match(%r{SELECT\s+(.*)?\s+FROM\s+(.*)?}).captures
-            select_into = "SELECT #{projections} INTO #{table_name} FROM #{source}"
+            sql = "SELECT #{projections} INTO #{table_name} FROM #{source}"
           else
             o.instance_variable_set :@as, nil
-            super
+            o.instance_variable_set :@if_not_exists, false
+            sql = super
           end
+
+          if if_not_exists
+            o.instance_variable_set :@if_not_exists, true
+            table_name = o.temporary ? "##{o.name}" : o.name
+            sql = "IF NOT EXISTS (SELECT * FROM sysobjects WHERE name='#{table_name}' and xtype='U') #{sql}"
+          end
+
+          sql
         end
 
         def add_column_options!(sql, options)
@@ -34,7 +47,7 @@ module ActiveRecord
         def action_sql(action, dependency)
           case dependency
           when :restrict
-            raise ArgumentError, <<-MSG.strip_heredoc
+            raise ArgumentError, <<~MSG.squish
               '#{dependency}' is not supported for :on_update or :on_delete.
               Supported values are: :nullify, :cascade
             MSG