activerecord-sqlserver-adapter 5.2.1 → 6.0.0

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

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module CoreExt
         module ActiveRecord
-
           extend ActiveSupport::Concern
 
           module ClassMethods
-
             def execute_procedure(proc_name, *variables)
               if connection.respond_to?(:execute_procedure)
                 connection.execute_procedure(proc_name, *variables)
@@ -15,9 +15,7 @@ module ActiveRecord
                 []
               end
             end
-
           end
-
         end
       end
     end

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

@@ -1,12 +1,12 @@
-require 'active_record/attribute_methods'
+# frozen_string_literal: true
+
+require "active_record/attribute_methods"
 
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module CoreExt
         module AttributeMethods
-
-
           private
 
           def attributes_for_update(attribute_names)
@@ -15,7 +15,6 @@ module ActiveRecord
               column && column.respond_to?(:is_identity?) && column.is_identity?
             end
           end
-
         end
       end
     end

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

@@ -1,12 +1,13 @@
-require 'active_record/relation'
-require 'active_record/version'
+# frozen_string_literal: true
+
+require "active_record/relation"
+require "active_record/version"
 
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module CoreExt
         module Calculations
-
           # Same as original except we don't perform PostgreSQL hack that removes ordering.
           def calculate(operation, column_name)
             if has_include?(column_name)
@@ -15,7 +16,7 @@ module ActiveRecord
               if operation.to_s.downcase == "count"
                 unless distinct_value || distinct_select?(column_name || select_for_count)
                   relation.distinct!
-                  relation.select_values = [ klass.primary_key || table[Arel.star] ]
+                  relation.select_values = [klass.primary_key || table[Arel.star]]
                 end
               end
 

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

@@ -1,10 +1,11 @@
+# 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)
@@ -32,7 +33,6 @@ module ActiveRecord
 
             executesql
           end
-
         end
       end
     end

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,23 +1,24 @@
-require 'active_record/relation'
-require 'active_record/version'
+# frozen_string_literal: true
+
+require "active_record/relation"
+require "active_record/version"
 
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module CoreExt
         module FinderMethods
-
           private
 
           # 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,15 +1,17 @@
-require 'active_record/relation'
-require 'active_record/version'
+# frozen_string_literal: true
+
+require "active_record/relation"
+require "active_record/version"
 
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module CoreExt
         module QueryMethods
-
           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
@@ -11,7 +25,13 @@ module ActiveRecord
           end
         end
 
-        def exec_query(sql, name = 'SQL', binds = [], prepare: false)
+        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
 
@@ -24,17 +44,17 @@ module ActiveRecord
         end
 
         def exec_delete(sql, name, binds)
-          sql = sql.dup << '; SELECT @@ROWCOUNT AS AffectedRows'
+          sql = sql.dup << "; SELECT @@ROWCOUNT AS AffectedRows"
           super(sql, name, binds).rows.first.first
         end
 
         def exec_update(sql, name, binds)
-          sql = sql.dup << '; SELECT @@ROWCOUNT AS AffectedRows'
+          sql = sql.dup << "; SELECT @@ROWCOUNT AS AffectedRows"
           super(sql, name, binds).rows.first.first
         end
 
         def begin_db_transaction
-          do_execute 'BEGIN TRANSACTION'
+          do_execute "BEGIN TRANSACTION"
         end
 
         def transaction_isolation_levels
@@ -51,11 +71,11 @@ module ActiveRecord
         end
 
         def commit_db_transaction
-          do_execute 'COMMIT TRANSACTION'
+          do_execute "COMMIT TRANSACTION"
         end
 
         def exec_rollback_db_transaction
-          do_execute 'IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION'
+          do_execute "IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION"
         end
 
         include Savepoints
@@ -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,16 +139,29 @@ 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
                    variables.map { |v| quote(v) }
-                 end.join(', ')
+                 end.join(", ")
           sql = "EXEC #{proc_name} #{vars}".strip
-          name = 'Execute Procedure'
+          name = "Execute Procedure"
           log(sql, name) do
             case @connection_options[:mode]
             when :dblib
@@ -156,20 +186,22 @@ module ActiveRecord
 
         def use_database(database = nil)
           return if sqlserver_azure?
+
           name = SQLServer::Utils.extract_identifiers(database || @connection_options[:database]).quoted
           do_execute "USE #{name}" unless name.blank?
         end
 
         def user_options
           return {} if sqlserver_azure?
-          rows = select_rows('DBCC USEROPTIONS WITH NO_INFOMSGS', 'SCHEMA')
+
+          rows = select_rows("DBCC USEROPTIONS WITH NO_INFOMSGS", "SCHEMA")
           rows = rows.first if rows.size == 2 && rows.last.empty?
           rows.reduce(HashWithIndifferentAccess.new) do |values, row|
             if row.instance_of? Hash
-              set_option = row.values[0].gsub(/\s+/, '_')
+              set_option = row.values[0].gsub(/\s+/, "_")
               user_value = row.values[1]
-            elsif  row.instance_of? Array
-              set_option = row[0].gsub(/\s+/, '_')
+            elsif row.instance_of? Array
+              set_option = row[0].gsub(/\s+/, "_")
               user_value = row[1]
             end
             values[set_option] = user_value
@@ -179,9 +211,9 @@ module ActiveRecord
 
         def user_options_dateformat
           if sqlserver_azure?
-            select_value 'SELECT [dateformat] FROM [sys].[syslanguages] WHERE [langid] = @@LANGID', 'SCHEMA'
+            select_value "SELECT [dateformat] FROM [sys].[syslanguages] WHERE [langid] = @@LANGID", "SCHEMA"
           else
-            user_options['dateformat']
+            user_options["dateformat"]
           end
         end
 
@@ -196,43 +228,44 @@ module ActiveRecord
                     WHEN 5 THEN 'SNAPSHOT' END AS [isolation_level]
                     FROM [sys].[dm_exec_sessions]
                     WHERE [session_id] = @@SPID).squish
-            select_value sql, 'SCHEMA'
+            select_value sql, "SCHEMA"
           else
-            user_options['isolation_level']
+            user_options["isolation_level"]
           end
         end
 
         def user_options_language
           if sqlserver_azure?
-            select_value 'SELECT @@LANGUAGE AS [language]', 'SCHEMA'
+            select_value "SELECT @@LANGUAGE AS [language]", "SCHEMA"
           else
-            user_options['language']
+            user_options["language"]
           end
         end
 
         def newid_function
-          select_value 'SELECT NEWID()'
+          select_value "SELECT NEWID()"
         end
 
         def newsequentialid_function
-          select_value 'SELECT NEWSEQUENTIALID()'
+          select_value "SELECT NEWSEQUENTIALID()"
         end
 
-
         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
+                    id_sql_type = exclude_output_inserted.is_a?(TrueClass) ? "bigint" : exclude_output_inserted
+                    <<~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
@@ -256,7 +289,9 @@ module ActiveRecord
 
         # === SQLServer Specific (Executing) ============================ #
 
-        def do_execute(sql, name = 'SQL')
+        def do_execute(sql, name = "SQL")
+          materialize_transactions
+
           log(sql, name) { raw_connection_do(sql) }
         end
 
@@ -282,11 +317,12 @@ module ActiveRecord
 
         def sp_executesql_sql_type(attr)
           return attr.type.sqlserver_type if attr.type.respond_to?(:sqlserver_type)
+
           case value = attr.value_for_database
           when Numeric
-            value > 2_147_483_647 ? 'bigint'.freeze : 'int'.freeze
+            value > 2_147_483_647 ? "bigint".freeze : "int".freeze
           else
-            'nvarchar(max)'.freeze
+            "nvarchar(max)".freeze
           end
         end
 
@@ -301,16 +337,16 @@ module ActiveRecord
         end
 
         def sp_executesql_sql(sql, types, params, name)
-          if name == 'EXPLAIN'
+          if name == "EXPLAIN"
             params.each.with_index do |param, index|
               substitute_at_finder = /(@#{index})(?=(?:[^']|'[^']*')*$)/ # Finds unquoted @n values.
               sql = sql.sub substitute_at_finder, param.to_s
             end
           else
-            types = quote(types.join(', '))
-            params = params.map.with_index{ |p, i| "@#{i} = #{p}" }.join(', ') # Only p is needed, but with @i helps explain regexp.
+            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 +354,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
@@ -336,8 +379,10 @@ module ActiveRecord
 
         def exclude_output_inserted_table_name?(table_name, sql)
           return false unless exclude_output_inserted_table_names?
+
           table_name ||= get_table_name(sql)
           return false unless table_name
+
           self.class.exclude_output_inserted_table_names[table_name]
         end
 
@@ -366,7 +411,7 @@ module ActiveRecord
 
         # === SQLServer Specific (Selecting) ============================ #
 
-        def raw_select(sql, name = 'SQL', binds = [], options = {})
+        def raw_select(sql, name = "SQL", binds = [], options = {})
           log(sql, name, binds) { _raw_select(sql, options) }
         end
 
@@ -414,7 +459,6 @@ module ActiveRecord
           end
           handle
         end
-
       end
     end
   end

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

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module DatabaseTasks
-
         def create_database(database, options = {})
           name = SQLServer::Utils.extract_identifiers(database)
           db_options = create_database_options(options)
@@ -17,7 +18,7 @@ module ActiveRecord
         end
 
         def current_database
-          select_value 'SELECT DB_NAME()'
+          select_value "SELECT DB_NAME()"
         end
 
         def charset
@@ -30,20 +31,20 @@ module ActiveRecord
 
         private
 
-        def create_database_options(options={})
+        def create_database_options(options = {})
           keys  = [:collate]
           copts = @connection_options
           options = {
             collate: copts[:collation]
           }.merge(options.symbolize_keys).select { |_, v|
             v.present?
-          }.slice(*keys).map { |k,v|
+          }.slice(*keys).map { |k, v|
             "#{k.to_s.upcase} #{v}"
-          }.join(' ')
+          }.join(" ")
           options
         end
 
-        def create_database_edition_options(options={})
+        def create_database_edition_options(options = {})
           keys  = [:maxsize, :edition, :service_objective]
           copts = @connection_options
           edition_options = {
@@ -52,17 +53,13 @@ module ActiveRecord
             service_objective: copts[:azure_service_objective]
           }.merge(options.symbolize_keys).select { |_, v|
             v.present?
-          }.slice(*keys).map { |k,v|
+          }.slice(*keys).map { |k, v|
             "#{k.to_s.upcase} = #{v}"
-          }.join(', ')
+          }.join(", ")
           edition_options = "( #{edition_options} )" if edition_options.present?
           edition_options
         end
-
       end
     end
   end
 end
-
-
-

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

@@ -1,7 +1,6 @@
-module ActiveRecord
+# frozen_string_literal: true
 
+module ActiveRecord
   class DeadlockVictim < WrappedDatabaseException
   end
-
-
 end