IPSAG.AbTesting 1.0.0-preview34.1

IPSAG.AbTesting library for .NET

Introduction

The A/B Testing Nuget is a .NET-based library designed to facilitate A/B testing experiments in a controlled environment. It should be included together with an npm package to complete the integration, see example in the playground.

• playground | Source code | README
• IPSAG.AbTesting | Source code | README
• @ips-ag/abtesting | Source code | README

Getting Started

Install the package

Install the Azure Storage Blobs client library for .NET with NuGet:

dotnet add package IPSAG.AbTesting

Prerequisites

You need an Azure subscription and a App Configuration to use this package. The App Insight is not mandatory.

To create a new App Configuration, you can use the Azure Portal, or the Azure CLI. Here's an example using the Azure CLI:

az appconfig create --name MyAppConfig --resource-group MyResourceGroup --location westus

Before you can use the IPSAG.AbTesting, ensure you have the following prerequisites installed on your system:

• .NET 8.0 or higher SDK Application: Required to install the Nuget. You can download it from https://dotnet.microsoft.com/download.

With these prerequisites in place, you're ready to start using the A/B Testing libraries to conduct your A/B testing experiments.

How to use

In order to interact with the A/B Testing service, you'll need to configure connection to Azure App Configuration.

// Create Host builder
var builder = WebApplication.CreateBuilder(args);
// Sample connection strings
var (appConfigCs, appInsightsCs) = ("<AppConfigConnectionString>", "<AppInsightsConnectionString>");

// Configure A/B Testing by providing connection to App Configuration & App Insights
// By options
builder.AddAbTesting<TargetingContextService>(options =>
{
    options.AppConfigConnectionString = appConfigCs;
    options.AppInsightsConnectionString = appInsightsCs;
    options.UseDefaultControllers = true; // default value
});
// By options & configuration
builder.AddAbTesting<TargetingContextService>((options, configuration) =>
{
    options.AppConfigConnectionString = configuration.GetConnectionString("AppConfig");
    options.AppInsightsConnectionString = configuration.GetConnectionString("AppInsights");
    options.UseDefaultControllers = true; // default value
});
// OR by parameters
builder.AddAbTesting<TargetingContextService>(appConfigCs!,
                                              appInsightsCs);

// Configure A/B Testing by providing connection to App Configuration only
//By options
builder.AddAbTesting<TargetingContextService>(options =>
{
    options.AppConfigConnectionString = appConfigCs;
    options.UseDefaultControllers = true; // default value
});
// By options & configuration
builder.AddAbTesting<TargetingContextService>((options, configuration) =>
{
    options.AppConfigConnectionString = configuration.GetConnectionString("AppConfig");
    options.UseDefaultControllers = true; // default value
});
// OR by parameters
builder.AddAbTesting<TargetingContextService>(appConfigCs!);

var app = builder.Build();
// If you are using Authorization information to build the TargetingContext,
// please ensure that app.UseAbTesting() was placed after app.UseAuthentication(); & app.UseAuthorization();
app.UseAbTesting();
//

The TargetingContextService is an implementation from the interface IPSAG.AbTesting.Services.ITargetingContextService which is required to use A/B Testing package.

There, you could define your own logic to create the TargetingContext which can reflect to App Configuration

// Example
public class TargetingContextService(IHttpContextAccessor contextAccessor) : ITargetingContextService
{
    public async Task<TargetingContext> GetTargetingContextAsync(CancellationToken ct = default)
    {
        HttpContext httpContext = contextAccessor.HttpContext!;
        var user = httpContext.User;
        if (user.Identity == null || !user.Identity.IsAuthenticated)
        {
            return new()
            {
                UserId = "anonymous",
                Groups = []
            };
        }

        var distributionGroup = user.Claims.SingleOrDefault(c => c.Type == ClaimTypes.GroupSid)?.Value;
        return new()
        {
            UserId = user.Identity.Name,
            Groups = string.IsNullOrEmpty(distributionGroup) ? [] : [distributionGroup]
        };
    }
}

By default, a default AbTestingController would be injected to your application

[Route("api/ab-testing")]
public class AbTestingController(IConfigurationService abTestingConfigService) : BaseApiController
{
    [HttpGet("feature-flags")]
    [ProducesResponseType(typeof(FeatureFlag[]), StatusCodes.Status200OK)]
    public async Task<IActionResult> GetAllAsync(CancellationToken ct = default)
    {
        var featureFlags = await abTestingConfigService.ReadFeatureFlagsAsync(ct).ConfigureAwait(false);
        return featureFlags.Match(Ok, ServerError);
    }
}

Request sample

curl -X 'GET' \
  'http://localhost:5103/api/ab-testing/feature-flags' \
  -H 'accept: application/json'

Response body

[
  {
    "name": "ShopFilter",
    "value": "False",
    "isVariant": true
  },
  {
    "name": "ShopFilterEarlyAccess",
    "value": "False",
    "isVariant": false
  },
  {
    "name": "ShopFilterVersion",
    "value": "0.0.1",
    "isVariant": true
  }
]

But you could also use your own controllers by removing the default controllers and defining your controllers and injecting IConfigurationService

// Remove default controllers
builder.AddAbTesting<TargetingContextService>(options =>
{
    options.AppConfigConnectionString = appConfigCs;
    options.AppInsightsConnectionString = appInsightsCs;
    options.UseDefaultControllers = false; // <-- set to false
});
....
// Create new controller
[Route("api/my-route")]
public class MyController(IConfigurationService abTestingConfigService)
{
    // Implementation
}

Related Packages

• JetBrains.Annotations (>= 2024.2.0)
• Microsoft.Azure.AppConfiguration.AspNetCore (>= 8.0.0-preview.2)
• Microsoft.FeatureManagement.AspNetCore (>= 4.0.0-preview3)
• Microsoft.FeatureManagement.Telemetry.ApplicationInsights (>= 4.0.0-preview3)
• Microsoft.FeatureManagement.Telemetry.ApplicationInsights.AspNetCore (>= 4.0.0-preview3)

License

• The IPSAG.AbTesting NuGet package and its source code under the packages/Nuget directory are distributed under the terms of the MIT License.

Feedback

We value your feedback! If you have any suggestions, bug reports, or feature requests, please open an issue on our GitHub repository.