fix: bucket caching issue for multiple keys on audit log. by MichaelUnkey · Pull Request #2305 · unkeyed/unkey

MichaelUnkey · 2024-10-10T16:48:49Z

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

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

New Features
- Enhanced efficiency in daily and monthly refill jobs by implementing a caching mechanism for bucket IDs.
- Introduced a new constant for bucket naming to standardize references.
Bug Fixes
- Improved reliability in bucket ID retrieval, reducing redundant database queries.

changeset-bot · 2024-10-10T16:48:52Z

⚠️ No Changeset found

Latest commit: 8499ac9

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 · 2024-10-10T16:48:53Z

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	Oct 10, 2024 5:05pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 10, 2024 5:05pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 10, 2024 5:05pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
dashboard	⬜️ Ignored (Inspect)	Visit Preview		Oct 10, 2024 5:05pm
workflows	⬜️ Ignored (Inspect)	Visit Preview		Oct 10, 2024 5:05pm

github-actions · 2024-10-10T16:49:04Z

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

coderabbitai · 2024-10-10T16:51:56Z

📝 Walkthrough

Walkthrough

The changes in this pull request enhance the functionality of the refill.daily and refill.monthly jobs by introducing a new constant BUCKET_NAME, type aliases for improved type safety, and a caching mechanism for bucket IDs. The logic for retrieving bucket IDs has been refactored to first check a cache before querying the database, reducing redundant queries. If a bucket ID is not found in the cache, a new ID is generated and inserted into the auditLogBucket schema. These modifications streamline bucket ID management.

Changes

File(s)	Change Summary
`apps/workflows/jobs/refill-daily.ts`	Added constant `BUCKET_NAME`, type aliases `Key` and `BucketId`, and implemented `bucketCache`. Refactored bucket ID retrieval logic.
`apps/workflows/jobs/refill-monthly.ts`	Added constant `BUCKET_NAME`, type aliases `Key` and `BucketId`, and implemented `bucketCache`. Refactored bucket ID retrieval logic.

Possibly related PRs

refactor: query audit logs from planetscale #2181: The changes in this PR involve modifications to the audit log retrieval process, which is closely related to the new bucket ID management introduced in the main PR, as both involve handling audit logs and bucket IDs in the context of workflows.

Suggested labels

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

Suggested reviewers

perkinsjr
chronark

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.

coderabbitai

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (2)

apps/workflows/jobs/refill-daily.ts (1)
Line range hint 83-138: Use object property shorthand for bucketId

When the property name and the variable name are the same, you can simplify the object assignments using shorthand property names.

Apply this diff to simplify the code:

In line 110:
-                bucketId: bucketId,
+                bucketId,
Similarly, in lines 124 and 134:
-                  bucketId: bucketId,
+                  bucketId,
This makes the code more concise and readable.
apps/workflows/jobs/refill-monthly.ts (1)

17-17: Consider centralizing 'BUCKET_NAME' constant

Defining 'BUCKET_NAME' as a constant is good practice. However, if 'unkey_mutations' is used elsewhere in the codebase, consider moving this constant to a shared configuration or constants file to ensure consistency and ease of maintenance across the project.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c948512 and a97a6cb.

📒 Files selected for processing (2)

apps/workflows/jobs/refill-daily.ts (4 hunks)
apps/workflows/jobs/refill-monthly.ts (4 hunks)

🧰 Additional context used

🔇 Additional comments (5)

apps/workflows/jobs/refill-daily.ts (1)

20-22: Good use of type aliases and caching to improve type safety and performance

Introducing the Key and BucketId type aliases and implementing bucketCache enhances type safety and reduces redundant database queries during the job execution.

apps/workflows/jobs/refill-monthly.ts (4)

19-21: Good use of type aliases for clarity

Introducing type aliases Key and BucketId enhances type safety and improves code readability. This makes the intent of the code clearer and helps prevent type-related errors.

40-45: Efficient caching of bucket IDs

Implementing a cache for bucket IDs with bucketCache optimizes the performance by reducing redundant database queries. This is an effective way to improve the efficiency of the refill job.

66-66: Ensure 'bucketCache' is consistently updated

Updating the bucketCache with bucketCache.set(cacheKey, bucketId); after fetching or creating the bucketId ensures that subsequent iterations can utilize the cached value, further optimizing performance.

81-81: Verify 'bucketId' exists in 'auditLog' and 'auditLogTarget' schemas

Adding bucketId to the auditLog and auditLogTarget entries is a crucial change. Ensure that the schemas for these tables include the bucketId field and that any necessary database migrations have been performed to add this new column.

Run the following script to confirm the presence of the bucketId field:

Also applies to: 93-93, 101-101

apps/workflows/jobs/refill-daily.ts

apps/workflows/jobs/refill-monthly.ts

* fixed bucket caching issue for multiple keys on audit log. * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

fixed bucket caching issue for multiple keys on audit log.

4a50347

vercel bot deployed to Preview – play October 10, 2024 16:49 View deployment

vercel bot deployed to Preview – workflows October 10, 2024 16:49 View deployment

[autofix.ci] apply automated fixes

a97a6cb

vercel bot deployed to Preview – play October 10, 2024 16:51 View deployment

MichaelUnkey marked this pull request as ready for review October 10, 2024 16:51

MichaelUnkey requested review from chronark, mcstepp and perkinsjr as code owners October 10, 2024 16:51

MichaelUnkey enabled auto-merge October 10, 2024 16:52

vercel bot deployed to Preview – www October 10, 2024 16:52 View deployment

vercel bot deployed to Preview – engineering October 10, 2024 16:53 View deployment

vercel bot deployed to Preview – dashboard October 10, 2024 16:53 View deployment

vercel bot deployed to Preview – workflows October 10, 2024 16:55 View deployment

coderabbitai bot reviewed Oct 10, 2024

View reviewed changes

apps/workflows/jobs/refill-daily.ts Show resolved Hide resolved

apps/workflows/jobs/refill-daily.ts Show resolved Hide resolved

apps/workflows/jobs/refill-monthly.ts Show resolved Hide resolved

Merge branch 'main' into fix-audit-log-for-multiple-requests

8499ac9

vercel bot deployed to Preview – engineering October 10, 2024 17:04 View deployment

vercel bot deployed to Preview – www October 10, 2024 17:05 View deployment

vercel bot deployed to Preview – play October 10, 2024 17:05 View deployment

chronark approved these changes Oct 10, 2024

View reviewed changes

MichaelUnkey added this pull request to the merge queue Oct 10, 2024

Merged via the queue into main with commit 4991094 Oct 10, 2024

MichaelUnkey deleted the fix-audit-log-for-multiple-requests branch October 10, 2024 17:21

coderabbitai bot mentioned this pull request Oct 14, 2024

fix(dashboard): "No bucket found" message position on Audit Logs page #2413

Merged

18 tasks

coderabbitai bot mentioned this pull request Oct 14, 2024

fix: breadcrumb cache issue #2215

Merged

17 tasks

coderabbitai bot mentioned this pull request Nov 21, 2024

switch to blacksmith cache actions #2671

Closed

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: bucket caching issue for multiple keys on audit log.#2305

fix: bucket caching issue for multiple keys on audit log.#2305
MichaelUnkey merged 3 commits intomainfrom
fix-audit-log-for-multiple-requests

MichaelUnkey commented Oct 10, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Oct 10, 2024 •

edited

Loading

Uh oh!

vercel bot commented Oct 10, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Oct 10, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Oct 10, 2024 •

edited

Loading

Walkthrough

Changes

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!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

MichaelUnkey commented Oct 10, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

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!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MichaelUnkey commented Oct 10, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 10, 2024 •

edited

Loading

vercel bot commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading

coderabbitai bot commented Oct 10, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)