Hide functionality behind the LAZY_LOAD_NAVIGATION feature flag

Author: reakaleek

src/Elastic.Documentation.Configuration/Builder/FeatureFlags.cs

@@ -20,6 +20,12 @@ public bool PrimaryNavEnabled
 		set => _featureFlags["primary-nav"] = value;
 	}
 
+	public bool LazyLoadNavigation
+	{
+		get => IsEnabled("LAZY_LOAD_NAVIGATION");
+		set => _featureFlags["LAZY_LOAD_NAVIGATION"] = value;
+	}
+
 	private bool IsEnabled(string key)
 	{
 		var envKey = $"FEATURE_{key.ToUpperInvariant().Replace('-', '_')}";

src/Elastic.Documentation.Site/Layout/_PagesNav.cshtml

@@ -1,6 +1,10 @@
 @inherits RazorSlice<Elastic.Documentation.Site.GlobalLayoutViewModel>
 <aside class="sidebar bg-white fixed md:sticky shadow-2xl md:shadow-none left-[100%] group-has-[#pages-nav-hamburger:checked]/body:left-0 bottom-0 md:left-auto pl-6 md:pl-2 top-[calc(var(--offset-top)+1px)] w-[80%] md:w-auto shrink-0 border-r-1 border-r-grey-20 z-40 md:z-auto">
-	<div hx-get="@(Model.CurrentNavigationItem.Url + (Model.CurrentNavigationItem.Url.EndsWith('/') ? "index.nav.html" : "/index.nav.html"))" hx-trigger="load" hx-params="nav" hx-push-url="false" hx-swap="innerHTML" hx-target="#pages-nav"></div>
+	
+	@if (Model.Features.LazyLoadNavigation)
+	{
+		<div hx-get="@(Model.CurrentNavigationItem.Url + (Model.CurrentNavigationItem.Url.EndsWith('/') ? "index.nav.html" : "/index.nav.html"))" hx-trigger="load" hx-params="nav" hx-push-url="false" hx-swap="innerHTML" hx-target="#pages-nav"></div>
+	}
 	<nav
 		id="pages-nav"
 		class="sidebar-nav h-full">

src/Elastic.Markdown/DocumentationGenerator.cs

@@ -334,7 +334,7 @@ private async Task GenerateDocumentationState(Cancel ctx)
 		await DocumentationSet.OutputDirectory.FileSystem.File.WriteAllBytesAsync(stateFile.FullName, bytes, ctx);
 	}
 
-	public async Task<(string, string)> RenderLayout(MarkdownFile markdown, Cancel ctx)
+	public async Task<RenderResult> RenderLayout(MarkdownFile markdown, Cancel ctx)
 	{
 		await DocumentationSet.Tree.Resolve(ctx);
 		return await HtmlWriter.RenderLayout(markdown, ctx);

src/Elastic.Markdown/HtmlWriter.cs

@@ -44,19 +44,21 @@ public string Render(string markdown, IFileInfo? source)
 		return MarkdownFile.CreateHtml(parsed);
 	}
 
-	public async Task<(string, string)> RenderLayout(MarkdownFile markdown, Cancel ctx = default)
+	public async Task<RenderResult> RenderLayout(MarkdownFile markdown, Cancel ctx = default)
 	{
 		var document = await markdown.ParseFullAsync(ctx);
 		return await RenderLayout(markdown, document, ctx);
 	}
 
-	private async Task<(string, string)> RenderLayout(MarkdownFile markdown, MarkdownDocument document, Cancel ctx = default)
+	private async Task<RenderResult> RenderLayout(MarkdownFile markdown, MarkdownDocument document, Cancel ctx = default)
 	{
 		var html = MarkdownFile.CreateHtml(document);
 		await DocumentationSet.Tree.Resolve(ctx);
 
 		var fullNavigationHtml = await NavigationHtmlWriter.RenderNavigation(markdown.NavigationRoot, markdown.NavigationSource, -1, ctx);
-		var miniNavigationHtml = await NavigationHtmlWriter.RenderNavigation(markdown.NavigationRoot, markdown.NavigationSource, 1, ctx);
+		var miniNavigationHtml = DocumentationSet.Context.Configuration.Features.LazyLoadNavigation
+			? await NavigationHtmlWriter.RenderNavigation(markdown.NavigationRoot, markdown.NavigationSource, 1, ctx)
+			: "lazy navigation feature disabled";
 
 		var current = PositionalNavigation.GetCurrent(markdown);
 		var previous = PositionalNavigation.GetPrevious(markdown);
@@ -116,7 +118,7 @@ public string Render(string markdown, IFileInfo? source)
 			PreviousDocument = previous,
 			NextDocument = next,
 			Parents = parents,
-			NavigationHtml = miniNavigationHtml,
+			NavigationHtml = DocumentationSet.Configuration.Features.LazyLoadNavigation ? miniNavigationHtml : fullNavigationHtml,
 			UrlPathPrefix = markdown.UrlPathPrefix,
 			AppliesTo = markdown.YamlFrontMatter?.AppliesTo,
 			GithubEditUrl = editUrl,
@@ -133,7 +135,12 @@ public string Render(string markdown, IFileInfo? source)
 			Products = allProducts,
 			VersionsConfig = DocumentationSet.Context.VersionsConfig
 		});
-		return (fullNavigationHtml, await slice.RenderAsync(cancellationToken: ctx));
+		return new RenderResult
+		{
+			Html = await slice.RenderAsync(cancellationToken: ctx),
+			FullNavigationPartialHtml = fullNavigationHtml
+		};
+
 	}
 
 	public async Task<MarkdownDocument> WriteAsync(IFileInfo outputFile, MarkdownFile markdown, IConversionCollector? collector, Cancel ctx = default)
@@ -161,10 +168,20 @@ public async Task<MarkdownDocument> WriteAsync(IFileInfo outputFile, MarkdownFil
 		var document = await markdown.ParseFullAsync(ctx);
 
 		var rendered = await RenderLayout(markdown, document, ctx);
-		collector?.Collect(markdown, document, rendered.Item2);
-		await writeFileSystem.File.WriteAllTextAsync(path, rendered.Item2, ctx);
-		await writeFileSystem.File.WriteAllTextAsync(path.Replace(".html", ".nav.html"), rendered.Item1, ctx);
+		collector?.Collect(markdown, document, rendered.Html);
+		await writeFileSystem.File.WriteAllTextAsync(path, rendered.Html, ctx);
+
+		if (DocumentationSet.Configuration.Features.LazyLoadNavigation)
+		{
+			await writeFileSystem.File.WriteAllTextAsync(path.Replace(".html", ".nav.html"), rendered.FullNavigationPartialHtml, ctx);
+		}
 		return document;
 	}
 
 }
+
+public record RenderResult
+{
+	public required string Html { get; init; }
+	public required string FullNavigationPartialHtml { get; init; }
+}

src/tooling/docs-assembler/assembler.yml

@@ -23,6 +23,8 @@ environments:
     content_source: current
     google_tag_manager:
       enabled: false
+    feature_flags:
+      LAZY_LOAD_NAVIGATION: true
   dev:
     uri: http://localhost:4000
     content_source: next

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

@@ -207,7 +207,7 @@ private static async Task<IResult> ServeDocumentationFile(ReloadableGeneratorSta
 		{
 			case MarkdownFile markdown:
 				var rendered = await generator.RenderLayout(markdown, ctx);
-				return Results.Content(isNavPartial ? rendered.Item1 : rendered.Item2, "text/html");
+				return Results.Content(isNavPartial ? rendered.FullNavigationPartialHtml : rendered.Html, "text/html");
 
 			case ImageFile image:
 				return Results.File(image.SourceFile.FullName, image.MimeType);
@@ -222,7 +222,7 @@ private static async Task<IResult> ServeDocumentationFile(ReloadableGeneratorSta
 					return Results.NotFound();
 
 				var renderedNotFound = await generator.RenderLayout((notFoundDocumentationFile as MarkdownFile)!, ctx);
-				return Results.Content(renderedNotFound.Item2, "text/html", null, (int)HttpStatusCode.NotFound);
+				return Results.Content(renderedNotFound.Html, "text/html", null, (int)HttpStatusCode.NotFound);
 		}
 	}
 }