Skip to content

Commit 43c75a9

Browse files
baywetbaywet
authored
Merge pull request #2659 from microsoft/copilot/fix-openapi-pointer-skip
fix: correct error pointer when extension parser throws OpenApiException
2 parents c04dff5 + 8021a75 commit 43c75a9

5 files changed

Lines changed: 130 additions & 18 deletions

File tree

‎src/Microsoft.OpenApi/Reader/V2/OpenApiV2Deserializer.cs‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,18 @@ private static IOpenApiExtension LoadExtension(string name, ParseNode node)
7979
{
8080
if (node.Context.ExtensionParsers is not null && node.Context.ExtensionParsers.TryGetValue(name, out var parser))
8181
{
82-
return parser(node.CreateAny(), OpenApiSpecVersion.OpenApi2_0);
83-
}
84-
else
85-
{
86-
return new JsonNodeExtension(node.CreateAny());
82+
try
83+
{
84+
return parser(node.CreateAny(), OpenApiSpecVersion.OpenApi2_0);
85+
}
86+
catch (OpenApiException ex)
87+
{
88+
ex.Pointer = node.Context.GetLocation();
89+
node.Context.Diagnostic.Errors.Add(new(ex));
90+
}
8791
}
92+
93+
return new JsonNodeExtension(node.CreateAny());
8894
}
8995

9096
private static string? LoadString(ParseNode node)

‎src/Microsoft.OpenApi/Reader/V3/OpenApiV3Deserializer.cs‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -130,15 +130,24 @@ public static JsonNodeExtension LoadAny(ParseNode node, OpenApiDocument hostDocu
130130

131131
private static IOpenApiExtension LoadExtension(string name, ParseNode node)
132132
{
133-
if (node.Context.ExtensionParsers is not null && node.Context.ExtensionParsers.TryGetValue(name, out var parser) && parser(
134-
node.CreateAny(), OpenApiSpecVersion.OpenApi3_0) is { } result)
133+
if (node.Context.ExtensionParsers is not null && node.Context.ExtensionParsers.TryGetValue(name, out var parser))
135134
{
136-
return result;
137-
}
138-
else
139-
{
140-
return new JsonNodeExtension(node.CreateAny());
135+
try
136+
{
137+
var result = parser(node.CreateAny(), OpenApiSpecVersion.OpenApi3_0);
138+
if (result is { })
139+
{
140+
return result;
141+
}
142+
}
143+
catch (OpenApiException ex)
144+
{
145+
ex.Pointer = node.Context.GetLocation();
146+
node.Context.Diagnostic.Errors.Add(new(ex));
147+
}
141148
}
149+
150+
return new JsonNodeExtension(node.CreateAny());
142151
}
143152

144153
private static string? LoadString(ParseNode node)

‎src/Microsoft.OpenApi/Reader/V31/OpenApiV31Deserializer.cs‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,20 @@ public static JsonNode LoadAny(ParseNode node, OpenApiDocument hostDocument)
131131

132132
private static IOpenApiExtension LoadExtension(string name, ParseNode node)
133133
{
134-
return node.Context.ExtensionParsers is not null && node.Context.ExtensionParsers.TryGetValue(name, out var parser)
135-
? parser(node.CreateAny(), OpenApiSpecVersion.OpenApi3_1)
136-
: new JsonNodeExtension(node.CreateAny());
134+
if (node.Context.ExtensionParsers is not null && node.Context.ExtensionParsers.TryGetValue(name, out var parser))
135+
{
136+
try
137+
{
138+
return parser(node.CreateAny(), OpenApiSpecVersion.OpenApi3_1);
139+
}
140+
catch (OpenApiException ex)
141+
{
142+
ex.Pointer = node.Context.GetLocation();
143+
node.Context.Diagnostic.Errors.Add(new(ex));
144+
}
145+
}
146+
147+
return new JsonNodeExtension(node.CreateAny());
137148
}
138149

139150
private static string? LoadString(ParseNode node)

‎src/Microsoft.OpenApi/Reader/V32/OpenApiV32Deserializer.cs‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,20 @@ public static JsonNode LoadAny(ParseNode node, OpenApiDocument hostDocument)
131131

132132
private static IOpenApiExtension LoadExtension(string name, ParseNode node)
133133
{
134-
return node.Context.ExtensionParsers is not null && node.Context.ExtensionParsers.TryGetValue(name, out var parser)
135-
? parser(node.CreateAny(), OpenApiSpecVersion.OpenApi3_2)
136-
: new JsonNodeExtension(node.CreateAny());
134+
if (node.Context.ExtensionParsers is not null && node.Context.ExtensionParsers.TryGetValue(name, out var parser))
135+
{
136+
try
137+
{
138+
return parser(node.CreateAny(), OpenApiSpecVersion.OpenApi3_2);
139+
}
140+
catch (OpenApiException ex)
141+
{
142+
ex.Pointer = node.Context.GetLocation();
143+
node.Context.Diagnostic.Errors.Add(new(ex));
144+
}
145+
}
146+
147+
return new JsonNodeExtension(node.CreateAny());
137148
}
138149

139150
private static string? LoadString(ParseNode node)

‎test/Microsoft.OpenApi.Readers.Tests/TestCustomExtension.cs‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,81 @@ public void ParseCustomExtension()
4444
Assert.Equal("hey", fooExtension.Bar);
4545
Assert.Equal("hi!", fooExtension.Baz);
4646
}
47+
48+
[Fact]
49+
public void ExtensionParserThrowingOpenApiException_V2_ShouldHaveCorrectPointer()
50+
{
51+
var json = """
52+
{
53+
"swagger": "2.0",
54+
"info": {
55+
"title": "Demo",
56+
"version": "1"
57+
},
58+
"paths": {},
59+
"definitions": {
60+
"demo": {
61+
"x-tag": null
62+
}
63+
}
64+
}
65+
""";
66+
var settings = new OpenApiReaderSettings
67+
{
68+
ExtensionParsers =
69+
{
70+
{ "x-tag", (any, version) => throw new OpenApiException("Testing") }
71+
}
72+
};
73+
74+
var result = OpenApiDocument.Parse(json, "json", settings);
75+
76+
Assert.NotNull(result.Diagnostic);
77+
Assert.NotEmpty(result.Diagnostic.Errors);
78+
var error = result.Diagnostic.Errors[0];
79+
Assert.Equal("Testing", error.Message);
80+
Assert.Equal("#/definitions/demo/x-tag", error.Pointer);
81+
}
82+
83+
[Theory]
84+
[InlineData("3.0.4")]
85+
[InlineData("3.1.1")]
86+
[InlineData("3.2.0")]
87+
public void ExtensionParserThrowingOpenApiException_V3_ShouldHaveCorrectPointer(string version)
88+
{
89+
var json = $$"""
90+
{
91+
"openapi": "{{version}}",
92+
"info": {
93+
"title": "Demo",
94+
"version": "1"
95+
},
96+
"paths": {},
97+
"components": {
98+
"schemas": {
99+
"demo": {
100+
"x-tag": null
101+
}
102+
}
103+
}
104+
}
105+
""";
106+
var settings = new OpenApiReaderSettings
107+
{
108+
ExtensionParsers =
109+
{
110+
{ "x-tag", (any, version) => throw new OpenApiException("Testing") }
111+
}
112+
};
113+
114+
var result = OpenApiDocument.Parse(json, "json", settings);
115+
116+
Assert.NotNull(result.Diagnostic);
117+
Assert.NotEmpty(result.Diagnostic.Errors);
118+
var error = result.Diagnostic.Errors[0];
119+
Assert.Equal("Testing", error.Message);
120+
Assert.Equal("#/components/schemas/demo/x-tag", error.Pointer);
121+
}
47122
}
48123

49124
internal class FooExtension : IOpenApiExtension, IOpenApiElement

0 commit comments

Comments
 (0)