Visitar URL original
fix: circular ref guard by gavinbarron · Pull Request #3033 · microsoft/OpenAPI.NET · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
codeql updates
  • Loading branch information
gavinbarron committed Aug 19, 2026
commit f67e81b35daf7d56c72843cfb30e9c2386d0ed9e
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public virtual U? Target
private protected TResult GetFromTarget<TResult>(Func<U, TResult> selector)
{
Utils.CheckArgumentNull(selector);
return ExecuteWithReferenceGuard(ref t_activeReferenceAccesses, () =>
return ExecuteWithReferenceAccessGuard(this, () =>
{
return Target is { } target ? selector(target) : default!;
});
Expand All @@ -53,7 +53,7 @@ private protected TResult GetFromTarget<TResult>(Func<U, TResult> selector)
private protected void ApplyToTarget(Action<U> action)
{
Utils.CheckArgumentNull(action);
ExecuteWithReferenceGuard<object?>(ref t_activeTargetActions, () =>
ExecuteWithTargetActionGuard<object?>(this, () =>
{
if (Target is { } target)
{
Expand All @@ -63,14 +63,29 @@ private protected void ApplyToTarget(Action<U> action)
});
}

private TResult ExecuteWithReferenceGuard<TResult>(
private static TResult ExecuteWithReferenceAccessGuard<TResult>(
BaseOpenApiReferenceHolder<T, U, V> holder,
Func<TResult> action)
{
return ExecuteWithReferenceGuard(ref t_activeReferenceAccesses, holder, action);
}

private static TResult ExecuteWithTargetActionGuard<TResult>(
BaseOpenApiReferenceHolder<T, U, V> holder,
Func<TResult> action)
{
return ExecuteWithReferenceGuard(ref t_activeTargetActions, holder, action);
}

private static TResult ExecuteWithReferenceGuard<TResult>(
ref HashSet<BaseOpenApiReferenceHolder<T, U, V>>? activeReferences,
BaseOpenApiReferenceHolder<T, U, V> holder,
Func<TResult> action)
{
activeReferences ??= new HashSet<BaseOpenApiReferenceHolder<T, U, V>>(ReferenceHolderComparer.Instance);
if (!activeReferences.Add(this))
if (!activeReferences.Add(holder))
{
throw new InvalidOperationException($"Circular reference detected while resolving reference: {Reference.ReferenceV3}");
throw new InvalidOperationException($"Circular reference detected while resolving reference: {holder.Reference.ReferenceV3}");
}

try
Expand All @@ -81,12 +96,12 @@ private TResult ExecuteWithReferenceGuard<TResult>(
catch (InsufficientExecutionStackException ex)
{
throw new InvalidOperationException(
$"The chain of references starting at {Reference.ReferenceV3} is nested too deeply to resolve.",
$"The chain of references starting at {holder.Reference.ReferenceV3} is nested too deeply to resolve.",
ex);
}
finally
{
activeReferences.Remove(this);
activeReferences.Remove(holder);
if (activeReferences.Count == 0)
{
activeReferences = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,8 @@ public void FilteringADocumentWithCircularSchemaReferencesPreservesTheReferences
var filtered = OpenApiFilterService.CreateFilteredDocument(readResult.Document, predicate);

// Assert
Assert.NotNull(filtered.Components?.Schemas);
Assert.NotNull(filtered.Components);
Assert.NotNull(filtered.Components.Schemas);
Assert.Contains("A", filtered.Components.Schemas.Keys);
Comment thread
github-code-quality[bot] marked this conversation as resolved.
Fixed
Assert.Contains("B", filtered.Components.Schemas.Keys);
}
Expand Down