ex_check_ng

defmodule ExCheck.Reporter.Github do
  @moduledoc false

  # GitHub Actions workflow-command output. Passing/failing tools are rendered to the
  # workflow log: ok/skipped as one-liners, failures as collapsible `::group::` blocks
  # carrying their raw (ANSI-colored) output, which the GitHub log renderer displays.
  # A Markdown run summary is appended to the file named by `$GITHUB_STEP_SUMMARY`.
  #
  # This reporter writes to stdout directly (not via Reporter.emit/2) since the log has
  # to reach the live GitHub runner; `--output` is rejected for this format.

  @behaviour ExCheck.Reporter

  alias ExCheck.Diagnostics
  alias ExCheck.Reporter

  # GitHub renders at most 10 annotations of each type per step; emitting more is wasted.
  @max_annotations 10

  @impl true
  def report(results, total_duration, _opts) do
    token = gen_token()
    IO.write(log(results, token))
    write_step_summary(results, total_duration)
    :ok
  end

  @doc """
  Renders the workflow log for `results`. `token` scopes the `::stop-commands::` guard
  that wraps raw failure output so that any workflow-command-looking lines inside a
  tool's output can't be interpreted by the runner. Inline `::error`/`::warning` file
  annotations are emitted after all groups (GitHub ignores annotations that appear
  inside a stop-commands region).
  """
  def log(results, token) do
    sorted = Enum.sort_by(results, &Reporter.summary_order/1)
    [Enum.map(sorted, &line(&1, token)), annotations(sorted)]
  end

  defp line({:ok, {name, _, _}, {_, _, duration}}, _token) do
    "✓ #{Reporter.tool_name_string(name)} success in #{Reporter.format_duration(duration)}\n"
  end

  defp line({:skipped, name, reason}, _token) do
    "⏭ #{Reporter.tool_name_string(name)} skipped (#{Reporter.skip_reason_string(reason)})\n"
  end

  defp line({:error, {name, cmd, _}, {code, output, _}}, token) do
    title = "✕ #{Reporter.tool_name_string(name)} — #{command(cmd)} (exit #{code})"

    [
      "::group::#{escape_data(title)}\n",
      "::stop-commands::#{token}\n",
      ensure_trailing_newline(output),
      "::#{token}::\n",
      "::endgroup::\n"
    ]
  end

  # One inline annotation per structured diagnostic, capped at GitHub's per-type limit.
  # When a failed check yields no diagnostics (no parser, or unparseable output) we fall
  # back to a single file-less annotation so every failure still shows up in the PR.
  defp annotations(sorted_results) do
    sorted_results
    |> Enum.filter(&match?({:error, _, _}, &1))
    |> Enum.map(&check_annotations/1)
  end

  defp check_annotations({:error, {name, _cmd, tool_opts}, {code, _output, _}} = result) do
    case Diagnostics.extract(result) do
      [] ->
        message = "#{Reporter.tool_name_string(name)} failed (exit #{code})"
        "::error::#{escape_data(message)}\n"

      diagnostics ->
        diagnostics
        |> Enum.take(@max_annotations)
        |> Enum.map(&annotation(&1, name, tool_opts))
    end
  end

  defp annotation(diagnostic, name, tool_opts) do
    command = if diagnostic.severity == :warning, do: "warning", else: "error"
    props = annotation_props(diagnostic, tool_opts, Reporter.tool_name_string(name))

    "::#{command} #{props}::#{escape_data(diagnostic.message)}\n"
  end

  defp annotation_props(diagnostic, tool_opts, title) do
    [
      prop("file", annotation_file(diagnostic, tool_opts)),
      prop("line", diagnostic.line),
      prop("col", diagnostic.column),
      prop("title", title)
    ]
    |> Enum.reject(&is_nil/1)
    |> Enum.join(",")
  end

  defp prop(_key, nil), do: nil
  defp prop(key, value) when is_integer(value), do: "#{key}=#{value}"
  defp prop(key, value), do: "#{key}=#{escape_property(value)}"

  # `:cd` (an umbrella child's `apps/<app>`) is relative to the `mix check` cwd. GitHub
  # anchors annotations against `$GITHUB_WORKSPACE`; if check runs from a different cwd
  # the path won't line up and GitHub drops the file, degrading to a file-less annotation
  # — acceptable, and avoids sniffing the environment.
  defp annotation_file(%{file: nil}, _tool_opts), do: nil

  defp annotation_file(%{file: file}, tool_opts) do
    case tool_opts[:cd] do
      nil -> file
      cd -> Path.join(cd, file)
    end
  end

  @doc "Escapes a workflow-command data payload (message body)."
  def escape_data(str) do
    str
    |> String.replace("%", "%25")
    |> String.replace("\r", "%0D")
    |> String.replace("\n", "%0A")
  end

  @doc "Escapes a workflow-command property value (stricter than data)."
  def escape_property(str) do
    str
    |> escape_data()
    |> String.replace(":", "%3A")
    |> String.replace(",", "%2C")
  end

  @doc "Appends the Markdown run summary to `$GITHUB_STEP_SUMMARY`, or skips silently if unset."
  # sobelow_skip ["Traversal.FileModule"]
  def write_step_summary(results, total_duration) do
    case System.get_env("GITHUB_STEP_SUMMARY") do
      path when is_binary(path) and path != "" ->
        File.write!(path, summary_md(results, total_duration), [:append])

      _ ->
        :ok
    end

    :ok
  end

  defp summary_md(results, total_duration) do
    rows =
      results
      |> Enum.sort_by(&Reporter.summary_order/1)
      |> Enum.map(&summary_row/1)

    [
      "## mix check\n\n",
      "| Check | Status | Duration |\n",
      "| --- | --- | --- |\n",
      rows,
      "\nTotal: #{Reporter.format_duration(total_duration)}\n"
    ]
  end

  defp summary_row({:ok, {name, _, _}, {_, _, duration}}) do
    "| #{Reporter.tool_name_string(name)} | ✅ | #{Reporter.format_duration(duration)} |\n"
  end

  defp summary_row({:error, {name, _, _}, {_, _, duration}}) do
    "| #{Reporter.tool_name_string(name)} | ❌ | #{Reporter.format_duration(duration)} |\n"
  end

  defp summary_row({:skipped, name, _reason}) do
    "| #{Reporter.tool_name_string(name)} | ⏭ | — |\n"
  end

  defp command(cmd), do: cmd |> List.wrap() |> Enum.join(" ")

  defp ensure_trailing_newline(""), do: "\n"

  defp ensure_trailing_newline(str),
    do: if(String.ends_with?(str, "\n"), do: str, else: str <> "\n")

  defp gen_token, do: Base.encode16(:crypto.strong_rand_bytes(8))
end