fix: tooltip showing wrong time interval by ogzhanolguncu · Pull Request #3189 · unkeyed/unkey

ogzhanolguncu · 2025-04-24T11:12:22Z

What does this PR do?

MERGE THIS AFTER #3187

When you hover over chart tooltips this PR will prevent showing wrong timestamp. This timestamp should match data points under chart and timestamp on log data.

Fixes #3188

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

Appreciated

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

BEFORE

AFTER

Summary by CodeRabbit

Enhancements
- Improved timestamp formatting in chart tooltips for greater consistency, now displaying times in "HH:mm" format across all relevant charts.
Refactor
- Simplified and standardized internal logic for formatting timestamps in chart tooltips, ensuring uniform display and removing unnecessary conditional logic.

linear · 2025-04-24T11:12:25Z

ENG-1773 Chart tooltip shows incorrect time range for last record

changeset-bot · 2025-04-24T11:12:26Z

⚠️ No Changeset found

Latest commit: 3b558bf

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

vercel · 2025-04-24T11:12:27Z

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	Apr 29, 2025 9:09pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 29, 2025 9:09pm

coderabbitai · 2025-04-24T11:12:29Z

📝 Walkthrough

"""

Walkthrough

The changes update the logic for formatting timestamps in chart tooltips within the dashboard logs components. The timestamp formatting function now directly uses the date-fns library for formatting, and its interface is extended to accept a customizable time format string. The tooltip label formatter is updated to use this new capability. Additionally, timezone offset adjustments in the timestamp formatting utility are removed, simplifying the handling of date values.

Changes

File(s)	Change Summary
apps/dashboard/components/logs/chart/utils/format-timestamp.ts	Removed timezone offset adjustment logic in `formatTimestampForChart`; now directly creates `Date` objects from input values. Removed unused `addMinutes` import.
apps/dashboard/components/logs/overview-charts/overview-bar-chart.tsx	Updated `ChartTooltipContent` to call `createTimeIntervalFormatter` with an explicit `"HH:mm"` time format argument for tooltip label formatting.
apps/dashboard/components/logs/overview-charts/overview-area-chart.tsx	Updated `ChartTooltipContent` to call `createTimeIntervalFormatter` with an explicit `"HH:mm"` time format argument for tooltip label formatting.
apps/dashboard/components/logs/chart/index.tsx	Updated `ChartTooltipContent` to call `createTimeIntervalFormatter` with an explicit `"HH:mm"` time format argument for tooltip label formatting.
apps/dashboard/components/logs/overview-charts/utils.tsx	Modified `createTimeIntervalFormatter` to accept an optional `timeFormat` parameter (default `"HH:mm"`), use `date-fns` for formatting, and simplified fallback logic. Updated function signature accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant ChartTooltipContent
    participant Utils
    participant date-fns

    ChartTooltipContent->>Utils: createTimeIntervalFormatter(data, "HH:mm")
    Utils->>date-fns: format(timestamp, "HH:mm")
    Utils-->>ChartTooltipContent: formatted label

Assessment against linked issues

Objective	Addressed	Explanation
Fix tooltip time range showing incorrect time interval for last record (#3188)	✅

Possibly related PRs

feat: show timerange on chart tooltip #2985: The main PR’s changes to createTimeIntervalFormatter and its usage in tooltip label formatting directly build upon and extend the approach introduced in the retrieved PR feat: show timerange on chart tooltip #2985, which initially replaced formatTimestampTooltip with createTimeIntervalFormatter for showing timeranges on chart tooltips.

Suggested labels

Bug, Needs Approval

Suggested reviewers

perkinsjr
chronark
mcstepp
"""

📜 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 d129e7f and 1b37fd3.

📒 Files selected for processing (2)

apps/dashboard/components/logs/chart/index.tsx (1 hunks)
apps/dashboard/components/logs/overview-charts/overview-area-chart.tsx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

apps/dashboard/components/logs/overview-charts/overview-area-chart.tsx

🧰 Additional context used

🧬 Code Graph Analysis (1)

apps/dashboard/components/logs/chart/index.tsx (1)

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

createTimeIntervalFormatter (12-68)

⏰ Context from checks skipped due to timeout of 90000ms (8)

GitHub Check: Test Packages / Test ./packages/rbac
GitHub Check: Test Packages / Test ./packages/nextjs
GitHub Check: Test Packages / Test ./packages/hono
GitHub Check: Test Packages / Test ./packages/cache
GitHub Check: Test Packages / Test ./packages/api
GitHub Check: Test Packages / Test ./internal/clickhouse
GitHub Check: Test Packages / Test ./internal/encryption
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (1)

apps/dashboard/components/logs/chart/index.tsx (1)

187-189: Well done on explicitly setting the time format!

This change correctly addresses the issue where tooltips were showing wrong time intervals. By explicitly passing "HH:mm" as the format parameter to createTimeIntervalFormatter, you ensure that the tooltip timestamps are consistently formatted and match the data points under the chart. This aligns with similar formatting used in other components.

✨ 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 generate sequence diagram to generate a sequence diagram of the changes in 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.

github-actions · 2025-04-24T11:12:33Z

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

chronark

can you update the verification outcome chart too?

ogzhanolguncu · 2025-04-25T11:56:26Z

Ahh those weren't shared. sorry missed that. will do 🫡

perkinsjr · 2025-04-25T15:03:51Z

I just made a 5 requests in API keys. The ratelimiting charts looked good.

Shows 5 requests.

Shows last used as 10:55am

Chart shows 10:00 - 10:28am

Last used shows 10:58am

ogzhanolguncu · 2025-04-25T15:04:31Z

Finally

fix: tooltip showing wrong time interval

d129e7f

ogzhanolguncu requested review from chronark, mcstepp and perkinsjr as code owners April 24, 2025 11:12

vercel bot deployed to Preview – engineering April 24, 2025 11:13 View deployment

vercel bot deployed to Preview – dashboard April 24, 2025 11:15 View deployment

Merge branch 'main' into ENG-1773

bb22328

vercel bot deployed to Preview – dashboard April 24, 2025 15:47 View deployment

chronark requested changes Apr 25, 2025

View reviewed changes

fix: add same tooltip display to every chart

1b37fd3

ogzhanolguncu requested a review from chronark April 25, 2025 12:26

vercel bot deployed to Preview – dashboard April 25, 2025 12:29 View deployment

Merge branch 'main' into ENG-1773

86b0c69

vercel bot deployed to Preview – engineering April 25, 2025 14:49 View deployment

vercel bot deployed to Preview – dashboard April 25, 2025 14:51 View deployment

Merge branch 'main' into ENG-1773

3b558bf

vercel bot deployed to Preview – engineering April 29, 2025 21:07 View deployment

perkinsjr merged commit 404a4b9 into main Apr 29, 2025
29 of 30 checks passed

perkinsjr deleted the ENG-1773 branch April 29, 2025 21:08

vercel bot deployed to Preview – dashboard April 29, 2025 21:09 View deployment

perkinsjr mentioned this pull request Sep 4, 2025

fix: WIP Chart and tooltips are not informative #3915

Closed

18 tasks

coderabbitai bot mentioned this pull request Sep 30, 2025

fix: tooltip times are wrong when looking at different date times #4043

Merged

18 tasks

Conversation

ogzhanolguncu commented Apr 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

MERGE THIS AFTER #3187

Type of change

How should this be tested?

Checklist

Required

Appreciated

BEFORE

AFTER

Summary by CodeRabbit

Uh oh!

linear bot commented Apr 24, 2025

Uh oh!

changeset-bot bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chronark left a comment

Choose a reason for hiding this comment

Uh oh!

ogzhanolguncu commented Apr 25, 2025

Uh oh!

perkinsjr commented Apr 25, 2025

Uh oh!

ogzhanolguncu commented Apr 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ogzhanolguncu commented Apr 24, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Apr 24, 2025 •

edited

Loading

vercel bot commented Apr 24, 2025 •

edited

Loading

coderabbitai bot commented Apr 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Apr 24, 2025 •

edited

Loading