File: streamable.rb

package info (click to toggle)
ruby-protocol-http 0.55.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 840 kB
  • sloc: ruby: 6,904; makefile: 4
file content (309 lines) | stat: -rw-r--r-- 6,577 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# frozen_string_literal: true

# Released under the MIT License.
# Copyright, 2024-2025, by Samuel Williams.

require "protocol/http/body/streamable"
require "sus/fixtures/async"

describe Protocol::HTTP::Body::Streamable do
	include Sus::Fixtures::Async::ReactorContext
	
	let(:block) do
		proc do |stream|
			stream.write("Hello")
			stream.write("World")
			stream.close
		end
	end
	
	let(:body) {subject.request(&block)}
	
	with ".request" do
		it "can create a new body" do
			body = subject.request(&block)
			expect(body).to be_a(Protocol::HTTP::Body::Streamable::RequestBody)
		end
	end
	
	with ".response" do
		let(:request) {Protocol::HTTP::Request.new("GET", "/")}
		
		it "can create a new body" do
			body = subject.response(request, &block)
			expect(body).to be_a(Protocol::HTTP::Body::Streamable::Body)
		end
	end
	
	with "#stream?" do
		it "should be streamable" do
			expect(body).to be(:stream?)
		end
	end
	
	with "#read" do
		it "can read the body" do
			expect(body.read).to be == "Hello"
			expect(body.read).to be == "World"
			expect(body.read).to be == nil
		end
	end
	
	with "#close_write" do
		let(:block) do
			proc do |stream|
				stream.close_write
			end
		end
		
		it "can close the output body" do
			expect(body.read).to be == nil
		end
	end
	
	with "#each" do
		it "can read the body" do
			chunks = []
			body.each{|chunk| chunks << chunk}
			expect(chunks).to be == ["Hello", "World"]
		end
	end
	
	with "#call" do
		it "can read the body" do
			stream = StringIO.new
			body.call(stream)
			expect(stream.string).to be == "HelloWorld"
		end
		
		it "will fail if invoked twice" do
			stream = StringIO.new
			body.call(stream)
			
			expect do
				body.call(stream)
			end.to raise_exception(Protocol::HTTP::Body::Streamable::ConsumedError)
		end
		
		it "will fail if trying to read after streaming" do
			stream = StringIO.new
			body.call(stream)
			
			expect do
				body.read
			end.to raise_exception(Protocol::HTTP::Body::Streamable::ConsumedError)
		end
	end
	
	with "#inspect" do
		it "shows block available when not consumed" do
			expect(body.inspect).to be == "#<Protocol::HTTP::Body::Streamable::RequestBody block available, not consumed>"
		end
		
		it "shows output active after reading starts" do
			# Start reading to create @output
			body.read
			expect(body.inspect).to be == "#<Protocol::HTTP::Body::Streamable::RequestBody block consumed, output active>"
		end
		
		it "shows output closed after completion" do
			# Consume the body, then close output to trigger final else state
			body.read
			body.close_output
			expect(body.inspect).to be == "#<Protocol::HTTP::Body::Streamable::RequestBody block consumed, output closed>"
		end
		
		with "a block that raises an error" do
			let(:block) do
				proc do |stream|
					stream.write("Hello")
					
					raise "Oh no... a wild error appeared!"
				ensure
					stream.close
				end
			end
			
			it "closes the stream if an error occurs" do
				stream = StringIO.new
				
				expect do
					body.call(stream)
				end.to raise_exception(RuntimeError, message: be =~ /Oh no... a wild error appeared!/)
				
				expect(stream.string).to be == "Hello"
			end
		end
	end
	
	with "#close" do
		it "can close the body" do
			expect(body.read).to be == "Hello"
			
			body.close
		end
		
		it "can raise an error on the block" do
			expect(body.read).to be == "Hello"
			body.close(RuntimeError.new("Oh no!"))
		end
	end
	
	with "nested fiber" do
		let(:block) do
			proc do |stream|
				Fiber.new do
					stream.write("Hello")
				end.resume
			end
		end
		
		it "can read a chunk" do
			expect(body.read).to be == "Hello"
		end
	end
	
	with "buffered input" do
		let(:input) {Protocol::HTTP::Body::Buffered.new(["Hello", " ", "World"])}
		
		let(:block) do
			proc do |stream|
				while chunk = stream.read_partial
					stream.write(chunk)
				end
			end
		end
		
		let(:response) {Protocol::HTTP::Response[200, body: input]}
		let(:body) {subject.response(response, &block)}
		
		it "can read from input" do
			expect(body.read).to be == "Hello"
			expect(body.read).to be == " "
			expect(body.read).to be == "World"
		end
		
		it "can stream to output" do
			output = StringIO.new
			stream = Protocol::HTTP::Body::Stream.new(input, output)
			
			body.call(stream)
			
			expect(output.string).to be == "Hello World"
		end
		
		with "#close" do
			it "can close the body" do
				expect(input).not.to receive(:close)
				
				expect(body.read).to be == "Hello"
				body.close
			end
		end
	end
	
	with "#stream" do
		let(:block) do
			proc do |stream|
				while chunk = stream.read_partial
					stream.write(chunk)
				end
			rescue => error
			ensure
				stream.close(error)
			end
		end
		
		it "can stream to output" do
			input = Protocol::HTTP::Body::Buffered.new(["Hello", " ", "World"])
			
			body.stream(input)
			
			expect(body.read).to be == "Hello"
			expect(body.read).to be == " "
			expect(body.read).to be == "World"
			
			body.close
		end
		
		it "can stream to output with an error" do
			input = Protocol::HTTP::Body::Buffered.new(["Hello", " ", "World"])
			
			mock(input) do |mock|
				mock.replace(:read) do
					raise "Oh no!"
				end
			end
			
			body.stream(input)
			
			expect do
				body.read
			end.to raise_exception(RuntimeError, message: be =~ /Oh no!/)
		end
	end
	
	with "streaming in a different task" do
		let(:block) do
			proc do |stream|
				while chunk = stream.read_partial
					stream.write(chunk)
				end
			rescue => error
			ensure
				stream.close(error)
			end
		end
		
		let(:input) {Protocol::HTTP::Body::Writable.new}
		let(:output) {Protocol::HTTP::Body::Writable.new}
		
		before do
			parent = Async::Task.current
			
			@input_task = parent.async do
				body.stream(input)
			end
			
			@output_task = parent.async do
				while chunk = body.read
					output.write(chunk)
				end
			rescue => error
			ensure
				output.close_write(error)
			end
		end
		
		after do
			@input_task&.wait
			@output_task&.wait
		end
		
		it "can stream a chunk" do
			input.write("Hello")
			input.close_write
			expect(output.read).to be == "Hello"
		end
		
		it "can stream multiple chunks" do
			input.write("Hello")
			input.write(" ")
			input.write("World")
			input.close_write
			
			expect(output.read).to be == "Hello"
			expect(output.read).to be == " "
			expect(output.read).to be == "World"
		end
		
		it "can stream an error" do
			input.write("Hello")
			input.close_write(RuntimeError.new("Oh no!"))
			
			expect do
				output.read
			end.to raise_exception(RuntimeError, message: be =~ /Oh no!/)
		end
	end
end