Skip to content
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

feat(generate-spec): Disallow unused schemas #196

Merged
merged 3 commits into from
Dec 17, 2024
Merged

feat(generate-spec): Disallow unused schemas #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a0c7d9
refactor(generate-spec): Use correct variable name for used refs
provokateurin Dec 17, 2024
3378afd
feat(generate-spec): Disallow unused schemas
provokateurin Dec 17, 2024
86dfdc3
test: Add capabilities tests
provokateurin Dec 17, 2024
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
24 changes: 16 additions & 8 deletions generate-spec.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,6 +940,8 @@
}
}

$usedSchemas = ['Capabilities', 'PublicCapabilities'];

foreach ($scopePaths as $scope => $paths) {
$openapiScope = $openapi;

Expand All @@ -955,29 +957,29 @@
$openapiScope['paths'] = array_merge(...$fullScopePathArrays);
$openapiScope['components']['schemas'] = $schemas;
} else {
$usedSchemas = [];
$usedRefs = [];
foreach ($paths as $urlRoutes) {
foreach ($urlRoutes as $routeData) {
foreach ($routeData['responses'] as $responseData) {
if (isset($responseData['content']) && $responseData['content'] !== []) {
$usedSchemas[] = Helpers::collectUsedRefs($responseData['content']);
$usedRefs[] = Helpers::collectUsedRefs($responseData['content']);
}
}
if (isset($routeData['requestBody']['content']) && $routeData['requestBody']['content'] !== []) {
$usedSchemas[] = Helpers::collectUsedRefs($routeData['requestBody']['content']);
$usedRefs[] = Helpers::collectUsedRefs($routeData['requestBody']['content']);
}
}
}

$usedSchemas = array_merge(...$usedSchemas);
$usedRefs = array_merge(...$usedRefs);

$scopedSchemas = [];
while ($usedSchema = array_shift($usedSchemas)) {
if (!str_starts_with((string)$usedSchema, '#/components/schemas/')) {
while ($usedRef = array_shift($usedRefs)) {
if (!str_starts_with((string)$usedRef, '#/components/schemas/')) {
continue;
}

$schemaName = substr((string)$usedSchema, strlen('#/components/schemas/'));
$schemaName = substr((string)$usedRef, strlen('#/components/schemas/'));

if (!isset($schemas[$schemaName])) {
Logger::error('app', "Schema $schemaName used by scope $scope is not defined");
Expand All @@ -986,11 +988,12 @@
$newRefs = Helpers::collectUsedRefs($schemas[$schemaName]);
foreach ($newRefs as $newRef) {
if (!isset($scopedSchemas[substr((string)$newRef, strlen('#/components/schemas/'))])) {
$usedSchemas[] = $newRef;
$usedRefs[] = $newRef;
}
}

$scopedSchemas[$schemaName] = $schemas[$schemaName];
$usedSchemas[] = $schemaName;
}

if (isset($schemas['Capabilities'])) {
Expand Down Expand Up @@ -1031,6 +1034,11 @@
Logger::info('app', 'Generated scope ' . $scope . ' with ' . $pathsCount . ' routes!');
}

$unusedSchemas = array_diff(array_keys($schemas), $usedSchemas);
if ($unusedSchemas !== []) {
Logger::error('app', 'Unused schemas: ' . implode(', ', $unusedSchemas));
}

if (Logger::$errorCount > 0) {
Logger::panic('app', 'Encountered ' . Logger::$errorCount . ' errors that need to be fixed!');
}
21 changes: 21 additions & 0 deletions tests/lib/Capabilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\Notifications;

use OCP\Capabilities\ICapability;

class Capabilities implements ICapability {
/**
* @return array{test: array{a: int}}
*/
public function getCapabilities(): array {
return [];
}
}
21 changes: 21 additions & 0 deletions tests/lib/PublicCapabilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\Notifications;

use OCP\Capabilities\IPublicCapability;

class PublicCapabilities implements IPublicCapability {
/**
* @return array{test: array{b: string}}
*/
public function getCapabilities(): array {
return [];
}
}
39 changes: 39 additions & 0 deletions tests/openapi-administration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,26 @@
}
},
"schemas": {
"Capabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"a"
],
"properties": {
"a": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"OCSMeta": {
"type": "object",
"required": [
Expand All @@ -44,6 +64,25 @@
}
}
},
"PublicCapabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"b"
],
"properties": {
"b": {
"type": "string"
}
}
}
}
},
"PushDevice": {
"allOf": [
{
Expand Down
39 changes: 39 additions & 0 deletions tests/openapi-ex_app.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,26 @@
}
},
"schemas": {
"Capabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"a"
],
"properties": {
"a": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"OCSMeta": {
"type": "object",
"required": [
Expand All @@ -43,6 +63,25 @@
"type": "string"
}
}
},
"PublicCapabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"b"
],
"properties": {
"b": {
"type": "string"
}
}
}
}
}
}
},
Expand Down
39 changes: 39 additions & 0 deletions tests/openapi-federation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,26 @@
}
},
"schemas": {
"Capabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"a"
],
"properties": {
"a": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"OCSMeta": {
"type": "object",
"required": [
Expand All @@ -43,6 +63,25 @@
"type": "string"
}
}
},
"PublicCapabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"b"
],
"properties": {
"b": {
"type": "string"
}
}
}
}
}
}
},
Expand Down
39 changes: 39 additions & 0 deletions tests/openapi-full.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,26 @@
}
},
"schemas": {
"Capabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"a"
],
"properties": {
"a": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"Collection": {
"type": "array",
"items": {
Expand Down Expand Up @@ -179,6 +199,25 @@
}
}
},
"PublicCapabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"b"
],
"properties": {
"b": {
"type": "string"
}
}
}
}
},
"PushDevice": {
"allOf": [
{
Expand Down
39 changes: 39 additions & 0 deletions tests/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,26 @@
}
},
"schemas": {
"Capabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"a"
],
"properties": {
"a": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"Collection": {
"type": "array",
"items": {
Expand Down Expand Up @@ -179,6 +199,25 @@
}
}
},
"PublicCapabilities": {
"type": "object",
"required": [
"test"
],
"properties": {
"test": {
"type": "object",
"required": [
"b"
],
"properties": {
"b": {
"type": "string"
}
}
}
}
},
"RequestProperty": {
"type": "object",
"required": [
Expand Down
Loading