MDEE-1041: Persist x-request-id from response (#485)

Author: duhon

CatalogDataExporter/Test/Integration/ProductDataSerializerTest.php

@@ -24,6 +24,7 @@
 use Magento\DataExporter\Status\ExportStatusCodeProvider;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\DataExporter\Model\FeedExportStatusBuilder;
+use Magento\DataExporter\Model\Indexer\FeedIndexMetadata;
 
 class ProductDataSerializerTest extends AbstractProductTestHelper
 {
@@ -255,6 +256,7 @@ private function prepareExpectedData(
                 'is_deleted' => $feed['deleted'],
                 'status' => $failedSkuPosition ? $finalStatus : $status,
                 'errors' => $failedSkuPosition ? $errors : $exportStatus->getReasonPhrase(),
+                FeedIndexMetadata::FEED_TABLE_FIELD_METADATA => $exportStatus->getMetadata(),
                 'feed_data' => $this->jsonSerializer->serialize($feed),
                 'feed_hash' => $item['feed_hash'],
                 'feed_id' => $item['feed_id'],

CatalogDataExporter/etc/db_schema.xml

@@ -75,6 +75,12 @@
                 nullable="true"
                 comment="Errors"
         />
+        <column
+                xsi:type="text"
+                name="metadata"
+                nullable="true"
+                comment="metadata info"
+        />
         <constraint xsi:type="primary" referenceId="PRIMARY">
             <column name="id"/>
         </constraint>
@@ -151,6 +157,12 @@
                 nullable="true"
                 comment="Errors"
         />
+        <column
+                xsi:type="text"
+                name="metadata"
+                nullable="true"
+                comment="metadata info"
+        />
         <constraint xsi:type="primary" referenceId="PRIMARY">
             <column name="id"/>
         </constraint>
@@ -227,6 +239,12 @@
                 nullable="true"
                 comment="Errors"
         />
+        <column
+                xsi:type="text"
+                name="metadata"
+                nullable="true"
+                comment="metadata info"
+        />
         <constraint xsi:type="primary" referenceId="PRIMARY">
             <column name="id"/>
         </constraint>

DataExporter/Model/FeedExportStatus.php

@@ -17,6 +17,8 @@
 namespace Magento\DataExporter\Model;
 
 use Magento\DataExporter\Status\ExportStatusCode;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Serialize\Serializer\Json;
 
 /**
  * DTO class to handle result of feed export
@@ -26,20 +28,29 @@ class FeedExportStatus
     private ExportStatusCode $status;
     private string $reasonPhrase;
     private array $failedItems;
+    private array $metadata;
+    private Json $jsonSerializer;
 
     /**
      * @param ExportStatusCode $status
      * @param string $reasonPhrase
      * @param array $failedItems
+     * @param Json $jsonSerializer
+     * @param array $metadata
      */
     public function __construct(
         ExportStatusCode $status,
         string $reasonPhrase,
-        array $failedItems
+        array $failedItems,
+        ?Json $jsonSerializer = null,
+        ?array $metadata = []
     ) {
         $this->status = $status;
         $this->reasonPhrase = $reasonPhrase;
         $this->failedItems = $failedItems;
+        $this->metadata = $metadata;
+        $this->jsonSerializer = $jsonSerializer
+            ?? ObjectManager::getInstance()->get(Json::class);
     }
 
     /**
@@ -71,4 +82,14 @@ public function getStatus(): ExportStatusCode
     {
         return $this->status;
     }
+
+    /**
+     * Get metadata
+     *
+     * @return string
+     */
+    public function getMetadata(): string
+    {
+        return $this->jsonSerializer->serialize($this->metadata);
+    }
 }

DataExporter/Model/FeedExportStatusBuilder.php

@@ -58,19 +58,22 @@ public function __construct(
      * @param int $status
      * @param string $reasonPhrase
      * @param array $failedItems
+     * @param array $metadata
      * @return FeedExportStatus
      */
     public function build(
         int $status,
         string $reasonPhrase = '',
-        array $failedItems = []
+        array $failedItems = [],
+        array $metadata = []
     ) : FeedExportStatus {
         try {
             return $this->feedExportStatusFactory->create(
                 [
                     'status' => $this->buildStatusCode($status),
                     'reasonPhrase' => $reasonPhrase,
-                    'failedItems' => $failedItems
+                    'failedItems' => $failedItems,
+                    'metadata' => $metadata
                 ]
             );
 

DataExporter/Model/Indexer/DataSerializer.php

@@ -165,6 +165,7 @@ private function serializeForImmediateExport(
             $outputRow[FeedIndexMetadata::FEED_TABLE_FIELD_FEED_HASH] = $row[
                 FeedIndexMetadata::FEED_TABLE_FIELD_FEED_HASH
             ];
+            $outputRow[FeedIndexMetadata::FEED_TABLE_FIELD_METADATA] = $exportStatus->getMetadata();
             if (IndexStateProvider::isUpdate($row)) {
                 $outputRow[FeedIndexMetadata::FEED_TABLE_FIELD_PK] = $row[FeedIndexMetadata::FEED_TABLE_FIELD_PK];
                 $output[IndexStateProvider::UPDATE_OPERATION][] = $outputRow;

DataExporter/Model/Indexer/FeedIndexMetadata.php

@@ -34,6 +34,7 @@ class FeedIndexMetadata
     public const FEED_TABLE_FIELD_FEED_DATA = 'feed_data';
     public const FEED_TABLE_FIELD_STATUS = 'status';
     public const FEED_TABLE_FIELD_ERRORS = 'errors';
+    public const FEED_TABLE_FIELD_METADATA = 'metadata';
     /**
      * Default columns that must be updated each time when feed persisted to storage
      */
@@ -44,6 +45,7 @@ class FeedIndexMetadata
         self::FEED_TABLE_FIELD_FEED_HASH => self::FEED_TABLE_FIELD_FEED_HASH,
         self::FEED_TABLE_FIELD_STATUS => self::FEED_TABLE_FIELD_STATUS,
         self::FEED_TABLE_FIELD_ERRORS => self::FEED_TABLE_FIELD_ERRORS,
+        self::FEED_TABLE_FIELD_METADATA => self::FEED_TABLE_FIELD_METADATA,
         self::FEED_TABLE_FIELD_MODIFIED_AT => self::FEED_TABLE_FIELD_MODIFIED_AT
     ];
 

InventoryDataExporter/etc/db_schema.xml

@@ -74,6 +74,12 @@
                 nullable="true"
                 comment="Errors"
         />
+        <column
+                xsi:type="text"
+                name="metadata"
+                nullable="true"
+                comment="metadata info"
+        />
         <constraint xsi:type="primary" referenceId="PRIMARY">
             <column name="id"/>
         </constraint>

ProductPriceDataExporter/etc/db_schema.xml

@@ -75,6 +75,12 @@
                 nullable="true"
                 comment="Errors"
         />
+        <column
+                xsi:type="text"
+                name="metadata"
+                nullable="true"
+                comment="metadata info"
+        />
         <constraint xsi:type="primary" referenceId="PRIMARY">
             <column name="id"/>
         </constraint>

ProductVariantDataExporter/etc/db_schema.xml

@@ -75,6 +75,12 @@
                 nullable="true"
                 comment="Errors"
         />
+        <column
+                xsi:type="text"
+                name="metadata"
+                nullable="true"
+                comment="metadata info"
+        />
         <constraint xsi:type="primary" referenceId="PRIMARY">
             <column name="id"/>
         </constraint>