[Test] Add phpstan tool to test suite and fix detected errors. #4928

johnsaigle · 2019-07-04T19:40:26Z

Brief summary of changes

I found a cool static analysis tool called PHP Stan which is like phan but much faster and flags additional issues.

This PR cleans up some of the errors it flags.

~~I'm going to add another commit that adds phpstan as a dependency but it requires PHPUnit >= 7 to work properly. This should be solved by #4433 so I'm marking this PR as blocked for now.~~

johnsaigle · 2019-07-04T20:15:15Z

Forgot to do make checkstatic. There are some phan errors I'll fix here.

xlecours · 2019-07-09T14:09:48Z

Nice catches!
I see that you choose var instead of a visibility keyword. Is it recommended?

johnsaigle · 2019-07-09T20:26:36Z

@xlecours No I don't think the tool cares. As far as I know var is the same as public in PHP. I can change it if public is preferred.

xlecours · 2019-07-10T13:51:36Z

I usually prefer explicit statements. But in this case, the visibility would need to be set to public, because there might be calls like $that->_variablename, and ideally they should be set to protected or private (in a utopian futur).

[TL;DR] leave them var

driusan · 2019-07-10T13:55:27Z

"public" is better than "var" because it's explicit. The "var" keyword shouldn't be used outside of legacy code.

johnsaigle · 2019-07-10T16:30:12Z

There are some phan issues that exist on the 21.0-release branch.. not sure how they got there.

Many of these are/will be addressed by #4914 so I'm going to mark this PR as Blocked until that one is merged.

johnsaigle · 2019-10-29T17:00:03Z

This PR now includes phpstan in the test suite. I was able to run it at max level and fix all detected errors! Pretty sweet.

johnsaigle · 2019-10-29T18:41:13Z

Travis is failing because PHP 7.2 is too old to run the dependencies for this version.

Since this is unlikely to go into LORIS 22 anyway, I think I'll punt this until 7.3 is required

johnsaigle · 2019-10-30T15:42:11Z

To be rebased onto the "Dev" branch after 22 is released.

Co-Authored-By: Rida Abou-Haidar <[email protected]>

Suggestions incorporated

xlecours

Good cleanup. Now we need to fix all those public variables. At least we now have a better idea of how many there are...

driusan

mostly looks good except for some minor things

php/libraries/BVL_Feedback_Panel.class.inc

php/libraries/Database.class.inc

php/libraries/LorisForm.class.inc

driusan · 2020-01-28T17:24:37Z

php/libraries/NDB_BVL_Instrument.class.inc

-
-            $formArray = $renderer->toArray();
-        }
+        $formArray = $this->form->toElementArray();


What about the other part of the else statement? What is this trying to solve? I think this change of behaviour is likely to break things with different types of instruments

I believe there was an issue with HTML_QuickForm_Renderer_Array because it doesn't exist in the code.

I made this PR 6 months ago so I'm not sure about the details.

I just did a little investigation of the impact of losing this else case and I think it means the API would be broken for the endpoint which gets the instrument in a JSON format for projects that had old instruments that couldn't be updated to LorisForm and were still using QuickForm.

There was only 1 such instrument that I could find when I searched the IBIS repo, and I'm not aware of anyone/thing depending on that endpoint of the API, so I guess it should be fine.

@xlecours or @ridz1208 do you want to chime in or know of anything using the /projects/$proj/instruments/$instrumentname endpoint?

We can add a note in the CHANGELOG about this if it ends up being a breaking change.

php/libraries/NDB_BVL_InstrumentStatus_ControlPanel.class.inc

Co-Authored-By: Dave MacFarlane <[email protected]>

johnsaigle · 2020-01-29T17:11:10Z

@driusan I've incorporated your suggestions. I added a note in the CHANGELOG about QuickForm complications and added the Caveat... label.

Could you re-review?

driusan · 2020-01-29T21:07:43Z

php/libraries/BVL_Feedback_Panel.class.inc

     */
-    var $_feedbackThread;
+    protected $feedbackThread;


The doc (@private) and the code (protected) here still don't seem to agree.

Thanks, just fixed it above

php/libraries/Module.class.inc

driusan · 2020-01-29T21:11:44Z

php/libraries/SessionID.php

-            && (is_integer($value));
+        return intval($value) > 0
+            && strlen($value) <= self::SESSIONID_MAX_LENGTH
+            && ctype_digit($value);


what was wrong with is_integer?

is_int() returns true if the argument is an integer type, ctype_digit() takes a string argument and returns true if all the characters in the string are digits.

The value is passed as a string so is_integer() always returns false

https://stackoverflow.com/questions/236406/is-there-a-difference-between-is-int-and-ctype-digit

test/phpstan-loris.neon

Co-Authored-By: Dave MacFarlane <[email protected]>

php/libraries/BVL_Feedback_Panel.class.inc

Reverses changes from #4928 that renames $ValidityEnabled to $validityEnabled and $ValidityRequired to $validityRequired. The variabes are UpperCamerCase elsewhere on Loris. This removes the following error that does not allow the Validity flags to render in instruments' control panels PHP Notice: Undefined property: NDB_BVL_Instrument_aosi::$validityEnabled in /var/www/loris/php/libraries/NDB_BVL_InstrumentStatus_ControlPanel.class.inc on line 101 PHP Notice: Undefined property: NDB_BVL_Instrument_aosi::$validityRequired in /var/www/loris/php/libraries/NDB_BVL_InstrumentStatus_ControlPanel.class.inc on line 102

johnsaigle added the State: Blocked PR or issue awaiting an external event such as the merge or another PR to proceed label Jul 10, 2019

johnsaigle changed the base branch from 21.0-release to major July 17, 2019 15:44

johnsaigle mentioned this pull request Jul 24, 2019

[Testing] Remove DB Unit package #4985

Merged

johnsaigle removed the State: Needs work PR awaiting additional work by the author to proceed label Sep 23, 2019

johnsaigle added the State: Needs rebase PR that needs to be rebased to proceed (conflicts, wrong branch...) label Oct 17, 2019

johnsaigle mentioned this pull request Oct 22, 2019

Add phpstan to static analysis test suite #5356

Closed

johnsaigle removed State: Blocked PR or issue awaiting an external event such as the merge or another PR to proceed State: Needs rebase PR that needs to be rebased to proceed (conflicts, wrong branch...) labels Oct 29, 2019

johnsaigle changed the title ~~Fix/clean problems in codebase detected by phpstan~~ [Test] Add phpstan tool to test suite and fix detected errors. Oct 29, 2019

johnsaigle requested a review from driusan October 29, 2019 17:00

johnsaigle added the State: Blocked PR or issue awaiting an external event such as the merge or another PR to proceed label Oct 29, 2019

johnsaigle added the State: Needs rebase PR that needs to be rebased to proceed (conflicts, wrong branch...) label Nov 12, 2019

cmadjar assigned johnsaigle Nov 29, 2019

johnsaigle removed the State: Blocked PR or issue awaiting an external event such as the merge or another PR to proceed label Dec 2, 2019

johnsaigle changed the base branch from major to master December 3, 2019 19:24

johnsaigle removed the State: Needs rebase PR that needs to be rebased to proceed (conflicts, wrong branch...) label Dec 3, 2019

johnsaigle and others added 6 commits January 20, 2020 13:13

Add phpstan to test suite

f65c9cb

Fix phan + phpcs errors

95940d6

fix undefined variables

c0bd0f1

phpcs

4c30635

Apply suggestions from code review

9fd3add

Co-Authored-By: Rida Abou-Haidar <[email protected]>

revert change to sessionID;

668a897

johnsaigle removed the State: Needs rebase PR that needs to be rebased to proceed (conflicts, wrong branch...) label Jan 20, 2020

Fix edge-case with adding alias to ID generation

a0f8588

johnsaigle requested a review from ridz1208 January 27, 2020 16:04

xlecours approved these changes Jan 27, 2020

View reviewed changes

driusan requested changes Jan 28, 2020

View reviewed changes

Apply suggestions from code review

f35d103

Co-Authored-By: Dave MacFarlane <[email protected]>

johnsaigle added State: Needs work PR awaiting additional work by the author to proceed Needs formatting PR requires formatting fixes to meet our coding standards (PHPCS, phan, etc.) and removed State: Needs work PR awaiting additional work by the author to proceed labels Jan 28, 2020

johnsaigle added 2 commits January 29, 2020 12:09

PHPCS

cdbece3

Add caveat about QuickForm to changelog

477e9e1

johnsaigle added Release: Breaking changes PR that contains changes that might impact the code or accepted practices of active projects and removed Needs formatting PR requires formatting fixes to meet our coding standards (PHPCS, phan, etc.) labels Jan 29, 2020

johnsaigle requested a review from driusan January 29, 2020 21:05

driusan requested changes Jan 29, 2020

View reviewed changes

Update php/libraries/Module.class.inc

afa97d1

Co-Authored-By: Dave MacFarlane <[email protected]>

johnsaigle commented Jan 29, 2020

View reviewed changes

php/libraries/BVL_Feedback_Panel.class.inc Outdated Show resolved Hide resolved

Change var doc to protected

4c49132

driusan merged commit ab78eee into aces:master Feb 3, 2020

ridz1208 added this to the 23.0.0 milestone Feb 25, 2020

zaliqarosli mentioned this pull request Feb 27, 2020

[InstrumentStatus_ControlPanel] Restore $validity to $Validity #6119

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Test] Add phpstan tool to test suite and fix detected errors. #4928

[Test] Add phpstan tool to test suite and fix detected errors. #4928

johnsaigle commented Jul 4, 2019 •

edited

Loading

johnsaigle commented Jul 4, 2019

xlecours commented Jul 9, 2019

johnsaigle commented Jul 9, 2019

xlecours commented Jul 10, 2019

driusan commented Jul 10, 2019

johnsaigle commented Jul 10, 2019

johnsaigle commented Oct 29, 2019

johnsaigle commented Oct 29, 2019

johnsaigle commented Oct 30, 2019

xlecours left a comment

driusan left a comment

driusan Jan 28, 2020

johnsaigle Jan 28, 2020

driusan Jan 28, 2020

driusan Jan 28, 2020

johnsaigle Jan 28, 2020

johnsaigle commented Jan 29, 2020

driusan Jan 29, 2020

johnsaigle Jan 29, 2020

driusan Jan 29, 2020

johnsaigle Jan 29, 2020

[Test] Add phpstan tool to test suite and fix detected errors. #4928

[Test] Add phpstan tool to test suite and fix detected errors. #4928

Conversation

johnsaigle commented Jul 4, 2019 • edited Loading

Brief summary of changes

johnsaigle commented Jul 4, 2019

xlecours commented Jul 9, 2019

johnsaigle commented Jul 9, 2019

xlecours commented Jul 10, 2019

driusan commented Jul 10, 2019

johnsaigle commented Jul 10, 2019

johnsaigle commented Oct 29, 2019

johnsaigle commented Oct 29, 2019

johnsaigle commented Oct 30, 2019

xlecours left a comment

Choose a reason for hiding this comment

driusan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnsaigle commented Jan 29, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnsaigle commented Jul 4, 2019 •

edited

Loading