-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract user deletion into a new service (#919)
* Extract user deletion into a new service Introduce a programming API for downstream developers that allows customizing what should happen when a user is deleted in Drupal. Co-authored-by: Dezső BICZÓ <[email protected]> * Leverage the new user removal handler API for cascade deleting team roles * Better naming for the new API and implementations --------- Co-authored-by: ferenc.csongradi <[email protected]>
- Loading branch information
1 parent
230b0c5
commit a7b3ef7
Showing
7 changed files
with
215 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
...gee_edge_teams/src/User/RemoveTeamRolesOfUserSynchronousPostUserDeleteActionPerformer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Copyright 2023 Google Inc. | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU General Public License | ||
| * version 2 as published by the Free Software Foundation. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program; if not, write to the Free Software | ||
| * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, | ||
| * MA 02110-1301, USA. | ||
| */ | ||
|
|
||
| namespace Drupal\apigee_edge_teams\User; | ||
|
|
||
| use Drupal\apigee_edge\User\PostUserDeleteActionPerformerInterface; | ||
| use Drupal\Core\Entity\EntityTypeManagerInterface; | ||
| use Drupal\Core\Utility\Error; | ||
| use Drupal\user\UserInterface; | ||
| use Psr\Log\LoggerInterface; | ||
| use Psr\Log\LogLevel; | ||
|
|
||
| /** | ||
| * Ensures team roles of the removed user also get deleted. | ||
| */ | ||
| final class RemoveTeamRolesOfUserSynchronousPostUserDeleteActionPerformer implements PostUserDeleteActionPerformerInterface { | ||
|
|
||
| /** | ||
| * Constructs a new object. | ||
| */ | ||
| public function __construct(private readonly PostUserDeleteActionPerformerInterface $decorated, private readonly EntityTypeManagerInterface $entityTypeManager, private readonly LoggerInterface $logger) {} | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function __invoke(UserInterface $user): void { | ||
| ($this->decorated)($user); | ||
|
|
||
| /** @var \Drupal\apigee_edge_teams\Entity\Storage\TeamMemberRoleStorageInterface $team_member_role_storage */ | ||
| $team_member_role_storage = $this->entityTypeManager->getStorage('team_member_role'); | ||
| // When a user gets deleted then its developer account also gets deleted | ||
| // from Apigee Edge which removes its (team) company memberships. | ||
| // We must delete this user's team roles from Drupal as well. | ||
| foreach ($team_member_role_storage->loadByDeveloper($user) as $team_member_roles_in_team) { | ||
| try { | ||
| $team_member_roles_in_team->delete(); | ||
| } | ||
| catch (\Exception $e) { | ||
| Error::logException($this->logger, $e, "Integrity check: Failed to remove %developer team member's roles in %team team when its Drupal user got deleted. Reason: @message", [ | ||
| '%developer' => $user->getEmail(), | ||
| '%team' => $team_member_roles_in_team->getTeam()->id(), | ||
| ], LogLevel::CRITICAL); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Copyright 2023 Google Inc. | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU General Public License | ||
| * version 2 as published by the Free Software Foundation. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program; if not, write to the Free Software | ||
| * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, | ||
| * MA 02110-1301, USA. | ||
| */ | ||
|
|
||
| namespace Drupal\apigee_edge\User; | ||
|
|
||
| use Drupal\user\UserInterface; | ||
|
|
||
| /** | ||
| * Contract for triggering Apigee specific reactions _after_ user removal. | ||
| * | ||
| * It is important to know that when implementations are called the user | ||
| * entity is already removed and the database transaction is closed, there | ||
| * is no way to roll that back. | ||
| */ | ||
| interface PostUserDeleteActionPerformerInterface { | ||
|
|
||
| /** | ||
| * React on user removal. | ||
| * | ||
| * @param \Drupal\user\UserInterface $user | ||
| * The deleted user. | ||
| * | ||
| * @see \hook_ENTITY_TYPE_delete() | ||
| */ | ||
| public function __invoke(UserInterface $user): void; | ||
|
|
||
| } |
96 changes: 96 additions & 0 deletions
96
src/User/RemoveRelatedDeveloperAccountSynchronousPostUserDeleteActionPerformer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Copyright 2023 Google Inc. | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU General Public License | ||
| * version 2 as published by the Free Software Foundation. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program; if not, write to the Free Software | ||
| * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, | ||
| * MA 02110-1301, USA. | ||
| */ | ||
|
|
||
| namespace Drupal\apigee_edge\User; | ||
|
|
||
| use Drupal\Core\Entity\EntityTypeManagerInterface; | ||
| use Drupal\Core\Utility\Error; | ||
| use Drupal\user\UserInterface; | ||
| use Psr\Log\LoggerInterface; | ||
|
|
||
| /** | ||
| * Handler that removes the related developer when a user is deleted. | ||
| * | ||
| * ATTENTION!!! Removing a developer from Apigee is a dangerous operation | ||
| * because it also destroys all API keys the developer pwns. If that is not | ||
| * an intended behavior, use the service decorator pattern to customize | ||
| * this process. | ||
| * | ||
| * @see \apigee_edge_user_delete() | ||
| */ | ||
| final class RemoveRelatedDeveloperAccountSynchronousPostUserDeleteActionPerformer implements PostUserDeleteActionPerformerInterface { | ||
|
|
||
| /** | ||
| * Entity type manager. | ||
| * | ||
| * @var \Drupal\Core\Entity\EntityTypeManagerInterface | ||
| */ | ||
| private EntityTypeManagerInterface $entityTypeManager; | ||
|
|
||
| /** | ||
| * The logger. | ||
| * | ||
| * @var \Psr\Log\LoggerInterface | ||
| */ | ||
| private LoggerInterface $logger; | ||
|
|
||
| /** | ||
| * Constructs a new object. | ||
| * | ||
| * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager | ||
| * Entity type manager. | ||
| * @param \Psr\Log\LoggerInterface $logger | ||
| * The logger. | ||
| */ | ||
| public function __construct(EntityTypeManagerInterface $entity_type_manager, LoggerInterface $logger) { | ||
| $this->entityTypeManager = $entity_type_manager; | ||
| $this->logger = $logger; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function __invoke(UserInterface $user): void { | ||
| // Do not try to delete developer of the anonymous user because it does | ||
| // not exist. | ||
| if ($user->isAnonymous()) { | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| /** @var \Drupal\apigee_edge\Entity\DeveloperInterface|null $developer */ | ||
| $developer = $this->entityTypeManager->getStorage('developer')->load($user->getEmail()); | ||
| // Sanity check, the developer may not exist in Apigee Edge. | ||
| if ($developer) { | ||
| $developer->delete(); | ||
| $this->logger->info('The @developer developer has been deleted as a reaction to removing its user account.', [ | ||
| '@developer' => $user->getEmail(), | ||
| ]); | ||
| } | ||
| } | ||
| catch (\Exception $exception) { | ||
| $context = [ | ||
| '@developer' => $user->getEmail(), | ||
| ]; | ||
| Error::logException($this->logger, $exception, 'The @developer developer could not be deleted as a reaction to removing its user account. @message %function (line %line of %file). <pre>@backtrace_string</pre>', $context); | ||
| } | ||
| } | ||
|
|
||
| } |