Skip to content

NGSTACK-901 implement decorator service for variation path generator #51

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.

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

Open
wants to merge 3 commits into
base: 1.7
Choose a base branch
from
Open
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

declare(strict_types=1);

namespace Netgen\Bundle\SiteBundle\Core\Imagine\VariationPathGenerator;

use eZ\Bundle\EzPublishCoreBundle\Imagine\VariationPathGenerator;
use Liip\ImagineBundle\Imagine\Filter\FilterConfiguration;

use function pathinfo;
use function preg_replace;

/**
* Decorates VariationPathGenerator with .webp extension if image variation is configured for this format.
*/
final class WebpFormatVariationPathGenerator implements VariationPathGenerator
{
private VariationPathGenerator $innerVariationPathGenerator;

private FilterConfiguration $filterConfiguration;

public function __construct(
VariationPathGenerator $innerVariationPathGenerator,
FilterConfiguration $filterConfiguration
) {
$this->innerVariationPathGenerator = $innerVariationPathGenerator;
$this->filterConfiguration = $filterConfiguration;
}

public function getVariationPath($originalPath, $filter): string
{
$variationPath = $this->innerVariationPathGenerator->getVariationPath($originalPath, $filter);
$filterConfig = $this->filterConfiguration->get($filter);

if (!isset($filterConfig['format']) || $filterConfig['format'] !== 'webp') {
return $variationPath;
}

$info = pathinfo($originalPath);

if (!is_string($info['extension']) || strlen($info['extension']) === 0) {
return $variationPath . '.webp';
}

return preg_replace("/\.{$info['extension']}$/", '.webp', $variationPath);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

declare(strict_types=1);

namespace Netgen\Bundle\SiteBundle\DependencyInjection\Compiler;

use Netgen\Bundle\SiteBundle\Core\Imagine\VariationPathGenerator\WebpFormatVariationPathGenerator;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;

class WebpFormatVariationPathGeneratorDecoratorPass implements CompilerPassInterface
Copy link
Member

Choose a reason for hiding this comment

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

Do we really need the compiler pass just to register a decorator?

Can't we do this through the service config in YAML files?

Copy link
Member Author

Choose a reason for hiding this comment

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

Half of my life you force me to write compiler passes, now you want me to add it in the config 😆
I wasn't initially sure if we want to make the decorator service enabled by default, or if we will need to introduce a switch through configuration. @vjeran wants this enabled by default in both legacy admin and symfony/ezplatform, so maybe no need for the compiler pass.

Copy link
Member

Choose a reason for hiding this comment

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

Compiler passes should be used when modifying eixsting services! With this, we're not modifying an existing service, but adding a new one.

Besides, we're already using decorators directly in yaml files.

Copy link
Member Author

Choose a reason for hiding this comment

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

Let's leave it like this for consistency sake, as we will be using the compiler pass to actually decorate the existing variation path generator in Ibexa 4.x with our own service. If we are using 4.x in combination with legacy admin, then this is needed to consolidate variation path patterns to match the ones from legacy. The compiler pass in that case will replace ibexa decorator class with our own.

{
/**
* Decorates default image alias variation path generator to comply with legacy variation URL pattern
*/
public function process(ContainerBuilder $container): void
{
if (!$container->has('ezpublish.image_alias.variation_path_generator')) {
return;
}

$container->register(
'ezpublish.image_alias.webp_variation_path_generator_decorator',
WebpFormatVariationPathGenerator::class,
)
->setDecoratedService('ezpublish.image_alias.variation_path_generator')
->addArgument(new Reference('ezpublish.image_alias.webp_variation_path_generator_decorator.inner'))
->addArgument(new Reference('liip_imagine.filter.configuration'));
}
}
1 change: 1 addition & 0 deletions bundle/NetgenSiteBundle.php
Original file line number Diff line number Diff line change
@@ -20,5 +20,6 @@ public function build(ContainerBuilder $container): void
$container->addCompilerPass(new Compiler\LocationFactoryPass());
$container->addCompilerPass(new Compiler\AsseticPass());
$container->addCompilerPass(new Compiler\IoStorageAllowListPass());
$container->addCompilerPass(new Compiler\WebpFormatVariationPathGeneratorDecoratorPass());
}
}