Improvement: Increase Secret v2 Reminder Note Max Length

[scott-ray-wilson]

Description 📣

This PR increases the max length of secret v2 reminder notes from 255 characters to 1024 characters. The API has also been updated to provide max length error messaging rather than failing at the service level.

Type ✨

• Bug fix
• New feature
• Improvement
• Breaking change
• Documentation

Tests 🛠️

# Here's some code block to paste some code snippets

---

• I have read the contributing guide, agreed and acknowledged the code of conduct. 📝

Summary by CodeRabbit

• New Features
  • Secret reminder notes now support up to 1024 characters.
  • Added clear, descriptive error messaging to guide users when the character limit is exceeded.

[coderabbitai]

Walkthrough

The changes update both the database schema and the API request validations related to secret reminder notes. A new migration file has been added to modify the reminderNote column in three tables, increasing its maximum allowed length to 1024 characters. This migration file contains an up function to apply the changes and a down function to revert them, both using asynchronous operations to check the column's existence before altering the table. In addition, the API route definitions have been updated to enforce a maximum length constraint of 1024 characters on the secretReminderNote field. The updated schema now provides an error message when inputs exceed this limit, ensuring that both database storage and API validations are aligned in terms of field length.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

backend/src/db/migrations/20250228022604_increase-secret-reminder-note-max-length.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "@typescript-eslint/eslint-plugin".

(The package "@typescript-eslint/eslint-plugin" was not found when loaded as a Node module from the directory "/backend".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install @typescript-eslint/eslint-plugin@latest --save-dev

The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in "backend/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

backend/src/server/routes/v3/secret-router.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "@typescript-eslint/eslint-plugin".

(The package "@typescript-eslint/eslint-plugin" was not found when loaded as a Node module from the directory "/backend".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install @typescript-eslint/eslint-plugin@latest --save-dev

The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in "backend/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 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 30f0f17 and f1facf1.

📒 Files selected for processing (2)

• backend/src/db/migrations/20250228022604_increase-secret-reminder-note-max-length.ts (1 hunks)
• backend/src/server/routes/v3/secret-router.ts (3 hunks)

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

• GitHub Check: Run integration test
• GitHub Check: Check API Changes
• GitHub Check: Check TS and Lint

🔇 Additional comments (5)

backend/src/db/migrations/20250228022604_increase-secret-reminder-note-max-length.ts (2)

5-19: Well-structured migration with proper database safety checks.

The up function correctly implements the schema change to increase the reminder note length to 1024 characters. The code includes a safety check by verifying if the column exists before attempting to alter it, which is a good practice for robust migrations.

---

21-35: Proper rollback implementation.

The down function provides a clean rollback path by properly restoring the original column definition. The same safety check for column existence is correctly applied here as well.

backend/src/server/routes/v3/secret-router.ts (3)

540-545: Good validation with appropriate error message.

The schema validation for the secretReminderNote field when creating secrets now enforces the 1024 character limit and provides a clear error message. This properly aligns with the database migration.

---

648-653: Consistent validation in update routes.

The schema validation for secretReminderNote is consistently applied in the secret update route, maintaining the same 1024 character limit and error message as the create route.

---

2066-2071: Consistent validation in batch update.

The validation is also properly implemented in the batch update route, ensuring all secret reminder note validations throughout the API enforce the same 1024 character limit.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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 generate docstrings to generate docstrings for this 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.