[5.x] Antlers: Improves logging behavior when using the ray modifier (

#10680)
statamic · Aug 22, 2024 · cd5e263 · cd5e263
1 parent 5aafeba
commit cd5e263
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 2 deletions.
diff --git a/src/View/Antlers/Language/Runtime/ModifierManager.php b/src/View/Antlers/Language/Runtime/ModifierManager.php
@@ -16,6 +16,7 @@
 class ModifierManager
 {
     public static $statamicModifiers = null;
+    public static $lastModifierName = null;
     const METHOD_MODIFIER = '{__method_args}';
 
     public static function isModifier(ParameterNode $node)
@@ -27,8 +28,15 @@ public static function isModifier(ParameterNode $node)
         return array_key_exists($node->name, self::$statamicModifiers);
     }
 
+    public static function clearModifierState()
+    {
+        self::$lastModifierName = null;
+    }
+
     public static function guardRuntimeModifier($modifierName)
     {
+        self::$lastModifierName = $modifierName;
+
         if (GlobalRuntimeState::$isEvaluatingUserData) {
             $guardList = GlobalRuntimeState::$bannedContentModifierPaths;
         } else {
@@ -62,6 +70,8 @@ public static function guardRuntimeModifier($modifierName)
 
     public static function evaluate($value, Environment $env, ModifierChainNode $modifierChain, $context)
     {
+        self::clearModifierState();
+
         if (count($modifierChain->modifierChain) == 0) {
             return $value;
         }

diff --git a/src/View/Antlers/Language/Runtime/NodeProcessor.php b/src/View/Antlers/Language/Runtime/NodeProcessor.php
@@ -788,6 +788,15 @@ protected function isInternalTagLike(AntlersNode $node)
         return false;
     }
 
+    private function shouldReportArrayToStringWarning(): bool
+    {
+        if (ModifierManager::$lastModifierName === 'ray') {
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * Tests if the runtime should continue processing the node/value combination.
      *
@@ -810,8 +819,10 @@ private function guardRuntime(AntlersNode $node, $value)
 
             return false;
         } elseif ($this->isInterpolationProcessor == false && $this->isLoopable($value) && $node->isClosedBy == null) {
-            $varName = $node->name->getContent();
-            Log::debug("Cannot render an array variable as a string: {{ {$varName} }}", $this->getErrorLogContext($node));
+            if ($this->shouldReportArrayToStringWarning()) {
+                $varName = $node->name->getContent();
+                Log::debug("Cannot render an array variable as a string: {{ {$varName} }}", $this->getErrorLogContext($node));
+            }
 
             return false;
         } elseif (is_object($value) && $node->isClosedBy == null) {

diff --git a/src/View/Antlers/Language/Runtime/Sandbox/Environment.php b/src/View/Antlers/Language/Runtime/Sandbox/Environment.php
@@ -1249,6 +1249,8 @@ private function convertToRuntimeNumeric($value, $name)
      */
     private function scopeValue($name, $originalNode = null)
     {
+        ModifierManager::clearModifierState();
+
         if (! empty(GlobalRuntimeState::$prefixState)) {
             $this->dataRetriever->setHandlePrefixes(array_reverse(GlobalRuntimeState::$prefixState));
         }

diff --git a/tests/Antlers/Runtime/TemplateTest.php b/tests/Antlers/Runtime/TemplateTest.php
@@ -311,6 +311,31 @@ public function unclosed_array_variable_pairs_should_be_null()
         $this->assertEquals('', $this->renderString($template, $this->variables));
     }
 
+    #[Test]
+    public function unclosed_array_variable_does_not_report_warning_if_followed_by_ray_modifier()
+    {
+        Log::shouldReceive('debug')->never();
+
+        $template = '{{ simple | ray }}';
+
+        $this->assertEquals('', $this->renderString($template, $this->variables));
+    }
+
+    #[Test]
+    public function unclosed_array_variable_does_reports_warning_even_if_a_call_before_it_did_not()
+    {
+        // Test case to ensure the modifier state is cleared correctly.
+
+        Log::shouldReceive('debug')->once()
+            ->with('Cannot render an array variable as a string: {{ simple }}', [
+                'line' => 1, 'file' => '',
+            ]);
+
+        $template = '{{ simple | ray }}{{ simple }}';
+
+        $this->assertEquals('', $this->renderString($template, $this->variables));
+    }
+
     #[Test]
     public function single_condition()
     {