Manually inject live reload script, the default was causing issues on larger chucked Results.Content

Author: Mpdreamz

src/Elastic.ApiExplorer/OpenApiGenerator.cs

@@ -62,15 +62,17 @@ public LandingNavigationItem CreateNavigation(string apiUrlSuffix, OpenApiDocume
 					? anyApi.Node.GetValue<string>()
 					: null;
 				var tag = op.Value.Tags?.FirstOrDefault()?.Reference.Id;
-				var classification = openApiDocument.Info.Title == "Elasticsearch Request & Response Specification"
-					? ClassifyElasticsearchTag(tag ?? "unknown")
-					: "unknown";
+				var tagClassification = (extensions?.TryGetValue("x-tag-group", out var g) ?? false) && g is OpenApiAny anyTagGroup
+					? anyTagGroup.Node.GetValue<string>()
+					: openApiDocument.Info.Title == "Elasticsearch Request & Response Specification"
+						? ClassifyElasticsearchTag(tag ?? "unknown")
+						: "unknown";
 
 				var apiString = ns is null
 					? api ?? op.Value.Summary ?? Guid.NewGuid().ToString("N") : $"{ns}.{api}";
 				return new
 				{
-					Classification = classification,
+					Classification = tagClassification,
 					Api = apiString,
 					Tag = tag,
 					pair.Path,
@@ -158,7 +160,7 @@ group tagGroup by classificationGroup.Key
 		var hasClassifications = classifications.Count > 1;
 		foreach (var classification in classifications)
 		{
-			if (hasClassifications)
+			if (hasClassifications && classification.Name != "common")
 			{
 				var classificationNavigationItem = new ClassificationNavigationItem(classification, rootNavigation, rootNavigation);
 				var tagNavigationItems = new List<IApiGroupingNavigationItem<IApiGroupingModel, INavigationItem>>();
@@ -264,23 +266,25 @@ public async Task Generate(Cancel ctx = default)
 				MarkdownRenderer = markdownStringRenderer
 			};
 			_ = await Render(prefix, navigation, navigation.Index, renderContext, navigationRenderer, ctx);
-			await RenderNavigationItems(navigation);
-			async Task RenderNavigationItems(INavigationItem currentNavigation)
-			{
-				if (currentNavigation is INodeNavigationItem<IApiModel, INavigationItem> node)
-				{
-					_ = await Render(prefix, node, node.Index, renderContext, navigationRenderer, ctx);
-					foreach (var child in node.NavigationItems)
-						await RenderNavigationItems(child);
-				}
+			await RenderNavigationItems(prefix, renderContext, navigationRenderer, navigation, ctx);
 
-				else
-				{
-					_ = currentNavigation is ILeafNavigationItem<IApiModel> leaf
-						? await Render(prefix, leaf, leaf.Model, renderContext, navigationRenderer, ctx)
-						: throw new Exception($"Unknown navigation item type {currentNavigation.GetType()}");
-				}
-			}
+		}
+	}
+
+	private async Task RenderNavigationItems(string prefix, ApiRenderContext renderContext, IsolatedBuildNavigationHtmlWriter navigationRenderer, INavigationItem currentNavigation, Cancel ctx)
+	{
+		if (currentNavigation is INodeNavigationItem<IApiModel, INavigationItem> node)
+		{
+			_ = await Render(prefix, node, node.Index, renderContext, navigationRenderer, ctx);
+			foreach (var child in node.NavigationItems)
+				await RenderNavigationItems(prefix, renderContext, navigationRenderer, child, ctx);
+		}
+
+		else
+		{
+			_ = currentNavigation is ILeafNavigationItem<IApiModel> leaf
+				? await Render(prefix, leaf, leaf.Model, renderContext, navigationRenderer, ctx)
+				: throw new Exception($"Unknown navigation item type {currentNavigation.GetType()}");
 		}
 	}
 

src/Elastic.ApiExplorer/Operations/OperationNavigationItem.cs

@@ -12,6 +12,19 @@
 
 namespace Elastic.ApiExplorer.Operations;
 
+public interface IApiProperty
+{
+
+}
+
+public record ApiObject
+{
+	public required string Name { get; init; }
+	public IReadOnlyCollection<IApiProperty> Properties { get; init; } = [];
+}
+
+
+
 public record ApiOperation(OperationType OperationType, OpenApiOperation Operation, string Route, IOpenApiPathItem Path, string ApiName) : IApiModel
 {
 	public async Task RenderAsync(FileSystemStream stream, ApiRenderContext context, Cancel ctx = default)

src/tooling/docs-builder/Http/DocumentationWebHost.cs

@@ -5,15 +5,13 @@
 using System.IO.Abstractions;
 using System.Net;
 using System.Runtime.InteropServices;
+using System.Text;
 using Documentation.Builder.Diagnostics.LiveMode;
 using Elastic.Documentation.Configuration;
 using Elastic.Documentation.Configuration.Versions;
 using Elastic.Documentation.Site.FileProviders;
 using Elastic.Documentation.Tooling;
-using Elastic.Markdown.Exporters;
 using Elastic.Markdown.IO;
-using Elastic.Markdown.Myst.Renderers;
-using Markdig.Syntax;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Http;
@@ -92,60 +90,9 @@ public async Task StopAsync(Cancel ctx)
 	private void SetUpRoutes()
 	{
 		_ = _webApplication
-			.UseExceptionHandler(options =>
-			{
-				options.Run(async context =>
-				{
-					try
-					{
-						var exception = context.Features.Get<Microsoft.AspNetCore.Diagnostics.IExceptionHandlerFeature>();
-						if (exception != null)
-						{
-							var logger = context.RequestServices.GetRequiredService<ILogger<DocumentationWebHost>>();
-							logger.LogError(
-								exception.Error,
-								"Unhandled exception processing request {Path}. Error: {Error}\nStack Trace: {StackTrace}\nInner Exception: {InnerException}",
-								context.Request.Path,
-								exception.Error.Message,
-								exception.Error.StackTrace,
-								exception.Error.InnerException?.ToString() ?? "None"
-							);
-							logger.LogError(
-								"Request Details - Method: {Method}, Path: {Path}, QueryString: {QueryString}",
-								context.Request.Method,
-								context.Request.Path,
-								context.Request.QueryString
-							);
-
-							context.Response.StatusCode = 500;
-							context.Response.ContentType = "text/html";
-							await context.Response.WriteAsync(@"
-								<html>
-									<head><title>Error</title></head>
-									<body>
-										<h1>Internal Server Error</h1>
-										<p>An error occurred while processing your request.</p>
-										<p>Please check the application logs for more details.</p>
-									</body>
-								</html>");
-						}
-					}
-					catch (Exception handlerEx)
-					{
-						var logger = context.RequestServices.GetRequiredService<ILogger<DocumentationWebHost>>();
-						logger.LogCritical(
-							handlerEx,
-							"Error handler failed to process exception. Handler Error: {Error}\nStack Trace: {StackTrace}",
-							handlerEx.Message,
-							handlerEx.StackTrace
-						);
-						context.Response.StatusCode = 500;
-						context.Response.ContentType = "text/plain";
-						await context.Response.WriteAsync("A critical error occurred.");
-					}
-				});
-			})
-			.UseLiveReload()
+			.UseLiveReloadWithManualScriptInjection(_webApplication.Lifetime)
+			.UseDeveloperExceptionPage(new DeveloperExceptionPageOptions())
+			//.UseMiddleware<NoInjectLiveReloadMiddleware>()
 			.UseStaticFiles(
 				new StaticFileOptions
 				{
@@ -169,37 +116,34 @@ await context.Response.WriteAsync(@"
 
 	private async Task<IResult> ServeApiFile(ReloadableGeneratorState holder, string slug, Cancel ctx)
 	{
-#if DEBUG
-		// only reload when actually debugging
-		if (System.Diagnostics.Debugger.IsAttached)
-			await holder.ReloadApiReferences(ctx);
-#endif
+		var x = LiveReloadConfiguration.Current.LiveReloadScriptUrl;
+
 		var path = Path.Combine(holder.ApiPath.FullName, slug.Trim('/'), "index.html");
 		var info = _writeFileSystem.FileInfo.New(path);
 		if (info.Exists)
 		{
 			//TODO STREAM
 			var contents = await _writeFileSystem.File.ReadAllTextAsync(info.FullName, ctx);
-			return Results.Content(contents, "text/html");
+			return LiveReloadHtml(contents, Encoding.UTF8, 200);
 		}
 
 		return Results.NotFound();
 	}
 
 	private static async Task<IResult> ServeDocumentationFile(ReloadableGeneratorState holder, string slug, Cancel ctx)
 	{
+		if (slug == ".well-known/appspecific/com.chrome.devtools.json")
+			return Results.NotFound();
+
 		var generator = holder.Generator;
 		const string navPartialSuffix = ".nav.html";
 
 		// Check if the original request is asking for LLM-rendered markdown
 		var requestLlmMarkdown = slug.EndsWith(".md");
-		var originalSlug = slug;
 
 		// If requesting .md output, remove the .md extension to find the source file
 		if (requestLlmMarkdown)
-		{
 			slug = slug[..^3]; // Remove ".md" extension
-		}
 
 		if (slug.EndsWith(navPartialSuffix))
 		{
@@ -238,12 +182,9 @@ private static async Task<IResult> ServeDocumentationFile(ReloadableGeneratorSta
 					var llmRendered = await generator.RenderLlmMarkdown(markdown, ctx);
 					return Results.Content(llmRendered, "text/markdown; charset=utf-8");
 				}
-				else
-				{
-					// Regular HTML rendering
-					var rendered = await generator.RenderLayout(markdown, ctx);
-					return Results.Content(rendered.Html, "text/html");
-				}
+				// Regular HTML rendering
+				var rendered = await generator.RenderLayout(markdown, ctx);
+				return LiveReloadHtml(rendered.Html);
 
 			case ImageFile image:
 				return Results.File(image.SourceFile.FullName, image.MimeType);
@@ -261,4 +202,17 @@ private static async Task<IResult> ServeDocumentationFile(ReloadableGeneratorSta
 				return Results.Content(renderedNotFound.Html, "text/html", null, (int)HttpStatusCode.NotFound);
 		}
 	}
+
+	private static IResult LiveReloadHtml(string content, Encoding? encoding = null, int? statusCode = null)
+	{
+		if (LiveReloadConfiguration.Current.LiveReloadEnabled)
+		{
+			//var script = WebsocketScriptInjectionHelper.GetWebSocketClientJavaScript(context, true);
+			//var html = $"<script>\n{script}\n</script>";
+			var html = "\n" + $@"<script src=""{LiveReloadConfiguration.Current.LiveReloadScriptUrl}"" defer></script>";
+			content += html;
+		}
+
+		return Results.Content(content, "text/html", encoding, statusCode);
+	}
 }

src/tooling/docs-builder/Http/LiveReload.cs

@@ -3,9 +3,13 @@
 // See the LICENSE file in the project root for more information
 
 using System.Diagnostics.CodeAnalysis;
+using System.Reflection;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
 
 // ReSharper disable once CheckNamespace
 #pragma warning disable IDE0130
@@ -57,4 +61,61 @@ public static IServiceCollection AddAotLiveReload(this IServiceCollection servic
 
 		return services;
 	}
+
+	public static IApplicationBuilder UseLiveReloadWithManualScriptInjection(this IApplicationBuilder builder, IHostApplicationLifetime webApplicationLifetime)
+	{
+		var config = LiveReloadConfiguration.Current;
+
+		if (config.LiveReloadEnabled)
+		{
+			var webSocketOptions = new WebSocketOptions()
+			{
+				KeepAliveInterval = TimeSpan.FromSeconds(300),
+			};
+			_ = builder.UseWebSockets(webSocketOptions);
+
+			_ = builder
+				.Use((context, next) =>
+				{
+					var middleWare = new NoInjectLiveReloadMiddleware(next, webApplicationLifetime);
+					return middleWare.InvokeAsync(context);
+				});
+			LiveReloadFileWatcher.StartFileWatcher();
+
+			// always refresh when the server restarts...
+			_ = LiveReloadMiddleware.RefreshWebSocketRequest();
+		}
+
+		return builder;
+	}
+}
+
+
+/// <inheritdoc />
+public class NoInjectLiveReloadMiddleware(RequestDelegate next, IHostApplicationLifetime lifeTime) : LiveReloadMiddleware(next, lifeTime)
+{
+	private readonly MethodInfo _handleWebSocketRequest =
+		typeof(LiveReloadMiddleware).GetMethod("HandleWebSocketRequest", BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.InvokeMethod)!;
+
+	private readonly RequestDelegate _next = next;
+
+	public new async Task InvokeAsync(HttpContext context)
+	{
+		var config = LiveReloadConfiguration.Current;
+		if (!config.LiveReloadEnabled)
+		{
+			await _next(context);
+			return;
+		}
+
+		if (await HandleServeLiveReloadScript(context))
+			return;
+
+		// See if we have a WebSocket request. True means we handled
+		var invoked = await (Task<bool>)_handleWebSocketRequest.Invoke(this, [context])!;
+		if (invoked)
+			return;
+
+		await _next(context);
+	}
 }

src/tooling/docs-builder/Http/ReloadGeneratorService.cs

@@ -26,12 +26,12 @@ public async Task StartAsync(Cancel cancellationToken)
 		var watcher = new FileSystemWatcher(ReloadableGenerator.Generator.DocumentationSet.SourceDirectory.FullName)
 		{
 			NotifyFilter = NotifyFilters.Attributes
-			               | NotifyFilters.CreationTime
-			               | NotifyFilters.DirectoryName
-			               | NotifyFilters.FileName
-			               | NotifyFilters.LastWrite
-			               | NotifyFilters.Security
-			               | NotifyFilters.Size
+							| NotifyFilters.CreationTime
+							| NotifyFilters.DirectoryName
+							| NotifyFilters.FileName
+							| NotifyFilters.LastWrite
+							| NotifyFilters.Security
+							| NotifyFilters.Size
 		};
 
 		watcher.Changed += OnChanged;