[Security] Display authenticators laziness and exception in the profiler

MatTheCat · MatTheCat · commit 7d8c8e170141 · 2024-06-19T11:54:12.000+02:00
diff --git a/src/Symfony/Bundle/SecurityBundle/Resources/views/Collector/security.html.twig b/src/Symfony/Bundle/SecurityBundle/Resources/views/Collector/security.html.twig
@@ -340,10 +340,12 @@
                             <tr>
                                 <th>Authenticator</th>
                                 <th>Supports</th>
+                                <th>Lazy</th>
                                 <th>Authenticated</th>
                                 <th>Duration</th>
                                 <th>Passport</th>
                                 <th>Badges</th>
+                                <th>Exception</th>
                             </tr>
                             </thead>
 
@@ -361,7 +363,8 @@
                                 <tr>
                                     <td class="font-normal">{{ profiler_dump(authenticator.stub) }}</td>
                                     <td class="no-wrap">{{ source('@WebProfiler/Icon/' ~ (authenticator.supports ? 'yes' : 'no') ~ '.svg') }}</td>
-                                    <td class="no-wrap">{{ authenticator.authenticated is not null ? source('@WebProfiler/Icon/' ~ (authenticator.authenticated ? 'yes' : 'no') ~ '.svg') : '' }}</td>
+                                    <td class="no-wrap">{{ authenticator.lazy is not null ? source('@WebProfiler/Icon/' ~ (authenticator.lazy ? 'yes' : 'no') ~ '.svg') }}</td>
+                                    <td class="no-wrap">{{ authenticator.authenticated is not null ? source('@WebProfiler/Icon/' ~ (authenticator.authenticated ? 'yes' : 'no') ~ '.svg') }}</td>
                                     <td class="no-wrap">{{ authenticator.duration is null ? '(none)' : '%0.2f ms'|format(authenticator.duration * 1000) }}</td>
                                     <td class="font-normal">{{ authenticator.passport ? profiler_dump(authenticator.passport) : '(none)' }}</td>
                                     <td class="font-normal">
@@ -373,6 +376,7 @@
                                             (none)
                                         {% endfor %}
                                     </td>
+                                    <td class="font-normal">{{ authenticator.exception ? profiler_dump(authenticator.exception) : '(none)' }}</td>
                                 </tr>
 
                                 {% if loop.last %}
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticator.php b/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticator.php
@@ -34,6 +34,8 @@ final class TraceableAuthenticator implements AuthenticatorInterface, Interactiv
     private ?float $duration = null;
     private ClassStub|string $stub;
     private ?bool $authenticated = null;
+    private ?bool $lazy = null;
+    private ?AuthenticationException $exception = null;
 
     public function __construct(private AuthenticatorInterface $authenticator)
     {
@@ -56,12 +58,18 @@ static function (BadgeInterface $badge): array {
                 },
                 $this->passport?->getBadges() ?? [],
             ),
+            'lazy' => $this->lazy,
+            'exception' => $this->exception,
         ];
     }
 
     public function supports(Request $request): ?bool
     {
-        return $this->authenticator->supports($request);
+        $supports = $this->authenticator->supports($request);
+
+        $this->lazy = null === $supports;
+
+        return $supports;
     }
 
     public function authenticate(Request $request): Passport
@@ -88,6 +96,7 @@ public function onAuthenticationSuccess(Request $request, TokenInterface $token,
     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
     {
         $this->authenticated = false;
+        $this->exception = $exception->getPrevious() instanceof AuthenticationException ? $exception->getPrevious() : $exception;
 
         return $this->authenticator->onAuthenticationFailure($request, $exception);
     }
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticatorManagerListener.php b/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticatorManagerListener.php
@@ -55,6 +55,8 @@ public function authenticate(RequestEvent $event): void
                 'duration' => 0,
                 'authenticated' => null,
                 'badges' => [],
+                'lazy' => null,
+                'exception' => null,
             ];
         }
 

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,8 @@ final class TraceableAuthenticator implements AuthenticatorInterface, Interactiv`
`34`	`34`	`private ?float $duration = null;`
`35`	`35`	`private ClassStub\|string $stub;`
`36`	`36`	`private ?bool $authenticated = null;`
	`37`	`+ private ?bool $lazy = null;`
	`38`	`+ private ?AuthenticationException $exception = null;`
`37`	`39`
`38`	`40`	`public function __construct(private AuthenticatorInterface $authenticator)`
`39`	`41`	`{`
`@@ -56,12 +58,18 @@ static function (BadgeInterface $badge): array {`
`56`	`58`	`},`
`57`	`59`	`$this->passport?->getBadges() ?? [],`
`58`	`60`	`),`
	`61`	`+ 'lazy' => $this->lazy,`
	`62`	`+ 'exception' => $this->exception,`
`59`	`63`	`];`
`60`	`64`	`}`
`61`	`65`
`62`	`66`	`public function supports(Request $request): ?bool`
`63`	`67`	`{`
`64`		`- return $this->authenticator->supports($request);`
	`68`	`+ $supports = $this->authenticator->supports($request);`
	`69`	`+`
	`70`	`+ $this->lazy = null === $supports;`
	`71`	`+`
	`72`	`+ return $supports;`
`65`	`73`	`}`
`66`	`74`
`67`	`75`	`public function authenticate(Request $request): Passport`
`@@ -88,6 +96,7 @@ public function onAuthenticationSuccess(Request $request, TokenInterface $token,`
`88`	`96`	`public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response`
`89`	`97`	`{`
`90`	`98`	`$this->authenticated = false;`
	`99`	`+ $this->exception = $exception->getPrevious() instanceof AuthenticationException ? $exception->getPrevious() : $exception;`
`91`	`100`
`92`	`101`	`return $this->authenticator->onAuthenticationFailure($request, $exception);`
`93`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,8 @@ public function authenticate(RequestEvent $event): void`
`55`	`55`	`'duration' => 0,`
`56`	`56`	`'authenticated' => null,`
`57`	`57`	`'badges' => [],`
	`58`	`+ 'lazy' => null,`
	`59`	`+ 'exception' => null,`
`58`	`60`	`];`
`59`	`61`	`}`
`60`	`62`