Skip to content

Bugfix #428 - Recursively denormalize references if entry point is 'serialize without references' #430

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

Closed
nth-commit wants to merge 2 commits into from
Closed

Bugfix #428 - Recursively denormalize references if entry point is 'serialize without references' #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6513d07
Recursively denormalize references if entry point is 'serialize witho…
nth-commit Nov 13, 2019
f72eaf9
Defend against stack overflow in the minimal way
nth-commit Nov 14, 2019
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
137 changes: 105 additions & 32 deletions src/Microsoft.OpenApi/Models/OpenApiSchema.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System;
using System.Collections.Generic;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Interfaces;
Expand Down Expand Up @@ -257,16 +258,40 @@ public void SerializeAsV3(IOpenApiWriter writer)
return;
}

SerializeAsV3WithoutReference(writer);
writer.WriteStartObject();

WriteSchemaPropertiesAsV3(writer, (w, s) => s.SerializeAsV3(w));

writer.WriteEndObject();
}

/// <summary>
/// Serialize to OpenAPI V3 document without using reference.
/// </summary>
public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
{
SerializeAsV3WithoutReference(writer, new OpenApiSchemaVisitor());
}

private void SerializeAsV3WithoutReference(
IOpenApiWriter writer,
OpenApiSchemaVisitor visitor)
{
visitor.Enter(this);

writer.WriteStartObject();

WriteSchemaPropertiesAsV3(writer, (w, s) => s.SerializeAsV3WithoutReference(w, visitor));

writer.WriteEndObject();

visitor.Exit();
}

private void WriteSchemaPropertiesAsV3(
IOpenApiWriter writer,
Action<IOpenApiWriter, OpenApiSchema> serializeSchema)
{
// title
writer.WriteProperty(OpenApiConstants.Title, Title);

Expand Down Expand Up @@ -319,30 +344,30 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
writer.WriteProperty(OpenApiConstants.Type, Type);

// allOf
writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, serializeSchema);

// anyOf
writer.WriteOptionalCollection(OpenApiConstants.AnyOf, AnyOf, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalCollection(OpenApiConstants.AnyOf, AnyOf, serializeSchema);

// oneOf
writer.WriteOptionalCollection(OpenApiConstants.OneOf, OneOf, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalCollection(OpenApiConstants.OneOf, OneOf, serializeSchema);

// not
writer.WriteOptionalObject(OpenApiConstants.Not, Not, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalObject(OpenApiConstants.Not, Not, serializeSchema);

// items
writer.WriteOptionalObject(OpenApiConstants.Items, Items, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalObject(OpenApiConstants.Items, Items, serializeSchema);

// properties
writer.WriteOptionalMap(OpenApiConstants.Properties, Properties, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalMap(OpenApiConstants.Properties, Properties, serializeSchema);

// additionalProperties
if (AdditionalPropertiesAllowed)
{
writer.WriteOptionalObject(
OpenApiConstants.AdditionalProperties,
AdditionalProperties,
(w, s) => s.SerializeAsV3(w));
serializeSchema);
}
else
{
Expand All @@ -362,7 +387,7 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
writer.WriteProperty(OpenApiConstants.Nullable, Nullable, false);

// discriminator
writer.WriteOptionalObject(OpenApiConstants.Discriminator, Discriminator, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalObject(OpenApiConstants.Discriminator, Discriminator, (w, d) => d.SerializeAsV3(w));

// readOnly
writer.WriteProperty(OpenApiConstants.ReadOnly, ReadOnly, false);
Expand All @@ -371,10 +396,10 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
writer.WriteProperty(OpenApiConstants.WriteOnly, WriteOnly, false);

// xml
writer.WriteOptionalObject(OpenApiConstants.Xml, Xml, (w, s) => s.SerializeAsV2(w));
writer.WriteOptionalObject(OpenApiConstants.Xml, Xml, (w, x) => x.SerializeAsV2(w));

// externalDocs
writer.WriteOptionalObject(OpenApiConstants.ExternalDocs, ExternalDocs, (w, s) => s.SerializeAsV3(w));
writer.WriteOptionalObject(OpenApiConstants.ExternalDocs, ExternalDocs, (w, ed) => ed.SerializeAsV3(w));

// example
writer.WriteOptionalObject(OpenApiConstants.Example, Example, (w, e) => w.WriteAny(e));
Expand All @@ -384,8 +409,6 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)

// extensions
writer.WriteExtensions(Extensions, OpenApiSpecVersion.OpenApi3_0);

writer.WriteEndObject();
}

/// <summary>
Expand All @@ -403,6 +426,7 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
{
SerializeAsV2WithoutReference(
writer: writer,
visitor: new OpenApiSchemaVisitor(),
parentRequiredProperties: new HashSet<string>(),
propertyName: null);
}
Expand Down Expand Up @@ -435,24 +459,52 @@ internal void SerializeAsV2(
parentRequiredProperties = new HashSet<string>();
}

SerializeAsV2WithoutReference(writer, parentRequiredProperties, propertyName);
writer.WriteStartObject();

WriteSchemaPropertiesAsV2(
writer,
parentRequiredProperties,
propertyName,
(w, s) => s.SerializeAsV2(w),
(w, key, s) => s.SerializeAsV2(w, Required, key));

writer.WriteEndObject();
}

/// <summary>
/// Serialize to OpenAPI V2 document without using reference and handles not marking the provided property
/// as readonly if its included in the provided list of required properties of parent schema.
/// </summary>
/// <param name="writer">The open api writer.</param>
/// <param name="parentRequiredProperties">The list of required properties in parent schema.</param>
/// <param name="propertyName">The property name that will be serialized.</param>
internal void SerializeAsV2WithoutReference(
private void SerializeAsV2WithoutReference(
IOpenApiWriter writer,
OpenApiSchemaVisitor visitor,
ISet<string> parentRequiredProperties,
string propertyName)
{
visitor.Enter(this);

writer.WriteStartObject();
WriteAsSchemaProperties(writer, parentRequiredProperties, propertyName);

Action<IOpenApiWriter, OpenApiSchema> serializeSchema = (w, s) =>
s.SerializeAsV2WithoutReference(
w,
visitor,
parentRequiredProperties: null,
propertyName: null);

Action<IOpenApiWriter, string, OpenApiSchema> serializeSchemaProperty = (w, key, s) =>
s.SerializeAsV2WithoutReference(
w,
visitor,
Required,
key);

WriteSchemaPropertiesAsV2(
writer,
parentRequiredProperties,
propertyName,
serializeSchema,
serializeSchemaProperty);

writer.WriteEndObject();

visitor.Exit();
}

internal void WriteAsItemsProperties(IOpenApiWriter writer)
Expand Down Expand Up @@ -519,10 +571,12 @@ internal void WriteAsItemsProperties(IOpenApiWriter writer)
writer.WriteExtensions(Extensions, OpenApiSpecVersion.OpenApi2_0);
}

internal void WriteAsSchemaProperties(
private void WriteSchemaPropertiesAsV2(
IOpenApiWriter writer,
ISet<string> parentRequiredProperties,
string propertyName)
string propertyName,
Action<IOpenApiWriter, OpenApiSchema> serializeSchema,
Action<IOpenApiWriter, string, OpenApiSchema> serializeSchemaProperty)
{
if (writer == null)
{
Expand Down Expand Up @@ -590,20 +644,19 @@ internal void WriteAsSchemaProperties(
writer.WriteProperty(OpenApiConstants.Type, Type);

// items
writer.WriteOptionalObject(OpenApiConstants.Items, Items, (w, s) => s.SerializeAsV2(w));
writer.WriteOptionalObject(OpenApiConstants.Items, Items, serializeSchema);

// allOf
writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, (w, s) => s.SerializeAsV2(w));
writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, serializeSchema);

// properties
writer.WriteOptionalMap(OpenApiConstants.Properties, Properties, (w, key, s) =>
s.SerializeAsV2(w, Required, key));
writer.WriteOptionalMap(OpenApiConstants.Properties, Properties, serializeSchemaProperty);

// additionalProperties
writer.WriteOptionalObject(
OpenApiConstants.AdditionalProperties,
AdditionalProperties,
(w, s) => s.SerializeAsV2(w));
serializeSchema);

// discriminator
writer.WriteProperty(OpenApiConstants.Discriminator, Discriminator?.PropertyName);
Expand All @@ -617,16 +670,36 @@ internal void WriteAsSchemaProperties(
}

// xml
writer.WriteOptionalObject(OpenApiConstants.Xml, Xml, (w, s) => s.SerializeAsV2(w));
writer.WriteOptionalObject(OpenApiConstants.Xml, Xml, (w, x) => x.SerializeAsV2(w));

// externalDocs
writer.WriteOptionalObject(OpenApiConstants.ExternalDocs, ExternalDocs, (w, s) => s.SerializeAsV2(w));
writer.WriteOptionalObject(OpenApiConstants.ExternalDocs, ExternalDocs, (w, ed) => ed.SerializeAsV2(w));

// example
writer.WriteOptionalObject(OpenApiConstants.Example, Example, (w, e) => w.WriteAny(e));

// extensions
writer.WriteExtensions(Extensions, OpenApiSpecVersion.OpenApi2_0);
}

private class OpenApiSchemaVisitor
{
private readonly Stack<OpenApiSchema> _visitedSchemas = new Stack<OpenApiSchema>();

public void Enter(OpenApiSchema schema)
{
if (_visitedSchemas.Contains(schema))
{
throw new NotSupportedException("Serializing circular references in schemas is not yet supported");
}

_visitedSchemas.Push(schema);
}

public void Exit()
{
_visitedSchemas.Pop();
}
}
}
}
19 changes: 16 additions & 3 deletions test/Microsoft.OpenApi.Tests/Models/OpenApiComponentsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,13 @@ public class OpenApiComponentsTests
{
Type = ReferenceType.Schema,
Id = "schema2"
},
Properties = new Dictionary<string, OpenApiSchema>
{
["property2"] = new OpenApiSchema
{
Type = "integer"
}
}
}
},
Expand All @@ -99,7 +106,7 @@ public class OpenApiComponentsTests
Type = "integer"
}
}
},
}
},
SecuritySchemes = new Dictionary<string, OpenApiSecurityScheme>
{
Expand Down Expand Up @@ -343,7 +350,11 @@ public void SerializeAdvancedComponentsWithReferenceAsJsonV3Works()
""type"": ""integer""
},
""property3"": {
""$ref"": ""#/components/schemas/schema2""
""properties"": {
""property2"": {
""type"": ""integer""
}
}
}
}
},
Expand Down Expand Up @@ -432,7 +443,9 @@ public void SerializeAdvancedComponentsWithReferenceAsYamlV3Works()
property2:
type: integer
property3:
$ref: '#/components/schemas/schema2'
properties:
property2:
type: integer
schema2:
properties:
property2:
Expand Down
Loading