Skip to content

refactor: prevent revalidation#3191

Merged
perkinsjr merged 3 commits intomainfrom
refactor-rq-revalidations
Apr 25, 2025
Merged

refactor: prevent revalidation#3191
perkinsjr merged 3 commits intomainfrom
refactor-rq-revalidations

Conversation

@ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Apr 24, 2025

What does this PR do?

Prevent revalidation of the log and charts if time params don't change. This PR is also a continuation of #3147 see this for more detail and how to test.

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

  • Refactor
    • Improved time synchronization across dashboard charts and logs by standardizing the use of a shared timestamp for all time-based queries and refresh actions.
    • Enhanced refresh behavior in logs and API overview pages to ensure data is consistently updated using a unified query time mechanism.
  • Tests
    • Updated logs query tests to mock shared query time and reflect enhanced error logging for invalid filters.

@changeset-bot
Copy link

changeset-bot bot commented Apr 24, 2025

⚠️ No Changeset found

Latest commit: eb47aef

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 24, 2025

📝 Walkthrough

Walkthrough

This change refactors multiple React hooks and components across the dashboard application to replace locally memoized timestamps (using Date.now()) with a shared timestamp value obtained from a useQueryTime provider. This affects the calculation of time-based query parameters, such as startTime and endTime, in several data-fetching hooks. Additionally, refresh components are updated to invoke refreshQueryTime() from the provider before invalidating caches, ensuring consistent time synchronization across queries. No changes are made to the signatures of exported functions or components, and no additional logic or control flow is introduced.

Changes

File(s) Change Summary
.../apis/[apiId]/_overview/components/charts/bar-chart/hooks/use-fetch-timeseries.ts
.../apis/_components/hooks/use-query-timeseries.ts
.../apis/[apiId]/_overview/components/charts/line-chart/hooks/use-fetch-timeseries.ts
.../logs/components/charts/hooks/use-fetch-timeseries.ts
.../logs/components/table/hooks/use-logs-query.ts
.../apis/[apiId]/_overview/components/table/hooks/use-logs-query.ts
Replaced local memoized dateNow timestamps with a shared timestamp from useQueryTime provider in query parameter calculations and updated dependency arrays accordingly. No changes to exported function signatures.
.../apis/[apiId]/_overview/components/controls/components/logs-refresh.tsx
.../logs/components/controls/components/logs-refresh.tsx
Updated refresh logic to call refreshQueryTime() from the provider before invalidating TRPC query caches. No changes to component signatures.
.../logs/components/table/hooks/use-logs-query.test.ts Added mocks for useQueryTime and QueryTimeProvider to support the new shared timestamp logic; updated expected console error call counts in tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LogsRefresh
    participant useQueryTimeProvider
    participant TRPCQueryCache

    User->>LogsRefresh: Click Refresh Button
    LogsRefresh->>useQueryTimeProvider: refreshQueryTime()
    LogsRefresh->>TRPCQueryCache: Invalidate relevant queries
Loading
sequenceDiagram
    participant Component
    participant useQueryTimeProvider
    participant TRPCHook

    Component->>useQueryTimeProvider: Get current timestamp
    Component->>TRPCHook: Fetch data with timestamp as startTime/endTime
    TRPCHook-->>Component: Return data
Loading

Possibly related PRs

  • unkeyed/unkey#3147: Both PRs refactor hooks and components to replace local memoized timestamps with a shared timestamp from the useQueryTime provider, centralizing time management for queries and refresh logic.
  • unkeyed/unkey#3187: Modifies constants for time window durations in timeseries queries but still uses local Date.now(), related to time handling in query hooks.

Suggested reviewers

  • perkinsjr
  • mcstepp
  • chronark
✨ 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.

@vercel
Copy link

vercel bot commented Apr 24, 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 Apr 25, 2025 2:48pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 25, 2025 2:48pm

@github-actions
Copy link
Contributor

github-actions bot commented Apr 24, 2025

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 256dcf2 and 6e07304.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/logs/components/table/hooks/use-logs-query.test.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: Test Packages / Test ./apps/dashboard
  • 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/resend
  • GitHub Check: Test Packages / Test ./internal/keys
  • GitHub Check: Test Packages / Test ./internal/id
  • GitHub Check: Test Packages / Test ./internal/hash
  • GitHub Check: Test Packages / Test ./internal/encryption
  • GitHub Check: Test Packages / Test ./internal/billing
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
apps/dashboard/app/(app)/logs/components/table/hooks/use-logs-query.test.ts (1)

9-15: Mock implementation matches refactoring intent

The added mock for @/providers/query-time-provider properly supports the refactoring to use a shared timestamp source instead of local Date.now() calls. The implementation correctly provides a fixed query time based on mockDate and a mock for the refreshQueryTime function.

@perkinsjr perkinsjr added this pull request to the merge queue Apr 25, 2025
Merged via the queue into main with commit b089583 Apr 25, 2025
30 checks passed
@perkinsjr perkinsjr deleted the refactor-rq-revalidations branch April 25, 2025 16:10
@coderabbitai coderabbitai bot mentioned this pull request Aug 22, 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