Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: order audit logs by time, show latest on top #2295

Merged
merged 1 commit into from
Oct 13, 2024
Merged

Conversation

chronark
Copy link
Collaborator

@chronark chronark commented Oct 10, 2024

Summary by CodeRabbit

  • New Features

    • Audit logs are now displayed in descending order by time, showcasing the most recent entries first.
    • Introduced pagination functionality with improved URL construction for navigating audit logs.
    • Added user and root key filtering options based on tenant context.
  • Bug Fixes

    • Refined handling of the before parameter for accurate log pagination.

Copy link

changeset-bot bot commented Oct 10, 2024

⚠️ No Changeset found

Latest commit: d624205

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

Copy link

vercel bot commented Oct 10, 2024

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 Oct 10, 2024 9:53am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 9:53am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 9:53am
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 9:53am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 9:53am

Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve modifications to the AuditPage component in apps/dashboard/app/(app)/audit/[bucket]/page.tsx. The order of fetched audit log entries has been changed from ascending by id to descending by time, allowing for the most recent logs to be displayed first. Additionally, a new buildHref function has been introduced for pagination, and the UserFilter and RootKeyFilter components have been updated to fetch options based on the current tenant's context.

Changes

File Path Change Summary
apps/dashboard/app/(app)/audit/[bucket]/page.tsx - Changed log retrieval order from ascending by id to descending by time.
- Introduced buildHref function for pagination.
- Updated UserFilter and RootKeyFilter components to fetch context-based options.

Possibly related PRs

  • refactor: query audit logs from planetscale #2181: The changes in this PR also modify the AuditPage component in the same file, focusing on the retrieval and structure of audit logs, which is directly related to the changes made in the main PR regarding how logs are fetched and displayed.
  • perf: add database indices #2192: This PR adds new indexes to the audit_log table, including an index on the time field, which is relevant to the main PR's change of ordering logs by the time field for display purposes.

Suggested reviewers

  • mcstepp
  • perkinsjr

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3ef2cc7 and d624205.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/audit/[bucket]/page.tsx (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
apps/dashboard/app/(app)/audit/[bucket]/page.tsx (2)

85-85: LGTM: Improved ordering of audit logs

The change from asc(table.id) to desc(table.time) is a good improvement. It ensures that:

  1. Logs are ordered chronologically by their timestamp rather than by ID.
  2. The most recent logs appear first, aligning with the PR objective.

This change will provide a better user experience by showing the most relevant (recent) information first.


Line range hint 1-368: Verify additional changes mentioned in the PR summary

The AI-generated summary mentions a new buildHref function and updates to the UserFilter and RootKeyFilter components. However, these changes are not visible in the provided diff. Could you please confirm:

  1. The implementation of the buildHref function, ensuring it correctly constructs URLs for pagination based on the selected filters and the before parameter?
  2. The updates made to UserFilter and RootKeyFilter components to fetch options based on the current tenant's context?

These changes are important for the proper functioning of the pagination and filtering features.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.

Copy link
Contributor

github-actions bot commented Oct 10, 2024

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

@chronark chronark merged commit 30a1424 into main Oct 13, 2024
27 of 28 checks passed
@chronark chronark deleted the auditlog-sort-order branch October 13, 2024 09:07
AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 14, 2024
AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 14, 2024
chronark added a commit that referenced this pull request Oct 28, 2024
* fix:breadcrum-cache-issue

* chore:rename-revalidateMytag

* refactor: move-revalidateTag

* refactor: extract tags into reusable utility

* feat: add template

* Update 3_follow_the_unkey_x_account.md (#2323)

* fix: capture uniqueness error and return it correctly (#2337)

* docs: getVerifications instead of get (#2329)

* Update 3_follow_the_unkey_x_account.md (#2324)

Followed unkey on Twitter

Co-authored-by: Andreas Thomas <dev@chronark.com>

* fix: transaction ...: in use: for query (#2278)

* fix: transaction ...: in use: for query
- Fixes #2197
- The error is caused by the cache revalidation happening in the background, so we have a racecondition with the other queries we are running in the insertGenericAuditLogs function

* docs: explain for future self

* fix: another racecondition
also bulk insert auditLogs and auditLogTargets

* [autofix.ci] apply automated fixes

---------

Co-authored-by: chronark <dev@chronark.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* fix: handle undefined ratelimits

* Update 3_follow_the_unkey_x_account.md (#2338)

* fix: handle case when blogs array is empty

* [oss.gg] side quest : added another framework; hono on cloudflare workers. (#2345)

* fix: weird spacing in changelog by removing the extra gap (#2340)

* fix: weird spacing in changelog

* feat: formatted

* oss.gg: create a template for ratelimiting a oak server in deno with unkey (#2308)

Co-authored-by: Andreas Thomas <dev@chronark.com>

* follow unkey on X #2252 (#2315)

Co-authored-by: Your Name <you@example.com>

* Follow the Unkey X account: @unkeydev Complete! (#2332)

* Update 3_follow_the_unkey_x_account.md

* Update 3_follow_the_unkey_x_account.md

---------

Co-authored-by: Andreas Thomas <dev@chronark.com>

* fix(www): analytics bento code snippet is not readable (#2311)

- add hover effect to analytics bento removing gradient background
- make copy code button sticky to top-right corner
- impl independent vertical scrolls for language switcher and code editor

* Update 7_create_a_template.md

* Update 7_create_a_template.md

* chore(deps-dev): bump @content-collections/core from 0.6.2 to 0.7.2 (#2255)

Bumps @content-collections/core from 0.6.2 to 0.7.2.

---
updated-dependencies:
- dependency-name: "@content-collections/core"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: order audit logs by time, show latest on top (#2295)

* feat: add template

* feat: Unkey FastAPI boilerplate (#2307)

* feat: add template

* feat: follow unkey on X (#2357)

* Update 6_record_onboarding.md (#2301)

* fix: reset input fields in API delete dialog after reopening (#2316)

* fix: reset input fields in API delete dialog after reopening

* refactor: remove unnecessary useEffect and utilize existing onOpenChange function for dialog

* refactor: removed unused imports

* Update 3_follow_the_unkey_x_account.md (#2364)

Added name to the followed list.

Co-authored-by: Andreas Thomas <dev@chronark.com>

* ci: add label

* feat: add hover to input fields

* Added gaps and width for md (#2371)

* docs: update overview.mdx (#2384)

avaliable -> available

* oss.gg side quest 3_follow_the_unkey_x_account.md (#2399)

Followed the unkey x account

* feat: Following unkey acc on twitter #2407 (#2408)

* Feat: Followed Unkey on X

* Feat: Followed Unkey on Twitter

---------

Co-authored-by: Andreas Thomas <dev@chronark.com>

* resolve merge conflicts

* resolve merge conflicts

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: chronark <dev@chronark.com>
Co-authored-by: Emily Marie Ahtúnan <86572370+Emmarie-Ahtunan@users.noreply.github.com>
Co-authored-by: Harsh Shrikant Bhat <90265455+harshsbhat@users.noreply.github.com>
Co-authored-by: Aritra Sadhukhan <60315087+aritradevelops@users.noreply.github.com>
Co-authored-by: Flo <53355483+Flo4604@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Devang Rakholiya <116096508+Devang0907@users.noreply.github.com>
Co-authored-by: Prabin <42871240+prabincankod@users.noreply.github.com>
Co-authored-by: ZiaCodes <72739794+Khaan25@users.noreply.github.com>
Co-authored-by: Devansh Baghel <77718741+Devansh-Baghel@users.noreply.github.com>
Co-authored-by: Shreenarayan jaiswal <127131074+shreenarayan123@users.noreply.github.com>
Co-authored-by: Your Name <you@example.com>
Co-authored-by: Chirag Arora <chirag8023@gmail.com>
Co-authored-by: Nazar Poshtarenko <32395926+unrenamed@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Saketh Pavan Goti <44170829+Sakethpavan@users.noreply.github.com>
Co-authored-by: Teddy ASSIH <110066080+Ionfinisher@users.noreply.github.com>
Co-authored-by: Vardhaman Bhandari <97441447+Vardhaman619@users.noreply.github.com>
Co-authored-by: Atharva_404 <72994819+Atharva-3000@users.noreply.github.com>
Co-authored-by: Rishi <rishipatel0826@gmail.com>
Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com>
Co-authored-by: Ayan Mondal <ayanmondal1805@gmail.com>
Co-authored-by: Kunal Arya <105645118+kunalarya873@users.noreply.github.com>
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