feat: fill logs with meaningful data src/Migration (#46)

jozsefdamokos · web-flow · commit 5d495b8094b0 · 2025-08-27T16:02:51.000+02:00
diff --git a/src/Migration/Logging/Log/Builder/SwagMigrationLogBuilder.php b/src/Migration/Logging/Log/Builder/SwagMigrationLogBuilder.php
@@ -128,7 +128,11 @@ public function withExceptionTrace(array $exceptionTrace): self
      */
     public function build(string $logClass): AbstractSwagMigrationLogEntry
     {
-        $log = new $logClass(
+        if (!class_exists($logClass) || !is_subclass_of($logClass, AbstractSwagMigrationLogEntry::class)) {
+            throw MigrationException::failedToCreateMigrationLog($logClass);
+        }
+
+        return new $logClass(
             $this->runId,
             $this->profileName,
             $this->gatewayName,
@@ -141,11 +145,5 @@ public function build(string $logClass): AbstractSwagMigrationLogEntry
             $this->exceptionMessage,
             $this->exceptionTrace,
         );
-
-        if ($log instanceof AbstractSwagMigrationLogEntry) {
-            return $log;
-        }
-
-        throw MigrationException::failedToCreateMigrationLog($logClass);
     }
 }
diff --git a/src/Migration/Media/Processor/HttpDownloadServiceBase.php b/src/Migration/Media/Processor/HttpDownloadServiceBase.php
@@ -9,12 +9,12 @@
 
 use Doctrine\DBAL\Connection;
 use GuzzleHttp\Exception\RequestException;
-use GuzzleHttp\Promise;
 use GuzzleHttp\Promise\PromiseInterface;
 use GuzzleHttp\Promise\Utils;
 use Psr\Http\Message\ResponseInterface;
 use Shopware\Core\Content\Media\File\FileSaver;
 use Shopware\Core\Content\Media\File\MediaFile;
+use Shopware\Core\Content\Media\MediaDefinition;
 use Shopware\Core\Content\Media\MediaException;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
@@ -77,10 +77,11 @@ public function process(MigrationContextInterface $migrationContext, Context $co
         if ($client === null) {
             $exception = new \Exception('Http download client can not be constructed.');
 
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                     ->withExceptionMessage($exception->getMessage())
                     ->withExceptionTrace($exception->getTrace())
+                    ->withEntityName(MediaDefinition::ENTITY_NAME)
                     ->build(ExceptionRunLog::class)
             );
             $this->loggingService->saveLogging($context);
@@ -122,8 +123,9 @@ function (MediaProcessWorkloadStruct $work) use ($uuid) {
                     $failureUuids[] = $uuid;
                     $work->setState(MediaProcessWorkloadStruct::ERROR_STATE);
 
-                    $this->loggingService->addLogEntry( // TODO: add optional fields
+                    $this->loggingService->addLogEntry(
                         SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
+                            ->withEntityName(MediaDefinition::ENTITY_NAME)
                             ->build(CannotGetFileRunLog::class)
                     );
                 }
@@ -141,8 +143,9 @@ function (MediaProcessWorkloadStruct $work) use ($uuid) {
                 $failureUuids[] = $uuid;
                 $work->setState(MediaProcessWorkloadStruct::ERROR_STATE);
 
-                $this->loggingService->addLogEntry( // TODO: add optional fields
+                $this->loggingService->addLogEntry(
                     SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
+                        ->withEntityName(MediaDefinition::ENTITY_NAME)
                         ->build(TemporaryFileErrorLog::class)
                 );
 
@@ -181,10 +184,11 @@ function (MediaProcessWorkloadStruct $work) use ($uuid) {
                 } catch (\Exception $e) {
                     $failureUuids[] = $uuid;
                     $work->setState(MediaProcessWorkloadStruct::ERROR_STATE);
-                    $this->loggingService->addLogEntry( // TODO: add optional fields
+                    $this->loggingService->addLogEntry(
                         SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                             ->withExceptionMessage($e->getMessage())
                             ->withExceptionTrace($e->getTrace())
+                            ->withEntityName(MediaDefinition::ENTITY_NAME)
                             ->build(ExceptionRunLog::class)
                     );
                 } finally {
@@ -279,10 +283,11 @@ private function doNormalDownloadRequest(MigrationContextInterface $migrationCon
             $workload->setState(MediaProcessWorkloadStruct::FINISH_STATE);
         } catch (\Throwable $exception) {
             // this should never happen because of Promises, but just in case something is wrong with request construction
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                     ->withExceptionMessage($exception->getMessage())
                     ->withExceptionTrace($exception->getTrace())
+                    ->withEntityName(MediaDefinition::ENTITY_NAME)
                     ->build(ExceptionRunLog::class)
             );
 
@@ -302,10 +307,11 @@ private function persistFileToMedia(string $filePath, string $uuid, string $name
         if ($fileSize === false || $fileSize === 0 || $mimeType === false) {
             $exception = new \Exception('Downloaded file is empty or could not determine mime type.');
 
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                     ->withExceptionMessage($exception->getMessage())
                     ->withExceptionTrace($exception->getTrace())
+                    ->withEntityName(MediaDefinition::ENTITY_NAME)
                     ->build(ExceptionRunLog::class)
             );
 
@@ -337,10 +343,11 @@ private function persistFileToMedia(string $filePath, string $uuid, string $name
                 } elseif (\in_array($mediaException->getErrorCode(), [MediaException::MEDIA_ILLEGAL_FILE_NAME, MediaException::MEDIA_EMPTY_FILE_NAME], true)) {
                     $this->fileSaver->persistFileToMedia($mediaFile, Uuid::randomHex(), $uuid, $context);
                 } else {
-                    $this->loggingService->addLogEntry( // TODO: add optional fields
+                    $this->loggingService->addLogEntry(
                         SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                             ->withExceptionMessage($mediaException->getMessage())
                             ->withExceptionTrace($mediaException->getTrace())
+                            ->withEntityName(MediaDefinition::ENTITY_NAME)
                             ->build(ExceptionRunLog::class)
                     );
                 }
diff --git a/src/Migration/MessageQueue/Handler/ProcessMediaHandler.php b/src/Migration/MessageQueue/Handler/ProcessMediaHandler.php
@@ -7,6 +7,7 @@
 
 namespace SwagMigrationAssistant\Migration\MessageQueue\Handler;
 
+use Shopware\Core\Content\Media\MediaDefinition;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
@@ -84,18 +85,22 @@ public function __invoke(ProcessMediaMessage $message): void
             $processor = $this->mediaFileProcessorRegistry->getProcessor($migrationContext);
             $workload = $processor->process($migrationContext, $context, $workload);
             $this->processFailures($context, $migrationContext, $processor, $workload);
-        } catch (NoConnectionFoundException) {
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+        } catch (NoConnectionFoundException $exception) {
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
+                    ->withExceptionMessage($exception->getMessage())
+                    ->withExceptionTrace($exception->getTrace())
+                    ->withEntityName(MediaDefinition::ENTITY_NAME)
                     ->build(ProcessorNotFoundLog::class)
             );
 
             $this->loggingService->saveLogging($context);
         } catch (\Exception $e) {
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                     ->withExceptionMessage($e->getMessage())
                     ->withExceptionTrace($e->getTrace())
+                    ->withEntityName(MediaDefinition::ENTITY_NAME)
                     ->build(ExceptionRunLog::class)
             );
 
diff --git a/src/Migration/Run/RunService.php b/src/Migration/Run/RunService.php
@@ -254,13 +254,17 @@ public function assignThemeToSalesChannel(string $runUuid, Context $context): vo
         foreach ($salesChannels as $salesChannel) {
             try {
                 $this->themeService->assignTheme($defaultTheme, $salesChannel, $context);
-            } catch (\Throwable) {
-                $this->loggingService->addLogEntry( // TODO: add optional fields
+            } catch (\Throwable $exception) {
+                $this->loggingService->addLogEntry(
                     (new SwagMigrationLogBuilder(
                         $runUuid,
                         $connection->getProfileName(),
                         $connection->getGatewayName(),
-                    ))->build(ThemeCompilingErrorRunLog::class)
+                    ))
+                        ->withExceptionMessage($exception->getMessage())
+                        ->withExceptionTrace($exception->getTrace())
+                        ->withEntityName(SalesChannelDefinition::ENTITY_NAME)
+                        ->build(ThemeCompilingErrorRunLog::class)
                 );
             }
         }
diff --git a/src/Migration/Service/MediaFileProcessorService.php b/src/Migration/Service/MediaFileProcessorService.php
@@ -45,8 +45,8 @@ public function processMediaFiles(MigrationContextInterface $migrationContext, C
             if ($currentDataSet === null) {
                 try {
                     $currentDataSet = $this->dataSetRegistry->getDataSet($migrationContext, $mediaFile['entity']);
-                } catch (DataSetNotFoundException) {
-                    $this->logDataSetNotFoundException($migrationContext);
+                } catch (DataSetNotFoundException $exception) {
+                    $this->logDataSetNotFoundException($migrationContext, $exception);
 
                     continue;
                 }
@@ -59,8 +59,8 @@ public function processMediaFiles(MigrationContextInterface $migrationContext, C
                     $messageMediaUuids = [];
                     $currentCount = 0;
                     $currentDataSet = $this->dataSetRegistry->getDataSet($migrationContext, $mediaFile['entity']);
-                } catch (DataSetNotFoundException) {
-                    $this->logDataSetNotFoundException($migrationContext);
+                } catch (DataSetNotFoundException $exception) {
+                    $this->logDataSetNotFoundException($migrationContext, $exception);
 
                     continue;
                 }
@@ -129,10 +129,14 @@ private function addMessageToBus(string $runUuid, Context $context, DataSet $dat
         $this->messageBus->dispatch($message);
     }
 
-    private function logDataSetNotFoundException(MigrationContextInterface $migrationContext): void
-    {
-        $this->loggingService->addLogEntry( // TODO: add optional fields
+    private function logDataSetNotFoundException(
+        MigrationContextInterface $migrationContext,
+        \Throwable $exception
+    ): void {
+        $this->loggingService->addLogEntry(
             SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
+                ->withExceptionMessage($exception->getMessage())
+                ->withExceptionTrace($exception->getTrace())
                 ->build(DataSetNotFoundLog::class)
         );
     }
diff --git a/src/Migration/Service/MigrationDataConverter.php b/src/Migration/Service/MigrationDataConverter.php
@@ -68,10 +68,11 @@ public function convert(array $data, MigrationContextInterface $migrationContext
                 $this->mediaFileService->writeMediaFile($context);
             }
         } catch (\Throwable $exception) {
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                     ->withExceptionMessage($exception->getMessage())
                     ->withExceptionTrace($exception->getTrace())
+                    ->withEntityName($dataSet::getEntity())
                     ->build(ExceptionRunLog::class)
             );
 
@@ -104,10 +105,12 @@ private function convertData(
                     'convertFailure' => $convertFailureFlag,
                 ];
             } catch (\Throwable $exception) {
-                $this->loggingService->addLogEntry( // TODO: add optional fields
+                $this->loggingService->addLogEntry(
                     SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                         ->withExceptionMessage($exception->getMessage())
                         ->withExceptionTrace($exception->getTrace())
+                        ->withEntityName($dataSet::getEntity())
+                        ->withSourceData($item)
                         ->build(ExceptionRunLog::class)
                 );
 
diff --git a/src/Migration/Service/MigrationDataFetcher.php b/src/Migration/Service/MigrationDataFetcher.php
@@ -35,10 +35,11 @@ public function fetchData(MigrationContextInterface $migrationContext, Context $
         try {
             return $this->gatewayRegistry->getGateway($migrationContext)->read($migrationContext);
         } catch (\Throwable $exception) {
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                     ->withExceptionMessage($exception->getMessage())
                     ->withExceptionTrace($exception->getTrace())
+                    ->withEntityName($dataSet::getEntity())
                     ->build(ExceptionRunLog::class)
             );
             $this->loggingService->saveLogging($context);
diff --git a/src/Migration/Service/MigrationDataWriter.php b/src/Migration/Service/MigrationDataWriter.php
@@ -105,10 +105,12 @@ public function writeData(MigrationContextInterface $migrationContext, Context $
             $currentWriter = $this->writerRegistry->getWriter($dataSet::getEntity());
             $currentWriter->writeData(\array_values($converted), $this->writeContext);
         } catch (WriterNotFoundException $writerNotFoundException) {
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                     ->withExceptionMessage($writerNotFoundException->getMessage())
                     ->withExceptionTrace($writerNotFoundException->getTrace())
+                    ->withConvertedData([$converted])
+                    ->withEntityName($dataSet::getEntity())
                     ->build(ExceptionRunLog::class)
             );
             $this->loggingService->saveLogging($context);
@@ -181,8 +183,12 @@ private function handleWriteException(
             $updateWrittenData[$dataId]['written'] = false;
             $updateWrittenData[$dataId]['writeFailure'] = true;
 
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
+                    ->withExceptionMessage($exception->getMessage())
+                    ->withExceptionTrace($exception->getTrace())
+                    ->withEntityName($entityName)
+                    ->withConvertedData($entity)
                     ->build(WriteExceptionRunLog::class)
             );
 
@@ -234,10 +240,12 @@ private function writePerEntity(
                 $currentWriter = $this->writerRegistry->getWriter($entityName);
                 $currentWriter->writeData([$entity], $this->writeContext);
             } catch (\Throwable $exception) {
-                $this->loggingService->addLogEntry( // TODO: add optional fields
+                $this->loggingService->addLogEntry(
                     SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
                         ->withExceptionMessage($exception->getMessage())
                         ->withExceptionTrace($exception->getTrace())
+                        ->withEntityName($entityName)
+                        ->withConvertedData([$entity])
                         ->build(ExceptionRunLog::class)
                 );
 
diff --git a/src/Migration/Subscriber/MessageQueueSubscriber.php b/src/Migration/Subscriber/MessageQueueSubscriber.php
@@ -89,7 +89,7 @@ public function onWorkerMessageFailed(WorkerMessageFailedEvent $event): void
          * Raise exception counter and log the exception
          */
         $progress->raiseExceptionCount();
-        $this->loggingService->addLogEntry( // TODO: add optional fields
+        $this->loggingService->addLogEntry(
             (new SwagMigrationLogBuilder(
                 $run->getId(),
                 $connection?->getProfileName() ?? 'unknown',
@@ -108,7 +108,7 @@ public function onWorkerMessageFailed(WorkerMessageFailedEvent $event): void
             $progress->setIsAborted(true);
             $this->updateRun($run->getId(), $progress, $message->getContext());
 
-            $this->loggingService->addLogEntry( // TODO: add optional fields
+            $this->loggingService->addLogEntry(
                 (new SwagMigrationLogBuilder(
                     $run->getId(),
                     $connection?->getProfileName() ?? 'unknown',
diff --git a/tests/Migration/Media/Process/HttpDownloadServiceBaseTest.php b/tests/Migration/Media/Process/HttpDownloadServiceBaseTest.php
@@ -17,6 +17,7 @@
 use Psr\Http\Message\StreamInterface;
 use Shopware\Core\Content\Media\File\FileSaver;
 use Shopware\Core\Content\Media\File\MediaFile;
+use Shopware\Core\Content\Media\MediaDefinition;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\Dbal\QueryBuilder;
 use Shopware\Core\Framework\Log\Package;
@@ -203,7 +204,7 @@ public function testProcessWithRequestFailure(): void
                 'profileName' => '',
                 'gatewayName' => '',
                 'userFixable' => false,
-                'entityName' => null,
+                'entityName' => MediaDefinition::ENTITY_NAME,
                 'fieldName' => null,
                 'fieldSourcePath' => null,
                 'sourceData' => null,
