Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: improve decompression middleware #606

Merged
merged 1 commit into from
Oct 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 57 additions & 6 deletions lib/tesla/middleware/compression.ex
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,16 @@ defmodule Tesla.Middleware.Compression do
def call(env, next, opts) do
env
|> compress(opts)
|> Tesla.put_headers([{"accept-encoding", "gzip, deflate"}])
|> add_accept_encoding()
|> Tesla.run(next)
|> decompress()
end

@doc false
def add_accept_encoding(env) do
Tesla.put_headers(env, [{"accept-encoding", "gzip, deflate, identity"}])
end

defp compressible?(body), do: is_binary(body)

@doc """
Expand Down Expand Up @@ -61,13 +66,59 @@ defmodule Tesla.Middleware.Compression do
def decompress({:error, reason}), do: {:error, reason}

def decompress(env) do
codecs = compression_algorithms(Tesla.get_header(env, "content-encoding"))
{decompressed_body, unknown_codecs} = decompress_body(codecs, env.body, [])

env
|> Tesla.put_body(decompress_body(env.body, Tesla.get_header(env, "content-encoding")))
|> put_decompressed_body(decompressed_body)
|> put_or_delete_content_encoding(unknown_codecs)
end

defp put_or_delete_content_encoding(env, []) do
Tesla.delete_header(env, "content-encoding")
end

defp put_or_delete_content_encoding(env, unknown_codecs) do
Tesla.put_header(env, "content-encoding", Enum.join(unknown_codecs, ", "))
end

defp decompress_body([gzip | rest], body, acc) when gzip in ["gzip", "x-gzip"] do
decompress_body(rest, :zlib.gunzip(body), acc)
end

defp decompress_body(<<31, 139, 8, _::binary>> = body, "gzip"), do: :zlib.gunzip(body)
defp decompress_body(body, "deflate"), do: :zlib.unzip(body)
defp decompress_body(body, _content_encoding), do: body
defp decompress_body(["deflate" | rest], body, acc) do
decompress_body(rest, :zlib.unzip(body), acc)
end

defp decompress_body(["identity" | rest], body, acc) do
decompress_body(rest, body, acc)
end

defp decompress_body([codec | rest], body, acc) do
decompress_body(rest, body, [codec | acc])
end

defp decompress_body([], body, acc) do
{body, acc}
end

defp compression_algorithms(nil) do
[]
end

defp compression_algorithms(value) do
value
|> String.downcase()
|> String.split(",", trim: true)
|> Enum.map(&String.trim/1)
|> Enum.reverse()
end

defp put_decompressed_body(env, body) do
env
|> Tesla.put_body(body)
|> Tesla.delete_header("content-length")
end
end

defmodule Tesla.Middleware.CompressRequest do
Expand Down Expand Up @@ -99,7 +150,7 @@ defmodule Tesla.Middleware.DecompressResponse do
@impl Tesla.Middleware
def call(env, next, _opts) do
env
|> Tesla.put_headers([{"accept-encoding", "gzip, deflate"}])
|> Tesla.Middleware.Compression.add_accept_encoding()
|> Tesla.run(next)
|> Tesla.Middleware.Compression.decompress()
end
Expand Down
3 changes: 2 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ defmodule Tesla.Mixfile do
plt_add_apps: [:mix, :inets, :idna, :ssl_verify_fun, :ex_unit],
plt_add_deps: :project
],
docs: docs()
docs: docs(),
preferred_cli_env: [coveralls: :test, "coveralls.html": :test]
]
end

Expand Down
7 changes: 7 additions & 0 deletions test/support/test_support.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
defmodule TestSupport do
def gzip_headers(env) do
env.headers
|> Enum.map_join("|", fn {key, value} -> "#{key}: #{value}" end)
|> :zlib.gzip()
end
end
12 changes: 8 additions & 4 deletions test/tesla/middleware/compression_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ defmodule Tesla.Middleware.CompressionTest do

test "decompress response body (gzip)" do
assert {:ok, env} = CompressionResponseClient.get("/response-gzip")
assert env.headers == [{"content-type", "text/plain"}]
assert env.body == "decompressed gzip"
end

Expand All @@ -80,6 +81,7 @@ defmodule Tesla.Middleware.CompressionTest do
test "return unchanged response for unsupported content-encoding" do
assert {:ok, env} = CompressionResponseClient.get("/response-identity")
assert env.body == "unchanged"
assert env.headers == [{"content-type", "text/plain"}]
end

defmodule CompressRequestDecompressResponseClient do
Expand Down Expand Up @@ -114,7 +116,8 @@ defmodule Tesla.Middleware.CompressionTest do
{status, headers, body} =
case env.url do
"/" ->
{200, [{"content-type", "text/plain"}, {"content-encoding", "gzip"}], env.headers}
{200, [{"content-type", "text/plain"}, {"content-encoding", "gzip"}],
TestSupport.gzip_headers(env)}
yordis marked this conversation as resolved.
Show resolved Hide resolved
end

{:ok, %{env | status: status, headers: headers, body: body}}
Expand All @@ -123,7 +126,7 @@ defmodule Tesla.Middleware.CompressionTest do

test "Compression headers" do
assert {:ok, env} = CompressionHeadersClient.get("/")
assert env.body == [{"accept-encoding", "gzip, deflate"}]
assert env.body == "accept-encoding: gzip, deflate, identity"
end

defmodule DecompressResponseHeadersClient do
Expand All @@ -135,7 +138,8 @@ defmodule Tesla.Middleware.CompressionTest do
{status, headers, body} =
case env.url do
"/" ->
{200, [{"content-type", "text/plain"}, {"content-encoding", "gzip"}], env.headers}
{200, [{"content-type", "text/plain"}, {"content-encoding", "gzip"}],
TestSupport.gzip_headers(env)}
end

{:ok, %{env | status: status, headers: headers, body: body}}
Expand All @@ -144,7 +148,7 @@ defmodule Tesla.Middleware.CompressionTest do

test "Decompress response headers" do
assert {:ok, env} = DecompressResponseHeadersClient.get("/")
assert env.body == [{"accept-encoding", "gzip, deflate"}]
assert env.body == "accept-encoding: gzip, deflate, identity"
end

defmodule CompressRequestHeadersClient do
Expand Down
Loading