Integration with JS client

- added possibility to render custom attributes on a banner tag - added rendering of data attribute `data-amp-banner-external` - fixed fingerprint resolving (now compatible with JS client) - added and fixed tests
68publishers · Nov 29, 2023 · d12decd · d12decd
1 parent 0fe5551
commit d12decd
Show file tree

Hide file tree

Showing 60 changed files with 382 additions and 112 deletions.
diff --git a/docs/integration-with-nette-framework.md b/docs/integration-with-nette-framework.md
@@ -111,7 +111,7 @@ Now we have the macro `{banner}` available in the application, and we can use it
 
 ```latte
 {banner homepage.top}
-{banner homepage.promo, ['role' => 'guest']}
+{banner homepage.promo, resources: ['role' => 'guest']}
 ```
 
 Banners are now requested via API and rendered to the template automatically.

diff --git a/docs/integration-without-framework.md b/docs/integration-without-framework.md
@@ -244,7 +244,7 @@ $engine->render(__DIR__ . '/template.latte');
 {* ./template.latte *}
 
 {banner homepage.top}
-{banner homepage.promo, ['role' => 'guest']}
+{banner homepage.promo, resources: ['role' => 'guest']}
 ```
 
 Banners are now requested via API and rendered to the template automatically.

diff --git a/src/Bridge/Latte/AmpClientLatte2Extension.php b/src/Bridge/Latte/AmpClientLatte2Extension.php
@@ -39,6 +39,6 @@ public function macroBanner(MacroNode $node, PhpWriter $writer): string
 
         return $writer
             ->using($node)
-            ->write('echo ($this->global->ampClientRenderer)($this->global, %node.word, %node.args?);');
+            ->write('echo ($this->global->ampClientRenderer)($this->global, %node.word, %node.array?);');
     }
 }
diff --git a/src/Bridge/Latte/Node/BannerNode.php b/src/Bridge/Latte/Node/BannerNode.php
@@ -6,6 +6,7 @@
 
 use Generator;
 use Latte\CompileException;
+use Latte\Compiler\Nodes\Php\Expression\ArrayNode;
 use Latte\Compiler\Nodes\Php\ExpressionNode;
 use Latte\Compiler\Nodes\StatementNode;
 use Latte\Compiler\PrintContext;
@@ -18,7 +19,7 @@ final class BannerNode extends StatementNode
 {
     public ExpressionNode $positionCode;
 
-    public ?ExpressionNode $resources = null;
+    public ?ArrayNode $options = null;
 
     /**
      * @throws CompileException
@@ -30,19 +31,19 @@ public static function create(Tag $tag): self
         $node->positionCode = $tag->parser->parseUnquotedStringOrExpression();
 
         if ($tag->parser->stream->tryConsume(',')) {
-            $node->resources = $tag->parser->parseExpression();
+            $node->options = $tag->parser->parseArguments();
         }
 
         return $node;
     }
 
     public function print(PrintContext $context): string
     {
-        if (null !== $this->resources) {
+        if (null !== $this->options) {
             return $context->format(
                 'echo ($this->global->ampClientRenderer)($this->global, %node, %node?);',
                 $this->positionCode,
-                $this->resources,
+                $this->options,
             );
         }
 
@@ -56,8 +57,8 @@ public function &getIterator(): Generator
     {
         yield $this->positionCode;
 
-        if (null !== $this->resources) {
-            yield $this->resources;
+        if (null !== $this->options) {
+            yield $this->options;
         }
     }
 }
diff --git a/src/Bridge/Latte/RendererProvider.php b/src/Bridge/Latte/RendererProvider.php
@@ -30,6 +30,8 @@
 
 final class RendererProvider
 {
+    private const OptionResources = 'resources';
+
     private AmpClientInterface $client;
 
     private RendererInterface $renderer;
@@ -62,13 +64,13 @@ public function __construct(
     }
 
     /**
-     * @param array<string, string|array<int, string>> $resources
+     * @param array<string, mixed> $options
      *
      * @throws AmpExceptionInterface
      */
-    public function __invoke(object $globals, string $positionCode, array $resources = []): string
+    public function __invoke(object $globals, string $positionCode, array $options = []): string
     {
-        $position = $this->createPosition($positionCode, $resources);
+        $position = $this->createPosition($positionCode, $options);
 
         if ($this->renderingMode->shouldBePositionQueued($position, $globals)) {
             return $this->addToQueue($position);
@@ -250,14 +252,15 @@ private function renderPosition(ResponsePosition $position): string
     }
 
     /**
-     * @param array<string, string|array<int, string>> $resources
+     * @param array<string, mixed> $options
      */
-    private function createPosition(string $positionCode, array $resources): RequestPosition
+    private function createPosition(string $positionCode, array $options): RequestPosition
     {
+        $resources = (array) ($options[self::OptionResources] ?? []);
         $bannerResources = [];
 
         foreach ($resources as $resourceCode => $resourceValues) {
-            $bannerResources[] = new BannerResource($resourceCode, $resourceValues);
+            $bannerResources[] = $resourceValues instanceof BannerResource ? $resourceValues : new BannerResource($resourceCode, $resourceValues);
         }
 
         return new RequestPosition($positionCode, $bannerResources);

diff --git a/src/Exception/RendererException.php b/src/Exception/RendererException.php
@@ -24,6 +24,19 @@ public static function unableToCreateFingerprint(string $positionCode, string $b
         );
     }
 
+    public static function unableToRenderAmpBannerExternalAttribute(string $positionCode, ?Throwable $previous = null): self
+    {
+        return new self(
+            sprintf(
+                'Unable to render amp-banner-external for the position %s. %s',
+                $positionCode,
+                null !== $previous ? $previous->getMessage() : '',
+            ),
+            0,
+            $previous,
+        );
+    }
+
     /**
      * @param class-string $rendererBridgeClassname
      */

diff --git a/src/Renderer/AmpBannerExternalAttribute.php b/src/Renderer/AmpBannerExternalAttribute.php
@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SixtyEightPublishers\AmpClient\Renderer;
+
+use JsonException;
+use SixtyEightPublishers\AmpClient\Exception\RendererException;
+use SixtyEightPublishers\AmpClient\Response\ValueObject\Position;
+
+final class AmpBannerExternalAttribute
+{
+    private Position $position;
+
+    private string $state;
+
+    private string $stateInfo;
+
+    private function __construct(Position $position, string $state, string $stateInfo)
+    {
+        $this->position = $position;
+        $this->state = $state;
+        $this->stateInfo = $stateInfo;
+    }
+
+    public static function rendered(Position $position): self
+    {
+        return new self($position, 'RENDERED', 'Banner was successfully rendered server-side.');
+    }
+
+    public static function notFound(Position $position): self
+    {
+        return new self($position, 'NOT_FOUND', 'Banner not found in fetched response on the server.');
+    }
+
+    public function __toString(): string
+    {
+        $components = [
+            'positionData' => [
+                'id' => $this->position->getId(),
+                'code' => $this->position->getCode(),
+                'name' => $this->position->getName(),
+                'rotationSeconds' => $this->position->getRotationSeconds(),
+                'displayType' => $this->position->getDisplayType(),
+                'breakpointType' => $this->position->getBreakpointType(),
+            ],
+            'state' => [
+                'value' => $this->state,
+                'info' => $this->stateInfo,
+            ],
+        ];
+
+        try {
+            $json = json_encode($components, JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+        } catch (JsonException $e) {
+            throw RendererException::unableToRenderAmpBannerExternalAttribute($this->position->getCode(), $e);
+        }
+
+        return base64_encode(
+            rawurlencode($json),
+        );
+    }
+}
diff --git a/src/Renderer/Fingerprint.php b/src/Renderer/Fingerprint.php
@@ -11,7 +11,6 @@
 use function base64_encode;
 use function json_encode;
 use function rawurlencode;
-use function rtrim;
 
 final class Fingerprint
 {
@@ -39,17 +38,14 @@ public static function create(Position $position, Banner $banner): self
         ];
 
         try {
-            $json = json_encode($components, JSON_THROW_ON_ERROR);
+            $json = json_encode($components, JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
         } catch (JsonException $e) {
             throw RendererException::unableToCreateFingerprint($position->getCode(), $banner->getId(), $e);
         }
 
         return new self(
-            rtrim(
-                base64_encode(
-                    rawurlencode($json),
-                ),
-                '=',
+            base64_encode(
+                rawurlencode($json),
             ),
         );
     }

diff --git a/src/Renderer/Latte/LatteRendererBridge.php b/src/Renderer/Latte/LatteRendererBridge.php
@@ -48,35 +48,35 @@ public function overrideTemplates(Templates $templates): self
         return $renderer;
     }
 
-    public function renderNotFound(Position $position): string
+    public function renderNotFound(Position $position, array $elementAttributes = []): string
     {
         return $this->getLatte()->renderToString(
             $this->templates->getTemplateFile(Templates::TemplateNotFound),
-            new NotFoundTemplate($position),
+            new NotFoundTemplate($position, $elementAttributes),
         );
     }
 
-    public function renderSingle(Position $position, ?Banner $banner): string
+    public function renderSingle(Position $position, ?Banner $banner, array $elementAttributes = []): string
     {
         return $this->getLatte()->renderToString(
             $this->templates->getTemplateFile(Templates::TemplateSingle),
-            new SingleTemplate($position, $banner),
+            new SingleTemplate($position, $banner, $elementAttributes),
         );
     }
 
-    public function renderRandom(Position $position, ?Banner $banner): string
+    public function renderRandom(Position $position, ?Banner $banner, array $elementAttributes = []): string
     {
         return $this->getLatte()->renderToString(
             $this->templates->getTemplateFile(Templates::TemplateRandom),
-            new RandomTemplate($position, $banner),
+            new RandomTemplate($position, $banner, $elementAttributes),
         );
     }
 
-    public function renderMultiple(Position $position, array $banners): string
+    public function renderMultiple(Position $position, array $banners, array $elementAttributes = []): string
     {
         return $this->getLatte()->renderToString(
             $this->templates->getTemplateFile(Templates::TemplateMultiple),
-            new MultipleTemplate($position, $banners),
+            new MultipleTemplate($position, $banners, $elementAttributes),
         );
     }
 

diff --git a/src/Renderer/Latte/Templates/MultipleTemplate.php b/src/Renderer/Latte/Templates/MultipleTemplate.php
@@ -14,14 +14,20 @@ final class MultipleTemplate
     /** @var array<int, Banner> */
     public array $banners;
 
+    /** @var array<string, scalar|null> */
+    public array $elementAttributes;
+
     /**
-     * @param array<int, Banner> $banners
+     * @param array<int, Banner>         $banners
+     * @param array<string, scalar|null> $elementAttributes
      */
     public function __construct(
         Position $position,
-        array $banners
+        array $banners,
+        array $elementAttributes
     ) {
         $this->position = $position;
         $this->banners = $banners;
+        $this->elementAttributes = $elementAttributes;
     }
 }
diff --git a/src/Renderer/Latte/Templates/NotFoundTemplate.php b/src/Renderer/Latte/Templates/NotFoundTemplate.php
@@ -10,9 +10,17 @@ final class NotFoundTemplate
 {
     public Position $position;
 
+    /** @var array<string, scalar|null> */
+    public array $elementAttributes;
+
+    /**
+     * @param array<string, scalar|null> $elementAttributes
+     */
     public function __construct(
-        Position $position
+        Position $position,
+        array $elementAttributes
     ) {
         $this->position = $position;
+        $this->elementAttributes = $elementAttributes;
     }
 }
diff --git a/src/Renderer/Latte/Templates/RandomTemplate.php b/src/Renderer/Latte/Templates/RandomTemplate.php
@@ -13,11 +13,19 @@ final class RandomTemplate
 
     public ?Banner $banner;
 
+    /** @var array<string, scalar|null> */
+    public array $elementAttributes;
+
+    /**
+     * @param array<string, scalar|null> $elementAttributes
+     */
     public function __construct(
         Position $position,
-        ?Banner $banner
+        ?Banner $banner,
+        array $elementAttributes
     ) {
         $this->position = $position;
         $this->banner = $banner;
+        $this->elementAttributes = $elementAttributes;
     }
 }
diff --git a/src/Renderer/Latte/Templates/SingleTemplate.php b/src/Renderer/Latte/Templates/SingleTemplate.php
@@ -13,11 +13,19 @@ final class SingleTemplate
 
     public ?Banner $banner;
 
+    /** @var array<string, scalar|null> */
+    public array $elementAttributes;
+
+    /**
+     * @param array<string, scalar|null> $elementAttributes
+     */
     public function __construct(
         Position $position,
-        ?Banner $banner
+        ?Banner $banner,
+        array $elementAttributes
     ) {
         $this->position = $position;
         $this->banner = $banner;
+        $this->elementAttributes = $elementAttributes;
     }
 }
diff --git a/src/Renderer/Latte/Templates/multiple.latte b/src/Renderer/Latte/Templates/multiple.latte
@@ -1,6 +1,8 @@
 {templateType SixtyEightPublishers\AmpClient\Renderer\Latte\Templates\MultipleTemplate}
 
-<div data-amp-banner="{$position->getCode()}" data-amp-attached>
+<div data-amp-banner="{$position->getCode()}"
+     data-amp-banner-external="{=SixtyEightPublishers\AmpClient\Renderer\AmpBannerExternalAttribute::rendered($position)}"
+     n:attr="$elementAttributes">
     {do $banners = array_filter($banners, fn(SixtyEightPublishers\AmpClient\Response\ValueObject\Banner $banner) => 0 < count($banner->getContents()))}
     <div n:if="0 < count($banners)" class="amp-banner amp-banner--multiple">
         <div class="amp-banner__list">

diff --git a/src/Renderer/Latte/Templates/notFound.latte b/src/Renderer/Latte/Templates/notFound.latte
@@ -1,3 +1,6 @@
 {templateType SixtyEightPublishers\AmpClient\Renderer\Latte\Templates\NotFoundTemplate}
 
-<div data-amp-banner="{$position->getCode()}" data-amp-attached></div>
+<div data-amp-banner="{$position->getCode()}"
+     data-amp-banner-external="{=SixtyEightPublishers\AmpClient\Renderer\AmpBannerExternalAttribute::notFound($position)}"
+     n:attr="$elementAttributes">
+</div>
diff --git a/src/Renderer/Latte/Templates/random.latte b/src/Renderer/Latte/Templates/random.latte
@@ -1,6 +1,8 @@
 {templateType SixtyEightPublishers\AmpClient\Renderer\Latte\Templates\RandomTemplate}
 
-<div data-amp-banner="{$position->getCode()}" data-amp-attached>
+<div data-amp-banner="{$position->getCode()}"
+     data-amp-banner-external="{=SixtyEightPublishers\AmpClient\Renderer\AmpBannerExternalAttribute::rendered($position)}"
+     n:attr="$elementAttributes">
     <div n:if="null !== $banner && 0 < count($banner->getContents())"
          class="amp-banner amp-banner--random"
          data-amp-banner-fingerprint="{SixtyEightPublishers\AmpClient\Renderer\Fingerprint::create($position, $banner)}"