Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[test-proxy] Only remove session once body has been written #8709

Merged
merged 10 commits into from
Jul 30, 2024
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
Expand Down Expand Up @@ -84,7 +84,7 @@ public void Record(RecordEntry entry)

public RecordEntry Lookup(RecordEntry requestEntry, RecordMatcher matcher, IEnumerable<RecordedTestSanitizer> sanitizers, bool remove = true)
{
foreach(RecordedTestSanitizer sanitizer in sanitizers)
foreach (RecordedTestSanitizer sanitizer in sanitizers)
{
sanitizer.Sanitize(requestEntry);
}
Expand All @@ -103,6 +103,14 @@ public RecordEntry Lookup(RecordEntry requestEntry, RecordMatcher matcher, IEnum
}
}

public void Remove(RecordEntry entry)
{
lock (Entries)
scbedd marked this conversation as resolved.
Show resolved Hide resolved
{
Entries.Remove(entry);
}
}

public void Sanitize(RecordedTestSanitizer sanitizer)
{
lock (Entries)
Expand Down
47 changes: 29 additions & 18 deletions tools/test-proxy/Azure.Sdk.Tools.TestProxy/RecordingHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -457,16 +457,19 @@ public async Task HandlePlaybackRequest(string recordingId, HttpRequest incoming

var sanitizers = SanitizerRegistry.GetSanitizers(session);

// we don't need to re-sanitize with recording-applicable sanitizers every time. just the very first one
lock (session)
if (!session.IsSanitized)
scbedd marked this conversation as resolved.
Show resolved Hide resolved
{
if (!session.IsSanitized)
// we don't need to re-sanitize with recording-applicable sanitizers every time. just the very first one
lock (session)
{
session.IsSanitized = true;

foreach (RecordedTestSanitizer sanitizer in sanitizers)
if (!session.IsSanitized)
{
session.Session.Sanitize(sanitizer);
foreach (RecordedTestSanitizer sanitizer in sanitizers)
{
session.Session.Sanitize(sanitizer);
}

session.IsSanitized = true;
}
}
}
Expand All @@ -475,23 +478,14 @@ public async Task HandlePlaybackRequest(string recordingId, HttpRequest incoming

var entry = (await CreateEntryAsync(incomingRequest).ConfigureAwait(false)).Item1;

// If request contains "x-recording-remove: false", then request is not removed from session after playback.
// Used by perf tests to play back the same request multiple times.
var remove = true;
if (incomingRequest.Headers.TryGetValue("x-recording-remove", out var removeHeader))
{
remove = bool.Parse(removeHeader);
}

var match = session.Session.Lookup(entry, session.CustomMatcher ?? Matcher, sanitizers, remove);
// Session may be removed later, but only after response has been fully written
var match = session.Session.Lookup(entry, session.CustomMatcher ?? Matcher, sanitizers, remove: false);

foreach (ResponseTransform transform in Transforms.Concat(session.AdditionalTransforms))
{
transform.Transform(incomingRequest, match);
}

Interlocked.Increment(ref Startup.RequestsPlayedBack);

outgoingResponse.StatusCode = match.StatusCode;

foreach (var header in match.Response.Headers)
Expand All @@ -512,6 +506,23 @@ public async Task HandlePlaybackRequest(string recordingId, HttpRequest incoming

await WriteBodyBytes(bodyData, session.PlaybackResponseTime, outgoingResponse);
}

Interlocked.Increment(ref Startup.RequestsPlayedBack);

// Only remove session once body has been written, to minimize probability client retries but test-proxy has already removed the session
var remove = true;

// If request contains "x-recording-remove: false", then request is not removed from session after playback.
// Used by perf tests to play back the same request multiple times.
if (incomingRequest.Headers.TryGetValue("x-recording-remove", out var removeHeader))
{
remove = bool.Parse(removeHeader);
}

if (remove)
{
session.Session.Remove(match);
}
}

public byte[][] GetBatches(byte[] bodyData, int batchCount)
Expand Down