Skip to content

fix: restore orderby fallback for unresolved navigation targets #954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Gavin Barron (gavinbarron) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: restore orderby fallback for unresolved navigation targets #954

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
9 changes: 5 additions & 4 deletions src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyGetOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@
}

/// <inheritdoc/>
protected override void SetParameters(OpenApiOperation operation)

Check failure on line 152 in src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyGetOperationHandler.cs

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Refactor this method to reduce its Cognitive Complexity from 17 to the 15 allowed. 


See more on https://sonarcloud.io/project/issues?id=microsoft_OpenAPI.NET.OData&issues=AaHSJmxvPAqB8eQYPjDh&open=AaHSJmxvPAqB8eQYPjDh&pullRequest=954

Check warning on line 152 in src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyGetOperationHandler.cs

View workflow job for this annotation

GitHub Actions / Build 

Refactor this method to reduce its Cognitive Complexity from 17 to the 15 allowed.

Check warning on line 152 in src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyGetOperationHandler.cs

View workflow job for this annotation

GitHub Actions / Build 

Refactor this method to reduce its Cognitive Complexity from 17 to the 15 allowed.
{
base.SetParameters(operation);

Expand Down Expand Up @@ -178,11 +178,12 @@
AddParameterIfExists(parametersToAdd, Context.CreateFilter, Context.CreateFilter);
AddParameterIfExists(parametersToAdd, Context.CreateCount, Context.CreateCount);

var orderByParameter = (string.IsNullOrEmpty(TargetPath), NavigationProperty) switch
// Fall back only for unresolved targets, not for explicit sorting restrictions.
var orderByParameter = (string.IsNullOrEmpty(TargetPath) ? null : Context.Model.GetTargetPath(TargetPath), NavigationProperty) switch
{
(false, not null) when NavigationProperty.ToEntityType() is {} entityType =>
Context.CreateOrderBy(TargetPath!, entityType),
(true, not null) => Context.CreateOrderBy(NavigationProperty),
({} target, not null) when NavigationProperty.ToEntityType() is {} entityType =>
Context.CreateOrderBy(target, entityType),
(null, not null) => Context.CreateOrderBy(NavigationProperty),
_ => null,
};
if (orderByParameter != null)
Expand Down
98 changes: 98 additions & 0 deletions ...rosoft.OpenAPI.OData.Reader.Tests/Operation/NavigationPropertyGetOperationHandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using System.Xml.Linq;
using Microsoft.OData.Edm;
using Microsoft.OData.Edm.Csdl;
using Microsoft.OpenApi.OData.Edm;
using Microsoft.OpenApi.OData.Generator;
using Microsoft.OpenApi.OData.PathItem.Tests;
Expand Down Expand Up @@ -145,6 +147,102 @@ public void CreateNavigationGetOperationViaComposableFunctionReturnsCorrectOpera
Assert.Contains(operation.Parameters, x => x.Name == "path");
}

[Theory]
[InlineData(true)]
[InlineData(false)]
public void CreateNavigationGetOperationWithUnresolvedFunctionTargetUsesPropertySortRestrictions(bool sortable)
{
VerifyNavigationSortRestrictions(viaFunction: true, propertySortable: sortable, pathSortable: null);
}

[Theory]
[InlineData(true, null)]
[InlineData(true, false)]
[InlineData(false, true)]
public void CreateNavigationGetOperationWithResolvedTargetUsesPathSortRestrictions(bool propertySortable, bool? pathSortable)
{
VerifyNavigationSortRestrictions(viaFunction: false, propertySortable, pathSortable);
}

private void VerifyNavigationSortRestrictions(bool viaFunction, bool propertySortable, bool? pathSortable)
{
string pathAnnotation = pathSortable.HasValue ? $@"
<Annotations Target=""microsoft.graph.GraphService/tables/columns"">
<Annotation Term=""Org.OData.Capabilities.V1.SortRestrictions"">
<Record>
<PropertyValue Property=""Sortable"" Bool=""{pathSortable.Value.ToString().ToLowerInvariant()}"" />
</Record>
</Annotation>
</Annotations>" : "";
string csdl = $@"
<edmx:Edmx Version=""4.0"" xmlns:edmx=""http://docs.oasis-open.org/odata/ns/edmx"">
<edmx:DataServices>
<Schema Namespace=""microsoft.graph"" xmlns=""http://docs.oasis-open.org/odata/ns/edm"">
<EntityType Name=""workbookTable"">
<Key><PropertyRef Name=""id"" /></Key>
<Property Name=""id"" Type=""Edm.String"" Nullable=""false"" />
<NavigationProperty Name=""columns"" Type=""Collection(microsoft.graph.workbookTableColumn)"" ContainsTarget=""true"">
<Annotation Term=""Org.OData.Capabilities.V1.SortRestrictions"">
<Record>
<PropertyValue Property=""Sortable"" Bool=""{propertySortable.ToString().ToLowerInvariant()}"" />
<PropertyValue Property=""NonSortableProperties"">
<Collection><PropertyPath>id</PropertyPath></Collection>
</PropertyValue>
</Record>
</Annotation>
</NavigationProperty>
</EntityType>
<EntityType Name=""workbookTableColumn"">
<Key><PropertyRef Name=""id"" /></Key>
<Property Name=""id"" Type=""Edm.String"" Nullable=""false"" />
<Property Name=""name"" Type=""Edm.String"" />
</EntityType>
<Function Name=""itemAt"" IsBound=""true"" IsComposable=""true"">
<Parameter Name=""bindingParameter"" Type=""Collection(microsoft.graph.workbookTable)"" />
<Parameter Name=""index"" Type=""Edm.Int32"" Nullable=""false"" />
<ReturnType Type=""microsoft.graph.workbookTable"" />
</Function>
<EntityContainer Name=""GraphService"">
<EntitySet Name=""tables"" EntityType=""microsoft.graph.workbookTable"" />
</EntityContainer>
{pathAnnotation}
</Schema>
</edmx:DataServices>
</edmx:Edmx>";
IEdmModel model = CsdlReader.Parse(XElement.Parse(csdl).CreateReader());
IEdmEntitySet tables = model.EntityContainer.FindEntitySet("tables");
IEdmNavigationProperty columns = tables.EntityType.DeclaredNavigationProperties().Single();
var path = new ODataPath(new ODataNavigationSourceSegment(tables));
if (viaFunction)
{
path.Push(new ODataOperationSegment(model.SchemaElements.OfType<IEdmFunction>().Single()));
}
else
{
path.Push(new ODataKeySegment(tables.EntityType));
}
path.Push(new ODataNavigationPropertySegment(columns));

var target = model.GetTargetPath(path.GetTargetPath(model));
Assert.Equal(viaFunction, target is null);

var settings = new OpenApiConvertSettings { UseStringArrayForQueryOptionsSchema = false };
var operation = _operationHandler.CreateOperation(new ODataContext(model, settings), path);

if (viaFunction ? propertySortable : pathSortable ?? true)
{
var orderBy = Assert.Single(operation.Parameters, parameter => parameter.Name == "$orderby");
var expectedProperties = viaFunction
? new[] { "name", "name desc" }
: new[] { "id", "id desc", "name", "name desc" };
Assert.Equal(expectedProperties, orderBy.Schema.Items.Enum.Select(value => value.GetValue<string>()));
}
else
{
Assert.DoesNotContain(operation.Parameters, parameter => parameter.Name == "$orderby");
}
}

[Fact]
public void CreateNavigationGetOperationViaOverloadedComposableFunctionReturnsCorrectOperation()
{
Expand Down
Loading