activerecord-jdbc-alt-adapter 71.0.0-java → 72.0.0.rc1-java

data/lib/arjdbc/sqlite3/adapter.rb

@@ -17,6 +17,8 @@ require "active_record/connection_adapters/sqlite3/schema_dumper"
 require "active_record/connection_adapters/sqlite3/schema_statements"
 require "active_support/core_ext/class/attribute"
 require "arjdbc/sqlite3/column"
+require "arjdbc/sqlite3/adapter_hash_config"
+require "arjdbc/sqlite3/pragmas"
 
 require "arjdbc/abstract/relation_query_attribute_monkey_patch"
 
@@ -58,18 +60,12 @@ module ArJdbc
     # DIFFERENCE: Some common constant names to reduce differences in rest of this module from AR5 version
     ConnectionAdapters = ::ActiveRecord::ConnectionAdapters
     IndexDefinition = ::ActiveRecord::ConnectionAdapters::IndexDefinition
+    ForeignKeyDefinition = ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition
     Quoting = ::ActiveRecord::ConnectionAdapters::SQLite3::Quoting
     RecordNotUnique = ::ActiveRecord::RecordNotUnique
     SchemaCreation = ConnectionAdapters::SQLite3::SchemaCreation
     SQLite3Adapter = ConnectionAdapters::AbstractAdapter
 
-    ADAPTER_NAME = 'SQLite'
-
-    # DIFFERENCE: FQN
-    include ::ActiveRecord::ConnectionAdapters::SQLite3::Quoting
-    include ::ActiveRecord::ConnectionAdapters::SQLite3::SchemaStatements
-    include ::ActiveRecord::ConnectionAdapters::SQLite3::DatabaseStatements
-
     NATIVE_DATABASE_TYPES = {
         primary_key:  "integer PRIMARY KEY AUTOINCREMENT NOT NULL",
         string:       { name: "varchar" },
@@ -84,7 +80,16 @@ module ArJdbc
         boolean:      { name: "boolean" },
         json:         { name: "json" },
     }
-    
+
+    DEFAULT_PRAGMAS = {
+      "foreign_keys"        => true,
+      "journal_mode"        => :wal,
+      "synchronous"         => :normal,
+      "mmap_size"           => 134217728, # 128 megabytes
+      "journal_size_limit"  => 67108864, # 64 megabytes
+      "cache_size"          => 2000
+    }
+
     class StatementPool < ConnectionAdapters::StatementPool # :nodoc:
       private
       def dealloc(stmt)
@@ -160,8 +165,23 @@ module ArJdbc
       !@memory_database
     end
 
+    def supports_virtual_columns?
+      database_version >= "3.31.0"
+    end
+
+    def connected?
+      !(@raw_connection.nil? || @raw_connection.closed?)
+    end
+
     def active?
-      @raw_connection && !@raw_connection.closed?
+      if connected?
+        @lock.synchronize do
+          if @raw_connection&.active?
+            verified!
+            true
+          end
+        end
+      end || false
     end
 
     def return_value_after_insert?(column) # :nodoc:
@@ -173,10 +193,11 @@ module ArJdbc
     # Disconnects from the database if already connected. Otherwise, this
     # method does nothing.
     def disconnect!
-      super
-
-      @raw_connection&.close rescue nil
-      @raw_connection = nil
+      @lock.synchronize do
+        super
+        @raw_connection&.close rescue nil
+        @raw_connection = nil
+      end
     end
 
     def supports_index_sort_order?
@@ -241,7 +262,6 @@ module ArJdbc
       internal_exec_query "DROP INDEX #{quote_column_name(index_name)}"
     end
 
-    
     # Renames a table.
     #
     # Example:
@@ -330,15 +350,31 @@ module ArJdbc
     end
     alias :add_belongs_to :add_reference
 
+    FK_REGEX = /.*FOREIGN KEY\s+\("([^"]+)"\)\s+REFERENCES\s+"(\w+)"\s+\("(\w+)"\)/
+    DEFERRABLE_REGEX = /DEFERRABLE INITIALLY (\w+)/
     def foreign_keys(table_name)
       # SQLite returns 1 row for each column of composite foreign keys.
       fk_info = internal_exec_query("PRAGMA foreign_key_list(#{quote(table_name)})", "SCHEMA")
+      # Deferred or immediate foreign keys can only be seen in the CREATE TABLE sql
+      fk_defs = table_structure_sql(table_name)
+                  .select do |column_string|
+                    column_string.start_with?("CONSTRAINT") &&
+                    column_string.include?("FOREIGN KEY")
+                  end
+                  .to_h do |fk_string|
+                    _, from, table, to = fk_string.match(FK_REGEX).to_a
+                    _, mode = fk_string.match(DEFERRABLE_REGEX).to_a
+                    deferred = mode&.downcase&.to_sym || false
+                    [[table, from, to], deferred]
+                  end
+
       grouped_fk = fk_info.group_by { |row| row["id"] }.values.each { |group| group.sort_by! { |row| row["seq"] } }
       grouped_fk.map do |group|
         row = group.first
         options = {
           on_delete: extract_foreign_key_action(row["on_delete"]),
-          on_update: extract_foreign_key_action(row["on_update"])
+          on_update: extract_foreign_key_action(row["on_update"]),
+          deferrable: fk_defs[[row["table"], row["from"], row["to"]]]
         }
 
         if group.one?
@@ -348,8 +384,7 @@ module ArJdbc
           options[:column] = group.map { |row| row["from"] }
           options[:primary_key] = group.map { |row| row["to"] }
         end
-        # DIFFERENCE: FQN
-        ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(table_name, row["table"], options)
+        ForeignKeyDefinition.new(table_name, row["table"], options)
       end
     end
 
@@ -396,7 +431,14 @@ module ArJdbc
 
       type_metadata = fetch_type_metadata(field["type"])
       default_value = extract_value_from_default(default)
-      default_function = extract_default_function(default_value, default)
+      generated_type = extract_generated_type(field)
+
+      if generated_type.present?
+        default_function = default
+      else
+        default_function = extract_default_function(default_value, default)
+      end
+
       rowid = is_column_the_rowid?(field, definitions)
 
       ActiveRecord::ConnectionAdapters::SQLite3Column.new(
@@ -407,7 +449,8 @@ module ArJdbc
         default_function,
         collation: field["collation"],
         auto_increment: field["auto_increment"],
-        rowid: rowid
+        rowid: rowid,
+        generated_type: generated_type
       )
     end
 
@@ -419,7 +462,12 @@ module ArJdbc
     end
 
     def table_structure(table_name)
-      structure = internal_exec_query("PRAGMA table_info(#{quote_table_name(table_name)})", "SCHEMA")
+      structure = if supports_virtual_columns?
+        internal_exec_query("PRAGMA table_xinfo(#{quote_table_name(table_name)})", "SCHEMA")
+      else
+        internal_exec_query("PRAGMA table_info(#{quote_table_name(table_name)})", "SCHEMA")
+      end
+
       raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if structure.empty?
       table_structure_with_collation(table_name, structure)
     end
@@ -459,8 +507,9 @@ module ArJdbc
     # See: https://www.sqlite.org/lang_altertable.html
     # SQLite has an additional restriction on the ALTER TABLE statement
     def invalid_alter_table_type?(type, options)
-      type.to_sym == :primary_key || options[:primary_key] ||
-        options[:null] == false && options[:default].nil?
+      type == :primary_key || options[:primary_key] ||
+        options[:null] == false && options[:default].nil? ||
+        (type == :virtual && options[:stored])
     end
 
     def alter_table(
@@ -516,12 +565,6 @@ module ArJdbc
              options[:rename][column.name.to_sym] ||
              column.name) : column.name
 
-          if column.has_default?
-            type = lookup_cast_type_from_column(column)
-            default = type.deserialize(column.default)
-            default = -> { column.default_function } if default.nil?
-          end
-
           column_options = {
             limit: column.limit,
             precision: column.precision,
@@ -531,19 +574,31 @@ module ArJdbc
             primary_key: column_name == from_primary_key
           }
 
-          unless column.auto_increment?
-            column_options[:default] = default
+          if column.virtual?
+            column_options[:as] = column.default_function
+            column_options[:stored] = column.virtual_stored?
+            column_options[:type] = column.type
+          elsif column.has_default?
+            type = lookup_cast_type_from_column(column)
+            default = type.deserialize(column.default)
+            default = -> { column.default_function } if default.nil?
+
+            unless column.auto_increment?
+              column_options[:default] = default
+            end
           end
 
-          column_type = column.bigint? ? :bigint : column.type
+          column_type = column.virtual? ? :virtual : (column.bigint? ? :bigint : column.type)
           @definition.column(column_name, column_type, **column_options)
         end
 
         yield @definition if block_given?
       end
       copy_table_indexes(from, to, options[:rename] || {})
+
+      columns_to_copy = @definition.columns.reject { |col| col.options.key?(:as) }.map(&:name)
       copy_table_contents(from, to,
-        @definition.columns.map(&:name),
+        columns_to_copy,
         options[:rename] || {})
     end
 
@@ -617,32 +672,22 @@ module ArJdbc
 
     COLLATE_REGEX = /.*\"(\w+)\".*collate\s+\"(\w+)\".*/i.freeze
     PRIMARY_KEY_AUTOINCREMENT_REGEX = /.*\"(\w+)\".+PRIMARY KEY AUTOINCREMENT/i
+    GENERATED_ALWAYS_AS_REGEX = /.*"(\w+)".+GENERATED ALWAYS AS \((.+)\) (?:STORED|VIRTUAL)/i
 
     def table_structure_with_collation(table_name, basic_structure)
       collation_hash = {}
       auto_increments = {}
-      sql = <<~SQL
-        SELECT sql FROM
-          (SELECT * FROM sqlite_master UNION ALL
-           SELECT * FROM sqlite_temp_master)
-        WHERE type = 'table' AND name = #{quote(table_name)}
-      SQL
+      generated_columns = {}
 
-      # Result will have following sample string
-      # CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
-      #                       "password_digest" varchar COLLATE "NOCASE");
-      result = query_value(sql, "SCHEMA")
+      column_strings = table_structure_sql(table_name, basic_structure.map { |column| column["name"] })
 
-      if result
-        # Splitting with left parentheses and discarding the first part will return all
-        # columns separated with comma(,).
-        columns_string = result.split("(", 2).last
-
-        columns_string.split(",").each do |column_string|
+      if column_strings.any?
+        column_strings.each do |column_string|
           # This regex will match the column name and collation type and will save
           # the value in $1 and $2 respectively.
           collation_hash[$1] = $2 if COLLATE_REGEX =~ column_string
           auto_increments[$1] = true if PRIMARY_KEY_AUTOINCREMENT_REGEX =~ column_string
+          generated_columns[$1] = $2 if GENERATED_ALWAYS_AS_REGEX =~ column_string
         end
 
         basic_structure.map do |column|
@@ -656,6 +701,10 @@ module ArJdbc
             column["auto_increment"] = true
           end
 
+          if generated_columns.has_key?(column_name)
+            column["dflt_value"] = generated_columns[column_name]
+          end
+
           column
         end
       else
@@ -663,6 +712,50 @@ module ArJdbc
       end
     end
 
+    UNQUOTED_OPEN_PARENS_REGEX = /\((?![^'"]*['"][^'"]*$)/
+    FINAL_CLOSE_PARENS_REGEX = /\);*\z/
+
+    def table_structure_sql(table_name, column_names = nil)
+      unless column_names
+        column_info = table_info(table_name)
+        column_names = column_info.map { |column| column["name"] }
+      end
+
+      sql = <<~SQL
+        SELECT sql FROM
+          (SELECT * FROM sqlite_master UNION ALL
+           SELECT * FROM sqlite_temp_master)
+        WHERE type = 'table' AND name = #{quote(table_name)}
+      SQL
+
+      # Result will have following sample string
+      # CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+      #                       "password_digest" varchar COLLATE "NOCASE",
+      #                       "o_id" integer,
+      #                       CONSTRAINT "fk_rails_78146ddd2e" FOREIGN KEY ("o_id") REFERENCES "os" ("id"));
+      result = query_value(sql, "SCHEMA")
+
+      return [] unless result
+
+      # Splitting with left parentheses and discarding the first part will return all
+      # columns separated with comma(,).
+      result.partition(UNQUOTED_OPEN_PARENS_REGEX)
+            .last
+            .sub(FINAL_CLOSE_PARENS_REGEX, "")
+            # column definitions can have a comma in them, so split on commas followed
+            # by a space and a column name in quotes or followed by the keyword CONSTRAINT
+            .split(/,(?=\s(?:CONSTRAINT|"(?:#{Regexp.union(column_names).source})"))/i)
+            .map(&:strip)
+    end
+
+    def table_info(table_name)
+      if supports_virtual_columns?
+        internal_exec_query("PRAGMA table_xinfo(#{quote_table_name(table_name)})", "SCHEMA")
+      else
+        internal_exec_query("PRAGMA table_info(#{quote_table_name(table_name)})", "SCHEMA")
+      end
+    end
+
     def arel_visitor
       Arel::Visitors::SQLite.new(self)
     end
@@ -692,29 +785,17 @@ module ArJdbc
         end
       end
 
-      # Enforce foreign key constraints
-      # https://www.sqlite.org/pragma.html#pragma_foreign_keys
-      # https://www.sqlite.org/foreignkeys.html
-      raw_execute("PRAGMA foreign_keys = ON", "SCHEMA")
-      unless @memory_database
-        # Journal mode WAL allows for greater concurrency (many readers + one writer)
-        # https://www.sqlite.org/pragma.html#pragma_journal_mode
-        raw_execute("PRAGMA journal_mode = WAL", "SCHEMA")
-        # Set more relaxed level of database durability
-        # 2 = "FULL" (sync on every write), 1 = "NORMAL" (sync every 1000 written pages) and 0 = "NONE"
-        # https://www.sqlite.org/pragma.html#pragma_synchronous
-        raw_execute("PRAGMA synchronous = NORMAL", "SCHEMA")
-        # Set the global memory map so all processes can share some data
-        # https://www.sqlite.org/pragma.html#pragma_mmap_size
-        # https://www.sqlite.org/mmap.html
-        raw_execute("PRAGMA mmap_size = #{128.megabytes}", "SCHEMA")
-      end
-      # Impose a limit on the WAL file to prevent unlimited growth
-      # https://www.sqlite.org/pragma.html#pragma_journal_size_limit
-      raw_execute("PRAGMA journal_size_limit = #{64.megabytes}", "SCHEMA")
-      # Set the local connection cache to 2000 pages
-      # https://www.sqlite.org/pragma.html#pragma_cache_size
-      raw_execute("PRAGMA cache_size = 2000", "SCHEMA")
+      super
+
+      pragmas = @config.fetch(:pragmas, {}).stringify_keys
+      DEFAULT_PRAGMAS.merge(pragmas).each do |pragma, value|
+        if ::SQLite3::Pragmas.respond_to?(pragma)
+          stmt = ::SQLite3::Pragmas.public_send(pragma, value)
+          raw_execute(stmt, "SCHEMA")
+        else
+          warn "Unknown SQLite pragma: #{pragma}"
+        end
+      end
     end
   end
   # DIFFERENCE: A registration here is moved down to concrete class so we are not registering part of an adapter.
@@ -729,13 +810,44 @@ module ActiveRecord::ConnectionAdapters
   # ActiveRecord::ConnectionAdapters::SQLite3Adapter.  Once we can do that we can remove the
   # module SQLite3 above and remove a majority of this file.
   class SQLite3Adapter < AbstractAdapter
+    ADAPTER_NAME = "SQLite"
+
+    class << self
+      def new_client(conn_params, adapter_instance)
+        jdbc_connection_class.new(conn_params, adapter_instance)
+      end
+
+      def dbconsole(config, options = {})
+        args = []
+
+        args << "-#{options[:mode]}" if options[:mode]
+        args << "-header" if options[:header]
+        args << File.expand_path(config.database, const_defined?(:Rails) && Rails.respond_to?(:root) ? Rails.root : nil)
+
+        find_cmd_and_exec("sqlite3", *args)
+      end
+
+      def jdbc_connection_class
+        ::ActiveRecord::ConnectionAdapters::SQLite3JdbcConnection
+      end
+    end
+
+    # NOTE: include these modules before all then override some methods with the
+    # ones defined in ArJdbc::SQLite3 java part and ArJdbc::Abstract
+    include ::ActiveRecord::ConnectionAdapters::SQLite3::Quoting
+    include ::ActiveRecord::ConnectionAdapters::SQLite3::SchemaStatements
+    include ::ActiveRecord::ConnectionAdapters::SQLite3::DatabaseStatements
+
     include ArJdbc::Abstract::Core
     include ArJdbc::SQLite3
+    include ArJdbc::SQLite3Config
+
     include ArJdbc::Abstract::ConnectionManagement
     include ArJdbc::Abstract::DatabaseStatements
     include ArJdbc::Abstract::StatementCache
     include ArJdbc::Abstract::TransactionSupport
 
+
     ##
     # :singleton-method:
     # Configure the SQLite3Adapter to be used in a strict strings mode.
@@ -749,7 +861,16 @@ module ActiveRecord::ConnectionAdapters
     def initialize(...)
       super
 
-      conn_params = @config.compact
+      @memory_database = false
+      case @config[:database].to_s
+      when ""
+        raise ArgumentError, "No database file specified. Missing argument: database"
+      when ":memory:"
+        @memory_database = true
+      end
+
+      # assign arjdbc extra connection params
+      conn_params = build_connection_config(@config.compact)
 
       # NOTE: strict strings is not supported by the jdbc driver yet,
       # hope it will supported soon, I open a issue in their repository.
@@ -820,24 +941,6 @@ module ActiveRecord::ConnectionAdapters
     ::ActiveRecord::Type.register(:integer, SQLite3Integer, adapter: :sqlite3)
 
     class << self
-      def jdbc_connection_class
-        ::ActiveRecord::ConnectionAdapters::SQLite3JdbcConnection
-      end
-
-      def new_client(conn_params, adapter_instance)
-        jdbc_connection_class.new(conn_params, adapter_instance)
-      end
-
-      def dbconsole(config, options = {})
-        args = []
-
-        args << "-#{options[:mode]}" if options[:mode]
-        args << "-header" if options[:header]
-        args << File.expand_path(config.database, const_defined?(:Rails) && Rails.respond_to?(:root) ? Rails.root : nil)
-
-        find_cmd_and_exec("sqlite3", *args)
-      end
-
       private
         def initialize_type_map(m)
           super

data/lib/arjdbc/sqlite3/adapter_hash_config.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module ArJdbc
+  module SQLite3Config
+    def build_connection_config(config)
+      config = config.deep_dup
+
+      load_jdbc_driver
+
+      config[:driver] ||= "org.sqlite.JDBC"
+
+      parse_sqlite3_config!(config)
+
+      database = config[:database]
+
+      # NOTE: "jdbc:sqlite::memory:" syntax is supported
+      config[:url] ||= "jdbc:sqlite:#{database == ':memory:' ? '' : database}"
+      config[:connection_alive_sql] ||= "SELECT 1"
+
+      config[:properties] = build_properties(config)
+
+      config
+    end
+
+    private
+
+    def load_jdbc_driver
+      require "jdbc/sqlite3"
+
+      ::Jdbc::SQLite3.load_driver(:require) if defined?(::Jdbc::SQLite3.load_driver)
+    rescue LoadError
+      # assuming driver.jar is on the class-path
+    end
+
+    def build_properties(config)
+      properties = config[:properties] || {}
+
+      if config[:readonly]
+        # See
+        # * http://sqlite.org/c3ref/open.html
+        # * http://sqlite.org/c3ref/c_open_autoproxy.html
+        # => 0x01 = readonly, 0x40 = uri (default in JDBC)
+        properties[:open_mode] =
+          ::SQLite3::Constants::Open::READONLY | ::SQLite3::Constants::Open::URI
+      end
+
+      if config[:flags]
+        properties[:open_mode] ||= 0
+        properties[:open_mode] |= config[:flags]
+
+        # JDBC driver has an extra flag for it
+        if config[:flags] & ::SQLite3::Constants::Open::SHAREDCACHE != 0
+          properties[:shared_cache] = true
+        end
+      end
+
+      timeout = config[:timeout]
+      if timeout && timeout.to_s !~ /\A\d+\Z/
+        raise ActiveRecord::StatementInvalid.new(
+          "TypeError: Timeout must be nil or a number (got: #{timeout}).",
+          connection_pool: ActiveRecord::ConnectionAdapters::NullPool.new
+        )
+      end
+
+      properties["busy_timeout"] ||= timeout unless timeout.nil?
+
+      properties
+    end
+
+    def parse_sqlite3_config!(config)
+      database = (config[:database] ||= config[:dbfile])
+
+      if database != ":memory:"
+        # make sure to have an absolute path. Ruby and Java don't agree
+        # on working directory
+        base_dir = defined?(Rails.root) ? Rails.root : nil
+        config[:database] = File.expand_path(database, base_dir)
+        dirname = File.dirname(config[:database])
+        Dir.mkdir(dirname) unless File.directory?(dirname)
+      end
+    rescue Errno::ENOENT => e
+      if e.message.include?("No such file or directory")
+        raise ActiveRecord::NoDatabaseError.new(
+          connection_pool: ActiveRecord::ConnectionAdapters::NullPool.new
+        )
+      end
+
+      raise
+    end
+  end
+end

data/lib/arjdbc/sqlite3/column.rb

@@ -4,12 +4,14 @@ module ActiveRecord::ConnectionAdapters
   class SQLite3Column < JdbcColumn
 
     attr_reader :rowid
-    
-    def initialize(name, default, sql_type_metadata = nil, null = true, default_function = nil, collation: nil, comment: nil, auto_increment: nil, rowid: false, **)
+
+    def initialize(*, auto_increment: nil, rowid: false, generated_type: nil, **)
       super
+
       @auto_increment = auto_increment
       @default = nil if default =~ /NULL/
       @rowid = rowid
+      @generated_type = generated_type
     end
 
     def self.string_to_binary(value)
@@ -39,6 +41,18 @@ module ActiveRecord::ConnectionAdapters
       auto_increment? || rowid
     end
 
+    def virtual?
+      !@generated_type.nil?
+    end
+
+    def virtual_stored?
+      virtual? && @generated_type == :stored
+    end
+
+    def has_default?
+      super && !virtual?
+    end
+
     def init_with(coder)
       @auto_increment = coder["auto_increment"]
       super
@@ -100,4 +114,4 @@ module ActiveRecord::ConnectionAdapters
       end
     end
   end
-end
+end