[ErrorHandler] Improve fileLinkFormat handling

[nlemoine]

Q	A
Branch?	6.4
Bug fix?	no
New feature?	yes
Deprecations?	yes
Tickets	Fix #50619
License	MIT
Doc PR

• Avoid repeating file link format guessing (logic is already in FileLinkFormatter class)
• Always set a fileLinkFormat to a FileLinkFormatter object to handle path mappings properly

[carsonbot]

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

• Always add tests
• Keep backward compatibility (see https://symfony.com/bc).
• Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
• Features and deprecations must be submitted against the 6.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

[GromNaN]

Using the Symfony\Component\HttpKernel\Debug\FileLinkFormatter in Symfony\Component\ErrorHandler\ErrorRenderer\HtmlErrorRenderer is a good idea, but the 2 classes are not in the same composer packages.
I think the FileLinkFormatter should be moved to symfony/error-handler: this package is already required by symfony/http-kernel, but not in the other direction.

This can be done in a backward-compatible way by replacing the class with:

namespace Symfony\Component\HttpKernel\Debug;

use Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter as NewFileLinkFormatter;

/** @deprecated since 6.4, use Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter */
class FileLinkFormatter extends NewFileLinkFormatter
{
    // Inherit all the methods from the parent
}

I'll just ask @symfony/mergers opinion before you can start editing if you wish.

[nlemoine]

Using the Symfony\Component\HttpKernel\Debug\FileLinkFormatter in Symfony\Component\ErrorHandler\ErrorRenderer\HtmlErrorRenderer is a good idea, but the 2 classes are not in the same composer packages.

That would be great! My original issue about was actually aiming to consolidate file link formatting and make it more consistent across components. Some business logic, that's already contained in FileLinkFormatter class, is repeated in various places:

• symfony/src/Symfony/Bridge/Twig/Extension/CodeExtension.php

  Line 31 in 81c102d

  $this->fileLinkFormat = $fileLinkFormat ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');

• symfony/src/Symfony/Component/VarDumper/Dumper/CliDumper.php

  Line 84 in 81c102d

  $this->displayOptions['fileLinkFormat'] = \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: 'file://%f#L%l';

• symfony/src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php

  Line 48 in 81c102d

  $fileLinkFormat = $fileLinkFormat ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');

• symfony/src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php

  Line 81 in 81c102d

  $this->displayOptions['fileLinkFormat'] = \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');

Probably all those statements could be replaced with something like (long version):

if ($fileLinkFormat instanceof FileLinkFormatter) {
    $this->fileLinkFormat = $fileLinkFormat;
} else {
    $this->fileLinkFormat = class_exists(FileLinkFormatter::class) ? new FileLinkFormatter() : $fileLinkFormat;
}

What do you think @GromNaN?

I'll just ask @symfony/mergers opinion before you can start editing if you wish.

That would be welcome!

[nicolas-grekas]

I updated all references to the deprecated namespace.
This should be good to do (despite tests)

[fabpot]

Thank you @nlemoine.

[nlemoine]

Great, thanks!