fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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
Vincent Biret (baywet) merged 1 commit into from
Nov 13, 2024
Merged

fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum #1915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 17 additions & 1 deletion src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
/// </summary>
public static class OpenApiTypeMapper
{
#nullable enable
/// <summary>
/// Maps a JsonSchema data type to an identifier.
/// </summary>
/// <param name="schemaType"></param>
/// <returns></returns>
public static string ToIdentifier(this JsonSchemaType? schemaType)
public static string? ToIdentifier(this JsonSchemaType? schemaType)
{
if (schemaType is null)
{
return null;
}
return schemaType.Value.ToIdentifier();
}

/// <summary>
/// Maps a JsonSchema data type to an identifier.
/// </summary>
/// <param name="schemaType"></param>
/// <returns></returns>
public static string? ToIdentifier(this JsonSchemaType schemaType)
{
return schemaType switch
{
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
_ => null,
};
}
#nullable restore

/// <summary>
/// Converts a schema type's identifier into the enum equivalent
Expand Down
96 changes: 42 additions & 54 deletions src/Microsoft.OpenApi/Models/OpenApiSchema.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

// type
if (Type is not null)
{
SerializeTypeProperty(Type, writer, version);
}
SerializeTypeProperty(Type, writer, version);

// allOf
writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
writer.WriteStartObject();

// type
if (Type is not null)
{
SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
}
SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

// description
writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
{
var flagsCount = CountEnumSetFlags(type);
if (flagsCount is 1)
if (type is null)
{
return;
}
if (!HasMultipleTypes(type.Value))
{
// check whether nullable is true for upcasting purposes
if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
}
else
{
writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
}
}
else if(flagsCount > 1)
else
{
// type
if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
{
DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
DowncastTypeArrayToV2OrV3(type.Value, writer, version);
}
else
{
if (type is not null)
var list = new List<JsonSchemaType>();
foreach (JsonSchemaType flag in jsonSchemaTypeValues)
{
var list = new List<JsonSchemaType?>();
foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
if (type.Value.HasFlag(flag))
{
if (type.Value.HasFlag(flag))
{
list.Add(flag);
}
list.Add(flag);
}
}

writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
}
writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
}
}
}

private static int CountEnumSetFlags(JsonSchemaType? schemaType)
private static bool IsPowerOfTwo(int x)
{
int count = 0;

if (schemaType != null)
{
// Check each flag in the enum
foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
{
// Check if the flag is set
if (schemaType.Value.HasFlag(value))
{
count++;
}
}
}
return x != 0 && (x & (x - 1)) == 0;
}

return count;
private static bool HasMultipleTypes(JsonSchemaType schemaType)
{
var schemaTypeNumeric = (int)schemaType;
return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
schemaTypeNumeric != (int)JsonSchemaType.Null;
}

private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
{
// create a new array and insert the type and "null" as values
Type = type | JsonSchemaType.Null;
var list = new List<string>();
foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
{
// Check if the flag is set in 'type' using a bitwise AND operation
if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
}

private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
{
/* If the array has one non-null value, emit Type as string
* If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
? OpenApiConstants.NullableExtension
: OpenApiConstants.Nullable;

if (flagsCount is 1)
if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
{
if (schemaType is JsonSchemaType.Null)
{
writer.WriteProperty(nullableProp, true);
}
else
{
writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
}
}
else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
{
foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
{
// Skip if the flag is not set or if it's the Null flag
if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
{
// Write the non-null flag value to the writer
writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
writer.WriteProperty(nullableProp, true);
}
}
else if (!HasMultipleTypes(schemaType))
{
if (schemaType is JsonSchemaType.Null)
{
writer.WriteProperty(nullableProp, true);
}
else
{
writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
}
}
}
}
}
3 changes: 2 additions & 1 deletion test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
{
public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
}
public static class StringExtensions
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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

Vincent Biret (baywet)
merged 1 commit into

from

Nov 13, 2024
 Merged


fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum
#1915
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 17 additions & 1 deletion
src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
 /// </summary>
 public static class OpenApiTypeMapper
 {
#nullable enable
 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string ToIdentifier(this JsonSchemaType? schemaType)
 public static string? ToIdentifier(this JsonSchemaType? schemaType)
 {
 if (schemaType is null)
 {
 return null;
 }
 return schemaType.Value.ToIdentifier();
 }

 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string? ToIdentifier(this JsonSchemaType schemaType)
 {
 return schemaType switch
 {
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
 _ => null,
 };
 }
#nullable restore

 /// <summary>
 /// Converts a schema type's identifier into the enum equivalent
Expand Down

96 changes: 42 additions & 54 deletions
src/Microsoft.OpenApi/Models/OpenApiSchema.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
 writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, version);
 }
 SerializeTypeProperty(Type, writer, version);

 // allOf
 writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
 writer.WriteStartObject();

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
 }
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

 // description
 writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

 private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 var flagsCount = CountEnumSetFlags(type);
 if (flagsCount is 1)
 if (type is null)
 {
 return;
 }
 if (!HasMultipleTypes(type.Value))
 {
 // check whether nullable is true for upcasting purposes
 if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
 writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
 }
 }
 else if(flagsCount > 1)
 else
 {
 // type
 if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
 {
 DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
 DowncastTypeArrayToV2OrV3(type.Value, writer, version);
 }
 else
 {
 if (type is not null)
 var list = new List<JsonSchemaType>();
 foreach (JsonSchemaType flag in jsonSchemaTypeValues)
 {
 var list = new List<JsonSchemaType?>();
 foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 if (type.Value.HasFlag(flag))
 {
 if (type.Value.HasFlag(flag))
 {
 list.Add(flag);
 }
 list.Add(flag);
 }
 }

 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 } 
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 }
 } 
 }

 private static int CountEnumSetFlags(JsonSchemaType? schemaType)
 private static bool IsPowerOfTwo(int x)
 {
 int count = 0;

 if (schemaType != null)
 {
 // Check each flag in the enum
 foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
 {
 // Check if the flag is set
 if (schemaType.Value.HasFlag(value))
 {
 count++;
 }
 }
 } 
 return x != 0 && (x & (x - 1)) == 0;
 }

 return count;
 private static bool HasMultipleTypes(JsonSchemaType schemaType)
 {
 var schemaTypeNumeric = (int)schemaType;
 return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
 schemaTypeNumeric != (int)JsonSchemaType.Null;
 }

 private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 {
 // create a new array and insert the type and "null" as values
 Type = type | JsonSchemaType.Null;
 var list = new List<string>();
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Check if the flag is set in 'type' using a bitwise AND operation
 if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
 }

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
 private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 /* If the array has one non-null value, emit Type as string
 * If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 ? OpenApiConstants.NullableExtension
 : OpenApiConstants.Nullable;

 if (flagsCount is 1)
 if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Skip if the flag is not set or if it's the Null flag
 if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
 if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
 {
 // Write the non-null flag value to the writer
 writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 writer.WriteProperty(nullableProp, true);
 }
 }
 else if (!HasMultipleTypes(schemaType))
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 }
 }
}

3 changes: 2 additions & 1 deletion
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
 {
 public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
 public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
 public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
 }
 public static class StringExtensions
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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

Vincent Biret (baywet)
merged 1 commit into

from

Nov 13, 2024
 Merged


fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum
#1915
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 17 additions & 1 deletion
src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
 /// </summary>
 public static class OpenApiTypeMapper
 {
#nullable enable
 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string ToIdentifier(this JsonSchemaType? schemaType)
 public static string? ToIdentifier(this JsonSchemaType? schemaType)
 {
 if (schemaType is null)
 {
 return null;
 }
 return schemaType.Value.ToIdentifier();
 }

 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string? ToIdentifier(this JsonSchemaType schemaType)
 {
 return schemaType switch
 {
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
 _ => null,
 };
 }
#nullable restore

 /// <summary>
 /// Converts a schema type's identifier into the enum equivalent
Expand Down

96 changes: 42 additions & 54 deletions
src/Microsoft.OpenApi/Models/OpenApiSchema.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
 writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, version);
 }
 SerializeTypeProperty(Type, writer, version);

 // allOf
 writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
 writer.WriteStartObject();

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
 }
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

 // description
 writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

 private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 var flagsCount = CountEnumSetFlags(type);
 if (flagsCount is 1)
 if (type is null)
 {
 return;
 }
 if (!HasMultipleTypes(type.Value))
 {
 // check whether nullable is true for upcasting purposes
 if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
 writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
 }
 }
 else if(flagsCount > 1)
 else
 {
 // type
 if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
 {
 DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
 DowncastTypeArrayToV2OrV3(type.Value, writer, version);
 }
 else
 {
 if (type is not null)
 var list = new List<JsonSchemaType>();
 foreach (JsonSchemaType flag in jsonSchemaTypeValues)
 {
 var list = new List<JsonSchemaType?>();
 foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 if (type.Value.HasFlag(flag))
 {
 if (type.Value.HasFlag(flag))
 {
 list.Add(flag);
 }
 list.Add(flag);
 }
 }

 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 } 
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 }
 } 
 }

 private static int CountEnumSetFlags(JsonSchemaType? schemaType)
 private static bool IsPowerOfTwo(int x)
 {
 int count = 0;

 if (schemaType != null)
 {
 // Check each flag in the enum
 foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
 {
 // Check if the flag is set
 if (schemaType.Value.HasFlag(value))
 {
 count++;
 }
 }
 } 
 return x != 0 && (x & (x - 1)) == 0;
 }

 return count;
 private static bool HasMultipleTypes(JsonSchemaType schemaType)
 {
 var schemaTypeNumeric = (int)schemaType;
 return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
 schemaTypeNumeric != (int)JsonSchemaType.Null;
 }

 private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 {
 // create a new array and insert the type and "null" as values
 Type = type | JsonSchemaType.Null;
 var list = new List<string>();
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Check if the flag is set in 'type' using a bitwise AND operation
 if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
 }

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
 private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 /* If the array has one non-null value, emit Type as string
 * If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 ? OpenApiConstants.NullableExtension
 : OpenApiConstants.Nullable;

 if (flagsCount is 1)
 if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Skip if the flag is not set or if it's the Null flag
 if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
 if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
 {
 // Write the non-null flag value to the writer
 writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 writer.WriteProperty(nullableProp, true);
 }
 }
 else if (!HasMultipleTypes(schemaType))
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 }
 }
}

3 changes: 2 additions & 1 deletion
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
 {
 public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
 public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
 public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
 }
 public static class StringExtensions
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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

Vincent Biret (baywet)
merged 1 commit into

from

Nov 13, 2024
 Merged


fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum
#1915
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 17 additions & 1 deletion
src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
 /// </summary>
 public static class OpenApiTypeMapper
 {
#nullable enable
 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string ToIdentifier(this JsonSchemaType? schemaType)
 public static string? ToIdentifier(this JsonSchemaType? schemaType)
 {
 if (schemaType is null)
 {
 return null;
 }
 return schemaType.Value.ToIdentifier();
 }

 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string? ToIdentifier(this JsonSchemaType schemaType)
 {
 return schemaType switch
 {
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
 _ => null,
 };
 }
#nullable restore

 /// <summary>
 /// Converts a schema type's identifier into the enum equivalent
Expand Down

96 changes: 42 additions & 54 deletions
src/Microsoft.OpenApi/Models/OpenApiSchema.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
 writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, version);
 }
 SerializeTypeProperty(Type, writer, version);

 // allOf
 writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
 writer.WriteStartObject();

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
 }
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

 // description
 writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

 private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 var flagsCount = CountEnumSetFlags(type);
 if (flagsCount is 1)
 if (type is null)
 {
 return;
 }
 if (!HasMultipleTypes(type.Value))
 {
 // check whether nullable is true for upcasting purposes
 if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
 writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
 }
 }
 else if(flagsCount > 1)
 else
 {
 // type
 if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
 {
 DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
 DowncastTypeArrayToV2OrV3(type.Value, writer, version);
 }
 else
 {
 if (type is not null)
 var list = new List<JsonSchemaType>();
 foreach (JsonSchemaType flag in jsonSchemaTypeValues)
 {
 var list = new List<JsonSchemaType?>();
 foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 if (type.Value.HasFlag(flag))
 {
 if (type.Value.HasFlag(flag))
 {
 list.Add(flag);
 }
 list.Add(flag);
 }
 }

 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 } 
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 }
 } 
 }

 private static int CountEnumSetFlags(JsonSchemaType? schemaType)
 private static bool IsPowerOfTwo(int x)
 {
 int count = 0;

 if (schemaType != null)
 {
 // Check each flag in the enum
 foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
 {
 // Check if the flag is set
 if (schemaType.Value.HasFlag(value))
 {
 count++;
 }
 }
 } 
 return x != 0 && (x & (x - 1)) == 0;
 }

 return count;
 private static bool HasMultipleTypes(JsonSchemaType schemaType)
 {
 var schemaTypeNumeric = (int)schemaType;
 return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
 schemaTypeNumeric != (int)JsonSchemaType.Null;
 }

 private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 {
 // create a new array and insert the type and "null" as values
 Type = type | JsonSchemaType.Null;
 var list = new List<string>();
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Check if the flag is set in 'type' using a bitwise AND operation
 if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
 }

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
 private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 /* If the array has one non-null value, emit Type as string
 * If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 ? OpenApiConstants.NullableExtension
 : OpenApiConstants.Nullable;

 if (flagsCount is 1)
 if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Skip if the flag is not set or if it's the Null flag
 if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
 if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
 {
 // Write the non-null flag value to the writer
 writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 writer.WriteProperty(nullableProp, true);
 }
 }
 else if (!HasMultipleTypes(schemaType))
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 }
 }
}

3 changes: 2 additions & 1 deletion
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
 {
 public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
 public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
 public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
 }
 public static class StringExtensions
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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

Vincent Biret (baywet)
merged 1 commit into

from

Nov 13, 2024
 Merged


fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum
#1915
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 17 additions & 1 deletion
src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
 /// </summary>
 public static class OpenApiTypeMapper
 {
#nullable enable
 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string ToIdentifier(this JsonSchemaType? schemaType)
 public static string? ToIdentifier(this JsonSchemaType? schemaType)
 {
 if (schemaType is null)
 {
 return null;
 }
 return schemaType.Value.ToIdentifier();
 }

 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string? ToIdentifier(this JsonSchemaType schemaType)
 {
 return schemaType switch
 {
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
 _ => null,
 };
 }
#nullable restore

 /// <summary>
 /// Converts a schema type's identifier into the enum equivalent
Expand Down

96 changes: 42 additions & 54 deletions
src/Microsoft.OpenApi/Models/OpenApiSchema.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
 writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, version);
 }
 SerializeTypeProperty(Type, writer, version);

 // allOf
 writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
 writer.WriteStartObject();

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
 }
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

 // description
 writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

 private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 var flagsCount = CountEnumSetFlags(type);
 if (flagsCount is 1)
 if (type is null)
 {
 return;
 }
 if (!HasMultipleTypes(type.Value))
 {
 // check whether nullable is true for upcasting purposes
 if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
 writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
 }
 }
 else if(flagsCount > 1)
 else
 {
 // type
 if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
 {
 DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
 DowncastTypeArrayToV2OrV3(type.Value, writer, version);
 }
 else
 {
 if (type is not null)
 var list = new List<JsonSchemaType>();
 foreach (JsonSchemaType flag in jsonSchemaTypeValues)
 {
 var list = new List<JsonSchemaType?>();
 foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 if (type.Value.HasFlag(flag))
 {
 if (type.Value.HasFlag(flag))
 {
 list.Add(flag);
 }
 list.Add(flag);
 }
 }

 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 } 
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 }
 } 
 }

 private static int CountEnumSetFlags(JsonSchemaType? schemaType)
 private static bool IsPowerOfTwo(int x)
 {
 int count = 0;

 if (schemaType != null)
 {
 // Check each flag in the enum
 foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
 {
 // Check if the flag is set
 if (schemaType.Value.HasFlag(value))
 {
 count++;
 }
 }
 } 
 return x != 0 && (x & (x - 1)) == 0;
 }

 return count;
 private static bool HasMultipleTypes(JsonSchemaType schemaType)
 {
 var schemaTypeNumeric = (int)schemaType;
 return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
 schemaTypeNumeric != (int)JsonSchemaType.Null;
 }

 private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 {
 // create a new array and insert the type and "null" as values
 Type = type | JsonSchemaType.Null;
 var list = new List<string>();
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Check if the flag is set in 'type' using a bitwise AND operation
 if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
 }

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
 private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 /* If the array has one non-null value, emit Type as string
 * If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 ? OpenApiConstants.NullableExtension
 : OpenApiConstants.Nullable;

 if (flagsCount is 1)
 if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Skip if the flag is not set or if it's the Null flag
 if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
 if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
 {
 // Write the non-null flag value to the writer
 writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 writer.WriteProperty(nullableProp, true);
 }
 }
 else if (!HasMultipleTypes(schemaType))
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 }
 }
}

3 changes: 2 additions & 1 deletion
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
 {
 public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
 public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
 public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
 }
 public static class StringExtensions
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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

Vincent Biret (baywet)
merged 1 commit into

from

Nov 13, 2024
 Merged


fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum
#1915
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 17 additions & 1 deletion
src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
 /// </summary>
 public static class OpenApiTypeMapper
 {
#nullable enable
 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string ToIdentifier(this JsonSchemaType? schemaType)
 public static string? ToIdentifier(this JsonSchemaType? schemaType)
 {
 if (schemaType is null)
 {
 return null;
 }
 return schemaType.Value.ToIdentifier();
 }

 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string? ToIdentifier(this JsonSchemaType schemaType)
 {
 return schemaType switch
 {
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
 _ => null,
 };
 }
#nullable restore

 /// <summary>
 /// Converts a schema type's identifier into the enum equivalent
Expand Down

96 changes: 42 additions & 54 deletions
src/Microsoft.OpenApi/Models/OpenApiSchema.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
 writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, version);
 }
 SerializeTypeProperty(Type, writer, version);

 // allOf
 writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
 writer.WriteStartObject();

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
 }
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

 // description
 writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

 private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 var flagsCount = CountEnumSetFlags(type);
 if (flagsCount is 1)
 if (type is null)
 {
 return;
 }
 if (!HasMultipleTypes(type.Value))
 {
 // check whether nullable is true for upcasting purposes
 if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
 writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
 }
 }
 else if(flagsCount > 1)
 else
 {
 // type
 if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
 {
 DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
 DowncastTypeArrayToV2OrV3(type.Value, writer, version);
 }
 else
 {
 if (type is not null)
 var list = new List<JsonSchemaType>();
 foreach (JsonSchemaType flag in jsonSchemaTypeValues)
 {
 var list = new List<JsonSchemaType?>();
 foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 if (type.Value.HasFlag(flag))
 {
 if (type.Value.HasFlag(flag))
 {
 list.Add(flag);
 }
 list.Add(flag);
 }
 }

 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 } 
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 }
 } 
 }

 private static int CountEnumSetFlags(JsonSchemaType? schemaType)
 private static bool IsPowerOfTwo(int x)
 {
 int count = 0;

 if (schemaType != null)
 {
 // Check each flag in the enum
 foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
 {
 // Check if the flag is set
 if (schemaType.Value.HasFlag(value))
 {
 count++;
 }
 }
 } 
 return x != 0 && (x & (x - 1)) == 0;
 }

 return count;
 private static bool HasMultipleTypes(JsonSchemaType schemaType)
 {
 var schemaTypeNumeric = (int)schemaType;
 return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
 schemaTypeNumeric != (int)JsonSchemaType.Null;
 }

 private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 {
 // create a new array and insert the type and "null" as values
 Type = type | JsonSchemaType.Null;
 var list = new List<string>();
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Check if the flag is set in 'type' using a bitwise AND operation
 if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
 }

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
 private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 /* If the array has one non-null value, emit Type as string
 * If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 ? OpenApiConstants.NullableExtension
 : OpenApiConstants.Nullable;

 if (flagsCount is 1)
 if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Skip if the flag is not set or if it's the Null flag
 if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
 if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
 {
 // Write the non-null flag value to the writer
 writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 writer.WriteProperty(nullableProp, true);
 }
 }
 else if (!HasMultipleTypes(schemaType))
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 }
 }
}

3 changes: 2 additions & 1 deletion
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
 {
 public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
 public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
 public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
 }
 public static class StringExtensions
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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

Vincent Biret (baywet)
merged 1 commit into

from

Nov 13, 2024
 Merged


fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum
#1915
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 17 additions & 1 deletion
src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
 /// </summary>
 public static class OpenApiTypeMapper
 {
#nullable enable
 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string ToIdentifier(this JsonSchemaType? schemaType)
 public static string? ToIdentifier(this JsonSchemaType? schemaType)
 {
 if (schemaType is null)
 {
 return null;
 }
 return schemaType.Value.ToIdentifier();
 }

 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string? ToIdentifier(this JsonSchemaType schemaType)
 {
 return schemaType switch
 {
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
 _ => null,
 };
 }
#nullable restore

 /// <summary>
 /// Converts a schema type's identifier into the enum equivalent
Expand Down

96 changes: 42 additions & 54 deletions
src/Microsoft.OpenApi/Models/OpenApiSchema.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
 writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, version);
 }
 SerializeTypeProperty(Type, writer, version);

 // allOf
 writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
 writer.WriteStartObject();

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
 }
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

 // description
 writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

 private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 var flagsCount = CountEnumSetFlags(type);
 if (flagsCount is 1)
 if (type is null)
 {
 return;
 }
 if (!HasMultipleTypes(type.Value))
 {
 // check whether nullable is true for upcasting purposes
 if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
 writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
 }
 }
 else if(flagsCount > 1)
 else
 {
 // type
 if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
 {
 DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
 DowncastTypeArrayToV2OrV3(type.Value, writer, version);
 }
 else
 {
 if (type is not null)
 var list = new List<JsonSchemaType>();
 foreach (JsonSchemaType flag in jsonSchemaTypeValues)
 {
 var list = new List<JsonSchemaType?>();
 foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 if (type.Value.HasFlag(flag))
 {
 if (type.Value.HasFlag(flag))
 {
 list.Add(flag);
 }
 list.Add(flag);
 }
 }

 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 } 
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 }
 } 
 }

 private static int CountEnumSetFlags(JsonSchemaType? schemaType)
 private static bool IsPowerOfTwo(int x)
 {
 int count = 0;

 if (schemaType != null)
 {
 // Check each flag in the enum
 foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
 {
 // Check if the flag is set
 if (schemaType.Value.HasFlag(value))
 {
 count++;
 }
 }
 } 
 return x != 0 && (x & (x - 1)) == 0;
 }

 return count;
 private static bool HasMultipleTypes(JsonSchemaType schemaType)
 {
 var schemaTypeNumeric = (int)schemaType;
 return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
 schemaTypeNumeric != (int)JsonSchemaType.Null;
 }

 private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 {
 // create a new array and insert the type and "null" as values
 Type = type | JsonSchemaType.Null;
 var list = new List<string>();
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Check if the flag is set in 'type' using a bitwise AND operation
 if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
 }

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
 private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 /* If the array has one non-null value, emit Type as string
 * If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 ? OpenApiConstants.NullableExtension
 : OpenApiConstants.Nullable;

 if (flagsCount is 1)
 if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Skip if the flag is not set or if it's the Null flag
 if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
 if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
 {
 // Write the non-null flag value to the writer
 writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 writer.WriteProperty(nullableProp, true);
 }
 }
 else if (!HasMultipleTypes(schemaType))
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 }
 }
}

3 changes: 2 additions & 1 deletion
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
 {
 public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
 public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
 public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
 }
 public static class StringExtensions
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum#1915

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

Vincent Biret (baywet)
merged 1 commit into

from

Nov 13, 2024
 Merged


fix: multiple performance fixes for type serialization feat: adds to identifier mapping to non nullable enum
#1915
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


18 changes: 17 additions & 1 deletion
src/Microsoft.OpenApi/Extensions/OpenApiTypeMapper.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,27 @@ namespace Microsoft.OpenApi.Extensions
 /// </summary>
 public static class OpenApiTypeMapper
 {
#nullable enable
 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string ToIdentifier(this JsonSchemaType? schemaType)
 public static string? ToIdentifier(this JsonSchemaType? schemaType)
 {
 if (schemaType is null)
 {
 return null;
 }
 return schemaType.Value.ToIdentifier();
 }

 /// <summary>
 /// Maps a JsonSchema data type to an identifier.
 /// </summary>
 /// <param name="schemaType"></param>
 /// <returns></returns>
 public static string? ToIdentifier(this JsonSchemaType schemaType)
 {
 return schemaType switch
 {
Expand All@@ -32,6 +47,7 @@ public static string ToIdentifier(this JsonSchemaType? schemaType)
 _ => null,
 };
 }
#nullable restore

 /// <summary>
 /// Converts a schema type's identifier into the enum equivalent
Expand Down

96 changes: 42 additions & 54 deletions
src/Microsoft.OpenApi/Models/OpenApiSchema.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -476,10 +476,7 @@ public void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version,
 writer.WriteOptionalCollection(OpenApiConstants.Enum, Enum, (nodeWriter, s) => nodeWriter.WriteAny(s));

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, version);
 }
 SerializeTypeProperty(Type, writer, version);

 // allOf
 writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
Expand DownExpand Up@@ -660,10 +657,7 @@ internal void SerializeAsV2(
 writer.WriteStartObject();

 // type
 if (Type is not null)
 {
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);
 }
 SerializeTypeProperty(Type, writer, OpenApiSpecVersion.OpenApi2_0);

 // description
 writer.WriteProperty(OpenApiConstants.Description, Description);
Expand DownExpand Up@@ -794,8 +788,11 @@ internal void SerializeAsV2(

 private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 var flagsCount = CountEnumSetFlags(type);
 if (flagsCount is 1)
 if (type is null)
 {
 return;
 }
 if (!HasMultipleTypes(type.Value))
 {
 // check whether nullable is true for upcasting purposes
 if (version is OpenApiSpecVersion.OpenApi3_1 && (Nullable || Extensions.ContainsKey(OpenApiConstants.NullableExtension)))
Expand All@@ -804,61 +801,50 @@ private void SerializeTypeProperty(JsonSchemaType? type, IOpenApiWriter writer,
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, type.ToIdentifier());
 writer.WriteProperty(OpenApiConstants.Type, type.Value.ToIdentifier());
 }
 }
 else if(flagsCount > 1)
 else
 {
 // type
 if (version is OpenApiSpecVersion.OpenApi2_0 || version is OpenApiSpecVersion.OpenApi3_0)
 {
 DowncastTypeArrayToV2OrV3(type, writer, version, flagsCount);
 DowncastTypeArrayToV2OrV3(type.Value, writer, version);
 }
 else
 {
 if (type is not null)
 var list = new List<JsonSchemaType>();
 foreach (JsonSchemaType flag in jsonSchemaTypeValues)
 {
 var list = new List<JsonSchemaType?>();
 foreach (JsonSchemaType flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 if (type.Value.HasFlag(flag))
 {
 if (type.Value.HasFlag(flag))
 {
 list.Add(flag);
 }
 list.Add(flag);
 }
 }

 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 } 
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s.ToIdentifier()));
 }
 } 
 }

 private static int CountEnumSetFlags(JsonSchemaType? schemaType)
 private static bool IsPowerOfTwo(int x)
 {
 int count = 0;

 if (schemaType != null)
 {
 // Check each flag in the enum
 foreach (JsonSchemaType value in System.Enum.GetValues(typeof(JsonSchemaType)))
 {
 // Check if the flag is set
 if (schemaType.Value.HasFlag(value))
 {
 count++;
 }
 }
 } 
 return x != 0 && (x & (x - 1)) == 0;
 }

 return count;
 private static bool HasMultipleTypes(JsonSchemaType schemaType)
 {
 var schemaTypeNumeric = (int)schemaType;
 return !IsPowerOfTwo(schemaTypeNumeric) && // Boolean, Integer, Number, String, Array, Object
 schemaTypeNumeric != (int)JsonSchemaType.Null;
 }

 private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 {
 // create a new array and insert the type and "null" as values
 Type = type | JsonSchemaType.Null;
 var list = new List<string>();
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Check if the flag is set in 'type' using a bitwise AND operation
 if (Type.Value.HasFlag(flag))
Expand All@@ -870,7 +856,9 @@ private void UpCastSchemaTypeToV31(JsonSchemaType? type, IOpenApiWriter writer)
 writer.WriteOptionalCollection(OpenApiConstants.Type, list, (w, s) => w.WriteValue(s));
 }

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWriter writer, OpenApiSpecVersion version, int flagsCount)
 private static readonly Array jsonSchemaTypeValues = System.Enum.GetValues(typeof(JsonSchemaType));

 private void DowncastTypeArrayToV2OrV3(JsonSchemaType schemaType, IOpenApiWriter writer, OpenApiSpecVersion version)
 {
 /* If the array has one non-null value, emit Type as string
 * If the array has one null value, emit x-nullable as true
Expand All@@ -882,23 +870,12 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 ? OpenApiConstants.NullableExtension
 : OpenApiConstants.Nullable;

 if (flagsCount is 1)
 if (!HasMultipleTypes(schemaType ^ JsonSchemaType.Null) && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 else if (flagsCount is 2 && (schemaType & JsonSchemaType.Null) == JsonSchemaType.Null) // checks for two values and one is null
 {
 foreach (JsonSchemaType? flag in System.Enum.GetValues(typeof(JsonSchemaType)))
 foreach (JsonSchemaType? flag in jsonSchemaTypeValues)
 {
 // Skip if the flag is not set or if it's the Null flag
 if (schemaType.Value.HasFlag(flag) && flag != JsonSchemaType.Null)
 if (schemaType.HasFlag(flag) && flag != JsonSchemaType.Null)
 {
 // Write the non-null flag value to the writer
 writer.WriteProperty(OpenApiConstants.Type, flag.ToIdentifier());
Expand All@@ -909,6 +886,17 @@ private void DowncastTypeArrayToV2OrV3(JsonSchemaType? schemaType, IOpenApiWrite
 writer.WriteProperty(nullableProp, true);
 }
 }
 else if (!HasMultipleTypes(schemaType))
 {
 if (schemaType is JsonSchemaType.Null)
 {
 writer.WriteProperty(nullableProp, true);
 }
 else
 {
 writer.WriteProperty(OpenApiConstants.Type, schemaType.ToIdentifier());
 }
 }
 }
 }
}

3 changes: 2 additions & 1 deletion
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -192,7 +192,8 @@ namespace Microsoft.OpenApi.Extensions
 {
 public static System.Type MapOpenApiPrimitiveTypeToSimpleType(this Microsoft.OpenApi.Models.OpenApiSchema schema) { }
 public static Microsoft.OpenApi.Models.OpenApiSchema MapTypeToOpenApiPrimitiveType(this System.Type type) { }
 public static string ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType schemaType) { }
 public static string? ToIdentifier(this Microsoft.OpenApi.Models.JsonSchemaType? schemaType) { }
 public static Microsoft.OpenApi.Models.JsonSchemaType ToJsonSchemaType(this string identifier) { }
 }
 public static class StringExtensions
Expand Down