Add sanity check in regenerating doc pages #518
Conversation
| @@ -620,7 +620,7 @@ private static function parse_docblock( $docblock ) { | |||
| $ret['description'] .= PHP_EOL . "{$extra_line}{$info}"; | |||
| } else { | |||
| preg_match( '/@(\w+)/', $info, $matches ); | |||
| $param_name = $matches[1]; | |||
| $param_name = count( $matches ) > 1 ? $matches[1] : null; | |||
There was a problem hiding this comment.
As per #507 (comment), the code used to work but has recently started generating PHP warnings. Can we investigate the root cause of this issue? The preg_match function may be returning an unexpected null value, and this safeguard may prematurely terminate the required documentation generation.
There was a problem hiding this comment.
Hi @thelovekesh
Actually this ran a preg_match and in the next line we are getting the 2nd value of the $matches value without any proper conditional check if the 2nd index is present or not.
So, that's why these warnings were getting generated in the local, that "can't access this index of $matches".
So, therefore I am just adding a sanity check over here to check if the index is present, then only take that value, else assign it as null, which was anyhow happening if undefined index was accessed. Therefore as far I am seeing there shouldn't be any functional change in this change.
Please let me know if I am missing something and this can cause any regression functional change, as per you have mentioned.
There was a problem hiding this comment.
I tested this change in a separate PR. Yes, PHP error is now gone but parsing of docs of internal-api is not correct. If you like you can check this diff
There was a problem hiding this comment.
@ernilambar Thank you for pointing this out. Not sure how this is causing such a significant change. Will surely look into it to find the root cause of it.
|
This PR should fix the issue #520 |
Fixes: #507
internal-apiwas failing because of the warnings thrown by the following code.preg_matchwould always find a match.parse_docblockmethod to handle invalid JSON output gracefully.