Merge pull request #588 from Smartling/WP-967-always-send-related

vsolovei-smartling · web-flow · commit e981d8aecb9f · 2025-11-10T14:05:28.000+01:00
send related content for translation if requested, regardless of submission status (WP-967)
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "smartling/wordpress-connector",
   "license": "GPL-2.0-or-later",
-  "version": "4.4.1",
+  "version": "5.0.0",
   "description": "",
   "type": "wordpress-plugin",
   "repositories": [
diff --git a/inc/Smartling/Models/DetectedRelations.php b/inc/Smartling/Models/DetectedRelations.php
@@ -5,35 +5,22 @@
 class DetectedRelations
 {
     public const ORIGINAL_REFERENCES_KEY = 'originalReferences';
-    public const MISSING_TRANSLATED_REFERENCES_KEY = 'missingTranslatedReferences';
     private array $originalReferences;
-    private array $missingReferences = [];
 
     public function __construct(array $originalReferences)
     {
         $this->originalReferences = $originalReferences;
     }
 
-    public function addMissingReference(int $targetBlogId, string $contentType, int $id): void
-    {
-        $this->missingReferences[$targetBlogId][$contentType][] = $id;
-    }
-
     public function getOriginalReferences(): array
     {
         return $this->originalReferences;
     }
 
-    public function getMissingReferences(): array
-    {
-        return $this->missingReferences;
-    }
-
     public function toArray(): array
     {
         return [
             self::ORIGINAL_REFERENCES_KEY => $this->originalReferences,
-            self::MISSING_TRANSLATED_REFERENCES_KEY => $this->missingReferences,
         ];
     }
 }
diff --git a/inc/Smartling/Models/UserTranslationRequest.php b/inc/Smartling/Models/UserTranslationRequest.php
@@ -47,7 +47,7 @@ public function isBulk(): bool
         return count($this->ids) > 0;
     }
 
-    private static function validate(array $array)
+    private static function validate(array $array): void
     {
         if (!array_key_exists('source', $array)) {
             throw new \InvalidArgumentException('Source array required');
diff --git a/inc/Smartling/Services/ContentRelationsDiscoveryService.php b/inc/Smartling/Services/ContentRelationsDiscoveryService.php
@@ -217,14 +217,12 @@ public function createSubmissions(UserTranslationRequest $request): void
 
         $relatedIds = [];
         try {
-            foreach ($request->getRelationsOrdered() as $relations) {
-                foreach ($relations as $content) {
-                    foreach ($content as $contentType => $contentIds) {
-                        if (!array_key_exists($contentType, $relatedIds)) {
-                            $relatedIds[$contentType] = [];
-                        }
-                        $relatedIds[$contentType] = array_merge($relatedIds[$contentType], $contentIds);
+            foreach ($request->getRelationsOrdered() as $content) {
+                foreach ($content as $contentType => $contentIds) {
+                    if (!array_key_exists($contentType, $relatedIds)) {
+                        $relatedIds[$contentType] = [];
                     }
+                    $relatedIds[$contentType] = array_merge($relatedIds[$contentType], $contentIds);
                 }
             }
             foreach ($relatedIds as $contentType => $contentIds) {
@@ -568,25 +566,7 @@ public function getRelations(string $contentType, int $id, array $targetBlogIds)
         $detectedReferences = $this->normalizeReferences($detectedReferences);
         $this->getLogger()->debug('References after normalizing: ' . json_encode($detectedReferences));
 
-        $responseData = new DetectedRelations($detectedReferences);
-
-        foreach ($targetBlogIds as $targetBlogId) {
-            foreach ($detectedReferences as $detectedContentType => $ids) {
-                if (in_array($detectedContentType, array_merge($this->contentTypeManager->getRegisteredContentTypes(), $this->externalContentManager->getExternalContentTypes()), true)) {
-                    foreach ($ids as $detectedId) {
-                        if (!$this->submissionManager->submissionExistsNoLastError($detectedContentType, $curBlogId, $detectedId, $targetBlogId)) {
-                            $responseData->addMissingReference($targetBlogId, $detectedContentType, $detectedId);
-                        } else {
-                            $this->getLogger()->debug("Skipped adding relatedId=$detectedId for sourceContentId=$id, blogId=$targetBlogId: submission exists");
-                        }
-                    }
-                } else {
-                    $this->getLogger()->debug("Excluded $detectedContentType from related submissions, type not in registered or external types");
-                }
-            }
-        }
-
-        return $responseData;
+        return new DetectedRelations($detectedReferences);
     }
 
     public function normalizeReferences(array $references): array
@@ -682,17 +662,16 @@ private function getSources(UserCloneRequest $request, int $targetBlogId): array
     {
         $sources = [];
 
-        foreach ($request->getRelationsOrdered() as $relationSet) {
-            foreach (($relationSet[$targetBlogId] ?? []) as $type => $ids) {
-                foreach ($ids as $id) {
-                    if ($id === $request->getContentId() && $type === $request->getContentType()) {
-                        $this->getLogger()->info("Related list contains reference to root content, skip adding sourceId=$id, contentType=$type to sources list");
-                    } else {
-                        $sources[] = [
-                            'id' => $id,
-                            'type' => $type,
-                        ];
-                    }
+        $relationSet = $request->getRelationsOrdered();
+        foreach (($relationSet[$targetBlogId] ?? []) as $type => $ids) {
+            foreach ($ids as $id) {
+                if ($id === $request->getContentId() && $type === $request->getContentType()) {
+                    $this->getLogger()->info("Related list contains reference to root content, skip adding sourceId=$id, contentType=$type to sources list");
+                } else {
+                    $sources[] = [
+                        'id' => $id,
+                        'type' => $type,
+                    ];
                 }
             }
         }
diff --git a/inc/Smartling/Services/ContentRelationsHandler.php b/inc/Smartling/Services/ContentRelationsHandler.php
@@ -25,12 +25,6 @@
  *              "page":[2],
  *              "post_tag":[13,14],
  *              "category":[1]
- *          },
- *          "missingTranslatedReferences":{
- *              "2":{"attachment":[244,232,231]},
- *              "3":{"attachment":[244,232,26,231]},
- *              "4":{"attachment":[244,232,26,231],"post":[1],"post_tag":[13,14]},
- *              "5":{"attachment":[244,232,26,231],"post_tag":[13,14]}
  *          }
  *      }
  *  }
diff --git a/inc/Smartling/WP/Controller/TestRunController.php b/inc/Smartling/WP/Controller/TestRunController.php
@@ -190,7 +190,8 @@ public function testRun($data): void
             $this->contentRelationDiscoveryService->createSubmissions(new UserTranslationRequest(
                 $post->ID,
                 $post->post_type,
-                $this->contentRelationDiscoveryService->getRelations($post->post_type, $post->ID, [$targetBlogId])->getMissingReferences(),
+                [$targetBlogId => $this->contentRelationDiscoveryService
+                    ->getRelations($post->post_type, $post->ID, [$targetBlogId])->getOriginalReferences()],
                 [$targetBlogId],
                 new JobInformation($job->getJobUid(), true, $job->getJobName(), 'Test run job', '', 'UTC'),
                 [],
diff --git a/inc/Smartling/WP/View/ContentEditJob.php b/inc/Smartling/WP/View/ContentEditJob.php
@@ -28,8 +28,8 @@
 
 <script>
     const isBulkSubmitPage = <?= $isBulkSubmitPage ? 'true' : 'false'?>;
-    let l1Relations = {missingTranslatedReferences: {}, originalReferences: {}};
-    let l2Relations = {missingTranslatedReferences: {}, originalReferences: {}};
+    let l1Relations = {originalReferences: {}};
+    let l2Relations = {originalReferences: {}};
     let globalButton;
 </script>
 
@@ -141,7 +141,7 @@
                                 </td>
                             </tr>
                             <tr id="relationsInfo">
-                                <th>New content to be uploaded:</th>
+                                <th>Related content to be uploaded:</th>
                                 <td id="relatedContent">
                                 </td>
                             </tr>
@@ -387,38 +387,27 @@ function (i, e) {
                 minDate: 0
             });
 
-            const mergeRelations = function mergeRelations(a, b) {
-                a = a || {};
-                b = b || {};
-                const result = JSON.parse(JSON.stringify(a));
-                for (const blogId in b) {
-                    if (!result.hasOwnProperty(blogId)) {
-                        result[blogId] = {};
-                    }
-                    for (const type in b[blogId]) {
-                        if (!result[blogId].hasOwnProperty(type)) {
-                            result[blogId][type] = [];
-                        }
-                        result[blogId][type] = result[blogId][type].concat(b[blogId][type]).filter((value, index, self) => self.indexOf(value) === index);
-                    }
-                }
-
-                return result;
-            }
-
             const recalculateRelations = function recalculateRelations() {
-                $("#relatedContent").html("");
+                const relatedContent = $("#relatedContent");
+                relatedContent.html("");
                 const relations = {};
-                let missingRelations = {};
+                let allRelations = {};
                 const cloneDepth = $('#cloneDepth').val();
                 switch (cloneDepth) {
                     case "0":
                         return;
                     case "1":
-                        missingRelations = l1Relations.missingTranslatedReferences;
+                        allRelations = l1Relations.originalReferences;
                         break;
                     case "2":
-                        missingRelations = mergeRelations(l1Relations.missingTranslatedReferences, l2Relations.missingTranslatedReferences);
+                        allRelations = {...l1Relations.originalReferences};
+                        for (const type in l2Relations.originalReferences) {
+                            if (allRelations[type]) {
+                                allRelations[type] = [...new Set([...allRelations[type], ...l2Relations.originalReferences[type]])];
+                            } else {
+                                allRelations[type] = l2Relations.originalReferences[type];
+                            }
+                        }
                         break;
                     default:
                         console.error(`Unsupported clone depth value: ${cloneDepth}`);
@@ -430,20 +419,17 @@ function (i, e) {
                     }
                     return html;
                 };
-                $(".job-wizard input.mcheck[type=checkbox]:checked").each(function () {
-                    const blogId = this.dataset.blogId;
-                    if (missingRelations && missingRelations.hasOwnProperty(blogId)) {
-                        for (const sysType in missingRelations[blogId]) {
-                            let sysCount = missingRelations[blogId][sysType].length;
-                            if (relations.hasOwnProperty(sysType)) {
-                                relations[sysType] += sysCount;
-                            } else {
-                                relations[sysType] = sysCount;
-                            }
-                            $("#relatedContent").html(buildRelationsHint(relations));
+                if (allRelations && Object.keys(allRelations).length > 0) {
+                    for (const sysType in allRelations) {
+                        let sysCount = allRelations[sysType].length;
+                        if (relations.hasOwnProperty(sysType)) {
+                            relations[sysType] += sysCount;
+                        } else {
+                            relations[sysType] = sysCount;
                         }
                     }
-                });
+                    relatedContent.html(buildRelationsHint(relations));
+                }
             };
 
             const loadRelations = function loadRelations(contentType, contentId, level = 1) {
@@ -464,16 +450,10 @@ function (i, e) {
                             case 2:
                                 const originalReferences = data.response.data.originalReferences;
                                 for (const relatedType in originalReferences) {
-                                    for (const relatedId of originalReferences[relatedType]) {
-                                        if (!l2Relations.originalReferences.hasOwnProperty(relatedType)) {
-                                            l2Relations.originalReferences[relatedType] = [];
-                                        }
-                                        l2Relations.originalReferences[relatedType] = l2Relations.originalReferences[relatedType].concat(originalReferences[relatedType]);
+                                    if (!l2Relations.originalReferences.hasOwnProperty(relatedType)) {
+                                        l2Relations.originalReferences[relatedType] = [];
                                     }
-                                    l2Relations.missingTranslatedReferences = mergeRelations(
-                                        l2Relations.missingTranslatedReferences,
-                                        data.response.data.missingTranslatedReferences,
-                                    );
+                                    l2Relations.originalReferences[relatedType] = l2Relations.originalReferences[relatedType].concat(originalReferences[relatedType]);
                                 }
                                 break;
                         }
@@ -547,12 +527,29 @@ function (i, e) {
                 };
 
                 if (!isBulkSubmitPage) {
+                    const prepareRequest = (originalRefs) => {
+                        const result = {};
+                        $(".job-wizard input.mcheck[type=checkbox]:checked").each(function () {
+                            const blogId = this.dataset.blogId;
+                            result[blogId] = originalRefs;
+                        });
+                        return result;
+                    };
+
                     switch ($('#cloneDepth').val()) {
                         case "1":
-                            data.relations = {1: l1Relations.missingTranslatedReferences};
+                            data.relations = prepareRequest(l1Relations.originalReferences);
                             break;
                         case "2":
-                            data.relations = {1: l1Relations.missingTranslatedReferences, 2: l2Relations.missingTranslatedReferences}
+                            const mergedOriginal = {...l1Relations.originalReferences};
+                            for (const type in l2Relations.originalReferences) {
+                                if (mergedOriginal[type]) {
+                                    mergedOriginal[type] = [...new Set([...mergedOriginal[type], ...l2Relations.originalReferences[type]])];
+                                } else {
+                                    mergedOriginal[type] = l2Relations.originalReferences[type];
+                                }
+                            }
+                            data.relations = prepareRequest(mergedOriginal);
                             break;
                     }
                 }
diff --git a/readme.txt b/readme.txt
@@ -4,7 +4,7 @@ Tags: translation, localization, multilingual, internationalization, smartling
 Requires at least: 5.5
 Tested up to: 6.6.2
 Requires PHP: 8.0
-Stable tag: 4.4.1
+Stable tag: 5.0.0
 License: GPLv2 or later
 
 Translate content in WordPress quickly and seamlessly with Smartling, the industry-leading Translation Management System.
@@ -62,6 +62,9 @@ Additional information on the Smartling Connector for WordPress can be found [he
 3. Track translation status within WordPress from the Submissions Board. View overall progress of submitted translation requests as well as resend updated content.
 
 == Changelog ==
+= 5.0.0 =
+* Related assets will now be processed for translation when the content is submitted from the widget, even if they were previously sent for translation
+
 = 4.4.1 =
 * Added possibility to clear the test run flag regardless of the test run status
 * Fixed test run erroneously flagging taxonomy submissions as failed
diff --git a/smartling-connector.php b/smartling-connector.php
@@ -11,7 +11,7 @@
  * Plugin Name:       Smartling Connector
  * Plugin URI:        https://www.smartling.com/products/automate/integrations/wordpress/
  * Description:       Integrate your WordPress site with Smartling to upload your content and download translations.
- * Version:           4.4.1
+ * Version:           5.0.0
  * Author:            Smartling
  * Author URI:        https://www.smartling.com
  * License:           GPL-2.0+
diff --git a/tests/IntegrationTests/tests/CloneTest.php b/tests/IntegrationTests/tests/CloneTest.php
@@ -46,8 +46,8 @@ public function testNoMediaDuplication(): void
             ],
         ], function () use ($childPostId, $imageId, $relationsDiscoveryService, $rootPostId, $targetBlogId) {
             $references = $relationsDiscoveryService->getRelations('post', $rootPostId, [$targetBlogId]);
-            $this->assertCount(1, $references->getMissingReferences()[$targetBlogId]['post']);
-            $this->assertEquals($childPostId, $references->getMissingReferences()[$targetBlogId]['post'][0]);
+            $this->assertCount(1, $references->getOriginalReferences()['post']);
+            $this->assertEquals($childPostId, $references->getOriginalReferences()['post'][0]);
             $relationsDiscoveryService->clone(new UserCloneRequest($rootPostId, 'post', [
                 1 => [$targetBlogId => ['post' => [$childPostId]]],
                 2 => [$targetBlogId => ['attachment' => [$imageId]]],
diff --git a/tests/IntegrationTests/tests/RelationsTest.php b/tests/IntegrationTests/tests/RelationsTest.php
@@ -238,12 +238,11 @@ private function verify(int $postId, int $cloneBlogId, int $translationBlogId, i
         ]);
         $expectedThumbId = -1;
         $thumbId = get_post_thumbnail_id($postId);
-        $this->assertArrayHasKey($cloneBlogId, $relations->getMissingReferences());
-        $this->assertArrayHasKey(ContentTypeHelper::POST_TYPE_ATTACHMENT, $relations->getMissingReferences()[$cloneBlogId]);
-        $this->assertCount($imagesPerPost, $relations->getMissingReferences()[$cloneBlogId][ContentTypeHelper::POST_TYPE_ATTACHMENT]);
+        $this->assertArrayHasKey(ContentTypeHelper::POST_TYPE_ATTACHMENT, $relations->getOriginalReferences());
+        $this->assertCount($imagesPerPost, $relations->getOriginalReferences()[ContentTypeHelper::POST_TYPE_ATTACHMENT]);
         #region cloning
         $imageSubmissions = [];
-        foreach ($relations->getMissingReferences()[$cloneBlogId][ContentTypeHelper::POST_TYPE_ATTACHMENT] as $imageId) {
+        foreach ($relations->getOriginalReferences()[ContentTypeHelper::POST_TYPE_ATTACHMENT] as $imageId) {
             $submission = $this->uploadDownload($this->createSubmissionForCloning(ContentTypeHelper::POST_TYPE_ATTACHMENT, $imageId));
             $this->assertEquals(SubmissionEntity::SUBMISSION_STATUS_COMPLETED, $submission->getStatus());
             $this->assertNotEquals(0, $submission->getTargetId());
@@ -267,7 +266,7 @@ private function verify(int $postId, int $cloneBlogId, int $translationBlogId, i
         #endregion
         #region translation
         $imageSubmissions = [];
-        foreach ($relations->getMissingReferences()[$translationBlogId][ContentTypeHelper::POST_TYPE_ATTACHMENT] as $imageId) {
+        foreach ($relations->getOriginalReferences()[ContentTypeHelper::POST_TYPE_ATTACHMENT] as $imageId) {
             $submission = $this->uploadDownload($this->createSubmission(ContentTypeHelper::POST_TYPE_ATTACHMENT, $imageId));
             $this->assertEquals(SubmissionEntity::SUBMISSION_STATUS_COMPLETED, $submission->getStatus());
             $this->assertNotEquals(0, $submission->getTargetId());
diff --git a/tests/Services/ContentRelationsDiscoveryServiceTest.php b/tests/Services/ContentRelationsDiscoveryServiceTest.php
@@ -657,7 +657,7 @@ public function testParentPageReferenceDetected()
             $x->method('getBackwardRelatedTaxonomies')->willReturn([]);
 
             $relations = $x->getRelations('post', 1, [$targetBlogId]);
-            $this->assertEquals($parentId, $relations->getMissingReferences()[$targetBlogId]['page'][0]);
+            $this->assertEquals($parentId, $relations->getOriginalReferences()['page'][0]);
         }
 
         public function testRelatedItemsSentForTranslation()

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "smartling/wordpress-connector",`
`3`	`3`	`"license": "GPL-2.0-or-later",`
`4`		`- "version": "4.4.1",`
	`4`	`+ "version": "5.0.0",`
`5`	`5`	`"description": "",`
`6`	`6`	`"type": "wordpress-plugin",`
`7`	`7`	`"repositories": [`
Original file line number	Diff line number	Diff line change
`@@ -5,35 +5,22 @@`
`5`	`5`	`class DetectedRelations`
`6`	`6`	`{`
`7`	`7`	`public const ORIGINAL_REFERENCES_KEY = 'originalReferences';`
`8`		`- public const MISSING_TRANSLATED_REFERENCES_KEY = 'missingTranslatedReferences';`
`9`	`8`	`private array $originalReferences;`
`10`		`- private array $missingReferences = [];`
`11`	`9`
`12`	`10`	`public function __construct(array $originalReferences)`
`13`	`11`	`{`
`14`	`12`	`$this->originalReferences = $originalReferences;`
`15`	`13`	`}`
`16`	`14`
`17`		`- public function addMissingReference(int $targetBlogId, string $contentType, int $id): void`
`18`		`- {`
`19`		`- $this->missingReferences[$targetBlogId][$contentType][] = $id;`
`20`		`- }`
`21`		`-`
`22`	`15`	`public function getOriginalReferences(): array`
`23`	`16`	`{`
`24`	`17`	`return $this->originalReferences;`
`25`	`18`	`}`
`26`	`19`
`27`		`- public function getMissingReferences(): array`
`28`		`- {`
`29`		`- return $this->missingReferences;`
`30`		`- }`
`31`		`-`
`32`	`20`	`public function toArray(): array`
`33`	`21`	`{`
`34`	`22`	`return [`
`35`	`23`	`self::ORIGINAL_REFERENCES_KEY => $this->originalReferences,`
`36`		`- self::MISSING_TRANSLATED_REFERENCES_KEY => $this->missingReferences,`
`37`	`24`	`];`
`38`	`25`	`}`
`39`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function isBulk(): bool`
`47`	`47`	`return count($this->ids) > 0;`
`48`	`48`	`}`
`49`	`49`
`50`		`- private static function validate(array $array)`
	`50`	`+ private static function validate(array $array): void`
`51`	`51`	`{`
`52`	`52`	`if (!array_key_exists('source', $array)) {`
`53`	`53`	`throw new \InvalidArgumentException('Source array required');`