Add `secureDeliveryProxyUrlResolver` and `secureUploadsTokenResolver` options
Description
Checklist
- [ ] Tests (if applicable)
- [ ] Documentation (if applicable)
- [ ] Changelog stub (or use conventional commit messages)
Summary by CodeRabbit
-
New Features
- Introduced secure uploads management, including token retrieval and expiration checks.
- Added support for secure delivery proxy URL resolution.
-
Enhancements
- Expanded configuration options to include secure upload and delivery settings.
- Improved flexibility and readability of type-checking functions for configurations.
-
Bug Fixes
- Ensured asynchronous handling of upload client options in file upload components.
-
Documentation
- Added HTML templates and demo pages for secure uploads and proxy URL resolution setup.
-
Tests
- Added test cases for secure token expiration and CDN URL modifier extraction.
Walkthrough
The updates introduce secure upload and delivery features across multiple files. Key enhancements include the integration of SecureUploadsManager for managing secure tokens, adjustments to configuration handling, and the introduction of utility functions for URL extraction and token expiration checks. Additionally, new HTML templates and test cases have been added to support and validate these functionalities.
Changes
| Files/Groups | Change Summary |
|---|---|
abstract/Block.js |
Modified proxyUrl method to handle secure delivery differently. |
abstract/CTX.js |
Added secureUploadsManager declaration in uploaderBlockCtx function. |
abstract/SecureUploadsManager.js |
Introduced SecureUploadsManager class and isSecureTokenExpired function. |
abstract/UploaderBlock.js |
Integrated SecureUploadsManager and updated getUploadClientOptions method. |
blocks/Config/Config.js |
Expanded complexConfigKeys array with secure upload and delivery keys. |
blocks/Config/initialConfig.js |
Added secureUploadsTokenResolver and secureDeliveryProxyUrlResolver fields. |
blocks/Config/normalizeConfigValue.js |
Refactored type-checking functions to use generic templates. |
blocks/FileItem/FileItem.js |
Made baseUploadClientOptions assignment asynchronous. |
demo/preview-proxy/secure-delivery-proxy-url-... |
Added HTML for setting up secure delivery proxy URL resolver. |
demo/preview-proxy/secure-delivery-proxy-url-... |
Introduced HTML template for secure delivery proxy URL. |
demo/secure-uploads.html |
Added scripts and configuration for secure file uploads. |
types/exported.d.ts |
Added new types and updated ConfigComplexType to use complexConfigKeys. |
utils/cdn-utils.js |
Renamed and adjusted extractOperations function and introduced a new function for UUID extraction. |
utils/isSecureTokenExpired.js |
Introduced isSecureTokenExpired function to check token expiration. |
utils/isSecureTokenExpired.test.js |
Added test cases for isSecureTokenExpired function. |
utils/cdn-utils.test.js |
Added test for extractCdnUrlModifiers function. |
🐰✨ In code we trust, with tokens secure, Our files now travel paths obscure. Through proxies swift, and signatures neat, They find their way, a data feat. With tests to guide, and configs clear, Uploads proceed, no need to fear. 🌟📂
[!TIP]
New Features and Improvements
Review Settings
Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.
AST-based Instructions
CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.
Community-driven AST-based Rules
We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.
New Static Analysis Tools
We are continually expanding our support for static analysis tools. We have added support for
biome,hadolint, andast-grep. Update the settings in your.coderabbit.yamlfile or head over to the settings page to enable or disable the tools you want to use.Tone Settings
Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
- Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
- Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
- Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"
Revamped Settings Page
We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to
.coderabbit.yamlwill be reflected in the settings page, and vice versa.Miscellaneous
- Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the
enable_free_tiersetting.- Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (
local) or the organization (global) level using theknowledge_basesetting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.- High-level summary placement: You can now customize the location of the high-level summary in the PR description using the
high_level_summary_placeholdersetting (default@coderabbitai summary).- Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the
request_changes_workflowsetting.
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>.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
@coderabbitaiin 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
@coderabbitaiin 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 generate interesting stats about this repository and render them as a table.@coderabbitai show all the console.log statements in this repository.@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.
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 as PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger a review. This is useful when automatic reviews are disabled for the repository.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.