Contrib.social

Fix issues reported by PHPStan

Open on Drupal.org →
Created on 5 July 2024, 10 months ago
Updated 6 July 2024, 10 months ago

Problem/Motivation

With the integration of GitLab CI from 📌 Add Gitlab CI to V2 of the module Active there is now a report for PHPStan issues at https://git.drupalcode.org/project/activecampaign/-/jobs/2043632

PHPStan - PHP Static Analysis Tool 1.11.6
$ php --version
PHP 8.1.29 (cli) (built: Jun  6 2024 17:38:49) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.29, Copyright (c) Zend Technologies
    with Zend OPcache v8.1.29, Copyright (c), by Zend Technologies
$ echo "Executing php vendor/bin/phpstan analyze $_WEB_ROOT/modules/custom/$CI_PROJECT_NAME $PHPSTAN_CONFIGURATION"
Executing php vendor/bin/phpstan analyze web/modules/custom/activecampaign --configuration=web/modules/custom/activecampaign/phpstan.neon
$ php vendor/bin/phpstan analyze $_WEB_ROOT/modules/custom/$CI_PROJECT_NAME $PHPSTAN_CONFIGURATION --error-format=junit > junit.xml || true
  0/15 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░]   0%
 15/15 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
$ php vendor/bin/phpstan analyze $_WEB_ROOT/modules/custom/$CI_PROJECT_NAME $PHPSTAN_CONFIGURATION --no-progress --error-format=gitlab > phpstan-quality-report.json || true
$ php vendor/bin/phpstan analyze $_WEB_ROOT/modules/custom/$CI_PROJECT_NAME $PHPSTAN_CONFIGURATION --no-progress || EXIT_CODE=$?
 ------ ----------------------------------------------------------------------------------------------------------------- 
  Line   modules/activecampaign_webform/src/Plugin/WebformHandler/ActiveCampaignFormHandler.php                           
 ------ ----------------------------------------------------------------------------------------------------------------- 
  24     Class                                                                                                            
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler                                    
         extends unknown class Drupal\webform\Plugin\WebformHandlerBase.                                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols                                              
  42     Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::create()                          
         calls parent::create() but                                                                                       
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler                                    
         does not extend any class.                                                                                       
  65     Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$webform.                         
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  68     Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  79     Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  82     Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  83     Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$configuration.                   
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  87     Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  90     Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  91     Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$configuration.                   
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  94     Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  97     Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  98     Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$configuration.                   
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  104    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  108    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  109    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  111    Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$configuration.                   
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  116    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  117    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  122    Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$configuration.                   
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  125    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::setSettingsParents().             
  133    Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::submitConfigurationForm()         
         calls parent::submitConfigurationForm() but                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler                                    
         does not extend any class.                                                                                       
  136    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::applyFormStateToConfiguration().  
  139    Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$configuration.                   
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  139    Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$configuration.                   
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  146    Parameter $webform_submission of method                                                                          
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::submitForm()                      
         has invalid type Drupal\webform\webformSubmissionInterface.                                                      
  148    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::getConfiguration().               
  194    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::getLogger().                      
  198    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::getLogger().                      
  203    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  205    Call to static method encode() on an unknown class                                                               
         Drupal\webform\Utility\WebformYaml.                                                                              
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols                                              
  209    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::t().                              
  211    Call to static method encode() on an unknown class                                                               
         Drupal\webform\Utility\WebformYaml.                                                                              
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols                                              
  217    Access to an undefined property                                                                                  
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::$renderer.                        
         💡 Learn more:                                                                                                   
            https://phpstan.org/blog/solving-phpstan-access-to-undefined-property                                         
  218    Call to an undefined method                                                                                      
         Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler::getLogger().                      
 ------ ----------------------------------------------------------------------------------------------------------------- 
 [ERROR] Found 35 errors                                                        
$ php vendor/bin/phpstan analyze $_WEB_ROOT/modules/custom/$CI_PROJECT_NAME $PHPSTAN_CONFIGURATION --no-progress --generate-baseline --allow-empty-baseline || true # collapsed multi-line command
 [WARNING] Baseline generated with 34 errors.                                   
           Some errors could not be put into baseline. Re-run PHPStan and fix   
           them.                                                                
This baseline file is an artifact you can download and use in the project.

Steps to reproduce

https://git.drupalcode.org/project/activecampaign/-/jobs/2043632

Proposed resolution

Fix the issues and create a merge request.

Review the changes and merge the MR.

Remaining tasks

Add code and review the changes.

📌 Task
Status

Active

Version

2.0

Component

Code

Created by

🇧🇪Belgium dtfabio Ninove

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @dtfabio
  • First commit to issue fork.
  • Merge request !16Drupal 11 upgrade → (Merged) created by VladimirAus
  • Pipeline finished with Canceled
    10 months ago
    Total: 19s
    #217415
  • Pipeline finished with Failed
    10 months ago
    Total: 150s
    #217417
  • Pipeline finished with Failed
    10 months ago
    #217424
  • Pipeline finished with Running
    10 months ago
    #217443
  • Pipeline finished with Failed
    10 months ago
    Total: 145s
    #217445
  • Pipeline finished with Failed
    10 months ago
    Total: 145s
    #217447
  • Pipeline finished with Canceled
    10 months ago
    Total: 99s
    #217453
  • Pipeline finished with Failed
    10 months ago
    Total: 167s
    #217455
  • Status changed to Needs review 10 months ago
  • Comment 10 months ago →
    🇦🇺Australia VladimirAus Brisbane, Australia
  • Comment 10 months ago →
    🇦🇺Australia VladimirAus Brisbane, Australia

    PHPStan errors are fixed.

  • Status changed to Needs work 9 months ago
  • Comment 9 months ago →
    🇧🇪Belgium tim-diels Belgium 🇧🇪

    Needs rebase

  • Assigned to dtfabio
  • Status changed to Needs review 11 days ago
  • Comment 11 days ago →
    🇧🇪Belgium dtfabio Ninove

    I have rebased the MR with the changes from the latest version, did note that the code would also be D11 ready.

    The php stan pipeline is green, but I am going to test this before moving this ticket over to RTBC.

  • Comment 11 days ago →
    🇧🇪Belgium dtfabio Ninove

    I tested the code on three different Drupal instances, Drupal versions 10.3.14, 10.4.6 and 10.2.12.

    The first two versions gave no problems, but as the minimum version was increased to 10.2 I wanted to make sure it would therefore also work for the latest 10.2 release.

    Here I got the following error message when using the debug option on the webform handler:

    The website encountered an unexpected error. Try again later.

Error: Call to undefined method Drupal\Core\Render\Renderer::renderInIsolation() in Drupal\activecampaign_webform\Plugin\WebformHandler\ActiveCampaignFormHandler->submitForm() (line 217 of modules/custom/activecampaign/modules/activecampaign_webform/src/Plugin/WebformHandler/ActiveCampaignFormHandler.php).

    So I'm going to raise the version requirement for the webform submodule to 10.3 + updated the title to reflect that D11 update adjustments have been added here.

  • Comment 11 days ago →
    🇧🇪Belgium dtfabio Ninove

    Tested on Drupal version 11.1.6 and everything works ok here too, so I am changing the ticket to RTBC.

  • Comment 6 days ago →
    System Message
  • Comment 6 days ago →
    🇧🇪Belgium dtfabio Ninove

    Re-based to and merged with the 2.x branch and will cherry pick the changes to the 1.x branch later.

  • Comment 5 days ago →
    System Message
    • vladimiraus → authored cb3838b2 on 1.x 
      Issue #3459298 by vladimiraus, dtfabio, tim-diels: Fix issues reported...
  • Comment 5 days ago →
    🇧🇪Belgium dtfabio Ninove

    Cherry picked to 1.x branch, thanks for the work everyone and for the D11 update Vladimiraus. :)

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024