Skip to content

Introduce a simple cache and build a new ReferenceContext only when needed #158

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Introduce a simple cache and build a new ReferenceContext only when needed #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9edcbd2
Resolve 156 with introduce a simple cache and build a new ReferenceCo…
marcelthole Mar 11, 2022
6162a39
use ReferenceContext to cache the relativeReferences and prevent erro…
marcelthole Apr 20, 2022
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
13 changes: 11 additions & 2 deletions src/spec/Reference.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,16 +294,20 @@ private function resolveTransitiveReference(Reference $referencedObject, Referen
/**
* Adjust relative references inside of the file to match the context of the base file
*/
private function adjustRelativeReferences($referencedDocument, $basePath, $baseDocument = null, $oContext = null)
private function adjustRelativeReferences($referencedDocument, $basePath, $baseDocument = null, ?ReferenceContext $oContext = null)
{
$context = new ReferenceContext(null, $basePath);
if ($baseDocument === null) {
$baseDocument = $referencedDocument;
}

foreach ($referencedDocument as $key => $value) {
// adjust reference URLs
if ($key === '$ref' && is_string($value)) {
$fullPath = $basePath . $value;
if ($oContext !== null && $oContext->getCache()->has($fullPath, 'relativeReferences')) {
return $oContext->getCache()->get($fullPath, 'relativeReferences');
}

if (isset($value[0]) && $value[0] === '#') {
// direcly inline references in the same document,
// these are not going to be valid in the new context anymore
Expand All @@ -315,8 +319,12 @@ private function adjustRelativeReferences($referencedDocument, $basePath, $baseD
$this->_recursingInsideFile = true;
$return = $this->adjustRelativeReferences($inlineDocument, $basePath, $baseDocument, $oContext);
$this->_recursingInsideFile = false;
if ($oContext !== null) {
$oContext->getCache()->set($fullPath, 'relativeReferences', $return);
}
return $return;
}
$context = new ReferenceContext(null, $basePath);
$referencedDocument[$key] = $context->resolveRelativeUri($value);
$parts = explode('#', $referencedDocument[$key], 2);
if ($parts[0] === $oContext->getUri()) {
Expand All @@ -329,6 +337,7 @@ private function adjustRelativeReferences($referencedDocument, $basePath, $baseD
// adjust URLs for 'externalValue' references in Example Objects
// https://spec.openapis.org/oas/v3.0.3#example-object
if ($key === 'externalValue' && is_string($value)) {
$context = new ReferenceContext(null, $basePath);
$referencedDocument[$key] = $this->makeRelativePath($oContext->getUri(), $context->resolveRelativeUri($value));
continue;
}
Expand Down