Class: Users::DestroyService

Inherits:
Object
  • Object
show all
Defined in:
app/services/users/destroy_service.rb

Constant Summary collapse

DestroyError =
Class.new(StandardError)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(current_user) ⇒ DestroyService

Returns a new instance of DestroyService.


9
10
11
# File 'app/services/users/destroy_service.rb', line 9

def initialize(current_user)
  @current_user = current_user
end

Instance Attribute Details

#current_userObject

Returns the value of attribute current_user


7
8
9
# File 'app/services/users/destroy_service.rb', line 7

def current_user
  @current_user
end

Instance Method Details

#execute(user, options = {}) {|user| ... } ⇒ Object

Synchronously destroys user

The operation will fail if the user is the sole owner of any groups. To force the groups to be destroyed, pass `delete_solo_owned_groups: true` in options.

The user's contributions will be migrated to a global ghost user. To force the contributions to be destroyed, pass `hard_delete: true` in options.

`hard_delete: true` implies `delete_solo_owned_groups: true`. To perform a hard deletion without destroying solo-owned groups, pass `delete_solo_owned_groups: false, hard_delete: true` in options.

Yields:

  • (user)

Raises:


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'app/services/users/destroy_service.rb', line 26

def execute(user, options = {})
  delete_solo_owned_groups = options.fetch(:delete_solo_owned_groups, options[:hard_delete])

  unless Ability.allowed?(current_user, :destroy_user, user)
    raise Gitlab::Access::AccessDeniedError, "#{current_user} tried to destroy user #{user}!"
  end

  if !delete_solo_owned_groups && user.solo_owned_groups.present?
    user.errors[:base] << 'You must transfer ownership or delete groups before you can remove user'
    return user
  end

  # Calling all before/after_destroy hooks for the user because
  # there is no dependent: destroy in the relationship. And the removal
  # is done by a foreign_key. Otherwise they won't be called
  user.members.find_each { |member| member.run_callbacks(:destroy) }

  user.solo_owned_groups.each do |group|
    Groups::DestroyService.new(group, current_user).execute
  end

  namespace = user.namespace
  namespace.prepare_for_destroy

  user.personal_projects.each do |project|
    success = ::Projects::DestroyService.new(project, current_user).execute
    raise DestroyError, "Project #{project.id} can't be deleted" unless success
  end

  yield(user) if block_given?

  MigrateToGhostUserService.new(user).execute unless options[:hard_delete]

  response = Snippets::BulkDestroyService.new(current_user, user.snippets).execute(options)
  raise DestroyError, response.message if response.error?

  # Rails attempts to load all related records into memory before
  # destroying: https://github.com/rails/rails/issues/22510
  # This ensures we delete records in batches.
  user.destroy_dependent_associations_in_batches(exclude: [:snippets])

  # Destroy the namespace after destroying the user since certain methods may depend on the namespace existing
  user_data = user.destroy
  namespace.destroy

  user_data
end