Issue #3375843 by lussoluca, e0ipso, smustgrave, DieterHolvoet: Allow other...

Issue #3375843 by lussoluca, e0ipso, smustgrave, DieterHolvoet: Allow other Twig node visitors to modify 'display_start' and 'display_end'

core/modules/sdc/src/Twig/ComponentNodeVisitor.php

@@ -71,15 +71,25 @@ public function leaveNode(Node $node, Environment $env): ?Node {
       new Node([new ConstantExpression($component_id, $line)]),
       $line
     ), $line);
-    foreach ($print_nodes as $index => $print_node) {
-      $node->getNode('display_start')->setNode((string) $index, $print_node);
-    }
+
+    // Append the print nodes to the display_start node.
+    $node->setNode(
+      'display_start',
+      new Node([
+        $node->getNode('display_start'),
+        ...$print_nodes,
+      ]),
+    );
+
     if ($env->isDebug()) {
-      $node->getNode('display_end')
-        ->setNode(
-          '0',
-          new PrintNode(new ConstantExpression(sprintf('<!-- %s Component end: %s -->', $emoji, $component_id), $line), $line)
-        );
+      // Append the closing comment to the display_end node.
+      $node->setNode(
+        'display_end',
+        new Node([
+          new PrintNode(new ConstantExpression(sprintf('<!-- %s Component end: %s -->', $emoji, $component_id), $line), $line),
+          $node->getNode('display_end'),
+        ])
+      );
     }
     // Slots can be validated at compile time, we don't need to add nodes to
     // execute functions during display with the actual data.

core/modules/sdc/tests/modules/sdc_other_node_visitor/sdc_other_node_visitor.info.yml

+name: 'Add another node visitor'
+type: module
+dependencies:
+  - sdc:sdc
+package: Testing

core/modules/sdc/tests/modules/sdc_other_node_visitor/sdc_other_node_visitor.services.yml

+services:
+  sdc_other_node_visitor.twig.extension.profiler:
+    class: Drupal\sdc_other_node_visitor\Twig\Extension\TestProfilerExtension
+    tags:
+      - { name: twig.extension, priority: 100 }

core/modules/sdc/tests/modules/sdc_other_node_visitor/src/Twig/Extension/TestProfilerExtension.php

+<?php
+
+namespace Drupal\sdc_other_node_visitor\Twig\Extension;
+
+use Drupal\sdc_other_node_visitor\Twig\NodeVisitor\TestNodeVisitor;
+use Twig\Extension\AbstractExtension;
+
+/**
+ * Twig extension to add a test node visitor.
+ */
+class TestProfilerExtension extends AbstractExtension {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getNodeVisitors(): array {
+    return [new TestNodeVisitor(static::class)];
+  }
+
+  /**
+   * Dummy function called when a Twig template is entered.
+   */
+  public function enter() {
+    // NOOP.
+  }
+
+  /**
+   * Dummy function called when a Twig template is left.
+   */
+  public function leave() {
+    // NOOP.
+  }
+
+}

core/modules/sdc/tests/modules/sdc_other_node_visitor/src/Twig/NodeVisitor/TestNodeVisitor.php

+<?php
+
+namespace Drupal\sdc_other_node_visitor\Twig\NodeVisitor;
+
+use Drupal\sdc_other_node_visitor\Twig\Profiler\EnterProfileNode;
+use Drupal\sdc_other_node_visitor\Twig\Profiler\LeaveProfileNode;
+use Twig\Environment;
+use Twig\Node\ModuleNode;
+use Twig\Node\Node;
+use Twig\NodeVisitor\NodeVisitorInterface;
+
+/**
+ * A node visitor that adds nodes to the Twig template.
+ *
+ * Most of this code is copied from
+ * Twig\Profiler\NodeVisitor\ProfilerNodeVisitor.
+ */
+final class TestNodeVisitor implements NodeVisitorInterface {
+
+  private string $extensionName;
+
+  private string $varName;
+
+  /**
+   * TestNodeVisitor constructor.
+   *
+   * @param string $extensionName
+   *   The name of the extension.
+   */
+  public function __construct(string $extensionName) {
+    $this->extensionName = $extensionName;
+    $this->varName = sprintf('__internal_%s', hash(\PHP_VERSION_ID < 80100 ? 'sha256' : 'xxh128', $extensionName));
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function enterNode(Node $node, Environment $env): Node {
+    return $node;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function leaveNode(Node $node, Environment $env): ?Node {
+    if ($node instanceof ModuleNode) {
+      $node->setNode('display_start', new Node([
+        new EnterProfileNode($this->extensionName, $this->varName),
+        $node->getNode('display_start'),
+      ]));
+      $node->setNode('display_end', new Node([
+        new LeaveProfileNode($this->varName),
+        $node->getNode('display_end'),
+      ]));
+    }
+
+    return $node;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getPriority(): int {
+    return 0;
+  }
+
+}

core/modules/sdc/tests/modules/sdc_other_node_visitor/src/Twig/Profiler/EnterProfileNode.php

+<?php
+
+namespace Drupal\sdc_other_node_visitor\Twig\Profiler;
+
+use Twig\Compiler;
+use Twig\Node\Node;
+
+/**
+ * Represents a profile enter node.
+ */
+class EnterProfileNode extends Node {
+
+  public function __construct(string $extensionName, string $varName) {
+    parent::__construct([], [
+      'extension_name' => $extensionName,
+      'var_name' => $varName,
+    ]);
+  }
+
+  public function compile(Compiler $compiler): void {
+    $compiler
+      ->write(sprintf('$%s = $this->extensions[', $this->getAttribute('var_name')))
+      /* cspell:disable-next-line */
+      ->repr($this->getAttribute('extension_name'))
+      ->raw("];\n")
+      ->write(sprintf('$%s->enter();', $this->getAttribute('var_name')))
+      ->raw("\n\n");
+  }
+
+}

core/modules/sdc/tests/modules/sdc_other_node_visitor/src/Twig/Profiler/LeaveProfileNode.php

+<?php
+
+namespace Drupal\sdc_other_node_visitor\Twig\Profiler;
+
+use Twig\Compiler;
+use Twig\Node\Node;
+
+/**
+ * Represents a profile leave node.
+ */
+class LeaveProfileNode extends Node {
+
+  public function __construct(string $varName) {
+    parent::__construct([], ['var_name' => $varName]);
+  }
+
+  public function compile(Compiler $compiler): void {
+    $compiler
+      ->write("\n")
+      ->write(sprintf("\$%s->leave();\n\n", $this->getAttribute('var_name')));
+  }
+
+}

core/modules/sdc/tests/src/Kernel/ComponentNodeVisitorTest.php

+<?php
+
+namespace Drupal\Tests\sdc\Kernel;
+
+/**
+ * Tests the node visitor.
+ *
+ * @coversDefaultClass \Drupal\sdc\Twig\ComponentNodeVisitor
+ * @group sdc
+ *
+ * @internal
+ */
+final class ComponentNodeVisitorTest extends ComponentKernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = ['sdc', 'sdc_other_node_visitor'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $themes = ['sdc_theme_test'];
+
+  /**
+   * Test that other visitors can modify Twig nodes.
+   */
+  public function testOtherVisitorsCanModifyTwigNodes(): void {
+    $build = [
+      '#type' => 'inline_template',
+      '#template' => "{% embed('sdc_theme_test_base:my-card-no-schema') %}{% block card_body %}Foo bar{% endblock %}{% endembed %}",
+    ];
+    $this->renderComponentRenderArray($build);
+
+    // If this is reached, the test passed.
+    $this->assertTrue(TRUE);
+  }
+
+}