magento/adobe-stock-integration#1391: SaveAssetsKeywordsInterface to delete obsolete keywords - Code enhancement for SavedAssetLinks logic and updated AssetKeywordsTest

Author: jmonteros422

app/code/Magento/MediaGallery/Model/ResourceModel/Keyword/SaveAssetLinks.php

@@ -33,24 +33,24 @@ class SaveAssetLinks
     /**
      * @var GetAssetsKeywordsInterface
      */
-    private $getAssetsKeywordsInterface;
+    private $getAssetsKeywords;
 
     /**
      * @var LoggerInterface
      */
     private $logger;
 
     /**
-     * @param GetAssetsKeywordsInterface $getAssetsKeywordsInterface
+     * @param GetAssetsKeywordsInterface $getAssetsKeywords
      * @param ResourceConnection $resourceConnection
      * @param LoggerInterface $logger
      */
     public function __construct(
-        GetAssetsKeywordsInterface $getAssetsKeywordsInterface,
+        GetAssetsKeywordsInterface $getAssetsKeywords,
         ResourceConnection $resourceConnection,
         LoggerInterface $logger
     ) {
-        $this->getAssetsKeywordsInterface = $getAssetsKeywordsInterface;
+        $this->getAssetsKeywords = $getAssetsKeywords;
         $this->resourceConnection = $resourceConnection;
         $this->logger = $logger;
     }
@@ -66,8 +66,14 @@ public function __construct(
     public function execute(int $assetId, array $keywordIds): void
     {
         try {
-            $this->deleteAssetKeywords($assetId, $keywordIds);
-            $this->insertAssetKeywords($assetId, $keywordIds);
+            $currentKeywordIds = $this->getCurrentKeywordIds($assetId);
+
+            $obsoleteKeywordIds = array_diff($currentKeywordIds, $keywordIds);
+            $newKeywordIds = array_diff($keywordIds, $currentKeywordIds);
+
+            $this->deleteAssetKeywords($assetId, $obsoleteKeywordIds);
+            $this->insertAssetKeywords($assetId, $newKeywordIds);
+
         } catch (\Exception $exception) {
             $this->logger->critical($exception);
             throw new CouldNotSaveException(
@@ -81,17 +87,16 @@ public function execute(int $assetId, array $keywordIds): void
      * Save new asset keyword links
      *
      * @param int $assetId
-     * @param array $keywordIds
+     * @param int[] $keywordIds
      * @throws CouldNotSaveException
      */
     private function insertAssetKeywords(int $assetId, array $keywordIds): void
     {
         try {
             if (!empty($keywordIds)) {
                 $values = [];
-                $keywordsToInsert = array_diff($keywordIds, $this->getCurrentKeywords($assetId));
 
-                foreach ($keywordsToInsert as $keywordId) {
+                foreach ($keywordIds as $keywordId) {
                     $values[] = [$assetId, $keywordId];
                 }
 
@@ -119,14 +124,12 @@ private function insertAssetKeywords(int $assetId, array $keywordIds): void
      * Delete obsolete asset keyword links
      *
      * @param int $assetId
-     * @param array $keywords
+     * @param int[] $obsoleteKeywordIds
      * @throws CouldNotDeleteException
      */
-    private function deleteAssetKeywords(int $assetId, array $keywords): void
+    private function deleteAssetKeywords(int $assetId, array $obsoleteKeywordIds): void
     {
         try {
-            $obsoleteKeywordIds = array_diff($this->getCurrentKeywords($assetId), $keywords);
-
             if (!empty($obsoleteKeywordIds)) {
                 /** @var Mysql $connection */
                 $connection = $this->resourceConnection->getConnection();
@@ -150,31 +153,29 @@ private function deleteAssetKeywords(int $assetId, array $keywords): void
     }
 
     /**
-     * Get current keyword data of an asset
+     * Get current keyword ids of an asset
      *
      * @param int $assetId
-     * @return array
+     * @return int[]
      */
-    private function getCurrentKeywords(int $assetId): array
+    private function getCurrentKeywordIds(int $assetId): array
     {
-        $currentKeywordsData = $this->getAssetsKeywordsInterface->execute([$assetId]);
+        $currentKeywordsData = $this->getAssetsKeywords->execute([$assetId]);
 
-        if (!empty($currentKeywordsData)) {
-            $currentKeywords = $this->getKeywordIdsFromKeywordData(
-                $currentKeywordsData[$assetId]->getKeywords()
-            );
-
-            return $currentKeywords;
+        if (empty($currentKeywordsData)) {
+            return [];
         }
 
-        return [];
+        return $this->getKeywordIdsFromKeywordData(
+            $currentKeywordsData[$assetId]->getKeywords()
+        );
     }
 
     /**
      * Get keyword ids from keyword data
      *
-     * @param array $keywordsData
-     * @return array
+     * @param KeywordInterface[] $keywordsData
+     * @return int[]
      */
     private function getKeywordIdsFromKeywordData(array $keywordsData): array
     {

dev/tests/integration/testsuite/Magento/MediaGallery/Model/ResourceModel/AssetKeywordsTest.php

@@ -72,6 +72,7 @@ protected function setUp(): void
     public function testSaveAndGetKeywords(array $keywords): void
     {
         $keywords = ['pear', 'plum'];
+        $updatedKeywords = ['pear', 'apple','orange'];
 
         $loadedAssets = $this->getAssetsByPath->execute([self::FIXTURE_ASSET_PATH]);
         $this->assertCount(1, $loadedAssets);
@@ -105,6 +106,34 @@ public function testSaveAndGetKeywords(array $keywords): void
         sort($keywords);
 
         $this->assertEquals($keywords, $loadedKeywordStrings);
+
+        $updatedAssetKeywords = $this->assetsKeywordsFactory->create(
+            [
+                'assetId' => $loadedAsset->getId(),
+                'keywords' => $this->getKeywords($updatedKeywords)
+            ]
+        );
+        $this->saveAssetsKeywords->execute([$updatedAssetKeywords]);
+        $updatedLoadedAssetKeywords = $this->getAssetsKeywords->execute([$loadedAsset->getId()]);
+
+        $this->assertCount(1, $updatedLoadedAssetKeywords);
+
+        /** @var AssetKeywordsInterface $updatedLoadedAssetKeywords */
+        $updatedLoadedAssetKeywords = current($updatedLoadedAssetKeywords);
+
+        $updatedLoadedKeywords = $updatedLoadedAssetKeywords->getKeywords();
+
+        $this->assertEquals(count($updatedKeywords), count($updatedLoadedKeywords));
+
+        $updatedLoadedKeywordStrings = [];
+        foreach ($updatedLoadedKeywords as $updatedLoadedKeywordObject) {
+            $updatedLoadedKeywordStrings[] = $updatedLoadedKeywordObject->getKeyword();
+        }
+
+        sort($updatedLoadedKeywordStrings);
+        sort($updatedKeywords);
+
+        $this->assertEquals($updatedKeywords, $updatedLoadedKeywordStrings);
     }
 
     /**