vimeo/psalm

Psalm is not able to infer types from doc blocks of Google\Protobuf with 'protobuf' extension installed

Open

#8,281 opened on Jul 18, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)PHP (5,369 stars) (668 forks)batch import
Help wantedeasy problemsgood first issueinternal stubs/callmap

Description

Hi, I have the protobuf extension installed in container in which I run Psalm, this causes psalm to not be able to infer types from Google\Protobuf classes, resulting in MixedAssignment and other errors, please see example below:

ERROR: MixedAssignment - index.php:3:1 - Unable to determine the type that $t is being assigned to (see https://psalm.dev/032)
$t = (new \Google\Protobuf\Timestamp())->setSeconds(0)->setNanos(0);

If I remove the protobuf extension, Psalm no longer reports those errors.

I've created a repository with reproducible example here: https://github.com/benkelukas/psalm-google-protobuf-issue

For now, I'm using container without protobuf for Psalm, but somebody might not have the options, so wanted to leave this here in case somebody else has this weird problem.

I've done some digging as well, and from my very much limited knowledge of Psalm, it seems that with the protobuf extension, the Google\Protobuf classes are not located via composer, but analyzed using reflection instead, and these classes do not have return types specified in actual code, but rather via annotations, so maybe that is what is breaking this? If you compare output of --debug-by-line with the extension and without it is different when processing the Google\Protobuf classes.

Some info on my environment:

  • Psalm version: 4.24.0
  • PHP: 8.1.1

Contributor guide

Tech stack
None
Domain
backenddeveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PHP reflectionPsalm plugin systemdebugging skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate why Psalm fails to infer types from Google\Protobuf classes when the protobuf extension is installed. Compare the debug output with and without the extension to see how classes are resolved. Check if Psalm's reflection based analysis ignores doc block annotations for classes provided by the extension, as described in the issue. The reproducible repository at https://github.com/benkelukas/psalm google protobuf issue may be used for testing.