Merge pull request #47 from netlogix/fix/expect-empty-arguments

Author: paxuclus

Classes/Scope/Extra/VariablesFromStackProvider.php

@@ -77,21 +77,39 @@ private function collectDataFromTrace(array $trace): Traversable
             if ($traceFunction !== $configFunction) {
                 continue;
             }
+
+            yield from self::buildReadableRepresentationOfTrace($configFunction, $argumentPaths, $trace);
+        }
+    }
+
+    /**
+     * @internal This method is only public because mocking \Throwable::getTrace() is not possible.
+     *
+     * @param string $callablePattern
+     * @param array<string, string> $argumentPaths
+     * @param array<mixed> $trace
+     * @return Traversable<mixed>
+     */
+    public static function buildReadableRepresentationOfTrace(string $callablePattern, array $argumentPaths, array $trace): Traversable
+    {
+        if (!isset($trace['args'])) {
+            yield [$callablePattern => ['💥' => 'Argument tracing is disabled. To enable, set `zend.exception_ignore_args=0` ⚙️']];
+        } else {
             $values = [];
             foreach ($argumentPaths as $argumentPathName => $argumentPathLookup) {
                 try {
-                    $values[$argumentPathName] = $this->representationSerialize(
+                    $values[$argumentPathName] = self::representationSerialize(
                         ObjectAccess::getPropertyPath($trace['args'], $argumentPathLookup)
                     );
                 } catch (Throwable $t) {
                     $values[$argumentPathName] = '👻';
                 }
             }
-            yield [$configFunction => $values];
+            yield [$callablePattern => $values];
         }
     }
 
-    private function representationSerialize($value)
+    private static function representationSerialize($value)
     {
         static $representationSerialize;
 
@@ -136,8 +154,14 @@ private function getSettings(): Traversable
 
             $reflection = new MethodReflection($className, $methodName);
             foreach ($reflection->getParameters() as $parameter) {
-                $search = sprintf('/^%s./', $parameter->getName());
-                $replace = sprintf('%d.', $parameter->getPosition());
+                $search = [
+                    sprintf('/^%s\\./', $parameter->getName()),
+                    sprintf('/^%s$/', $parameter->getName()),
+                ];
+                $replace = [
+                    sprintf('%d.', $parameter->getPosition()),
+                    $parameter->getPosition(),
+                ];
                 $argumentPaths = preg_replace($search, $replace, $argumentPaths);
             }
 

Tests/Unit/Scope/Extra/VariablesFromStackProviderTest.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netlogix\Sentry\Tests\Unit\Scope\Extra;
+
+use Neos\Flow\Tests\UnitTestCase;
+use Netlogix\Sentry\Scope\Extra\VariablesFromStackProvider;
+
+use function iterator_to_array;
+
+class VariablesFromStackProviderTest extends UnitTestCase
+{
+    /**
+     * @test
+     */
+    public function Render_simple_values_as_single_line_information(): void
+    {
+        $result = iterator_to_array(
+            VariablesFromStackProvider::buildReadableRepresentationOfTrace(
+                'foo::bar()',
+                [
+                    'baz' => '0'
+                ],
+                [
+                    'args' => [
+                        'some value'
+                    ]
+                ]
+            )
+        );
+
+        self::assertEquals([
+            [
+                'foo::bar()' => [
+                    'baz' => 'some value'
+                ]
+            ]
+        ], $result);
+    }
+
+    /**
+     * @test
+     */
+    public function Render_complex_values_as_multi_line_information(): void
+    {
+        $result = iterator_to_array(
+            VariablesFromStackProvider::buildReadableRepresentationOfTrace(
+                'foo::bar()',
+                [
+                    'baz.name' => '0.name',
+                    'baz.gender' => '0.gender',
+                ],
+                [
+                    'args' => [
+                        [
+                            'name' => 'Stephan',
+                            'gender' => 'male'
+                        ]
+                    ]
+                ]
+            )
+        );
+
+        self::assertEquals([
+            [
+                'foo::bar()' => [
+                    'baz.name' => 'Stephan',
+                    'baz.gender' => 'male',
+                ]
+            ]
+        ], $result);
+    }
+
+    /**
+     * @test
+     */
+    public function Render_special_message_when_frames_dont_contain_method_arguments(): void
+    {
+        $result = iterator_to_array(
+            VariablesFromStackProvider::buildReadableRepresentationOfTrace(
+                'foo::bar()',
+                [
+                    'baz' => '0'
+                ],
+                []
+            )
+        );
+
+        self::assertEquals([
+            [
+                'foo::bar()' => [
+                    '💥' => 'Argument tracing is disabled. To enable, set `zend.exception_ignore_args=0` ⚙️'
+                ]
+            ]
+        ], $result);
+    }
+}