tpeczek / demo.ndjson.asyncstreams

Sample project for demonstrating how to use async streams and NDJSON to improve user experience by streaming JSON objects from server to client and client to server in .NET

Demo.Ndjson.AsyncStreams

Sample project for demonstrating how to use async streams and NDJSON to improve user experience by streaming JSON objects from server to client and client to server in .NET. You can read more here:

• Fetch API, Streams API, NDJSON, and ASP.NET Core MVC
• Consuming JSON Objects Stream (NDJSON) With HttpClient
• Streaming JSON Objects (NDJSON) With HttpClient
• Receiving JSON Objects Stream (NDJSON) in ASP.NET Core MVC
• ASP.NET Core 6 and IAsyncEnumerable - Async Streamed JSON vs NDJSON
• ASP.NET Core 6 and IAsyncEnumerable - Receiving Async Streamed JSON in Blazor WebAssembly

Sponsor This Project

My blog and open source projects are result of my passion for software development, but they require a fair amount of my personal time. If you got value from any of the content I create, then I would appreciate your support by sponsoring me (either monthly or one-time).

Copyright and License

Copyright © 2019 - 2024 Tomasz Pęczek

Licensed under the MIT License

demo.ndjson.asyncstreams's Issues

Compressing and Decompressing Streams

The Compression Streams API enables compressing and decompressing streams of data using the gzip or deflate formats. This should be explored separately for every client type:

• Browser (Vanilla JS)
• Browser (Blazor WebAssembly)
• Desktop .NET

---

• https://web.dev/blog/compressionstreams
• https://developer.mozilla.org/en-US/docs/Web/API/Compression_Streams_API

Requests Streaming

Currently there is only one sample of request streaming - streaming NDJSON from Desktop .NET. Following options should be explored:

• NDJSON from Browser - Vanilla JS
• NDJSON from Browser - Blazor WebAssembly
• JSON from Desktop .NET
• JSON from Browser - Blazor WebAssembly

[DEPENDS ON] chromium/688906
[DEPENDS ON] dotnet/runtime#36634

---

• https://web.dev/fetch-upload-streaming/
• https://chromestatus.com/feature/5274139738767360

Create Lib.AspNetCore.Mvc.Ndjson NuGet package based on aspnetcore-v3.0.0 branch

New Async streaming in ASP.NET 6

https://devblogs.microsoft.com/aspnet/asp-net-core-updates-in-net-6-preview-4/#async-streaming

Potential to simplify code for this sample project?

Consuming Async Streamed JSON

Currently there are sample of consuming async streamed JSON in following scenarios:

• Blazor WebAssembly
• Desktop .NET
• JSON from Browser - Blazor WebAssembly

There is one scenario missing: Browser - Vanilla JS.

---

• https://github.com/jimhigson/oboe.js/

Requests Cancellation

As streamed responses can be streaming for significant time, client may wish to cancel them. This should be explored separately for every client type:

• Browser (Vanilla JS)
• Browser (Blazor WebAssembly)
• Desktop .NET

[DEPENDS ON] dotnet/runtime#64225
[DEPENDS ON] tpeczek/Ndjson.AsyncStreams#6