Skip to content

[JSON Schema] Use validation groups for property metadata in JSON Schema factory #3806

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
merged 1 commit into from
Nov 2, 2020
Merged

[JSON Schema] Use validation groups for property metadata in JSON Schema factory #3806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 21 additions & 9 deletions src/JsonSchema/SchemaFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public function buildSchema(string $className, string $format = 'json', string $
if (null === $metadata = $this->getMetadata($className, $type, $operationType, $operationName, $serializerContext)) {
return $schema;
}
[$resourceMetadata, $serializerContext, $inputOrOutputClass] = $metadata;
[$resourceMetadata, $serializerContext, $validationGroups, $inputOrOutputClass] = $metadata;

if (null === $resourceMetadata && (null !== $operationType || null !== $operationName)) {
throw new \LogicException('The $operationType and $operationName arguments must be null for non-resource class.');
Expand Down Expand Up @@ -131,7 +131,7 @@ public function buildSchema(string $className, string $format = 'json', string $
$definition['externalDocs'] = ['url' => $iri];
}

$options = $this->getFactoryOptions($serializerContext, $operationType, $operationName);
$options = $this->getFactoryOptions($serializerContext, $validationGroups, $operationType, $operationName);
foreach ($this->propertyNameCollectionFactory->create($inputOrOutputClass, $options) as $propertyName) {
$propertyMetadata = $this->propertyMetadataFactory->create($inputOrOutputClass, $propertyName, $options);
if (!$propertyMetadata->isReadable() && !$propertyMetadata->isWritable()) {
Expand Down Expand Up @@ -200,18 +200,13 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
}

$propertySchema = new \ArrayObject($propertySchema + $valueSchema);
if (DocumentationNormalizer::OPENAPI_VERSION === $version) {
$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = $propertySchema;

return;
}

$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = $propertySchema;
}

private function buildDefinitionName(string $className, string $format = 'json', string $type = Schema::TYPE_OUTPUT, ?string $operationType = null, ?string $operationName = null, ?array $serializerContext = null): string
{
[$resourceMetadata, $serializerContext, $inputOrOutputClass] = $this->getMetadata($className, $type, $operationType, $operationName, $serializerContext);
[$resourceMetadata, $serializerContext,, $inputOrOutputClass] = $this->getMetadata($className, $type, $operationType, $operationName, $serializerContext);

$prefix = $resourceMetadata ? $resourceMetadata->getShortName() : (new \ReflectionClass($className))->getShortName();
if (null !== $inputOrOutputClass && $className !== $inputOrOutputClass) {
Expand Down Expand Up @@ -239,6 +234,7 @@ private function getMetadata(string $className, string $type = Schema::TYPE_OUTP
return [
null,
$serializerContext ?? [],
[],
$className,
];
}
Expand All @@ -259,6 +255,7 @@ private function getMetadata(string $className, string $type = Schema::TYPE_OUTP
return [
$resourceMetadata,
$serializerContext ?? $this->getSerializerContext($resourceMetadata, $type, $operationType, $operationName),
$this->getValidationGroups($resourceMetadata, $operationType, $operationName),
$inputOrOutput['class'],
];
}
Expand All @@ -274,10 +271,21 @@ private function getSerializerContext(ResourceMetadata $resourceMetadata, string
return $resourceMetadata->getTypedOperationAttribute($operationType, $operationName, $attribute, [], true);
}

private function getValidationGroups(ResourceMetadata $resourceMetadata, ?string $operationType, ?string $operationName): array
{
$attribute = 'validation_groups';

if (null === $operationType || null === $operationName) {
return \is_array($validationGroups = $resourceMetadata->getAttribute($attribute, [])) ? $validationGroups : [];
}

return \is_array($validationGroups = $resourceMetadata->getTypedOperationAttribute($operationType, $operationName, $attribute, [], true)) ? $validationGroups : [];
}

/**
* Gets the options for the property name collection / property metadata factories.
*/
private function getFactoryOptions(array $serializerContext, ?string $operationType, ?string $operationName): array
private function getFactoryOptions(array $serializerContext, array $validationGroups, ?string $operationType, ?string $operationName): array
{
$options = [];

Expand All @@ -299,6 +307,10 @@ private function getFactoryOptions(array $serializerContext, ?string $operationT
}
}

if ($validationGroups) {
$options['validation_groups'] = $validationGroups;
}

return $options;
}
}
8 changes: 5 additions & 3 deletions tests/JsonSchema/SchemaFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ public function testBuildSchemaForOperationWithOverriddenSerializerGroups(): voi
'normalization_context' => [
'groups' => 'overridden_operation_dummy_put',
],
'validation_groups' => ['validation_groups_dummy_put'],
],
], [], [
'normalization_context' => [
Expand All @@ -107,21 +108,22 @@ public function testBuildSchemaForOperationWithOverriddenSerializerGroups(): voi
]));

$serializerGroup = 'overridden_operation_dummy_put';
$validationGroups = 'validation_groups_dummy_put';

$propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
$propertyNameCollectionFactoryProphecy->create(OverriddenOperationDummy::class, Argument::allOf(
Argument::type('array'),
Argument::withEntry('serializer_groups', [$serializerGroup])
Argument::allOf(Argument::withEntry('serializer_groups', [$serializerGroup]), Argument::withEntry('validation_groups', [$validationGroups]))
))->willReturn(new PropertyNameCollection(['alias', 'description']));

$propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
$propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'alias', Argument::allOf(
Argument::type('array'),
Argument::withEntry('serializer_groups', [$serializerGroup])
Argument::allOf(Argument::withEntry('serializer_groups', [$serializerGroup]), Argument::withEntry('validation_groups', [$validationGroups]))
))->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), null, true));
$propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'description', Argument::allOf(
Argument::type('array'),
Argument::withEntry('serializer_groups', [$serializerGroup])
Argument::allOf(Argument::withEntry('serializer_groups', [$serializerGroup]), Argument::withEntry('validation_groups', [$validationGroups]))
))->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), null, true));

$resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
Expand Down