fix: pagination issue and improve fetch logic

[ogzhanolguncu]

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

• Refactor
  • Streamlined the audit logs functionality by refining filtering and pagination.
  • Made time filters optional for greater flexibility when viewing log data.
  • Improved the overall reliability and consistency of historical log access on the dashboard.

[linear]

ENG-1702 Change audit logs to show the 100 most recent entries by default

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0e0c966

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]

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 7, 2025 0:28am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 7, 2025 0:28am
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 7, 2025 0:28am
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 7, 2025 0:28am

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR updates the audit logs query functionality by modifying the handling of time parameters and cursor values. The changes remove the use of the derived dateNow variable, setting time fields to undefined in the UI hook, and adjust the associated schemas to mark time parameters as optional. In the TRPC audit router, the cursor handling is simplified by directly using a new cursor field, and a hasTimeFilter flag is introduced for conditional time filtering. Finally, the transformation logic in the utilities has been consolidated to support the new cursor structure.

Changes

File(s)	Change Summary
apps/dashboard/app/(app)/audit/components/table/hooks/use-logs-query.ts, apps/dashboard/app/(app)/audit/components/table/query-logs.schema.ts	Removed dateNow usage; set startTime and endTime to undefined in query parameters; updated schema fields to be optional; simplified the cursor definition from object to an optional number.
apps/dashboard/lib/trpc/routers/audit/fetch.ts, apps/dashboard/lib/trpc/routers/audit/schema.ts, apps/dashboard/lib/trpc/routers/audit/utils.ts	Simplified cursor handling by removing deprecated fields; introduced hasTimeFilter for conditional time filtering in queries; updated schema definitions for optional time fields and new cursor; consolidated cursor logic in the filter transformation utility.

Sequence Diagram(s)

sequenceDiagram
    participant UI as Dashboard UI
    participant Hook as useAuditLogsQuery Hook
    participant TRPC as Audit Router
    participant DB as Database

    UI->>Hook: Request audit logs with filters (startTime, endTime, cursor)
    Hook->>TRPC: Send query payload (undefined time values, simplified cursor)
    TRPC->>DB: Execute query with conditional time filtering (between or retention cutoff)
    DB-->>TRPC: Return filtered logs
    TRPC-->>Hook: Deliver results
    Hook-->>UI: Update logs display

Loading

Possibly related PRs

• fix: query by time #3054: Focuses on time filtering logic in the audit logs query, similar to the changes in this PR.
• fix: use only time as cursos #3055: Addresses cursor simplification and time parameter handling in audit logs, aligning closely with the modifications here.
• refactor: query audit logs from planetscale #2181: Involves updates to time and cursor management in audit logs queries, directly related to these changes.

Suggested labels

Bug, Needs Approval

Suggested reviewers

• perkinsjr
• mcstepp
• chronark

---

📜 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 042a00e and 0e0c966.

📒 Files selected for processing (5)

• apps/dashboard/app/(app)/audit/components/table/hooks/use-logs-query.ts (2 hunks)
• apps/dashboard/app/(app)/audit/components/table/query-logs.schema.ts (2 hunks)
• apps/dashboard/lib/trpc/routers/audit/fetch.ts (1 hunks)
• apps/dashboard/lib/trpc/routers/audit/schema.ts (2 hunks)
• apps/dashboard/lib/trpc/routers/audit/utils.ts (1 hunks)

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

• GitHub Check: Test Packages / Test ./internal/id
• GitHub Check: Test Go API Local / Test (Shard 8/8)
• GitHub Check: Test Packages / Test ./internal/hash
• GitHub Check: Test Go API Local / Test (Shard 2/8)
• GitHub Check: Test Go API Local / Test (Shard 5/8)
• GitHub Check: Test Packages / Test ./packages/rbac
• GitHub Check: Test Packages / Test ./packages/hono
• GitHub Check: Test Packages / Test ./packages/nextjs
• GitHub Check: Test Go API Local / Test (Shard 4/8)
• GitHub Check: Test Go API Local / Test (Shard 6/8)
• GitHub Check: Test Packages / Test ./packages/cache
• GitHub Check: Test Go API Local / Test (Shard 7/8)
• GitHub Check: Test Packages / Test ./internal/keys
• GitHub Check: Test Packages / Test ./internal/encryption
• GitHub Check: Test Packages / Test ./internal/billing
• GitHub Check: Test Agent Local / test_agent_local
• GitHub Check: Test API / API Test Local
• GitHub Check: Build / Build
• GitHub Check: autofix
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (10)

apps/dashboard/app/(app)/audit/components/table/hooks/use-logs-query.ts (2)

21-22: Time parameters are now optional

The change to initialize startTime and endTime as undefined aligns with the updated schema making these fields optional. This provides more flexibility in querying audit logs without requiring time constraints.

---

98-98: Updated dependency array matches implementation

Correctly updated the dependency array to remove the no-longer-used dateNow variable, reducing unnecessary re-computations while maintaining the proper dependencies.

apps/dashboard/app/(app)/audit/components/table/query-logs.schema.ts (2)

6-7: Making time parameters optional improves flexibility

Converting startTime and endTime to optional fields enables using the query without time constraints, enhancing the component's flexibility.

---

40-40: Simplified cursor implementation

The cursor field has been simplified from a complex object to a single optional number value, which streamlines pagination handling across the codebase.

apps/dashboard/lib/trpc/routers/audit/utils.ts (1)

42-42: Simplified cursor handling

The cursor transformation has been streamlined to directly pass the cursor value without extracting individual properties, which aligns with the schema changes and simplifies the cursor implementation throughout the codebase.

apps/dashboard/lib/trpc/routers/audit/fetch.ts (3)

81-81: Simplified cursor assignment

Direct cursor assignment improves code readability and aligns with the schema changes that simplified the cursor structure.

---

87-89: Improved control of time filtering

Adding the hasTimeFilter flag provides clearer control over when time constraints should be applied, improving code readability and adding flexibility to the query construction.

---

91-106: Enhanced time filtering logic

The updated filtering logic now:

1. Applies time filters only when explicitly provided
2. Otherwise enforces just the retention period
3. Correctly handles the retention cutoff as a minimum threshold
4. Uses a simplified cursor condition

This implementation provides more flexibility while maintaining data retention policies.

apps/dashboard/lib/trpc/routers/audit/schema.ts (2)

73-74: Good change: Making time parameters optional improves flexibility.

This change to make startTime and endTime optional in the schema aligns well with the PR objective to improve fetch logic. By making these parameters optional, the API becomes more flexible, allowing clients to omit time constraints when they're not needed.

---

99-99: Good simplification of cursor handling.

Replacing separate cursor fields with a single cursor field that can be optional and nullable is a smart simplification. This change directly addresses the pagination issue mentioned in the PR objectives by streamlining how pagination state is tracked.

The change will make the pagination logic more maintainable and easier to understand for developers working with this code in the future.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 plan to trigger planning for file edits and PR creation.
• @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]

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