mirror of
https://github.com/bitwarden/server
synced 2026-01-15 15:03:34 +00:00
f144828a87
We want to reduce the amount of business critical test data in the company. One way of doing that is to generate test data on demand prior to client side testing. Clients will request a scene to be set up with a JSON body set of options, specific to a given scene. Successful seed requests will be responded to with a mangleMap which maps magic strings present in the request to the mangled, non-colliding versions inserted into the database. This way, the server is solely responsible for understanding uniqueness requirements in the database. scenes also are able to return custom data, depending on the scene. For example, user creation would benefit from a return value of the userId for further test setup on the client side. Clients will indicate they are running tests by including a unique header, x-play-id which specifies a unique testing context. The server uses this PlayId as the seed for any mangling that occurs. This allows the client to decide it will reuse a given PlayId if the test context builds on top of previously executed tests. When a given context is no longer needed, the API user will delete all test data associated with the PlayId by calling a delete endpoint. --------- Co-authored-by: Matt Gibson <mgibson@bitwarden.com>
41 lines
1.7 KiB
C#
41 lines
1.7 KiB
C#
using System.Diagnostics.CodeAnalysis;
|
|
using System.Text.Json;
|
|
|
|
namespace Bit.SeederApi.IntegrationTest;
|
|
|
|
public static class HttpClientExtensions
|
|
{
|
|
/// <summary>
|
|
/// Sends a POST request with JSON content and attaches the x-play-id header.
|
|
/// </summary>
|
|
/// <typeparam name="TValue">The type of the value to serialize.</typeparam>
|
|
/// <param name="client">The HTTP client.</param>
|
|
/// <param name="requestUri">The URI the request is sent to.</param>
|
|
/// <param name="value">The value to serialize.</param>
|
|
/// <param name="playId">The play ID to attach as x-play-id header.</param>
|
|
/// <param name="options">Options to control the behavior during serialization.</param>
|
|
/// <param name="cancellationToken">A cancellation token that can be used to cancel the operation.</param>
|
|
/// <returns>The task object representing the asynchronous operation.</returns>
|
|
public static Task<HttpResponseMessage> PostAsJsonAsync<TValue>(
|
|
this HttpClient client,
|
|
[StringSyntax(StringSyntaxAttribute.Uri)] string? requestUri,
|
|
TValue value,
|
|
string playId,
|
|
JsonSerializerOptions? options = null,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(client);
|
|
|
|
if (string.IsNullOrWhiteSpace(playId))
|
|
{
|
|
throw new ArgumentException("Play ID cannot be null or whitespace.", nameof(playId));
|
|
}
|
|
|
|
var content = JsonContent.Create(value, mediaType: null, options);
|
|
content.Headers.Remove("x-play-id");
|
|
content.Headers.Add("x-play-id", playId);
|
|
|
|
return client.PostAsync(requestUri, content, cancellationToken);
|
|
}
|
|
}
|