async 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e95eca0cff51fba91c446924485001f6bd9d63978d92a15b583bbb8916b7c53b
-  data.tar.gz: 463002c552022842360fb031aee28c6286ed7af44761e3e8e55b60c40f1094bb
+  metadata.gz: 3722acb6246ee95cecd02b7d763cf695eabe3726510d2eda756ecfe3e809632e
+  data.tar.gz: da8e9cd294faf48293c39f7577ef6b807d3e46881fb99f248a7d3369bbc2d182
 SHA512:
-  metadata.gz: 8d2848633ef85c07e88321c1cc5f4eb890fc53eb66c973dcf182ab5b535fa211b3493d1a265500c83a359bcd673912ea9b77a076e0c818add4ad82b7d5b35a11
-  data.tar.gz: 9814c99bbdb06a4993aefd573cf77795d813ee0f129d93cd7df1cc29522cd4f2b11b212a4d9c91d45bdd9f78114ee21ca55dac0fa51438a877124e08e69dd382
+  metadata.gz: b69666de33bf4b97a4b72a9b9e6ecce98651dbc7fc6eab8c124946f979731fdb3b349d3143b6763a5cf2a41b2a2725d8186d3d2903603667dbd5ac973aea7686
+  data.tar.gz: 3e5a5211537c71bc368aeb7b1d7396693ad6f8908bdbf8e20a5a3baf395a0bb908eddbab2e05f3293667c3e25b2b75d08909df7dc6540d47522f411361ff9628

data/README.md

@@ -270,7 +270,7 @@ You can wrap asynchronous operations in a timeout. This ensures that malicious s
 require 'async'
 
 Async do |task|
-	task.timeout(1) do
+	task.with_timeout(1) do
 		task.sleep 100
 	rescue Async::TimeoutError
 		puts "I timed out!"

data/examples/fibers.rb

@@ -13,7 +13,7 @@ class IO
 		
 		monitor = reactor.add_io(fiber, descriptor, state)
 		
-		fiber.timeout(duration) do
+		fiber.with_timeout(duration) do
 			result = Fiber.yield
 			raise result if result.is_a? Exception
 		end

data/lib/async/logger.rb

@@ -80,12 +80,12 @@ module Async
 			@subjects[subject.class] = false
 		end
 		
-		def log(level, *args, &block)
+		def log(level, *arguments, &block)
 			unless level.is_a? Symbol
 				level = LEVELS[level]
 			end
 			
-			self.send(level, *args, &block)
+			self.send(level, *arguments, &block)
 		end
 		
 		def format(subject = nil, *arguments, &block)

data/lib/async/reactor.rb

@@ -204,7 +204,6 @@ module Async
 			@children.each(&:stop)
 			
 			# TODO Should we also clear all timers?
-			
 			@selector.close
 			@selector = nil
 		end
@@ -231,18 +230,15 @@ module Async
 			timer.cancel if timer
 		end
 		
-		# Invoke the block, but after the timeout, raise {TimeoutError} in any
-		# currenly blocking operation.
+		# Invoke the block, but after the specified timeout, raise {TimeoutError} in any currenly blocking operation. If the block runs to completion before the timeout occurs or there are no non-blocking operations after the timeout expires, the code will complete without any exception.
 		# @param duration [Numeric] The time in seconds, in which the task should 
 		#   complete.
-		def timeout(duration, exception = TimeoutError)
-			backtrace = caller
+		def with_timeout(timeout, exception = TimeoutError)
 			fiber = Fiber.current
 			
-			timer = self.after(duration) do
+			timer = self.after(timeout) do
 				if fiber.alive?
 					error = exception.new("execution expired")
-					error.set_backtrace backtrace
 					fiber.resume error
 				end
 			end
@@ -251,5 +247,12 @@ module Async
 		ensure
 			timer.cancel if timer
 		end
+		
+		# TODO remove
+		def timeout(*args, &block)
+			warn "#{self.class}\#timeout(...) is deprecated, use #{self.class}\#with_timeout(...) instead."
+			
+			with_timeout(*args, &block)
+		end
 	end
 end

data/lib/async/task.rb

@@ -76,7 +76,7 @@ module Async
 		
 		# @attr ios [Reactor] The reactor the task was created within.
 		attr :reactor
-		def_delegators :@reactor, :timeout, :sleep
+		def_delegators :@reactor, :with_timeout, :timeout, :sleep
 		
 		# Yield back to the reactor and allow other fibers to execute.
 		def yield
@@ -90,7 +90,7 @@ module Async
 		# @attr status [Symbol] The status of the execution of the fiber, one of `:initialized`, `:running`, `:complete`, `:stopped` or `:failed`.
 		attr :status
 		
-		# Resume the execution of the task.
+		# Begin the execution of the task.
 		def run(*args)
 			if @status == :initialized
 				@status = :running
@@ -124,6 +124,7 @@ module Async
 		
 		# Deprecated.
 		alias result wait
+		# Soon to become attr :result
 		
 		# Stop the task and all of its children.
 		# @return [void]

data/lib/async/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Async
-	VERSION = "1.14.0"
+	VERSION = "1.15.0"
 end

data/lib/async/wrapper.rb

@@ -92,14 +92,14 @@ module Async
 		end
 		
 		# Wait for the io to become readable.
-		def wait_readable(duration = nil)
+		def wait_readable(timeout = nil)
 			raise WaitError if @readable
 			
 			self.reactor = Task.current.reactor
 			
 			begin
 				@readable = Fiber.current
-				wait_for(duration)
+				wait_for(timeout)
 			ensure
 				@readable = nil
 				@monitor.interests = interests if @monitor
@@ -107,14 +107,14 @@ module Async
 		end
 		
 		# Wait for the io to become writable.
-		def wait_writable(duration = nil)
+		def wait_writable(timeout = nil)
 			raise WaitError if @writable
 			
 			self.reactor = Task.current.reactor
 			
 			begin
 				@writable = Fiber.current
-				wait_for(duration)
+				wait_for(timeout)
 			ensure
 				@writable = nil
 				@monitor.interests = interests if @monitor
@@ -123,14 +123,14 @@ module Async
 		
 		# Wait fo the io to become either readable or writable.
 		# @param duration [Float] timeout after the given duration if not `nil`.
-		def wait_any(duration = nil)
+		def wait_any(timeout = nil)
 			raise WaitError if @any
 			
 			self.reactor = Task.current.reactor
 			
 			begin
 				@any = Fiber.current
-				wait_for(duration)
+				wait_for(timeout)
 			ensure
 				@any = nil
 				@monitor.interests = interests if @monitor
@@ -195,7 +195,7 @@ module Async
 			end
 		end
 		
-		def wait_for(duration)
+		def wait_for(timeout)
 			if @monitor
 				@monitor.interests = interests
 			else
@@ -203,8 +203,8 @@ module Async
 			end
 			
 			# If the user requested an explicit timeout for this operation:
-			if duration
-				@reactor.timeout(duration) do
+			if timeout
+				@reactor.with_timeout(timeout) do
 					Task.yield
 				end
 			else

data/spec/async/reactor_spec.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'benchmark/ips'
+
 RSpec.describe Async::Reactor do
 	describe '#run' do
 		it "can run tasks on different fibers" do
@@ -118,7 +120,7 @@ RSpec.describe Async::Reactor do
 		end
 	end
 	
-	describe '#timeout' do
+	describe '#with_timeout' do
 		let(:duration) {1}
 		
 		it "stops immediately" do
@@ -127,7 +129,7 @@ RSpec.describe Async::Reactor do
 			described_class.run do |task|
 				condition = Async::Condition.new
 				
-				task.timeout(duration) do
+				task.with_timeout(duration) do
 					task.async do
 						condition.wait
 					end
@@ -150,12 +152,29 @@ RSpec.describe Async::Reactor do
 		it "raises specified exception" do
 			expect do
 				described_class.run do |task|
-					task.timeout(0.0, timeout_class) do
+					task.with_timeout(0.0, timeout_class) do
 						task.sleep(1.0)
 					end
 				end.wait
 			end.to raise_exception(timeout_class)
 		end
+		
+		it "should be fast to use timeouts" do
+			Benchmark.ips do |x|
+				x.report('Reactor#with_timeout') do |repeats|
+					Async do |task|
+						reactor = task.reactor
+						
+						repeats.times do
+							reactor.with_timeout(1) do
+							end
+						end
+					end
+				end
+				
+				x.compare!
+			end
+		end
 	end
 	
 	describe '#to_s' do

data/spec/async/task_spec.rb

@@ -199,10 +199,10 @@ RSpec.describe Async::Task do
 		end
 	end
 	
-	describe '#timeout' do
+	describe '#with_timeout' do
 		it "can extend timeout" do
 			reactor.async do |task|
-				task.timeout(0.2) do |timer|
+				task.with_timeout(0.2) do |timer|
 					task.sleep(0.1)
 					
 					expect(timer.fires_in).to be_within(10).percent_of(0.1)
@@ -221,7 +221,7 @@ RSpec.describe Async::Task do
 			
 			reactor.async do |task|
 				begin
-					task.timeout(0.01) do
+					task.with_timeout(0.01) do
 						state = :started
 						task.sleep(10)
 						state = :finished
@@ -241,7 +241,7 @@ RSpec.describe Async::Task do
 			
 			reactor.async do |task|
 				state = :started
-				task.timeout(0.01) do
+				task.with_timeout(0.01) do
 					task.sleep(0.001)
 					state = :finished
 				end
@@ -251,6 +251,26 @@ RSpec.describe Async::Task do
 			
 			expect(state).to be == :finished
 		end
+		
+		def sleep_forever
+			while true
+				Async::Task.current.sleep(1)
+			end
+		end
+		
+		it "contains useful backtrace" do
+			task = Async do |task|
+				task.with_timeout(1.0) do
+					sleep_forever
+				end
+			end
+			
+			expect{task.wait}.to raise_error(Async::TimeoutError)
+			
+			# TODO replace this with task.result
+			task.wait rescue error = $!
+			expect(error.backtrace).to include(/sleep_forever/)
+		end
 	end
 	
 	describe '#wait' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r