File: Proxying\SpaProxyingExtensions.cs
Web Access
Project: src\src\Middleware\Spa\SpaServices.Extensions\src\Microsoft.AspNetCore.SpaServices.Extensions.csproj (Microsoft.AspNetCore.SpaServices.Extensions)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using Microsoft.AspNetCore.SpaServices;
using Microsoft.AspNetCore.SpaServices.Extensions.Proxy;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
 
namespace Microsoft.AspNetCore.Builder;
 
/// <summary>
/// Extension methods for proxying requests to a local SPA development server during
/// development. Not for use in production applications.
/// </summary>
public static class SpaProxyingExtensions
{
    /// <summary>
    /// Configures the application to forward incoming requests to a local Single Page
    /// Application (SPA) development server. This is only intended to be used during
    /// development. Do not enable this middleware in production applications.
    /// </summary>
    /// <param name="spaBuilder">The <see cref="ISpaBuilder"/>.</param>
    /// <param name="baseUri">The target base URI to which requests should be proxied.</param>
    public static void UseProxyToSpaDevelopmentServer(
        this ISpaBuilder spaBuilder,
        string baseUri)
    {
        UseProxyToSpaDevelopmentServer(
            spaBuilder,
            new Uri(baseUri));
    }
 
    /// <summary>
    /// Configures the application to forward incoming requests to a local Single Page
    /// Application (SPA) development server. This is only intended to be used during
    /// development. Do not enable this middleware in production applications.
    /// </summary>
    /// <param name="spaBuilder">The <see cref="ISpaBuilder"/>.</param>
    /// <param name="baseUri">The target base URI to which requests should be proxied.</param>
    public static void UseProxyToSpaDevelopmentServer(
        this ISpaBuilder spaBuilder,
        Uri baseUri)
    {
        UseProxyToSpaDevelopmentServer(
            spaBuilder,
            () => Task.FromResult(baseUri));
    }
 
    /// <summary>
    /// Configures the application to forward incoming requests to a local Single Page
    /// Application (SPA) development server. This is only intended to be used during
    /// development. Do not enable this middleware in production applications.
    /// </summary>
    /// <param name="spaBuilder">The <see cref="ISpaBuilder"/>.</param>
    /// <param name="baseUriTaskFactory">A callback that will be invoked on each request to supply a <see cref="Task"/> that resolves with the target base URI to which requests should be proxied.</param>
    public static void UseProxyToSpaDevelopmentServer(
        this ISpaBuilder spaBuilder,
        Func<Task<Uri>> baseUriTaskFactory)
    {
        var applicationBuilder = spaBuilder.ApplicationBuilder;
        var applicationStoppingToken = GetStoppingToken(applicationBuilder);
 
        // Since we might want to proxy WebSockets requests (e.g., by default, AngularCliMiddleware
        // requires it), enable it for the app
        applicationBuilder.UseWebSockets();
 
        // It's important not to time out the requests, as some of them might be to
        // server-sent event endpoints or similar, where it's expected that the response
        // takes an unlimited time and never actually completes
        var neverTimeOutHttpClient =
            SpaProxy.CreateHttpClientForProxy(Timeout.InfiniteTimeSpan);
 
        // Proxy all requests to the SPA development server
        applicationBuilder.Run(async (context) =>
        {
            var didProxyRequest = await SpaProxy.PerformProxyRequest(
                context, neverTimeOutHttpClient, baseUriTaskFactory(), applicationStoppingToken,
                proxy404s: true);
        });
    }
 
    private static CancellationToken GetStoppingToken(IApplicationBuilder appBuilder)
    {
        var applicationLifetime = appBuilder
            .ApplicationServices
            .GetRequiredService<IHostApplicationLifetime>();
        return applicationLifetime.ApplicationStopping;
    }
}