Multiple variables in @psalm-trace

[rarila]

Psalm did allow multiple variables in @psalm-trace but failed to add multiple trace issues to the same place.

That way, both cases in this example fail:

https://psalm.dev/r/31262a113f

Additional to fixing this bug, I’ve added the ability to use a comma as separator, so this line is valid also:

/** @psalm-trace $a, $b */

This is probably more natural for some people.

Caveat:

• I don’t know if my fix is the best way to allow multiple traces or if changing the format of $emitted_key for that case breaks something elsewhere. But no included test fails (at least none related to my changes) and using this codebase in another project worked as expected.
• The additional tests test only half of the addition. I don’t know if is possible to expect multiple errors in the test framework. At least the test asserts that adding two variables doesn’t break getting the first.

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/31262a113f

<?php

$a = 123;
$b = 456;

/** @psalm-trace $a $b */

$c = 123;
$d = 456;

/** @psalm-trace $c */
/** @psalm-trace $d */

Psalm output (using commit 45e1a1c):

INFO: Trace - 8:1 - $a: 123

INFO: Trace - 12:23 - $d: 456

INFO: UnusedVariable - 3:1 - $a is never referenced or the value is not used

INFO: UnusedVariable - 4:1 - $b is never referenced or the value is not used

INFO: UnusedVariable - 8:1 - $c is never referenced or the value is not used

INFO: UnusedVariable - 9:1 - $d is never referenced or the value is not used

[weirdan]

👍

[weirdan]

if changing the format of $emitted_key for that case breaks something elsewhere

I think that's unlikely.

I don’t know if is possible to expect multiple errors in the test framework

Not with Valid/InvalidCodeTrait, as those tests rely on Psalm throwing exceptions instead of storing all issues reported. It's possible to arrange a test emitting several issues like it's done in, e.g., ReportOutputTest.

[weirdan]

Thanks!

[pilif]

For checking for multiple errors, see also #6899 where I had to do that last week