JSInterop Streaming implementation to allow for larger objects over S…

…ignalR (#247) * Added Streaming provider to support storing objects larger than the SignalR message limit * updated readme to include streaming use * cleanup --------- Co-authored-by: Chris Sainty <[email protected]>
Blazored · Sep 18, 2024 · e1139f9 · e1139f9
1 parent 8f60bf3
commit e1139f9
Show file tree

Hide file tree

Showing 11 changed files with 479 additions and 358 deletions.
diff --git a/README.md b/README.md
@@ -79,6 +79,27 @@ builder.Services.AddBlazoredLocalStorageAsSingleton();
 
 This method will not work with Blazor Server applications as Blazor's JS interop services are registered as Scoped and cannot be injected into Singletons.
 
+### Using JS Interop Streaming
+When using interactive components in server-side apps JS Interop calls are limited to the configured SignalR message size (default: 32KB). 
+Therefore when attempting to store or retrieve an object larger than this in LocalStorage the call will fail with a SignalR exception. 
+
+The following streaming implementation can be used to remove this limit (you will still be limited by the browser).
+
+Register the streaming local storage service 
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+    services.AddBlazoredLocalStorageStreaming();
+}
+``` 
+
+Add the JavaScript file to your _App.razor_
+
+```html
+ <script src="_content/Blazored.LocalStorage/Blazored.LocalStorage.js"></script>
+```
+
 ## Usage (Blazor WebAssembly)
 To use Blazored.LocalStorage in Blazor WebAssembly, inject the `ILocalStorageService` per the example below.
 

diff --git a/samples/InteractiveServer/Components/App.razor b/samples/InteractiveServer/Components/App.razor
@@ -15,6 +15,7 @@
 <body>
 <Routes @rendermode="InteractiveServer"/>
 <script src="_framework/blazor.web.js"></script>
+<script src="_content/Blazored.LocalStorage/Blazored.LocalStorage.js"></script>
 </body>
 
 </html>
diff --git a/samples/InteractiveServer/Program.cs b/samples/InteractiveServer/Program.cs
@@ -11,7 +11,10 @@
     .AddInteractiveServerComponents();
 
 builder.Services.Replace(ServiceDescriptor.Scoped<IJsonSerializer, NewtonSoftJsonSerializer>());
+
 builder.Services.AddBlazoredLocalStorage();
+// Use the below to enable streaming of objects with local storage
+//builder.Services.AddBlazoredLocalStorageStreaming();
 
 var app = builder.Build();
 

diff --git a/src/Blazored.LocalStorage/Blazored.LocalStorage.csproj b/src/Blazored.LocalStorage/Blazored.LocalStorage.csproj
@@ -65,4 +65,8 @@
     </AssemblyAttribute>
   </ItemGroup>
 
+  <ItemGroup>
+    <Content Update="wwwroot\Blazored.LocalStorage.js"></Content>
+  </ItemGroup>
+
 </Project>