From 5b89a817935f12393bb6334da3ea08f6b71bb024 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Fri, 28 Feb 2020 17:42:57 +0100 Subject: [PATCH] Fix transitive reference resolving in the current document context fixes #57 --- src/spec/Reference.php | 18 +++++++++ tests/spec/ReferenceTest.php | 74 ++++++++++++++++++++++++++++++++++++ 2 files changed, 92 insertions(+) diff --git a/src/spec/Reference.php b/src/spec/Reference.php index 1610162..4716512 100644 --- a/src/spec/Reference.php +++ b/src/spec/Reference.php @@ -174,6 +174,24 @@ public function resolve(ReferenceContext $context = null) // TODO type error if resolved object does not match $this->_to ? /** @var $referencedObject SpecObjectInterface */ $referencedObject = $jsonReference->getJsonPointer()->evaluate($baseSpec); + // transitive reference + if ($referencedObject instanceof Reference) { + if ($referencedObject->_to === null) { + $referencedObject->_to = $this->_to; + } + $referencedObject->setContext($context); + + if ($referencedObject === $this) { // catch recursion + throw new UnresolvableReferenceException('Cyclic reference detected on a Reference Object.'); + } + + $transitiveRefResult = $referencedObject->resolve(); + + if ($transitiveRefResult === $this) { // catch recursion + throw new UnresolvableReferenceException('Cyclic reference detected on a Reference Object.'); + } + return $transitiveRefResult; + } if ($referencedObject instanceof SpecObjectInterface) { $referencedObject->setReferenceContext($context); } diff --git a/tests/spec/ReferenceTest.php b/tests/spec/ReferenceTest.php index 990fc9e..b4f13de 100644 --- a/tests/spec/ReferenceTest.php +++ b/tests/spec/ReferenceTest.php @@ -304,4 +304,78 @@ enum: $this->assertEquals(['Four', 'Five'], $openapi->components->schemas['Pet']->properties['typeD']->enum); $this->assertEquals(['Five', 'Six'], $openapi->components->schemas['Pet']->properties['typeE']->enum); } + + /** + * References to references fail as "cyclic reference" + * @see https://github.com/cebe/php-openapi/issues/57 + */ + public function testTransitiveReference() + { + $schema = <<<'YAML' +openapi: 3.0.2 +info: + title: 'City API' + version: dev +paths: + '/city': + get: + description: 'Get City' + responses: + '200': + description: 'success' + content: + application/json: + schema: + $ref: '#/components/schemas/City' +components: + schemas: + City: + $ref: '#/components/schemas/Named' + Named: + type: string + +YAML; + + $openapi = Reader::readFromYaml($schema); + $openapi->resolveReferences(new \cebe\openapi\ReferenceContext($openapi, 'file:///tmp/openapi.yaml')); + + $this->assertTrue(isset($openapi->components->schemas['City'])); + $this->assertTrue(isset($openapi->components->schemas['Named'])); + $this->assertEquals('string', $openapi->components->schemas['Named']->type); + $this->assertEquals('string', $openapi->components->schemas['City']->type); + $this->assertEquals('string', $openapi->paths['/city']->get->responses[200]->content['application/json']->schema->type); + } + + public function testTransitiveReferenceCyclic() + { + $schema = <<<'YAML' +openapi: 3.0.2 +info: + title: 'City API' + version: dev +paths: + '/city': + get: + description: 'Get City' + responses: + '200': + description: 'success' + content: + application/json: + schema: + $ref: '#/components/schemas/City' +components: + schemas: + City: + $ref: '#/components/schemas/City' + +YAML; + + $openapi = Reader::readFromYaml($schema); + + $this->expectException(\cebe\openapi\exceptions\UnresolvableReferenceException::class); + $this->expectExceptionMessage('Cyclic reference detected on a Reference Object.'); + + $openapi->resolveReferences(new \cebe\openapi\ReferenceContext($openapi, 'file:///tmp/openapi.yaml')); + } }