Current section

Files

Jump to
phoenix_live_view lib phoenix_live_view test dom.ex
Raw

lib/phoenix_live_view/test/dom.ex

defmodule Phoenix.LiveViewTest.DOM do
@moduledoc false
@phx_component "data-phx-component"
@static :s
@dynamics :d
@components :c
def by_id!(html_tree, id) do
by_id(html_tree, id) || raise ArgumentError, "could not find ID #{inspect(id)} in the DOM"
end
def cid_by_id(rendered, id) do
rendered
|> render_diff()
|> by_id!(id)
|> all_attributes(@phx_component)
|> case do
[cid] -> String.to_integer(cid)
[] -> nil
end
end
def all(html_tree, selector), do: Floki.find(html_tree, selector)
def parse(html) do
{:ok, parsed} = Floki.parse_document(html)
parsed
end
def attrs({_tag, attrs, _children}), do: Enum.into(attrs, %{})
def attrs({_tag, attrs, _children}, key), do: Enum.into(attrs, %{})[key]
def all_attributes(html_tree, name), do: Floki.attribute(html_tree, name)
def to_html(html_tree), do: Floki.raw_html(html_tree)
def filter_out(html_tree, selector), do: Floki.filter_out(html_tree, selector)
def child_nodes({_, _, children}), do: children
def inner_html(html, id), do: html |> by_id!(id) |> child_nodes()
def outer_html(html, id), do: html |> by_id!(id)
def find_static_views(html) do
html
|> all("[data-phx-static]")
|> Enum.into(%{}, fn node ->
attrs = attrs(node)
{attrs["id"], attrs["data-phx-static"]}
end)
end
def find_live_views(html) do
html
|> all("[data-phx-session]")
|> Enum.map(fn node ->
attrs = attrs(node)
static =
cond do
attrs["data-phx-static"] in [nil, ""] -> nil
true -> attrs["data-phx-static"]
end
{attrs["id"], attrs["data-phx-session"], static}
end)
end
def deep_merge(target, source) do
Map.merge(target, source, fn
_, %{} = target, %{} = source -> deep_merge(target, source)
_, _target, source -> source
end)
end
# Diff rendering
def render_diff(rendered) do
render_diff(rendered, Map.get(rendered, @components, %{}))
end
def render_diff(rendered, components) do
rendered
|> to_output_buffer(components, [])
|> Enum.reverse()
|> IO.iodata_to_binary()
|> parse()
|> List.wrap()
end
# for comprehension
defp to_output_buffer(%{@dynamics => for_dynamics, @static => statics}, components, acc) do
Enum.reduce(for_dynamics, acc, fn dynamics, acc ->
dynamics
|> Enum.with_index()
|> Enum.into(%{@static => statics}, fn {val, key} -> {key, val} end)
|> to_output_buffer(components, acc)
end)
end
defp to_output_buffer(%{@static => [head | tail]} = rendered, components, acc) do
tail
|> Enum.with_index(0)
|> Enum.reduce([head | acc], fn {static, index}, acc ->
[static | dynamic_to_buffer(rendered[index], components, acc)]
end)
end
defp dynamic_to_buffer(%{} = rendered, components, acc) do
to_output_buffer(rendered, components, []) ++ acc
end
defp dynamic_to_buffer(str, _components, acc) when is_binary(str), do: [str | acc]
defp dynamic_to_buffer(cid, components, acc) when is_integer(cid) do
html_with_cids =
components
|> Map.fetch!(cid)
|> render_diff(components)
|> Enum.map(walk_fun(&inject_cid_attr(&1, cid)))
|> to_html()
[html_with_cids | acc]
end
defp inject_cid_attr({tag, attrs, children}, cid) do
{tag, attrs ++ [{@phx_component, to_string(cid)}], children}
end
# Patching
def patch_id(id, html, inner_html) do
cids_before = find_component_ids(id, html)
phx_update_tree =
walk(inner_html, fn node ->
apply_phx_update(attrs(node, "phx-update"), html, node)
end)
new_html =
walk(html, fn {tag, attrs, children} = node ->
if attrs(node, "id") == id do
{tag, attrs, phx_update_tree}
else
{tag, attrs, children}
end
end)
cids_after = find_component_ids(id, new_html)
deleted_cids = for cid <- cids_before -- cids_after, do: String.to_integer(cid)
deleted_ids =
html
|> all(Enum.join(Enum.map(deleted_cids, &"[#{@phx_component}=\"#{&1}\"]"), ", "))
|> all_attributes("id")
{new_html, deleted_cids, deleted_ids}
end
defp walk(html_tree, fun) when is_function(fun, 1) do
Floki.traverse_and_update(html_tree, walk_fun(fun))
end
defp walk_fun(fun) when is_function(fun, 1) do
fn
{:pi, _, _} = xml -> xml
{:comment, _children} = comment -> comment
{:doctype, _, _, _} = doctype -> doctype
{_tag, _attrs, _children} = node -> fun.(node)
end
end
defp find_component_ids(id, html) do
html
|> by_id!(id)
|> all("[#{@phx_component}]")
|> all_attributes(@phx_component)
end
defp apply_phx_update(type, html, {tag, attrs, appended_children} = node)
when type in ["append", "prepend"] do
children_before = phx_update_children(html, attrs(node, "id"))
existing_ids = all_attributes(children_before, "id")
new_ids = all_attributes(appended_children, "id")
content_changed? = new_ids !== existing_ids
dup_ids =
if content_changed? && new_ids do
Enum.filter(new_ids, fn id -> id in existing_ids end)
else
[]
end
{updated_existing_children, updated_appended} =
Enum.reduce(dup_ids, {children_before, appended_children}, fn dup_id, {before, appended} ->
patched_before =
walk(before, fn {tag, attrs, _} = node ->
cond do
attrs(node, "id") == dup_id -> {tag, attrs, inner_html(appended, dup_id)}
true -> node
end
end)
{patched_before, filter_out(appended, "##{dup_id}")}
end)
cond do
content_changed? && type == "append" ->
{tag, attrs, updated_existing_children ++ updated_appended}
content_changed? && type == "prepend" ->
{tag, attrs, updated_appended ++ updated_existing_children}
!content_changed? ->
{tag, attrs, updated_appended}
end
end
defp apply_phx_update(type, _state, {tag, attrs, children})
when type in [nil, "replace", "ignore"] do
{tag, attrs, children}
end
defp apply_phx_update(other, _state, {_tag, _attrs, _children}) do
raise ArgumentError, """
invalid phx-update value #{inspect(other)}.
Expected one of "replace", "append", "prepend", "ignore"
"""
end
def phx_update_children(html, id) do
case by_id(html, id) do
{_, _, children_before} -> children_before
nil -> raise ArgumentError, "phx-update append/prepend containers require an ID"
end
end
defp by_id(html_tree, ids) when is_list(ids) do
selector = Enum.join(Enum.map(ids, fn id -> "##{id}" end), " ")
case Floki.find(html_tree, selector) do
[node | _] -> node
[] -> nil
end
end
defp by_id(html_tree, id) do
case Floki.find(html_tree, "##{id}") do
[node | _] -> node
[] -> nil
end
end
end