Skip to content

Commit 6873693

Browse files
soyukasoyuka
committed
Merge branch 'feature/empty-item-operations' into 2.5
2 parents 98b0e59 + 5aa6f20 commit 6873693

File tree

24 files changed

+354
-88
lines changed

24 files changed

+354
-88
lines changed

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"friendsofsymfony/user-bundle": "^2.2@dev",
4444
"guzzlehttp/guzzle": "^6.0",
4545
"jangregor/phpstan-prophecy": "^0.4.2",
46-
"justinrainbow/json-schema": "^5.0",
46+
"justinrainbow/json-schema": "^5.2.1",
4747
"nelmio/api-doc-bundle": "^2.13.4",
4848
"phpdocumentor/reflection-docblock": "^3.0 || ^4.0",
4949
"phpdocumentor/type-resolver": "^0.3 || ^0.4",

‎features/main/operation.feature‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,11 @@ Feature: Operation support
5555
}
5656
}
5757
"""
58+
59+
Scenario: Get the collection of a resource that doesn't have a defined item operation
60+
When I send a "GET" request to "/disable_item_operations"
61+
Then the response status code should be 200
62+
63+
Scenario: Do not get a resource that doesn't have a defined item operation
64+
When I send a "GET" request to "/disable_item_operations/1"
65+
Then the response status code should be 404

‎phpstan.neon.dist‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ parameters:
5454
-
5555
message: '#Parameter \#1 \$docblock of method phpDocumentor\\Reflection\\DocBlockFactoryInterface::create\(\) expects string, ReflectionClass given\.#'
5656
path: %currentWorkingDirectory%/src/Metadata/Resource/Factory/PhpDocResourceMetadataFactory.php
57+
-
58+
message: '#Parameter \#1 \$objectValue of method GraphQL\\Type\\Definition\\InterfaceType::resolveType\(\) expects object, array(<string, string>)? given.#'
59+
path: %currentWorkingDirectory%/tests/GraphQl/Type/TypeBuilderTest.php
5760
-
5861
message: '#Property ApiPlatform\\Core\\Test\\DoctrineMongoDbOdmFilterTestCase::\$repository \(Doctrine\\ODM\\MongoDB\\Repository\\DocumentRepository\) does not accept Doctrine\\ORM\\EntityRepository<ApiPlatform\\Core\\Tests\\Fixtures\\TestBundle\\Document\\Dummy>\.#'
5962
path: %currentWorkingDirectory%/src/Test/DoctrineMongoDbOdmFilterTestCase.php
@@ -78,7 +81,10 @@ parameters:
7881
-
7982
message: '#Binary operation "\+" between (float\|int\|)?string and 0 results in an error\.#'
8083
path: %currentWorkingDirectory%/src/Bridge/Doctrine/Common/Filter/RangeFilterTrait.php
81-
- '#Parameter \#1 \$objectValue of method GraphQL\\Type\\Definition\\InterfaceType::resolveType\(\) expects object, array(<string, string>)? given.#'
84+
# https://github.com/phpstan/phpstan-symfony/issues/27
85+
-
86+
message: '#Service "api_platform\.json_schema\.schema_factory" is private\.#'
87+
path: %currentWorkingDirectory%/src/Bridge/Symfony/Bundle/Test/ApiTestAssertionsTrait.php
8288

8389
# Expected, due to optional interfaces
8490
- '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryCollectionExtensionInterface::applyToCollection\(\) invoked with 5 parameters, 3-4 required\.#'

‎src/Action/NotFoundAction.php‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the API Platform project.
5+
*
6+
* (c) Kévin Dunglas <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
declare(strict_types=1);
13+
14+
namespace ApiPlatform\Core\Action;
15+
16+
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
17+
18+
/**
19+
* Not found action.
20+
*
21+
* @author Antoine Bluchet <[email protected]>
22+
*/
23+
final class NotFoundAction
24+
{
25+
public function __invoke()
26+
{
27+
throw new NotFoundHttpException();
28+
}
29+
}

‎src/Bridge/Symfony/Bundle/Resources/config/api.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@
230230
<service id="api_platform.action.put_item" alias="api_platform.action.placeholder" public="true" />
231231
<service id="api_platform.action.delete_item" alias="api_platform.action.placeholder" public="true" />
232232
<service id="api_platform.action.get_subresource" alias="api_platform.action.placeholder" public="true" />
233+
<service id="api_platform.action.not_found" class="ApiPlatform\Core\Action\NotFoundAction" public="true" />
234+
<service id="ApiPlatform\Core\Action\NotFoundAction" alias="api_platform.action.not_found" public="true" />
233235

234236
<service id="api_platform.action.entrypoint" class="ApiPlatform\Core\Action\EntrypointAction" public="true">
235237
<argument type="service" id="api_platform.metadata.resource.name_collection_factory" />

‎src/Bridge/Symfony/Bundle/Test/ApiTestAssertionsTrait.php‎

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,13 @@
1313

1414
namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;
1515

16+
use ApiPlatform\Core\Api\OperationType;
1617
use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint\ArraySubset;
1718
use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint\MatchesJsonSchema;
19+
use ApiPlatform\Core\JsonSchema\Schema;
20+
use ApiPlatform\Core\JsonSchema\SchemaFactoryInterface;
1821
use PHPUnit\Framework\ExpectationFailedException;
22+
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
1923
use Symfony\Contracts\HttpClient\ResponseInterface;
2024

2125
/**
@@ -28,9 +32,9 @@ trait ApiTestAssertionsTrait
2832
use BrowserKitAssertionsTrait;
2933

3034
/**
31-
* Asserts that the retrieved JSON contains has the specified subset.
35+
* Asserts that the retrieved JSON contains the specified subset.
3236
*
33-
* This method delegates to self::assertArraySubset().
37+
* This method delegates to static::assertArraySubset().
3438
*
3539
* @param array|string $subset
3640
*
@@ -91,18 +95,34 @@ public static function assertJsonEquals($json, string $message = ''): void
9195
public static function assertArraySubset($subset, $array, bool $checkForObjectIdentity = false, string $message = ''): void
9296
{
9397
$constraint = new ArraySubset($subset, $checkForObjectIdentity);
98+
9499
static::assertThat($array, $constraint, $message);
95100
}
96101

97102
/**
98-
* @param array|string $jsonSchema
103+
* @param object|array|string $jsonSchema
99104
*/
100105
public static function assertMatchesJsonSchema($jsonSchema, ?int $checkMode = null, string $message = ''): void
101106
{
102107
$constraint = new MatchesJsonSchema($jsonSchema, $checkMode);
108+
103109
static::assertThat(self::getHttpResponse()->toArray(false), $constraint, $message);
104110
}
105111

112+
public static function assertMatchesResourceCollectionJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
113+
{
114+
$schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::COLLECTION, $operationName);
115+
116+
static::assertMatchesJsonSchema($schema);
117+
}
118+
119+
public static function assertMatchesResourceItemJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
120+
{
121+
$schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::ITEM, $operationName);
122+
123+
static::assertMatchesJsonSchema($schema);
124+
}
125+
106126
private static function getHttpClient(Client $newClient = null): ?Client
107127
{
108128
static $client;
@@ -126,4 +146,16 @@ private static function getHttpResponse(): ResponseInterface
126146

127147
return $response;
128148
}
149+
150+
private static function getSchemaFactory(): SchemaFactoryInterface
151+
{
152+
try {
153+
/** @var SchemaFactoryInterface $schemaFactory */
154+
$schemaFactory = static::$container->get('api_platform.json_schema.schema_factory');
155+
} catch (ServiceNotFoundException $e) {
156+
throw new \LogicException('You cannot use the resource JSON Schema assertions if the "api_platform.swagger.versions" config is null or empty.');
157+
}
158+
159+
return $schemaFactory;
160+
}
129161
}

‎src/Bridge/Symfony/Bundle/Test/Constraint/MatchesJsonSchema.php‎

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,19 @@
2525
*/
2626
final class MatchesJsonSchema extends Constraint
2727
{
28+
/**
29+
* @var object|array
30+
*/
2831
private $schema;
2932
private $checkMode;
3033

3134
/**
32-
* @param array|string $schema
35+
* @param object|array|string $schema
3336
*/
3437
public function __construct($schema, ?int $checkMode = null)
3538
{
39+
$this->schema = \is_string($schema) ? json_decode($schema) : $schema;
3640
$this->checkMode = $checkMode;
37-
$this->schema = \is_array($schema) ? (object) $schema : json_decode($schema);
3841
}
3942

4043
/**
@@ -46,15 +49,15 @@ public function toString(): string
4649
}
4750

4851
/**
49-
* @param array $other
52+
* {@inheritdoc}
5053
*/
5154
protected function matches($other): bool
5255
{
5356
if (!class_exists(Validator::class)) {
54-
throw new \RuntimeException('The "justinrainbow/json-schema" library must be installed to use "assertMatchesJsonSchema()". Try running "composer require --dev justinrainbow/json-schema".');
57+
throw new \LogicException('The "justinrainbow/json-schema" library must be installed to use "assertMatchesJsonSchema()". Try running "composer require --dev justinrainbow/json-schema".');
5558
}
5659

57-
$other = (object) $other;
60+
$other = $this->normalizeJson($other);
5861

5962
$validator = new Validator();
6063
$validator->validate($other, $this->schema, $this->checkMode);
@@ -63,14 +66,14 @@ protected function matches($other): bool
6366
}
6467

6568
/**
66-
* @param object $other
69+
* {@inheritdoc}
6770
*/
6871
protected function additionalFailureDescription($other): string
6972
{
70-
$other = (object) $other;
73+
$other = $this->normalizeJson($other);
7174

7275
$validator = new Validator();
73-
$validator->check($other, $this->schema);
76+
$validator->validate($other, $this->schema, $this->checkMode);
7477

7578
$errors = [];
7679
foreach ($validator->getErrors() as $error) {
@@ -80,4 +83,32 @@ protected function additionalFailureDescription($other): string
8083

8184
return implode("\n", $errors);
8285
}
86+
87+
/**
88+
* Normalizes a JSON document.
89+
*
90+
* Specifically, we should ensure that:
91+
* 1. a JSON object is represented as a PHP object, not as an associative array.
92+
*/
93+
private function normalizeJson($document)
94+
{
95+
if (is_scalar($document) || \is_object($document)) {
96+
return $document;
97+
}
98+
99+
if (!\is_array($document)) {
100+
throw new \InvalidArgumentException('Document must be scalar, array or object.');
101+
}
102+
103+
$document = json_encode($document);
104+
if (!\is_string($document)) {
105+
throw new \UnexpectedValueException('JSON encode failed.');
106+
}
107+
$document = json_decode($document);
108+
if (!\is_array($document) && !\is_object($document)) {
109+
throw new \UnexpectedValueException('JSON decode failed.');
110+
}
111+
112+
return $document;
113+
}
83114
}

‎src/Hydra/JsonSchema/SchemaFactory.php‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ public function __construct(BaseSchemaFactory $schemaFactory)
4747
/**
4848
* {@inheritdoc}
4949
*/
50-
public function buildSchema(string $resourceClass, string $format = 'jsonld', bool $output = true, ?string $operationType = null, ?string $operationName = null, ?Schema $schema = null, ?array $serializerContext = null, bool $forceCollection = false): Schema
50+
public function buildSchema(string $resourceClass, string $format = 'jsonld', string $type = Schema::TYPE_OUTPUT, ?string $operationType = null, ?string $operationName = null, ?Schema $schema = null, ?array $serializerContext = null, bool $forceCollection = false): Schema
5151
{
52-
$schema = $this->schemaFactory->buildSchema($resourceClass, $format, $output, $operationType, $operationName, $schema, $serializerContext, $forceCollection);
52+
$schema = $this->schemaFactory->buildSchema($resourceClass, $format, $type, $operationType, $operationName, $schema, $serializerContext, $forceCollection);
5353
if ('jsonld' !== $format) {
5454
return $schema;
5555
}
@@ -74,24 +74,29 @@ public function buildSchema(string $resourceClass, string $format = 'jsonld', bo
7474
],
7575
'hydra:totalItems' => [
7676
'type' => 'integer',
77-
'minimum' => 1,
77+
'minimum' => 0,
7878
],
7979
'hydra:view' => [
8080
'type' => 'object',
8181
'properties' => [
82-
'@id' => ['type' => 'string'],
83-
'@type' => ['type' => 'string'],
82+
'@id' => [
83+
'type' => 'string',
84+
'format' => 'iri-reference',
85+
],
86+
'@type' => [
87+
'type' => 'string',
88+
],
8489
'hydra:first' => [
85-
'type' => 'integer',
86-
'minimum' => 1,
90+
'type' => 'string',
91+
'format' => 'iri-reference',
8792
],
8893
'hydra:last' => [
89-
'type' => 'integer',
90-
'minimum' => 1,
94+
'type' => 'string',
95+
'format' => 'iri-reference',
9196
],
9297
'hydra:next' => [
93-
'type' => 'integer',
94-
'minimum' => 1,
98+
'type' => 'string',
99+
'format' => 'iri-reference',
95100
],
96101
],
97102
],
@@ -116,6 +121,9 @@ public function buildSchema(string $resourceClass, string $format = 'jsonld', bo
116121
],
117122
],
118123
];
124+
$schema['required'] = [
125+
'hydra:member',
126+
];
119127

120128
return $schema;
121129
}

‎src/JsonSchema/Command/JsonSchemaGenerateCommand.php‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
namespace ApiPlatform\Core\JsonSchema\Command;
1515

1616
use ApiPlatform\Core\Api\OperationType;
17+
use ApiPlatform\Core\JsonSchema\Schema;
1718
use ApiPlatform\Core\JsonSchema\SchemaFactoryInterface;
1819
use Symfony\Component\Console\Command\Command;
1920
use Symfony\Component\Console\Exception\InvalidOptionException;
@@ -53,7 +54,7 @@ protected function configure()
5354
->addOption('itemOperation', null, InputOption::VALUE_REQUIRED, 'The item operation')
5455
->addOption('collectionOperation', null, InputOption::VALUE_REQUIRED, 'The collection operation')
5556
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The response format', (string) $this->formats[0])
56-
->addOption('type', null, InputOption::VALUE_REQUIRED, 'The type of schema to generate (input or output)', 'input');
57+
->addOption('type', null, InputOption::VALUE_REQUIRED, sprintf('The type of schema to generate (%s or %s)', Schema::TYPE_INPUT, Schema::TYPE_OUTPUT), Schema::TYPE_INPUT);
5758
}
5859

5960
/**
@@ -71,11 +72,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
7172
$collectionOperation = $input->getOption('collectionOperation');
7273
/** @var string $format */
7374
$format = $input->getOption('format');
74-
/** @var string $outputType */
75-
$outputType = $input->getOption('type');
75+
/** @var string $type */
76+
$type = $input->getOption('type');
7677

77-
if (!\in_array($outputType, ['input', 'output'], true)) {
78-
$io->error('You can only use "input" or "output" for the "type" option');
78+
if (!\in_array($type, [Schema::TYPE_INPUT, Schema::TYPE_OUTPUT], true)) {
79+
$io->error(sprintf('You can only use "%s" or "%s" for the "type" option', Schema::TYPE_INPUT, Schema::TYPE_OUTPUT));
7980

8081
return 1;
8182
}
@@ -100,10 +101,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
100101
$operationName = $itemOperation ?? $collectionOperation;
101102
}
102103

103-
$schema = $this->schemaFactory->buildSchema($resource, $format, 'output' === $outputType, $operationType, $operationName);
104+
$schema = $this->schemaFactory->buildSchema($resource, $format, $type, $operationType, $operationName);
104105

105106
if (null !== $operationType && null !== $operationName && !$schema->isDefined()) {
106-
$io->error(sprintf('There is no %ss defined for the operation "%s" of the resource "%s".', $outputType, $operationName, $resource));
107+
$io->error(sprintf('There is no %s defined for the operation "%s" of the resource "%s".', $type, $operationName, $resource));
107108

108109
return 1;
109110
}

‎src/JsonSchema/Schema.php‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,11 @@
2727
*/
2828
final class Schema extends \ArrayObject
2929
{
30+
public const TYPE_INPUT = 'input';
31+
public const TYPE_OUTPUT = 'output';
3032
public const VERSION_JSON_SCHEMA = 'json-schema';
31-
public const VERSION_SWAGGER = 'swagger';
3233
public const VERSION_OPENAPI = 'openapi';
34+
public const VERSION_SWAGGER = 'swagger';
3335

3436
private $version;
3537

@@ -49,6 +51,8 @@ public function getVersion(): string
4951
}
5052

5153
/**
54+
* {@inheritdoc}
55+
*
5256
* @param bool $includeDefinitions if set to false, definitions will not be included in the resulting array
5357
*/
5458
public function getArrayCopy(bool $includeDefinitions = true): array

0 commit comments

Comments
 (0)