Skip to content

fix: inconsistent time ticks#2984

Merged
chronark merged 1 commit intomainfrom
ENG-1666
Mar 18, 2025
Merged

fix: inconsistent time ticks#2984
chronark merged 1 commit intomainfrom
ENG-1666

Conversation

@ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Mar 18, 2025

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features
    • Tooltips across charts now display consistently formatted numbers for enhanced readability.
    • Timeseries visualizations feature refined granularity settings, offering more precise data insights.
    • Adjusted data intervals help ensure a more comprehensive representation of timeseries information.

@linear
Copy link

linear bot commented Mar 18, 2025

@vercel
Copy link

vercel bot commented Mar 18, 2025

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 18, 2025 2:13pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 18, 2025 2:13pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 18, 2025 2:13pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 18, 2025 2:13pm

@changeset-bot
Copy link

changeset-bot bot commented Mar 18, 2025

⚠️ No Changeset found

Latest commit: 804671a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2025

Thank you for following the naming conventions for pull request titles! 🙏

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 18, 2025

📝 Walkthrough

Walkthrough

This pull request updates tooltip displays in dashboard components to apply number formatting using the formatNumber function. Additionally, it adjusts the granularity settings for time series data based on specific time ranges. In several ClickHouse modules, the SQL queries generating time series data have been modified to include an additional offset (${stepMs}) when calculating the upper bound of the time interval. No changes were made to the exported public APIs across these updates.

Changes

File(s) Change Summary
apps/dashboard/components/.../overview-bar-chart.tsx, apps/dashboard/components/.../stats-chart.tsx Updated tooltip display logic to format numerical values using the formatNumber function.
apps/dashboard/lib/.../granularity.ts Modified granularity assignments in the getTimeseriesGranularity function for various time ranges.
internal/clickhouse/src/keys/active_keys.ts, internal/clickhouse/src/logs.ts, internal/clickhouse/src/ratelimits.ts, internal/clickhouse/src/verifications.ts Adjusted SQL queries to extend the upper time interval by adding a ${stepMs} offset and, where applicable, updated interval unit usage.

Sequence Diagram(s)

sequenceDiagram
    participant UI
    participant Component
    participant Formatter
    UI->>Component: Hover to display tooltip
    Component->>Formatter: Call formatNumber(value)
    Formatter-->>Component: Return formatted value
    Component-->>UI: Render tooltip with formatted value
Loading
sequenceDiagram
    participant App
    participant QueryBuilder
    participant DB
    App->>QueryBuilder: Request time series query
    QueryBuilder->>QueryBuilder: Compute upper bound (includes ${stepMs} offset)
    QueryBuilder-->>App: Return SQL query with updated interval
    App->>DB: Execute query
Loading

Possibly related PRs

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

  • mcstepp
  • perkinsjr
  • chronark
  • MichaelUnkey

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between efe7661 and 804671a.

📒 Files selected for processing (7)
  • apps/dashboard/components/logs/overview-charts/overview-bar-chart.tsx (2 hunks)
  • apps/dashboard/components/stats-card/components/chart/stats-chart.tsx (2 hunks)
  • apps/dashboard/lib/trpc/routers/utils/granularity.ts (2 hunks)
  • internal/clickhouse/src/keys/active_keys.ts (1 hunks)
  • internal/clickhouse/src/logs.ts (1 hunks)
  • internal/clickhouse/src/ratelimits.ts (1 hunks)
  • internal/clickhouse/src/verifications.ts (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
apps/dashboard/lib/trpc/routers/utils/granularity.ts (1)
apps/dashboard/lib/trpc/routers/utils/constants.ts (2) (2)
  • WEEK_IN_MS (3:3)
  • HOUR_IN_MS (1:1)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Test Go API Local / Test
  • GitHub Check: Build / Build
  • GitHub Check: Test API / API Test Local
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (9)
apps/dashboard/components/stats-card/components/chart/stats-chart.tsx (2)

10-10: Good enhancement: Added number formatting

Adding the formatNumber import provides more consistent number formatting for tooltip values.


91-91: Applying number formatting improves readability

Using formatNumber for tooltip values makes numbers more readable, especially for larger values.

apps/dashboard/lib/trpc/routers/utils/granularity.ts (2)

92-92: Good refinement: Improved granularity for weekly time ranges

Changing the granularity from multi-hour intervals to hourly intervals for week-based time ranges provides more consistent and detailed data points.

Also applies to: 94-94


108-108: Good refinement: Improved granularity for hourly time ranges

Increasing the granularity for hour-based time ranges (12h, 6h, 4h) from hourly/half-hourly to more frequent intervals (30min, 5min) provides finer resolution data points.

Also applies to: 112-112, 114-114

apps/dashboard/components/logs/overview-charts/overview-bar-chart.tsx (1)

214-214: Consistent application of number formatting

Using formatNumber for all numerical values in tooltips ensures consistent presentation across the dashboard components.

Also applies to: 238-238

internal/clickhouse/src/logs.ts (1)

296-296: Fixed inconsistent time ticks by extending the time interval.

The addition of + ${stepMs} to the upper bound of the time interval ensures that the last data point is properly included in the timeseries results. This change is consistent with similar fixes in other ClickHouse query files and addresses the inconsistent time ticks issue mentioned in the PR title.

internal/clickhouse/src/ratelimits.ts (1)

129-129: Fixed inconsistent time ticks and corrected interval unit variable.

This change makes two important fixes:

  1. Adds + ${stepMs} to extend the upper bound of the time interval, ensuring all data points are included
  2. Replaces ${interval.step} with ${intervalUnit}, which is the correct variable containing the proper ClickHouse interval unit mapping

Both changes help ensure consistent time ticks in the query results.

internal/clickhouse/src/keys/active_keys.ts (1)

155-155: Fixed inconsistent time ticks by extending the time interval.

The addition of + ${stepMs} to the upper bound ensures that the last data point is properly included in the timeseries results. This change is consistent with similar fixes in other ClickHouse query files and addresses the inconsistent time ticks issue.

internal/clickhouse/src/verifications.ts (1)

296-296: Fixed inconsistent time ticks by extending the time interval.

The addition of + ${stepMs} to the upper bound ensures that the last data point is properly included in the timeseries results. This change is consistent with similar fixes in other ClickHouse query files and addresses the inconsistent time ticks issue.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@chronark chronark added this pull request to the merge queue Mar 18, 2025
Merged via the queue into main with commit a2b4258 Mar 18, 2025
30 of 31 checks passed
@chronark chronark deleted the ENG-1666 branch March 18, 2025 15:24
@coderabbitai coderabbitai bot mentioned this pull request Mar 19, 2025
18 tasks
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