logstash-integration-jdbc 5.1.8 → 5.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70e445fd000df9ba4c631d3574d67826aaafcb22bb2b4c00f9e30aa386415ed0
-  data.tar.gz: 2fc2cef288fa7fa2f342db6096e79e49617c012e5ce9f5c4a5d94cc1f79b0838
+  metadata.gz: 9f3116d5abaa413fd73af725208c422a1cf98961ce7095c4d88fd7f14cb6c59d
+  data.tar.gz: 0ef2f5fd309236b8ec0e14bb38d275e26b3d2002cdb172a2d30d53682606ddec
 SHA512:
-  metadata.gz: e9fd72a1ebd12db838330101716032fbe125a9dab866bd552e61eeca37d51222f1f22e29cb8cdcc1b27bba8d1e5b59e8ff22de6aba29587e3811543a23860e79
-  data.tar.gz: ae0322899fdbc65f3be931f1e2fbc2cbb82ac7d3e9980c1aa1a404085a0d4e7218944567e4750260fd638506e6f43dceb6a477c4762fe856d3c262e152988920
+  metadata.gz: d701317b4edbe221b2dd9a66d6e2591a0a78e8b9502373860656a5d95f552eee06ae752904687b58b2dfda274dc7c20e5da3e5bebbefbd98c538c107f49bec7a
+  data.tar.gz: 22a9383f113f01025ba2f694cd61845aa4ed08474efc70cb37694993babb9ec7d6ac3d95291bbf2fe5b22835a8923ab1802061d861da2e59d5b0e3041f7b18ed

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 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)
 

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

@@ -1,9 +1,12 @@
+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 = {})
@@ -30,16 +33,16 @@ module LogStash module PluginMixins module Jdbc
       begin
         load_driver_jars
         begin
-          @driver_impl = Sequel::JDBC.load_driver(normalized_driver_class)
-        rescue Sequel::AdapterNotFound => e # Sequel::AdapterNotFound, "#{@jdbc_driver_class} not loaded"
-          # fix this !!!
+          @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}. #{message} #{e.backtrace}"
+          raise LogStash::PluginLoadingError, "#{e.inspect}. #{message}"
         end
       ensure
         DRIVERS_LOADING_LOCK.unlock()
@@ -71,16 +74,16 @@ module LogStash module PluginMixins module Jdbc
       !@jdbc_driver_library.nil? && !@jdbc_driver_library.empty?
     end
 
-    # normalizing the class name to always have a Java:: prefix
-    # is helpful since JRuby is only able to directly load class names
-    # whose top-level package is com, org, java, javax
-    # There are many jdbc drivers that use cc, io, net, etc.
-    def normalized_driver_class
-      if @jdbc_driver_class.start_with?("Java::", "Java.")
-        @jdbc_driver_class
-      else
-        "Java::#{@jdbc_driver_class}"
-      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/logstash-integration-jdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-integration-jdbc'
-  s.version         = '5.1.8'
+  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"

data/spec/inputs/jdbc_spec.rb

@@ -1620,16 +1620,35 @@ describe LogStash::Inputs::Jdbc do
   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 prefixed with Java::" do
-        expect(Sequel::JDBC).to receive(:load_driver).with(/^Java::/)
-        plugin.send(:load_driver)
+      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 as-is" do
-        expect(Sequel::JDBC).to receive(:load_driver).with(jdbc_driver_class)
-        plugin.send(:load_driver)
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-jdbc
 version: !ruby/object:Gem::Version
-  version: 5.1.8
+  version: 5.1.10
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement