No OneTemporary
Actions

Size

33 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/lib/tesla/adapter/gun.ex b/lib/tesla/adapter/gun.ex
	index f9b8e92..63744bb 100644
	--- a/lib/tesla/adapter/gun.ex
	+++ b/lib/tesla/adapter/gun.ex
	@@ -1,491 +1,471 @@
	if Code.ensure_loaded?(:gun) do
	defmodule Tesla.Adapter.Gun do
	@moduledoc """
	Adapter for [gun](https://github.com/ninenines/gun).

	Remember to add `{:gun, "~> 1.3"}` to dependencies.
	In version 1.3 gun sends `host` header with port. Fixed in master branch.
	Also, you need to recompile tesla after adding `:gun` dependency:

	```
	mix deps.clean tesla
	mix deps.compile tesla
	```

	## Example usage

	```
	# set globally in config/config.exs
	config :tesla, :adapter, Tesla.Adapter.Gun

	# set per module
	defmodule MyClient do
	use Tesla
	adapter Tesla.Adapter.Gun
	end
	```

	## Adapter specific options

	- `:timeout` - Time, while process, will wait for gun messages.
	- `:body_as` - What will be returned in `%Tesla.Env{}` body key. Possible values - `:plain`, `:stream`, `:chunks`. Defaults to `:plain`.
	- `:plain` - as binary.
	- `:stream` - as stream. If you don't want to close connection (because you want to reuse it later) pass `close_conn: false` in adapter opts.
	- `:chunks` - as chunks. You can get response body in chunks using `Tesla.Adapter.Gun.read_chunk/3` function.
	Processing of the chunks and checking body size must be done by yourself. Example of processing function is in `test/tesla/adapter/gun_test.exs` - `Tesla.Adapter.GunTest.read_body/4`. If you don't need connection later don't forget to close it with `Tesla.Adapter.Gun.close/1`.
	- `:max_body` - Max response body size in bytes. Works only with `body_as: :plain`, with other settings you need to check response body size by yourself.
	- `:conn` - Opened connection pid with gun. Is used for reusing gun connections.
	- `:close_conn` - Close connection or not after receiving full response body. Is used for reusing gun connections. Defaults to `true`.
	- `:certificates_verification` - Add SSL certificates verification. [erlang-certifi](https://github.com/certifi/erlang-certifi) [ssl_verify_fun.erl](https://github.com/deadtrickster/ssl_verify_fun.erl)
	- `:proxy` - Proxy for requests. Socks proxy are supported only for gun master branch. Examples: `{'localhost', 1234}`, `{{127, 0, 0, 1}, 1234}`, `{:socks5, 'localhost', 1234}`.

	## [Gun options](https://ninenines.eu/docs/en/gun/1.3/manual/gun/)

	- `:connect_timeout` - Connection timeout.
	- `:http_opts` - Options specific to the HTTP protocol.
	- `:http2_opts` - Options specific to the HTTP/2 protocol.
	- `:protocols` - Ordered list of preferred protocols. Defaults: `[:http2, :http]`- for :tls, `[:http]` - for :tcp.
	- `:trace` - Whether to enable dbg tracing of the connection process. Should only be used during debugging. Default: false.
	- `:transport` - Whether to use TLS or plain TCP. The default varies depending on the port used. Port 443 defaults to tls. All other ports default to tcp.
	- `:transport_opts` - Transport options. They are TCP options or TLS options depending on the selected transport. Default: `[]`. Gun version: 1.3
	- `:tls_opts` - TLS transport options. Default: `[]`. Gun from master branch.
	- `:tcp_opts` - TCP trasnport options. Default: `[]`. Gun from master branch.
	- `:socks_opts` - Options for socks. Default: `[]`. Gun from master branch.
	- `:ws_opts` - Options specific to the Websocket protocol. Default: `%{}`.
	- `:compress` - Whether to enable permessage-deflate compression. This does not guarantee that compression will be used as it is the server that ultimately decides. Defaults to false.
	- `:protocols` - A non-empty list enables Websocket protocol negotiation. The list of protocols will be sent in the sec-websocket-protocol request header. The handler module interface is currently undocumented and must be set to `gun_ws_h`.
	"""
	@behaviour Tesla.Adapter
	alias Tesla.Multipart

	+ # TODO: update list after update to gun 2.0
	@gun_keys [
	:connect_timeout,
	:http_opts,
	:http2_opts,
	:protocols,
	:retry,
	:retry_timeout,
	:trace,
	:transport,
	:socks_opts,
	:ws_opts
	]

	- @adapter_default_timeout 1_000
	+ @default_timeout 1_000

	@impl Tesla.Adapter
	def call(env, opts) do
	with {:ok, status, headers, body} <- request(env, opts) do
	{:ok, %{env \| status: status, headers: format_headers(headers), body: body}}
	end
	end

	@doc """
	Reads chunk of the response body.

	Returns `{:fin, binary()}` if all body received, otherwise returns `{:nofin, binary()}`.
	"""
	@spec read_chunk(pid(), reference(), keyword() \| map()) ::
	{:fin, binary()} \| {:nofin, binary()} \| {:error, atom()}
	def read_chunk(pid, stream, opts) do
	+ with {status, _} = chunk when status in [:fin, :error] <- do_read_chunk(pid, stream, opts) do
	+ if opts[:close_conn], do: close(pid)
	+ chunk
	+ end
	+ end
	+
	+ defp do_read_chunk(pid, stream, opts) do
	receive do
	{:gun_data, ^pid, ^stream, :fin, body} ->
	- if opts[:close_conn], do: close(pid)
	{:fin, body}

	{:gun_data, ^pid, ^stream, :nofin, part} ->
	{:nofin, part}

	{:DOWN, _, _, _, reason} ->
	- if opts[:close_conn], do: close(pid)
	{:error, reason}
	after
	- opts[:timeout] \|\| @adapter_default_timeout ->
	+ opts[:timeout] \|\| @default_timeout ->
	{:error, :recv_chunk_timeout}
	end
	end

	@doc """
	Brutally close the `gun` connection.
	"""
	@spec close(pid()) :: :ok
	defdelegate close(pid), to: :gun

	defp format_headers(headers) do
	for {key, value} <- headers do
	{String.downcase(to_string(key)), to_string(value)}
	end
	end

	defp request(env, opts) do
	request(
	Tesla.Adapter.Shared.format_method(env.method),
	Tesla.build_url(env.url, env.query),
	format_headers(env.headers),
	env.body \|\| "",
	Tesla.Adapter.opts(
	[close_conn: true, body_as: :plain, send_body: :at_once, receive: true],
	env,
	opts
	)
	\|> Enum.into(%{})
	)
	end

	defp request(method, url, headers, %Stream{} = body, opts),
	- do: request_stream(method, url, headers, body, Map.put(opts, :send_body, :stream))
	+ do: do_request(method, url, headers, body, Map.put(opts, :send_body, :stream))

	defp request(method, url, headers, body, opts) when is_function(body),
	- do: request_stream(method, url, headers, body, Map.put(opts, :send_body, :stream))
	+ do: do_request(method, url, headers, body, Map.put(opts, :send_body, :stream))

	defp request(method, url, headers, %Multipart{} = mp, opts) do
	headers = headers ++ Multipart.headers(mp)
	body = Multipart.body(mp)

	- request(method, url, headers, body, opts)
	+ do_request(method, url, headers, body, Map.put(opts, :send_body, :stream))
	end

	defp request(method, url, headers, body, opts),
	do: do_request(method, url, headers, body, opts)

	- defp request_stream(method, url, headers, body, opts),
	- do: do_request(method, url, headers, body, opts)
	-
	defp do_request(method, url, headers, body, opts) do
	- with uri <- URI.parse(url),
	- path <- Tesla.Adapter.Shared.prepare_path(uri.path, uri.query),
	- opts <- check_original(uri, opts),
	- {:ok, pid, opts} <- open_conn(uri, opts),
	- stream <- open_stream(pid, method, path, headers, body, opts) do
	- read_response(pid, stream, opts)
	+ uri = URI.parse(url)
	+ path = Tesla.Adapter.Shared.prepare_path(uri.path, uri.query)
	+
	+ with {:ok, pid, opts} <- open_conn(uri, opts) do
	+ stream = open_stream(pid, method, path, headers, body, opts)
	+ response = read_response(pid, stream, opts)
	+
	+ if opts[:close_conn] and opts[:body_as] not in [:stream, :chunks] do
	+ close(pid)
	+ end
	+
	+ response
	end
	end

	- defp check_original(%URI{host: host, port: port, scheme: scheme}, %{conn: conn} = opts) do
	+ defp open_conn(%{scheme: scheme, host: host, port: port}, %{conn: conn} = opts)
	+ when is_pid(conn) do
	info = :gun.info(conn)

	- conn_host =
	- case :inet.ntoa(info.origin_host) do
	- {:error, :einval} -> info.origin_host
	- ip -> ip
	- end
	-
	conn_scheme =
	case info do
	- # support for gun master branch, which has `origin_scheme` in connection info
	+ # gun master branch support, which has `origin_scheme` in connection info
	%{origin_scheme: scheme} -> scheme
	%{transport: :tls} -> "https"
	_ -> "http"
	end

	- matches? =
	- conn_scheme == scheme and to_string(conn_host) == host and
	- info.origin_port == port
	-
	- Map.put(opts, :original_matches, matches?)
	- end
	-
	- defp check_original(_uri, opts), do: opts
	-
	- defp open_conn(_uri, %{conn: conn, original_matches: true} = opts) do
	- {:ok, conn, Map.put(opts, :receive, false)}
	- end
	-
	- defp open_conn(uri, %{conn: conn, original_matches: false} = opts) do
	- # current url is different from the original, so we can't use transferred connection
	- opts =
	- opts
	- \|> Map.put_new(:old_conn, conn)
	- \|> Map.delete(:conn)
	+ conn_host =
	+ case :inet.ntoa(info.origin_host) do
	+ {:error, :einval} -> info.origin_host
	+ ip -> ip
	+ end

	- open_conn(uri, opts)
	+ if conn_scheme == scheme and to_string(conn_host) == host and info.origin_port == port do
	+ {:ok, conn, Map.put(opts, :receive, false)}
	+ else
	+ {:error, :invalid_conn}
	+ end
	end

	defp open_conn(uri, opts) do
	- opts =
	- if uri.scheme == "https" do
	- Map.put(opts, :transport, :tls)
	- else
	- opts
	- end
	-
	- tls_opts =
	- opts
	- \|> Map.get(:tls_opts, [])
	- \|> Keyword.merge(Map.get(opts, :transport_opts, []))
	-
	- tls_opts =
	- with "https" <- uri.scheme,
	- false <- opts[:original_matches] do
	- # current url is different from the original, so we can't use verify_fun for https requests
	- Keyword.delete(tls_opts, :verify_fun)
	- else
	- _ -> tls_opts
	- end
	-
	- # Support for gun master branch where transport_opts, were splitted to tls_opts and tcp_opts
	- # https://github.com/ninenines/gun/blob/491ddf58c0e14824a741852fdc522b390b306ae2/doc/src/manual/gun.asciidoc#changelog
	+ opts = maybe_add_transport(uri, opts)

	tls_opts =
	- with "https" <- uri.scheme,
	- true <- opts[:certificates_verification] do
	- security_opts = [
	- verify: :verify_peer,
	- cacertfile: CAStore.file_path(),
	- depth: 20,
	- reuse_sessions: false,
	- verify_fun:
	- {&:ssl_verify_hostname.verify_fun/3, [check_hostname: domain_or_fallback(uri.host)]}
	- ]
	-
	- Keyword.merge(security_opts, tls_opts)
	+ if uri.scheme == "https" do
	+ opts
	+ \|> fetch_tls_opts()
	+ \|> maybe_add_verify_options(opts, uri)
	else
	- _ -> tls_opts
	+ []
	end

	gun_opts = Map.take(opts, @gun_keys)

	- with {:ok, pid} <- do_open_conn(uri, opts, gun_opts, tls_opts) do
	- # If there were redirects, and passed `closed_conn: false`, we need to close opened connections to these intermediate hosts.
	- {:ok, pid, Map.put(opts, :close_conn, true)}
	+ with {:ok, conn} <- do_open_conn(uri, opts, gun_opts, tls_opts) do
	+ {:ok, conn, opts}
	end
	end

	+ defp maybe_add_transport(%URI{scheme: "https"}, opts), do: Map.put(opts, :transport, :tls)
	+ defp maybe_add_transport(_, opts), do: opts
	+
	+ # Support for gun master branch where transport_opts, were splitted to tls_opts and tcp_opts
	+ # https://github.com/ninenines/gun/blob/491ddf58c0e14824a741852fdc522b390b306ae2/doc/src/manual/gun.asciidoc#changelog
	+ # TODO: remove after update to gun 2.0
	+ defp fetch_tls_opts(%{tls_opts: tls_opts}) when is_list(tls_opts), do: tls_opts
	+ defp fetch_tls_opts(%{transport_opts: tls_opts}) when is_list(tls_opts), do: tls_opts
	+ defp fetch_tls_opts(_), do: []
	+
	+ defp maybe_add_verify_options(tls_opts, %{certificates_verification: true}, %{host: host}) do
	+ charlist =
	+ host
	+ \|> to_charlist()
	+ \|> :idna.encode()
	+
	+ security_opts = [
	+ verify: :verify_peer,
	+ cacertfile: CAStore.file_path(),
	+ depth: 20,
	+ reuse_sessions: false,
	+ verify_fun: {&:ssl_verify_hostname.verify_fun/3, [check_hostname: charlist]}
	+ ]
	+
	+ Keyword.merge(security_opts, tls_opts)
	+ end
	+
	+ defp maybe_add_verify_options(tls_opts, _, _), do: tls_opts
	+
	defp do_open_conn(uri, %{proxy: {proxy_host, proxy_port}}, gun_opts, tls_opts) do
	connect_opts =
	uri
	\|> tunnel_opts()
	\|> tunnel_tls_opts(uri.scheme, tls_opts)

	with {:ok, pid} <- :gun.open(proxy_host, proxy_port, gun_opts),
	{:ok, _} <- :gun.await_up(pid),
	stream <- :gun.connect(pid, connect_opts),
	{:response, :fin, 200, _} <- :gun.await(pid, stream) do
	{:ok, pid}
	end
	end

	defp do_open_conn(uri, %{proxy: {proxy_type, proxy_host, proxy_port}}, gun_opts, tls_opts) do
	version =
	proxy_type
	\|> to_string()
	\|> String.last()
	\|> case do
	"4" -> 4
	_ -> 5
	end

	socks_opts =
	uri
	\|> tunnel_opts()
	\|> tunnel_tls_opts(uri.scheme, tls_opts)
	\|> Map.put(:version, version)

	gun_opts =
	gun_opts
	\|> Map.put(:protocols, [:socks])
	\|> Map.update(:socks_opts, socks_opts, &Map.merge(socks_opts, &1))

	with {:ok, pid} <- :gun.open(proxy_host, proxy_port, gun_opts),
	{:ok, _} <- :gun.await_up(pid) do
	{:ok, pid}
	else
	{:error, {:options, {:protocols, [:socks]}}} ->
	{:error, "socks protocol is not supported"}

	error ->
	error
	end
	end

	defp do_open_conn(uri, opts, gun_opts, tls_opts) do
	tcp_opts = Map.get(opts, :tcp_opts, [])

	# if gun used from master
	opts_with_master_keys =
	gun_opts
	\|> Map.put(:tls_opts, tls_opts)
	\|> Map.put(:tcp_opts, tcp_opts)

	- {_type, host} = domain_or_ip(uri.host)
	+ host = domain_or_ip(uri.host)

	with {:ok, pid} <- gun_open(host, uri.port, opts_with_master_keys, opts) do
	{:ok, pid}
	else
	{:error, {:options, {key, _}}} when key in [:tcp_opts, :tls_opts] ->
	gun_open(host, uri.port, Map.put(gun_opts, :transport_opts, tls_opts), opts)

	error ->
	error
	end
	end

	defp gun_open(host, port, gun_opts, opts) do
	with {:ok, pid} <- :gun.open(host, port, gun_opts),
	- {:receive, true, pid} <- {:receive, opts[:receive], pid},
	- {:ok, _} <- :gun.await_up(pid) do
	+ {_, true, _} <- {:receive, opts[:receive], pid},
	+ {_, {:ok, _}, _} <- {:up, :gun.await_up(pid), pid} do
	{:ok, pid}
	else
	{:receive, false, pid} ->
	{:ok, pid}

	+ {:up, error, pid} ->
	+ close(pid)
	+ error
	+
	error ->
	error
	end
	end

	defp tunnel_opts(uri) do
	- {_type, host} = domain_or_ip(uri.host)
	+ host = domain_or_ip(uri.host)
	%{host: host, port: uri.port}
	end

	defp tunnel_tls_opts(opts, "https", tls_opts) do
	http2_opts = %{protocols: [:http2], transport: :tls, tls_opts: tls_opts}
	Map.merge(opts, http2_opts)
	end

	defp tunnel_tls_opts(opts, _, _), do: opts

	defp open_stream(pid, method, path, headers, body, opts) do
	req_opts = %{reply_to: opts[:reply_to] \|\| self()}

	open_stream(pid, method, path, headers, body, req_opts, opts[:send_body])
	end

	defp open_stream(pid, method, path, headers, body, req_opts, :stream) do
	stream = :gun.request(pid, method, path, headers, "", req_opts)
	for data <- body, do: :ok = :gun.data(pid, stream, :nofin, data)
	:gun.data(pid, stream, :fin, "")
	stream
	end

	defp open_stream(pid, method, path, headers, body, req_opts, :at_once),
	do: :gun.request(pid, method, path, headers, body, req_opts)

	defp read_response(pid, stream, opts) do
	receive? = opts[:receive]

	receive do
	{:gun_response, ^pid, ^stream, :fin, status, headers} ->
	- if opts[:close_conn], do: close(pid)
	{:ok, status, headers, ""}

	{:gun_response, ^pid, ^stream, :nofin, status, headers} ->
	format_response(pid, stream, opts, status, headers, opts[:body_as])

	{:gun_up, ^pid, _protocol} when receive? ->
	read_response(pid, stream, opts)

	{:gun_error, ^pid, reason} ->
	- if opts[:close_conn], do: close(pid)
	{:error, reason}

	{:gun_down, ^pid, _, _, _, _} when receive? ->
	read_response(pid, stream, opts)

	{:DOWN, _, _, _, reason} ->
	- if opts[:close_conn], do: close(pid)
	{:error, reason}
	after
	- opts[:timeout] \|\| @adapter_default_timeout ->
	- if opts[:close_conn], do: :ok = close(pid)
	+ opts[:timeout] \|\| @default_timeout ->
	{:error, :recv_response_timeout}
	end
	end

	defp format_response(pid, stream, opts, status, headers, :plain) do
	case read_body(pid, stream, opts) do
	{:ok, body} ->
	- if opts[:close_conn], do: close(pid)
	{:ok, status, headers, body}

	{:error, error} ->
	- if opts[:close_conn] do
	- close(pid)
	- else
	- # prevent gun sending messages to owner process, if body is too large and connection is not closed
	- :ok = :gun.flush(stream)
	- end
	+ # prevent gun sending messages to owner process, if body is too large and connection is not closed
	+ :ok = :gun.flush(stream)

	{:error, error}
	end
	end

	defp format_response(pid, stream, opts, status, headers, :stream) do
	stream_body =
	Stream.resource(
	fn -> %{pid: pid, stream: stream} end,
	fn
	%{pid: pid, stream: stream} ->
	case read_chunk(pid, stream, opts) do
	{:nofin, part} -> {[part], %{pid: pid, stream: stream}}
	{:fin, body} -> {[body], %{pid: pid, final: :fin}}
	end

	%{pid: pid, final: :fin} ->
	{:halt, %{pid: pid}}
	end,
	fn %{pid: pid} ->
	if opts[:close_conn], do: close(pid)
	end
	)

	{:ok, status, headers, stream_body}
	end

	defp format_response(pid, stream, opts, status, headers, :chunks) do
	{:ok, status, headers, %{pid: pid, stream: stream, opts: Enum.into(opts, [])}}
	end

	defp read_body(pid, stream, opts, acc \\ "") do
	limit = opts[:max_body]

	receive do
	{:gun_data, ^pid, ^stream, :fin, body} ->
	check_body_size(acc, body, limit)

	{:gun_data, ^pid, ^stream, :nofin, part} ->
	with {:ok, acc} <- check_body_size(acc, part, limit) do
	read_body(pid, stream, opts, acc)
	end

	{:DOWN, _, _, _, reason} ->
	{:error, reason}
	after
	- opts[:timeout] \|\| @adapter_default_timeout ->
	+ opts[:timeout] \|\| @default_timeout ->
	{:error, :recv_body_timeout}
	end
	end

	defp check_body_size(acc, part, nil), do: {:ok, acc <> part}

	defp check_body_size(acc, part, limit) do
	body = acc <> part

	if limit - byte_size(body) >= 0 do
	{:ok, body}
	else
	{:error, :body_too_large}
	end
	end

	- defp domain_or_fallback(host) do
	- case domain_or_ip(host) do
	- {:domain, domain} -> domain
	- {:ip, _ip} -> to_charlist(host)
	- end
	- end
	-
	defp domain_or_ip(host) do
	charlist = to_charlist(host)

	case :inet.parse_address(charlist) do
	{:error, :einval} ->
	- {:domain, :idna.encode(charlist)}
	+ :idna.encode(charlist)

	- {:ok, ip} when is_tuple(ip) and tuple_size(ip) in [4, 8] ->
	- {:ip, ip}
	+ {:ok, ip} ->
	+ ip
	end
	end
	end
	end
	diff --git a/test/tesla/adapter/gun_test.exs b/test/tesla/adapter/gun_test.exs
	index fead64e..00771df 100644
	--- a/test/tesla/adapter/gun_test.exs
	+++ b/test/tesla/adapter/gun_test.exs
	@@ -1,380 +1,235 @@
	defmodule Tesla.Adapter.GunTest do
	use ExUnit.Case

	use Tesla.AdapterCase, adapter: Tesla.Adapter.Gun
	use Tesla.AdapterCase.Basic
	use Tesla.AdapterCase.Multipart
	use Tesla.AdapterCase.StreamRequestBody
	use Tesla.AdapterCase.SSL
	alias Tesla.Adapter.Gun

	+ setup do
	+ on_exit(fn -> assert Supervisor.which_children(:gun_sup) == [] end)
	+ end
	+
	test "fallback adapter timeout option" do
	request = %Env{
	method: :get,
	url: "#{@http}/delay/2"
	}

	assert {:error, :recv_response_timeout} = call(request, timeout: 1_000)
	end

	test "max_body option" do
	request = %Env{
	method: :get,
	url: "#{@http}/stream-bytes/100"
	}

	assert {:error, :body_too_large} = call(request, max_body: 5)
	end

	- test "query without path" do
	+ test "url without path" do
	request = %Env{
	method: :get,
	url: "#{@http}"
	}

	- assert {:ok, %Env{} = response} = call(request)
	- assert response.status == 200
	+ assert {:ok, %Env{status: 200}} = call(request)
	end

	- test "query without path with query" do
	+ test "url without path, but with query" do
	request = %Env{
	method: :get,
	url: "#{@http}",
	query: [
	param: "value"
	]
	}

	- assert {:ok, %Env{} = response} = call(request)
	- assert response.status == 200
	+ assert {:ok, %Env{status: 200} = response} = call(request)
	end

	- test "response stream" do
	+ test "ipv4 request" do
	request = %Env{
	method: :get,
	- url: "#{@http}/stream-bytes/10"
	+ url: "http://127.0.0.1:#{Application.get_env(:httparrot, :http_port)}/stream-bytes/10"
	}

	- assert {:ok, %Env{} = response} = call(request)
	- assert response.status == 200
	- assert byte_size(response.body) == 16
	+ assert {:ok, %Env{status: 200, body: body}} = call(request)
	+ assert byte_size(body) == 16
	end

	- test "read response body in chunks" do
	+ test "response stream" do
	request = %Env{
	method: :get,
	url: "#{@http}/stream-bytes/10"
	}

	- assert {:ok, %Env{} = response} = call(request, body_as: :chunks)
	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	- assert opts[:body_as] == :chunks
	- assert is_pid(pid)
	- assert is_reference(stream)
	-
	- assert read_body(pid, stream, opts) \|> byte_size() == 16
	- refute Process.alive?(pid)
	+ assert {:ok, %Env{status: 200, body: body}} = call(request)
	+ assert byte_size(body) == 16
	end

	- test "read response body in chunks with closing connection by default opts" do
	+ test "response body as stream" do
	request = %Env{
	method: :get,
	url: "#{@http}/stream-bytes/10"
	}

	- assert {:ok, %Env{} = response} = call(request, body_as: :chunks)
	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	- assert opts[:body_as] == :chunks
	- assert is_pid(pid)
	- assert is_reference(stream)
	-
	- assert read_body(pid, stream, opts) \|> byte_size() == 16
	- refute Process.alive?(pid)
	- end
	-
	- test "with body_as :plain reusing connection" do
	- uri = URI.parse(@http)
	- {:ok, conn} = :gun.open(to_charlist(uri.host), uri.port)
	-
	- request = %Env{
	- method: :get,
	- url: "#{@http}/ip"
	- }
	-
	- assert {:ok, %Env{} = response} = call(request, conn: conn, close_conn: false)
	-
	- assert response.status == 200
	- assert Process.alive?(conn)
	-
	- assert {:ok, %Env{} = response} = call(request, conn: conn, close_conn: false)
	-
	- assert response.status == 200
	- assert Process.alive?(conn)
	- :ok = Gun.close(conn)
	- refute Process.alive?(conn)
	+ assert {:ok, %Env{status: 200, body: stream}} = call(request, body_as: :stream)
	+ assert is_function(stream)
	+ assert stream \|> Enum.join() \|> byte_size() == 16
	end

	- test "read response body in chunks with reused connection and closing it" do
	- uri = URI.parse(@http)
	- {:ok, conn} = :gun.open(to_charlist(uri.host), uri.port)
	-
	+ test "response body as chunks with closing connection" do
	request = %Env{
	method: :get,
	url: "#{@http}/stream-bytes/10"
	}

	- assert {:ok, %Env{} = response} =
	- call(request, body_as: :chunks, conn: conn, close_conn: false)
	-
	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	- assert opts[:body_as] == :chunks
	- assert is_pid(pid)
	- assert is_reference(stream)
	- assert conn == pid
	-
	- assert read_body(pid, stream, opts) \|> byte_size() == 16
	- assert Process.alive?(pid)
	-
	- # reusing connection
	- assert {:ok, %Env{} = response} =
	- call(request, body_as: :chunks, conn: conn, close_conn: false)
	+ assert {:ok, %Env{status: 200, body: %{pid: pid, stream: stream, opts: opts}}} =
	+ call(request, body_as: :chunks)

	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	- assert opts[:body_as] == :chunks
	assert is_pid(pid)
	assert is_reference(stream)
	- assert conn == pid

	assert read_body(pid, stream, opts) \|> byte_size() == 16
	- assert Process.alive?(pid)
	-
	- :ok = Gun.close(pid)
	refute Process.alive?(pid)
	end

	- test "certificates_verification" do
	+ test "certificates_verification option" do
	request = %Env{
	method: :get,
	url: "#{@https}"
	}

	assert {:ok, %Env{} = response} =
	call(request,
	certificates_verification: true,
	transport_opts: [
	cacertfile: "./deps/httparrot/priv/ssl/server-ca.crt"
	]
	)
	end

	- test "read response body in stream" do
	- request = %Env{
	- method: :get,
	- url: "#{@http}/stream-bytes/10"
	- }
	+ describe "reusing connection" do
	+ setup do
	+ uri = URI.parse(@http)
	+ {:ok, conn} = :gun.open(to_charlist(uri.host), uri.port)

	- assert {:ok, %Env{} = response} = call(request, body_as: :stream)
	- assert response.status == 200
	- assert is_function(response.body)
	- assert Enum.join(response.body) \|> byte_size() == 16
	- end
	+ request = %Env{
	+ method: :get,
	+ url: "#{@http}/stream-bytes/10"
	+ }

	- test "read response body in stream with opened connection without closing connection" do
	- uri = URI.parse(@http)
	- {:ok, conn} = :gun.open(to_charlist(uri.host), uri.port)
	+ on_exit(fn -> Gun.close(conn) end)

	- request = %Env{
	- method: :get,
	- url: "#{@http}/stream-bytes/10"
	- }
	+ {:ok, request: request, conn: conn}
	+ end

	- assert {:ok, %Env{} = response} =
	- call(request, body_as: :stream, conn: conn, close_conn: false)
	+ test "response body as plain", %{request: request, conn: conn} do
	+ assert {:ok, %Env{status: 200, body: body}} = call(request, conn: conn, close_conn: false)
	+ assert byte_size(body) == 16
	+ assert Process.alive?(conn)
	+ end

	- assert response.status == 200
	- assert is_function(response.body)
	- assert Enum.join(response.body) \|> byte_size() == 16
	+ test "response body as chunks", %{request: request, conn: conn} do
	+ opts = [body_as: :chunks, conn: conn, close_conn: false]

	- assert Process.alive?(conn)
	+ assert {:ok, %Env{status: 200, body: %{pid: pid, stream: stream}}} = call(request, opts)

	- :ok = Gun.close(conn)
	- refute Process.alive?(conn)
	- end
	+ assert is_pid(pid)
	+ assert is_reference(stream)
	+ assert conn == pid

	- test "read response body in stream with opened connection with closing connection" do
	- uri = URI.parse(@http)
	- {:ok, conn} = :gun.open(to_charlist(uri.host), uri.port)
	+ assert read_body(pid, stream, opts) \|> byte_size() == 16
	+ assert Process.alive?(pid)
	+ end

	- request = %Env{
	- method: :get,
	- url: "#{@http}/stream-bytes/10"
	- }
	+ test "response body as stream without closing connection", %{request: request, conn: conn} do
	+ assert {:ok, %Env{status: 200, body: stream}} =
	+ call(request, body_as: :stream, conn: conn, close_conn: false)

	- assert {:ok, %Env{} = response} = call(request, body_as: :stream, conn: conn)
	+ assert is_function(stream)
	+ assert stream \|> Enum.join() \|> byte_size() == 16

	- assert response.status == 200
	- assert is_function(response.body)
	- assert Enum.join(response.body) \|> byte_size() == 16
	+ assert Process.alive?(conn)
	+ end
	+
	+ test "response body as stream with closing connection", %{request: request, conn: conn} do
	+ assert {:ok, %Env{status: 200, body: stream}} = call(request, body_as: :stream, conn: conn)
	+
	+ assert is_function(stream)
	+ assert stream \|> Enum.join() \|> byte_size() == 16

	- refute Process.alive?(conn)
	+ refute Process.alive?(conn)
	+ end
	+
	+ test "opened to another domain", %{request: request, conn: conn} do
	+ new_url = "http://127.0.0.1:#{Application.get_env(:httparrot, :http_port)}/stream-bytes/10"
	+ assert {:error, :invalid_conn} = call(Map.put(request, :url, new_url), conn: conn)
	+ end
	end

	test "error response" do
	request = %Env{
	method: :get,
	url: "#{@http}/status/500"
	}

	assert {:ok, %Env{} = response} = call(request, timeout: 1_000)
	assert response.status == 500
	end

	test "error on socks proxy" do
	request = %Env{
	method: :get,
	url: "#{@http}/status/500"
	}

	assert {:error, "socks protocol is not supported"} ==
	call(request, proxy: {:socks5, 'localhost', 1234})
	end

	test "receive gun_up message when receive is false" do
	request = %Env{
	method: :get,
	url: "#{@http}"
	}

	assert {:ok, %Env{} = response} = call(request, receive: false)
	assert response.status == 200
	assert_receive {:gun_up, pid, :http}
	assert is_pid(pid)
	end

	- describe "don't reuse connection if request url is not equal opened connection url" do
	- test "for ipv4" do
	- uri = URI.parse(@http)
	- {:ok, conn} = :gun.open(to_charlist(uri.host), uri.port)
	-
	- request = %Env{
	- method: :get,
	- url: "http://0.0.0.0:5080/stream-bytes/10"
	- }
	-
	- assert {:ok, %Env{} = response} = call(request, body_as: :chunks, conn: conn)
	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	- refute conn == pid
	- assert %{origin_host: {0, 0, 0, 0}} = :gun.info(pid)
	- assert opts[:original_matches] == false
	- assert read_body(pid, stream, opts) \|> byte_size() == 16
	- end
	-
	- test "for domain" do
	- {:ok, conn} = :gun.open({0, 0, 0, 0}, 5080)
	-
	- request = %Env{
	- method: :get,
	- url: "#{@http}/stream-bytes/10"
	- }
	-
	- assert {:ok, %Env{} = response} = call(request, body_as: :chunks, conn: conn)
	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	- refute conn == pid
	- assert %{origin_host: 'localhost'} = :gun.info(pid)
	- assert opts[:original_matches] == false
	- assert read_body(pid, stream, opts) \|> byte_size() == 16
	- end
	-
	- test "for different schemes" do
	- uri = URI.parse(@http)
	- host = to_charlist(uri.host)
	- {:ok, conn} = :gun.open(host, uri.port)
	-
	- request = %Env{
	- method: :get,
	- url: "#{@https}/stream-bytes/10"
	- }
	-
	- assert {:ok, %Env{} = response} = call(request, body_as: :chunks, conn: conn)
	-
	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	-
	- assert is_pid(pid)
	- assert is_reference(stream)
	-
	- assert read_body(pid, stream, opts) \|> byte_size() == 16
	-
	- refute Process.alive?(pid)
	- assert opts[:old_conn] == conn
	- refute conn == pid
	- end
	-
	- test "and don't use verify_fun" do
	- {:ok, conn} = :gun.open({0, 0, 0, 0}, 5443)
	-
	- request = %Env{
	- method: :get,
	- url: "#{@https}/stream-bytes/10"
	- }
	-
	- assert {:ok, %Env{} = response} =
	- call(request,
	- body_as: :chunks,
	- conn: conn,
	- certificates_verification: true,
	- transport_opts: [
	- cacertfile: "./deps/httparrot/priv/ssl/server-ca.crt",
	- verify_fun: {&:ssl_verify_hostname.verify_fun/3, [check_hostname: '0.0.0.0']}
	- ]
	- )
	-
	- assert response.status == 200
	- %{pid: pid, stream: stream, opts: opts} = response.body
	-
	- assert is_pid(pid)
	- assert is_reference(stream)
	-
	- assert read_body(pid, stream, opts) \|> byte_size() == 16
	-
	- refute Process.alive?(pid)
	- assert opts[:old_conn] == conn
	- refute conn == pid
	- end
	- end
	-
	test "on TLS errors get timeout error from await_up method" do
	request = %Env{
	method: :get,
	url: "#{@https}"
	}

	{time, resp} =
	:timer.tc(fn ->
	call(request,
	timeout: 60_000,
	certificates_verification: true
	)
	end)

	assert resp == {:error, :timeout}

	assert time / 1_000_000 < 6
	end

	defp read_body(pid, stream, opts, acc \\ "") do
	case Gun.read_chunk(pid, stream, opts) do
	{:fin, body} ->
	acc <> body

	{:nofin, part} ->
	read_body(pid, stream, opts, acc <> part)
	end
	end
	end

File Metadata

Mime Type: text/x-diff
Expires: Mon, Nov 25, 3:13 PM (1 d, 8 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 39558
Default Alt Text: (33 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions