Merge pull request #1172 from iceljc/master

iceljc · web-flow · commit 6581b2ecbc8c · 2025-09-23T17:21:37.000-05:00
fix chat stream and websocket close
diff --git a/src/Infrastructure/BotSharp.Abstraction/MLTasks/Utilities/LlmUtility.cs b/src/Infrastructure/BotSharp.Abstraction/MLTasks/Utilities/LlmUtility.cs
@@ -0,0 +1,14 @@
+namespace BotSharp.Abstraction.MLTasks.Utilities;
+
+public static class LlmUtility
+{
+    public static string? VerifyModelParameter(string? curVal, string? defaultVal, IEnumerable<string>? options = null)
+    {
+        if (options.IsNullOrEmpty())
+        {
+            return curVal.IfNullOrEmptyAs(defaultVal);
+        }
+
+        return options.Contains(curVal) ? curVal : defaultVal;
+    }
+}
diff --git a/src/Infrastructure/BotSharp.Core/Session/BotSharpRealtimeSession.cs b/src/Infrastructure/BotSharp.Core/Session/BotSharpRealtimeSession.cs
@@ -74,7 +74,7 @@ public async Task DisconnectAsync()
             return;
         }
 
-        await _websocket.CloseAsync(WebSocketCloseStatus.Empty, null, CancellationToken.None);
+        await _websocket.CloseAsync(WebSocketCloseStatus.NormalClosure, $"Normal Closure from {nameof(BotSharpRealtimeSession)}-{_sessionOptions?.Provider}", CancellationToken.None);
     }
 
     public void Dispose()
diff --git a/src/Infrastructure/BotSharp.Core/Session/LlmRealtimeSession.cs b/src/Infrastructure/BotSharp.Core/Session/LlmRealtimeSession.cs
@@ -111,7 +111,7 @@ public async Task DisconnectAsync()
 
         if (_webSocket.State == WebSocketState.Open)
         {
-            await _webSocket.CloseAsync(WebSocketCloseStatus.Empty, null, CancellationToken.None);
+            await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, $"Normal Closure from {nameof(LlmRealtimeSession)}-{_sessionOptions?.Provider}", CancellationToken.None);
         }
     }
 
diff --git a/src/Plugins/BotSharp.Plugin.ChatHub/ChatStreamMiddleware.cs b/src/Plugins/BotSharp.Plugin.ChatHub/ChatStreamMiddleware.cs
@@ -10,7 +10,6 @@ public class ChatStreamMiddleware
 {
     private readonly RequestDelegate _next;
     private readonly ILogger<ChatStreamMiddleware> _logger;
-    private BotSharpRealtimeSession _session;
 
     public ChatStreamMiddleware(
         RequestDelegate next,
@@ -40,7 +39,6 @@ public async Task Invoke(HttpContext httpContext)
                 }
                 catch (Exception ex)
                 {
-                    _session?.Dispose();
                     _logger.LogError(ex, $"Error when connecting Chat stream. ({ex.Message})");
                 }
                 return;
@@ -52,8 +50,7 @@ public async Task Invoke(HttpContext httpContext)
 
     private async Task HandleWebSocket(IServiceProvider services, string agentId, string conversationId, WebSocket webSocket)
     {
-        _session?.Dispose();
-        _session = new BotSharpRealtimeSession(services, webSocket, new ChatSessionOptions
+        using var session = new BotSharpRealtimeSession(services, webSocket, new ChatSessionOptions
         {
             Provider = "BotSharp Chat Stream",
             BufferSize = 1024 * 32,
@@ -72,7 +69,7 @@ private async Task HandleWebSocket(IServiceProvider services, string agentId, st
         convService.SetConversationId(conversationId, []);
         await convService.GetConversationRecordOrCreateNew(agentId);
 
-        await foreach (ChatSessionUpdate update in _session.ReceiveUpdatesAsync(CancellationToken.None))
+        await foreach (ChatSessionUpdate update in session.ReceiveUpdatesAsync(CancellationToken.None))
         {
             var receivedText = update?.RawResponse;
             if (string.IsNullOrEmpty(receivedText))
@@ -87,7 +84,7 @@ private async Task HandleWebSocket(IServiceProvider services, string agentId, st
                 _logger.LogCritical($"Start chat stream connection for conversation ({conversationId})");
 #endif
                 var request = InitRequest(data, conversationId);
-                await ConnectToModel(hub, webSocket, request?.States);
+                await ConnectToModel(hub, session, request?.States);
             }
             else if (eventType == "media")
             {
@@ -107,17 +104,16 @@ private async Task HandleWebSocket(IServiceProvider services, string agentId, st
         }
 
         convService.SaveStates();
-        await _session.DisconnectAsync();
-        _session.Dispose();
+        await session.DisconnectAsync();
     }
 
-    private async Task ConnectToModel(IRealtimeHub hub, WebSocket webSocket, List<MessageState>? states = null)
+    private async Task ConnectToModel(IRealtimeHub hub, BotSharpRealtimeSession session, List<MessageState>? states = null)
     {
         await hub.ConnectToModel(responseToUser: async data =>
         {
-            if (_session != null)
+            if (session != null)
             {
-                await _session.SendEventAsync(data);
+                await session.SendEventAsync(data);
             }
         }, initStates: states);
     }
diff --git a/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Audio/AudioTranscriptionProvider.cs b/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Audio/AudioTranscriptionProvider.cs
@@ -47,8 +47,8 @@ private AudioTranscriptionOptions PrepareTranscriptionOptions(string? text)
             temperature = $"{settings.Temperature}";
         }
         
-        responseFormat = settings?.ResponseFormat != null ? VerifyTranscriptionParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
-        granularity = settings?.Granularity != null ? VerifyTranscriptionParameter(granularity, settings.Granularity.Default, settings.Granularity.Options) : null;
+        responseFormat = settings?.ResponseFormat != null ? LlmUtility.VerifyModelParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
+        granularity = settings?.Granularity != null ? LlmUtility.VerifyModelParameter(granularity, settings.Granularity.Default, settings.Granularity.Options) : null;
 
         var options = new AudioTranscriptionOptions
         {
@@ -131,14 +131,4 @@ private AudioTimestampGranularities GetGranularity(string input)
 
         return temperature;
     }
-
-    private string? VerifyTranscriptionParameter(string? curVal, string? defaultVal, IEnumerable<string>? options = null)
-    {
-        if (options.IsNullOrEmpty())
-        {
-            return curVal.IfNullOrEmptyAs(defaultVal);
-        }
-
-        return options.Contains(curVal) ? curVal : defaultVal;
-    }
 }
diff --git a/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.Edit.cs b/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.Edit.cs
@@ -61,9 +61,9 @@ public async Task<RoleDialogModel> GetImageEdits(Agent agent, RoleDialogModel me
 
         var settings = settingsService.GetSetting(Provider, _model)?.Image?.Edit;
 
-        size = settings?.Size != null ? VerifyImageParameter(size, settings.Size.Default, settings.Size.Options) : null;
-        responseFormat = settings?.ResponseFormat != null ? VerifyImageParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
-        background = settings?.Background != null ? VerifyImageParameter(background, settings.Background.Default, settings.Background.Options) : null;
+        size = settings?.Size != null ? LlmUtility.VerifyModelParameter(size, settings.Size.Default, settings.Size.Options) : null;
+        responseFormat = settings?.ResponseFormat != null ? LlmUtility.VerifyModelParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
+        background = settings?.Background != null ? LlmUtility.VerifyModelParameter(background, settings.Background.Default, settings.Background.Options) : null;
 
         var options = new ImageEditOptions();
         if (!string.IsNullOrEmpty(size))
diff --git a/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.Generation.cs b/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.Generation.cs
@@ -42,11 +42,11 @@ public async Task<RoleDialogModel> GetImageGeneration(Agent agent, RoleDialogMod
 
         var settings = settingsService.GetSetting(Provider, _model)?.Image?.Generation;
 
-        size = settings?.Size != null ? VerifyImageParameter(size, settings.Size.Default, settings.Size.Options) : null;
-        quality = settings?.Quality != null ? VerifyImageParameter(quality, settings.Quality.Default, settings.Quality.Options) : null;
-        style = settings?.Style != null ? VerifyImageParameter(style, settings.Style.Default, settings.Style.Options) : null;
-        responseFormat = settings?.ResponseFormat != null ? VerifyImageParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
-        background = settings?.Background != null ? VerifyImageParameter(background, settings.Background.Default, settings.Background.Options) : null;
+        size = settings?.Size != null ? LlmUtility.VerifyModelParameter(size, settings.Size.Default, settings.Size.Options) : null;
+        quality = settings?.Quality != null ? LlmUtility.VerifyModelParameter(quality, settings.Quality.Default, settings.Quality.Options) : null;
+        style = settings?.Style != null ? LlmUtility.VerifyModelParameter(style, settings.Style.Default, settings.Style.Options) : null;
+        responseFormat = settings?.ResponseFormat != null ? LlmUtility.VerifyModelParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
+        background = settings?.Background != null ? LlmUtility.VerifyModelParameter(background, settings.Background.Default, settings.Background.Options) : null;
 
         var options = new ImageGenerationOptions();
         if (!string.IsNullOrEmpty(size))
diff --git a/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.Variation.cs b/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.Variation.cs
@@ -35,8 +35,8 @@ public async Task<RoleDialogModel> GetImageVariation(Agent agent, RoleDialogMode
 
         var settings = settingsService.GetSetting(Provider, _model)?.Image?.Variation;
 
-        size = settings?.Size != null ? VerifyImageParameter(size, settings.Size.Default, settings.Size.Options) : null;
-        responseFormat = settings?.ResponseFormat != null ? VerifyImageParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
+        size = settings?.Size != null ? LlmUtility.VerifyModelParameter(size, settings.Size.Default, settings.Size.Options) : null;
+        responseFormat = settings?.ResponseFormat != null ? LlmUtility.VerifyModelParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;
 
         var options = new ImageVariationOptions();
         if (!string.IsNullOrEmpty(size))
diff --git a/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.cs b/src/Plugins/BotSharp.Plugin.OpenAI/Providers/Image/ImageCompletionProvider.cs
@@ -201,15 +201,5 @@ private int GetImageCount(string count)
         }
         return retCount;
     }
-
-    private string? VerifyImageParameter(string? curVal, string? defaultVal, IEnumerable<string>? options = null)
-    {
-        if (options.IsNullOrEmpty())
-        {
-            return curVal.IfNullOrEmptyAs(defaultVal);
-        }
-
-        return options.Contains(curVal) ? curVal : defaultVal;
-    }
     #endregion
 }
diff --git a/src/Plugins/BotSharp.Plugin.OpenAI/Using.cs b/src/Plugins/BotSharp.Plugin.OpenAI/Using.cs
@@ -26,6 +26,7 @@
 global using BotSharp.Abstraction.Files.Utilities;
 global using BotSharp.Abstraction.Functions.Models;
 global using BotSharp.Abstraction.MLTasks.Settings;
+global using BotSharp.Abstraction.MLTasks.Utilities;
 global using BotSharp.Abstraction.Options;
 global using BotSharp.Abstraction.Realtime;
 global using BotSharp.Abstraction.Realtime.Models;

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public async Task DisconnectAsync()`
`74`	`74`	`return;`
`75`	`75`	`}`
`76`	`76`
`77`		`- await _websocket.CloseAsync(WebSocketCloseStatus.Empty, null, CancellationToken.None);`
	`77`	`+ await _websocket.CloseAsync(WebSocketCloseStatus.NormalClosure, $"Normal Closure from {nameof(BotSharpRealtimeSession)}-{_sessionOptions?.Provider}", CancellationToken.None);`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`public void Dispose()`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ public async Task DisconnectAsync()`
`111`	`111`
`112`	`112`	`if (_webSocket.State == WebSocketState.Open)`
`113`	`113`	`{`
`114`		`- await _webSocket.CloseAsync(WebSocketCloseStatus.Empty, null, CancellationToken.None);`
	`114`	`+ await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, $"Normal Closure from {nameof(LlmRealtimeSession)}-{_sessionOptions?.Provider}", CancellationToken.None);`
`115`	`115`	`}`
`116`	`116`	`}`
`117`	`117`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ public class ChatStreamMiddleware`
`10`	`10`	`{`
`11`	`11`	`private readonly RequestDelegate _next;`
`12`	`12`	`private readonly ILogger<ChatStreamMiddleware> _logger;`
`13`		`- private BotSharpRealtimeSession _session;`
`14`	`13`
`15`	`14`	`public ChatStreamMiddleware(`
`16`	`15`	`RequestDelegate next,`
`@@ -40,7 +39,6 @@ public async Task Invoke(HttpContext httpContext)`
`40`	`39`	`}`
`41`	`40`	`catch (Exception ex)`
`42`	`41`	`{`
`43`		`- _session?.Dispose();`
`44`	`42`	`_logger.LogError(ex, $"Error when connecting Chat stream. ({ex.Message})");`
`45`	`43`	`}`
`46`	`44`	`return;`
`@@ -52,8 +50,7 @@ public async Task Invoke(HttpContext httpContext)`
`52`	`50`
`53`	`51`	`private async Task HandleWebSocket(IServiceProvider services, string agentId, string conversationId, WebSocket webSocket)`
`54`	`52`	`{`
`55`		`- _session?.Dispose();`
`56`		`- _session = new BotSharpRealtimeSession(services, webSocket, new ChatSessionOptions`
	`53`	`+ using var session = new BotSharpRealtimeSession(services, webSocket, new ChatSessionOptions`
`57`	`54`	`{`
`58`	`55`	`Provider = "BotSharp Chat Stream",`
`59`	`56`	`BufferSize = 1024 * 32,`
`@@ -72,7 +69,7 @@ private async Task HandleWebSocket(IServiceProvider services, string agentId, st`
`72`	`69`	`convService.SetConversationId(conversationId, []);`
`73`	`70`	`await convService.GetConversationRecordOrCreateNew(agentId);`
`74`	`71`
`75`		`- await foreach (ChatSessionUpdate update in _session.ReceiveUpdatesAsync(CancellationToken.None))`
	`72`	`+ await foreach (ChatSessionUpdate update in session.ReceiveUpdatesAsync(CancellationToken.None))`
`76`	`73`	`{`
`77`	`74`	`var receivedText = update?.RawResponse;`
`78`	`75`	`if (string.IsNullOrEmpty(receivedText))`
`@@ -87,7 +84,7 @@ private async Task HandleWebSocket(IServiceProvider services, string agentId, st`
`87`	`84`	`_logger.LogCritical($"Start chat stream connection for conversation ({conversationId})");`
`88`	`85`	`#endif`
`89`	`86`	`var request = InitRequest(data, conversationId);`
`90`		`- await ConnectToModel(hub, webSocket, request?.States);`
	`87`	`+ await ConnectToModel(hub, session, request?.States);`
`91`	`88`	`}`
`92`	`89`	`else if (eventType == "media")`
`93`	`90`	`{`
`@@ -107,17 +104,16 @@ private async Task HandleWebSocket(IServiceProvider services, string agentId, st`
`107`	`104`	`}`
`108`	`105`
`109`	`106`	`convService.SaveStates();`
`110`		`- await _session.DisconnectAsync();`
`111`		`- _session.Dispose();`
	`107`	`+ await session.DisconnectAsync();`
`112`	`108`	`}`
`113`	`109`
`114`		`- private async Task ConnectToModel(IRealtimeHub hub, WebSocket webSocket, List<MessageState>? states = null)`
	`110`	`+ private async Task ConnectToModel(IRealtimeHub hub, BotSharpRealtimeSession session, List<MessageState>? states = null)`
`115`	`111`	`{`
`116`	`112`	`await hub.ConnectToModel(responseToUser: async data =>`
`117`	`113`	`{`
`118`		`- if (_session != null)`
	`114`	`+ if (session != null)`
`119`	`115`	`{`
`120`		`- await _session.SendEventAsync(data);`
	`116`	`+ await session.SendEventAsync(data);`
`121`	`117`	`}`
`122`	`118`	`}, initStates: states);`
`123`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,8 +47,8 @@ private AudioTranscriptionOptions PrepareTranscriptionOptions(string? text)`
`47`	`47`	`temperature = $"{settings.Temperature}";`
`48`	`48`	`}`
`49`	`49`
`50`		`- responseFormat = settings?.ResponseFormat != null ? VerifyTranscriptionParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;`
`51`		`- granularity = settings?.Granularity != null ? VerifyTranscriptionParameter(granularity, settings.Granularity.Default, settings.Granularity.Options) : null;`
	`50`	`+ responseFormat = settings?.ResponseFormat != null ? LlmUtility.VerifyModelParameter(responseFormat, settings.ResponseFormat.Default, settings.ResponseFormat.Options) : null;`
	`51`	`+ granularity = settings?.Granularity != null ? LlmUtility.VerifyModelParameter(granularity, settings.Granularity.Default, settings.Granularity.Options) : null;`
`52`	`52`
`53`	`53`	`var options = new AudioTranscriptionOptions`
`54`	`54`	`{`
`@@ -131,14 +131,4 @@ private AudioTimestampGranularities GetGranularity(string input)`
`131`	`131`
`132`	`132`	`return temperature;`
`133`	`133`	`}`
`134`		`-`
`135`		`- private string? VerifyTranscriptionParameter(string? curVal, string? defaultVal, IEnumerable<string>? options = null)`
`136`		`- {`
`137`		`- if (options.IsNullOrEmpty())`
`138`		`- {`
`139`		`- return curVal.IfNullOrEmptyAs(defaultVal);`
`140`		`- }`
`141`		`-`
`142`		`- return options.Contains(curVal) ? curVal : defaultVal;`
`143`		`- }`
`144`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -201,15 +201,5 @@ private int GetImageCount(string count)`
`201`	`201`	`}`
`202`	`202`	`return retCount;`
`203`	`203`	`}`
`204`		`-`
`205`		`- private string? VerifyImageParameter(string? curVal, string? defaultVal, IEnumerable<string>? options = null)`
`206`		`- {`
`207`		`- if (options.IsNullOrEmpty())`
`208`		`- {`
`209`		`- return curVal.IfNullOrEmptyAs(defaultVal);`
`210`		`- }`
`211`		`-`
`212`		`- return options.Contains(curVal) ? curVal : defaultVal;`
`213`		`- }`
`214`	`204`	`#endregion`
`215`	`205`	`}`