feat(phpstan): foundation for usage in extensions by SychO9 · Pull Request #3666 · flarum/framework

SychO9 · 2022-11-03T19:50:46Z

Changes proposed in this pull request

In #3553, we added phpstan static code analysis, but only to core code. This PR aims to make the flarum/phpstan package usable by extension repositories. Which means (at the moment) being able to pick up on new model relations and attributes.

Static analysis is actually expanded to other extensions in a separate PR for ease of readability (#3667).

There are two crucial changes/additions introduced here.

`Model::cast()` Extender

A new cast(string $name, string $type) extender is introduced, which allows adding type casting to attributes added to existing models from extensions. This provides three advantages:

The feature itself is a good addition to extensions.
Our phpstan package can tell that an attribute added to a core model from an extension is a valid class property, since those are accessed though magic methods.
Deprecates the old dateAttribute extender, since laravel has deprecated the use of the $dates property in models for date attributes, and recommends using $casts instead. I hope in another PR to also change model classes from directly using $dates property.

Extending PHPStan

This PR also extends phpstan so that it can tell from extend.php files what relations and attributes are added to existing models, so that they aren't reported as unknown. extend.php files are parsed and currently the package looks up calls to cast and hasOne belongsTo hasMany belongsToMany method calls to inform the phpstan utility about them.

Reviewers should focus on:

cast model extender.
Deprecating dateAttribute extender.
Generally PHPStan extension logic, I would focus less on the code for it.

Follow-up Tasks

Write documentation about using PHPStan in extensions.
Add PHPStan infrastructure to Flarum CLI.

Necessity

Has the problem that is being solved here been clearly explained?
If applicable, have various options for solving this problem been considered?
For core PRs, does this need to be in core, or could it be in an extension?
Are we willing to maintain this for years / potentially forever?

Confirmed

Frontend changes: tested on a local Flarum installation.
Backend changes: tests are green (run composer test).
Core developer confirmed locally this works as intended.
Tests have been added, or are not appropriate here.

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

Stops using `dates` as it's deprecated in laravel 8 Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

askvortsov1 · 2023-01-17T16:12:57Z

+    private function findCastAttributeMethod(ClassReflection $classReflection, string $propertyName): ?MethodCall
+    {
+        foreach ($this->extendersResolver->getExtenders() as $extender) {
+            if (! $extender->isExtender('Model')) {


Maybe this string would make sense to put in a constant somewhere? Or could we reflect the model itself to get the unqualified class name?

askvortsov1 · 2023-01-17T16:14:23Z

+            }
+
+            foreach (array_merge([$classReflection->getName()], $classReflection->getParentClassesNames()) as $className) {
+                if ($className === 'Flarum\Database\AbstractModel') {


Same here, might be cleaner to put all these strings in one place. Deriving it from the class would be nice, but I assume impossible since then phpstan ext would need to depend on core

askvortsov1 · 2023-01-17T16:15:43Z

+use PHPStan\Type\ObjectType;
+use PHPStan\Type\UnionType;
+
+class ModelDateAttributesExtension implements PropertiesClassReflectionExtension


There's a lot of code repetition; maybe we should consider some abstract class on top of PropertiesClassReflectionExtension for finding extenders?

We can further iterate on this 👍🏼

askvortsov1 · 2023-01-17T16:17:18Z

+        $this->paths = $paths;
+    }
+
+    public function getExtenderFiles(): array


Sometimes I wish PHP were Hack: https://docs.hhvm.com/hack/attributes/predefined-attributes#__memoize

SychO9 added type/feature type/extensibility needs-documentation labels Nov 3, 2022

SychO9 self-assigned this Nov 3, 2022

SychO9 requested a review from a team as a code owner November 3, 2022 19:50

SychO9 changed the title ~~Sm/phpstan in extensions~~ feat(phpstan): foundation for usage in extensions* Nov 3, 2022

SychO9 changed the title feat(phpstan): foundation for usage in extensions* feat(phpstan): foundation for usage in extensions Nov 3, 2022

SychO9 mentioned this pull request Nov 3, 2022

chore(phpstan): enable phpstan in bundled extensions #3667

Merged

8 tasks

SychO9 linked an issue Nov 4, 2022 that may be closed by this pull request

PHPStan Setup #3559

Closed

SychO9 added the prio/high label Nov 20, 2022

SychO9 force-pushed the sm/phpstan-in-extensions branch from b4f0f8c to 182aac5 Compare November 20, 2022 21:47

SychO9 mentioned this pull request Nov 21, 2022

Document PHPStan usage in extensions flarum/docs#441

Merged

SychO9 and others added 11 commits January 13, 2023 20:06

feat(phpstan): pick up extended model relations typings

88883b2

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

feat(phpstan): pick up extended model date attributes

c952bc6

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

feat(core): introduce castAttribute extender

a94cda6

Stops using `dates` as it's deprecated in laravel 8 Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

feat(phpstan): pick up extended model attributes through casts

bb9b6fa

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

fix: extenders not resolved when declared namespace

9531e7e

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

fix(phpstan): new model attributes are always nullable

0468f6e

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

chore(phpstan): add helpful cache clearing command

7d4f021

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

Apply fixes from StyleCI

52d805e

chore: improve extend files provider logic

2e464d3

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

chore: rename castAttribute to just cast

1ae3346

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

chore: update phpstan package to detect cast method

ffaf722

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

SychO9 force-pushed the sm/phpstan-in-extensions branch from 023ce97 to ffaf722 Compare January 13, 2023 19:07

SychO9 commented Jan 13, 2023

View reviewed changes

Comment thread framework/core/src/Extend/Model.php Outdated

Update framework/core/src/Extend/Model.php

ba01e31

SychO9 removed prio/high needs-documentation labels Jan 14, 2023

SychO9 added this to the 1.7 milestone Jan 14, 2023

SychO9 merged commit 5fe3cfd into main Jan 15, 2023

SychO9 deleted the sm/phpstan-in-extensions branch January 15, 2023 14:25

askvortsov1 reviewed Jan 17, 2023

View reviewed changes

luceos mentioned this pull request Mar 2, 2023

Release v1.7.0 #3747

Closed

Navigation Menu

Uh oh!

Uh oh!

feat(phpstan): foundation for usage in extensions - #3666

feat(phpstan): foundation for usage in extensions#3666
SychO9 merged 12 commits into
mainfrom
sm/phpstan-in-extensions

SychO9 commented Nov 3, 2022 •

edited

Loading

Uh oh!

Uh oh!

askvortsov1 Jan 17, 2023

Uh oh!

askvortsov1 Jan 17, 2023

Uh oh!

askvortsov1 Jan 17, 2023

Uh oh!

SychO9 Jan 19, 2023

Uh oh!

askvortsov1 Jan 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

SychO9 commented Nov 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed in this pull request

Model::cast() Extender

Extending PHPStan

Reviewers should focus on:

Follow-up Tasks

Necessity

Confirmed

Uh oh!

Uh oh!

askvortsov1 Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

askvortsov1 Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

askvortsov1 Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

SychO9 Jan 19, 2023

Choose a reason for hiding this comment

Uh oh!

askvortsov1 Jan 17, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SychO9 commented Nov 3, 2022 •

edited

Loading

`Model::cast()` Extender