Skip to content

fix: sort audit logs by time#3032

Closed
chronark wants to merge 4 commits intomainfrom
eng-1689-audit-log-ordering-is-wrong
Closed

fix: sort audit logs by time#3032
chronark wants to merge 4 commits intomainfrom
eng-1689-audit-log-ordering-is-wrong

Conversation

@chronark
Copy link
Collaborator

@chronark chronark commented Mar 26, 2025

Summary by CodeRabbit

  • New Features
    • Improved audit log display: Logs are now arranged so that the most recent entries appear first for easier review.
  • Chores
    • Removed an unnecessary blank line in the heartbeat check code for cleaner formatting.

@vercel
Copy link

vercel bot commented Mar 26, 2025

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

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 26, 2025 3:41pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 26, 2025 3:41pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 26, 2025 3:41pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
dashboard ⬜️ Ignored (Inspect) Visit Preview Mar 26, 2025 3:41pm

@linear
Copy link

linear bot commented Mar 26, 2025

@changeset-bot
Copy link

changeset-bot bot commented Mar 26, 2025

⚠️ No Changeset found

Latest commit: 0117963

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 Mar 26, 2025

📝 Walkthrough

Walkthrough

This pull request introduces a sorting mechanism within the fetchAuditLog function to reorder the paginated audit logs by their time property in descending order. After slicing the items for pagination, the logs are re-sorted to ensure that the most recent entries appear first. The code comments clarify that, although the logs are initially sorted by ID for pagination, they must be resorted by time for correct display. No changes were made to the exported or public entity declarations.

Changes

File(s) Change Summary
apps/dashboard/lib/trpc/routers/.../fetch.ts Added sorting of the slicedItems array by the time property in descending order post-pagination; updated comments accordingly.
internal/checkly/src/__checks__/.../heartbeats.check.ts Removed a blank line before the instantiation of the HeartbeatCheck for "quota-checks"; no functional changes made.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant F as fetchAuditLog
    C->>F: Request audit logs
    F->>F: Slice logs for pagination
    F->>F: Sort sliced logs by descending time
    F->>C: Return sorted audit logs
Loading

Possibly related PRs

Suggested labels

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

Suggested reviewers

  • mcstepp
  • perkinsjr
  • 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 0f8ce1f and e0b2c02.

📒 Files selected for processing (1)
  • internal/checkly/src/__checks__/heartbeats.check.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • internal/checkly/src/checks/heartbeats.check.ts
⏰ Context from checks skipped due to timeout of 90000ms (18)
  • GitHub Check: Test Go API Local / Test (Shard 6/8)
  • GitHub Check: Test Go API Local / Test (Shard 8/8)
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test Go API Local / Test (Shard 1/8)
  • GitHub Check: Test Go API Local / Test (Shard 5/8)
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • GitHub Check: Test Go API Local / Test (Shard 2/8)
  • GitHub Check: Test Go API Local / Test (Shard 3/8)
  • GitHub Check: Test Go API Local / Test (Shard 4/8)
  • GitHub Check: Test Go API Local / Test (Shard 7/8)
  • GitHub Check: Test Packages / Test ./packages/rbac
  • GitHub Check: Test Packages / Test ./internal/billing
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Build / Build
  • GitHub Check: Analyze (javascript-typescript)

🪧 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
Copy link
Contributor

github-actions bot commented Mar 26, 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: 0

🧹 Nitpick comments (1)
apps/dashboard/lib/trpc/routers/audit/fetch.ts (1)

38-42: Sorting logic looks good!

The added sorting logic correctly addresses the issue of displaying audit logs by time in descending order. The comments clearly explain the reasoning behind this additional sort operation.

For improved robustness, consider handling potential edge cases where time might be undefined or non-numeric:

-slicedItems.sort((a, b) => b.time - a.time);
+slicedItems.sort((a, b) => (b.time || 0) - (a.time || 0));
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d6b16b0 and 0f8ce1f.

📒 Files selected for processing (1)
  • apps/dashboard/lib/trpc/routers/audit/fetch.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • GitHub Check: Test Packages / Test ./internal/hash
  • GitHub Check: Test Go API Local / Test (Shard 4/8)
  • GitHub Check: Test Packages / Test ./packages/rbac
  • GitHub Check: Test Go API Local / Test (Shard 6/8)
  • GitHub Check: Test Go API Local / Test (Shard 8/8)
  • GitHub Check: Test Go API Local / Test (Shard 3/8)
  • GitHub Check: Test Go API Local / Test (Shard 7/8)
  • GitHub Check: Test Go API Local / Test (Shard 1/8)
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test Go API Local / Test (Shard 2/8)
  • GitHub Check: Build / Build
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Docs
  • GitHub Check: Analyze (javascript-typescript)

@autofix-ci autofix-ci bot requested a review from MichaelUnkey as a code owner March 26, 2025 15:30
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.

1 participant