fix: remove tab group hash function (#8942)

dotnet · Jul 7, 2023 · 9134d6c · 9134d6c
1 parent 71e1479
commit 9134d6c
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 85 deletions.
diff --git a/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/Aggregator/TabGroupAggregator.cs b/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/Aggregator/TabGroupAggregator.cs
@@ -66,23 +66,14 @@ private static void AggregateCore(
         int offset
         )
     {
-        var groupId = GetHashString(items[0]?.Content?.ToString() ?? string.Empty).Replace("/", "-").Remove(10);
-
         context.AggregateTo(new TabGroupBlock(
-                            groupId,
                             items.ToImmutableArray(),
                             startLine,
                             startSpan,
                             0),
                             offset);
     }
 
-    private static string GetHashString(string content)
-    {
-        using var sha256 = SHA256.Create();
-        return Convert.ToBase64String(sha256.ComputeHash(Encoding.UTF8.GetBytes(content)));
-    }
-
     private static TabItemBlock CreateTabItem(
         HeadingBlock headBlock,
         Tuple<string, string, LinkInline> pair,

diff --git a/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/TabGroup/HtmlTabGroupBlockRenderer.cs b/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/TabGroup/HtmlTabGroupBlockRenderer.cs
@@ -11,7 +11,7 @@ public class HtmlTabGroupBlockRenderer : HtmlObjectRenderer<TabGroupBlock>
     protected override void Write(HtmlRenderer renderer, TabGroupBlock block)
     {
         renderer.Write(@"<div class=""tabGroup"" id=""tabgroup_");
-        var groupId = ExtensionsHelper.Escape(block.Id);
+        var groupId = block.Id.ToString();
         renderer.Write(groupId);
         renderer.Write("\"");
         renderer.WriteAttributes(block);

diff --git a/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/TabGroup/TabGroupBlock.cs b/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/TabGroup/TabGroupBlock.cs
@@ -9,15 +9,14 @@ namespace Microsoft.DocAsCode.MarkdigEngine.Extensions;
 
 public class TabGroupBlock : ContainerBlock
 {
-    public string Id { get; set; }
+    public int Id { get; set; }
 
     public int ActiveTabIndex { get; set; }
 
     public ImmutableArray<TabItemBlock> Items { get; set; }
 
-    public TabGroupBlock(string id, ImmutableArray<TabItemBlock> blocks, int startLine, int startSpan, int activeTabIndex) : base(null)
+    public TabGroupBlock(ImmutableArray<TabItemBlock> blocks, int startLine, int startSpan, int activeTabIndex) : base(null)
     {
-        Id = id;
         ActiveTabIndex = activeTabIndex;
         Items = blocks;
         Line = startLine;

diff --git a/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/TabGroup/TabGroupIdRewriter.cs b/src/Microsoft.DocAsCode.MarkdigEngine.Extensions/TabGroup/TabGroupIdRewriter.cs
@@ -8,7 +8,7 @@ namespace Microsoft.DocAsCode.MarkdigEngine;
 
 public class TabGroupIdRewriter : IMarkdownObjectRewriter
 {
-    private Dictionary<string, int> _dict = new();
+    private int _id;
 
     public void PostProcess(IMarkdownObject markdownObject)
     {
@@ -22,22 +22,7 @@ public IMarkdownObject Rewrite(IMarkdownObject markdownObject)
     {
         if (markdownObject is TabGroupBlock block)
         {
-            var groupId = block.Id;
-            while (true)
-            {
-                if (_dict.TryGetValue(groupId, out int index))
-                {
-                    _dict[groupId] += 1;
-                    groupId = $"{groupId}-{index}";
-                    block.Id = groupId;
-                    return block;
-                }
-                else
-                {
-                    _dict.Add(groupId, 1);
-                    return markdownObject;
-                }
-            }
+            block.Id = ++_id;
         }
 
         return markdownObject;

diff --git a/test/Microsoft.DocAsCode.MarkdigEngine.Extensions.Tests/GeneralTest.cs b/test/Microsoft.DocAsCode.MarkdigEngine.Extensions.Tests/GeneralTest.cs
@@ -234,20 +234,19 @@ public void TestTabGroup()
 # <a id=""x""></a>[title-b](#tab/b/c)
 content-b
 - - -";
-        var groupId = "bHGHmlrG6S";
-        var expected = $@"<div class=""tabGroup"" id=""tabgroup_{groupId}"" sourceFile=""test.md"" sourceStartLineNumber=""1"">
+        var expected = $@"<div class=""tabGroup"" id=""tabgroup_1"" sourceFile=""test.md"" sourceStartLineNumber=""1"">
 <ul role=""tablist"">
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}_a"" role=""tab"" aria-controls=""tabpanel_{groupId}_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""test.md"" sourceStartLineNumber=""1"">title-a</a>
+<a href=""#tabpanel_1_a"" role=""tab"" aria-controls=""tabpanel_1_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""test.md"" sourceStartLineNumber=""1"">title-a</a>
 </li>
 <li role=""presentation"" aria-hidden=""true"" hidden=""hidden"">
-<a href=""#tabpanel_{groupId}_b_c"" role=""tab"" aria-controls=""tabpanel_{groupId}_b_c"" data-tab=""b"" data-condition=""c"" tabindex=""-1"" sourceFile=""test.md"" sourceStartLineNumber=""3"">title-b</a>
+<a href=""#tabpanel_1_b_c"" role=""tab"" aria-controls=""tabpanel_1_b_c"" data-tab=""b"" data-condition=""c"" tabindex=""-1"" sourceFile=""test.md"" sourceStartLineNumber=""3"">title-b</a>
 </li>
 </ul>
-<section id=""tabpanel_{groupId}_a"" role=""tabpanel"" data-tab=""a"">
+<section id=""tabpanel_1_a"" role=""tabpanel"" data-tab=""a"">
 <p sourceFile=""test.md"" sourceStartLineNumber=""2"">content-a</p>
 </section>
-<section id=""tabpanel_{groupId}_b_c"" role=""tabpanel"" data-tab=""b"" data-condition=""c"" aria-hidden=""true"" hidden=""hidden"">
+<section id=""tabpanel_1_b_c"" role=""tabpanel"" data-tab=""b"" data-condition=""c"" aria-hidden=""true"" hidden=""hidden"">
 <p sourceFile=""test.md"" sourceStartLineNumber=""4"">content-b</p>
 </section>
 </div>
@@ -269,37 +268,36 @@ public void TestTabGroup_2()
 # [title-b](#tab/b/a)
 content-b
 - - -";
-        var groupId = "bHGHmlrG6S";
-        var expected = $@"<div class=""tabGroup"" id=""tabgroup_{groupId}"" sourceFile=""test.md"" sourceStartLineNumber=""1"">
+        var expected = $@"<div class=""tabGroup"" id=""tabgroup_1"" sourceFile=""test.md"" sourceStartLineNumber=""1"">
 <ul role=""tablist"">
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}_a"" role=""tab"" aria-controls=""tabpanel_{groupId}_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""test.md"" sourceStartLineNumber=""1"">title-a</a>
+<a href=""#tabpanel_1_a"" role=""tab"" aria-controls=""tabpanel_1_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""test.md"" sourceStartLineNumber=""1"">title-a</a>
 </li>
 <li role=""presentation"" aria-hidden=""true"" hidden=""hidden"">
-<a href=""#tabpanel_{groupId}_b_c"" role=""tab"" aria-controls=""tabpanel_{groupId}_b_c"" data-tab=""b"" data-condition=""c"" tabindex=""-1"" sourceFile=""test.md"" sourceStartLineNumber=""3"">title-b</a>
+<a href=""#tabpanel_1_b_c"" role=""tab"" aria-controls=""tabpanel_1_b_c"" data-tab=""b"" data-condition=""c"" tabindex=""-1"" sourceFile=""test.md"" sourceStartLineNumber=""3"">title-b</a>
 </li>
 </ul>
-<section id=""tabpanel_{groupId}_a"" role=""tabpanel"" data-tab=""a"">
+<section id=""tabpanel_1_a"" role=""tabpanel"" data-tab=""a"">
 <p sourceFile=""test.md"" sourceStartLineNumber=""2"">content-a</p>
 </section>
-<section id=""tabpanel_{groupId}_b_c"" role=""tabpanel"" data-tab=""b"" data-condition=""c"" aria-hidden=""true"" hidden=""hidden"">
+<section id=""tabpanel_1_b_c"" role=""tabpanel"" data-tab=""b"" data-condition=""c"" aria-hidden=""true"" hidden=""hidden"">
 <p sourceFile=""test.md"" sourceStartLineNumber=""4"">content-b</p>
 </section>
 </div>
-<div class=""tabGroup"" id=""tabgroup_{groupId}-1"" sourceFile=""test.md"" sourceStartLineNumber=""6"">
+<div class=""tabGroup"" id=""tabgroup_2"" sourceFile=""test.md"" sourceStartLineNumber=""6"">
 <ul role=""tablist"">
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}-1_a"" role=""tab"" aria-controls=""tabpanel_{groupId}-1_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""test.md"" sourceStartLineNumber=""6"">title-a</a>
+<a href=""#tabpanel_2_a"" role=""tab"" aria-controls=""tabpanel_2_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""test.md"" sourceStartLineNumber=""6"">title-a</a>
 </li>
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}-1_b_a"" role=""tab"" aria-controls=""tabpanel_{groupId}-1_b_a"" data-tab=""b"" data-condition=""a"" tabindex=""-1"" sourceFile=""test.md"" sourceStartLineNumber=""8"">title-b</a>
+<a href=""#tabpanel_2_b_a"" role=""tab"" aria-controls=""tabpanel_2_b_a"" data-tab=""b"" data-condition=""a"" tabindex=""-1"" sourceFile=""test.md"" sourceStartLineNumber=""8"">title-b</a>
 </li>
 </ul>
-<section id=""tabpanel_{groupId}-1_a"" role=""tabpanel"" data-tab=""a"">
+<section id=""tabpanel_2_a"" role=""tabpanel"" data-tab=""a"">
 
 <p sourceFile=""test.md"" sourceStartLineNumber=""7"">content-a</p>
 </section>
-<section id=""tabpanel_{groupId}-1_b_a"" role=""tabpanel"" data-tab=""b"" data-condition=""a"" aria-hidden=""true"" hidden=""hidden"">
+<section id=""tabpanel_2_b_a"" role=""tabpanel"" data-tab=""b"" data-condition=""a"" aria-hidden=""true"" hidden=""hidden"">
 
 <p sourceFile=""test.md"" sourceStartLineNumber=""9"">content-b</p>
 </section>

diff --git a/test/Microsoft.DocAsCode.MarkdigEngine.Extensions.Tests/TabGroupTest.cs b/test/Microsoft.DocAsCode.MarkdigEngine.Extensions.Tests/TabGroupTest.cs
@@ -11,7 +11,6 @@ public class TabGroupTest
     [Trait("Related", "TabGroup")]
     public void Test_General()
     {
-        var groupId = "bHGHmlrG6S";
         TestMarkupInGeneral(
             @"Tab group test case
 # [title-a](#tab/a)
@@ -20,20 +19,20 @@ public void Test_General()
 content-b
 - - -",
             $@"<p sourceFile=""Topic.md"" sourceStartLineNumber=""1"">Tab group test case</p>
-<div class=""tabGroup"" id=""tabgroup_{groupId}"" sourceFile=""Topic.md"" sourceStartLineNumber=""2"">
+<div class=""tabGroup"" id=""tabgroup_1"" sourceFile=""Topic.md"" sourceStartLineNumber=""2"">
 <ul role=""tablist"">
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}_a"" role=""tab"" aria-controls=""tabpanel_{groupId}_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""2"">title-a</a>
+<a href=""#tabpanel_1_a"" role=""tab"" aria-controls=""tabpanel_1_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""2"">title-a</a>
 </li>
 <li role=""presentation"" aria-hidden=""true"" hidden=""hidden"">
-<a href=""#tabpanel_{groupId}_b_c"" role=""tab"" aria-controls=""tabpanel_{groupId}_b_c"" data-tab=""b"" data-condition=""c"" tabindex=""-1"" sourceFile=""Topic.md"" sourceStartLineNumber=""4"">title-b</a>
+<a href=""#tabpanel_1_b_c"" role=""tab"" aria-controls=""tabpanel_1_b_c"" data-tab=""b"" data-condition=""c"" tabindex=""-1"" sourceFile=""Topic.md"" sourceStartLineNumber=""4"">title-b</a>
 </li>
 </ul>
-<section id=""tabpanel_{groupId}_a"" role=""tabpanel"" data-tab=""a"">
+<section id=""tabpanel_1_a"" role=""tabpanel"" data-tab=""a"">
 
 <p sourceFile=""Topic.md"" sourceStartLineNumber=""3"">content-a</p>
 </section>
-<section id=""tabpanel_{groupId}_b_c"" role=""tabpanel"" data-tab=""b"" data-condition=""c"" aria-hidden=""true"" hidden=""hidden"">
+<section id=""tabpanel_1_b_c"" role=""tabpanel"" data-tab=""b"" data-condition=""c"" aria-hidden=""true"" hidden=""hidden"">
 
 <p sourceFile=""Topic.md"" sourceStartLineNumber=""5"">content-b</p>
 </section>
@@ -46,7 +45,6 @@ public void Test_General()
     [Trait("Related", "TabGroup")]
     public void Test_TabGroup_Combining()
     {
-        var groupId = "bHGHmlrG6S";
         TestMarkupInGeneral(
             @"# [title-a or b](#tab/a+b)
 content-a or b
@@ -58,36 +56,36 @@ public void Test_TabGroup_Combining()
 # [title-b or c](#tab/b+c)
 content-b or c
 - - -",
-            $@"<div class=""tabGroup"" id=""tabgroup_{groupId}"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">
+            $@"<div class=""tabGroup"" id=""tabgroup_1"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">
 <ul role=""tablist"">
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}_a+b"" role=""tab"" aria-controls=""tabpanel_{groupId}_a+b"" data-tab=""a+b"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">title-a or b</a>
+<a href=""#tabpanel_1_a+b"" role=""tab"" aria-controls=""tabpanel_1_a+b"" data-tab=""a+b"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">title-a or b</a>
 </li>
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}_c"" role=""tab"" aria-controls=""tabpanel_{groupId}_c"" data-tab=""c"" tabindex=""-1"" sourceFile=""Topic.md"" sourceStartLineNumber=""3"">title-c</a>
+<a href=""#tabpanel_1_c"" role=""tab"" aria-controls=""tabpanel_1_c"" data-tab=""c"" tabindex=""-1"" sourceFile=""Topic.md"" sourceStartLineNumber=""3"">title-c</a>
 </li>
 </ul>
-<section id=""tabpanel_{groupId}_a+b"" role=""tabpanel"" data-tab=""a+b"">
+<section id=""tabpanel_1_a+b"" role=""tabpanel"" data-tab=""a+b"">
 <p sourceFile=""Topic.md"" sourceStartLineNumber=""2"">content-a or b</p>
 </section>
-<section id=""tabpanel_{groupId}_c"" role=""tabpanel"" data-tab=""c"" aria-hidden=""true"" hidden=""hidden"">
+<section id=""tabpanel_1_c"" role=""tabpanel"" data-tab=""c"" aria-hidden=""true"" hidden=""hidden"">
 <p sourceFile=""Topic.md"" sourceStartLineNumber=""4"">content-c</p>
 </section>
 </div>
-<div class=""tabGroup"" id=""tabgroup_{groupId}-1"" sourceFile=""Topic.md"" sourceStartLineNumber=""6"">
+<div class=""tabGroup"" id=""tabgroup_2"" sourceFile=""Topic.md"" sourceStartLineNumber=""6"">
 <ul role=""tablist"">
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}-1_a"" role=""tab"" aria-controls=""tabpanel_{groupId}-1_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""6"">title-a</a>
+<a href=""#tabpanel_2_a"" role=""tab"" aria-controls=""tabpanel_2_a"" data-tab=""a"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""6"">title-a</a>
 </li>
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}-1_b+c"" role=""tab"" aria-controls=""tabpanel_{groupId}-1_b+c"" data-tab=""b+c"" tabindex=""-1"" sourceFile=""Topic.md"" sourceStartLineNumber=""8"">title-b or c</a>
+<a href=""#tabpanel_2_b+c"" role=""tab"" aria-controls=""tabpanel_2_b+c"" data-tab=""b+c"" tabindex=""-1"" sourceFile=""Topic.md"" sourceStartLineNumber=""8"">title-b or c</a>
 </li>
 </ul>
-<section id=""tabpanel_{groupId}-1_a"" role=""tabpanel"" data-tab=""a"">
+<section id=""tabpanel_2_a"" role=""tabpanel"" data-tab=""a"">
 
 <p sourceFile=""Topic.md"" sourceStartLineNumber=""7"">content-a</p>
 </section>
-<section id=""tabpanel_{groupId}-1_b+c"" role=""tabpanel"" data-tab=""b+c"" aria-hidden=""true"" hidden=""hidden"">
+<section id=""tabpanel_2_b+c"" role=""tabpanel"" data-tab=""b+c"" aria-hidden=""true"" hidden=""hidden"">
 
 <p sourceFile=""Topic.md"" sourceStartLineNumber=""9"">content-b or c</p>
 </section>
@@ -99,19 +97,18 @@ public void Test_TabGroup_Combining()
     [Fact]
     public void TestTableInTabGroup()
     {
-        var groupId = "bHGHmlrG6S";
         TestMarkupInGeneral(@"# [title](#tab/id)
 
 a | b
 - | -
 c | d",
-$@"<div class=""tabGroup"" id=""tabgroup_{groupId}"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">
+$@"<div class=""tabGroup"" id=""tabgroup_1"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">
 <ul role=""tablist"">
 <li role=""presentation"">
-<a href=""#tabpanel_{groupId}_id"" role=""tab"" aria-controls=""tabpanel_{groupId}_id"" data-tab=""id"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">title</a>
+<a href=""#tabpanel_1_id"" role=""tab"" aria-controls=""tabpanel_1_id"" data-tab=""id"" tabindex=""0"" aria-selected=""true"" sourceFile=""Topic.md"" sourceStartLineNumber=""1"">title</a>
 </li>
 </ul>
-<section id=""tabpanel_{groupId}_id"" role=""tabpanel"" data-tab=""id"">
+<section id=""tabpanel_1_id"" role=""tabpanel"" data-tab=""id"">
 
 <table sourceFile=""Topic.md"" sourceStartLineNumber=""3"">
 <thead>