Reproducible IDs (#1335)

* Reproducible IDs

Generate the ID based on a stable unique attribute

* Add NavigationSource

* Refactor in to static helper class

* rename

Author: reakaleek

src/Elastic.Markdown/Helpers/IdExtensions.cs

@@ -0,0 +1,13 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Security.Cryptography;
+using System.Text;
+
+namespace Elastic.Markdown.Helpers;
+
+public static class ShortId
+{
+	public static string Create(params string[] components) => Convert.ToHexString(SHA256.HashData(Encoding.UTF8.GetBytes(string.Join("", components))))[..8];
+}

src/Elastic.Markdown/IO/MarkdownFile.cs

@@ -4,6 +4,8 @@
 
 using System.IO.Abstractions;
 using System.Runtime.InteropServices;
+using System.Security.Cryptography;
+using System.Text;
 using Elastic.Documentation.Diagnostics;
 using Elastic.Documentation.Navigation;
 using Elastic.Markdown.Diagnostics;
@@ -51,6 +53,7 @@ DocumentationSet set
 		_configurationFile = build.Configuration.SourceFile;
 		_globalSubstitutions = build.Configuration.Substitutions;
 		_set = set;
+		Id = ShortId.Create(FilePath);
 		//may be updated by DocumentationGroup.ProcessTocItems
 		//todo refactor mutability of MarkdownFile as a whole
 		ScopeDirectory = build.Configuration.ScopeDirectory;
@@ -65,7 +68,7 @@ DocumentationSet set
 
 	public Uri NavigationSource { get; set; }
 
-	public string Id { get; } = Guid.NewGuid().ToString("N")[..8];
+	public string Id { get; }
 
 	private IDiagnosticsCollector Collector { get; }
 

src/Elastic.Markdown/IO/Navigation/DocumentationGroup.cs

@@ -4,8 +4,11 @@
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using System.Security.Cryptography;
+using System.Text;
 using Elastic.Documentation;
 using Elastic.Documentation.Configuration.TableOfContents;
+using Elastic.Markdown.Helpers;
 
 namespace Elastic.Markdown.IO.Navigation;
 
@@ -125,7 +128,7 @@ public class DocumentationGroup : INavigationGroup
 {
 	private readonly TableOfContentsTreeCollector _treeCollector;
 
-	public string Id { get; } = Guid.NewGuid().ToString("N")[..8];
+	public string Id { get; }
 
 	public string NavigationRootId => NavigationRoot.Id;
 
@@ -196,7 +199,7 @@ protected DocumentationGroup(
 		GroupsInOrder = groups;
 		FilesInOrder = files;
 		NavigationItems = navigationItems;
-
+		Id = ShortId.Create(NavigationSource.ToString(), FolderName);
 		if (Index is not null)
 			FilesInOrder = [.. FilesInOrder.Except([Index])];
 	}

src/Elastic.Markdown/Slices/Directives/_ViewModels.cs

@@ -1,7 +1,10 @@
 // Licensed to Elasticsearch B.V under one or more agreements.
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
+
+using System.Security.Cryptography;
 using System.Text;
+using Elastic.Markdown.Helpers;
 using Elastic.Markdown.Myst.Settings;
 
 namespace Elastic.Markdown.Slices.Directives;
@@ -56,7 +59,13 @@ public class ImageViewModel
 	public required string? Target { get; init; }
 	public required string? Width { get; init; }
 	public required string? ImageUrl { get; init; }
-	public string UniqueImageId { get; } = Guid.NewGuid().ToString("N")[..8];
+
+	private string? _uniqueImageId;
+
+	public string UniqueImageId =>
+		_uniqueImageId ??= string.IsNullOrEmpty(ImageUrl)
+			? Guid.NewGuid().ToString("N")[..8] // fallback to a random ID if ImageUrl is null or empty
+			: ShortId.Create(ImageUrl);
 	public required string? Screenshot { get; init; }
 
 	public string Style

src/Elastic.Markdown/Slices/Layout/_PagesNav.cshtml

@@ -2,9 +2,7 @@
 <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">
 	<nav
 		id="pages-nav"
-		class="sidebar-nav h-full"
-		@* used to invalidate session storage *@
-		data-current-navigation="@LayoutViewModel.CurrentNavigationId">
+		class="sidebar-nav h-full">
 		@(new HtmlString(Model.NavigationHtml))
 	</nav>
 	@* ReSharper disable once Html.IdNotResolved *@

src/Elastic.Markdown/Slices/_ViewModels.cs

@@ -46,11 +46,6 @@ public class IndexViewModel
 public class LayoutViewModel
 {
 	public required string DocSetName { get; init; }
-
-	/// Used to identify the navigation for the current compilation
-	/// We want to reset users sessionStorage every time this changes to invalidate
-	/// the guids that no longer exist
-	public static string CurrentNavigationId { get; } = Guid.NewGuid().ToString("N")[..8];
 	public string Title { get; set; } = "Elastic Documentation";
 	public required string Description { get; init; }
 	public required IReadOnlyCollection<PageTocItem> PageTocItems { get; init; }