Current section

Files

Jump to
dumper lib dumper.ex
Raw

lib/dumper.ex

# Copyright 2024 Adobe. All rights reserved.
# This file is licensed to you under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License. You may obtain a copy
# of the License at http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software distributed under
# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
# OF ANY KIND, either express or implied. See the License for the specific language
# governing permissions and limitations under the License.
defmodule Dumper do
@moduledoc false
use Phoenix.Component
import Ecto.Query
alias Phoenix.LiveDashboard.PageBuilder
embed_templates "dumper/components/*"
def docs(assigns) do
doctext =
case Code.fetch_docs(assigns.module) do
{_, _, _, _, %{"en" => doctext} = _module_doc, _, _} -> String.trim(doctext)
_ -> ""
end
markdown_html =
doctext
|> Earmark.as_html!(code_class_prefix: "lang- language-")
|> Phoenix.HTML.raw()
assigns = assign(assigns, markdown: markdown_html, doctext: doctext)
~H"""
<details :if={@doctext != ""} class="markdown mt-2">
<summary class="cursor-pointer">Documentation</summary>
<div class="card bg-light mt-1 p-3 small">{@markdown}</div>
</details>
"""
end
def module_name(module), do: module |> to_string() |> String.replace(~r/^Elixir\./, "")
def humanize_association_name(module) when is_atom(module) do
module |> Atom.to_string() |> String.split("_") |> Enum.map_join(" ", &String.capitalize/1)
end
def fields(module, config_module) do
all = module.__schema__(:fields)
excluded = config_module.excluded_fields()
{allowed_map, allowed_strict?} =
case config_module.allowed_fields() do
nil -> {%{}, false}
%{} = m -> {m, true}
{m, :lenient} -> {m, false}
{m, _strict} -> {m, true}
end
cond do
allowed_strict? || Map.has_key?(allowed_map, module) ->
allowed_map |> Map.get(module, []) |> Enum.filter(fn f -> f in all end)
Map.has_key?(excluded, module) ->
Enum.reduce(excluded[module], all, fn f, acc -> List.delete(acc, f) end)
true ->
all
end
end
def embeds(module), do: module.__schema__(:embeds)
def redacted_fields(module), do: module.__schema__(:redact_fields)
def custom_record_links(record, config_module), do: config_module.custom_record_links(record)
def additional_associations(record, config_module), do: config_module.additional_associations(record)
def value(assigns) do
assigns.config_module.display(assigns)
end
def paginate(query, %{"pagenum" => page, "page_size" => page_size}, repo) do
page = if is_binary(page), do: String.to_integer(page), else: page
page = max(1, page)
page_size = if is_binary(page_size), do: String.to_integer(page_size), else: page_size
page_size = max(1, page_size)
page_size_plus_one = page_size + 1
entries =
query
|> limit(^page_size_plus_one)
|> offset(^(page_size * (page - 1)))
|> repo.all()
%{
entries: Enum.take(entries, page_size),
has_prev?: page > 1,
has_next?: Enum.count(entries) == page_size_plus_one,
page: page,
page_size: page_size
}
end
defp fetch_rows(otp_app) do
fn params, _node ->
%{search: search, sort_by: _sort_by, sort_dir: sort_dir, limit: limit} = params
search = String.downcase(search || "")
{:ok, modules} = :application.get_key(otp_app, :modules)
modules =
modules
|> Enum.filter(&is_ecto_schema?/1)
|> Enum.map(fn module -> %{name: module |> Module.split() |> Enum.join(".")} end)
# apply search
modules = Enum.filter(modules, fn %{name: name} -> String.downcase(name) =~ search end)
# sort
modules = Enum.sort(modules, sort_dir)
{Enum.take(modules, limit), Enum.count(modules)}
end
end
defp row_attrs(%{name: module}) do
[
{"phx-click", "show_table"},
{"phx-value-module", module},
{"phx-page-loading", true}
]
end
defp is_ecto_schema?(module) do
# true iff it 1. is a module 2. has a __schema__ function 3. is not an Embedded Schema
match?({:module, _}, Code.ensure_loaded(module)) &&
{:__schema__, 1} in module.__info__(:functions) &&
module.__schema__(:source) != nil
end
end