Add HTTP retry logic and cancellation support for OpenAI services

.vscode/tasks.json

@@ -74,10 +74,10 @@
  "detail": "Runs tasks to validate changes before checking in.",
  "group": "test",
  "dependsOn": [
+ "R# cleanup",
  "Build - Semantic-Kernel",
  "Test - Semantic-Kernel",
- "Run - Kernel-Demo",
- "R# cleanup"
+ "Run - Kernel-Demo"
  ],
  "dependsOrder": "sequence"
  },
@@ -103,7 +103,7 @@
  "label": "Test - Semantic-Kernel",
  "command": "dotnet",
  "type": "process",
- "args": ["test", "SemanticKernel.Test.csproj"],
+ "args": ["test", "SemanticKernel.UnitTests.csproj"],
  "problemMatcher": "$msCompile",
  "group": "test",
  "presentation": {
@@ -112,7 +112,7 @@
  "group": "PR-Validate"
  },
  "options": {
- "cwd": "${workspaceFolder}/dotnet/src/SemanticKernel.Test/"
+ "cwd": "${workspaceFolder}/dotnet/src/SemanticKernel.UnitTests/"
  }
  },
  {
@@ -123,7 +123,7 @@
  "test",
  "--collect",
  "XPlat Code Coverage;Format=lcov",
- "SemanticKernel.Test.csproj"
+ "SemanticKernel.UnitTests.csproj"
  ],
  "problemMatcher": "$msCompile",
  "group": "test",
@@ -132,7 +132,7 @@
  "panel": "shared"
  },
  "options": {
- "cwd": "${workspaceFolder}/dotnet/src/SemanticKernel.Test/"
+ "cwd": "${workspaceFolder}/dotnet/src/SemanticKernel.UnitTests/"
  }
  },
  {

dotnet/src/SemanticKernel.IntegrationTests/AI/OpenAICompletionTests.cs

@@ -9,6 +9,7 @@
 using Microsoft.SemanticKernel;
 using Microsoft.SemanticKernel.KernelExtensions;
 using Microsoft.SemanticKernel.Orchestration;
+using Microsoft.SemanticKernel.Reliability;
 using SemanticKernel.IntegrationTests.TestSettings;
 using Xunit;
 using Xunit.Abstractions;
@@ -91,6 +92,34 @@ public async Task AzureOpenAITestAsync(string prompt, string expectedAnswerConta
  Assert.Contains(expectedAnswerContains, actual.Result, StringComparison.InvariantCultureIgnoreCase);
  }
 
+ [Theory]
+ [InlineData("Where is the most famous fish market in Seattle, Washington, USA?",
+ "Error executing action [attempt 1 of 1]. Reason: Unauthorized. Will retry after 2000ms")]
+ public async Task OpenAIHttpRetryPolicyTestAsync(string prompt, string expectedOutput)
+ {
+ // Arrange
+ var retryConfig = new HttpRetryConfig();
+ retryConfig.RetryableStatusCodes.Add(System.Net.HttpStatusCode.Unauthorized);
+ IKernel target = Kernel.Builder.WithLogger(this._testOutputHelper).Configure(c => c.SetDefaultHttpRetryConfig(retryConfig)).Build();
+
+ OpenAIConfiguration? openAIConfiguration = this._configuration.GetSection("OpenAI").Get<OpenAIConfiguration>();
+ Assert.NotNull(openAIConfiguration);
+
+ // Use an invalid API key to force a 401 Unauthorized response
+ target.Config.AddOpenAICompletionBackend(
+ label: openAIConfiguration.Label,
+ modelId: openAIConfiguration.ModelId,
+ apiKey: "INVALID_KEY");
+
+ IDictionary<string, ISKFunction> skill = GetSkill("SummarizeSkill", target);
+
+ // Act
+ await target.RunAsync(prompt, skill["Summarize"]);
+
+ // Assert
+ Assert.Contains(expectedOutput, this._testOutputHelper.GetLogs(), StringComparison.InvariantCultureIgnoreCase);
+ }
+
  private static IDictionary<string, ISKFunction> GetSkill(string skillName, IKernel target)
  {
  string? currentAssemblyDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);

dotnet/src/SemanticKernel.IntegrationTests/RedirectOutput.cs

@@ -1,24 +1,51 @@
 // Copyright (c) Microsoft. All rights reserved.
 
+using System;
 using System.IO;
 using System.Text;
+using Microsoft.Extensions.Logging;
 using Xunit.Abstractions;
 
 namespace SemanticKernel.IntegrationTests;
 
-public class RedirectOutput : TextWriter
+public class RedirectOutput : TextWriter, ILogger
 {
  private readonly ITestOutputHelper _output;
+ private readonly StringBuilder _logs;
 
  public RedirectOutput(ITestOutputHelper output)
  {
  this._output = output;
+ this._logs = new StringBuilder();
  }
 
  public override Encoding Encoding { get; } = Encoding.UTF8;
 
  public override void WriteLine(string? value)
  {
  this._output.WriteLine(value);
+ this._logs.AppendLine(value);
+ }
+
+ public IDisposable? BeginScope<TState>(TState state) where TState : notnull
+ {
+ return null;
+ }
+
+ public bool IsEnabled(LogLevel logLevel)
+ {
+ return true;
+ }
+
+ public string GetLogs()
+ {
+ return this._logs.ToString();
+ }
+
+ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
+ {
+ var message = formatter(state, exception);
+ this._output?.WriteLine(message);
+ this._logs.AppendLine(message);
  }
 }

dotnet/src/SemanticKernel.UnitTests/Configuration/KernelConfigTests.cs

@@ -16,55 +16,55 @@ namespace SemanticKernel.UnitTests.Configuration;
 public class KernelConfigTests
 {
  [Fact]
- public void RetryMechanismIsSet()
+ public void HttpRetryHandlerFactoryIsSet()
  {
  // Arrange
- var retry = new PassThroughWithoutRetry();
+ var retry = new NullHttpRetryHandlerFactory();
  var config = new KernelConfig();
 
  // Act
- config.SetRetryMechanism(retry);
+ config.SetHttpRetryHandlerFactory(retry);
 
  // Assert
- Assert.Equal(retry, config.RetryMechanism);
+ Assert.Equal(retry, config.HttpHandlerFactory);
  }
 
  [Fact]
- public void RetryMechanismIsSetWithCustomImplementation()
+ public void HttpRetryHandlerFactoryIsSetWithCustomImplementation()
  {
  // Arrange
- var retry = new Mock<IRetryMechanism>();
+ var retry = new Mock<IDelegatingHandlerFactory>();
  var config = new KernelConfig();
 
  // Act
- config.SetRetryMechanism(retry.Object);
+ config.SetHttpRetryHandlerFactory(retry.Object);
 
  // Assert
- Assert.Equal(retry.Object, config.RetryMechanism);
+ Assert.Equal(retry.Object, config.HttpHandlerFactory);
  }
 
  [Fact]
- public void RetryMechanismIsSetToPassThroughWithoutRetryIfNull()
+ public void HttpRetryHandlerFactoryIsSetToDefaultHttpRetryHandlerFactoryIfNull()
  {
  // Arrange
  var config = new KernelConfig();
 
  // Act
- config.SetRetryMechanism(null);
+ config.SetHttpRetryHandlerFactory(null);
 
  // Assert
- Assert.IsType<PassThroughWithoutRetry>(config.RetryMechanism);
+ Assert.IsType<DefaultHttpRetryHandlerFactory>(config.HttpHandlerFactory);
  }
 
  [Fact]
- public void RetryMechanismIsSetToPassThroughWithoutRetryIfNotSet()
+ public void HttpRetryHandlerFactoryIsSetToDefaultHttpRetryHandlerFactoryIfNotSet()
  {
  // Arrange
  var config = new KernelConfig();
 
  // Act
  // Assert
- Assert.IsType<PassThroughWithoutRetry>(config.RetryMechanism);
+ Assert.IsType<DefaultHttpRetryHandlerFactory>(config.HttpHandlerFactory);
  }
 
  [Fact]