logstash-integration-jdbc 5.1.5 → 5.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71904a199b39255cbefb08b1c43a08e0507df8af19be11ae3b57b69519d337f5
-  data.tar.gz: 17e4ef460ad1e9d51d0ecada1d94b6d41951a65e65f316e287ad58331f5a4211
+  metadata.gz: 9f3116d5abaa413fd73af725208c422a1cf98961ce7095c4d88fd7f14cb6c59d
+  data.tar.gz: 0ef2f5fd309236b8ec0e14bb38d275e26b3d2002cdb172a2d30d53682606ddec
 SHA512:
-  metadata.gz: 503737f45cfcba0724d533664b14bda25bf9abd0c5de549973857855f00722a666022693d1d22e517b735e6171a06d20cd31e11492c7d60321b3456627eab05f
-  data.tar.gz: 78d36bd182723abdc72ebf7809f76b86111d3e8bc4111bb08c5a8363fe88e8fe38c4ab563f1408f60c7b0b491f3802c69a31259e4035e8bebcd4bbfc5e8636d9
+  metadata.gz: d701317b4edbe221b2dd9a66d6e2591a0a78e8b9502373860656a5d95f552eee06ae752904687b58b2dfda274dc7c20e5da3e5bebbefbd98c538c107f49bec7a
+  data.tar.gz: 22a9383f113f01025ba2f694cd61845aa4ed08474efc70cb37694993babb9ec7d6ac3d95291bbf2fe5b22835a8923ab1802061d861da2e59d5b0e3041f7b18ed

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 5.1.10
+  - Refactor: to explicit Java (driver) class name loading [#96](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/96),
+    the change is expected to provide a more robust fix for the driver loading issue [#83](https://github.com/logstash-plugins/logstash-integration-jdbc/issues/83).
+
+  - Fix: regression due returning the Java driver class [#98](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/98)
+
+## 5.1.9 (yanked)
+  - Refactor: to explicit Java (driver) class name loading [#96](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/96),
+    the change is expected to provide a more robust fix for the driver loading issue [#83](https://github.com/logstash-plugins/logstash-integration-jdbc/issues/83).
+
+## 5.1.8
+  - Fix the blocking pipeline reload and shutdown when connectivity issues happen [#85](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/85)
+
+## 5.1.7
+  - Normalize jdbc_driver_class loading to support any top-level java packages [#86](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/86)
+
+## 5.1.6
+  - Fix, serialize the JDBC driver loading steps to avoid concurrency issues [#84](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/84)
+
 ## 5.1.5
   - Refined ECS support [#82](https://github.com/logstash-plugins/logstash-integration-jdbc/pull/82)
     - Uses shared `target` guidance when ECS compatibility is enabled

data/lib/logstash/plugin_mixins/jdbc/common.rb

@@ -1,9 +1,14 @@
+require 'jruby'
 
 module LogStash module PluginMixins module Jdbc
   module Common
 
     private
 
+    # NOTE: using the JRuby mechanism to load classes (through JavaSupport)
+    # makes the lock redundant although it does not hurt to have it around.
+    DRIVERS_LOADING_LOCK = java.util.concurrent.locks.ReentrantLock.new()
+
     def complete_sequel_opts(defaults = {})
       sequel_opts = @sequel_opts.
           map { |key,val| [key.is_a?(String) ? key.to_sym : key, val] }.
@@ -22,18 +27,25 @@ module LogStash module PluginMixins module Jdbc
       require "sequel"
       require "sequel/adapters/jdbc"
 
-      load_driver_jars
+      # execute all the driver loading related duties in a serial fashion to avoid
+      # concurrency related problems with multiple pipelines and multiple drivers
+      DRIVERS_LOADING_LOCK.lock()
       begin
-        @driver_impl = Sequel::JDBC.load_driver(@jdbc_driver_class)
-      rescue Sequel::AdapterNotFound => e # Sequel::AdapterNotFound, "#{@jdbc_driver_class} not loaded"
-        # fix this !!!
-        message = if jdbc_driver_library_set?
-                    "Are you sure you've included the correct jdbc driver in :jdbc_driver_library?"
-                  else
-                    ":jdbc_driver_library is not set, are you sure you included " +
-                        "the proper driver client libraries in your classpath?"
-                  end
-        raise LogStash::PluginLoadingError, "#{e}. #{message}"
+        load_driver_jars
+        begin
+          @driver_impl = load_jdbc_driver_class
+        rescue => e # catch java.lang.ClassNotFoundException, potential errors
+          # (e.g. ExceptionInInitializerError or LinkageError) won't get caught
+          message = if jdbc_driver_library_set?
+                      "Are you sure you've included the correct jdbc driver in :jdbc_driver_library?"
+                    else
+                      ":jdbc_driver_library is not set, are you sure you included " +
+                          "the proper driver client libraries in your classpath?"
+                    end
+          raise LogStash::PluginLoadingError, "#{e.inspect}. #{message}"
+        end
+      ensure
+        DRIVERS_LOADING_LOCK.unlock()
       end
     end
 
@@ -62,5 +74,16 @@ module LogStash module PluginMixins module Jdbc
       !@jdbc_driver_library.nil? && !@jdbc_driver_library.empty?
     end
 
+    def load_jdbc_driver_class
+      # sub a potential: 'Java::org::my.Driver' to 'org.my.Driver'
+      klass = @jdbc_driver_class.gsub('::', '.').sub(/^Java\./, '')
+      # NOTE: JRuby's Java::JavaClass.for_name which considers the custom class-loader(s)
+      # in 9.3 the API changed and thus to avoid surprises we go down to the Java API :
+      klass = JRuby.runtime.getJavaSupport.loadJavaClass(klass) # throws ClassNotFoundException
+      # unfortunately we can not simply return the wrapped java.lang.Class instance as
+      # Sequel assumes to be able to do a `driver_class.new` which only works on the proxy,
+      org.jruby.javasupport.Java.getProxyClass(JRuby.runtime, klass)
+    end
+
   end
 end end end

data/lib/logstash/plugin_mixins/jdbc/jdbc.rb

@@ -168,8 +168,6 @@ module LogStash  module PluginMixins module Jdbc
         @logger.warn("Failed test_connection with java.sql.SQLException.", :exception => e)
       rescue Sequel::DatabaseConnectionError => e
         @logger.warn("Failed test_connection.", :exception => e)
-        close_jdbc_connection
-
         #TODO return false and let the plugin raise a LogStash::ConfigurationError
         raise e
       end
@@ -208,9 +206,9 @@ module LogStash  module PluginMixins module Jdbc
     public
     def execute_statement
       success = false
-      @connection_lock.lock
-      open_jdbc_connection
       begin
+        @connection_lock.lock
+        open_jdbc_connection
         sql_last_value = @use_column_value ? @value_tracker.value : Time.now.utc
         @tracking_column_warning_sent = false
         @statement_handler.perform_query(@database, @value_tracker.value, @jdbc_paging_enabled, @jdbc_page_size) do |row|

data/logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.1.5'
+  s.version         = '5.1.10'
   s.licenses = ['Apache License (2.0)']
   s.summary         = "Integration with JDBC - input and filter plugins"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -41,7 +41,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "logstash-mixin-event_support", '~> 1.0'
 
   s.add_development_dependency "childprocess"
-  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-devutils', '>= 2.3'
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'jdbc-derby'
 end

data/spec/inputs/integration/integ_spec.rb

@@ -66,13 +66,13 @@ describe LogStash::Inputs::Jdbc, :integration => true do
       )
     end
 
-    it "should not register correctly" do
+    it "log warning msg when plugin run" do
       plugin.register
-      allow( plugin ).to receive(:log_java_exception)
+      expect( plugin ).to receive(:log_java_exception)
+      expect(plugin.logger).to receive(:warn).once.with("Exception when executing JDBC query",
+                                                        hash_including(:exception => instance_of(String)))
       q = Queue.new
-      expect do
-        plugin.run(q)
-      end.to raise_error(::Sequel::DatabaseConnectionError)
+      expect{ plugin.run(q) }.not_to raise_error
     end
 
     it "should log (native) Java driver error" do
@@ -85,9 +85,7 @@ describe LogStash::Inputs::Jdbc, :integration => true do
         logger
       end
       q = Queue.new
-      expect do
-        plugin.run(q)
-      end.to raise_error(::Sequel::DatabaseConnectionError)
+      expect{ plugin.run(q) }.not_to raise_error
     end
   end
 end

data/spec/inputs/jdbc_spec.rb

@@ -14,10 +14,11 @@ require "date"
 
 describe LogStash::Inputs::Jdbc do
   let(:connection_string) { "jdbc:derby:memory:testdb;create=true" }
+  let(:jdbc_driver_class) { "org.apache.derby.jdbc.EmbeddedDriver" }
   let(:mixin_settings) do
     {
         "jdbc_user" => ENV['USER'],
-        "jdbc_driver_class" => "org.apache.derby.jdbc.EmbeddedDriver",
+        "jdbc_driver_class" => jdbc_driver_class,
         "jdbc_connection_string" => connection_string
     }
   end
@@ -1392,10 +1393,8 @@ describe LogStash::Inputs::Jdbc do
       event = queue.pop
       expect(event.get("num")).to eq(1)
       expect(event.get("string")).to eq("A test")
-      expect(event.get("started_at")).to be_a(LogStash::Timestamp)
-      expect(event.get("started_at").to_s).to eq("1999-12-31T00:00:00.000Z")
-      expect(event.get("custom_time")).to be_a(LogStash::Timestamp)
-      expect(event.get("custom_time").to_s).to eq("1999-12-31T23:59:59.000Z")
+      expect(event.get("started_at")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T00:00:00.000Z")
+      expect(event.get("custom_time")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T23:59:59.000Z")
       expect(event.get("ranking").to_f).to eq(95.67)
     end
   end
@@ -1441,10 +1440,8 @@ describe LogStash::Inputs::Jdbc do
         event = queue.pop
         expect(event.get("num")).to eq(1)
         expect(event.get("string")).to eq("A test")
-        expect(event.get("started_at")).to be_a(LogStash::Timestamp)
-        expect(event.get("started_at").to_s).to eq("1999-12-31T00:00:00.000Z")
-        expect(event.get("custom_time")).to be_a(LogStash::Timestamp)
-        expect(event.get("custom_time").to_s).to eq("1999-12-31T23:59:59.000Z")
+        expect(event.get("started_at")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T00:00:00.000Z")
+        expect(event.get("custom_time")).to be_a_logstash_timestamp_equivalent_to("1999-12-31T23:59:59.000Z")
         expect(event.get("ranking").to_f).to eq(95.67)
       end
     end
@@ -1619,4 +1616,40 @@ describe LogStash::Inputs::Jdbc do
       end
     end
   end
+
+  describe "jdbc_driver_class" do
+    context "when not prefixed with Java::" do
+      let(:jdbc_driver_class) { "org.apache.derby.jdbc.EmbeddedDriver" }
+      it "loads the class" do
+        expect { plugin.send(:load_driver) }.not_to raise_error
+      end
+    end
+    context "when prefixed with Java::" do
+      let(:jdbc_driver_class) { "Java::org.apache.derby.jdbc.EmbeddedDriver" }
+      it "loads the class" do
+        expect { plugin.send(:load_driver) }.not_to raise_error
+      end
+    end
+    context "when prefixed with Java." do
+      let(:jdbc_driver_class) { "Java.org::apache::derby::jdbc.EmbeddedDriver" }
+      it "loads the class" do
+        expect { plugin.send(:load_driver) }.not_to raise_error
+      end
+
+      it "can instantiate the returned driver class" do
+        # for drivers where the path through DriverManager fails, Sequel assumes
+        # having a proxied Java class instance (instead of a java.lang.Class) and
+        # does a driver.new.connect https://git.io/JDV6M
+        driver = plugin.send(:load_driver)
+        expect { driver.new }.not_to raise_error
+      end
+    end
+    context "when class name invalid" do
+      let(:jdbc_driver_class) { "org.apache.NonExistentDriver" }
+      it "raises a loading error" do
+        expect { plugin.send(:load_driver) }.to raise_error LogStash::PluginLoadingError,
+                                                            /java.lang.ClassNotFoundException: org.apache.NonExistentDriver/
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.1.5
+  version: 5.1.10
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +203,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   name: logstash-devutils
   prerelease: false
   type: :development
@@ -211,7 +211,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -252,7 +252,6 @@ files:
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
-- NOTICE.TXT
 - README.md
 - docs/filter-jdbc_static.asciidoc
 - docs/filter-jdbc_streaming.asciidoc

data/NOTICE.TXT

@@ -1,5 +0,0 @@
-Elasticsearch
-Copyright 2012-2018 Elasticsearch
-
-This product includes software developed by The Apache Software
-Foundation (http://www.apache.org/).