|
| 1 | +using System.ClientModel.Primitives; |
| 2 | +using System.ComponentModel; |
| 3 | +using Devlooped.Extensions.AI; |
| 4 | +using Spectre.Console; |
| 5 | +using Spectre.Console.Json; |
| 6 | + |
| 7 | +namespace Microsoft.Extensions.AI; |
| 8 | + |
| 9 | +/// <summary> |
| 10 | +/// Adds console logging capabilities to the chat client and pipeline transport. |
| 11 | +/// </summary> |
| 12 | +[EditorBrowsable(EditorBrowsableState.Never)] |
| 13 | +public static class JsonConsoleLoggingExtensions |
| 14 | +{ |
| 15 | + /// <summary> |
| 16 | + /// Sets a <see cref="ClientPipelineOptions.Transport"/> that renders HTTP messages to the |
| 17 | + /// console using Spectre.Console rich JSON formatting, but only if the console is interactive. |
| 18 | + /// </summary> |
| 19 | + /// <typeparam name="TOptions">The options type to configure for HTTP logging.</typeparam> |
| 20 | + /// <param name="options">The options instance to configure.</param> |
| 21 | + /// <remarks> |
| 22 | + /// NOTE: this is the lowst-level logging after all chat pipeline processing has been done. |
| 23 | + /// <para> |
| 24 | + /// If the options already provide a transport, it will be wrapped with the console |
| 25 | + /// logging transport to minimize the impact on existing configurations. |
| 26 | + /// </para> |
| 27 | + /// </remarks> |
| 28 | + public static TOptions UseJsonConsoleLogging<TOptions>(this TOptions options) |
| 29 | + where TOptions : ClientPipelineOptions |
| 30 | + => UseJsonConsoleLogging(options, ConsoleExtensions.IsConsoleInteractive); |
| 31 | + |
| 32 | + /// <summary> |
| 33 | + /// Sets a <see cref="ClientPipelineOptions.Transport"/> that renders HTTP messages to the |
| 34 | + /// console using Spectre.Console rich JSON formatting. |
| 35 | + /// </summary> |
| 36 | + /// <typeparam name="TOptions">The options type to configure for HTTP logging.</typeparam> |
| 37 | + /// <param name="options">The options instance to configure.</param> |
| 38 | + /// <param name="askConfirmation">Whether to confirm logging before enabling it.</param> |
| 39 | + /// <remarks> |
| 40 | + /// NOTE: this is the lowst-level logging after all chat pipeline processing has been done. |
| 41 | + /// <para> |
| 42 | + /// If the options already provide a transport, it will be wrapped with the console |
| 43 | + /// logging transport to minimize the impact on existing configurations. |
| 44 | + /// </para> |
| 45 | + /// </remarks> |
| 46 | + public static TOptions UseJsonConsoleLogging<TOptions>(this TOptions options, bool askConfirmation) |
| 47 | + where TOptions : ClientPipelineOptions |
| 48 | + { |
| 49 | + if (askConfirmation && !AnsiConsole.Confirm("Do you want to enable rich JSON console logging for HTTP pipeline messages?")) |
| 50 | + return options; |
| 51 | + |
| 52 | + options.Transport = new ConsoleLoggingPipelineTransport(options.Transport ?? HttpClientPipelineTransport.Shared); |
| 53 | + |
| 54 | + return options; |
| 55 | + } |
| 56 | + |
| 57 | + /// <summary> |
| 58 | + /// Renders chat messages and responses to the console using Spectre.Console rich JSON formatting. |
| 59 | + /// </summary> |
| 60 | + /// <param name="builder">The builder in use.</param> |
| 61 | + /// <remarks> |
| 62 | + /// Confirmation will be asked if the console is interactive, otherwise, it will be |
| 63 | + /// enabled unconditionally. |
| 64 | + /// </remarks> |
| 65 | + public static ChatClientBuilder UseJsonConsoleLogging(this ChatClientBuilder builder) |
| 66 | + => UseJsonConsoleLogging(builder, ConsoleExtensions.IsConsoleInteractive); |
| 67 | + |
| 68 | + /// <summary> |
| 69 | + /// Renders chat messages and responses to the console using Spectre.Console rich JSON formatting. |
| 70 | + /// </summary> |
| 71 | + /// <param name="builder">The builder in use.</param> |
| 72 | + /// <param name="askConfirmation">If true, prompts the user for confirmation before enabling console logging.</param> |
| 73 | + /// <param name="maxLength">Optional maximum length to render for string values. Replaces remaining characters with "...".</param> |
| 74 | + public static ChatClientBuilder UseJsonConsoleLogging(this ChatClientBuilder builder, bool askConfirmation = false, Action<JsonConsoleLoggingChatClient>? configure = null) |
| 75 | + { |
| 76 | + if (askConfirmation && !AnsiConsole.Confirm("Do you want to enable console logging for chat messages?")) |
| 77 | + return builder; |
| 78 | + |
| 79 | + return builder.Use(inner => |
| 80 | + { |
| 81 | + var client = new JsonConsoleLoggingChatClient(inner); |
| 82 | + configure?.Invoke(client); |
| 83 | + return client; |
| 84 | + }); |
| 85 | + } |
| 86 | + |
| 87 | + class ConsoleLoggingPipelineTransport(PipelineTransport inner) : PipelineTransport |
| 88 | + { |
| 89 | + public static PipelineTransport Default { get; } = new ConsoleLoggingPipelineTransport(); |
| 90 | + |
| 91 | + public ConsoleLoggingPipelineTransport() : this(HttpClientPipelineTransport.Shared) { } |
| 92 | + |
| 93 | + protected override PipelineMessage CreateMessageCore() => inner.CreateMessage(); |
| 94 | + protected override void ProcessCore(PipelineMessage message) => inner.Process(message); |
| 95 | + |
| 96 | + protected override async ValueTask ProcessCoreAsync(PipelineMessage message) |
| 97 | + { |
| 98 | + message.BufferResponse = true; |
| 99 | + await inner.ProcessAsync(message); |
| 100 | + |
| 101 | + if (message.Request.Content is not null) |
| 102 | + { |
| 103 | + using var memory = new MemoryStream(); |
| 104 | + message.Request.Content.WriteTo(memory); |
| 105 | + memory.Position = 0; |
| 106 | + using var reader = new StreamReader(memory); |
| 107 | + var content = await reader.ReadToEndAsync(); |
| 108 | + |
| 109 | + AnsiConsole.Write(new Panel(new JsonText(content))); |
| 110 | + } |
| 111 | + |
| 112 | + if (message.Response != null) |
| 113 | + { |
| 114 | + AnsiConsole.Write(new Panel(new JsonText(message.Response.Content.ToString()))); |
| 115 | + } |
| 116 | + } |
| 117 | + } |
| 118 | + |
| 119 | +} |
0 commit comments