fix(projecthub): rename project when it is soft deleted (#247)

Author: forestileao

projecthub/lib/projecthub/models/project.ex

@@ -300,7 +300,12 @@ defmodule Projecthub.Models.Project do
   end
 
   def soft_destroy(project, user) do
-    {:ok, _} = update_record(project, %{deleted_at: DateTime.utc_now(), deleted_by: user.id})
+    current_datetime = DateTime.utc_now() |> DateTime.truncate(:second)
+
+    deleted_project_name = "#{project.name}-deleted-#{current_datetime |> DateTime.to_unix(:second)}"
+
+    {:ok, _} = update_record(project, %{name: deleted_project_name, deleted_at: current_datetime, deleted_by: user.id})
+
     {:ok, _} = Events.ProjectDeleted.publish(project, soft_delete: true)
 
     {:ok, nil}

projecthub/test/projecthub/api/grpc_server_test.exs

@@ -660,7 +660,8 @@ defmodule Projecthub.Api.GrpcServerTest do
       assert response.metadata.status ==
                InternalApi.Projecthub.ResponseMeta.Status.new(code: :OK)
 
-      assert response.project.metadata.name == project.name
+      cut_timestamp = create_cut_timestamp()
+      assert response.project.metadata.name =~ "#{project.name}-deleted-#{cut_timestamp}"
       assert response.project.metadata.id == project.id
       assert response.project.metadata.org_id == project.organization_id
       assert response.project.metadata.description == project.description
@@ -825,11 +826,12 @@ defmodule Projecthub.Api.GrpcServerTest do
 
     test "when a soft_deleted project is requested by name and soft_deleted param is true => returns the project" do
       {:ok, project} = Support.Factories.Project.create_with_repo()
-      {:ok, _} = Project.soft_destroy(project, %User{github_token: "token"})
+      {:ok, nil} = Project.soft_destroy(project, %User{github_token: "token"})
+      {:ok, soft_deleted_project} = Project.find(project.id, true)
 
       {:ok, _project_with_same_name} =
         Support.Factories.Project.create(%{
-          name: project.name
+          name: soft_deleted_project.name
         })
 
       {:ok, channel} =
@@ -848,11 +850,11 @@ defmodule Projecthub.Api.GrpcServerTest do
               api_version: "",
               kind: "",
               req_id: "",
-              org_id: project.organization_id,
+              org_id: soft_deleted_project.organization_id,
               user_id: Ecto.UUID.generate()
             ),
           id: "",
-          name: project.name,
+          name: soft_deleted_project.name,
           soft_deleted: true
         )
 
@@ -861,13 +863,15 @@ defmodule Projecthub.Api.GrpcServerTest do
       assert response.metadata.status ==
                InternalApi.Projecthub.ResponseMeta.Status.new(code: :OK)
 
-      assert response.project.metadata.name == project.name
-      assert response.project.metadata.id == project.id
-      assert response.project.metadata.org_id == project.organization_id
-      assert response.project.metadata.description == project.description
-      assert response.project.spec.repository.url == project.repository.url
-      assert response.project.spec.repository.name == project.repository.name
-      assert response.project.spec.repository.owner == project.repository.owner
+      cut_timestamp = create_cut_timestamp()
+      assert response.project.metadata.name == soft_deleted_project.name
+      assert response.project.metadata.name =~ "#{project.name}-deleted-#{cut_timestamp}"
+      assert response.project.metadata.id == soft_deleted_project.id
+      assert response.project.metadata.org_id == soft_deleted_project.organization_id
+      assert response.project.metadata.description == soft_deleted_project.description
+      assert response.project.spec.repository.url == soft_deleted_project.repository.url
+      assert response.project.spec.repository.name == soft_deleted_project.repository.name
+      assert response.project.spec.repository.owner == soft_deleted_project.repository.owner
     end
 
     test "when the project description is empty => returns the project" do
@@ -1182,9 +1186,11 @@ defmodule Projecthub.Api.GrpcServerTest do
 
       assert Enum.count(response.projects) == 2
 
+      cut_timestamp = create_cut_timestamp()
       names = Enum.map(response.projects, fn p -> p.metadata.name end)
-      assert Enum.member?(names, project1.name)
-      assert Enum.member?(names, project2.name)
+      assert Enum.any?(names, fn name -> name =~ "#{project1.name}-deleted-#{cut_timestamp}" end)
+      assert Enum.any?(names, fn name -> name =~ "#{project2.name}-deleted-#{cut_timestamp}" end)
+      assert Enum.all?(names, fn name -> name =~ "-deleted-#{cut_timestamp}" end)
     end
 
     test "when there are no projects => returns empty list" do
@@ -3179,4 +3185,10 @@ defmodule Projecthub.Api.GrpcServerTest do
       end
     end
   end
+
+  defp create_cut_timestamp do
+    DateTime.utc_now()
+    |> DateTime.to_unix(:second)
+    |> Integer.floor_div(1000)
+  end
 end

projecthub/test/projecthub/models/project_test.exs

@@ -551,6 +551,9 @@ defmodule Projecthub.Models.ProjectTest do
       soft_deleted_project = Project |> Repo.get(project.id)
       assert soft_deleted_project.deleted_at != nil
       assert soft_deleted_project.deleted_by == user.id
+
+      cut_timestamp = create_cut_timestamp()
+      assert soft_deleted_project.name =~ "#{project.name}-deleted-#{cut_timestamp}"
     end
   end
 
@@ -599,9 +602,10 @@ defmodule Projecthub.Models.ProjectTest do
       project = create_and_soft_destroy()
 
       {:ok, found_project} = Project.find(project.id, true)
-
+      cut_timestamp = create_cut_timestamp()
       assert found_project.id == project.id
       assert found_project.name == project.name
+      assert found_project.name =~ "-deleted-#{cut_timestamp}"
     end
   end
 
@@ -637,8 +641,11 @@ defmodule Projecthub.Models.ProjectTest do
 
       {:ok, found_project} = Project.find_by_name(project.name, project.organization_id, true)
 
+      cut_timestamp = create_cut_timestamp()
+
       assert found_project.id == project.id
       assert found_project.name == project.name
+      assert found_project.name =~ "-deleted-#{cut_timestamp}"
     end
   end
 
@@ -697,7 +704,9 @@ defmodule Projecthub.Models.ProjectTest do
 
       projects = Project.find_many(org_id, [project1.id, project2.id], true)
 
+      cut_timestamp = create_cut_timestamp()
       assert Enum.count(projects) == 2
+      assert Enum.all?(projects, fn project -> project.name =~ "-deleted-#{cut_timestamp}" end)
     end
   end
 
@@ -739,6 +748,7 @@ defmodule Projecthub.Models.ProjectTest do
     test "it returns a page of soft deleted projects" do
       org_id = Ecto.UUID.generate()
 
+      cut_timestamp = create_cut_timestamp()
       create_and_soft_destroy_many(org_id: org_id, quantity: 4)
 
       {:ok, _non_deleted_project} = Support.Factories.Project.create()
@@ -752,6 +762,7 @@ defmodule Projecthub.Models.ProjectTest do
 
       entries = page.entries
       assert Enum.count(entries) == 3
+      assert Enum.all?(entries, fn project -> project.name =~ "-deleted-#{cut_timestamp}" end)
     end
 
     test "it filter projects by owner_id" do
@@ -886,7 +897,13 @@ defmodule Projecthub.Models.ProjectTest do
     user = %User{id: Ecto.UUID.generate(), github_token: "token"}
 
     {:ok, _} = Project.soft_destroy(project, user)
-
+    {:ok, project} = Project.find(project.id, true)
     project
   end
+
+  defp create_cut_timestamp do
+    DateTime.utc_now()
+    |> DateTime.to_unix(:second)
+    |> Integer.floor_div(1000)
+  end
 end