Skip to content

UX improvements - #35

Merged
CamiloSierraH merged 12 commits into
mainfrom
ugosan/ux-1
Sep 29, 2026
Merged

CamiloSierraH merged 12 commits into
mainfrom
ugosan/ux-1

Conversation

@ugosan

@ugosan ugosan commented Sep 28, 2026

Copy link
Copy Markdown
Contributor
Screen.Recording.2026-09-28.at.11.35.36.AM.mov

This PR builds upon main and cami/schema-dependency-graph and adds small changes to the UX of the Dashboard

  • Section navigation is a fixed left sidebar instead of a horizontal strip under the header. The sidebar lists every section, highlights the one being read, and keeps that link scrolled into view.
  • Arrow to hide/show it. The chevron at the left of the header collapses the sidebar and the content takes the width back. While collapsed, the button shows the current section's name.
  • Narrow screens (under 900px) start collapsed; when shown there the sidebar overlays the content and picking a section hides it again. Reduced-motion disables the slide; print hides the sidebar.
  • Header lockup: "ClickHouse" on the first line, "Diagnostic Dashboard" as a smaller second line.
  • Mode badge moved next to the version on the right, so it reads [cloud] Version: 26.6.2191.
  • Scroll spy, --topbar-h measurement and anchor offsets are unchanged; the sidebar hangs from the same measured header height.

@CLAassistant

CLAassistant commented Sep 28, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Critical redaction and schema-graph correctness issues, plus preview and documentation fixes, remain unresolved.

Review effort: Lite
Findings: 2 High severity · 2 Medium severity · 1 Low severity

Open (5)
What changed in this PR

This PR improves dashboard navigation and adds schema-graph collection, rendering, redaction, and related diagnostics.

Changes:

  • Adds a responsive collapsible sidebar and updated dashboard header.
  • Adds schema graph, refreshable-view, index, and metadata collectors.
  • Adds SQL/JSONL redaction, cloud configuration handling, previews, tests, and documentation.

Review findings:

  • Makefile — moderate (3 votes): preview target omits the schema graph test and generated-file output.
  • README.md — nit (1 vote): qualify schema graph availability when no readable user objects exist.
  • internal/collection/sqlredact.go — critical (1 vote): raw substring matching can miss sensitive JSON fields.
  • internal/collection/sqlredact.go — critical (1 vote): SQL scanning does not skip all quoted regions and comments.
  • internal/dashboard/generator.go — nit (2 votes): print mode retains an unnecessary sidebar gutter.
  • internal/dashboard/generator.go — moderate (1 vote): generated HTML contains duplicate doctypes.
  • internal/dashboard/schema_graph.go — moderate (3 votes): cloud dictionary data is not aggregated across replicas.
  • internal/dashboard/schema_graph.go — moderate (1 vote): system dictionaries are not filtered from the graph.
File Description
skills/​clickhouse-diagnostic/​references/​health-checks.md Documents refreshable-view health checks.
skills/​clickhouse-diagnostic/​references/​file-guide.md Documents new schema evidence.
skills/​clickhouse-diagnostic/​references/​bundle-layout.md Documents graph output and redaction changes.
README.md Documents schema graph, UX, and collection behavior.
queries.onprem/​system.tables.sql Collects table metadata.
queries.onprem/​system.data_skipping_indices.sql Collects skip-index metadata.
queries.onprem/​system.columns.sql Collects column key flags.
queries.onprem/​26.6.1.0/​system.tables.sql Adds materialized-view target metadata.
queries.onprem/​25.4.1.0/​system.tables.sql Adds table metadata.
queries.onprem/​24.2.1.0/​system.tables.sql Adds table metadata.
queries.onprem/​23.12.1.0/​system.view_refreshes.sql Collects refreshable-view state.
queries.gov/​system.tables.sql Adds hashed schema relationships.
queries.gov/​system.data_skipping_indices.sql Adds redacted skip-index data.
queries.gov/​system.columns.sql Adds hashed column flags.
queries.gov/​26.6.1.0/​system.tables.sql Adds hashed view-target metadata.
queries.gov/​24.2.1.0/​system.tables.sql Adds hashed table relationships.
queries.gov/​23.12.1.0/​system.view_refreshes.sql Adds redacted refresh state.
queries.cloud/​system.tables.sql Collects cloud table metadata.
queries.cloud/​system.data_skipping_indices.sql Collects cloud skip-index metadata.
queries.cloud/​system.columns.sql Collects cloud column flags.
queries.cloud/​26.6.1.0/​system.tables.sql Adds cloud view-target metadata.
queries.cloud/​25.4.1.0/​system.tables.sql Adds cloud table metadata.
queries.cloud/​24.2.1.0/​system.tables.sql Adds cloud table metadata.
queries.cloud/​23.12.1.0/​system.view_refreshes.sql Collects replica refresh state.
Makefile Updates dashboard preview targets.
internal/​query/​versioned_test.go Tests versioned refresh queries.
internal/​query/​redact_hook_test.go Tests collector redaction hooks.
internal/​query/​gov_leak_test.go Tests government-mode hashing.
internal/​query/​executor.go Redacts collector results.
internal/​dashboard/​theme_test.go Updates dashboard header tests.
internal/​dashboard/​schema_graph.go Implements schema graph generation.
internal/​dashboard/​schema_graph_test.go Tests graph rendering and behavior.
internal/​dashboard/​nav_spy_test.go Tests sidebar navigation.
internal/​dashboard/​keeper_preview_test.go Adds graph data to previews.
internal/​dashboard/​generator.go Adds graph integration and sidebar UX.
internal/​dashboard/​files_panel_test.go Excludes the graph from file listings.
internal/​collection/​sqlredact.go Implements SQL and JSONL credential redaction.
internal/​collection/​sqlredact_test.go Tests redaction behavior.
internal/​collection/​heuristics.go Generalizes redaction tokens.
cmd/​main.go Adjusts cloud configuration collection.
cmd/​local_collector_test.go Tests cloud configuration behavior.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread internal/collection/sqlredact.go
Comment thread internal/collection/sqlredact.go Outdated
Comment thread Makefile Outdated
Comment thread internal/dashboard/schema_graph.go Outdated
Comment thread internal/dashboard/generator.go Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@CamiloSierraH CamiloSierraH left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@CamiloSierraH
CamiloSierraH merged commit d10589e into main Sep 29, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants