Shebang breaks @var namespace resolution

[InvisibleSmiley]

Bug report

Adding a shebang to a script breaks @var namespace resolution.
Worked until v1.2
Broken in v1.3

Code snippet that reproduces the problem

https://phpstan.org/r/43479d60-e6c5-4319-916a-db41b72942f8

[martin-heralecky]

I am experiencing this issue as well and can confirm, that it did work in v1.2. Specifically, the commit that broke it is phpstan/phpstan-src@256d11b8.

I was digging a bit deeper today and traced the problem down to FileTypeMapper::createNameScopeMap(), concretely lines 374-395:

$nameScopeKey = $this->getNameScopeKey($originalClassFileName, $className, $lookForTrait, $functionName);
if (
        $node instanceof Node\Stmt
        && !$node instanceof Node\Stmt\Namespace_
        && !$node instanceof Node\Stmt\Declare_
        && !$node instanceof Node\Stmt\DeclareDeclare
        && !$node instanceof Node\Stmt\Use_
        && !$node instanceof Node\Stmt\UseUse
        && !$node instanceof Node\Stmt\GroupUse
        && !$node instanceof Node\Stmt\TraitUse
        && !$node instanceof Node\Stmt\TraitUseAdaptation
        && !array_key_exists($nameScopeKey, $nameScopeMap)
) {
        $nameScopeMap[$nameScopeKey] = static fn (): NameScope => new NameScope(
                $namespace,
                $uses,
                $className,
                $functionName,
                ($typeMapCb !== null ? $typeMapCb() : TemplateTypeMap::createEmpty()),
                $typeAliasesMap,
        );
}

If we assume to analyze the following snippet:

#!/usr/bin/env php
<?php

use FooNamespace\FooClass;

/** @var FooClass $f */

then the if-condition would be satisfied for two Nodes:

1. The first one is a Node\Stmt\InlineHTML, which represents the shebang line, but is otherwise "empty" ($namespace is null, $uses is empty, $className is null...). I am not sure, whether a NameScope should even be created for this node.
2. The other one is a Node\Stmt\Nop and it is filled correctly (mainly I was looking at $uses, which, as expected, contained the use from the snippet).

Now the problem is, that the second NameScope is actually never created, because the last condition of the if is not satisfied (!array_key_exists($nameScopeKey, $nameScopeMap)). The reason for this is that $nameScopeKey is only based on the filename, since all $className, $lookForTrait, and $functionName are null ($nameScopeKey = $this->getNameScopeKey($originalClassFileName, $className, $lookForTrait, $functionName);) and thus the keys for both Nodes are the same.

That's as far as my digging went, but unfortunately I don't have the necessary insight into the internal workings of PHPStan to figure out what would be the correct approach to solve this issue.

Any suggestions? @ondrejmirtes

[ondrejmirtes]

@martin-heralecky Thank you for your research, it seems like you'd be capable at fixing PHPStan bugs! :)

I fixed this one: phpstan/phpstan-src@c87284a

[martin-heralecky]

Excellent! When can we expect this to be released?

[ondrejmirtes]

Later today

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.