async-io 1.23.3 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0dbae8c805f1cd5878161490bbb70a211ecf7ebd3252a55c81f8c901b583b82
-  data.tar.gz: 5691a8fa37149cd0a79d9363e4b3a98588bf3f48f8df3ba8a683f0adc1fc1548
+  metadata.gz: c0614be3c203f3e9b8de82215fdacbe3a9bccdcd9b82784af349aa3149d63419
+  data.tar.gz: da66baf1cea7ee3ba1411eee6c09a7eeef5faef39e40ce6459fcd8002df2437b
 SHA512:
-  metadata.gz: 49c21510120fe04d90283bdcf1041bd510057cf107b2d535e2d822d4aff0baff1c7e52f511903f7c8cc3e196985c2effc607b377bbd33dc8ccd50a34bae44785
-  data.tar.gz: 3bbefda69345a03fdee012b84466d15788686e5944b53b5c835176d81c230b5ed521290f555d98ffe9f54a72bb113f3069f7d93cd0c3ad1263606b840d414d79
+  metadata.gz: 3624d5fe1177e65b87cb75fdec5eaeac9ef25543d423a66333c6de3b2826f656d0e7acdf5742741b2a7744518baa482f987584829aa6f2ebf140339161bf13be
+  data.tar.gz: d12bdfe724ba95f6f39cbc68bf21b7df0c16537f1c5dd689e70f102609ce6c75502d2cc41478546c9704d42bfdcdafbdc9e63a5cc5cc300ccf08610d4c533f96

data/lib/async/io/generic.rb

@@ -23,9 +23,11 @@ require 'forwardable'
 
 module Async
 	module IO
-		# The default block size for IO buffers.
-		# BLOCK_SIZE = ENV.fetch('BLOCK_SIZE', 1024*16).to_i
-		BLOCK_SIZE = 1024*8
+		# The default block size for IO buffers. Defaults to 8KB.
+		BLOCK_SIZE = ENV.fetch('ASYNC_IO_BLOCK_SIZE', 1024*8).to_i
+		
+		# The maximum read size when appending to IO buffers. Defaults to 8MB.
+		MAXIMUM_READ_SIZE = ENV.fetch('ASYNC_IO_MAXIMUM_READ_SIZE', BLOCK_SIZE * 128 * 8).to_i
 		
 		# Convert a Ruby ::IO object to a wrapped instance:
 		def self.try_convert(io, &block)

data/lib/async/io/stream.rb

@@ -26,7 +26,19 @@ module Async
 		class Stream
 			BLOCK_SIZE = IO::BLOCK_SIZE
 			
-			def initialize(io, block_size: BLOCK_SIZE, sync: true)
+			def self.open(path, mode = "r+", **options)
+				stream = self.new(File.open(path, mode), **options)
+				
+				return stream unless block_given?
+				
+				begin
+					yield stream
+				ensure
+					stream.close
+				end
+			end
+			
+			def initialize(io, block_size: BLOCK_SIZE, maximum_read_size: MAXIMUM_READ_SIZE, sync: true)
 				@io = io
 				@eof = false
 				
@@ -34,6 +46,7 @@ module Async
 				@io.sync = sync
 				
 				@block_size = block_size
+				@maximum_read_size = maximum_read_size
 				
 				@read_buffer = Buffer.new
 				@write_buffer = Buffer.new
@@ -220,6 +233,11 @@ module Async
 			
 			# Fills the buffer from the underlying stream.
 			def fill_read_buffer(size = @block_size)
+				# We impose a limit because the underlying `read` system call can fail if we request too much data in one go.
+				if size > @maximum_read_size
+					size = @maximum_read_size
+				end
+				
 				if @read_buffer.empty? and @io.read_nonblock(size, @read_buffer, exception: false)
 					return true
 				elsif chunk = @io.read_nonblock(size, @input_buffer, exception: false)

data/lib/async/io/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module IO
-		VERSION = "1.23.3"
+		VERSION = "1.24.0"
 	end
 end

data/spec/async/io/stream_spec.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require 'async/io/socket'
+require 'async/clock'
 
 require_relative 'generic_examples'
 require_relative 'stream_context'
@@ -46,14 +47,6 @@ RSpec.describe Async::IO::Stream do
 		it_should_behave_like Async::IO
 		
 		describe '#close_read' do
-			let(:sockets) do
-				@sockets = Async::IO::Socket.pair(Socket::AF_UNIX, Socket::SOCK_STREAM)
-			end
-			
-			after do
-				@sockets&.each(&:close)
-			end
-			
 			subject {described_class.new(sockets.last)}
 			
 			it "can close the reading end of the stream" do
@@ -95,6 +88,28 @@ RSpec.describe Async::IO::Stream do
 		end
 	end
 	
+	context "performance (BLOCK_SIZE: #{Async::IO::BLOCK_SIZE} MAXIMUM_READ_SIZE: #{Async::IO::MAXIMUM_READ_SIZE})" do
+		include_context Async::RSpec::Reactor
+		
+		let!(:stream) {described_class.open("/dev/zero")}
+		after {stream.close}
+		
+		it "can read data quickly" do |example|
+			data = nil
+			
+			duration = Async::Clock.measure do
+				data = stream.read(4*1024**3)
+			end
+			
+			size = data.bytesize / 1024**2
+			rate = size / duration
+			
+			example.reporter.message "Read #{size.round(2)}MB of data at #{rate.round(2)}MB/s."
+			
+			expect(rate).to be > 512
+		end
+	end
+	
 	context "buffered I/O" do
 		include_context Async::IO::Stream
 		include_context Async::RSpec::Memory

data/spec/spec_helper.rb

@@ -4,6 +4,12 @@ require "async/rspec"
 
 require_relative 'addrinfo'
 
+class RSpec::Core::Formatters::DocumentationFormatter
+	def message(notification)
+		output.puts "#{current_indentation}#{notification.message}"
+	end
+end
+
 RSpec.configure do |config|
 	# Enable flags like --only-failures and --next-failure
 	config.example_status_persistence_file_path = ".rspec_status"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-io
 version: !ruby/object:Gem::Version
-  version: 1.23.3
+  version: 1.24.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2019-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async