[SignalR-Playground] Ignore null fields when serializing negotiate response #8203
Conversation
cqnguy23
commented
Mar 20, 2025
cqnguy23
commented
- Add a serializing option to ignore null fields for negotiate response as a workaround for this bug in SignalR Client .NET Library
There was a problem hiding this comment.
Pull Request Overview
This PR adds a serializing option to ignore null fields in the negotiate response to work around an identified bug in the SignalR Client .NET Library.
- Added using directives for System.Text.Json and System.Text.Json.Serialization.
- Updated the negotiate endpoint to use Results.Json with a JsonSerializerOptions that ignores null values.
Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more
dotnet-policy-service
bot
added
the
community-contribution
github-actions
bot
added
the
needs-area-label
|
Hi @cqnguy23, This bug doesn't exist in the JavaScript SignalR client; therefore, this change isn't needed—unless the playground sample code is updated to use the .NET SignalR client. |
| @@ -39,7 +41,10 @@ | |||
| UserId = userId ?? "user1" | |||
| }); | |||
|
|
|||
| return Results.Ok(negotiateResponse); | |||
| return Results.Json(negotiateResponse, new JsonSerializerOptions(JsonSerializerDefaults.Web) | |||
There was a problem hiding this comment.
JsonSerializerOptions should not be created per request.
It's not necessary to run this playground sample, but I think it would prevent users from getting error in case they were looking at this sample as a reference, and they are using the .NET SignalR client instead. |
| using Microsoft.AspNetCore.SignalR; | ||
| using Microsoft.Azure.SignalR.Management; | ||
|
|
||
| var builder = WebApplication.CreateBuilder(args); | ||
|
|
||
| builder.Services.AddRazorPages(); | ||
| builder.Services.ConfigureHttpJsonOptions(options => | ||
| { | ||
| options.SerializerOptions.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull; |
There was a problem hiding this comment.
this changes the default behavior for all the apis. var ingoreNullOption = new JsonSerializerOptions... for negotiate is enough?
eerhardt
added
area-integrations
