Merge branch 'next-14790/delete-integration-for-app-on-app-delete' into 'trunk'

NEXT-14790 - Delete integration for app when the app gets deleted

See merge request shopware/6/product/platform!5032

Author: keulinho

changelog/_unreleased/2021-04-14-delete-integration-for-app-on-app-delete.md

@@ -0,0 +1,6 @@
+---
+title: Delete integration for app when the app gets deleted
+issue: NEXT-14790
+---
+# Core
+* Changed `\Shopware\Core\Framework\App\Lifecycle\AppLifecycle::removeAppAndRole()` to additionally remove the integration of the app.

src/Core/Framework/App/Lifecycle/AppLifecycle.php

@@ -39,82 +39,40 @@
  */
 class AppLifecycle extends AbstractAppLifecycle
 {
-    /**
-     * @var EntityRepositoryInterface
-     */
-    private $appRepository;
+    private EntityRepositoryInterface $appRepository;
 
-    /**
-     * @var PermissionPersister
-     */
-    private $permissionPersister;
+    private PermissionPersister $permissionPersister;
 
-    /**
-     * @var CustomFieldPersister
-     */
-    private $customFieldPersister;
+    private CustomFieldPersister $customFieldPersister;
 
-    /**
-     * @var AbstractAppLoader
-     */
-    private $appLoader;
+    private AbstractAppLoader $appLoader;
 
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $eventDispatcher;
+    private EventDispatcherInterface $eventDispatcher;
 
-    /**
-     * @var AppRegistrationService
-     */
-    private $registrationService;
+    private AppRegistrationService $registrationService;
 
-    /**
-     * @var AppStateService
-     */
-    private $appStateService;
+    private AppStateService $appStateService;
 
-    /**
-     * @var ActionButtonPersister
-     */
-    private $actionButtonPersister;
+    private ActionButtonPersister $actionButtonPersister;
 
-    /**
-     * @var TemplatePersister
-     */
-    private $templatePersister;
+    private TemplatePersister $templatePersister;
 
-    /**
-     * @var WebhookPersister
-     */
-    private $webhookPersister;
+    private WebhookPersister $webhookPersister;
 
     /**
      * @internal (flag:FEATURE_NEXT_14357) make persister not nullable on removal
-     *
-     * @var PaymentMethodPersister|null
      */
-    private $paymentMethodPersister;
+    private ?PaymentMethodPersister $paymentMethodPersister;
 
-    /**
-     * @var EntityRepositoryInterface
-     */
-    private $languageRepository;
+    private EntityRepositoryInterface $languageRepository;
 
-    /*
-     * @var SystemConfigService
-     */
-    private $systemConfigService;
+    private SystemConfigService $systemConfigService;
 
-    /*
-     * @var ConfigValidator
-     */
-    private $configValidator;
+    private ConfigValidator $configValidator;
 
-    /**
-     * @var string
-     */
-    private $projectDir;
+    private string $projectDir;
+
+    private EntityRepositoryInterface $integrationRepository;
 
     public function __construct(
         EntityRepositoryInterface $appRepository,
@@ -131,6 +89,7 @@ public function __construct(
         EntityRepositoryInterface $languageRepository,
         SystemConfigService $systemConfigService,
         ConfigValidator $configValidator,
+        EntityRepositoryInterface $integrationRepository,
         string $projectDir
     ) {
         $this->appRepository = $appRepository;
@@ -148,6 +107,7 @@ public function __construct(
         $this->languageRepository = $languageRepository;
         $this->systemConfigService = $systemConfigService;
         $this->configValidator = $configValidator;
+        $this->integrationRepository = $integrationRepository;
     }
 
     public function getDecorated(): AbstractAppLifecycle
@@ -195,10 +155,10 @@ public function delete(string $appName, array $app, Context $context): void
         $appEntity = $this->loadApp($app['id'], $context);
 
         if ($appEntity->isActive()) {
-            $this->appStateService->deactivateApp($app['id'], $context);
+            $this->appStateService->deactivateApp($appEntity->getId(), $context);
         }
 
-        $this->removeAppAndRole($app['id'], $app['roleId'], $context);
+        $this->removeAppAndRole($appEntity, $context);
     }
 
     private function updateApp(
@@ -231,7 +191,7 @@ private function updateApp(
             try {
                 $this->registrationService->registerApp($manifest, $id, $secretAccessKey, $context);
             } catch (AppRegistrationException $e) {
-                $this->removeAppAndRole($id, $roleId, $context);
+                $this->removeAppAndRole($app, $context);
 
                 throw $e;
             }
@@ -280,17 +240,18 @@ private function updateApp(
         return $app;
     }
 
-    private function removeAppAndRole(string $appId, string $roleId, Context $context): void
+    private function removeAppAndRole(AppEntity $app, Context $context): void
     {
         // throw event before deleting app from db as it may be delivered via webhook to the deleted app
         $this->eventDispatcher->dispatch(
-            new AppDeletedEvent($appId, $context)
+            new AppDeletedEvent($app->getId(), $context)
         );
 
-        $context->scope(Context::SYSTEM_SCOPE, function (Context $context) use ($appId): void {
-            $this->appRepository->delete([['id' => $appId]], $context);
+        $context->scope(Context::SYSTEM_SCOPE, function (Context $context) use ($app): void {
+            $this->appRepository->delete([['id' => $app->getId()]], $context);
+            $this->integrationRepository->delete([['id' => $app->getIntegrationId()]], $context);
         });
-        $this->permissionPersister->removeRole($roleId);
+        $this->permissionPersister->removeRole($app->getAclRoleId());
     }
 
     private function updateMetadata(array $metadata, Context $context): void
@@ -309,6 +270,7 @@ private function enrichInstallMetadata(Manifest $manifest, array $metadata, stri
             'writeAccess' => true,
             'accessKey' => AccessKeyHelper::generateAccessKey('integration'),
             'secretAccessKey' => $secret,
+            'admin' => false,
         ];
         $metadata['aclRole'] = [
             'id' => $roleId,

src/Core/Framework/DependencyInjection/app.xml

@@ -172,6 +172,7 @@
             <argument type="service" id="language.repository"/>
             <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
             <argument type="service" id="Shopware\Core\Framework\App\Validation\ConfigValidator"/>
+            <argument type="service" id="integration.repository"/>
             <argument type="string">%kernel.project_dir%</argument>
         </service>
 

src/Core/Framework/Test/App/Lifecycle/AppLifecycleTest.php

@@ -102,8 +102,10 @@ public function testInstall(): void
 
         static::assertTrue($eventWasReceived);
         $this->eventDispatcher->removeListener(AppInstalledEvent::class, $onAppInstalled);
+        $criteria = new Criteria();
+        $criteria->addAssociation('integration');
         /** @var AppCollection $apps */
-        $apps = $this->appRepository->search(new Criteria(), $this->context)->getEntities();
+        $apps = $this->appRepository->search($criteria, $this->context)->getEntities();
 
         static::assertCount(1, $apps);
         static::assertEquals('test', $apps->first()->getName());
@@ -123,6 +125,7 @@ public function testInstall(): void
 
         static::assertEquals($appId, $apps->first()->getId());
         static::assertFalse($apps->first()->isConfigurable());
+        static::assertFalse($apps->first()->getIntegration()->getAdmin());
         $this->assertDefaultActionButtons();
         $this->assertDefaultModules($apps->first());
         $this->assertDefaultPrivileges($apps->first()->getAclRoleId());
@@ -776,6 +779,7 @@ public function testDelete(): void
     {
         $appId = Uuid::randomHex();
         $roleId = Uuid::randomHex();
+        $integrationId = Uuid::randomHex();
 
         $this->appRepository->create([[
             'id' => $appId,
@@ -794,6 +798,7 @@ public function testDelete(): void
                 ],
             ],
             'integration' => [
+                'id' => $integrationId,
                 'label' => 'test',
                 'writeAccess' => false,
                 'accessKey' => 'test',
@@ -829,6 +834,11 @@ public function testDelete(): void
         $roles = $aclRoleRepository->searchIds(new Criteria([$roleId]), $this->context)->getIds();
         static::assertCount(0, $roles);
 
+        /** @var EntityRepositoryInterface $integrationRepository */
+        $integrationRepository = $this->getContainer()->get('integration.repository');
+        $integrations = $integrationRepository->searchIds(new Criteria([$integrationId]), $this->context)->getIds();
+        static::assertCount(0, $integrations);
+
         $criteria = new Criteria();
         $criteria->addFilter(new EqualsFilter('appId', $appId));
         $apps = $this->actionButtonRepository->searchIds($criteria, $this->context)->getIds();