Fhi.HelseId.Blazor
1.0.0-beta.1
See the version list below for details.
dotnet add package Fhi.HelseId.Blazor --version 1.0.0-beta.1
NuGet\Install-Package Fhi.HelseId.Blazor -Version 1.0.0-beta.1
<PackageReference Include="Fhi.HelseId.Blazor" Version="1.0.0-beta.1" />
paket add Fhi.HelseId.Blazor --version 1.0.0-beta.1
#r "nuget: Fhi.HelseId.Blazor, 1.0.0-beta.1"
// Install Fhi.HelseId.Blazor as a Cake Addin #addin nuget:?package=Fhi.HelseId.Blazor&version=1.0.0-beta.1&prerelease // Install Fhi.HelseId.Blazor as a Cake Tool #tool nuget:?package=Fhi.HelseId.Blazor&version=1.0.0-beta.1&prerelease
Fhi.HelseId.Refit
This package contains code to simplify working with Blazor, Refit and HelseId.
Blazor does not currently let you interact with the HttpContext that is needed for normal HelseId funtionallity in a WebApi.
Some of the problems this code solves are
- HttpContext is not availible during most of the Blazor SPA lifetime
- The HelseId tokens are stored in the HttpContext which are not normally availible from most of the rendering tree in the Blazor code.
- The HelseId tokens are stored in the HttpContext which are not normally availible from a normal scoped or transient service when resolved with the ServiceProvider (DI).
- Refit uses HttpClientFactory, which creates transient DelegationHandlers, but they come from a singleton scope! This leads to us being unable to get the HelseId access token by the consumer of a Refit interface.
- We need to update cookies with new token data when refreshing HelseId token
This default setup will add a token handler to your Refit Interface in addition to letting you add multiple delegates if needed (f.ex. logging).
Usage
Include thhis code in your WebApi startup builder (remember to also call "builder.AddHelseIdWebAuthentication()"):
builder.AddHelseIdForBlazor()
.AddRefitClient<IMyRefitClient>()
...
app.UseHelseIdForBlazor();
app.UseHelseIdForBlazorLogout();
You will also need to wrap your hole App.razor code with a CascadingStates-tag:
<CascadingStates>
... all your App.razor HTML ...
</CascadingStates>
If you want to add additional loggers add them before "AddRefitClient":
builder.AddHelseIdForBlazor()
.AddHandler<MyLoggingDelegationHandler>()
.AddRefitClient<IMyRefitClient>()
The code loads your configuration from IConfiguration using the section "HelseIdWebKonfigurasjon". If you want to override which section to use you can pass the correct section to AddHelseIdForBlazor:
builder.AddHelseIdForBlazor("HelseIdWebKonfigurasjon")
.AddRefitClient<IMyRefitClient>()
The default RefitSettings we are using use SystemTextJsonContentSerializer, is case insensitive and use camelCasing. If you want to override the default RefitSettings to use you can pass the settings to AddHelseIdForBlazor:
builder.AddHelseIdForBlazor(new RefitSettings())
.AddRefitClient<IMyRefitClient>();
Adding Correlation Id to all requests
Use "AddCorrelationId()" to add header propagation of the default FHI correlation id header.
builder.AddHelseIdForBlazor()
.AddCorrelationId()
.AddRefitClient<IMyRefitClient>();
A new correlation ID will be given to each request and response that does not contain the header when invoked. Remember to add usage of header propagation to your app startup code:
app.UseHeaderPropagation();
More usage
If you would like to reuse some of the code to access the HttpContext for dependency injection you can hook into the code with custom implementations of a IScopedState:
builder.AddStateHandlers().AddScopedState<UserState>();
An example of a implementation of UserState could be something like this.
public class UserState : IScopedState
{
public string CorrelationId { get; set; }
public UserState() // you can even use the constructor for normal dependency injection here!
{
}
public async Task Populate(HttpContext httpContext)
{
var headerValue = string.Empty;
if (httpContext.Request.Headers.TryGetValue("X-Correlation-ID", out var values))
{
headerValue = values.FirstOrDefault();
}
else if (httpContext.Response.Headers.TryGetValue("X-Correlation-ID", out values))
{
headerValue = values.FirstOrDefault();
}
CorrelationId = string.IsNullOrEmpty(headerValue) ? Guid.NewGuid().ToString() : headerValue;
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Fhi.HelseId (>= 5.2.0)
- Microsoft.AspNetCore.Components (>= 6.0.0)
- Microsoft.AspNetCore.HeaderPropagation (>= 6.0.24)
- Refit (>= 6.3.2)
- Refit.HttpClientFactory (>= 6.3.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.0.1 | 112 | 11/29/2024 |
8.0.0 | 88 | 11/19/2024 |
7.1.2 | 94 | 11/6/2024 |
7.1.1 | 82 | 11/1/2024 |
7.1.0 | 79 | 10/31/2024 |
7.0.1 | 94 | 10/23/2024 |
6.3.0 | 98 | 10/11/2024 |
6.2.1 | 109 | 10/7/2024 |
6.2.0 | 99 | 9/27/2024 |
6.2.0-beta.2 | 51 | 9/24/2024 |
6.2.0-beta.1 | 68 | 9/17/2024 |
6.1.0 | 114 | 9/10/2024 |
6.0.0 | 92 | 8/7/2024 |
1.1.3-alpha.1 | 59 | 5/6/2024 |
1.1.2 | 297 | 5/3/2024 |
1.1.1 | 97 | 5/2/2024 |
1.1.0 | 97 | 5/2/2024 |
1.0.1 | 128 | 4/18/2024 |
1.0.0-beta.2 | 130 | 1/7/2024 |
1.0.0-beta.1 | 79 | 1/4/2024 |
1.0.0-alpha.3 | 335 | 2/13/2024 |
1.0.0-alpha.2 | 88 | 2/2/2024 |
1.0.0-alpha.1 | 94 | 1/12/2024 |