Merge pull request #944 from ruby-concurrency/restore-api

Restore API from #926 with warnings

Author: eregon

lib/concurrent-ruby/concurrent/timer_task.rb

@@ -152,6 +152,9 @@ class TimerTask < RubyExecutorService
     # Default `:execution_interval` in seconds.
     EXECUTION_INTERVAL = 60
 
+    # Default `:timeout_interval` in seconds.
+    TIMEOUT_INTERVAL = 30
+
     # Create a new TimerTask with the given task and configuration.
     #
     # @!macro timer_task_initialize
@@ -239,6 +242,20 @@ def execution_interval=(value)
       end
     end
 
+    # @!attribute [rw] timeout_interval
+    # @return [Fixnum] Number of seconds the task can run before it is
+    #   considered to have failed.
+    def timeout_interval
+      warn 'TimerTask timeouts are now ignored as these were not able to be implemented correctly'
+    end
+
+    # @!attribute [rw] timeout_interval
+    # @return [Fixnum] Number of seconds the task can run before it is
+    #   considered to have failed.
+    def timeout_interval=(value)
+      warn 'TimerTask timeouts are now ignored as these were not able to be implemented correctly'
+    end
+
     private :post, :<<
 
     private
@@ -247,6 +264,9 @@ def ns_initialize(opts, &task)
       set_deref_options(opts)
 
       self.execution_interval = opts[:execution] || opts[:execution_interval] || EXECUTION_INTERVAL
+      if opts[:timeout] || opts[:timeout_interval]
+        warn 'TimeTask timeouts are now ignored as these were not able to be implemented correctly'
+      end
       @run_now = opts[:now] || opts[:run_now]
       @executor = Concurrent::SafeTaskExecutor.new(task)
       @running = Concurrent::AtomicBoolean.new(false)

spec/concurrent/timer_task_spec.rb

@@ -113,7 +113,8 @@ def trigger_observable(observable)
       specify '#execution_interval is writeable' do
 
         latch   = CountDownLatch.new(1)
-        subject = TimerTask.new(execution_interval: 1,
+        subject = TimerTask.new(timeout_interval: 1,
+                                execution_interval: 1,
                                 run_now: true) do |task|
           task.execution_interval = 3
           latch.count_down
@@ -129,6 +130,16 @@ def trigger_observable(observable)
         expect(subject.execution_interval).to eq(3)
         subject.kill
       end
+
+      specify '#timeout_interval being written produces a warning' do
+        subject = TimerTask.new(timeout_interval: 1,
+                                execution_interval: 0.1,
+                                run_now: true) do |task|
+          expect { task.timeout_interval = 3 }.to output("TimerTask timeouts are now ignored as these were not able to be implemented correctly\n").to_stderr
+        end
+
+        expect { subject.timeout_interval = 2 }.to output("TimerTask timeouts are now ignored as these were not able to be implemented correctly\n").to_stderr
+      end
     end
 
     context 'execution' do