Dashboard tab with live message counts for all entities by RaoulJacobs · Pull Request #866 · paolosalvatori/ServiceBusExplorer

RaoulJacobs · 2026-04-02T21:11:12Z

Summary

New Dashboard tab showing Active, Dead Letter, Scheduled and Total message counts for all queues and subscriptions at a glance
Auto-refresh with configurable interval (30s / 1min / 5min) and manual Refresh button
Per-row right-click refresh — refresh a single entity without reloading the full namespace
Single-click syncs TreeView selection; double-click opens the entity in the Explorer tab
Color-coded dead-letter alerts: rows with Dead Letter > 0 highlighted in pink
Dashboard rows stay in sync when queues or subscriptions are created or deleted

Dependencies

⚠️ This PR depends on #865 (TreeView search/filter) — please merge that one first. The Dashboard integrates with the filter (clears it on row navigation) and shares changes in MainForm.cs and MainForm.Designer.cs.

Screenshots

Right-click context menu:

Test plan

Dashboard tab loads all queues and subscriptions with correct counts
Auto-refresh updates counts at the configured interval
Single-click on a row selects the matching node in TreeView
Double-click opens the entity in the Explorer tab
Right-click → Refresh updates only the selected row
Creating/deleting a queue or subscription adds/removes the row in Dashboard
Dead-letter > 0 rows are highlighted pink

…-03-29-0950

- Replace stale allChildNodes cache with restore-then-snapshot approach (always restore full node set before re-filtering) - Add 250ms debounce timer on TextChanged to prevent UI stutter - filterSnapshot cleared on tree refresh via InvalidateTreeViewFilter

…tainer Timer was lazily created but never disposed, causing a resource leak. Now created in constructor and registered with components for automatic disposal.

TabControl in Panel2 with Dashboard (default) and Explorer tabs. DashboardControl shows DataGridView with Active/DLQ/Scheduled counts, async loading, refresh button, auto-refresh timer, DLQ color coding.

…disposal - Add isLoading guard to prevent overlapping LoadDataAsync calls - Move writeToLog calls to UI thread (collect errors in Task.Run, log after await) - Extract Font objects to fields, dispose in Dispose(bool) - Revert AssemblyVersion to 1.0.0.1 (upstream test convention)

Replace topic rows (always 0 counts) with subscription rows that show actual Active/DLQ message counts from SubscriptionDescription.

…subscriptions

Filter now also filters child nodes (subscriptions) under topics. When a topic is kept because a child matches, non-matching children are hidden. Child snapshots are restored when filter is cleared.

…ANGELOG/TESTING update

Clicking a row in the Dashboard DataGridView now selects the matching node in the TreeView, scrolls to it, and switches to the Explorer tab. Supports both queue rows and subscription rows (TopicName / SubName).

Ctrl+C copies selected row as TSV, context menu offers Copy row + Copy name.

Root cause: FilterChildNodes only checked direct children text match. Topic structure is Topic → "Subscriptions" container → actual subs. The container node text never matched, so all subscriptions were hidden. Fix: use recursive NodeMatchesFilter + recurse FilterChildNodes into container nodes. RestoreChildNodes also recurses for nested snapshots.

…RowSelected - ContextMenuStrip promoted from local var to field with explicit Dispose() - Added rootNode null check in DashboardRowSelected to prevent NRE before connection

…ested filter fix

…lper class

…tests

…e sync) Dashboard refresh button and auto-refresh timer now trigger ShowEntities(EntityType.All) via OnRefreshRequested callback instead of calling Azure SDK directly. This ensures log panel, TreeView, and dashboard stay in sync through one unified refresh flow.

DashboardControl.UpdateRow() finds and updates one row by entity name. RefreshSelectedEntity() calls it after queue and subscription refresh.

…tcut

- DashboardControl.RemoveRow: removes row by name (case-insensitive) - DashboardControl.RemoveRowsWithPrefix: removes all subscription rows for a topic - DashboardControl.AddRow: idempotent sorted insert with 0 counts - MainForm OnDelete: queue->RemoveRow, topic->RemoveRowsWithPrefix, sub->RemoveRow - MainForm OnCreate: queue->AddRow, subscription->AddRow

ErikMogensen

Got this error:

C:\GitHub\paolosalvatori\ServiceBusExplorer\src\ServiceBusExplorer\Forms\MainForm.cs(250,53,250,73): error CS0234: The type or namespace name 'TreeViewFilterHelper' does not exist in the namespace 'ServiceBusExplorer.Helpers' (are you missing an assembly reference?)

I assume we have to wait until the treeview PR is merged.

…ilterDebounceTimer conflict (keep readonly + constructor init)

RaoulJacobs · 2026-04-05T14:02:10Z

Hi @ErikMogensen, #865 has been merged — rebased this PR on the updated main. The compile error should be gone now. Ready for re-review!

RaoulJacobs · 2026-04-10T13:10:30Z

Hi @ErikMogensen , @SeanFeldman
Still something blocking?

ErikMogensen · 2026-04-13T20:54:06Z

Hi @ErikMogensen , @SeanFeldman Still something blocking?

Yes, as mentioned in this comment #616 (comment) from 2022 the message count operation puts a heavy burden on the Service Bus service. Therefore I just sent an email to the Service Bus Program Management to check if what they said in 2022 still applies.

paolosalvatori · 2026-04-14T06:12:37Z

Thanks @RaoulJacobs for the additions, @ErikMogensen sent an email to the guy who left #616 comment in 2022. If there are no meaningful drawbacks regarding the auto-refresh feature, we'll merge your PR right away. Thanks for the contribution!

RaoulJacobs · 2026-04-14T08:59:22Z

Thanks Paolo!

The auto-refresh is disabled by default — it's a gadget feature, so no meaningful drawbacks and zero impact on existing behavior.

In the meantime I've made a few additional improvements that further align the overall UX. Would you prefer I include them in this PR, or open a separate one?

ErikMogensen · 2026-04-14T19:04:08Z

In the meantime I've made a few additional improvements that further align the overall UX. Would you prefer I include them in this PR, or open a separate one?

Are they closely related to this one? In that case yes please, otherwise no thanks.

The product team hasn't responded about the auto-refresh. I suggest we go for what they wanted in 2022 which was:

Not enabled by default
1 minute as the lowest setting
A warning banner indicating the implication of enabling this and increasing the frequency.

If they reply with a different answer this time we can always fix it.

@RaoulJacobs, please remove the possibility to set it to 30 seconds and add a text stating something like: "Auto refresh affects the performance of the Service Bus resource, especially when set to a high frequency". I hope that text will fit...

I want to start over.

ErikMogensen

Some picky changes to the code and some questions about some files.

ErikMogensen · 2026-04-14T19:17:31Z

It was decided to remove this file.

ErikMogensen · 2026-04-14T19:18:51Z

Please remove this file since we are not using such a file.

ErikMogensen · 2026-04-14T19:19:39Z

Seems that this file is for manual testing of the dashboard. Is that so?

Yes, it was an internal manual test checklist for our own verification during development — not intended for upstream. Removed.

ErikMogensen · 2026-04-14T19:21:04Z

I don't see this file used anywhere. Is the file referencing this missing?

ErikMogensen · 2026-04-14T19:21:08Z

I don't see this file used anywhere. Is the file referencing this missing?

dashboard-tab.png and dashboard-refresh.png are referenced in docs/documentation.md — the Dashboard section uses both images to illustrate the tab and the right-click refresh. dashboard-copy.png was indeed not referenced and has been removed.

ErikMogensen · 2026-04-14T19:21:14Z

I don't see this file used anywhere. Is the file referencing this missing?

dashboard-tab.png and dashboard-refresh.png are referenced in docs/documentation.md — the Dashboard section uses both images to illustrate the tab and the right-click refresh. dashboard-copy.png was indeed not referenced and has been removed.

I don't see docs/documentation.md in this PR, but I guess it was in the other PR.

ErikMogensen · 2026-04-14T19:27:10Z

+            }
+        }
+
+        public async void LoadDataAsync()


Change this to async task LoadDataAsync() for better error handling.

ErikMogensen · 2026-04-14T19:44:26Z

+            if (getQueues == null || getTopics == null || getSubscriptions == null || isLoading) return;
+
+            isLoading = true;


This could be a race condition since there is a gap between the read and the write. Currently that does not occur since this method will be only called from the UI thread, but to be prepared for future code changes please secure it. One way of doing it is:

Change isloading to an int since interlocked does not work with bool.

Change the above code to:

if (getQueues == null || getTopics == null || getSubscriptions == null) return; if (System.Threading.Interlocked.CompareExchange(ref isLoading, 1, 0) != 0) return;

ErikMogensen · 2026-04-14T19:54:18Z

+                Dock = DockStyle.Bottom,
+                AutoSize = false,
+                Height = 20,
+                Font = new Font("Segoe UI", 8F),


Please handle this font in the same way you handle the other fonts, such as headerFont. Assigning it to a field and disposing it.

ErikMogensen · 2026-04-14T20:00:57Z

+            dataGridView.Rows.Clear();
+            foreach (var row in rows.OrderBy(r => r.Type).ThenBy(r => r.Name))
+            {
+                var total = row.Active + row.DeadLetter + row.Scheduled;


total is calculated in two places, here and in UpdateRow. If you add a Total property to DashboardRow it is only done in one place.

…ements Auto-refresh UX: - Remove 30s option; minimum is 1min (1/5/15/30/60min options) - Add warning banner when auto-refresh is enabled Dashboard: - Sync with treeview checkbox: when off, dashboard shows all entities ignoring active filter - Sort preservation: PopulateGrid retains sorted column and direction after refresh - Pending selection fix: clicking dashboard row while filter active + sync off clears filter first, then selects node Code quality (Erik's review): - async void LoadDataAsync -> async Task for proper error handling - isLoading bool -> int with Interlocked.CompareExchange (race condition fix) - DashboardRow.Total as computed property via static ComputeTotal (single source of truth) - hintFont and warningFont as fields, properly disposed - ComboBox width 80 -> 90px, syncWithTreeViewCheckBox position corrected TreeView filter: - Clear button: hidden when empty, visible on input, clears filter on click - Clear button forecolor fix (black text on hover) - ApplyFilter wired to filter text changes and sync checkbox toggle Removed: - docs/img/dashboard-copy.png (unreferenced) - CHANGELOG.md (not used in this project) - tools/version-bump.js (decided to remove)

RaoulJacobs · 2026-04-14T20:44:26Z

Hi @ErikMogensen, addressed all your review comments:

Removed files:

tools/version-bump.js
CHANGELOG.md
TESTING.md (was an internal manual test checklist, not intended for upstream)
docs/img/dashboard-copy.png (unreferenced)

Note: dashboard-tab.png and dashboard-refresh.png are referenced in docs/documentation.md — kept those.

Auto-refresh:

Removed 30s option; minimum is now 1min
Options: 1min / 5min / 15min / 30min / 60min
Added warning banner when auto-refresh is enabled

Code quality:

async void LoadDataAsync → async Task
isLoading bool → int with Interlocked.CompareExchange (race condition fix)
DashboardRow.Total as computed property via static ComputeTotal() (single source of truth for both PopulateGrid and UpdateRow)
hintFont and warningFont as fields, properly disposed

Additional improvements included in this push:

Sync with treeview checkbox: when unchecked, dashboard shows all entities regardless of active filter
Sort preservation: column sort is retained after refresh
TreeView filter clear button (hidden when empty)
Pending selection fix when clicking a dashboard row while filter is active

- Auto-refresh: remove 30s option, add 1/5/15/30/60min intervals - Add warning banner when auto-refresh is enabled - async void LoadDataAsync -> async Task for proper error handling - isLoading bool -> int with Interlocked.CompareExchange (race condition fix) - DashboardRow.Total as computed property via static ComputeTotal helper - hintFont and warningFont as fields, properly disposed - Fix syncWithTreeViewCheckBox position (gap after wider combobox) - Remove tools/version-bump.js, CHANGELOG.md, docs/img/dashboard-copy.png - MainForm.RefreshDashboard: await LoadDataAsync

ErikMogensen

Great!

RaoulJacobs added 30 commits March 29, 2026 09:56

Add search/filter TextBox above TreeView for real-time node filtering

c7a5dd6

task-00: Setup — add CHANGELOG.md and TESTING.md

ccce82e

Merge branch 'feature/search-filter-treeview' into agent/session-2026…

5571724

…-03-29-0950

roundup: Fix timer disposal — move to constructor with components con…

c3964dc

…tainer Timer was lazily created but never disposed, causing a resource leak. Now created in constructor and registered with components for automatic disposal.

roundup: Update CHANGELOG.md and TESTING.md for v1.1.0

8c3f151

Merge branch 'agent/session-2026-03-29-0950'

f74ab97

task-03: Add Dashboard tab with message counts per queue/topic

ac4a826

TabControl in Panel2 with Dashboard (default) and Explorer tabs. DashboardControl shows DataGridView with Active/DLQ/Scheduled counts, async loading, refresh button, auto-refresh timer, DLQ color coding.

roundup: Bump version to 1.2.0 — Dashboard feature + CHANGELOG update

520220c

task-04: Dashboard shows subscriptions instead of topics

05f86f6

Replace topic rows (always 0 counts) with subscription rows that show actual Active/DLQ message counts from SubscriptionDescription.

roundup: Fix per-topic error handling, use ScheduledMessageCount for …

7efbe4d

…subscriptions

Merge branch 'agent/session-2026-03-29-0950'

aa9e13a

task-05: TreeView filter searches inside topic subscriptions

c701ba0

Filter now also filters child nodes (subscriptions) under topics. When a topic is kept because a child matches, non-matching children are hidden. Child snapshots are restored when filter is cleared.

roundup: Bump version to 1.2.2 — subscription filter enhancement + CH…

a3f1b8b

…ANGELOG/TESTING update

Merge branch 'agent/session-2026-03-29-0950'

eb25ee8

task-06: Dashboard row click syncs TreeView selection

f6ea39a

Clicking a row in the Dashboard DataGridView now selects the matching node in the TreeView, scrolls to it, and switches to the Explorer tab. Supports both queue rows and subscription rows (TopicName / SubName).

task-07: Add copy row/name to clipboard in DashboardControl

bac3792

Ctrl+C copies selected row as TSV, context menu offers Copy row + Copy name.

roundup: Fix ContextMenuStrip disposal leak + null guard on Dashboard…

6234ea7

…RowSelected - ContextMenuStrip promoted from local var to field with explicit Dispose() - Added rootNode null check in DashboardRowSelected to prevent NRE before connection

roundup: Bump version to 1.3.0 — dashboard navigation + clipboard + n…

203b342

…ested filter fix

Merge branch 'agent/session-2026-03-29-0950'

90d2ad3

task-09: Extract TreeView filter logic into testable TreeViewFilterHe…

e2f4002

…lper class

roundup: Bump version to 1.3.1 — TreeViewFilterHelper extract + unit …

49dea59

…tests

Merge branch 'agent/session-2026-03-29-0950'

b4f214e

task-11: Single node refresh updates dashboard row

9de6a25

DashboardControl.UpdateRow() finds and updates one row by entity name. RefreshSelectedEntity() calls it after queue and subscription refresh.

task-12: InvalidateTreeViewFilter in OnCreate/OnDelete finally blocks

1ce1d0a

task-13: Ctrl+F keyboard shortcut focuses filter box

e23a7fc

roundup: Bump version to 1.3.2 — dashboard refresh sync + Ctrl+F shor…

a12bf88

…tcut

RaoulJacobs added 7 commits March 30, 2026 14:02

task-22: Hint label below dashboard grid explains click behavior

91e54a5

roundup: Bump version to 1.4.2 — Dashboard hint label + double-click fix

2cee767

merge: session 2026-03-29/30 — dashboard UX improvements v1.4.2

c01836c

docs: add TreeView filter, Dashboard and Copy Body documentation

b61d309

docs: add feature screenshots (dashboard, treeview filter)

f94e81a

merge: B-14 dashboard sync + docs + screenshots

09a1ca1

RaoulJacobs requested review from ErikMogensen, SeanFeldman and paolosalvatori as code owners April 2, 2026 21:11

ErikMogensen previously requested changes Apr 4, 2026

View reviewed changes

merge: upstream/main (TreeView filter paolosalvatori#865) — resolve f…

673e730

…ilterDebounceTimer conflict (keep readonly + constructor init)

RaoulJacobs force-pushed the pr/dashboard branch from 173d035 to 673e730 Compare April 5, 2026 14:01

SeanFeldman mentioned this pull request Apr 7, 2026

feat: add version-bump.js for automated version management #864

Closed

3 tasks

ErikMogensen self-requested a review April 14, 2026 18:46

ErikMogensen requested changes Apr 14, 2026

View reviewed changes

ErikMogensen changed the title ~~feat: Dashboard tab with live message counts for all entities~~ Dashboard tab with live message counts for all entities Apr 14, 2026

ErikMogensen added the Feature label Apr 14, 2026

ErikMogensen approved these changes Apr 14, 2026

View reviewed changes

SeanFeldman merged commit 4be2685 into paolosalvatori:main Apr 14, 2026
1 check passed

		if (getQueues == null \|\| getTopics == null \|\| getSubscriptions == null \|\| isLoading) return;

		isLoading = true;

Conversation

RaoulJacobs commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Dependencies

Screenshots

Test plan

Uh oh!

ErikMogensen left a comment

Choose a reason for hiding this comment

Uh oh!

RaoulJacobs commented Apr 5, 2026

Uh oh!

RaoulJacobs commented Apr 10, 2026

Uh oh!

ErikMogensen commented Apr 13, 2026

Uh oh!

paolosalvatori commented Apr 14, 2026

Uh oh!

RaoulJacobs commented Apr 14, 2026

Uh oh!

ErikMogensen commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ErikMogensen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RaoulJacobs commented Apr 14, 2026

Uh oh!

ErikMogensen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

RaoulJacobs commented Apr 2, 2026 •

edited

Loading

ErikMogensen commented Apr 14, 2026 •

edited

Loading