feat(projecthub): create soft delete for projects (#209)

Author: forestileao

front/lib/front/layout/cache_invalidator.ex

@@ -36,7 +36,7 @@ defmodule Front.Layout.CacheInvalidator do
       {"organization_exchange", "suspension_removed", :suspension_removed},
       {"project_exchange", "created", :created_project},
       {"project_exchange", "updated", :updated_project},
-      {"project_exchange", "deleted", :deleted_project},
+      {"project_exchange", "soft_deleted", :deleted_project},
       {"user_exchange", "favorite_created", :starred},
       {"user_exchange", "favorite_deleted", :unstarred}
     ]

github_hooks/db/migrate/20250407112219_add_deleted_at_for_projects.rb

@@ -0,0 +1,6 @@
+class AddDeletedAtForProjects < ActiveRecord::Migration[5.1]
+  def change
+    add_column :projects, :deleted_at, :datetime, null: true, default: nil
+    add_column :projects, :deleted_by, :uuid, null: true, default: nil
+  end
+end

projecthub/lib/projecthub/api/grpc_server.ex

@@ -338,7 +338,7 @@ defmodule Projecthub.Api.GrpcServer do
       if user do
         case find_project(req) do
           {:ok, project} ->
-            {:ok, _} = Project.destroy(project, user)
+            {:ok, _} = Project.soft_destroy(project, user)
             DestroyResponse.new(metadata: status_ok(req))
 
           {:error, :not_found} ->

projecthub/lib/projecthub/events/project_deleted.ex

@@ -1,5 +1,8 @@
 defmodule Projecthub.Events.ProjectDeleted do
-  def publish(project) do
+  @soft_deleted_routing_key "soft_deleted"
+  @deleted_routing_key "deleted"
+
+  def publish(project, opts \\ []) do
     timestamp = DateTime.utc_now() |> DateTime.to_unix()
 
     event =
@@ -10,11 +13,12 @@ defmodule Projecthub.Events.ProjectDeleted do
       )
 
     message = InternalApi.Projecthub.ProjectDeleted.encode(event)
+    routing_key = if opts[:soft_delete], do: @soft_deleted_routing_key, else: @deleted_routing_key
 
     options = %{
       url: Application.fetch_env!(:projecthub, :amqp_url),
       exchange: "project_exchange",
-      routing_key: "deleted"
+      routing_key: routing_key
     }
 
     Tackle.publish(message, options)

projecthub/lib/projecthub/models/project.ex

@@ -66,6 +66,9 @@ defmodule Projecthub.Models.Project do
 
     field(:repository, :map, virtual: true)
     # embeds_one(:repository, Repository)
+
+    field(:deleted_at, :utc_datetime, default: nil)
+    field(:deleted_by, :binary_id, default: nil)
   end
 
   def create(request_id, user, org, project_spec, repo_details, integration_type, skip_onboarding \\ false) do
@@ -240,7 +243,9 @@ defmodule Projecthub.Models.Project do
       :attach_non_default_branch,
       :attach_pr,
       :attach_forked_pr,
-      :attach_tag
+      :attach_tag,
+      :deleted_at,
+      :deleted_by
     ])
     |> validate_required([:name, :organization_id, :creator_id])
     |> validate_format(:name, ~r/\A[\w\-\.]+\z/,
@@ -251,7 +256,7 @@ defmodule Projecthub.Models.Project do
 
   def find(id) do
     if id_is_uuid?(id) do
-      case Repo.get_by(Project, id: id) do
+      case from(Project) |> where([p], p.id == ^id) |> where_undeleted() |> Repo.one() do
         nil -> {:error, :not_found}
         project -> {:ok, project}
       end
@@ -263,7 +268,10 @@ defmodule Projecthub.Models.Project do
 
   def find_in_org(org_id, id) do
     if id_is_uuid?(id) and id_is_uuid?(org_id) do
-      case Repo.get_by(__MODULE__, id: id, organization_id: org_id) do
+      case from(Project)
+           |> where_undeleted()
+           |> where([p], p.id == ^id and p.organization_id == ^org_id)
+           |> Repo.one() do
         nil -> {:error, :not_found}
         project -> {:ok, project}
       end
@@ -281,14 +289,24 @@ defmodule Projecthub.Models.Project do
   end
 
   def find_by_name(name, org_id) do
-    case Repo.get_by(Project, name: name, organization_id: org_id) do
+    case from(Project)
+         |> where_undeleted()
+         |> where([p], p.name == ^name and p.organization_id == ^org_id)
+         |> Repo.one() do
       nil -> {:error, :not_found}
       project -> {:ok, project}
     end
     |> unwrap(&preload_repository/1)
   end
 
-  def destroy(project, user) do
+  def soft_destroy(project, user) do
+    {:ok, _} = update_record(project, %{deleted_at: DateTime.utc_now(), deleted_by: user.id})
+    {:ok, _} = Events.ProjectDeleted.publish(project, soft_delete: true)
+
+    {:ok, nil}
+  end
+
+  def hard_destroy(project, user) do
     {:ok, repository} = Repository.find_for_project(project.id)
     {:ok, _} = Repository.destroy(repository)
 
@@ -306,13 +324,15 @@ defmodule Projecthub.Models.Project do
     Project
     |> where([p], p.organization_id == ^org_id)
     |> where([p], p.id in ^ids)
+    |> where_undeleted()
     |> Repo.all()
     |> preload_repositories()
   end
 
   def count_in_org(org_id) do
     Project
     |> where([p], p.organization_id == ^org_id)
+    |> where_undeleted()
     |> Repo.aggregate(:count, :id)
   end
 
@@ -334,6 +354,7 @@ defmodule Projecthub.Models.Project do
 
     Project
     |> filter_by(options)
+    |> where_undeleted()
     |> Repo.paginate(page: page, page_size: page_size)
     |> case do
       %{entries: entries} = paged_result ->
@@ -365,6 +386,7 @@ defmodule Projecthub.Models.Project do
 
     Project
     |> filter_by(options)
+    |> where_undeleted()
     |> order_by([p], asc: p.organization_id, asc: p.name)
     |> Repo.cursor_paginate(
       cursor_fields: [:organization_id, :name],
@@ -486,4 +508,9 @@ defmodule Projecthub.Models.Project do
       Projecthub.Workers.ProjectInit.lock_and_process(project_id)
     end)
   end
+
+  defp where_undeleted(query) do
+    query
+    |> where([project], is_nil(project.deleted_at))
+  end
 end

projecthub/priv/repo/migrations/20250407200300_add_deleted_at_for_projects.exs

@@ -0,0 +1,10 @@
+defmodule Projecthub.Repo.Migrations.AddDeletedAtForProjects do
+  use Ecto.Migration
+
+  def change do
+    alter table("projects") do
+      add :deleted_at, :utc_datetime, null: true, default: nil
+      add :deleted_by, :binary_id, null: true, default: nil
+    end
+  end
+end

projecthub/test/projecthub/api/grpc_server_test.exs

@@ -2598,10 +2598,10 @@ defmodule Projecthub.Api.GrpcServerTest do
           name: ""
         )
 
-      with_mock Project, [:passthrough], destroy: fn _p, _u -> {:ok, nil} end do
+      with_mock Project, [:passthrough], soft_destroy: fn _p, _u -> {:ok, nil} end do
         {:ok, response} = Stub.destroy(channel, request)
 
-        assert_called(Project.destroy(:_, :_))
+        assert_called(Project.soft_destroy(:_, :_))
 
         assert response.metadata.status.code ==
                  :OK
@@ -2644,10 +2644,10 @@ defmodule Projecthub.Api.GrpcServerTest do
           name: project.name
         )
 
-      with_mock Project, [:passthrough], destroy: fn _p, _u -> {:ok, nil} end do
+      with_mock Project, [:passthrough], soft_destroy: fn _p, _u -> {:ok, nil} end do
         {:ok, response} = Stub.destroy(channel, request)
 
-        assert_called(Project.destroy(:_, :_))
+        assert_called(Project.soft_destroy(:_, :_))
 
         assert response.metadata.status.code ==
                  :OK

projecthub/test/projecthub/models/project_test.exs

@@ -512,7 +512,7 @@ defmodule Projecthub.Models.ProjectTest do
     end
   end
 
-  describe ".destroy" do
+  describe ".hard_destroy" do
     test "destroys repo, deploy key, schedulers and project records, removes key and hook from github, destroys artifact" do
       {:ok, project} = Support.Factories.Project.create_with_repo()
 
@@ -524,7 +524,7 @@ defmodule Projecthub.Models.ProjectTest do
         {Schedulers, [], [delete_all: fn _p, _r -> {:ok, nil} end]},
         {Projecthub.Artifact, [], [destroy: fn _, _ -> nil end]}
       ]) do
-        {:ok, _} = Project.destroy(project, user)
+        {:ok, _} = Project.hard_destroy(project, user)
         assert_called(Schedulers.delete_all(project, user.id))
         assert_called(Events.ProjectDeleted.publish(project))
         assert_called(Projecthub.Artifact.destroy(project.artifact_store_id, project.id))
@@ -536,6 +536,24 @@ defmodule Projecthub.Models.ProjectTest do
     end
   end
 
+  describe ".soft_destroy" do
+    test "soft deletes the project updating deleted_at and deleted_by" do
+      {:ok, project} = Support.Factories.Project.create_with_repo()
+
+      user = %User{github_token: "token"}
+
+      {:ok, _} = Project.soft_destroy(project, user)
+
+      # Assert project is not found by default find function
+      assert {:error, :not_found} = Project.find(project.id)
+
+      # Assert soft deleted project
+      soft_deleted_project = Project |> Repo.get(project.id)
+      assert soft_deleted_project.deleted_at != nil
+      assert soft_deleted_project.deleted_by == user.id
+    end
+  end
+
   describe ".find" do
     test "when the project exists => returns the project" do
       {:ok, project} = Support.Factories.Project.create()