Add Plug.Test.sent_chunks/2

Before this patch there was no way to reconstruct the invidual chunks
that were sent. All we got was the full resulting body in
`conn.resp_body`.

For completeness, I believe instead of messaging we could store chunks in a list
in the test adapter state and simply append:

    - def send_chunked(state, _status, _headers), do: {:ok, "", %{state | chunks: ""}}
    + def send_chunked(state, _status, _headers), do: {:ok, "", %{state | chunks: []}}

    - def chunk(%{owner: owner, ref: ref, chunks: chunks} = state, chunk) do
    -   send(owner, {ref, :chunk, chunk})
    -   body = chunks <> IO.iodata_to_binary(chunk)
    -   {:ok, body, %{state | chunks: body}}
    - end
    + def chunk(%{owner: owner, ref: ref, chunks: chunks} = state, chunk) do
    +   chunk = IO.iodata_to_binary(chunk)
    +   body = IO.iodata_to_binary([chunks, chunk])
    +   {:ok, body, %{state | chunks: chunks ++ [chunk]}}
    + end

but I was following the existing functions `sent_informs` and `sent_upgrades`.

My use case is to be able to test response streaming using Req :plug
adapter:

    req =
      Req.new(
        plug: fn conn ->
          conn = Plug.Conn.send_chunked(conn, 200)
          {:ok, conn} = Plug.Conn.chunk(conn, "foo")
          {:ok, conn} = Plug.Conn.chunk(conn, "bar")
          conn
        end,
        into: []
      )

    resp = Req.request!(req)
    assert resp.body == ["foo", "bar"]

Author: wojtekmach

lib/plug/adapters/test/conn.ex

@@ -90,8 +90,10 @@ defmodule Plug.Adapters.Test.Conn do
 
   def chunk(%{method: "HEAD"} = state, _body), do: {:ok, "", state}
 
-  def chunk(%{chunks: chunks} = state, body) do
-    body = chunks <> IO.iodata_to_binary(body)
+  def chunk(%{owner: owner, ref: ref, chunks: chunks} = state, chunk) do
+    chunk = IO.iodata_to_binary(chunk)
+    send(owner, {ref, :chunk, chunk})
+    body = chunks <> chunk
     {:ok, body, %{state | chunks: body}}
   end
 

lib/plug/test.ex

@@ -99,13 +99,39 @@ defmodule Plug.Test do
     end
   end
 
+  @doc """
+  Returns the sent body chunks.
+
+  This function depends on gathering the messages sent by the test adapter when
+  response body chunks are sent. Calling this function will clear the chunk
+  messages from the inbox for the process. To assert on multiple informs, the
+  result of the function should be stored in a variable.
+
+  ## Examples
+
+      conn = conn(:get, "/")
+      assert Plug.Test.sent_chunks(conn) == ["foo", "bar"]
+  """
+  def sent_chunks(%Plug.Conn{adapter: {Plug.Adapters.Test.Conn, %{ref: ref}}}) do
+    Enum.reverse(receive_chunks(ref, []))
+  end
+
+  defp receive_chunks(ref, chunks) do
+    receive do
+      {^ref, :chunk, chunk} ->
+        receive_chunks(ref, [chunk | chunks])
+    after
+      0 -> chunks
+    end
+  end
+
   @doc """
   Returns the informational requests that have been sent.
 
   This function depends on gathering the messages sent by the test adapter when
   informational messages, such as an early hint, are sent. Calling this
   function will clear the informational request messages from the inbox for the
-  process.  To assert on multiple informs, the result of the function should be
+  process. To assert on multiple informs, the result of the function should be
   stored in a variable.
 
   ## Examples

test/plug/adapters/test/conn_test.exs

@@ -114,6 +114,16 @@ defmodule Plug.Adapters.Test.ConnTest do
     assert child_conn.host == "www.elixir-lang.org"
   end
 
+  test "sent chunks" do
+    conn = conn(:get, "/")
+    conn = Plug.Conn.send_chunked(conn, 200)
+    {:ok, conn} = Plug.Conn.chunk(conn, "foo")
+    {:ok, conn} = Plug.Conn.chunk(conn, "bar")
+
+    assert conn.resp_body == "foobar"
+    assert Plug.Test.sent_chunks(conn) == ["foo", "bar"]
+  end
+
   test "inform adds to the informational responses to the list" do
     conn =
       conn(:get, "/")