Prevent syntax issues if docs contains "*/"

Author: Kocal

src/Node/BlockNode.php

@@ -30,10 +30,17 @@ public function __construct(string $name, Node $body, int $lineno)
 
     public function compile(Compiler $compiler): void
     {
+        $docs = '';
+        if ($this->hasAttribute('docs')) {
+            // Escape */ to prevent closing the PHPDoc comment prematurely
+            $docsContent = str_replace('*/', '* /', $this->getAttribute('docs'));
+            $docs = ' * '.str_replace("\n", "\n * ", $docsContent)."\n";
+        }
+
         $compiler
             ->addDebugInfo($this)
             ->write("/**\n")
-            ->write($this->hasAttribute('docs') ? ' * '.str_replace("\n", "\n * ", $this->getAttribute('docs'))."\n" : '')
+            ->write($docs)
             ->write(" * @return iterable<null|scalar|\Stringable>\n")
             ->write(" */\n")
             ->write(\sprintf("public function block_%s(array \$context, array \$blocks = []): iterable\n", $this->getAttribute('name')), "{\n")

tests/Node/BlockTest.php

@@ -93,6 +93,24 @@ public function block_foo(array \$context, array \$blocks = []): iterable
 EOF, new Environment(new ArrayLoader()),
         ];
 
+        // block with docs containing */ (should be escaped)
+        $blockWithDocsContainingCommentEnd = new BlockNode('foo', new TextNode('foo', 1), 1);
+        $blockWithDocsContainingCommentEnd->setAttribute('docs', 'This contains */ which could break things');
+        $tests[] = [$blockWithDocsContainingCommentEnd, <<<EOF
+// line 1
+/**
+ * This contains * / which could break things
+ * @return iterable<null|scalar|\Stringable>
+ */
+public function block_foo(array \$context, array \$blocks = []): iterable
+{
+    \$macros = \$this->macros;
+    yield "foo";
+    yield from [];
+}
+EOF, new Environment(new ArrayLoader()),
+        ];
+
         return $tests;
     }
 }