1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-14 02:07:37 +01:00
psalm/src/Psalm/IssueBuffer.php

847 lines
26 KiB
PHP
Raw Normal View History

<?php
2016-07-26 00:37:44 +02:00
namespace Psalm;
use Psalm\Report\PhpStormReport;
2019-07-05 22:24:00 +02:00
use function array_pop;
use function array_search;
use function array_splice;
use function count;
use function debug_print_backtrace;
2019-07-05 22:24:00 +02:00
use function explode;
use function file_put_contents;
use function fwrite;
2019-07-05 22:24:00 +02:00
use function get_class;
use function memory_get_peak_usage;
use function microtime;
use function number_format;
use function ob_get_clean;
use function ob_start;
2020-02-17 00:24:40 +01:00
use Psalm\Internal\Analyzer\IssueData;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\ProjectAnalyzer;
2017-03-13 23:06:56 +01:00
use Psalm\Issue\CodeIssue;
2019-08-18 20:27:50 +02:00
use Psalm\Issue\UnusedPsalmSuppress;
use Psalm\Report\CheckstyleReport;
use Psalm\Report\CompactReport;
use Psalm\Report\ConsoleReport;
use Psalm\Report\EmacsReport;
use Psalm\Report\GithubActionsReport;
use Psalm\Report\JsonReport;
use Psalm\Report\JsonSummaryReport;
use Psalm\Report\JunitReport;
use Psalm\Report\PylintReport;
use Psalm\Report\SonarqubeReport;
use Psalm\Report\TextReport;
use Psalm\Report\XmlReport;
use function sha1;
2019-07-05 22:24:00 +02:00
use function str_repeat;
use function str_replace;
use function usort;
2020-01-22 13:42:00 +01:00
use function array_merge;
use function array_values;
use function in_array;
use const DEBUG_BACKTRACE_IGNORE_ARGS;
use const STDERR;
2016-06-26 21:18:40 +02:00
class IssueBuffer
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
/**
2020-02-17 00:24:40 +01:00
* @var array<string, list<IssueData>>
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
*/
protected static $issues_data = [];
2016-12-08 04:38:57 +01:00
/**
* @var array<int, array>
*/
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
protected static $console_issues = [];
2016-12-08 04:38:57 +01:00
/**
* @var array<string, int>
*/
protected static $fixable_issue_counts = [];
2016-11-02 07:29:00 +01:00
/**
* @var int
2016-11-02 07:29:00 +01:00
*/
protected static $error_count = 0;
2016-11-01 05:39:41 +01:00
2016-11-02 07:29:00 +01:00
/**
* @var array<string, bool>
*/
2016-10-19 00:55:53 +02:00
protected static $emitted = [];
2017-03-13 23:06:56 +01:00
/** @var int */
protected static $recording_level = 0;
/** @var array<int, array<int, CodeIssue>> */
protected static $recorded_issues = [];
2019-08-18 20:27:50 +02:00
/**
* @var array<string, array<int, int>>
*/
protected static $unused_suppressions = [];
2019-08-18 21:34:32 +02:00
/**
* @var array<string, array<int, bool>>
*/
protected static $used_suppressions = [];
2019-08-18 21:34:32 +02:00
2016-11-02 07:29:00 +01:00
/**
* @param string[] $suppressed_issues
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
*/
public static function accepts(CodeIssue $e, array $suppressed_issues = [], bool $is_fixable = false): bool
{
if (self::isSuppressed($e, $suppressed_issues)) {
return false;
}
return self::add($e, $is_fixable);
}
2019-08-18 20:27:50 +02:00
public static function addUnusedSuppression(string $file_path, int $offset, string $issue_type) : void
{
if ($issue_type === 'TaintedInput') {
return;
}
if (isset(self::$used_suppressions[$file_path][$offset])) {
2019-08-18 21:34:32 +02:00
return;
}
2019-08-18 20:27:50 +02:00
if (!isset(self::$unused_suppressions[$file_path])) {
self::$unused_suppressions[$file_path] = [];
}
self::$unused_suppressions[$file_path][$offset] = $offset + \strlen($issue_type) - 1;
}
/**
* @param string[] $suppressed_issues
*
*/
public static function isSuppressed(CodeIssue $e, array $suppressed_issues = []) : bool
{
2016-06-10 00:08:25 +02:00
$config = Config::getInstance();
$fqcn_parts = explode('\\', get_class($e));
$issue_type = array_pop($fqcn_parts);
2019-08-18 20:27:50 +02:00
$file_path = $e->getFilePath();
2019-08-18 20:27:50 +02:00
if (!$config->reportIssueInFile($issue_type, $file_path)) {
return true;
2016-06-10 00:08:25 +02:00
}
$suppressed_issue_position = array_search($issue_type, $suppressed_issues);
if ($suppressed_issue_position !== false) {
2019-08-18 21:34:32 +02:00
if (\is_int($suppressed_issue_position)) {
self::$used_suppressions[$file_path][$suppressed_issue_position] = true;
2019-08-18 21:34:32 +02:00
}
return true;
}
$parent_issue_type = Config::getParentIssueType($issue_type);
if ($parent_issue_type) {
$suppressed_issue_position = array_search($parent_issue_type, $suppressed_issues);
if ($suppressed_issue_position !== false) {
2019-08-18 21:34:32 +02:00
if (\is_int($suppressed_issue_position)) {
self::$used_suppressions[$file_path][$suppressed_issue_position] = true;
2019-08-18 21:34:32 +02:00
}
return true;
}
}
$suppress_all_position = array_search('all', $suppressed_issues);
if ($suppress_all_position !== false) {
if (\is_int($suppress_all_position)) {
self::$used_suppressions[$file_path][$suppress_all_position] = true;
}
return true;
}
$reporting_level = $config->getReportingLevelForIssue($e);
2019-05-03 23:12:20 +02:00
if ($reporting_level === Config::REPORT_SUPPRESS) {
return true;
}
if ($e->getLocation()->getLineNumber() === -1) {
return true;
}
2017-03-13 23:06:56 +01:00
if (self::$recording_level > 0) {
self::$recorded_issues[self::$recording_level][] = $e;
2017-05-25 04:07:49 +02:00
return true;
2017-03-13 23:06:56 +01:00
}
return false;
}
2016-11-02 07:29:00 +01:00
/**
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @throws Exception\CodeException
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
*/
public static function add(CodeIssue $e, bool $is_fixable = false): bool
{
$config = Config::getInstance();
$fqcn_parts = explode('\\', get_class($e));
$issue_type = array_pop($fqcn_parts);
2016-06-17 23:34:52 +02:00
2018-11-11 18:01:14 +01:00
$project_analyzer = ProjectAnalyzer::getInstance();
2018-11-11 18:01:14 +01:00
if (!$project_analyzer->show_issues) {
return false;
}
if ($project_analyzer->getCodebase()->taint && $issue_type !== 'TaintedInput') {
return false;
}
2019-05-03 23:12:20 +02:00
$reporting_level = $config->getReportingLevelForIssue($e);
2018-03-18 22:26:28 +01:00
if ($reporting_level === Config::REPORT_SUPPRESS) {
return false;
}
if ($config->debug_emitted_issues) {
ob_start();
debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
$trace = ob_get_clean();
fwrite(STDERR, "\nEmitting {$e->getShortLocation()} $issue_type {$e->getMessage()}\n$trace\n");
}
$emitted_key = $issue_type . '-' . $e->getShortLocation() . ':' . $e->getLocation()->getColumn();
if ($reporting_level === Config::REPORT_INFO) {
if ($issue_type === 'TaintedInput' || !self::alreadyEmitted($emitted_key)) {
2020-02-17 00:24:40 +01:00
self::$issues_data[$e->getFilePath()][] = $e->toIssueData(Config::REPORT_INFO);
}
2017-05-25 04:07:49 +02:00
return false;
}
if ($config->throw_exception) {
2019-05-17 00:36:36 +02:00
\Psalm\Internal\Analyzer\FileAnalyzer::clearCache();
$message = $e instanceof \Psalm\Issue\TaintedInput
? $e->getJourneyMessage()
: $e->getMessage();
2019-02-27 22:00:44 +01:00
throw new Exception\CodeException(
2019-02-27 22:16:19 +01:00
$issue_type
2019-05-27 16:07:56 +02:00
. ' - ' . $e->getShortLocationWithPrevious()
2019-02-27 22:16:19 +01:00
. ':' . $e->getLocation()->getColumn()
. ' - ' . $message
2019-02-27 22:00:44 +01:00
);
}
if ($issue_type === 'TaintedInput' || !self::alreadyEmitted($emitted_key)) {
++self::$error_count;
2020-02-17 00:24:40 +01:00
self::$issues_data[$e->getFilePath()][] = $e->toIssueData(Config::REPORT_ERROR);
2016-10-19 00:55:53 +02:00
}
2016-06-17 01:02:29 +02:00
if ($is_fixable) {
self::addFixableIssue($issue_type);
}
2016-08-08 20:36:18 +02:00
return true;
}
public static function remove(string $file_path, string $issue_type, int $file_offset) : void
{
if (!isset(self::$issues_data[$file_path])) {
return;
}
$filtered_issues = [];
foreach (self::$issues_data[$file_path] as $issue) {
2020-02-17 00:24:40 +01:00
if ($issue->type !== $issue_type || $issue->from !== $file_offset) {
$filtered_issues[] = $issue;
}
}
if (empty($filtered_issues)) {
unset(self::$issues_data[$file_path]);
} else {
self::$issues_data[$file_path] = $filtered_issues;
}
}
public static function addFixableIssue(string $issue_type) : void
{
if (isset(self::$fixable_issue_counts[$issue_type])) {
self::$fixable_issue_counts[$issue_type]++;
} else {
self::$fixable_issue_counts[$issue_type] = 1;
}
}
2016-12-08 04:38:57 +01:00
/**
2020-02-17 00:24:40 +01:00
* @return array<string, list<IssueData>>
2016-12-08 04:38:57 +01:00
*/
public static function getIssuesData(): array
2016-12-08 04:38:57 +01:00
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
return self::$issues_data;
2016-12-08 04:38:57 +01:00
}
/**
2020-02-17 00:24:40 +01:00
* @return list<IssueData>
*/
public static function getIssuesDataForFile(string $file_path)
{
return self::$issues_data[$file_path] ?? [];
}
/**
* @return array<string, int>
*/
public static function getFixableIssues(): array
{
return self::$fixable_issue_counts;
}
/**
* @param array<string, int> $fixable_issue_counts
*/
public static function addFixableIssues(array $fixable_issue_counts) : void
{
foreach ($fixable_issue_counts as $issue_type => $count) {
if (isset(self::$fixable_issue_counts[$issue_type])) {
self::$fixable_issue_counts[$issue_type] += $count;
} else {
self::$fixable_issue_counts[$issue_type] = $count;
}
}
}
2019-08-18 20:27:50 +02:00
/**
* @return array<string, array<int, int>>
*/
public static function getUnusedSuppressions() : array
{
return self::$unused_suppressions;
}
/**
* @return array<string, array<int, bool>>
*/
public static function getUsedSuppressions() : array
{
return self::$used_suppressions;
}
/**
* @param array<string, array<int, int>> $unused_suppressions
*/
2019-08-18 20:27:50 +02:00
public static function addUnusedSuppressions(array $unused_suppressions) : void
{
self::$unused_suppressions += $unused_suppressions;
}
/**
* @param array<string, array<int, bool>> $used_suppressions
*/
public static function addUsedSuppressions(array $used_suppressions) : void
{
foreach ($used_suppressions as $file => $offsets) {
if (!isset(self::$used_suppressions[$file])) {
self::$used_suppressions[$file] = $offsets;
} else {
self::$used_suppressions[$file] += $offsets;
}
}
}
2019-08-18 20:27:50 +02:00
public static function processUnusedSuppressions(\Psalm\Internal\Provider\FileProvider $file_provider) : void
{
$config = Config::getInstance();
foreach (self::$unused_suppressions as $file_path => $offsets) {
if (!$offsets) {
continue;
}
$file_contents = $file_provider->getContents($file_path);
foreach ($offsets as $start => $end) {
if (isset(self::$used_suppressions[$file_path][$start])) {
continue;
}
2019-08-18 20:27:50 +02:00
self::add(
new UnusedPsalmSuppress(
'This suppression is never used',
new CodeLocation\Raw(
$file_contents,
$file_path,
$config->shortenFileName($file_path),
$start,
$end
)
)
);
}
}
}
public static function getErrorCount(): int
{
return self::$error_count;
}
2016-12-08 04:38:57 +01:00
/**
2020-02-17 00:24:40 +01:00
* @param array<string, list<IssueData>> $issues_data
2017-05-27 02:16:18 +02:00
*
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
* @return void
2016-12-08 04:38:57 +01:00
*/
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
public static function addIssues(array $issues_data)
2016-12-08 04:38:57 +01:00
{
foreach ($issues_data as $file_path => $file_issues) {
foreach ($file_issues as $issue) {
2020-02-17 00:24:40 +01:00
$emitted_key = $issue->type
. '-' . $issue->file_name
. ':' . $issue->line_from
. ':' . $issue->column_from;
if (!self::alreadyEmitted($emitted_key)) {
self::$issues_data[$file_path][] = $issue;
}
2018-11-01 18:22:38 +01:00
}
}
2016-12-08 04:38:57 +01:00
}
2016-11-02 07:29:00 +01:00
/**
* @param array<string,array<string,array{o:int, s:array<int, string>}>> $issue_baseline
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return void
*/
2018-01-31 23:09:09 +01:00
public static function finish(
2018-11-11 18:01:14 +01:00
ProjectAnalyzer $project_analyzer,
bool $is_full,
float $start_time,
bool $add_stats = false,
array $issue_baseline = []
2018-01-31 23:09:09 +01:00
) {
if (!$project_analyzer->stdout_report_options) {
throw new \UnexpectedValueException('Cannot finish without stdout report options');
}
$codebase = $project_analyzer->getCodebase();
2018-03-18 23:04:50 +01:00
$error_count = 0;
$info_count = 0;
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
$issues_data = [];
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
if (self::$issues_data) {
if (in_array(
$project_analyzer->stdout_report_options->format,
[\Psalm\Report::TYPE_CONSOLE, \Psalm\Report::TYPE_PHP_STORM]
)) {
echo "\n";
}
\ksort(self::$issues_data);
foreach (self::$issues_data as $file_path => $file_issues) {
usort(
$file_issues,
2020-02-17 00:24:40 +01:00
function (IssueData $d1, IssueData $d2) : int {
if ($d1->file_path === $d2->file_path) {
if ($d1->line_from === $d2->line_from) {
if ($d1->column_from === $d2->column_from) {
return 0;
}
2020-02-17 00:24:40 +01:00
return $d1->column_from > $d2->column_from ? 1 : -1;
}
2020-02-17 00:24:40 +01:00
return $d1->line_from > $d2->line_from ? 1 : -1;
}
2020-02-17 00:24:40 +01:00
return $d1->file_path > $d2->file_path ? 1 : -1;
}
);
self::$issues_data[$file_path] = $file_issues;
}
// make a copy so what gets saved in cache is unaffected by baseline
$issues_data = self::$issues_data;
if (!empty($issue_baseline)) {
// Set severity for issues in baseline to INFO
foreach ($issues_data as $file_path => $file_issues) {
foreach ($file_issues as $key => $issue_data) {
2020-02-17 00:24:40 +01:00
$file = $issue_data->file_name;
$file = str_replace('\\', '/', $file);
2020-02-17 00:24:40 +01:00
$type = $issue_data->type;
if (isset($issue_baseline[$file][$type]) && $issue_baseline[$file][$type]['o'] > 0) {
if ($issue_baseline[$file][$type]['o'] === count($issue_baseline[$file][$type]['s'])) {
$position = array_search(
2020-02-17 00:24:40 +01:00
$issue_data->selected_text,
$issue_baseline[$file][$type]['s'],
true
);
if ($position !== false) {
2020-02-17 00:24:40 +01:00
$issue_data->severity = Config::REPORT_INFO;
array_splice($issue_baseline[$file][$type]['s'], $position, 1);
$issue_baseline[$file][$type]['o'] = $issue_baseline[$file][$type]['o'] - 1;
}
} else {
$issue_baseline[$file][$type]['s'] = [];
2020-02-17 00:24:40 +01:00
$issue_data->severity = Config::REPORT_INFO;
$issue_baseline[$file][$type]['o'] = $issue_baseline[$file][$type]['o'] - 1;
}
}
/** @psalm-suppress PropertyTypeCoercion due to Psalm bug */
$issues_data[$file_path][$key] = $issue_data;
}
}
}
}
echo self::getOutput(
$issues_data,
$project_analyzer->stdout_report_options,
$codebase->analyzer->getTotalTypeCoverage($codebase)
);
foreach ($issues_data as $file_issues) {
foreach ($file_issues as $issue_data) {
2020-02-17 00:24:40 +01:00
if ($issue_data->severity === Config::REPORT_ERROR) {
2018-03-18 23:04:50 +01:00
++$error_count;
} else {
++$info_count;
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
}
}
$after_analysis_hooks = $codebase->config->after_analysis;
if ($after_analysis_hooks) {
$source_control_info = null;
$build_info = (new \Psalm\Internal\ExecutionEnvironment\BuildInfoCollector($_SERVER))->collect();
try {
$source_control_info = (new \Psalm\Internal\ExecutionEnvironment\GitInfoCollector())->collect();
} catch (\RuntimeException $e) {
// do nothing
}
foreach ($after_analysis_hooks as $after_analysis_hook) {
/** @psalm-suppress ArgumentTypeCoercion due to Psalm bug */
$after_analysis_hook::afterAnalysis(
$codebase,
$issues_data,
$build_info,
$source_control_info
);
}
}
foreach ($project_analyzer->generated_report_options as $report_options) {
if (!$report_options->output_path) {
throw new \UnexpectedValueException('Output path should not be null here');
}
file_put_contents(
$report_options->output_path,
2019-05-11 00:07:13 +02:00
self::getOutput(
$issues_data,
$report_options,
2019-05-11 00:07:13 +02:00
$codebase->analyzer->getTotalTypeCoverage($codebase)
)
);
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
if (in_array(
$project_analyzer->stdout_report_options->format,
[\Psalm\Report::TYPE_CONSOLE, \Psalm\Report::TYPE_PHP_STORM]
)) {
echo str_repeat('-', 30) . "\n";
2018-03-18 23:04:50 +01:00
if ($error_count) {
2019-07-05 22:24:00 +02:00
echo($project_analyzer->stdout_report_options->use_color
? "\e[0;31m" . $error_count . " errors\e[0m"
: $error_count . ' errors'
) . ' found' . "\n";
} else {
echo 'No errors found!' . "\n";
}
$show_info = $project_analyzer->stdout_report_options->show_info;
$show_suggestions = $project_analyzer->stdout_report_options->show_suggestions;
if ($info_count && ($show_info || $show_suggestions)) {
echo str_repeat('-', 30) . "\n";
echo $info_count . ' other issues found.' . "\n";
2020-02-17 22:33:28 +01:00
if (!$show_info) {
echo 'You can display them with ' .
($project_analyzer->stdout_report_options->use_color
2020-02-17 22:33:28 +01:00
? "\e[30;48;5;195m--show-info=true\e[0m"
: '--show-info=true') . "\n";
}
}
if (self::$fixable_issue_counts && $show_suggestions && !$codebase->taint) {
echo str_repeat('-', 30) . "\n";
$total_count = \array_sum(self::$fixable_issue_counts);
$command = '--alter --issues=' . \implode(',', \array_keys(self::$fixable_issue_counts));
$command .= ' --dry-run';
echo 'Psalm can automatically fix ' . $total_count
2020-02-17 22:33:28 +01:00
. ($show_info ? ' issues' : ' of these issues') . ".\n"
. 'Run Psalm again with ' . "\n"
. ($project_analyzer->stdout_report_options->use_color
? "\e[30;48;5;195m" . $command . "\e[0m"
: $command) . "\n"
. 'to see what it can fix.' . "\n";
}
echo str_repeat('-', 30) . "\n" . "\n";
2018-03-18 23:04:50 +01:00
if ($start_time) {
2018-10-10 22:05:06 +02:00
echo 'Checks took ' . number_format(microtime(true) - $start_time, 2) . ' seconds';
echo ' and used ' . number_format(memory_get_peak_usage() / (1024 * 1024), 3) . 'MB of memory' . "\n";
$analysis_summary = $codebase->analyzer->getTypeInferenceSummary($codebase);
echo $analysis_summary . "\n";
2018-01-31 23:09:09 +01:00
if ($add_stats) {
echo '-----------------' . "\n";
2018-11-06 03:57:36 +01:00
echo $codebase->analyzer->getNonMixedStats();
echo "\n";
}
if ($project_analyzer->debug_performance) {
echo '-----------------' . "\n";
echo 'Slow-to-analyze functions' . "\n";
echo '-----------------' . "\n\n";
$function_timings = $codebase->analyzer->getFunctionTimings();
\arsort($function_timings);
$i = 0;
foreach ($function_timings as $function_id => $time) {
if (++$i > 10) {
break;
}
echo $function_id . ': ' . \round(1000 * $time, 2) . 'ms per node' . "\n";
}
echo "\n";
}
}
2016-12-15 01:24:16 +01:00
}
if ($is_full && $start_time) {
$codebase->file_reference_provider->removeDeletedFilesFromReferences();
if ($project_analyzer->project_cache_provider) {
$project_analyzer->project_cache_provider->processSuccessfulRun($start_time);
}
if ($codebase->statements_provider->parser_cache_provider) {
$codebase->statements_provider->parser_cache_provider->processSuccessfulRun();
}
2016-10-07 06:58:08 +02:00
}
if ($error_count) {
exit(1);
}
}
2016-10-19 00:55:53 +02:00
2016-10-30 17:46:18 +01:00
/**
* @param array<string, array<int, IssueData>> $issues_data
2019-05-11 00:07:13 +02:00
* @param array{int, int} $mixed_counts
*
*/
2019-05-11 00:07:13 +02:00
public static function getOutput(
array $issues_data,
\Psalm\Report\ReportOptions $report_options,
2019-05-11 00:07:13 +02:00
array $mixed_counts = [0, 0]
): string {
2019-05-11 00:07:13 +02:00
$total_expression_count = $mixed_counts[0] + $mixed_counts[1];
$mixed_expression_count = $mixed_counts[0];
$normalized_data = $issues_data === [] ? [] : array_merge(...array_values($issues_data));
switch ($report_options->format) {
case Report::TYPE_COMPACT:
$output = new CompactReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_EMACS:
$output = new EmacsReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_TEXT:
$output = new TextReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_JSON:
$output = new JsonReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_JSON_SUMMARY:
$output = new JsonSummaryReport(
$normalized_data,
self::$fixable_issue_counts,
$report_options,
2019-05-11 00:07:13 +02:00
$mixed_expression_count,
$total_expression_count
);
break;
case Report::TYPE_SONARQUBE:
$output = new SonarqubeReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_PYLINT:
$output = new PylintReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_CHECKSTYLE:
$output = new CheckstyleReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_XML:
$output = new XmlReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_JUNIT:
$output = new JUnitReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_CONSOLE:
$output = new ConsoleReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_GITHUB_ACTIONS:
$output = new GithubActionsReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
case Report::TYPE_PHP_STORM:
$output = new PhpStormReport($normalized_data, self::$fixable_issue_counts, $report_options);
break;
}
return $output->create();
}
protected static function alreadyEmitted(string $message): bool
2016-10-19 00:55:53 +02:00
{
$sham = sha1($message);
if (isset(self::$emitted[$sham])) {
return true;
}
self::$emitted[$sham] = true;
return false;
}
/**
* @return void
*/
public static function clearCache()
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
self::$issues_data = [];
self::$emitted = [];
self::$error_count = 0;
2017-03-13 23:06:56 +01:00
self::$recording_level = 0;
self::$recorded_issues = [];
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
self::$console_issues = [];
2019-08-18 20:27:50 +02:00
self::$unused_suppressions = [];
self::$used_suppressions = [];
2017-03-13 23:06:56 +01:00
}
/**
2020-02-17 00:24:40 +01:00
* @return array<string, list<IssueData>>
*/
public static function clear(): array
{
$current_data = self::$issues_data;
self::$issues_data = [];
self::$emitted = [];
2019-07-05 22:24:00 +02:00
return $current_data;
}
public static function isRecording(): bool
2017-06-29 06:28:37 +02:00
{
return self::$recording_level > 0;
}
2017-03-13 23:06:56 +01:00
/**
* @return void
*/
public static function startRecording()
{
2017-05-27 02:05:57 +02:00
++self::$recording_level;
2017-03-13 23:06:56 +01:00
self::$recorded_issues[self::$recording_level] = [];
}
/**
* @return void
*/
public static function stopRecording()
{
if (self::$recording_level === 0) {
throw new \UnexpectedValueException('Cannot stop recording - already at base level');
}
2017-05-27 02:05:57 +02:00
--self::$recording_level;
2017-03-13 23:06:56 +01:00
}
/**
* @return array<int, CodeIssue>
*/
public static function clearRecordingLevel(): array
2017-03-13 23:06:56 +01:00
{
if (self::$recording_level === 0) {
throw new \UnexpectedValueException('Not currently recording');
}
$recorded_issues = self::$recorded_issues[self::$recording_level];
self::$recorded_issues[self::$recording_level] = [];
return $recorded_issues;
}
/**
* @return void
*/
public static function bubbleUp(CodeIssue $e)
{
if (self::$recording_level === 0) {
self::add($e);
2017-05-25 04:07:49 +02:00
2017-03-13 23:06:56 +01:00
return;
}
self::$recorded_issues[self::$recording_level][] = $e;
}
}