Fix PHPStan warnings in GitLab CI job [#3400631]

PHPStan is now being run on GitLab CI. There are many messages and the pipeline job ends with an 'amber' warning.

Here is the Gitlab_templates issue where PHPStan was added and a follow-up for improvements

Matt Glamman has written a blog post about it.

Some asic Drupal.org documentation
https://www.drupal.org/docs/develop/development-tools/phpstan/getting-st...

PHPStan User guide and config reference
https://phpstan.org/user-guide/getting-started
https://phpstan.org/config-reference

Issue fork scheduler-3400631

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

3400631-phpstan changes, plain diff MR !107
Check out this branch for the first time

Check out existing branch, if you already have it locally
3400631-phpstan-8.x-1.x changes, plain diff MR !110
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

9 November 2023 at 17:53

jonathan1055 created an issue. See original summary.

Comment #2

17 December 2023 at 11:47

jonathan1055 opened merge request !107

Comment #3

20 January 2024 at 12:22

jonathan1055 committed 88a5eb91 on 2.x

Issue #3400631 by jonathan1055: Add phpstan.neon and two baseline files

Comment #5

20 January 2024 at 13:04

jonathan1055 committed 34773549 on 2.x

Issue #3400631 by jonathan1055: Do the easy PHPStan fixes

Comment #6

20 January 2024 at 15:01

jonathan1055 committed ef25ca68 on 2.x

Issue #3400631 by jonathan1055: Add the workbench_moderation modules to...

Comment #7

20 January 2024 at 17:18

jonathan1055 committed 8795eaed on 2.x

Issue #3400631 by jonathan1055: Add dependency injection to...

Comment #8

20 January 2024 at 17:48

jonathan1055 committed d683fde5 on 2.x

Issue #3400631 by jonathan1055: Fix prettier standard - empty line in...

Comment #9

20 January 2024 at 23:35

jonathan1055 committed 0c8f8613 on 2.x

Issue #3400631 by jonathan1055: PHPStan: Add missing Drupal\scheduler\...

Comment #10

jonathan1055 commented 21 January 2024 at 10:38

I wrote a script to summarise PHPstan messages in a baseline file. Right at the start we had:

---------------------------------------------------------------
Number of messages by file
   34 in src/SchedulerManager.php
   30 in tests/modules/scheduler_api_test/src/EventSubscriber.php
   9 in tests/src/Functional/SchedulerDrushTest.php
   8 in scheduler_rules_integration/scheduler_rules_integration.rules_defaults.inc
   4 in src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
   3 in scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionBase.php
   3 in src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
   3 in src/Theme/SchedulerThemeNegotiator.php
   2 in scheduler.module
   2 in scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionDeriver.php
   1 in plugins/content_types/scheduler_form_pane.inc
   1 in scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
   1 in scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
   1 in src/Access/SchedulerRouteAccess.php
   1 in src/Plugin/Field/FieldWidget/TimestampDatetimeNoDefaultWidget.php
   1 in src/Plugin/views/access/Scheduler.php
   1 in src/Routing/SchedulerRouteSubscriber.php
   1 in tests/src/Functional/SchedulerBasicNodeTest.php
---------------------------------------------------------------
Different types of message: 58
Total number of messages: 110
---------------------------------------------------------------

After splitting out the first set of legacy messages and following Core's ignore of Unsafe usage of new static() the result was:

---------------------------------------------------------------
Number of messages by file

   30 in tests/modules/scheduler_api_test/src/EventSubscriber.php
   25 in src/SchedulerManager.php
   8 in scheduler_rules_integration/scheduler_rules_integration.rules_defaults.inc
   4 in scheduler.module
   4 in scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionBase.php
   4 in src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
   3 in src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
   3 in src/Theme/SchedulerThemeNegotiator.php
   1 in plugins/content_types/scheduler_form_pane.inc
   1 in scheduler_rules_integration/src/Event/EventDeriver.php
   1 in scheduler_rules_integration/src/Plugin/Condition/ConditionDeriver.php
   1 in scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
   1 in scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionDeriver.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
   1 in src/Access/SchedulerRouteAccess.php
   1 in src/Controller/LightweightCronController.php
   1 in src/Form/SchedulerCronForm.php
   1 in src/Plugin/Derivative/DynamicLocalTasks.php
   1 in src/Plugin/Field/FieldWidget/TimestampDatetimeNoDefaultWidget.php
   1 in src/Plugin/views/access/Scheduler.php
   1 in src/Routing/SchedulerRouteSubscriber.php
   1 in src/SchedulerPermissions.php
   1 in src/SchedulerPluginBase.php
---------------------------------------------------------------
Different types of message: 46
Total number of messages: 100
---------------------------------------------------------------

Then after doing all the easy fixes we had

Summary of PHPStan messages

'Drupal calls should be avoided in classes, use dependency injection instead'
38 occurrence in 14 file(s)
   scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
   scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
   scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
   scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
   scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionBase.php
   scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
   scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
   src/Access/SchedulerRouteAccess.php
   src/Plugin/Field/FieldWidget/TimestampDatetimeNoDefaultWidget.php
   src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
   src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
   src/Routing/SchedulerRouteSubscriber.php
   src/SchedulerManager.php
   src/Theme/SchedulerThemeNegotiator.php

'Parameter \$event of method Drupal\scheduler_api_test\EventSubscriber\:\:apiTest(|Node|Media|Product|TaxonomyTerm)(PrePublish|Publish|PrePublishImmediately|PublishImmediately|PreUnpublish|Unpublish)\(\) has invalid type Drupal\scheduler\SchedulerEvent\.'
30 occurrence in 1 file(s)
   tests/modules/scheduler_api_test/src/EventSubscriber.php

'Parameter \$container of method Drupal\scheduler_rules_integration\Plugin\RulesAction\SchedulerRulesActionBase\:\:create\(\) has invalid type Drupal\scheduler_rules_integration\Plugin\RulesAction\ContainerInterface\.'
1 occurrence in 1 file(s)
   scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionBase.php

'Call to deprecated method loadRevision\(\) of class Drupal\\Core\\Entity\\EntityStorageInterface\:'
1 occurrence in 1 file(s)
   src/SchedulerManager.php

'Instantiated class Drupal\scheduler\SchedulerEvent not found\.'
1 occurrence in 1 file(s)
   src/SchedulerManager.php

---------------------------------------------------------------
Number of messages by file

   30 in tests/modules/scheduler_api_test/src/EventSubscriber.php
   19 in src/SchedulerManager.php
   4 in src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
   3 in scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionBase.php
   3 in src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
   3 in src/Theme/SchedulerThemeNegotiator.php
   1 in scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
   1 in scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
   1 in scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
   1 in src/Access/SchedulerRouteAccess.php
   1 in src/Plugin/Field/FieldWidget/TimestampDatetimeNoDefaultWidget.php
   1 in src/Routing/SchedulerRouteSubscriber.php
---------------------------------------------------------------
Different types of message: 5
Total number of messages: 71
---------------------------------------------------------------

Comment #11

21 January 2024 at 13:38

jonathan1055 committed 1a869172 on 2.x

Issue #3400631 by jonathan1055: PHPStan: Add ContainerInterface to...

Comment #12

22 January 2024 at 08:33

jonathan1055 committed cd1db37f on 2.x

Issue #3400631 by jonathan1055: Use dependency injection for scheduler....

Comment #13

26 January 2024 at 11:40

jonathan1055 opened merge request !110

Comment #14

jonathan1055 commented 26 January 2024 at 13:04

Current 8.x-1.x branch PHPStan job shows 46 errors
https://git.drupalcode.org/project/scheduler/-/jobs/687380

Using the three initial files, taken directly from 2.x with no changes, we get 41 errors
https://git.drupalcode.org/project/scheduler/-/jobs/695715
Many of these are because there are more messages in the 'ignore' files than are actuallly found in the code.

Comment #15

jonathan1055 commented 26 January 2024 at 13:17

After removing the extra ignored messages, we are left with 15 that need to be fixed.

Comment #16

28 January 2024 at 15:43

jonathan1055 committed 9f332e45 on 2.x

Issue #3400631 by jonathan1055: Add .scheduler-matrix and .scheduler-...

Comment #17

29 January 2024 at 17:04

jonathan1055 committed 3dd4fde1 on 8.x-1.x

Issue #3400631 by jonathan1055: Add phpstan baseline files. Add manual...

Comment #18

29 January 2024 at 17:42

jonathan1055 committed af1a9c1d on 8.x-1.x

Issue #3400631 by jonathan1055: Fix 16 PHPStan errors

Comment #19

30 January 2024 at 10:58

jonathan1055 committed a574fcf0 on 2.x

Issue #3400631 by jonathan1055: Run phpunit at "next minor" and show...

Comment #20

jonathan1055 commented 30 January 2024 at 15:52

Status:

Active

» Fixed

PHPStan is now running on 2.x and 8.x-1.x and all the easy fixes have been done.
Legacy code messages are permanently ignored in the phpstan-baseline-ok.neon file.
The remainder are "temporarily" ignored in the phpstan-baseline-to-fix.neon. These can (and should) be fixed in due course.

2.x

---------------------------------------------------------------------------
Summary of PHPStan messages in phpstan-baseline-to-fix.neon
---------------------------------------------------------------------------
Drupal calls should be avoided in classes, use dependency injection instead
36 occurrence(s) in 12 file(s)
scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionBase.php
scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
src/Routing/SchedulerRouteSubscriber.php
src/SchedulerManager.php
src/Theme/SchedulerThemeNegotiator.php
---------------------------------------------------------------------------
Call to deprecated method loadRevision of class Drupal\Core\Entity\EntityStorageInterface\:
1 occurrence(s) in 1 file(s)
src/SchedulerManager.php
---------------------------------------------------------------------------
Number of messages by file
18 in src/SchedulerManager.php
4 in src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
3 in src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
3 in src/Theme/SchedulerThemeNegotiator.php
2 in scheduler_rules_integration/src/Plugin/RulesAction/SchedulerRulesActionBase.php
1 in scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
1 in scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
1 in scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
1 in scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
1 in scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
1 in scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
1 in src/Routing/SchedulerRouteSubscriber.php
---------------------------------------------------------------------------
Different types of message: 2
Total number of messages: 37
---------------------------------------------------------------------------

8.x-1.x

---------------------------------------------------------------------------
Summary of PHPStan messages in phpstan-baseline-to-fix.neon
---------------------------------------------------------------------------
Drupal calls should be avoided in classes, use dependency injection instead
23 occurrence(s) in 11 file(s)
scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
src/Plugin/views/access/Scheduler.php
src/SchedulerManager.php
src/Theme/SchedulerThemeNegotiator.php
---------------------------------------------------------------------------
Variable \$unpublish_on in empty always exists and is not falsy\.
1 occurrence(s) in 1 file(s)
src/SchedulerManager.php
---------------------------------------------------------------------------
Number of messages by file
3 in scheduler_rules_integration/src/Plugin/RulesAction/RemovePublishingDate.php
3 in scheduler_rules_integration/src/Plugin/RulesAction/RemoveUnpublishingDate.php
3 in scheduler_rules_integration/src/Plugin/RulesAction/SetPublishingDate.php
3 in scheduler_rules_integration/src/Plugin/RulesAction/SetUnpublishingDate.php
3 in src/SchedulerManager.php
2 in src/Plugin/Validation/Constraint/SchedulerPublishOnConstraintValidator.php
2 in src/Plugin/Validation/Constraint/SchedulerUnpublishOnConstraintValidator.php
2 in src/Theme/SchedulerThemeNegotiator.php
1 in scheduler_rules_integration/src/Plugin/Condition/PublishingIsEnabled.php
1 in scheduler_rules_integration/src/Plugin/Condition/UnpublishingIsEnabled.php
1 in src/Plugin/views/access/Scheduler.php
---------------------------------------------------------------------------
Different types of message: 2
Total number of messages: 24
---------------------------------------------------------------------------

Comment #21

31 January 2024 at 13:48

jonathan1055 committed 1ef4d95b on 2.x

Issue #3400631 by jonathan1055: Put back ref: $_GITLAB_TEMPLATES_REF to...

Comment #22

14 February 2024 at 13:49

Status:

Fixed

» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

Comment #23

jonathan1055 commented 20 January 2025 at 16:39

Title:

PHPStan on GitLab CI

» Fix PHPStan warnings in GitLab CI job

Issue summary:	View changes
Related issues:		+#3395419: Allow contrib modules to run PHPStan via GitLab CI, +#3397162: Tweak PHPStan config so paths are always correct and baseline is more usable

Fix PHPStan warnings in GitLab CI job