incorrect InvalidArgument when using generic arrays of multiple value types

[azjezz]

see: https://psalm.dev/r/e80523194f

expected: no errors, the array passed is of type array<string, Node<string>|Node<int>>

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/e80523194f

<?php

/**
 * @template T
 */
final class Node {
  /**
   * @param T $value
   */
  public function __construct(public mixed $value) {}
}

/**
 * @template Tk of array-key
 * @template Tv
 *
 * @param array<Tk, Node<Tv>> $_array
 */
function a(array $_array): void {}


a(['a' => new Node('a')]);

a(['a' => new Node('a'), 'b' => new Node(3)]);

Psalm output (using commit 97a3d67):

ERROR: InvalidArgument - 24:1 - Incompatible types found for Tv

[azjezz]

actually, not a bug, but the error message should be clearer ( Node is not covariant ).

https://psalm.dev/r/991ca76408

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/991ca76408

<?php

/**
 * @template-covariant T
 */
final class Node {
  /**
   * @param T $value
   */
  public function __construct(public mixed $value) {}
}

/**
 * @template Tk of array-key
 * @template Tv
 *
 * @param array<Tk, Node<Tv>> $_array
 */
function a(array $_array): void {}


a(['a' => new Node('a')]);

a(['a' => new Node('a'), 'b' => new Node(3)]);

Psalm output (using commit 97a3d67):

No issues!

[orklah]

I'll close this, the message was improved slightly

[AndrolGenhald]

Seems like this could still be improved to work like this without requiring the @var annotation.

[orklah]

@AndrolGenhald The real fix is: https://psalm.dev/r/45db240ac3

The message was cryptic before, now it explains the issue, but it doesn't show the possible solution

[AndrolGenhald]

I think it's also fine to widen the type even when the template isn't covariant, but I guess I'm fine requiring that to be an explicit annotation.

I know we've talked about some sort of alternate annotation to @var that's not so dangerous, it would be nice to have that here too for type widening (eg /** @strict-var int */ $i = 1 widens $i from 1 to int, but /** @strict-var int */ $i = 'foo'; should emit an issue).

[weirdan]

https://psalm.dev/r/2c5a043897
https://psalm.dev/r/45db240ac3

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/2c5a043897

<?php

/**
 * @template T
 */
final class Node {
  /**
   * @param T $value
   */
  public function __construct(public mixed $value) {}
}

/**
 * @template Tk of array-key
 * @template Tv
 *
 * @param array<Tk, Node<Tv>> $_array
 */
function a(array $_array): void {}


a(['a' => new Node('a')]);

/** @var list<Node<'a'|3>> */
$nodes = ['a' => new Node('a'), 'b' => new Node(3)];
a($nodes);

Psalm output (using commit 31941d1):

No issues!

https://psalm.dev/r/45db240ac3

<?php

/**
 * @template-covariant T
 */
final class Node {
  /**
   * @param T $value
   */
  public function __construct(public mixed $value) {}
}

/**
 * @template Tk of array-key
 * @template Tv
 *
 * @param array<Tk, Node<Tv>> $_array
 */
function a(array $_array): void {}


a(['a' => new Node('a')]);

$nodes = ['a' => new Node('a'), 'b' => new Node(3)];
a($nodes);

Psalm output (using commit 31941d1):

No issues!