feat: allow-developer-to-set-a-custom-refill-time-when-using-the

[MichaelUnkey]

What does this PR do?

Eng-1324
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

Release Notes

• New Features

  • Introduced a new optional property refillDay for specifying the day of the month for refills, applicable when the refill interval is set to "monthly."
  • Added a new endpoint "/v1/keys.whoami" to enhance user identification features.

• Documentation

  • Updated API documentation to reflect the addition of refillDay, including its default behavior and usage examples.
  • Enhanced clarity and usability of the overall API documentation.

• Bug Fixes

  • Improved validation logic for refill-related properties to ensure accurate processing and handling of refill schedules.
  • Enhanced error handling for invalid refill configurations.

• Tests

  • Added new test cases to validate the behavior of the refillDay parameter and ensure proper error handling for invalid configurations.

[linear]

ENG-1324 Allow developer to set a custom refill time when using the refill interval feature

[changeset-bot]

⚠️ No Changeset found

Latest commit: a5ff863

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	Oct 18, 2024 0:25am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 0:25am
planetfall	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 0:25am
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 0:25am
workflows	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 0:25am
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 0:25am

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes introduce a new optional property, refillDay, to the refill logic in the key management system. This property allows users to specify the day of the month for refills when the interval is set to "monthly." The updates include validation checks to ensure compatibility with daily intervals, adjustments to request handling, and modifications to related tests and documentation. Overall, these changes enhance the functionality and clarity of the refill scheduling process.

Changes

Files	Change Summary
apps/api/src/routes/v1_keys_createKey.ts, apps/api/src/routes/v1_keys_updateKey.ts, apps/api/src/routes/v1_migrations_createKey.ts	Added refillDay property to the refill object schema, including validation and request handling logic updates.
apps/api/src/routes/v1_keys_updateKey.error.test.ts, apps/api/src/routes/v1_keys_updateKey.happy.test.ts, apps/api/src/routes/v1_migrations_createKey.happy.test.ts	Added tests to verify the behavior of the refillDay parameter, ensuring correct error handling and default values.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx	Updated form schema and handling for refillDay, including UI enhancements and validation logic.
apps/dashboard/lib/trpc/routers/key/create.ts, apps/dashboard/lib/trpc/routers/key/createRootKey.ts, apps/dashboard/lib/trpc/routers/key/updateRemaining.ts	Updated procedures to include the refillDay property in schemas, enhancing input and output structures.
apps/docs/libraries/ts/sdk/keys/get.mdx	Modified documentation for the refill response field, clarifying the interval and adding refillDay.
apps/workflows/jobs/index.ts, apps/workflows/jobs/refill-daily.ts	Adjusted exports and enhanced daily refill logic with new date calculations.
packages/api/src/openapi.d.ts	Expanded API schema with new endpoint /v1/keys.whoami and refined definitions.
apps/semantic-cache/package.json	Updated dependency version for @planetscale/database.
apps/www/app/feed.xml/route.ts	Reordered import statements in the RSS feed generation file.

Suggested labels

Feature, Dashboard, 🕹️ oss.gg, :joystick: 300 points, hacktoberfest

Suggested reviewers

• chronark
• perkinsjr
• mcstepp

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d93ce6d and a5ff863.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (1)

• apps/semantic-cache/package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• apps/semantic-cache/package.json

---

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

• 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 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.

[github-actions]

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