feat(front): invalidate branch page cache when branch becomes unmergeable (#391)

When a pull request branch becomes unmergeable, we invalidate the branch page
for it, so we can display the pull request unmergeable warning.

Author: lucaspin

front/lib/front/branch_page/cache_invalidator.ex

@@ -19,7 +19,8 @@ defmodule Front.BranchPage.CacheInvalidator do
       {"pipeline_state_exchange", "running", :pipeline_event},
       {"pipeline_state_exchange", "stopping", :pipeline_event},
       {"pipeline_state_exchange", "done", :pipeline_event},
-      {"velocity_pipeline_summary_exchange", "done", :pipeline_summary_event}
+      {"velocity_pipeline_summary_exchange", "done", :pipeline_summary_event},
+      {"hook_exchange", "pr_unmergeable", :pr_unmergeable_event}
     ]
 
   @metric_name "branch_page.cache_invalidator.process"
@@ -61,6 +62,24 @@ defmodule Front.BranchPage.CacheInvalidator do
       )
   end
 
+  def pr_unmergeable_event(message) do
+    Watchman.benchmark({@metric_name, ["pr_unmergeable_event"]}, fn ->
+      event = InternalApi.RepoProxy.PullRequestUnmergeable.decode(message)
+
+      measure_queue_time(event, "pr_unmergeable_event")
+      invalidate_with_pr_branch(event.project_id, event.branch_name)
+
+      Logger.info(
+        "#{@log_prefix} [PR UNMERGEABLE EVENT] [project_id=#{event.project_id} branch=#{event.branch_name}] Processing finished"
+      )
+    end)
+  rescue
+    e in Protobuf.DecodeError ->
+      Logger.error(
+        "#{@log_prefix} [PR UNMERGEABLE EVENT] Processing failed message: #{inspect(message)} error: #{inspect(e)}"
+      )
+  end
+
   def measure_queue_time(event, tag) do
     fetched_for_processing_at = :os.system_time(:millisecond)
     emitted_at = event.timestamp.seconds * 1000 + div(event.timestamp.nanos, 1_000_000)
@@ -84,4 +103,24 @@ defmodule Front.BranchPage.CacheInvalidator do
       struct!(BranchPage.Model.LoadParams, branch_id: pipeline.branch_id)
       |> BranchPage.Model.invalidate()
   end
+
+  defp invalidate_with_pr_branch(project_id, branch_name) do
+    #
+    # Find the latest workflow for the branch,
+    # and invalidate the cache for it, since it's from that workflow
+    # that we determine the conflict status of the branch.
+    #
+    workflow =
+      Models.Workflow.find_latest(
+        project_id: project_id,
+        branch_name: branch_name
+      )
+
+    Models.RepoProxy.invalidate(workflow.hook_id)
+    Models.Workflow.invalidate(workflow.id)
+
+    {:ok, _} =
+      struct!(BranchPage.Model.LoadParams, branch_id: workflow.branch_id)
+      |> BranchPage.Model.invalidate()
+  end
 end

front/lib/front/models/repo_proxy.ex

@@ -45,7 +45,7 @@ defmodule Front.Models.RepoProxy do
 
   def find(id, tracing_headers) do
     Watchman.benchmark("fetch_repo_proxy.duration", fn ->
-      Cacheman.fetch(:front, cache_key(id), fn ->
+      Cacheman.fetch(:front, cache_key(id), [ttl: :timer.hours(1)], fn ->
         request = %RepoProxy.DescribeRequest{hook_id: id}
 
         {:ok, response} = Stub.describe(channel(), request, options(tracing_headers))
@@ -231,6 +231,11 @@ defmodule Front.Models.RepoProxy do
     |> Enum.filter(fn id -> !Enum.any?(cached, fn hook -> hook.id == id end) end)
   end
 
+  def invalidate(id) do
+    cache_key(id)
+    |> then(&Cacheman.delete(:front, &1))
+  end
+
   defp sort_in_requested_order(hooks, ids) do
     ids
     |> Enum.map(fn id ->

front/lib/front_web/templates/branch/_conflict_info.html.eex

@@ -1,18 +1,15 @@
-<div class="mv3 pa3 bg-lightest-orange ba b--black-15">
+<div class="mv3 pa3 ph4 bg-lightest-orange ba b--black-15">
   <div class="flex-m items-center justify-between">
     <div class="mb3 mb0-m pr3-m">
       <div class="flex-m items-center">
-        <div class="flex-shrink-0 mb2 mb0-m pr3">
-          <img src="<%= assets_path() %>/images/icn-warning.svg">
-        </div>
         <div class="flex-auto">
           <p class="b mb0">This Pull Request has conflicts that must be resolved</p>
-          <p class="mb0">Please go to repository and resolve the conflicts before starting a new workflow</p>
+          <p class="mb0">Please go to the repository and resolve the conflicts before starting a new workflow.</p>
         </div>
       </div>
     </div>
     <div class="flex-shrink-0">
-      <a href="<%= human_accessible_repository_url(@project, @branch) %>#partial-pull-merging" class="btn btn-warning">Resolve conflicts ↗</a>
+      <a href="<%= human_accessible_repository_url(@project, @branch) %>" class="btn btn-link">Resolve conflicts ↗</a>
     </div>
   </div>
 </div>

front/lib/internal_api/organization.pb.ex

@@ -5,13 +5,15 @@ defmodule InternalApi.Organization.DescribeRequest do
   @type t :: %__MODULE__{
           org_id: String.t(),
           org_username: String.t(),
-          include_quotas: boolean
+          include_quotas: boolean,
+          soft_deleted: boolean
         }
-  defstruct [:org_id, :org_username, :include_quotas]
+  defstruct [:org_id, :org_username, :include_quotas, :soft_deleted]
 
   field(:org_id, 1, type: :string)
   field(:org_username, 2, type: :string)
   field(:include_quotas, 3, type: :bool)
+  field(:soft_deleted, 4, type: :bool)
 end
 
 defmodule InternalApi.Organization.DescribeResponse do
@@ -33,11 +35,13 @@ defmodule InternalApi.Organization.DescribeManyRequest do
   use Protobuf, syntax: :proto3
 
   @type t :: %__MODULE__{
-          org_ids: [String.t()]
+          org_ids: [String.t()],
+          soft_deleted: boolean
         }
-  defstruct [:org_ids]
+  defstruct [:org_ids, :soft_deleted]
 
   field(:org_ids, 1, repeated: true, type: :string)
+  field(:soft_deleted, 2, type: :bool)
 end
 
 defmodule InternalApi.Organization.DescribeManyResponse do
@@ -61,15 +65,17 @@ defmodule InternalApi.Organization.ListRequest do
           created_at_gt: Google.Protobuf.Timestamp.t(),
           order: integer,
           page_size: integer,
-          page_token: String.t()
+          page_token: String.t(),
+          soft_deleted: boolean
         }
-  defstruct [:user_id, :created_at_gt, :order, :page_size, :page_token]
+  defstruct [:user_id, :created_at_gt, :order, :page_size, :page_token, :soft_deleted]
 
   field(:user_id, 2, type: :string)
   field(:created_at_gt, 3, type: Google.Protobuf.Timestamp)
   field(:order, 4, type: InternalApi.Organization.ListRequest.Order, enum: true)
   field(:page_size, 5, type: :int32)
   field(:page_token, 6, type: :string)
+  field(:soft_deleted, 7, type: :bool)
 end
 
 defmodule InternalApi.Organization.ListRequest.Order do
@@ -512,6 +518,18 @@ defmodule InternalApi.Organization.DestroyRequest do
   field(:org_id, 1, type: :string)
 end
 
+defmodule InternalApi.Organization.RestoreRequest do
+  @moduledoc false
+  use Protobuf, syntax: :proto3
+
+  @type t :: %__MODULE__{
+          org_id: String.t()
+        }
+  defstruct [:org_id]
+
+  field(:org_id, 1, type: :string)
+end
+
 defmodule InternalApi.Organization.Organization do
   @moduledoc false
   use Protobuf, syntax: :proto3
@@ -962,6 +980,20 @@ defmodule InternalApi.Organization.OrganizationDailyUpdate do
   field(:timestamp, 11, type: Google.Protobuf.Timestamp)
 end
 
+defmodule InternalApi.Organization.OrganizationRestored do
+  @moduledoc false
+  use Protobuf, syntax: :proto3
+
+  @type t :: %__MODULE__{
+          org_id: String.t(),
+          timestamp: Google.Protobuf.Timestamp.t()
+        }
+  defstruct [:org_id, :timestamp]
+
+  field(:org_id, 1, type: :string)
+  field(:timestamp, 2, type: Google.Protobuf.Timestamp)
+end
+
 defmodule InternalApi.Organization.OrganizationService.Service do
   @moduledoc false
   use GRPC.Service, name: "InternalApi.Organization.OrganizationService"
@@ -1034,6 +1066,7 @@ defmodule InternalApi.Organization.OrganizationService.Service do
   )
 
   rpc(:Destroy, InternalApi.Organization.DestroyRequest, Google.Protobuf.Empty)
+  rpc(:Restore, InternalApi.Organization.RestoreRequest, Google.Protobuf.Empty)
 
   rpc(
     :RepositoryIntegrators,

front/lib/internal_api/repo_proxy.pb.ex

@@ -338,6 +338,22 @@ defmodule InternalApi.RepoProxy.CreateBlankResponse.Repo do
   field(:repository_id, 5, type: :string)
 end
 
+defmodule InternalApi.RepoProxy.PullRequestUnmergeable do
+  @moduledoc false
+  use Protobuf, syntax: :proto3
+
+  @type t :: %__MODULE__{
+          project_id: String.t(),
+          branch_name: String.t(),
+          timestamp: Google.Protobuf.Timestamp.t()
+        }
+  defstruct [:project_id, :branch_name, :timestamp]
+
+  field(:project_id, 1, type: :string)
+  field(:branch_name, 2, type: :string)
+  field(:timestamp, 3, type: Google.Protobuf.Timestamp)
+end
+
 defmodule InternalApi.RepoProxy.RepoProxyService.Service do
   @moduledoc false
   use GRPC.Service, name: "InternalApi.RepoProxy.RepoProxyService"

front/lib/internal_api/secrethub.pb.ex

@@ -673,7 +673,8 @@ defmodule InternalApi.Secrethub.GenerateOpenIDConnectTokenRequest do
           job_type: String.t(),
           git_pull_request_branch: String.t(),
           repo_slug: String.t(),
-          triggerer: String.t()
+          triggerer: String.t(),
+          project_name: String.t()
         }
   defstruct [
     :org_id,
@@ -694,7 +695,8 @@ defmodule InternalApi.Secrethub.GenerateOpenIDConnectTokenRequest do
     :job_type,
     :git_pull_request_branch,
     :repo_slug,
-    :triggerer
+    :triggerer,
+    :project_name
   ]
 
   field(:org_id, 1, type: :string)
@@ -716,6 +718,7 @@ defmodule InternalApi.Secrethub.GenerateOpenIDConnectTokenRequest do
   field(:git_pull_request_branch, 17, type: :string)
   field(:repo_slug, 18, type: :string)
   field(:triggerer, 19, type: :string)
+  field(:project_name, 20, type: :string)
 end
 
 defmodule InternalApi.Secrethub.GenerateOpenIDConnectTokenResponse do