feat: add iterative log building helper (#48)

Author: larskemper

src/Migration/Logging/LoggingService.php

@@ -71,6 +71,21 @@ public function addLogEntry(SwagMigrationLogEntry $logEntry): void
         ];
     }
 
+    /**
+     * @param array<array-key, mixed> $keys
+     * @param callable(array-key $key, mixed|null $value): SwagMigrationLogEntry $callback
+     */
+    public function addLogForEach(array $keys, callable $callback): void
+    {
+        foreach ($keys as $key => $value) {
+            if (\array_is_list($keys)) {
+                $this->addLogEntry($callback($value, null));
+            } else {
+                $this->addLogEntry($callback($key, $value));
+            }
+        }
+    }
+
     private function writePerEntry(Context $context): void
     {
         foreach ($this->logging as $log) {

src/Migration/Logging/LoggingServiceInterface.php

@@ -16,5 +16,11 @@ interface LoggingServiceInterface
 {
     public function addLogEntry(SwagMigrationLogEntry $logEntry): void;
 
+    /**
+     * @param array<array-key, mixed> $keys
+     * @param callable(array-key $key, mixed|null $value): SwagMigrationLogEntry $callback
+     */
+    public function addLogForEach(array $keys, callable $callback): void;
+
     public function saveLogging(Context $context): void;
 }

src/Migration/Service/MediaFileProcessorService.php

@@ -131,7 +131,7 @@ private function addMessageToBus(string $runUuid, Context $context, DataSet $dat
 
     private function logDataSetNotFoundException(
         MigrationContextInterface $migrationContext,
-        \Throwable $exception
+        \Throwable $exception,
     ): void {
         $this->loggingService->addLogEntry(
             SwagMigrationLogBuilder::fromMigrationContext($migrationContext)

src/Profile/Shopware/Converter/NewsletterRecipientConverter.php

@@ -7,6 +7,7 @@
 
 namespace SwagMigrationAssistant\Profile\Shopware\Converter;
 
+use Shopware\Core\Content\Newsletter\Aggregate\NewsletterRecipient\NewsletterRecipientDefinition;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\Log\Package;
 use Shopware\Core\Framework\Uuid\Uuid;
@@ -63,13 +64,17 @@ public function convert(
         $fields = $this->checkForEmptyRequiredDataFields($data, $this->requiredDataFieldKeys);
 
         if (!empty($fields)) {
-            $this->loggingService->addLogEntry( // TODO: add optional fields
-                SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
+            $this->loggingService->addLogForEach(
+                $fields,
+                fn (string $key) => SwagMigrationLogBuilder::fromMigrationContext($migrationContext)
+                    ->withEntityName(NewsletterRecipientDefinition::ENTITY_NAME)
+                    ->withFieldName($key)
                     ->build(EmptyNecessaryFieldRunLog::class)
             );
 
             return new ConvertStruct(null, $data);
         }
+
         $oldData = $data;
         $this->generateChecksum($data);
         $this->context = $context;