Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/berhir/AspNetCore.SpaYarp
An alternative approach to the new ASP.NET Core SPA templates in .NET 6. It uses YARP as proxy to forward requests to the SPA dev server.
https://github.com/berhir/AspNetCore.SpaYarp
asp-net-core proxy spa yarp
Last synced: about 2 months ago
JSON representation
An alternative approach to the new ASP.NET Core SPA templates in .NET 6. It uses YARP as proxy to forward requests to the SPA dev server.
- Host: GitHub
- URL: https://github.com/berhir/AspNetCore.SpaYarp
- Owner: berhir
- License: mit
- Created: 2021-09-03T13:12:40.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T14:19:16.000Z (6 months ago)
- Last Synced: 2024-06-28T05:20:51.344Z (3 months ago)
- Topics: asp-net-core, proxy, spa, yarp
- Language: C#
- Homepage:
- Size: 698 KB
- Stars: 96
- Watchers: 7
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# AspNetCore.SpaYarp
[](https://www.nuget.org/packages/AspNetCore.SpaYarp/)
_Supported ASP.NET Core versions:_
| AspNetCore.SpaYarp version | .NET Version |
|----------------------------|------------------|
| 1.1.0 | 3.1, 5.0 and 6.0 |
| 2.0.0 | 6.0 and 7.0 |
With [ASP.NET Core Preview 4](https://devblogs.microsoft.com/aspnet/asp-net-core-updates-in-net-6-preview-4/#improved-single-page-app-spa-templates), the ASP.NET Core team introduced a [new experience for SPA templates](https://github.com/dotnet/aspnetcore/issues/27887).
The main benefit of this new experience is that it's possible to start and stop the backend and client projects independently.
This is a very welcome change and speeds up the development process. But it also includes another more controversial change.
The old templates served the client application as part of the ASP.NET Core host and forwarded the requests to the SPA.
With the new templates, the URL of the SPA is used to run the application, and requests to the backend get forwarded by a built-in proxy of the SPA dev server.
_AspNetCore.SpaYarp_ uses a different approach. Instead of using the SPA dev server to forward requests to the host/backend, it uses [YARP](https://microsoft.github.io/reverse-proxy/index.html) to forward all requests that can't be handled by the host to the client application.
It works similar to the old templates, but with the advantage of the new templates to start and stop the backend and client projects independently.
The following graphic shows the differences:
To get more insights you can read my blog post [An alternative approach to the ASP.NET Core SPA templates using YARP](https://guidnew.com/en/blog/an-alternative-approach-to-the-asp-net-core-spa-templates-using-yarp).
## Running the sample
To run the sample, open the solution in Visual Studio and start the `Net6Startup` or `Net7WebApplicationBuilder` project.
It reuses an existing SPA dev server if the client app is already running (started manually in a terminal or VS Code) or it starts a new one.
## Debugging
It's possible to debug the .NET code and the SPA at the same time with different editors. To use Visual Studio Code to debug the SPA, create a `launch.json` file as [described in the docs](https://code.visualstudio.com/docs/nodejs/angular-tutorial#_debugging-angular).
But instead of the URL of the SPA, the URL of the .NET host must be used.
This is the `launch.json` file used in the sample projects:
```json
{
"version": "0.2.0",
"configurations": [
{
"type": "pwa-msedge",
"request": "launch",
"name": "Launch Edge against localhost",
"url": "https://localhost:7113",
"webRoot": "${workspaceFolder}"
}
]
}
```
## Using AspNetCore.SpaYarp
### Configure settings in project file
```xml
ClientApp\
https://localhost:44478
npm start
```
### Setup with WebApplication builder
Use `AddSpaYarp()` to register the services and `UseSpaYarp()` to add the middlware and configure the route endpoint.
```csharp
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddControllersWithViews();
// Like with Microsoft.AspNetCore.SpaProxy, a 'spa.proxy.json' file gets generated based on the values in the project file (SpaRoot, SpaProxyClientUrl, SpaProxyLaunchCommand).
// This file gets not published when using "dotnet publish".
// The services get not added and the proxy is not used when the file does not exist.
builder.Services.AddSpaYarp();
var app = builder.Build();
// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.MapControllerRoute(
name: "default",
pattern: "{controller}/{action=Index}/{id?}");
// The middlewares get only added if the 'spa.proxy.json' file exists and the SpaYarp services were added.
app.UseSpaYarp();
// If the SPA proxy is used, this will never be reached.
app.MapFallbackToFile("index.html");
app.Run();
```
### Setup with Startup.cs
Use `AddSpaYarp()` to register the services, `UseSpaYarpMiddleware()` to add the middlware, and `MapSpaYarp()` to configure the route endpoint.
```csharp
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
// Like with Microsoft.AspNetCore.SpaProxy, a 'spa.proxy.json' file gets generated based on the values in the project file (SpaRoot, SpaProxyClientUrl, SpaProxyLaunchCommand).
// This file gets not published when using "dotnet publish".
// The services get not added and the proxy is not used when the file does not exist.
services.AddSpaYarp();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Error");
// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
// The middleware gets only added if the 'spa.proxy.json' file exists and the SpaYarp services were added.
app.UseSpaYarpMiddleware();
app.UseRouting();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller}/{action=Index}/{id?}");
// The route endpoint gets only added if the 'spa.proxy.json' file exists and the SpaYarp services were added.
endpoints.MapSpaYarp();
// If the SPA proxy is used, this will never be reached.
endpoints.MapFallbackToFile("index.html");
});
}
}
```
### Multiple SPA Sites
This feature lets you combine multiple SPA dev servers into one, with each providing its site to a separate path.
There is a sample demonstrating how to do this as well.
```cs
app.UseSpaYarpMiddleware();
app.MapSpaYarp("one", "https://localhost:44478");
app.MapSpaYarp("two", "https://localhost:44479");
```
## Migrate from SpaProxy
This guide assumes that you are using the default ASP.NET Core with Angular Template (but should work the same for other frameworks too).
Thanks to @mdowais for this guide.
__Step 1: Add the Nuget Package__
https://www.nuget.org/packages/AspNetCore.SpaYarp
__Step 2: Remove Old SpaProxy Package__
Remove the Package Microsoft.AspNetCore.SpaProxy. As it is not needed for this implementation.
Note: The default template adds a Environment Variable `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "Microsoft.AspNetCore.SpaProxy"`, in the `launchSettings.json` (Debug Properties in Visual Studio). Which has to be removed, so that you don't see an annoying Exception thrown that "Microsoft.AspNetCore.SpaProxy" is 404.
__Step 3: Remove proxy.conf.js__
Remove the `proxy.conf.js` file that contains the proxy config for the client dev server.
And remove the reference to this file from the `angular.json` file too.
__Step 4: Change Project Properties__
In your Project Settings (csproj) -> PropertyGroup, change the following
`SpaProxyServerUrl` to `SpaClientUrl`
`SpaProxyLaunchCommand` to `SpaLaunchCommand`
__Step 5: Add the Services and Usings in your Program.cs__
```cs
// First
builder.Services.AddSpaYarp()
//Second
app.UseSpaYarp();
```