From da847f8f62506e426349bc9f6cbaa257bfea490d Mon Sep 17 00:00:00 2001
From: Roman Rudavskyi <roman.rudavskyi@plumrocket.com>
Date: Sat, 5 Jun 2021 09:04:38 +0300
Subject: [PATCH] Add first version of transformers sequence

---
 .../Exception/InvalidTransformersSequence.php | 28 ++++++++++++++++++
 src/Optimizer/TransformationEngine.php        |  2 ++
 .../Transformer/PreloadHeroImage.php          | 10 ++++++-
 .../Transformer/ServerSideRendering.php       | 10 ++++++-
 src/Optimizer/TransformerProvides.php         | 14 +++++++++
 src/Optimizer/TransformerRequires.php         | 14 +++++++++
 .../TransformersSequenceValidator.php         | 29 +++++++++++++++++++
 7 files changed, 105 insertions(+), 2 deletions(-)
 create mode 100644 src/Optimizer/Exception/InvalidTransformersSequence.php
 create mode 100644 src/Optimizer/TransformerProvides.php
 create mode 100644 src/Optimizer/TransformerRequires.php
 create mode 100644 src/Optimizer/TransformersSequenceValidator.php

diff --git a/src/Optimizer/Exception/InvalidTransformersSequence.php b/src/Optimizer/Exception/InvalidTransformersSequence.php
new file mode 100644
index 000000000..ab913145d
--- /dev/null
+++ b/src/Optimizer/Exception/InvalidTransformersSequence.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace AmpProject\Optimizer\Exception;
+
+use DomainException;
+
+/**
+ * Exception thrown when an invalid transformer sequence is provided
+ * or missed transformer which required by another transformer.
+ *
+ * @package ampproject/amp-toolbox
+ */
+final class InvalidTransformersSequence extends DomainException implements AmpOptimizerException
+{
+
+    /**
+     * @param string $transformerClass
+     * @param array  $missingTags
+     * @return \AmpProject\Optimizer\Exception\InvalidTransformersSequence
+     */
+    public static function forTransformer($transformerClass, array $missingTags)
+    {
+        $tagList = implode(',', $missingTags);
+        $message = "Transformer '{$transformerClass}' must be after transformers that provide '{$tagList}' tags.";
+
+        return new self($message);
+    }
+}
diff --git a/src/Optimizer/TransformationEngine.php b/src/Optimizer/TransformationEngine.php
index 509d8bc5f..57e480a21 100644
--- a/src/Optimizer/TransformationEngine.php
+++ b/src/Optimizer/TransformationEngine.php
@@ -88,6 +88,8 @@ private function initializeTransformers()
     {
         $this->transformers = [];
 
+        TransformersSequenceValidator::validate($this->configuration->get(Configuration::KEY_TRANSFORMERS));
+
         foreach ($this->configuration->get(Configuration::KEY_TRANSFORMERS) as $transformerClass) {
             $this->transformers[$transformerClass] = new $transformerClass(
                 ...$this->getTransformerDependencies($transformerClass)
diff --git a/src/Optimizer/Transformer/PreloadHeroImage.php b/src/Optimizer/Transformer/PreloadHeroImage.php
index fb1949740..725d628b7 100644
--- a/src/Optimizer/Transformer/PreloadHeroImage.php
+++ b/src/Optimizer/Transformer/PreloadHeroImage.php
@@ -17,6 +17,7 @@
 use AmpProject\Optimizer\ImageDimensions;
 use AmpProject\Optimizer\Transformer;
 use AmpProject\Optimizer\TransformerConfiguration;
+use AmpProject\Optimizer\TransformerProvides;
 use AmpProject\RequestDestination;
 use AmpProject\Tag;
 use AmpProject\Url;
@@ -42,9 +43,11 @@
  *
  * @package ampproject/amp-toolbox
  */
-final class PreloadHeroImage implements Transformer
+final class PreloadHeroImage implements Transformer, TransformerProvides
 {
 
+    const TAG = 'preload_hero_image';
+
     /**
      * Class(es) to apply to a serverside-rendered image element.
      *
@@ -158,6 +161,11 @@ public function __construct(TransformerConfiguration $configuration)
         $this->configuration = $configuration;
     }
 
+    public static function provides()
+    {
+        return [self::TAG];
+    }
+
     /**
      * Apply transformations to the provided DOM document.
      *
diff --git a/src/Optimizer/Transformer/ServerSideRendering.php b/src/Optimizer/Transformer/ServerSideRendering.php
index d3b764c99..d0d3248d9 100644
--- a/src/Optimizer/Transformer/ServerSideRendering.php
+++ b/src/Optimizer/Transformer/ServerSideRendering.php
@@ -17,6 +17,7 @@
 use AmpProject\Optimizer\Exception\InvalidArgument;
 use AmpProject\Optimizer\Exception\InvalidHtmlAttribute;
 use AmpProject\Optimizer\Transformer;
+use AmpProject\Optimizer\TransformerRequires;
 use AmpProject\Role;
 use AmpProject\Tag;
 use DOMAttr;
@@ -37,9 +38,11 @@
  *
  * @package ampproject/amp-toolbox
  */
-final class ServerSideRendering implements Transformer
+final class ServerSideRendering implements Transformer, TransformerRequires
 {
 
+    const TAG = 'server_side_rendering';
+
     /**
      * List of layouts that support server-side rendering.
      *
@@ -94,6 +97,11 @@ final class ServerSideRendering implements Transformer
      */
     private $customCss;
 
+    public static function requires()
+    {
+        return [PreloadHeroImage::TAG];
+    }
+
     /**
      * Apply transformations to the provided DOM document.
      *
diff --git a/src/Optimizer/TransformerProvides.php b/src/Optimizer/TransformerProvides.php
new file mode 100644
index 000000000..ef8281aee
--- /dev/null
+++ b/src/Optimizer/TransformerProvides.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace AmpProject\Optimizer;
+
+interface TransformerProvides
+{
+
+    /**
+     * Return the collection of dependencies that this transformer provides.
+     *
+     * @return string[]
+     */
+    public static function provides();
+}
diff --git a/src/Optimizer/TransformerRequires.php b/src/Optimizer/TransformerRequires.php
new file mode 100644
index 000000000..f153209d9
--- /dev/null
+++ b/src/Optimizer/TransformerRequires.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace AmpProject\Optimizer;
+
+interface TransformerRequires
+{
+
+    /**
+     * Return the collection of dependencies that this transformer requires.
+     *
+     * @return string[]
+     */
+    public static function requires();
+}
diff --git a/src/Optimizer/TransformersSequenceValidator.php b/src/Optimizer/TransformersSequenceValidator.php
new file mode 100644
index 000000000..d8c92d7b0
--- /dev/null
+++ b/src/Optimizer/TransformersSequenceValidator.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace AmpProject\Optimizer;
+
+use AmpProject\Optimizer\Exception\InvalidTransformersSequence;
+
+class TransformersSequenceValidator
+{
+
+    /**
+     * @param string[] $transformers
+     */
+    public static function validate(array $transformers)
+    {
+        $providedTags = [];
+        foreach (array_values($transformers) as $transformerClass) {
+            if ($transformerClass instanceof TransformerRequires) {
+                $missingTags = array_diff($transformerClass::requires(), $providedTags);
+                if ($missingTags) {
+                    throw InvalidTransformersSequence::forTransformer($transformerClass, $missingTags);
+                }
+            }
+
+            if ($transformerClass instanceof TransformerProvides) {
+                $providedTags = array_merge($providedTags, $transformerClass::provides());
+            }
+        }
+    }
+}