Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ProviderDataTransformer: throw TransformationFailedException on error #2444

Merged
merged 1 commit into from
Mar 8, 2024
Merged

ProviderDataTransformer: throw TransformationFailedException on error #2444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions src/Form/DataTransformer/ProviderDataTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,21 @@

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;
use Sonata\MediaBundle\Model\MediaInterface;
use Sonata\MediaBundle\Provider\Pool;
use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Exception\TransformationFailedException;

/**
* @implements DataTransformerInterface<MediaInterface, MediaInterface>
*
* NEXT_MAJOR: remove LoggerAwareInterface interface
*/
final class ProviderDataTransformer implements DataTransformerInterface, LoggerAwareInterface
{
/**
* NEXT_MAJOR: remove this trait.
*/
use LoggerAwareTrait;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a BC break.

If someone called setLogger it will crash.

Might be better to keep LoggerAwareInterface and LoggerAwareTrait with a NEXT_MAJOR comment "Remove them".


/**
Expand Down Expand Up @@ -68,6 +73,8 @@ public function transform($value): mixed
/**
* @param mixed $value
*
* @throws TransformationFailedException when the transformation fails
*
* @phpstan-param MediaInterface|null $value
* @phpstan-return MediaInterface|null
*/
Expand Down Expand Up @@ -116,15 +123,7 @@ public function reverseTransform($value): mixed
try {
$provider->transform($newMedia);
} catch (\Throwable $e) {
$logger = $this->logger ?? new NullLogger();

// #1107 We must never throw an exception here.
// An exception here would prevent us to provide meaningful errors through the Form
// Error message inspired from Monolog\ErrorHandler
$logger->error(
sprintf('Caught Exception %s: "%s" at %s line %s', $e::class, $e->getMessage(), $e->getFile(), $e->getLine()),
['exception' => $e]
);
throw new TransformationFailedException($e->getMessage(), 0, $e, $e->getMessage());
}

return $newMedia;
Expand Down
2 changes: 0 additions & 2 deletions src/Form/Type/MediaType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;
use Sonata\MediaBundle\Form\DataTransformer\ProviderDataTransformer;
use Sonata\MediaBundle\Model\MediaInterface;
use Sonata\MediaBundle\Provider\Pool;
Expand Down Expand Up @@ -53,7 +52,6 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
'empty_on_new' => $options['empty_on_new'],
'new_on_update' => $options['new_on_update'],
]);
$dataTransformer->setLogger($this->logger ?? new NullLogger());

$builder->addModelTransformer($dataTransformer);

Expand Down
27 changes: 3 additions & 24 deletions tests/Form/DataTransformer/ProviderDataTransformerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
namespace Sonata\MediaBundle\Tests\Form\DataTransformer;

use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
use Sonata\MediaBundle\Form\DataTransformer\ProviderDataTransformer;
use Sonata\MediaBundle\Model\MediaInterface;
use Sonata\MediaBundle\Provider\MediaProviderInterface;
use Sonata\MediaBundle\Provider\Pool;
use Symfony\Component\Form\Exception\TransformationFailedException;
use Symfony\Component\HttpFoundation\File\UploadedFile;

class ProviderDataTransformerTest extends TestCase
Expand Down Expand Up @@ -124,36 +124,16 @@ public function testReverseTransformWithMediaAndUploadFileInstance(): void
$transformer->reverseTransform($media);
}

public function testReverseTransformWithThrowingProviderNoThrow(): void
public function testReverseTransformWithThrowingProviderThrowTransformationFailedException(): void
{
$provider = $this->createMock(MediaProviderInterface::class);
$provider->expects(static::once())->method('transform')->will(static::throwException(new \Exception()));

$pool = new Pool('default');
$pool->addProvider('default', $provider);

$media = $this->createMock(MediaInterface::class);
$media->expects(static::exactly(3))->method('getProviderName')->willReturn('default');
$media->method('getId')->willReturn(1);
$media->method('getBinaryContent')->willReturn(new UploadedFile(__FILE__, 'ProviderDataTransformerTest'));
$this->expectException(TransformationFailedException::class);

$transformer = new ProviderDataTransformer($pool, MediaInterface::class, [
'new_on_update' => false,
]);
$transformer->reverseTransform($media);
}

public function testReverseTransformWithThrowingProviderLogsException(): void
{
$provider = $this->createMock(MediaProviderInterface::class);
$provider->expects(static::once())->method('transform')->will(static::throwException(new \Exception()));

$pool = new Pool('default');
$pool->addProvider('default', $provider);

$logger = $this->createMock(LoggerInterface::class);
$logger->expects(static::once())->method('error');

$media = $this->createMock(MediaInterface::class);
$media->expects(static::exactly(3))->method('getProviderName')->willReturn('default');
$media->method('getId')->willReturn(1);
Expand All @@ -162,7 +142,6 @@ public function testReverseTransformWithThrowingProviderLogsException(): void
$transformer = new ProviderDataTransformer($pool, MediaInterface::class, [
'new_on_update' => false,
]);
$transformer->setLogger($logger);
$transformer->reverseTransform($media);
}
}
Loading