feature #48379 [HttpKernel] Set a default file link format when none is provided to FileLinkFormatter (alexandre-daubois)

chalasr · chalasr · commit eed7a9cfb2e0 · 2022-12-04T19:05:09.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [HttpKernel] Set a default file link format when none is provided to FileLinkFormatter | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | _N/A_ | License | MIT | Doc PR | _N/A_ This change allow commands like `debug:route` to have clickable links. ![image](https://user-images.githubusercontent.com/2144837/204470917-0df8aeca-f71f-49b8-8f6b-57dbd2b7ed32.png) Link pointed by controller's action: `file:///home/alexandredaubois/PhpstormProjects/dummy_project/src/Controller/SomeController.php#L13` Commits ------- 269f4f1 [HttpKernel] Set a default file link format when none is provided to FileLinkFormatter
diff --git a/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php b/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php
@@ -35,7 +35,7 @@ class FileLinkFormatter
      */
     public function __construct(string|array $fileLinkFormat = null, RequestStack $requestStack = null, string $baseDir = null, string|\Closure $urlFormat = null)
     {
-        $fileLinkFormat ??= $_SERVER['SYMFONY_IDE'] ?? '';
+        $fileLinkFormat ??= $_SERVER['SYMFONY_IDE'] ?? 'file://%f#L%l';
         if (!\is_array($fileLinkFormat) && $fileLinkFormat = (ErrorRendererInterface::IDE_LINK_FORMATS[$fileLinkFormat] ?? $fileLinkFormat) ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: false) {
             $i = strpos($f = $fileLinkFormat, '&', max(strrpos($f, '%f'), strrpos($f, '%l'))) ?: \strlen($f);
             $fileLinkFormat = [substr($f, 0, $i)] + preg_split('/&([^>]++)>/', substr($f, $i), -1, \PREG_SPLIT_DELIM_CAPTURE);
diff --git a/src/Symfony/Component/HttpKernel/Tests/Debug/FileLinkFormatterTest.php b/src/Symfony/Component/HttpKernel/Tests/Debug/FileLinkFormatterTest.php
@@ -29,7 +29,7 @@ public function testAfterUnserialize()
     {
         $sut = unserialize(serialize(new FileLinkFormatter()));
 
-        $this->assertFalse($sut->format('/kernel/root/src/my/very/best/file.php', 3));
+        $this->assertSame('file:///kernel/root/src/my/very/best/file.php#L3', $sut->format('/kernel/root/src/my/very/best/file.php', 3));
     }
 
     public function testWhenFileLinkFormatAndNoRequest()

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ class FileLinkFormatter`
`35`	`35`	`*/`
`36`	`36`	`public function __construct(string\|array $fileLinkFormat = null, RequestStack $requestStack = null, string $baseDir = null, string\|\Closure $urlFormat = null)`
`37`	`37`	`{`
`38`		`- $fileLinkFormat ??= $_SERVER['SYMFONY_IDE'] ?? '';`
	`38`	`+ $fileLinkFormat ??= $_SERVER['SYMFONY_IDE'] ?? 'file://%f#L%l';`
`39`	`39`	`if (!\is_array($fileLinkFormat) && $fileLinkFormat = (ErrorRendererInterface::IDE_LINK_FORMATS[$fileLinkFormat] ?? $fileLinkFormat) ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: false) {`
`40`	`40`	`$i = strpos($f = $fileLinkFormat, '&', max(strrpos($f, '%f'), strrpos($f, '%l'))) ?: \strlen($f);`
`41`	`41`	`$fileLinkFormat = [substr($f, 0, $i)] + preg_split('/&([^>]++)>/', substr($f, $i), -1, \PREG_SPLIT_DELIM_CAPTURE);`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function testAfterUnserialize()`
`29`	`29`	`{`
`30`	`30`	`$sut = unserialize(serialize(new FileLinkFormatter()));`
`31`	`31`
`32`		`- $this->assertFalse($sut->format('/kernel/root/src/my/very/best/file.php', 3));`
	`32`	`+ $this->assertSame('file:///kernel/root/src/my/very/best/file.php#L3', $sut->format('/kernel/root/src/my/very/best/file.php', 3));`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public function testWhenFileLinkFormatAndNoRequest()`