feat(front): add project level reports (#311) (#317)

## 📝 Description
Cherry picked changes from #311

## ✅ Checklist
- [x] I have tested this change
- [ ] This change requires documentation update

Author: skipi

front/assets/js/report/index.tsx

@@ -18,6 +18,7 @@ export default function ({ config, dom }: { dom: HTMLElement, config: any, }) {
 enum ReportContext {
   Job = `job`,
   Workflow = `workflow`,
+  Project = `project`,
 }
 
 const App = (props: { reportUrl: string, context: ReportContext, }) => {
@@ -77,17 +78,26 @@ const MarkdownBody = (props: { markdown: string, }) => {
 };
 
 const ReportInstructions = (props: { context: ReportContext, }) => {
-  let command = `artifact push workflow -d .semaphore/REPORT.md REPORT.md`;
-  if (props.context === ReportContext.Job) {
-    command = `artifact push job -d .semaphore/REPORT.md REPORT.md`;
+  let command = ``;
+
+  switch (props.context) {
+    case ReportContext.Job:
+      command = `artifact push job -d .semaphore/REPORT.md REPORT.md`;
+      break;
+    case ReportContext.Workflow:
+      command = `artifact push workflow -d .semaphore/REPORT.md REPORT.md`;
+      break;
+    case ReportContext.Project:
+      command = `artifact push project -d .semaphore/REPORT.md REPORT.md`;
+      break;
   }
 
   return (
     <div className="bg-washed-yellow br3 pa3 pa4-m ba b--black-075 w-100">
       <div className="pv3-m mw7 center">
         <h2 className="f3 mb0">Your Markdown reports will appear here.</h2>
         <p className="f4 normal mb4">
-           These reports help share key details about your job or workflow, like build metrics or custom insights.
+           These reports help share key details about your {props.context}, like build metrics or custom insights.
         </p>
         <div className="flex-m">
           <div className="flex-shrink-0 dn db-m nl4 ph4">

front/lib/front/breadcrumbs/project.ex

@@ -16,6 +16,7 @@ defmodule Front.Breadcrumbs.Project do
   defp construct_crumb(:artifacts), do: "Artifacts"
   defp construct_crumb(:scheduler), do: "Scheduler"
   defp construct_crumb(:insights), do: "Insights"
+  defp construct_crumb(:reports), do: "Report"
   defp construct_crumb(:deployments), do: "Deployments"
   defp construct_crumb(:people), do: "People"
   defp construct_crumb(:settings), do: "Settings"

front/lib/front_web/controllers/report_controller.ex

@@ -4,13 +4,7 @@ defmodule FrontWeb.ReportController do
 
   alias Front.Async
 
-  alias FrontWeb.Plugs.{
-    FetchPermissions,
-    Header,
-    PageAccess,
-    PutProjectAssigns,
-    FeatureEnabled
-  }
+  alias FrontWeb.Plugs
 
   alias Front.Models.{
     Artifacthub,
@@ -21,11 +15,11 @@ defmodule FrontWeb.ReportController do
     Workflow
   }
 
-  plug(FeatureEnabled, [:ui_reports])
-  plug(PutProjectAssigns)
-  plug(FetchPermissions, scope: "project")
-  plug(PageAccess, permissions: "project.view")
-  plug(Header when action in [:job, :workflow])
+  plug(Plugs.FeatureEnabled, [:ui_reports])
+  plug(Plugs.PutProjectAssigns)
+  plug(Plugs.FetchPermissions, scope: "project")
+  plug(Plugs.PageAccess, permissions: "project.view")
+  plug(Plugs.Header when action in [:job, :workflow, :project])
 
   def job(conn, _params) do
     Watchman.benchmark("markdown_report.job", fn ->
@@ -80,6 +74,25 @@ defmodule FrontWeb.ReportController do
     end)
   end
 
+  def project(conn, _params) do
+    Watchman.benchmark("markdown_report.project", fn ->
+      project = conn.assigns.project
+
+      {assigns, org} =
+        assign_report_layout(conn, "project", project, %{
+          base_url: report_url(conn, :project, project.name),
+          project: project
+        })
+
+      assigns =
+        assigns
+        |> project_assigns(org, project)
+        |> Front.Breadcrumbs.Project.construct(conn, :reports)
+
+      render(conn, "markdown.html", assigns)
+    end)
+  end
+
   defp assign_report_layout(conn, context, resource, extra_assigns) do
     org_id = conn.assigns.organization_id
     project = conn.assigns.project
@@ -152,11 +165,31 @@ defmodule FrontWeb.ReportController do
     |> Map.put(:title, "Report ・#{project.name}・#{org.name}")
   end
 
+  defp project_assigns(assigns, org, project) do
+    user = assigns.user
+
+    starred? =
+      Watchman.benchmark(
+        "project_page_check_star",
+        fn ->
+          Front.Models.User.has_favorite(user.id, org.id, project.id)
+        end
+      )
+
+    assigns
+    |> Map.put(:organization, org)
+    |> Map.put(:starred?, starred?)
+  end
+
   defp fetch_report_from_context(project, "job", job) do
     Artifacthub.signed_url(project.id, "jobs", job.id, ".semaphore/REPORT.md")
   end
 
   defp fetch_report_from_context(project, "workflow", workflow) do
     Artifacthub.signed_url(project.id, "workflows", workflow.id, ".semaphore/REPORT.md")
   end
+
+  defp fetch_report_from_context(project, "project", project) do
+    Artifacthub.signed_url(project.id, "projects", project.id, ".semaphore/REPORT.md")
+  end
 end

front/lib/front_web/router.ex

@@ -545,6 +545,8 @@ defmodule FrontWeb.Router do
     put("/projects/:name_or_id/settings/pre_flight_checks", ProjectPFCController, :put)
     delete("/projects/:name_or_id/settings/pre_flight_checks", ProjectPFCController, :delete)
 
+    get("/projects/:name_or_id/report", ReportController, :project)
+
     get("/", DashboardController, :index)
     get("/workflows", DashboardController, :workflows)
     get("/dashboards/:name", DashboardController, :show)

front/lib/front_web/templates/layout/project.html.eex

@@ -55,6 +55,14 @@
           '), to: insights_index_path(@conn, :index, @project.name, []),
           class: Front.Decorators.Header.Project.tab_class(@conn, insights_index_path(@conn, :index, @project.name, [])) %>
     <% end %>
+    <%= if FeatureProvider.feature_enabled?(:ui_reports, param: @conn.assigns[:organization_id]) do %>
+      <%= link raw(~s'
+            <svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M2.025 2.025A3.5 3.5 0 001 4.5v7A3.5 3.5 0 004.5 15h7a3.5 3.5 0 003.5-3.5v-7A3.5 3.5 0 0011.5 1h-7a3.5 3.5 0 00-2.475 1.025zm.99.99A2.1 2.1 0 014.5 2.4h7a2.1 2.1 0 012.1 2.1v7a2.1 2.1 0 01-2.1 2.1h-7a2.1 2.1 0 01-2.1-2.1v-7a2.1 2.1 0 01.615-1.485zM4.7 4a.7.7 0 100 1.4h3.194a.7.7 0 100-1.4H4.7zM4 8a.7.7 0 01.7-.7h4.975a.7.7 0 110 1.4H4.7A.7.7 0 014 8zm4.731 2.594a.7.7 0 100 1.4h2.788a.7.7 0 000-1.4H8.73zm-4.731.7a.7.7 0 01.7-.7h1.787a.7.7 0 110 1.4H4.7a.7.7 0 01-.7-.7zM10.512 4a.7.7 0 100 1.4h1.007a.7.7 0 000-1.4h-1.007z"/></svg>
+            <span>Report</span>
+          '),
+          to: report_path(@conn, :project, @project.name),
+          class: Front.Decorators.Header.Project.tab_class(@conn, report_path(@conn, :project, @project.name)) %>
+    <% end %>
     <%= if FeatureProvider.feature_enabled?(:artifacts, param: @conn.assigns[:organization_id]) do %>
       <%= link raw(~s'
 <svg width="16" height="16" fill="none" xmlns="http://www.w3.org/2000/svg">

front/priv/storage/reports/project_report.md

@@ -0,0 +1,3 @@
+# Project Report
+
+This is a test project report.

front/test/browser/report_page_test.exs

@@ -45,6 +45,18 @@ defmodule Front.Browser.ReportPageTest do
       |> visit("/jobs/#{job_id}")
       |> refute_has(Query.text("Report"))
     end
+
+    test "does not display a report tab on a project page", %{
+      session: session
+    } do
+      project_name =
+        DB.first(:projects)
+        |> Map.get(:name)
+
+      session
+      |> visit("/projects/#{project_name}")
+      |> refute_has(Query.text("Report"))
+    end
   end
 
   describe "when ui_reports feature is enabled" do
@@ -81,5 +93,17 @@ defmodule Front.Browser.ReportPageTest do
       |> visit("/jobs/#{job_id}")
       |> assert_has(Query.text("Report"))
     end
+
+    test "displays a report tab on a project page", %{
+      session: session
+    } do
+      project_name =
+        DB.first(:projects)
+        |> Map.get(:name)
+
+      session
+      |> visit("/projects/#{project_name}")
+      |> assert_has(Query.text("Report"))
+    end
   end
 end

front/test/support/stubs/project.ex

@@ -81,6 +81,18 @@ defmodule Support.Stubs.Project do
     Artifacthub.create(workflow.id, params)
   end
 
+  def add_report(project_id, filename \\ "reports/project_report.md") do
+    Artifacthub.create(project_id,
+      path: ".semaphore/REPORT.md",
+      scope: "projects",
+      url:
+        Path.join(
+          Application.get_env(:front, :artifact_host),
+          filename
+        )
+    )
+  end
+
   @spec set_project_state(project_stub_t(), InternalApi.Projecthub.Project.Status.State.t()) ::
           any()
   def set_project_state(project, state) do