Skip to content

Fixes #580 Change PageResult<T> property names on serialization #1470

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
merged 1 commit into from
Apr 24, 2025
Merged

Fixes #580 Change PageResult<T> property names on serialization #1470

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
11 changes: 8 additions & 3 deletions src/Microsoft.AspNetCore.OData/Results/PageResultValueConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,26 @@ public override PageResult<TEntity> Read(ref Utf8JsonReader reader, Type typeToC
public override void Write(Utf8JsonWriter writer, PageResult<TEntity> value, JsonSerializerOptions options)
{
writer.WriteStartObject();
writer.WritePropertyName("items");
writer.WritePropertyName(ConvertName(options, "items"));
JsonSerializer.Serialize(writer, value.Items, options);

if (value.NextPageLink != null)
{
writer.WritePropertyName("nextpagelink");
writer.WritePropertyName(ConvertName(options, "nextpagelink"));
writer.WriteStringValue(value.NextPageLink.OriginalString);
}

if (value.Count != null)
{
writer.WritePropertyName("count");
writer.WritePropertyName(ConvertName(options, "count"));
writer.WriteNumberValue(value.Count.Value);
}

writer.WriteEndObject();
}

private static string ConvertName(JsonSerializerOptions options, string name)
=> options != null && options.PropertyNamingPolicy != null
Copy link
Member

@WanjohiSammy WanjohiSammy Apr 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this only targeting PropertyNamingPolicy

? options.PropertyNamingPolicy.ConvertName(name)
: name;
}
46 changes: 42 additions & 4 deletions test/Microsoft.AspNetCore.OData.Tests/Results/PageResultValueConverterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.AspNetCore.OData.Results;
using Microsoft.AspNetCore.OData.TestCommon;
using Microsoft.AspNetCore.OData.Tests.Extensions;
using Xunit;

Expand Down Expand Up @@ -48,8 +49,23 @@ public void CreateConverter_WorksForPageResultValueConverter()
Assert.Null(typeConverter);
}

[Fact]
public void PageResultValueConverter_CanSerializePageResultOfT()
public static TheoryDataSet<string, JsonNamingPolicy> PageResultValueConverterData
{
get
{
return new TheoryDataSet<string, JsonNamingPolicy>
{
{ "{\"items\":[{\"Id\":1,\"Name\":\"abc\"},{\"Id\":2,\"Name\":\"efg\"}],\"nextpagelink\":\"http://any\",\"count\":2}", null },
{ "{\"items\":[{\"id\":1,\"name\":\"abc\"},{\"id\":2,\"name\":\"efg\"}],\"nextpagelink\":\"http://any\",\"count\":2}", JsonNamingPolicy.CamelCase },
{ "{\"ITEMS\":[{\"ID\":1,\"NAME\":\"abc\"},{\"ID\":2,\"NAME\":\"efg\"}],\"NEXTPAGELINK\":\"http://any\",\"COUNT\":2}", JsonNamingPolicy.SnakeCaseUpper },
{ "{\"values\":[{\"Id\":1,\"Name\":\"abc\"},{\"Id\":2,\"Name\":\"efg\"}],\"next_page_link\":\"http://any\",\"count\":2}", new MyNamingPolicy() }
};
}
}

[Theory]
[MemberData(nameof(PageResultValueConverterData))]
public void PageResultValueConverter_CanSerializePageResultOfT_WithNamingPolicy(string expected, JsonNamingPolicy policy)
{
// Arrange & Act & Assert
IEnumerable<Customer> customers = new Customer[]
Expand All @@ -61,7 +77,11 @@ public void PageResultValueConverter_CanSerializePageResultOfT()
long? count = 2;
PageResult<Customer> result = new PageResult<Customer>(customers, nextPageLink, count);

JsonSerializerOptions options = new JsonSerializerOptions();
JsonSerializerOptions options = new JsonSerializerOptions
{
PropertyNamingPolicy = policy
};

PageResultValueConverter converterFactory = new PageResultValueConverter();
Type type = typeof(PageResult<Customer>);
PageResultConverter<Customer> typeConverter = converterFactory.CreateConverter(type, options) as PageResultConverter<Customer>;
Expand All @@ -70,7 +90,25 @@ public void PageResultValueConverter_CanSerializePageResultOfT()
string json = SerializeUtils.SerializeAsJson(jsonWriter => typeConverter.Write(jsonWriter, result, options));

// Assert
Assert.Equal("{\"items\":[{\"Id\":1,\"Name\":\"abc\"},{\"Id\":2,\"Name\":\"efg\"}],\"nextpagelink\":\"http://any\",\"count\":2}", json);
Assert.Equal(expected, json);
}

private class MyNamingPolicy : JsonNamingPolicy
{
public override string ConvertName(string name)
{
if (name == "nextpagelink")
{
return "next_page_link";
}

if (name == "items")
{
return "values";
}

return name;
}
}

private class Customer
Expand Down