Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update overview charts layout and enhance UI components #429

Merged
merged 1 commit into from
Nov 24, 2024

Conversation

duyet
Copy link
Owner

@duyet duyet commented Nov 24, 2024

Summary by Sourcery

Update the layout of overview charts and enhance UI components for improved user experience and visual clarity.

New Features:

  • Add a link to the Tables Overview in the database table count component.

Enhancements:

  • Improve the layout of the overview charts by adjusting grid column settings and adding dotted borders for better visual separation.
  • Enhance UI components by modifying text alignment, visibility of SQL buttons, and color settings for better user experience.

Copy link

vercel bot commented Nov 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clickhouse-monitoring ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 24, 2024 3:58pm

Copy link
Contributor

sourcery-ai bot commented Nov 24, 2024

Reviewer's Guide by Sourcery

This PR updates the layout and enhances UI components across several pages, focusing on improving the overview charts layout and query detail information display. The changes include better visual organization of database table counts, enhanced query detail information with more descriptive labels, and improved layout responsiveness.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Redesigned the database table count component layout
  • Added a 'Tables Overview' link at the top of the card
  • Improved layout of count items with dotted separator lines
  • Modified the SQL button visibility behavior to use 'hidden/inline' instead of opacity
  • Restructured the link and content layout for better alignment
components/overview-charts/database-table-count.tsx
Enhanced query detail information display and data fetching
  • Added cache control setting for query execution
  • Added new interface_query_initial_from field
  • Updated field labels with more detailed descriptions
  • Improved the organization of query metadata display
app/[host]/query/[query_id]/query-detail.tsx
app/[host]/query/[query_id]/config.ts
Updated visual styling and layout of overview components
  • Changed chart color scheme in running queries component
  • Modified text styling for better readability
  • Added dotted separator lines in info displays
  • Updated grid layout for overview charts
components/overview-charts/running-queries.tsx
components/overview-charts/clickhouse-info.tsx
app/[host]/overview/overview-charts.tsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codecov-commenter
Copy link

codecov-commenter commented Nov 24, 2024

Bundle Report

Changes will increase total bundle size by 799 bytes (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
clickhouse-monitoring-bundle-server-cjs 2.55MB 757 bytes (0.03%) ⬆️
clickhouse-monitoring-bundle-edge-server-array-push 128.52kB 6 bytes (-0.0%) ⬇️
clickhouse-monitoring-bundle-client-array-push 3.79MB 48 bytes (0.0%) ⬆️

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @duyet - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Could you explain the reasoning behind disabling the query cache with use_query_cache: 0? This might impact performance for repeated queries.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -87,36 +94,38 @@ async function LinkCount({
return (
<div
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (complexity): Consider restructuring the component layout using CSS grid for better organization

The component structure can be simplified using CSS grid while maintaining the same visual design and semantic separation. Here's a suggested approach:

<div
  className={cn(
    'group grid w-full grid-cols-[auto_1fr_auto_auto] items-center gap-2 p-1 opacity-80 hover:opacity-100',
    className
  )}
>
  <div className="text-3xl font-bold">
    <span className="p-0">{data[0].count}</span>
  </div>

  <hr className="border-dotted" />

  <Link href={await getScopedLink(href)}>
    <div className="inline-flex gap-1 truncate text-xs text-muted-foreground">
      {icon} {label}</div>
  </Link>

  <DialogSQL
    sql={query}
    description=""
    button={
      <Button
        variant="outline"
        className="hidden h-fit border-0 p-2 shadow-none group-hover:inline"
        aria-label="Show SQL"
        title="SQL of this"
      >
        <CodeIcon className="size-3" />
      </Button>
    }
    contentClassName="max-w-screen-lg"
  />
</div>

This change:

  • Uses CSS grid to create a 4-column layout (count, line, link, button)
  • Removes unnecessary nested div wrappers
  • Maintains the semantic separation of elements
  • Preserves all functionality and visual design

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.34%. Comparing base (ff9c5fd) to head (4d3fd0c).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #429   +/-   ##
=======================================
  Coverage   78.34%   78.34%           
=======================================
  Files           5        5           
  Lines         157      157           
  Branches       58       58           
=======================================
  Hits          123      123           
- Misses         31       34    +3     
+ Partials        3        0    -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@duyet duyet merged commit 97c0ac5 into main Nov 24, 2024
28 checks passed
@duyet duyet deleted the chore/ui-update branch November 24, 2024 16:13
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.

2 participants