dapr
/
dotnet-sdk
mirror of https://github.com/dapr/dotnet-sdk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add ability to specify default DaprClient options to AddDapr (#394) 

* Add fix for issue 390

* Move JsonSerializer defaults to DaprClientBuilder ctor

* Update samples to reflect changes

* Update unit-tests to reflect latest changes

* Remove obsolete using statements

* Change internal fields to internal properties

* Change internal fields to internal properties
This commit is contained in:
Edwin van Wijk 2020-09-24 19:36:47 +02:00 committed by GitHub
parent e93357cb9d
commit 55e168fac3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 124 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
samples/AspNetCore/ControllerSample/Readme.md
View File

@ -1,6 +1,6 @@
# ASP.NET Core Controller Sample
This sample shows using Dapr with ASP.NET Core routing. This application is a simple and not-so-secure banking application. The application uses the Dapr state-store for its data storage.
This sample shows using Dapr with ASP.NET Core controllers. This application is a simple and not-so-secure banking application. The application uses the Dapr state-store for its data storage.
It exposes the following endpoints over HTTP:
- GET `/{account}`: Get the balance for the account specified by `id`
@ -13,7 +13,7 @@ The application also registers for pub/sub with the `deposit` and `withdraw` top
To run the sample locally run this comment in this directory:
```sh
dapr run --app-id routing --app-port 5000 dotnet run
dapr run --app-id controller --app-port 5000 dotnet run
```
The application will listen on port 5000 for HTTP.
@ -136,13 +136,19 @@ On Windows:
```C#
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers().AddDapr();
services.AddControllers().AddDapr(builder =>
builder.UseJsonSerializationOptions(
new JsonSerializerOptions()
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
PropertyNameCaseInsensitive = true,
}));
...
}
```
`AddDapr()` registers the Dapr integration with controllers. This also registers the `StateClient` service with the dependency injection container. This service can be used to interact with the Dapr state-store.
`AddDapr()` registers the Dapr integration with controllers. This also registers the `DaprClient` service with the dependency injection container (using the sepcified `DaprClientBuilder` for settings options). This service can be used to interact with the dapr runtime (e.g. invoke services, publish messages, interact with a state-store, ...).
---

8
samples/AspNetCore/ControllerSample/Startup.cs
View File

@ -1,4 +1,4 @@
// ------------------------------------------------------------
// ------------------------------------------------------------
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
// ------------------------------------------------------------
@ -38,12 +38,6 @@ namespace ControllerSample
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers().AddDapr();
services.AddSingleton(new JsonSerializerOptions()
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
PropertyNameCaseInsensitive = true,
});
}
/// <summary>

10
samples/AspNetCore/RoutingSample/Readme.md
View File

@ -134,13 +134,19 @@ On Windows:
```C#
public void ConfigureServices(IServiceCollection services)
{
services.AddDaprClient();
services.AddDaprClient(builder =>
builder.UseJsonSerializationOptions(
new JsonSerializerOptions()
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
PropertyNameCaseInsensitive = true,
}));
...
}
```
`AddDaprClient()` registers the `StateClient` service with the dependency injection container. This service can be used to interact with the Dapr state-store.
`AddDaprClient()` registers the `DaprClient` service with the dependency injection container (using the sepcified `DaprClientBuilder` for settings options). This service can be used to interact with the dapr runtime (e.g. invoke services, publish messages, interact with a state-store, ...).
---

7
src/Dapr.AspNetCore/DaprMvcBuilderExtensions.cs
View File

@ -6,8 +6,10 @@
namespace Microsoft.Extensions.DependencyInjection
{
using System;
using System.Text.Json;
using Dapr;
using Dapr.AspNetCore;
using Dapr.Client;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ApplicationModels;
@ -20,8 +22,9 @@ namespace Microsoft.Extensions.DependencyInjection
/// Adds Dapr integration for MVC to the provided <see cref="IMvcBuilder" />.
/// </summary>
/// <param name="builder">The <see cref="IMvcBuilder" />.</param>
/// <param name="configureClient">The (optional) <see cref="DaprClientBuilder" /> to use for configuring the DaprClient.</param>
/// <returns>The <see cref="IMvcBuilder" /> builder.</returns>
public static IMvcBuilder AddDapr(this IMvcBuilder builder)
public static IMvcBuilder AddDapr(this IMvcBuilder builder, Action<DaprClientBuilder> configureClient = null)
{
if (builder is null)
{
@ -35,7 +38,7 @@ namespace Microsoft.Extensions.DependencyInjection
return builder;
}
builder.Services.AddDaprClient();
builder.Services.AddDaprClient(configureClient);
builder.Services.AddSingleton<DaprMvcMarkerService>();
builder.Services.AddSingleton<IApplicationModelProvider, StateEntryApplicationModelProvider>();

25
src/Dapr.Client/DaprClientBuilder.cs
View File

@ -14,10 +14,19 @@ namespace Dapr.Client
/// </summary>
public sealed class DaprClientBuilder
{
const string defaultDaprGrpcPort = "50001";
string daprEndpoint;
JsonSerializerOptions jsonSerializerOptions;
GrpcChannelOptions gRPCChannelOptions;
private const string defaultDaprGrpcPort = "50001";
private string daprEndpoint;
private JsonSerializerOptions jsonSerializerOptions;
private GrpcChannelOptions gRPCChannelOptions;
// property exposed for testing purposes
internal string DaprEndpoint => this.daprEndpoint;
// property exposed for testing purposes
internal JsonSerializerOptions JsonSerializerOptions => this.jsonSerializerOptions;
// property exposed for testing purposes
internal GrpcChannelOptions GRPCChannelOptions => this.gRPCChannelOptions;
/// <summary>
@ -26,13 +35,17 @@ namespace Dapr.Client
public DaprClientBuilder()
{
var daprGrpcPort = Environment.GetEnvironmentVariable("DAPR_GRPC_PORT") ?? defaultDaprGrpcPort;
this.daprEndpoint = $"http://127.0.0.1:{daprGrpcPort}";
this.daprEndpoint = $"http://127.0.0.1:{daprGrpcPort}";
this.jsonSerializerOptions = new JsonSerializerOptions
{
PropertyNameCaseInsensitive = true
};
}
/// <summary>
/// Overrides the default endpoint used by IDaprClient for conencting to Dapr runtime.
/// </summary>
/// <param name="daprEndpoint">Endpoint to use for making calls to Dapr runtime.
/// <param name="daprEndpoint">Endpoint to use for making calls to Dapr runtime.
/// Default endpoint used is http://127.0.0.1:DAPR_GRPC_PORT.</param>
/// <returns>DaprClientBuilder instance.</returns>
public DaprClientBuilder UseEndpoint(string daprEndpoint)

6
src/Dapr.Client/DaprClientGrpc.cs
View File

@ -26,6 +26,12 @@ namespace Dapr.Client
private readonly Autogenerated.Dapr.DaprClient client;
private readonly JsonSerializerOptions jsonSerializerOptions;
// property exposed for testing purposes
internal Autogenerated.Dapr.DaprClient Client => client;
// property exposed for testing purposes
internal JsonSerializerOptions JsonSerializerOptions => jsonSerializerOptions;
/// <summary>
/// Initializes a new instance of the <see cref="DaprClientGrpc"/> class.
/// </summary>

27
test/Dapr.AspNetCore.Test/DaprClientBuilderTest.cs Normal file
View File

@ -0,0 +1,27 @@
using System.Text.Json;
using Dapr.Client;
using Xunit;
namespace Dapr.AspNetCore.Test
{
public class DaprClientBuilderTest
{
[Fact]
public void DaprClientBuilder_UsesPropertyNameCaseHandlingInsensitiveByDefault()
{
DaprClientBuilder builder = new DaprClientBuilder();
Assert.True(builder.JsonSerializerOptions.PropertyNameCaseInsensitive);
}
[Fact]
public void DaprClientBuilder_UsesPropertyNameCaseHandlingAsSpecified()
{
DaprClientBuilder builder = new DaprClientBuilder();
builder.UseJsonSerializationOptions(new JsonSerializerOptions
{
PropertyNameCaseInsensitive = false
});
Assert.False(builder.JsonSerializerOptions.PropertyNameCaseInsensitive);
}
}
}

48
test/Dapr.AspNetCore.Test/DaprMvcBuilderExtensionsTest.cs Normal file
View File

@ -0,0 +1,48 @@
using System;
using System.Text.Json;
using Dapr.Client;
using Microsoft.Extensions.DependencyInjection;
using Xunit;
namespace Dapr.AspNetCore.Test
{
public class DaprMvcBuilderExtensionsTest
{
[Fact]
public void AddDapr_UsesSpecifiedDaprClientBuilderConfig()
{
var services = new ServiceCollection();
var clientBuilder = new Action<DaprClientBuilder>(
builder => builder.UseJsonSerializationOptions(
new JsonSerializerOptions()
{
PropertyNameCaseInsensitive = false
}
)
);
services.AddControllers().AddDapr(clientBuilder);
var serviceProvider = services.BuildServiceProvider();
DaprClientGrpc daprClient = serviceProvider.GetService<DaprClient>() as DaprClientGrpc;
Assert.False(daprClient.JsonSerializerOptions.PropertyNameCaseInsensitive);
}
[Fact]
public void AddDapr_UsesDefaultDaprClientBuilderConfig()
{
var services = new ServiceCollection();
services.AddControllers().AddDapr();
var serviceProvider = services.BuildServiceProvider();
DaprClientGrpc daprClient = serviceProvider.GetService<DaprClient>() as DaprClientGrpc;
Assert.True(daprClient.JsonSerializerOptions.PropertyNameCaseInsensitive);
}
}
}