Skip to content

fix(ControllerMethod): Log an error if return statements are detected but no @return annotation is present #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
provokateurin merged 2 commits into from
May 13, 2025
Merged

fix(ControllerMethod): Log an error if return statements are detected but no @return annotation is present #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d90738
chore(ControllerMethod): Remove unused property
provokateurin May 13, 2025
3d10236
fix(ControllerMethod): Log an error if return statements are detected…
provokateurin May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions generate-spec.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,10 +520,6 @@
}

$classMethodInfo = ControllerMethod::parse($routeName, $definitions, $methodFunction, $isAdmin, $isDeprecated, $isPasswordConfirmation, $isCORS);
if ($classMethodInfo->returns !== []) {
Logger::error($routeName, 'Returns an invalid response');
continue;
}
if (count($classMethodInfo->responses) == 0) {
Logger::error($routeName, 'Returns no responses');
continue;
Expand Down
16 changes: 12 additions & 4 deletions src/ControllerMethod.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
namespace OpenAPIExtractor;

use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Return_;
use PHPStan\PhpDocParser\Ast\PhpDoc\DeprecatedTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
Expand All @@ -30,7 +31,6 @@ class ControllerMethod {
public function __construct(
public array $parameters,
public array $responses,
public array $returns,
public array $responseDescription,
public array $description,
public ?string $summary,
Expand All @@ -46,18 +46,20 @@ public static function parse(string $context,
bool $isPasswordConfirmation,
bool $isCORS,
): ControllerMethod {
global $phpDocParser, $lexer, $allowMissingDocs;
global $phpDocParser, $lexer, $nodeFinder, $allowMissingDocs;

$parameters = [];
$responses = [];
$responseDescriptions = [];
$returns = [];

$methodDescription = [];
$methodSummary = null;
$methodParameters = $method->getParams();
$docParameters = [];

$returnStmtCount = count($nodeFinder->findInstanceOf($method->getStmts(), Return_::class));
$returnTagCount = 0;

$doc = $method->getDocComment()?->getText();
if ($doc !== null) {
$docNodes = $phpDocParser->parse(new TokenIterator($lexer->tokenize($doc)))->children;
Expand Down Expand Up @@ -111,6 +113,8 @@ public static function parse(string $context,
}

if ($docNode->value instanceof ReturnTagValueNode) {
$returnTagCount++;

$type = $docNode->value->type;

$responses = array_merge($responses, ResponseType::resolve($context . ': @return', $type));
Expand Down Expand Up @@ -138,6 +142,10 @@ public static function parse(string $context,
}
}

if ($returnStmtCount !== 0 && $returnTagCount === 0) {
Logger::error($context, 'Missing @return annotation');
}

if (!$allowMissingDocs) {
foreach (array_unique(array_map(fn (ControllerMethodResponse $response): int => $response->statusCode, array_filter($responses, fn (?ControllerMethodResponse $response): bool => $response != null))) as $statusCode) {
if ($statusCode < 500 && (!array_key_exists($statusCode, $responseDescriptions) || $responseDescriptions[$statusCode] === '')) {
Expand Down Expand Up @@ -266,7 +274,7 @@ public static function parse(string $context,
Logger::warning($context, 'Summary ends with a punctuation mark');
}

return new ControllerMethod($parameters, $responses, $returns, $responseDescriptions, $methodDescription, $methodSummary, $isDeprecated);
return new ControllerMethod($parameters, $responses, $responseDescriptions, $methodDescription, $methodSummary, $isDeprecated);
}

}
Loading