Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#65068] Add deleted status to user.

Pavel Balashou13239270954a
diff --git a/app/components/shares/user_details_component.html.erb b/app/components/shares/user_details_component.html.erb
index bc829adc120..c0e217d4db6 100644
--- a/app/components/shares/user_details_component.html.erb
+++ b/app/components/shares/user_details_component.html.erb
@@ -8,7 +8,7 @@ component_wrapper do
flex.with_row(classes: "ellipsis") do
if strategy.manageable?
if user_in_non_active_status?
- if user.locked?
+ if user.locked? || user.deleted?
concat(render(Primer::Beta::Octicon.new(icon: :lock, color: :muted, mr: 1)))
concat(render(Primer::Beta::Text.new(color: :subtle)) { I18n.t("sharing.user_details.locked") })
elsif user.invited?
diff --git a/app/components/shares/user_details_component.rb b/app/components/shares/user_details_component.rb
index 8ed9924d414..fd3100ef5af 100644
--- a/app/components/shares/user_details_component.rb
+++ b/app/components/shares/user_details_component.rb
@@ -68,7 +68,7 @@ module Shares
end
def user_in_non_active_status?
- user.locked? || user.invited?
+ user.locked? || user.invited? || user.deleted?
end
end
end
diff --git a/app/contracts/members/create_contract.rb b/app/contracts/members/create_contract.rb
index 6c8390c536b..407cbc0328e 100644
--- a/app/contracts/members/create_contract.rb
+++ b/app/contracts/members/create_contract.rb
@@ -47,7 +47,7 @@ module Members
def principal_assignable
return if principal.nil?
- if principal.builtin? || principal.locked?
+ if principal.builtin? || principal.locked? || principal.deleted?
errors.add(:principal, :unassignable)
end
end
diff --git a/app/contracts/shares/create_contract.rb b/app/contracts/shares/create_contract.rb
index c323c429c70..36097fba9c7 100644
--- a/app/contracts/shares/create_contract.rb
+++ b/app/contracts/shares/create_contract.rb
@@ -42,7 +42,7 @@ module Shares
def principal_assignable
return if principal.nil?
- if principal.builtin? || principal.locked?
+ if principal.builtin? || principal.locked? || principal.deleted?
errors.add(:principal, :unassignable)
end
end
diff --git a/app/contracts/users/update_contract.rb b/app/contracts/users/update_contract.rb
index 48ca485ffb0..98ae032c688 100644
--- a/app/contracts/users/update_contract.rb
+++ b/app/contracts/users/update_contract.rb
@@ -53,7 +53,7 @@ module Users
def at_least_one_admin_is_active
return unless
(model.admin_changed? && !model.admin?) ||
- (model.admin? && model.status_changed? && model.locked?)
+ (model.admin? && model.status_changed? && (model.locked? || model.deleted?))
if User.active.admin.where.not(id: model).none?
errors.add :base, :one_must_be_active
diff --git a/app/controllers/scim_v2/groups_controller.rb b/app/controllers/scim_v2/groups_controller.rb
index 5224d3d85d8..f2f9fa8e491 100644
--- a/app/controllers/scim_v2/groups_controller.rb
+++ b/app/controllers/scim_v2/groups_controller.rb
@@ -122,6 +122,7 @@ module ScimV2
.left_joins(:users, :user_auth_provider_links)
.includes(:users, :user_auth_provider_links)
.not_builtin
+ .where.not(status: Group.statuses[:deleted])
end
private
diff --git a/app/controllers/scim_v2/users_controller.rb b/app/controllers/scim_v2/users_controller.rb
index 90eaa881760..11ea4a11351 100644
--- a/app/controllers/scim_v2/users_controller.rb
+++ b/app/controllers/scim_v2/users_controller.rb
@@ -107,6 +107,7 @@ module ScimV2
.left_joins(:groups, :user_auth_provider_links)
.includes(:groups, :user_auth_provider_links)
.not_builtin
+ .where.not(status: User.statuses[:deleted])
end
end
end
diff --git a/app/controllers/shares_controller.rb b/app/controllers/shares_controller.rb
index 03009bdf39a..df7a6073c05 100644
--- a/app/controllers/shares_controller.rb
+++ b/app/controllers/shares_controller.rb
@@ -58,7 +58,7 @@ class SharesController < ApplicationController
find_or_create_users(send_notification: send_notification?) do |member_params|
user = User.find_by(id: member_params[:user_id])
- if user.present? && user.locked?
+ if user.present? && (user.locked? || user.deleted?)
@errors.add(:base, I18n.t("sharing.warning_locked_user", user: user.name))
else
service_call = create_or_update_share(member_params[:user_id], [params[:member][:role_id]])
diff --git a/app/mailers/application_mailer.rb b/app/mailers/application_mailer.rb
index 09b057c10fa..3fb09b3a9a6 100644
--- a/app/mailers/application_mailer.rb
+++ b/app/mailers/application_mailer.rb
@@ -128,7 +128,7 @@ class ApplicationMailer < ActionMailer::Base
if to
raise ArgumentError, "Recipient needs to be instance of User" unless to.is_a?(User)
- if to.locked?
+ if to.locked? || to.deleted?
Rails.logger.info "Not sending #{action_name} mail to locked user #{to.id} (#{to.login})"
return
end
diff --git a/app/models/principal.rb b/app/models/principal.rb
index 88dce60da38..415c4f1ae55 100644
--- a/app/models/principal.rb
+++ b/app/models/principal.rb
@@ -37,7 +37,8 @@ class Principal < ApplicationRecord
active: 1,
registered: 2,
locked: 3,
- invited: 4
+ invited: 4,
+ deleted: 5
}, scopes: false
self.table_name = "#{table_name_prefix}users#{table_name_suffix}"
diff --git a/app/models/project_queries/scopes/allowed_to.rb b/app/models/project_queries/scopes/allowed_to.rb
index 027a6e233ab..5654936fbdf 100644
--- a/app/models/project_queries/scopes/allowed_to.rb
+++ b/app/models/project_queries/scopes/allowed_to.rb
@@ -39,7 +39,7 @@ module ProjectQueries::Scopes
def allowed_to(user, permission)
permissions = Authorization.contextual_permissions(permission, :project_query, raise_on_unknown: true).map(&:name)
- return none if user.locked?
+ return none if user.locked? || user.deleted?
return none if permissions.empty?
if user.anonymous?
diff --git a/app/models/projects/scopes/allowed_to.rb b/app/models/projects/scopes/allowed_to.rb
index 17a86bee8cb..98103fcf49c 100644
--- a/app/models/projects/scopes/allowed_to.rb
+++ b/app/models/projects/scopes/allowed_to.rb
@@ -38,7 +38,7 @@ module Projects::Scopes
def allowed_to(user, permission)
permissions = allowed_to_permissions(permission)
- return none if user.locked?
+ return none if user.locked? || user.deleted?
return none if permissions.empty?
if user.admin? && permissions.all?(&:grant_to_admin?)
diff --git a/app/models/watcher.rb b/app/models/watcher.rb
index 58e81aae465..17f7960e0de 100644
--- a/app/models/watcher.rb
+++ b/app/models/watcher.rb
@@ -51,14 +51,14 @@ class Watcher < ApplicationRecord
def validate_active_user
return if user.blank?
- errors.add :user_id, :locked if user.locked?
+ errors.add :user_id, :locked if user.locked? || user.deleted?
end
def validate_user_allowed_to_watch
return if user.blank? || watchable.blank?
# No need to add a missing permission error on top of the user locked error
# created by validate_active_user.
- return if user.locked?
+ return if user.locked? || user.deleted?
errors.add :user_id, :not_allowed_to_view unless watchable.possible_watcher?(user)
end
diff --git a/app/models/work_packages/scopes/allowed_to.rb b/app/models/work_packages/scopes/allowed_to.rb
index 1d64092d477..925b8d62cf7 100644
--- a/app/models/work_packages/scopes/allowed_to.rb
+++ b/app/models/work_packages/scopes/allowed_to.rb
@@ -39,7 +39,7 @@ module WorkPackages::Scopes
def allowed_to(user, permission) # rubocop:disable Metrics/PerceivedComplexity
permissions = Authorization.contextual_permissions(permission, :work_package, raise_on_unknown: true)
- return none if user.locked?
+ return none if user.locked? || user.deleted?
return none if permissions.empty?
if user.admin? && permissions.all?(&:grant_to_admin?)
diff --git a/app/services/authorization/user_permissible_service.rb b/app/services/authorization/user_permissible_service.rb
index 83ce82cbc38..2099903aef3 100644
--- a/app/services/authorization/user_permissible_service.rb
+++ b/app/services/authorization/user_permissible_service.rb
@@ -168,7 +168,7 @@ module Authorization
end
def authorizable_user?
- !user.locked? || user.is_a?(SystemUser)
+ !(user.locked? || user.deleted?) || user.is_a?(SystemUser)
end
def permissions_by_enabled_project_modules(project, permissions)
diff --git a/app/services/groups/delete_service.rb b/app/services/groups/delete_service.rb
index 4e9fe54fd38..0c07a058b46 100644
--- a/app/services/groups/delete_service.rb
+++ b/app/services/groups/delete_service.rb
@@ -32,7 +32,7 @@ class Groups::DeleteService < BaseServices::Delete
protected
def destroy(group)
- group.update_column(:status, Group.statuses[:locked])
+ group.update_column(:status, Group.statuses[:deleted])
::Principals::DeleteJob.perform_later(group)
true
end
diff --git a/app/services/placeholder_users/delete_service.rb b/app/services/placeholder_users/delete_service.rb
index 6971ebc3b62..8b24fa29920 100644
--- a/app/services/placeholder_users/delete_service.rb
+++ b/app/services/placeholder_users/delete_service.rb
@@ -30,7 +30,7 @@
class PlaceholderUsers::DeleteService < BaseServices::Delete
def destroy(placeholder)
- placeholder.locked!
+ placeholder.update_column(:status, PlaceholderUser.statuses[:deleted])
::Principals::DeleteJob.perform_later(placeholder)
true
diff --git a/app/services/users/delete_service.rb b/app/services/users/delete_service.rb
index 342bb0c47dc..5c07e5c11ba 100644
--- a/app/services/users/delete_service.rb
+++ b/app/services/users/delete_service.rb
@@ -38,9 +38,9 @@ module Users
# @return True if the user deletion has been initiated, false otherwise.
def destroy(user_object)
# as destroying users is a lengthy process we handle it in the background
- # and lock the account now so that no action can be performed with it
- # don't use "locked!" handle as it will raise on invalid users
- user_object.update_column(:status, User.statuses[:locked])
+ # and mark the account as deleted now so that no action can be performed with it
+ # don't use "deleted!" handle as it will raise on invalid users
+ user_object.update_column(:status, User.statuses[:deleted])
::Principals::DeleteJob.perform_later(user_object)
logout! if self_delete?
diff --git a/config/locales/en.yml b/config/locales/en.yml
index 4dddc9322f5..08444645815 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -4428,6 +4428,7 @@ en:
status_invited: invited
status_locked: locked
status_registered: registered
+ status_deleted: deleted
# Used in array.to_sentence.
support:
diff --git a/lib/api/v3/users/user_representer.rb b/lib/api/v3/users/user_representer.rb
index d76b3f80a90..de21532e09b 100644
--- a/lib/api/v3/users/user_representer.rb
+++ b/lib/api/v3/users/user_representer.rb
@@ -47,7 +47,7 @@ module API
self_link
link :showUser do
- next if represented.new_record? || represented.locked?
+ next if represented.new_record? || represented.locked? || represented.deleted?
{
href: api_v3_paths.show_user(represented.id),
diff --git a/lib/api/v3/users/users_api.rb b/lib/api/v3/users/users_api.rb
index 341479264e9..1af0d31ad6c 100644
--- a/lib/api/v3/users/users_api.rb
+++ b/lib/api/v3/users/users_api.rb
@@ -97,14 +97,14 @@ module API
desc "Set lock on user account"
post do
- user_transition(@user.active? || @user.locked?) do
+ user_transition(@user.active? || @user.locked? || @user.deleted?) do
@user.lock! unless @user.locked?
end
end
desc "Remove lock on user account"
delete do
- user_transition(@user.locked? || @user.active?) do
+ user_transition(@user.locked? || @user.active? || @user.deleted?) do
@user.activate! unless @user.active?
end
end
diff --git a/lib/open_project/object_linking.rb b/lib/open_project/object_linking.rb
index c0f8a137e01..74ca76027b5 100644
--- a/lib/open_project/object_linking.rb
+++ b/lib/open_project/object_linking.rb
@@ -45,7 +45,7 @@ module OpenProject
# Will attach a user hover card to the link.
def link_to_user(user, options = {}) # rubocop:disable Metrics/AbcSize
return h(user.to_s) unless user.is_a?(User)
- return h(user.name) if user.locked? && !User.current.admin?
+ return h(user.name) if (user.locked? || user.deleted?) && !User.current.admin?
only_path = options.delete(:only_path) { true }
name = options.delete(:name) { user.name }
diff --git a/spec/factories/group_factory.rb b/spec/factories/group_factory.rb
index 2f97e9b9bc3..881464df3e2 100644
--- a/spec/factories/group_factory.rb
+++ b/spec/factories/group_factory.rb
@@ -48,5 +48,10 @@ FactoryBot.define do
.on_failure { |call| raise call.message }
end
end
+
+ factory :group_marked_for_deletion do
+ lastname { "DeletedGroup" }
+ status { Group.statuses[:deleted] }
+ end
end
end
diff --git a/spec/factories/user_factory.rb b/spec/factories/user_factory.rb
index c61b02ff9ce..70f1405ddf0 100644
--- a/spec/factories/user_factory.rb
+++ b/spec/factories/user_factory.rb
@@ -100,6 +100,16 @@ FactoryBot.define do
status { User.statuses[:locked] }
end
+ factory :user_marked_for_deletion do
+ firstname { "Deleted" }
+ lastname { "User" }
+ sequence(:login) { |n| "deleted#{n}" }
+ sequence(:mail) { |n| "deleted#{n}@bob.com" }
+ password { "adminADMIN!" }
+ password_confirmation { "adminADMIN!" }
+ status { User.statuses[:deleted] }
+ end
+
factory :invited_user do
status { User.statuses[:invited] }
end
diff --git a/spec/requests/api/v3/placeholder_users/delete_resource_examples.rb b/spec/requests/api/v3/placeholder_users/delete_resource_examples.rb
index 58c718276f5..a412efae452 100644
--- a/spec/requests/api/v3/placeholder_users/delete_resource_examples.rb
+++ b/spec/requests/api/v3/placeholder_users/delete_resource_examples.rb
@@ -32,12 +32,9 @@ RSpec.shared_examples "deletion allowed" do
expect(last_response).to have_http_status :accepted
end
- it "locks the account and mark for deletion" do
- expect(Principals::DeleteJob)
- .to have_been_enqueued
- .with(placeholder)
-
- expect(placeholder.reload).to be_locked
+ it "marks user as deleted and enqueues a deletion job" do
+ expect(Principals::DeleteJob).to have_been_enqueued.with(placeholder)
+ expect(placeholder.reload).to be_deleted
end
context "with a non-existent user" do
diff --git a/spec/requests/api/v3/placeholder_users/delete_resource_spec.rb b/spec/requests/api/v3/placeholder_users/delete_resource_spec.rb
index 4d780144dcb..cbe0f0e7466 100644
--- a/spec/requests/api/v3/placeholder_users/delete_resource_spec.rb
+++ b/spec/requests/api/v3/placeholder_users/delete_resource_spec.rb
@@ -30,8 +30,7 @@
require "spec_helper"
require_relative "delete_resource_examples"
-RSpec.describe API::V3::PlaceholderUsers::PlaceholderUsersAPI,
- "delete" do
+RSpec.describe API::V3::PlaceholderUsers::PlaceholderUsersAPI, "delete" do
include API::V3::Utilities::PathHelper
shared_let(:placeholder) { create(:placeholder_user, name: "foo") }
diff --git a/spec/requests/api/v3/user/user_resource_spec.rb b/spec/requests/api/v3/user/user_resource_spec.rb
index 9120306663d..7796667a163 100644
--- a/spec/requests/api/v3/user/user_resource_spec.rb
+++ b/spec/requests/api/v3/user/user_resource_spec.rb
@@ -31,8 +31,7 @@
require "spec_helper"
require "rack/test"
-RSpec.describe "API v3 User resource",
- content_type: :json do
+RSpec.describe "API v3 User resource", content_type: :json do
include Rack::Test::Methods
include API::V3::Utilities::PathHelper
@@ -274,12 +273,9 @@ RSpec.describe "API v3 User resource",
expect(subject.status).to eq 202
end
- it "locks the account and mark for deletion" do
- expect(Principals::DeleteJob)
- .to have_been_enqueued
- .with(user)
-
- expect(user).to be_locked
+ it "marks user as deleted and enqueues a deletion job" do
+ expect(Principals::DeleteJob).to have_been_enqueued.with(user)
+ expect(user).to be_deleted
end
context "with a non-existent user" do
diff --git a/spec/requests/scim_v2/groups_spec.rb b/spec/requests/scim_v2/groups_spec.rb
index cead0ee0df9..dadcceddfb5 100644
--- a/spec/requests/scim_v2/groups_spec.rb
+++ b/spec/requests/scim_v2/groups_spec.rb
@@ -57,7 +57,9 @@ RSpec.describe "SCIM API Groups", with_ee: [:scim_api] do
context "with the feature flag enabled", with_flag: { scim_api: true } do
before { group }
- it "responds with group list" do
+ it "responds with a list of groups excluding marked for deletion" do
+ create(:group_marked_for_deletion)
+
get "/scim_v2/Groups", {}, headers
response_body = JSON.parse(last_response.body)
@@ -255,22 +257,20 @@ RSpec.describe "SCIM API Groups", with_ee: [:scim_api] do
get "/scim_v2/Groups/#{group.id}", "", headers
+ expect(last_response).to have_http_status(404)
response_body = JSON.parse(last_response.body)
- expect(response_body).to eq("displayName" => group.name,
- "externalId" => external_group_id,
- "id" => group.id.to_s,
- "members" => [{ "value" => user.id.to_s }],
- "meta" => { "location" => "http://test.host/scim_v2/Groups/#{group.id}",
- "created" => group.created_at.iso8601,
- "lastModified" => group.updated_at.iso8601,
- "resourceType" => "Group" },
- "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"])
+ expect(response_body).to eq(
+ "detail" => "Resource \"#{group.id}\" not found",
+ "schemas" => ["urn:ietf:params:scim:api:messages:2.0:Error"],
+ "status" => "404"
+ )
perform_enqueued_jobs
assert_performed_jobs 1
get "/scim_v2/Groups/#{group.id}", "", headers
+ expect(last_response).to have_http_status(404)
response_body = JSON.parse(last_response.body)
expect(response_body).to eq(
"detail" => "Resource \"#{group.id}\" not found",
diff --git a/spec/requests/scim_v2/users_spec.rb b/spec/requests/scim_v2/users_spec.rb
index 10d9b0096dd..558bf341231 100644
--- a/spec/requests/scim_v2/users_spec.rb
+++ b/spec/requests/scim_v2/users_spec.rb
@@ -53,10 +53,17 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
group
end
- it "responds with users list" do
+ it "responds with users list including locked(not_active users) and excluding users marked for deletion" do
+ user_marked_for_deletion = create(:user_marked_for_deletion)
+ locked_user = create(:locked_user)
+
get "/scim_v2/Users", {}, headers
response_body = JSON.parse(last_response.body)
+ ids = response_body["Resources"].map { |item| item["id"] }
+ expect(ids).to include(locked_user.id.to_s)
+ expect(response_body["Resources"].find { |resource| resource["id"] == locked_user.id.to_s }["active"]).to eq(false)
+ expect(ids).not_to include(user_marked_for_deletion.id.to_s)
expect(response_body).to match("Resources" => include({ "active" => true,
"emails" => [{ "primary" => true,
"type" => "work",
@@ -90,7 +97,7 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
"itemsPerPage" => 100,
"schemas" => ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"startIndex" => 1,
- "totalResults" => 4)
+ "totalResults" => 5)
end
it "filters results by familyName case-insensitively" do
@@ -464,28 +471,20 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
get "/scim_v2/Users/#{user.id}", "", headers
+ expect(last_response).to have_http_status(404)
response_body = JSON.parse(last_response.body)
- expect(response_body).to eq("active" => false,
- "emails" => [{ "primary" => true,
- "type" => "work",
- "value" => user.mail }],
- "externalId" => external_user_id,
- "groups" => [{ "value" => group.id.to_s }],
- "id" => user.id.to_s,
- "meta" => { "created" => user.created_at.iso8601,
- "lastModified" => user.updated_at.iso8601,
- "location" => "http://test.host/scim_v2/Users/#{user.id}",
- "resourceType" => "User" },
- "name" => { "familyName" => user.lastname,
- "givenName" => user.firstname },
- "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:User"],
- "userName" => user.login)
+ expect(response_body).to eq(
+ "detail" => "Resource \"#{user.id}\" not found",
+ "schemas" => ["urn:ietf:params:scim:api:messages:2.0:Error"],
+ "status" => "404"
+ )
perform_enqueued_jobs
assert_performed_jobs 1
get "/scim_v2/Users/#{user.id}", "", headers
+ expect(last_response).to have_http_status(404)
response_body = JSON.parse(last_response.body)
expect(response_body).to eq(
"detail" => "Resource \"#{user.id}\" not found",
diff --git a/spec/services/placeholder_users/delete_service_spec.rb b/spec/services/placeholder_users/delete_service_spec.rb
index e218d20f587..22e0085c304 100644
--- a/spec/services/placeholder_users/delete_service_spec.rb
+++ b/spec/services/placeholder_users/delete_service_spec.rb
@@ -40,7 +40,7 @@ RSpec.describe PlaceholderUsers::DeleteService, type: :model do
shared_examples "deletes the user" do
it do
- expect(placeholder_user).to receive(:locked!)
+ expect(placeholder_user).to receive(:update_column).with(:status, 5)
expect(Principals::DeleteJob).to receive(:perform_later).with(placeholder_user)
expect(subject).to be_success
end
@@ -48,7 +48,7 @@ RSpec.describe PlaceholderUsers::DeleteService, type: :model do
shared_examples "does not delete the user" do
it do
- expect(placeholder_user).not_to receive(:locked!)
+ expect(placeholder_user).not_to receive(:update_column).with(:status, 5)
expect(Principals::DeleteJob).not_to receive(:perform_later)
expect(subject).not_to be_success
end
diff --git a/spec/services/users/delete_service_spec.rb b/spec/services/users/delete_service_spec.rb
index 2b566cdd2d4..2cf1ffbdaa7 100644
--- a/spec/services/users/delete_service_spec.rb
+++ b/spec/services/users/delete_service_spec.rb
@@ -40,19 +40,19 @@ RSpec.describe Users::DeleteService, type: :model do
shared_examples "deletes the user" do
it do
- allow(input_user).to receive(:update_column).with(:status, 3)
+ allow(input_user).to receive(:update_column).with(:status, 5)
expect(Principals::DeleteJob).to receive(:perform_later).with(input_user)
expect(subject).to be_success
- expect(input_user).to have_received(:update_column).with(:status, 3)
+ expect(input_user).to have_received(:update_column).with(:status, 5)
end
end
shared_examples "does not delete the user" do
it do
- allow(input_user).to receive(:update_column).with(:status, 3)
+ allow(input_user).to receive(:update_column).with(:status, 5)
expect(Principals::DeleteJob).not_to receive(:perform_later)
expect(subject).not_to be_success
- expect(input_user).not_to have_received(:update_column).with(:status, 3)
+ expect(input_user).not_to have_received(:update_column).with(:status, 5)
end
end