Merge pull request #57 from nextcloud/fix/parameter-return-types

nextcloud · Dec 14, 2023 · f00db4c · f00db4c
2 parents 2e3ab22 + b9a20cc
commit f00db4c
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 10 deletions.
diff --git a/merge-specs b/merge-specs
@@ -97,7 +97,7 @@ function loadSpec(string $path): array {
 
 function rewriteRefs(array $spec): array {
 	$readableAppID = Helpers::generateReadableAppID($spec["info"]["title"]);
-	array_walk_recursive($spec, function (&$item, $key) use ($readableAppID) {
+	array_walk_recursive($spec, function (string &$item, string $key) use ($readableAppID) {
 		if ($key == "\$ref" && $item != "#/components/schemas/OCSMeta") {
 			$item = str_replace("#/components/schemas/", "#/components/schemas/" . $readableAppID, $item);
 		}
@@ -151,8 +151,9 @@ function rewriteOperations(array $spec): array {
 				$operation["tags"] = [$spec["info"]["title"]];
 			}
 			if ($firstStatusCode && array_key_exists("responses", $operation)) {
-				$firstStatusCode = array_key_first($operation["responses"]);
-				$operation["responses"] = [$firstStatusCode => $operation["responses"][$firstStatusCode]];
+				/** @var string $value */
+				$value = array_key_first($operation["responses"]);
+				$operation["responses"] = [$value => $operation["responses"][$value]];
 			}
 			if (array_key_exists("security", $operation)) {
 				for ($i = 0; $i < count($operation["security"]); $i++) {

diff --git a/src/ControllerMethod.php b/src/ControllerMethod.php
@@ -13,7 +13,7 @@
 class ControllerMethod {
 	/**
 	 * @param ControllerMethodParameter[] $parameters
-	 * @param ControllerMethodResponse[] $responses
+	 * @param list<ControllerMethodResponse|null> $responses
 	 * @param OpenApiType[] $returns
 	 * @param array<int, string> $responseDescription
 	 * @param string[] $description

diff --git a/src/ControllerMethodParameter.php b/src/ControllerMethodParameter.php
@@ -46,7 +46,7 @@ private static function exprToValue(string $context, Expr $expr): mixed {
 			return -self::exprToValue($context, $expr->expr);
 		}
 		if ($expr instanceof Array_) {
-			$values = array_map(fn (ArrayItem $item) => self::exprToValue($context, $item), $expr->items);
+			$values = array_map(fn (ArrayItem $item): mixed => self::exprToValue($context, $item), $expr->items);
 			$filteredValues = array_filter($values, fn (mixed $value) => $value !== null);
 			if (count($filteredValues) != count($values)) {
 				return null;

diff --git a/src/Helpers.php b/src/Helpers.php
@@ -57,7 +57,7 @@ public static function mapVerb(string $verb): string {
 		};
 	}
 
-	public static function mergeSchemas(array $schemas) {
+	public static function mergeSchemas(array $schemas): mixed {
 		if (!in_array(true, array_map(fn ($schema) => is_array($schema), $schemas))) {
 			$results = array_values(array_unique($schemas));
 			if (count($results) > 1) {
@@ -123,7 +123,7 @@ public static function wrapOCSResponse(Route $route, ControllerMethodResponse $r
 		return $schema;
 	}
 
-	public static function cleanEmptyResponseArray(array|stdClass $schema): array|stdClass {
+	public static function cleanEmptyResponseArray(array $schema): array|stdClass {
 		if (key_exists("type", $schema) && $schema["type"] == "array" && key_exists("maxLength", $schema) && $schema["maxLength"] === 0) {
 			return new stdClass();
 		}

diff --git a/src/Logger.php b/src/Logger.php
@@ -34,6 +34,9 @@ public static function warning(string $context, string $text): void {
 		self::log(LoggerLevel::Warning, $context, $text);
 	}
 
+	/**
+	 * @throws LoggerException
+	 */
 	public static function error(string $context, string $text): void {
 		if (self::$exitOnError) {
 			throw new LoggerException(LoggerLevel::Error, $context, $text);
@@ -42,6 +45,10 @@ public static function error(string $context, string $text): void {
 		}
 	}
 
+	/**
+	 * @throws LoggerException
+	 * @psalm-return no-return
+	 */
 	public static function panic(string $context, string $text): void {
 		throw new LoggerException(LoggerLevel::Error, $context, $text);
 	}

diff --git a/src/LoggerException.php b/src/LoggerException.php
@@ -5,6 +5,7 @@
 use Exception;
 
 class LoggerException extends Exception {
+	/** @psalm-suppress MissingParamType False-positive */
 	public function __construct(
 		public LoggerLevel $level,
 		public string $context,

diff --git a/src/OpenApiType.php b/src/OpenApiType.php
@@ -259,8 +259,9 @@ enum: [(int) $node->constExpr->value],
 
 	/**
 	 * @param OpenApiType[] $types
+	 * @return OpenApiType[]
 	 */
-	private static function mergeEnums(array $types) {
+	private static function mergeEnums(array $types): array {
 		$enums = [];
 		$nonEnums = [];
 

diff --git a/src/ResponseType.php b/src/ResponseType.php
@@ -159,7 +159,7 @@ public static function getAll(): array {
 	/**
 	 * @param string $context
 	 * @param TypeNode $obj
-	 * @return ControllerMethodResponse[]
+	 * @return list<ControllerMethodResponse|null>
 	 * @throws Exception
 	 */
 	public static function resolve(string $context, TypeNode $obj): array {

diff --git a/src/Route.php b/src/Route.php
@@ -36,7 +36,7 @@ public static function parseRoutes(string $path): array {
 		}
 	}
 
-	private static function includeRoutes(string $code) {
+	private static function includeRoutes(string $code): array {
 		$tmpPath = tempnam(sys_get_temp_dir(), "routes-");
 		file_put_contents($tmpPath, $code);
 		$routes = include($tmpPath);