improve error handling SchemaBuilder

lib/internal/Magento/Framework/Setup/Declaration/Schema/Db/SchemaBuilder.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright 2017 Adobe All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2017 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
@@ -16,6 +16,9 @@
 use Magento\Framework\Setup\Declaration\Schema\Sharding;
 use Magento\Framework\Config\FileResolverByModule;
 use Magento\Framework\Setup\Declaration\Schema\Declaration\ReaderComposite;
+use Psr\Log\LoggerInterface;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * This type of builder is responsible for converting ENTIRE data, that comes from db
@@ -27,6 +30,7 @@
  *
  * @see Schema
  * @inheritdoc
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class SchemaBuilder
 {
@@ -55,30 +59,39 @@ class SchemaBuilder
  */
  private $readerComposite;
 
+ /**
+ * @var LoggerInterface
+ */
+ private $logger;
+
  /**
  * Constructor.
  *
  * @param ElementFactory $elementFactory
  * @param DbSchemaReaderInterface $dbSchemaReader
  * @param Sharding $sharding
  * @param ReaderComposite $readerComposite
+ * @param LoggerInterface $logger
  */
  public function __construct(
  ElementFactory $elementFactory,
  DbSchemaReaderInterface $dbSchemaReader,
  Sharding $sharding,
- ReaderComposite $readerComposite
+ ReaderComposite $readerComposite,
+ ?LoggerInterface $logger = null
  ) {
  $this->elementFactory = $elementFactory;
  $this->dbSchemaReader = $dbSchemaReader;
  $this->sharding = $sharding;
  $this->readerComposite = $readerComposite;
+ $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
  }
 
  /**
  * @inheritdoc
  * @SuppressWarnings(PHPMD.CyclomaticComplexity)
  * @SuppressWarnings(PHPMD.NPathComplexity)
+ * @throws LocalizedException
  */
  public function build(Schema $schema)
  {
@@ -88,8 +101,22 @@ public function build(Schema $schema)
  foreach ($data['table'] as $keyTable => $tableColumns) {
  $tableColumns['column'] ??= [];
  foreach ($tableColumns['column'] as $keyColumn => $columnData) {
- if ($columnData['type'] == 'json') {
- $tablesWithJsonTypeField[$keyTable] = $keyColumn;
+ try {
+ if ($columnData['type'] == 'json') {
+ $tablesWithJsonTypeField[$keyTable] = $keyColumn;
+ }
+ } catch (\Throwable $e) {
+ // Create a new exception with extended context message
+ $errorMessage = sprintf(
+ "%s\nError processing table %s column %s",
+ $e->getMessage(),
+ $keyTable,
+ $keyColumn
+ );
+ $this->logger->error($errorMessage);
+ // Throw a new exception with the extended message
+ // This preserves the original error but adds our context
+ throw new LocalizedException(new Phrase($errorMessage));
  }
  }
  }

lib/internal/Magento/Framework/Setup/Test/Unit/Declaration/Schema/Db/SchemaBuilderTest.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright 2018 Adobe All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2018 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
@@ -25,6 +25,7 @@
 use PHPUnit\Framework\Exception;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 
 /**
  * Test for SchemaBuilder.
@@ -63,6 +64,11 @@ class SchemaBuilderTest extends TestCase
  */
  private $sqlVersionProvider;
 
+ /**
+ * @var LoggerInterface|MockObject
+ */
+ private $loggerMock;
+
  protected function setUp(): void
  {
  $this->elementFactoryMock = $this->getMockBuilder(ElementFactory::class)
@@ -401,11 +407,16 @@ public function testBuildHandlesMissingColumnsGracefully()
  ->method('read')
  ->willReturn($data);
 
+ $this->loggerMock = $this->getMockBuilder(LoggerInterface::class)
+ ->disableOriginalConstructor()
+ ->getMock();
+
  $schemaBuilder = new SchemaBuilder(
  $this->elementFactoryMock,
  $this->dbSchemaReaderMock,
  $this->shardingMock,
- $readerCompositeMock
+ $readerCompositeMock,
+ $this->loggerMock
  );
 
  $schemaBuilder->build($this->createMock(Schema::class));