Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable property invariance checks for properties with templates #5380

Merged
merged 5 commits into from
Mar 16, 2021

Conversation

AndrolGenhald
Copy link
Collaborator

@AndrolGenhald AndrolGenhald commented Mar 13, 2021

Very much a work in progress, comments welcome.
Fix for #5371

I would like to have property invariance checks work correctly, but for now I'll at least settle for disabling them for properties containing a template.

So far I've changed Union::hasTemplate to check for arrays, lists, class-string-maps, and iterables containing templates, and the tests all pass. If this is the desired behavior of hasTemplate there's also TGenericObject, and possibly TCallable and others I haven't considered yet.

Any advice is much appreciated. I'm also trying to figure out how to update ClassAnalyzer.php:708 to check if $guide_property_storage has a template that's used by $property_storage, and then maybe clone $guide_property_storage and set the template to what $property_storage has before doing the ->equals check, but I bet there's a better way to do that, cloning doesn't sound great for performance.

Property invariance checks were already disabled for template
properties, this also disabled the checks for arrays, lists,
class-string-maps, and iterables that contain templates.

Partially fixes vimeo#5371
Add hasTemplate to TypeNode and simplify implementation with getChildNodes.
@AndrolGenhald
Copy link
Collaborator Author

AndrolGenhald commented Mar 13, 2021

Simplified now with getChildNodes() which I'd overlooked before, but it breaks a test for #3407. I think some checks are disabled for types with templates and now it's skipping checks that used to work properly? Also, hasTemplateOrStatic probably has the same issues as hasTemplate, but it's only used in one place and I don't understand it well enough to write a failing test case.

src/Psalm/Type/Atomic.php Outdated Show resolved Hide resolved
@AndrolGenhald AndrolGenhald changed the title Support property invariance checks for properties with templates Disable property invariance checks for properties with templates Mar 16, 2021
@AndrolGenhald
Copy link
Collaborator Author

I think this is working properly now to disable property invariance checks for templates, I'll open a new pull request if I manage to get the checks to work correctly with templates.

@muglug muglug merged commit 9d840ee into vimeo:master Mar 16, 2021
@muglug
Copy link
Collaborator

muglug commented Mar 16, 2021

Thanks!

This was referenced Mar 17, 2021
kodiakhq bot referenced this pull request in WesleyKlop/vote-system Mar 17, 2021
Bumps [vimeo/psalm](https://github.com/vimeo/psalm) from 4.6.3 to 4.6.4.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/vimeo/psalm/releases">vimeo/psalm's releases</a>.</em></p>
<blockquote>
<h2>Fix small API regression</h2>
<p><code>IssueBuffer::finish</code> had a small undocumented API change – that change is reverted here (<a href="https://github.com/vimeo/psalm/issues/5410">#5410</a>).</p>
<p>Bugfixes:</p>
<ul>
<li><a href="https://github.com/orklah"><code>@​orklah</code></a> improved the return type of <code>array_combine</code> and <code>iterator_to_array</code> (<a href="https://github.com/vimeo/psalm/issues/5393">#5393</a>, <a href="https://github.com/vimeo/psalm/issues/5400">#5400</a>)</li>
<li>Promoted properties are no longer counted as unused params — thanks <a href="https://github.com/weirdan"><code>@​weirdan</code></a> (<a href="https://github.com/vimeo/psalm/issues/5404">#5404</a>)</li>
<li><a href="https://github.com/theodorejb"><code>@​theodorejb</code></a> improved the type of DOMElement::childNodes (<a href="https://github.com/vimeo/psalm/issues/5403">#5403</a>)</li>
<li>Property invariance checks are now disabled for properties with templates — thanks <a href="https://github.com/AndrolGenhald"><code>@​AndrolGenhald</code></a> (<a href="https://github.com/vimeo/psalm/issues/5380">#5380</a>)</li>
<li><a href="https://github.com/orklah"><code>@​orklah</code></a> fixed scalar-to-string reconciliation inside templates (<a href="https://github.com/vimeo/psalm/issues/5402">#5402</a>)</li>
<li>Fixed a regression asserting on templated arrays and generic objects (<a href="https://github.com/vimeo/psalm/issues/5406">#5406</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/vimeo/psalm/commit/97fe86c4e158b5a57c5150aa5055c38b5a809aab"><code>97fe86c</code></a> Fix BC break introduced in 4.6.3 (<a href="https://github.com/vimeo/psalm/issues/5410">#5410</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/9d979e3467b623a69b69a5427884f519e61f7d73"><code>9d979e3</code></a> Fix <a href="https://github.com/vimeo/psalm/issues/5406">#5406</a> - track more changes to assertion type</li>
<li><a href="https://github.com/vimeo/psalm/commit/2777b62d0bc38ae439aedea338c5a6dd23cb7db5"><code>2777b62</code></a> String can be reconciled with Scalar (<a href="https://github.com/vimeo/psalm/issues/5402">#5402</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/11490508173c8e6be7f46724a70ca429caf96201"><code>1149050</code></a> adapt bcdiv for PHP8 in stubs (<a href="https://github.com/vimeo/psalm/issues/5401">#5401</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/ff5a6cb2974995d73ba2443fc6dc0b7b95ef7906"><code>ff5a6cb</code></a> iterator_to_array must always return array-key (<a href="https://github.com/vimeo/psalm/issues/5400">#5400</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/1a3ff5676aee987c35eebac1119ff306ac05f67f"><code>1a3ff56</code></a> fix stub for array_combine + remove false in PHP8 + improve tests (<a href="https://github.com/vimeo/psalm/issues/5395">#5395</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/9d840ee87bceb66b791b42f9d51f285d125fdbf2"><code>9d840ee</code></a> Disable property invariance checks for properties with templates (<a href="https://github.com/vimeo/psalm/issues/5380">#5380</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/5b9efd579de000a98af42eec52e2dcb7d3573cd3"><code>5b9efd5</code></a> Fix type of DomElement childNodes property (<a href="https://github.com/vimeo/psalm/issues/5403">#5403</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/ae247d09a3de23ea015c7a2b4bebac1388954953"><code>ae247d0</code></a> Don't mark promoted properties as unused params (<a href="https://github.com/vimeo/psalm/issues/5404">#5404</a>)</li>
<li><a href="https://github.com/vimeo/psalm/commit/817d1cf3fe9f3e3141bcb7f0a5734d2714ecdf78"><code>817d1cf</code></a> Fix <a href="https://github.com/vimeo/psalm/issues/5408">#5408</a> - avoid nullref when parser param cannot be found</li>
<li>Additional commits viewable in <a href="https://github.com/vimeo/psalm/compare/4.6.3...4.6.4">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=vimeo/psalm&package-manager=composer&previous-version=4.6.3&new-version=4.6.4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>
This was referenced Mar 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants