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

[TestProxy] Add auto-shutdown to the proxy #9540

Merged
merged 3 commits into from
Dec 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ public static RootCommand GenerateCommandLineOptions(Func<DefaultOptions, Task>
getDefaultValue: () => false);
universalOption.AddAlias("-u");

var autoShutdownOption = new Option<int>(
name: "--shutdownInSeconds",
scbedd marked this conversation as resolved.
Show resolved Hide resolved
description: "Integer argument; When provided, the proxy will auto-shutdown after not being contacted over any HTTP route for this number of seconds.",
getDefaultValue: () => -1);

var breakGlassOption = new Option<bool>(
name: "--break-glass",
description: "Flag; Ignore secret push protection results when pushing.",
Expand Down Expand Up @@ -88,10 +93,11 @@ public static RootCommand GenerateCommandLineOptions(Func<DefaultOptions, Task>
startCommand.AddOption(insecureOption);
startCommand.AddOption(dumpOption);
startCommand.AddOption(universalOption);
startCommand.AddOption(autoShutdownOption);
startCommand.AddArgument(collectedArgs);

startCommand.SetHandler(async (startOpts) => await callback(startOpts),
new StartOptionsBinder(storageLocationOption, storagePluginOption, insecureOption, dumpOption, universalOption, collectedArgs)
new StartOptionsBinder(storageLocationOption, storagePluginOption, insecureOption, dumpOption, universalOption, autoShutdownOption, collectedArgs)
);
root.Add(startCommand);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ public class StartOptions : DefaultOptions
public bool Dump { get; set; }
public bool UniversalOutput { get; set; }

public int AutoShutdownTime { get; set; }

// On the command line, use -- and everything after that becomes arguments to Host.CreateDefaultBuilder
// For example Test-Proxy start -i -d -- --urls https://localhost:8002 would set AdditionaArgs to a list containing
// --urls and https://localhost:8002 as individual entries. This is converted to a string[] before being
Expand All @@ -23,15 +25,17 @@ public class StartOptionsBinder : BinderBase<StartOptions>
private readonly Option<bool> _insecureOption;
private readonly Option<bool> _dumpOption;
private readonly Option<bool> _univeralOutputOption;
private readonly Option<int> _autoShutdownTime;
private readonly Argument<string[]> _additionalArgs;

public StartOptionsBinder(Option<string> storageLocationOption, Option<string> storagePluginOption, Option<bool> insecureOption, Option<bool> dumpOption, Option<bool> universalOutput, Argument<string[]> additionalArgs)
public StartOptionsBinder(Option<string> storageLocationOption, Option<string> storagePluginOption, Option<bool> insecureOption, Option<bool> dumpOption, Option<bool> universalOutput, Option<int> autoShutdownTime, Argument<string[]> additionalArgs)
{
_storageLocationOption = storageLocationOption;
_storagePluginOption = storagePluginOption;
_insecureOption = insecureOption;
_dumpOption = dumpOption;
_univeralOutputOption = universalOutput;
_autoShutdownTime = autoShutdownTime;
_additionalArgs = additionalArgs;
}

Expand All @@ -43,6 +47,7 @@ protected override StartOptions GetBoundValue(BindingContext bindingContext) =>
Insecure = bindingContext.ParseResult.GetValueForOption(_insecureOption),
Dump = bindingContext.ParseResult.GetValueForOption(_dumpOption),
UniversalOutput = bindingContext.ParseResult.GetValueForOption(_univeralOutputOption),
AutoShutdownTime = bindingContext.ParseResult.GetValueForOption(_autoShutdownTime),
AdditionalArgs = bindingContext.ParseResult.GetValueForArgument(_additionalArgs)
};
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
namespace Azure.Sdk.Tools.TestProxy.Common.AutoShutdown
{
public class ShutdownConfiguration
{
public bool EnableAutoShutdown { get; set; } = false;
public int TimeoutInSeconds { get; set; } = 300;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
using System.Threading.Tasks;
using System.Threading;
using System;

namespace Azure.Sdk.Tools.TestProxy.Common.AutoShutdown
{
public class ShutdownTimer
{
private readonly ShutdownConfiguration _shutdownConfig;
private CancellationTokenSource _cts;
private Task _shutdownTask;

public ShutdownTimer(ShutdownConfiguration shutdownConfiguration)
{
_shutdownConfig = shutdownConfiguration;
}

public void ResetTimer()
{
_cts?.Cancel();
_cts = new CancellationTokenSource();

_shutdownTask = Task.Run(async () =>
{
try
{
await Task.Delay(_shutdownConfig.TimeoutInSeconds * 1000, _cts.Token);

if (_shutdownConfig.EnableAutoShutdown)
{
System.Console.WriteLine("Server idle timeout reached. Shutting down...");
Environment.Exit(0);
}
}
catch (TaskCanceledException)
{
// Timer was reset or canceled
}
});
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;

namespace Azure.Sdk.Tools.TestProxy.Common.AutoShutdown
{
public class ShutdownTimerMiddleware
{
private readonly RequestDelegate _next;
private readonly ShutdownTimer _shutdownTimer;
private readonly ShutdownConfiguration _shutdownConfig;

public ShutdownTimerMiddleware(RequestDelegate next, ShutdownTimer shutdownTimer, ShutdownConfiguration shutdownConfig)
{
_next = next;
_shutdownTimer = shutdownTimer;
_shutdownConfig = shutdownConfig;
}

public async Task InvokeAsync(HttpContext context)
{
if (_shutdownConfig.EnableAutoShutdown)
{
_shutdownTimer.ResetTimer();
}
await _next(context);
}
}
}
16 changes: 15 additions & 1 deletion tools/test-proxy/Azure.Sdk.Tools.TestProxy/Startup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
using System.Text.Json;
using Microsoft.Extensions.Logging.Console;
using Microsoft.Extensions.Options;
using Azure.Sdk.Tools.TestProxy.Common.AutoShutdown;

namespace Azure.Sdk.Tools.TestProxy
{
Expand Down Expand Up @@ -125,6 +126,7 @@ private static async Task<int> Run(object commandObj)
StorageLocation = defaultOpts.StorageLocation,
StoragePlugin = defaultOpts.StoragePlugin,
Insecure = false,
AutoShutdownTime = -1,
Dump = false
});
break;
Expand All @@ -147,7 +149,7 @@ private static void StartServer(StartOptions startOptions)
newLine: true, statusThreadCts.Token);

var host = Host.CreateDefaultBuilder((startOptions.AdditionalArgs??new string[] { }).ToArray());

host.ConfigureWebHostDefaults(
builder =>
builder.UseStartup<Startup>()
Expand Down Expand Up @@ -180,6 +182,15 @@ private static void StartServer(StartOptions startOptions)

var app = host.Build();

var shutdownService = app.Services.GetRequiredService<ShutdownConfiguration>();
if (startOptions.AutoShutdownTime > -1)
{
shutdownService.EnableAutoShutdown = true;
shutdownService.TimeoutInSeconds = startOptions.AutoShutdownTime;
// start the first iteration of the shutdown timer
app.Services.GetRequiredService<ShutdownTimer>().ResetTimer();
}

if (startOptions.Dump)
{
var config = app.Services?.GetService<IConfiguration>();
Expand Down Expand Up @@ -227,6 +238,8 @@ public void ConfigureServices(IServiceCollection services)
);

services.AddSingleton<RecordingHandler>(singletonRecordingHandler);
services.AddSingleton<ShutdownConfiguration>();
services.AddSingleton<ShutdownTimer>();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory)
Expand All @@ -237,6 +250,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerF
}
app.UseCors("DefaultPolicy");
app.UseMiddleware<HttpExceptionMiddleware>();
app.UseMiddleware<ShutdownTimerMiddleware>();

DebugLogger.ConfigureLogger(loggerFactory);

Expand Down
Loading