priority queue implementation (#573)

gvreddy04 · web-flow · commit 22a2a9bf5d37 · 2024-02-19T10:02:00.000+05:30
* Implement priority queues.
diff --git a/blazorbootstrap/Components/Alert/Alert.razor.cs b/blazorbootstrap/Components/Alert/Alert.razor.cs
@@ -48,7 +48,7 @@ protected override async Task OnInitializedAsync()
         objRef ??= DotNetObjectReference.Create(this);
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.alert.initialize", ElementId, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.alert.initialize", ElementId, objRef), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/Button/Button.razor.cs b/blazorbootstrap/Components/Button/Button.razor.cs
@@ -103,7 +103,7 @@ protected override void OnInitialized()
 
         base.OnInitialized();
 
-        if (!string.IsNullOrWhiteSpace(TooltipTitle)) QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.tooltip.initialize", ElementRef); });
+        if (!string.IsNullOrWhiteSpace(TooltipTitle)) QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.tooltip.initialize", ElementRef), new RenderPriority());
     }
 
     protected override async Task OnParametersSetAsync()
diff --git a/blazorbootstrap/Components/Collapse/Collapse.razor.cs b/blazorbootstrap/Components/Collapse/Collapse.razor.cs
@@ -46,7 +46,7 @@ protected override async Task OnInitializedAsync()
     {
         objRef ??= DotNetObjectReference.Create(this);
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.collapse.initialize", ElementId, Parent, Toggle, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.collapse.initialize", ElementId, Parent, Toggle, objRef), new RenderPriority());
 
         await base.OnInitializedAsync();
     }
diff --git a/blazorbootstrap/Components/Core/BlazorBootstrapComponentBase.cs b/blazorbootstrap/Components/Core/BlazorBootstrapComponentBase.cs
@@ -55,7 +55,7 @@ public abstract class BlazorBootstrapComponentBase : ComponentBase, IDisposable,
     /// <summary>
     /// A stack of functions to execute after the rendering.
     /// </summary>
-    private Queue<Func<Task>>? renderQueue;
+    private PriorityQueue<Func<Task>, RenderPriority>? renderQueue;
 
     #endregion
 
@@ -248,10 +248,11 @@ protected virtual ValueTask DisposeAsync(bool disposing)
     /// Pushes an action to the stack to be executed after the rendering is done.
     /// </summary>
     /// <param name="action"></param>
-    protected void QueueAfterRenderAction(Func<Task> action)
+    /// <param name="renderPriority"></param>
+    protected void QueueAfterRenderAction(Func<Task> action, RenderPriority renderPriority)
     {
-        renderQueue ??= new Queue<Func<Task>>();
-        renderQueue.Enqueue(action);
+        renderQueue ??= new PriorityQueue<Func<Task>, RenderPriority>();
+        renderQueue.Enqueue(action, renderPriority);
     }
 
     #endregion
@@ -385,6 +386,6 @@ public string? StyleNames
             return styleNames;
         }
     }
-
+    
     #endregion
 }
diff --git a/blazorbootstrap/Components/Dropdown/Dropdown.razor.cs b/blazorbootstrap/Components/Dropdown/Dropdown.razor.cs
@@ -46,7 +46,7 @@ protected override void OnInitialized()
 
         base.OnInitialized();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.dropdown.initialize", ElementId, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.dropdown.initialize", ElementId, objRef), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/Form/AutoComplete/AutoComplete.razor.cs b/blazorbootstrap/Components/Form/AutoComplete/AutoComplete.razor.cs
@@ -66,7 +66,7 @@ protected override async Task OnInitializedAsync()
 
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.autocomplete.initialize", ElementRef, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.autocomplete.initialize", ElementRef, objRef), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/Modals/Modal.razor.cs b/blazorbootstrap/Components/Modals/Modal.razor.cs
@@ -72,7 +72,7 @@ protected override async Task OnInitializedAsync()
         objRef ??= DotNetObjectReference.Create(this);
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.modal.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.modal.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, objRef), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/Offcanvas/Offcanvas.razor.cs b/blazorbootstrap/Components/Offcanvas/Offcanvas.razor.cs
@@ -56,7 +56,7 @@ protected override async Task OnInitializedAsync()
         objRef ??= DotNetObjectReference.Create(this);
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.offcanvas.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, IsScrollable, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.offcanvas.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, IsScrollable, objRef), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/PdfViewer/PdfViewer.razor.cs b/blazorbootstrap/Components/PdfViewer/PdfViewer.razor.cs
@@ -28,7 +28,7 @@ protected override async Task OnInitializedAsync()
         objRef ??= DotNetObjectReference.Create(this);
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => await PdfViewerJsInterop.InitializeAsync(objRef!, ElementId!, scale, rotation, Url!));
+        QueueAfterRenderAction(async () => await PdfViewerJsInterop.InitializeAsync(objRef!, ElementId!, scale, rotation, Url!), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/ScriptLoader/ScriptLoader.razor.cs b/blazorbootstrap/Components/ScriptLoader/ScriptLoader.razor.cs
@@ -25,7 +25,7 @@ protected override async Task OnInitializedAsync()
     {
         objRef ??= DotNetObjectReference.Create(this);
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.scriptLoader.initialize", ElementId, Async, ScriptId, Source, type, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.scriptLoader.initialize", ElementId, Async, ScriptId, Source, type, objRef), new RenderPriority());
 
         await base.OnInitializedAsync();
     }
diff --git a/blazorbootstrap/Components/Sidebar/Sidebar.razor.cs b/blazorbootstrap/Components/Sidebar/Sidebar.razor.cs
@@ -48,7 +48,7 @@ protected override async Task OnInitializedAsync()
 
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.sidebar.initialize", ElementId, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.sidebar.initialize", ElementId, objRef), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/Tabs/Tabs.razor.cs b/blazorbootstrap/Components/Tabs/Tabs.razor.cs
@@ -55,7 +55,7 @@ protected override async Task OnInitializedAsync()
 
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.tabs.initialize", ElementId, objRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.tabs.initialize", ElementId, objRef), new RenderPriority());
     }
 
     [JSInvokable]
@@ -118,7 +118,8 @@ public void InitializeRecentTab(bool showTab)
                     if (showTab)
                         await ShowTabAsync(tab);
                 }
-            }
+            },
+            new RenderPriority()
         );
     }
 
diff --git a/blazorbootstrap/Components/Toasts/SimpleToast.razor.cs b/blazorbootstrap/Components/Toasts/SimpleToast.razor.cs
@@ -41,7 +41,7 @@ protected override async Task OnInitializedAsync()
 
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await ShowAsync(); });
+        QueueAfterRenderAction(async () => await ShowAsync(), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/Toasts/Toast.razor.cs b/blazorbootstrap/Components/Toasts/Toast.razor.cs
@@ -78,7 +78,7 @@ protected override async Task OnInitializedAsync()
         objRef ??= DotNetObjectReference.Create(this);
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await ShowAsync(); });
+        QueueAfterRenderAction(async () => await ShowAsync(), new RenderPriority());
     }
 
     [JSInvokable]
diff --git a/blazorbootstrap/Components/Tooltip/Tooltip.razor.cs b/blazorbootstrap/Components/Tooltip/Tooltip.razor.cs
@@ -50,7 +50,7 @@ protected override async Task OnInitializedAsync()
 
         await base.OnInitializedAsync();
 
-        QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.tooltip.initialize", ElementRef); });
+        QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.tooltip.initialize", ElementRef), new RenderPriority());
     }
 
     protected override async Task OnParametersSetAsync()
diff --git a/blazorbootstrap/Enums/Priority.cs b/blazorbootstrap/Enums/Priority.cs
@@ -0,0 +1,8 @@
+﻿namespace BlazorBootstrap;
+
+public enum Priority
+{
+    High = 0,
+    Medium,
+    Low
+}
diff --git a/blazorbootstrap/Models/RenderPriority.cs b/blazorbootstrap/Models/RenderPriority.cs
@@ -0,0 +1,19 @@
+﻿namespace BlazorBootstrap;
+
+public record RenderPriority
+{
+    public RenderPriority()
+    {
+        Priority = Priority.Low;
+        Order = DateTime.Now.Ticks;
+    }
+
+    public RenderPriority(Priority priority)
+    {
+        Priority = priority;
+    }
+
+    public Priority Priority { get; init; }
+
+    public long Order { get; init; }
+}

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ protected override async Task OnInitializedAsync()`
`48`	`48`	`objRef ??= DotNetObjectReference.Create(this);`
`49`	`49`	`await base.OnInitializedAsync();`
`50`	`50`
`51`		`- QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.alert.initialize", ElementId, objRef); });`
	`51`	`+ QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.alert.initialize", ElementId, objRef), new RenderPriority());`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`[JSInvokable]`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ protected override void OnInitialized()`
`103`	`103`
`104`	`104`	`base.OnInitialized();`
`105`	`105`
`106`		`- if (!string.IsNullOrWhiteSpace(TooltipTitle)) QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.tooltip.initialize", ElementRef); });`
	`106`	`+ if (!string.IsNullOrWhiteSpace(TooltipTitle)) QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.tooltip.initialize", ElementRef), new RenderPriority());`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`protected override async Task OnParametersSetAsync()`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ protected override async Task OnInitializedAsync()`
`46`	`46`	`{`
`47`	`47`	`objRef ??= DotNetObjectReference.Create(this);`
`48`	`48`
`49`		`- QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.collapse.initialize", ElementId, Parent, Toggle, objRef); });`
	`49`	`+ QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.collapse.initialize", ElementId, Parent, Toggle, objRef), new RenderPriority());`
`50`	`50`
`51`	`51`	`await base.OnInitializedAsync();`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public abstract class BlazorBootstrapComponentBase : ComponentBase, IDisposable,`
`55`	`55`	`/// <summary>`
`56`	`56`	`/// A stack of functions to execute after the rendering.`
`57`	`57`	`/// </summary>`
`58`		`- private Queue<Func<Task>>? renderQueue;`
	`58`	`+ private PriorityQueue<Func<Task>, RenderPriority>? renderQueue;`
`59`	`59`
`60`	`60`	`#endregion`
`61`	`61`
`@@ -248,10 +248,11 @@ protected virtual ValueTask DisposeAsync(bool disposing)`
`248`	`248`	`/// Pushes an action to the stack to be executed after the rendering is done.`
`249`	`249`	`/// </summary>`
`250`	`250`	`/// <param name="action"></param>`
`251`		`- protected void QueueAfterRenderAction(Func<Task> action)`
	`251`	`+ /// <param name="renderPriority"></param>`
	`252`	`+ protected void QueueAfterRenderAction(Func<Task> action, RenderPriority renderPriority)`
`252`	`253`	`{`
`253`		`- renderQueue ??= new Queue<Func<Task>>();`
`254`		`- renderQueue.Enqueue(action);`
	`254`	`+ renderQueue ??= new PriorityQueue<Func<Task>, RenderPriority>();`
	`255`	`+ renderQueue.Enqueue(action, renderPriority);`
`255`	`256`	`}`
`256`	`257`
`257`	`258`	`#endregion`
`@@ -385,6 +386,6 @@ public string? StyleNames`
`385`	`386`	`return styleNames;`
`386`	`387`	`}`
`387`	`388`	`}`
`388`		`-`
	`389`	`+`
`389`	`390`	`#endregion`
`390`	`391`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ protected override void OnInitialized()`
`46`	`46`
`47`	`47`	`base.OnInitialized();`
`48`	`48`
`49`		`- QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.dropdown.initialize", ElementId, objRef); });`
	`49`	`+ QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.dropdown.initialize", ElementId, objRef), new RenderPriority());`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`[JSInvokable]`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ protected override async Task OnInitializedAsync()`
`66`	`66`
`67`	`67`	`await base.OnInitializedAsync();`
`68`	`68`
`69`		`- QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.autocomplete.initialize", ElementRef, objRef); });`
	`69`	`+ QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.autocomplete.initialize", ElementRef, objRef), new RenderPriority());`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`[JSInvokable]`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ protected override async Task OnInitializedAsync()`
`72`	`72`	`objRef ??= DotNetObjectReference.Create(this);`
`73`	`73`	`await base.OnInitializedAsync();`
`74`	`74`
`75`		`- QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.modal.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, objRef); });`
	`75`	`+ QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.modal.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, objRef), new RenderPriority());`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`[JSInvokable]`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ protected override async Task OnInitializedAsync()`
`56`	`56`	`objRef ??= DotNetObjectReference.Create(this);`
`57`	`57`	`await base.OnInitializedAsync();`
`58`	`58`
`59`		`- QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.offcanvas.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, IsScrollable, objRef); });`
	`59`	`+ QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.offcanvas.initialize", ElementId, UseStaticBackdrop, CloseOnEscape, IsScrollable, objRef), new RenderPriority());`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`[JSInvokable]`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ protected override async Task OnInitializedAsync()`
`28`	`28`	`objRef ??= DotNetObjectReference.Create(this);`
`29`	`29`	`await base.OnInitializedAsync();`
`30`	`30`
`31`		`- QueueAfterRenderAction(async () => await PdfViewerJsInterop.InitializeAsync(objRef!, ElementId!, scale, rotation, Url!));`
	`31`	`+ QueueAfterRenderAction(async () => await PdfViewerJsInterop.InitializeAsync(objRef!, ElementId!, scale, rotation, Url!), new RenderPriority());`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`[JSInvokable]`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ protected override async Task OnInitializedAsync()`
`25`	`25`	`{`
`26`	`26`	`objRef ??= DotNetObjectReference.Create(this);`
`27`	`27`
`28`		`- QueueAfterRenderAction(async () => { await JS.InvokeVoidAsync("window.blazorBootstrap.scriptLoader.initialize", ElementId, Async, ScriptId, Source, type, objRef); });`
	`28`	`+ QueueAfterRenderAction(async () => await JS.InvokeVoidAsync("window.blazorBootstrap.scriptLoader.initialize", ElementId, Async, ScriptId, Source, type, objRef), new RenderPriority());`
`29`	`29`
`30`	`30`	`await base.OnInitializedAsync();`
`31`	`31`	`}`