logstash-mixin-scheduler 1.0.0-java → 1.0.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67978c6a1909fafc833c6b6ad0ea257274a7c6e9ae05dfd7c06e1a2b3d6820d0
-  data.tar.gz: cf0dada853778214e4bef783d356f921e0d153557912a6a00c787270decfaefe
+  metadata.gz: a8d7af34429c215680a9297a8e942923259af00163413bebd83d5e9df5d44c34
+  data.tar.gz: 9904ef45c2aa86b0b32250564ac17b76494584141be28081f7a1274b7c20692e
 SHA512:
-  metadata.gz: db8106c162a7268c40c3bfde3f7ee888d002238a9081f94eb294fa23af97eb687502a7243fd79b4e12c006574324bc1815b114966af43e42d73a837c7a4e3816
-  data.tar.gz: 0caadfd21d2b8e49f51b2b77cc3858423b0ec7fb21ba5aeab0839e2c17d308de34ecdcdea93e26e15cbc09b4bfccc435f5a05182e93a34eac5f69c3b019247a2
+  metadata.gz: e43c4643ec3c3ab0df62e7d41022734735b050c8eb3752e61ce8ebd406a6d9b29b2ef2af2827fddd7c44e7b5516c971375f36008e6bd6d0baefc9c5ab35c43bc
+  data.tar.gz: 5ce2f3c51c33b48b8aa2e0339c4c4f3210b7bc12a796559b9c40af9b61626b5010aadc309ac805700c2838f32c2866ffbc170ada9cb01f0cde1e99f486abfe7c

data/CHANGELOG.md

@@ -1,2 +1,8 @@
+## 1.0.2
+  - Fix: terminate idle scheduler work threads on plugin close, which leaked one thread per pipeline reload [#7](https://github.com/logstash-plugins/logstash-mixin-scheduler/pull/7)
+
+## 1.0.1
+  - Refactor: initialize time zone data eagerly [#2](https://github.com/logstash-plugins/logstash-mixin-scheduler/pull/2)
+
 ## 1.0.0
   - Feat: a common scheduler interface [#1](https://github.com/logstash-plugins/logstash-mixin-scheduler/pull/1)

data/README.md

@@ -1,6 +1,6 @@
 # Scheduler Mixin
 
-[![Build Status](https://travis-ci.com/logstash-plugins/logstash-mixin-scheduler.svg?branch=main)](https://travis-ci.com/logstash-plugins/logstash-mixin-scheduler)
+[![Unit Tests](https://github.com/logstash-plugins/logstash-mixin-scheduler/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/logstash-plugins/logstash-mixin-scheduler/actions/workflows/unit-tests.yml)
 
 
 ## Usage

data/lib/logstash/plugin_mixins/scheduler/rufus_impl.rb

@@ -1,5 +1,11 @@
 require 'rufus/scheduler'
-
+begin
+  require 'et-orbi.rb' # a dependency of rufus-scheduler since 3.4
+  ::EtOrbi::EoTime.now # might take a long time to initialize - loading time zone
+  # data (from tz-info) and thus gets un-predictable on CI, since the scheduler worker
+  # thread might be stuck starting while we attempt to shutdown in a given time frame
+rescue LoadError
+end
 require 'logstash/util/loggable'
 
 module LogStash module PluginMixins module Scheduler module RufusImpl
@@ -43,6 +49,8 @@ module LogStash module PluginMixins module Scheduler module RufusImpl
     # @overload
     def release!; @impl.shutdown(:wait) end
     # @overload
+    def terminate!; @impl.shutdown(:kill) end
+    # @overload
     def running?; !@impl.down? end
 
     # @overload

data/lib/logstash/plugin_mixins/scheduler.rb

@@ -37,7 +37,7 @@ module LogStash
       module CloseHook
         def close
           super # plugin.close
-          release_scheduler
+          terminate_scheduler!
         end
       end
       private_constant :CloseHook
@@ -47,10 +47,10 @@ module LogStash
 
       private
 
-      # Release jobs registered by the plugin from executing.
+      # Terminate the scheduler, including any jobs currently executing.
       # This method executes from the plugin's #close method.
-      def release_scheduler
-        @_scheduler.release if @_scheduler
+      def terminate_scheduler!
+        @_scheduler.terminate! if @_scheduler
       end
 
       # Release jobs registered by the plugin from executing.
@@ -117,6 +117,14 @@ module LogStash
         # @abstract
         def release!; release end
 
+        # Fully and immediately terminate the scheduler:
+        #  - prevents additional jobs from being registered,
+        #  - unschedules all future invocations of jobs previously registered,
+        #  - and stops any jobs currently executing.
+        #
+        # @abstract
+        def terminate!; release! end
+
         # Is this scheduler potentially executing our jobs.
         #
         # @abstract

data/spec/logstash/plugin_mixins/scheduler/rufus_impl_spec.rb

@@ -7,7 +7,7 @@ describe LogStash::PluginMixins::Scheduler::RufusImpl do
   let(:name) { '[test]<jdbc_scheduler' }
 
   let(:opts) do
-    { :max_work_threads => 2 }
+    { max_work_threads: 2, frequency: 0.2 }
   end
 
   subject(:scheduler) do
@@ -45,6 +45,47 @@ describe LogStash::PluginMixins::Scheduler::RufusImpl do
     try(10) { expect(join_thread).to_not be_alive }
   end
 
+  it "terminates idle work threads on terminate!" do
+    scheduler.every('0.2s') { }
+    sleep 0.5
+    scheduler.impl.jobs.each(&:unschedule)
+    sleep 0.5
+    work_threads = scheduler.impl.work_threads
+    expect( work_threads.count(&:alive?) ).to be >= 1
+    scheduler.terminate!
+    try(10) { expect( work_threads.count(&:alive?) ).to eql 0 }
+  end
+
+  context 'with a job in flight' do
+
+    let(:started)   { java.util.concurrent.CountDownLatch.new(1) }
+    let(:completed) { java.util.concurrent.atomic.AtomicBoolean.new(false) }
+
+    before do
+      scheduler.in('0.1s') do
+        started.count_down
+        sleep 2
+        completed.set(true)
+      end
+      expect( started.await(5, java.util.concurrent.TimeUnit::SECONDS) ).to be true
+    end
+
+    it "release! (from #stop) blocks until the running job finishes" do
+      work_threads = scheduler.impl.work_threads
+      scheduler.release!
+      expect( completed.get ).to be true
+      expect( work_threads.count(&:alive?) ).to eql 0
+    end
+
+    it "terminate! (from #close) stops the running job" do
+      work_threads = scheduler.impl.work_threads
+      scheduler.terminate!
+      expect( completed.get ).to be false
+      try(10) { expect( work_threads.count(&:alive?) ).to eql 0 }
+    end
+
+  end
+
   context 'cron schedule' do
 
     before do
@@ -83,7 +124,10 @@ describe LogStash::PluginMixins::Scheduler::RufusImpl do
     let(:counter) { java.util.concurrent.atomic.AtomicLong.new(0) }
 
     before do
-      scheduler.cron('* * * * * *') { counter.increment_and_get; sleep 3.25 } # every second
+      scheduler.cron('* * * * * *') do # every second
+        counter.increment_and_get
+        sleep_at_least 3.25
+      end
     end
 
     it "are working" do
@@ -102,4 +146,17 @@ describe LogStash::PluginMixins::Scheduler::RufusImpl do
 
   end
 
+  private
+
+  # with multiple threads on JRuby 9.3 -> some tend to finish 'early'
+  def sleep_at_least(time)
+    start = Time.now
+    slept = 0
+    while slept < time
+      sleep(time - slept)
+      slept = Time.now - start
+    end
+    slept
+  end
+
 end

data/spec/logstash/plugin_mixins/scheduler_spec.rb

@@ -55,6 +55,17 @@ describe LogStash::PluginMixins::Scheduler do
             expect( scheduler.running? ).to be false
           end
 
+          it 'terminates scheduler work threads on close' do
+            scheduler = plugin.scheduler
+            ran = java.util.concurrent.CountDownLatch.new(1)
+            scheduler.every('1s') { ran.count_down }
+            expect( ran.await(10, java.util.concurrent.TimeUnit::SECONDS) ).to be true
+            work_threads = scheduler.impl.work_threads
+            expect( work_threads.count(&:alive?) ).to be >= 1
+            plugin.do_close
+            try(10) { expect( work_threads.count(&:alive?) ).to eql 0 }
+          end
+
           it 'shuts-down the scheduler on stop' do
             scheduler = plugin.scheduler
             plugin.stop

metadata

@@ -1,86 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: logstash-mixin-scheduler
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: java
 authors:
 - Elastic
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2026-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.16'
-  name: logstash-core
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.16'
 - !ruby/object:Gem::Dependency
+  name: rufus-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.9
-  name: rufus-scheduler
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.9
 - !ruby/object:Gem::Dependency
+  name: logstash-devutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-plain
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description:
 email: info@elastic.co
 executables: []
 extensions: []
@@ -98,7 +96,6 @@ homepage: https://github.com/logstash-plugins/logstash-mixin-scheduler
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Scheduler for Logstash plugins
 test_files: