http/stream_common: Have :write_body_from_file take an table as argument

Author: daurnimator

doc/interfaces/stream.md

@@ -89,7 +89,10 @@ Writes the string `chunk` to the stream. If `end_stream` is true, the body will
 Writes the string `str` to the stream and ends the stream. On error, returns `nil`, an error message and an error number.
 
 
-### `stream:write_body_from_file(file, timeout)` <!-- --> {#stream:write_body_from_file}
+### `stream:write_body_from_file(options|file, timeout)` <!-- --> {#stream:write_body_from_file}
+
+  - `options` is a table containing:
+	- `.file` (file)
 
 Writes the contents of file `file` to the stream and ends the stream. `file` will not be automatically seeked, so ensure it is at the correct offset before calling. On error, returns `nil`, an error message and an error number.
 

doc/modules/http.h1_stream.md

@@ -94,9 +94,9 @@ See [`stream:write_chunk(chunk, end_stream, timeout)`](#stream:write_chunk)
 See [`stream:write_body_from_string(str, timeout)`](#stream:write_body_from_string)
 
 
-### `h1_stream:write_body_from_file(file, timeout)` <!-- --> {#http.h1_stream:write_body_from_file}
+### `h1_stream:write_body_from_file(options|file, timeout)` <!-- --> {#http.h1_stream:write_body_from_file}
 
-See [`stream:write_body_from_file(file, timeout)`](#stream:write_body_from_file)
+See [`stream:write_body_from_file(options|file, timeout)`](#stream:write_body_from_file)
 
 
 ### `h1_stream:shutdown()` <!-- --> {#http.h1_stream:shutdown}

doc/modules/http.h2_stream.md

@@ -87,9 +87,9 @@ See [`stream:write_chunk(chunk, end_stream, timeout)`](#stream:write_chunk)
 See [`stream:write_body_from_string(str, timeout)`](#stream:write_body_from_string)
 
 
-### `h2_stream:write_body_from_file(file, timeout)` <!-- --> {#http.h2_stream:write_body_from_file}
+### `h2_stream:write_body_from_file(options|file, timeout)` <!-- --> {#http.h2_stream:write_body_from_file}
 
-See [`stream:write_body_from_file(file, timeout)`](#stream:write_body_from_file)
+See [`stream:write_body_from_file(options|file, timeout)`](#stream:write_body_from_file)
 
 
 ### `h2_stream:shutdown()` <!-- --> {#http.h2_stream:shutdown}

http/stream_common.lua

@@ -152,8 +152,14 @@ function stream_methods:write_body_from_string(str, timeout)
 	return self:write_chunk(str, true, timeout)
 end
 
-function stream_methods:write_body_from_file(file, timeout)
+function stream_methods:write_body_from_file(options, timeout)
 	local deadline = timeout and (monotime()+timeout)
+	local file
+	if io.type(options) then -- lua-http <= 0.2 took a file handle
+		file = options
+	else
+		file = options.file
+	end
 	-- Can't use :lines here as in Lua 5.1 it doesn't take a parameter
 	while true do
 		local chunk, err = file:read(CHUNK_SIZE)

spec/stream_common_spec.lua

@@ -104,4 +104,26 @@ describe("http.stream_common", function()
 		client:close()
 		server:close()
 	end)
+	it("can write body from temporary file using options form", function()
+		local server, client = new_pair(1.1)
+		local cq = cqueues.new()
+		cq:wrap(function()
+			local file = io.tmpfile()
+			assert(file:write("hello world!"))
+			assert(file:seek("set"))
+			local stream = client:new_stream()
+			assert(stream:write_headers(new_request_headers(), false))
+			assert(stream:write_body_from_file({
+				file = file;
+			}))
+		end)
+		cq:wrap(function()
+			local stream = assert(server:get_next_incoming_stream())
+			assert.same("hello world!", assert(stream:get_body_as_string()))
+		end)
+		assert_loop(cq, TEST_TIMEOUT)
+		assert.truthy(cq:empty())
+		client:close()
+		server:close()
+	end)
 end)