Skip to content

feat(jsonschema): make JSON-LD specific properties required #6366

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 7 commits into from
Jul 18, 2024
Merged

feat(jsonschema): make JSON-LD specific properties required #6366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
546c6e3
feat(jsonschema): for JSON-LD, output the input and output schemas wi…
ttskch May 13, 2024
ef97556
feat(jsonschema): make JSON-LD specific properties required
ttskch May 13, 2024
d5bf551
fix exsistent tests
ttskch May 14, 2024
f3a8368
Update src/Hydra/JsonSchema/SchemaFactory.php
ttskch May 25, 2024
22320b5
refactor: reduce complexity
ttskch May 26, 2024
016ccac
docs: remove unnecessary comments
ttskch Jun 4, 2024
7a32d6a
fix: make JSON-LD specific properties non-readOnly and make them requ…
ttskch Jul 18, 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
8 changes: 4 additions & 4 deletions features/openapi/docs.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Feature: Documentation support
And the JSON node "paths./related_dummies/{id}/related_to_dummy_friends.get.parameters" should have 6 elements

# Subcollection - check schema
And the JSON node "paths./related_dummies/{id}/related_to_dummy_friends.get.responses.200.content.application/ld+json.schema.properties.hydra:member.items.$ref" should be equal to "#/components/schemas/RelatedToDummyFriend.jsonld-fakemanytomany"
And the JSON node "paths./related_dummies/{id}/related_to_dummy_friends.get.responses.200.content.application/ld+json.schema.properties.hydra:member.items.$ref" should be equal to "#/components/schemas/RelatedToDummyFriend.jsonld-fakemanytomany.output"

# Deprecations
And the JSON node "paths./dummies.get.deprecated" should be false
Expand All @@ -165,8 +165,8 @@ Feature: Documentation support
And the JSON node "paths./deprecated_resources/{id}.patch.deprecated" should be true

# Formats
And the OpenAPI class "Dummy.jsonld" exists
And the "@id" property exists for the OpenAPI class "Dummy.jsonld"
And the OpenAPI class "Dummy.jsonld.output" exists
And the "@id" property exists for the OpenAPI class "Dummy.jsonld.output"
And the JSON node "paths./dummies.get.responses.200.content.application/ld+json" should be equal to:
"""
{
Expand All @@ -176,7 +176,7 @@ Feature: Documentation support
"hydra:member": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dummy.jsonld"
"$ref": "#/components/schemas/Dummy.jsonld.output"
}
},
"hydra:totalItems": {
Expand Down
31 changes: 27 additions & 4 deletions src/Hydra/JsonSchema/SchemaFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
{
private const BASE_PROP = [
'readOnly' => true,
'type' => 'string',
];
private const BASE_PROPS = [
Expand All @@ -36,7 +35,6 @@ final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareI
];
private const BASE_ROOT_PROPS = [
'@context' => [
'readOnly' => true,
'oneOf' => [
['type' => 'string'],
[
Expand Down Expand Up @@ -74,18 +72,43 @@ public function buildSchema(string $className, string $format = 'jsonld', string
return $schema;
}

if ('input' === $type) {
return $schema;
if (($key = $schema->getRootDefinitionKey() ?? $schema->getItemsDefinitionKey()) !== null) {
$postfix = '.'.$type;
$definitions = $schema->getDefinitions();
$definitions[$key.$postfix] = $definitions[$key];
unset($definitions[$key]);

if (($schema['type'] ?? '') === 'array') {
$schema['items']['$ref'] .= $postfix;
} else {
$schema['$ref'] .= $postfix;
}
}

$definitions = $schema->getDefinitions();
if ($key = $schema->getRootDefinitionKey()) {
$definitions[$key]['properties'] = self::BASE_ROOT_PROPS + ($definitions[$key]['properties'] ?? []);
if (Schema::TYPE_OUTPUT === $type) {
foreach (array_keys(self::BASE_ROOT_PROPS) as $property) {
$definitions[$key]['required'] ??= [];
if (!\in_array($property, $definitions[$key]['required'], true)) {
$definitions[$key]['required'][] = $property;
}
}
}

return $schema;
}
if ($key = $schema->getItemsDefinitionKey()) {
$definitions[$key]['properties'] = self::BASE_PROPS + ($definitions[$key]['properties'] ?? []);
if (Schema::TYPE_OUTPUT === $type) {
foreach (array_keys(self::BASE_PROPS) as $property) {
$definitions[$key]['required'] ??= [];
if (!\in_array($property, $definitions[$key]['required'], true)) {
$definitions[$key]['required'][] = $property;
}
}
}
}

if (($schema['type'] ?? '') === 'array') {
Expand Down
50 changes: 47 additions & 3 deletions tests/Hydra/JsonSchema/SchemaFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Metadata\Property\PropertyNameCollection;
Expand Down Expand Up @@ -49,6 +50,7 @@ protected function setUp(): void

$propertyNameCollectionFactory = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
$propertyNameCollectionFactory->create(Dummy::class, ['enable_getter_setter_extraction' => true, 'schema_type' => Schema::TYPE_OUTPUT])->willReturn(new PropertyNameCollection());
$propertyNameCollectionFactory->create(Dummy::class, ['enable_getter_setter_extraction' => true, 'schema_type' => Schema::TYPE_INPUT])->willReturn(new PropertyNameCollection());
$propertyMetadataFactory = $this->prophesize(PropertyMetadataFactoryInterface::class);

$definitionNameFactory = new DefinitionNameFactory(['jsonapi' => true, 'jsonhal' => true, 'jsonld' => true]);
Expand All @@ -69,7 +71,12 @@ public function testBuildSchema(): void
$resultSchema = $this->schemaFactory->buildSchema(Dummy::class);

$this->assertTrue($resultSchema->isDefined());
$this->assertSame('Dummy.jsonld', $resultSchema->getRootDefinitionKey());
$this->assertSame('Dummy.jsonld.output', $resultSchema->getRootDefinitionKey());

$resultSchema = $this->schemaFactory->buildSchema(Dummy::class, 'jsonld', Schema::TYPE_INPUT, new Post());

$this->assertTrue($resultSchema->isDefined());
$this->assertSame('Dummy.jsonld.input', $resultSchema->getRootDefinitionKey());
}

public function testCustomFormatBuildSchema(): void
Expand All @@ -94,7 +101,6 @@ public function testHasRootDefinitionKeyBuildSchema(): void
$this->assertArrayHasKey('@context', $properties);
$this->assertEquals(
[
'readOnly' => true,
'oneOf' => [
['type' => 'string'],
[
Expand Down Expand Up @@ -122,7 +128,7 @@ public function testHasRootDefinitionKeyBuildSchema(): void
public function testSchemaTypeBuildSchema(): void
{
$resultSchema = $this->schemaFactory->buildSchema(Dummy::class, 'jsonld', Schema::TYPE_OUTPUT, new GetCollection());
$definitionName = 'Dummy.jsonld';
$definitionName = 'Dummy.jsonld.output';

$this->assertNull($resultSchema->getRootDefinitionKey());
// @noRector
Expand Down Expand Up @@ -151,6 +157,12 @@ public function testSchemaTypeBuildSchema(): void
$this->assertArrayNotHasKey('@context', $properties);
$this->assertArrayHasKey('@type', $properties);
$this->assertArrayHasKey('@id', $properties);

$resultSchema = $this->schemaFactory->buildSchema(Dummy::class, 'jsonld', Schema::TYPE_INPUT, new Post());
$definitionName = 'Dummy.jsonld.input';

$this->assertSame($definitionName, $resultSchema->getRootDefinitionKey());
$this->assertFalse(isset($resultSchema['properties']));
}

public function testHasHydraViewNavigationBuildSchema(): void
Expand All @@ -168,4 +180,36 @@ public function testHasHydraViewNavigationBuildSchema(): void
$this->assertArrayHasKey('hydra:previous', $resultSchema['properties']['hydra:view']['properties']);
$this->assertArrayHasKey('hydra:next', $resultSchema['properties']['hydra:view']['properties']);
}

public function testRequiredBasePropertiesBuildSchema(): void
{
$resultSchema = $this->schemaFactory->buildSchema(Dummy::class);
$definitions = $resultSchema->getDefinitions();
$rootDefinitionKey = $resultSchema->getRootDefinitionKey();

$this->assertTrue(isset($definitions[$rootDefinitionKey]));
$this->assertTrue(isset($definitions[$rootDefinitionKey]['required']));
$requiredProperties = $resultSchema['definitions'][$rootDefinitionKey]['required'];
$this->assertContains('@context', $requiredProperties);
$this->assertContains('@id', $requiredProperties);
$this->assertContains('@type', $requiredProperties);

$resultSchema = $this->schemaFactory->buildSchema(Dummy::class, 'jsonld', Schema::TYPE_OUTPUT, new GetCollection());
$definitions = $resultSchema->getDefinitions();
$itemsDefinitionKey = array_key_first($definitions->getArrayCopy());

$this->assertTrue(isset($definitions[$itemsDefinitionKey]));
$this->assertTrue(isset($definitions[$itemsDefinitionKey]['required']));
$requiredProperties = $resultSchema['definitions'][$itemsDefinitionKey]['required'];
$this->assertNotContains('@context', $requiredProperties);
$this->assertContains('@id', $requiredProperties);
$this->assertContains('@type', $requiredProperties);

$resultSchema = $this->schemaFactory->buildSchema(Dummy::class, 'jsonld', Schema::TYPE_INPUT, new Post());
$definitions = $resultSchema->getDefinitions();
$itemsDefinitionKey = array_key_first($definitions->getArrayCopy());

$this->assertTrue(isset($definitions[$itemsDefinitionKey]));
$this->assertFalse(isset($definitions[$itemsDefinitionKey]['required']));
}
}
38 changes: 19 additions & 19 deletions tests/JsonSchema/Command/JsonSchemaGenerateCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ public function testExecuteWithJsonldTypeInput(): void
$this->tester->run(['command' => 'api:json-schema:generate', 'resource' => $this->entityClass, '--operation' => '_api_/dummies{._format}_post', '--format' => 'jsonld', '--type' => 'input']);
$result = $this->tester->getDisplay();

$this->assertStringNotContainsString('@id', $result);
$this->assertStringNotContainsString('@context', $result);
$this->assertStringNotContainsString('@type', $result);
$this->assertStringContainsString('@id', $result);
$this->assertStringContainsString('@context', $result);
$this->assertStringContainsString('@type', $result);
}

/**
Expand All @@ -103,24 +103,24 @@ public function testArraySchemaWithReference(): void
$result = $this->tester->getDisplay();
$json = json_decode($result, associative: true);

$this->assertEquals($json['definitions']['BagOfTests.jsonld-write']['properties']['tests'], [
$this->assertEquals($json['definitions']['BagOfTests.jsonld-write.input']['properties']['tests'], [
'type' => 'string',
'foo' => 'bar',
]);

$this->assertEquals($json['definitions']['BagOfTests.jsonld-write']['properties']['nonResourceTests'], [
$this->assertEquals($json['definitions']['BagOfTests.jsonld-write.input']['properties']['nonResourceTests'], [
'type' => 'array',
'items' => [
'$ref' => '#/definitions/NonResourceTestEntity.jsonld-write',
'$ref' => '#/definitions/NonResourceTestEntity.jsonld-write.input',
],
]);

$this->assertEquals($json['definitions']['BagOfTests.jsonld-write']['properties']['description'], [
$this->assertEquals($json['definitions']['BagOfTests.jsonld-write.input']['properties']['description'], [
'maxLength' => 255,
]);

$this->assertEquals($json['definitions']['BagOfTests.jsonld-write']['properties']['type'], [
'$ref' => '#/definitions/TestEntity.jsonld-write',
$this->assertEquals($json['definitions']['BagOfTests.jsonld-write.input']['properties']['type'], [
'$ref' => '#/definitions/TestEntity.jsonld-write.input',
]);
}

Expand All @@ -130,14 +130,14 @@ public function testArraySchemaWithMultipleUnionTypesJsonLd(): void
$result = $this->tester->getDisplay();
$json = json_decode($result, associative: true);

$this->assertEquals($json['definitions']['Nest.jsonld']['properties']['owner']['anyOf'], [
['$ref' => '#/definitions/Wren.jsonld'],
['$ref' => '#/definitions/Robin.jsonld'],
$this->assertEquals($json['definitions']['Nest.jsonld.output']['properties']['owner']['anyOf'], [
['$ref' => '#/definitions/Wren.jsonld.output'],
['$ref' => '#/definitions/Robin.jsonld.output'],
['type' => 'null'],
]);

$this->assertArrayHasKey('Wren.jsonld', $json['definitions']);
$this->assertArrayHasKey('Robin.jsonld', $json['definitions']);
$this->assertArrayHasKey('Wren.jsonld.output', $json['definitions']);
$this->assertArrayHasKey('Robin.jsonld.output', $json['definitions']);
}

public function testArraySchemaWithMultipleUnionTypesJsonApi(): void
Expand Down Expand Up @@ -183,7 +183,7 @@ public function testArraySchemaWithTypeFactory(): void
$result = $this->tester->getDisplay();
$json = json_decode($result, associative: true);

$this->assertEquals($json['definitions']['Foo.jsonld']['properties']['expiration'], ['type' => 'string', 'format' => 'date']);
$this->assertEquals($json['definitions']['Foo.jsonld.output']['properties']['expiration'], ['type' => 'string', 'format' => 'date']);
}

/**
Expand All @@ -195,7 +195,7 @@ public function testWritableNonResourceRef(): void
$result = $this->tester->getDisplay();
$json = json_decode($result, associative: true);

$this->assertEquals($json['definitions']['SaveProduct.jsonld']['properties']['codes']['items']['$ref'], '#/definitions/ProductCode.jsonld');
$this->assertEquals($json['definitions']['SaveProduct.jsonld.input']['properties']['codes']['items']['$ref'], '#/definitions/ProductCode.jsonld.input');
}

/**
Expand All @@ -207,8 +207,8 @@ public function testOpenApiResourceRefIsNotOverwritten(): void
$result = $this->tester->getDisplay();
$json = json_decode($result, associative: true);

$this->assertEquals('#/definitions/DummyFriend', $json['definitions']['Issue6299.Issue6299OutputDto.jsonld']['properties']['itemDto']['$ref']);
$this->assertEquals('#/definitions/DummyDate', $json['definitions']['Issue6299.Issue6299OutputDto.jsonld']['properties']['collectionDto']['items']['$ref']);
$this->assertEquals('#/definitions/DummyFriend', $json['definitions']['Issue6299.Issue6299OutputDto.jsonld.output']['properties']['itemDto']['$ref']);
$this->assertEquals('#/definitions/DummyDate', $json['definitions']['Issue6299.Issue6299OutputDto.jsonld.output']['properties']['collectionDto']['items']['$ref']);
}

/**
Expand All @@ -220,7 +220,7 @@ public function testSubSchemaJsonLd(): void
$result = $this->tester->getDisplay();
$json = json_decode($result, associative: true);

$this->assertArrayHasKey('@id', $json['definitions']['ThirdLevel.jsonld-friends']['properties']);
$this->assertArrayHasKey('@id', $json['definitions']['ThirdLevel.jsonld-friends.output']['properties']);
}

public function testJsonApiIncludesSchema(): void
Expand Down
Loading