feat(clerk-js): Added `integrity` attribute support
Description
What
This PR introduces an integrity props and creates an attribute on the generated <Script /> tag.
Why
Google CASA and other common security audits require that all third party scripts be accompanied by an SRI to pass their certification checks. Doing this with Clerk, while possible, was not supported natively. The recommended solution was to point clerkJsUrl at a blank file hosted on my domain, and manually add the script tag with the verison and SRI attribute to match. This PR introduces first party support for integrity such that this workaround can be obviated.
Checklist
- [x]
pnpm testruns as expected. - [x]
pnpm buildruns as expected. - [x] (If applicable) JSDoc comments have been added or updated for any package exports
- [ ] (If applicable) Documentation has been updated
Type of change
- [ ] 🐛 Bug fix
- [x] 🌟 New feature
- [ ] 🔨 Breaking change
- [ ] 📖 Refactoring / dependency upgrade / documentation
- [ ] other:
Summary by CodeRabbit
-
New Features
- Added support for specifying an integrity attribute on script elements, enabling Subresource Integrity (SRI) for enhanced security when loading scripts.
-
Tests
- Added new test cases to verify correct handling of the integrity attribute during script loading.
🦋 Changeset detected
Latest commit: 42e689e48fc4efa1dab037f3e243739496c0cd2d
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 19 packages
| Name | Type |
|---|---|
| @clerk/nextjs | Minor |
| @clerk/shared | Minor |
| @clerk/clerk-react | Minor |
| @clerk/agent-toolkit | Patch |
| @clerk/astro | Patch |
| @clerk/backend | Patch |
| @clerk/chrome-extension | Patch |
| @clerk/clerk-js | Patch |
| @clerk/elements | Patch |
| @clerk/expo-passkeys | Patch |
| @clerk/clerk-expo | Patch |
| @clerk/express | Patch |
| @clerk/fastify | Patch |
| @clerk/nuxt | Patch |
| @clerk/react-router | Patch |
| @clerk/remix | Patch |
| @clerk/tanstack-react-start | Patch |
| @clerk/testing | Patch |
| @clerk/vue | Patch |
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| clerk-js-sandbox | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Mar 3, 2025 4:56pm |
@jonahallibone is attempting to deploy a commit to the Clerk Production Team on Vercel.
A member of the Team first needs to authorize it.
Hello 👋
We currently close PRs after 60 days of inactivity. It's been 50 days since the last update here. If we missed this PR, please reply here. Otherwise, we'll close this PR in 10 days.
Thanks for being a part of the Clerk community! 🙏
Any update on either this PR or this idea?
Hello 👋
We currently close PRs after 60 days of inactivity. It's been 50 days since the last update here. If we missed this PR, please reply here. Otherwise, we'll close this PR in 10 days.
Thanks for being a part of the Clerk community! 🙏
📝 Walkthrough
Walkthrough
This change introduces support for the integrity attribute across several packages to enable Subresource Integrity (SRI) for script elements. The update adds an optional integrity property to multiple types, including IsomorphicClerkOptions, LoadClerkJsScriptOptions, and LoadScriptOptions. The script-loading utilities and their consumers are updated to accept and propagate this property, ensuring that the generated <script> tags include the integrity attribute when specified. Corresponding tests are added to verify the correct handling of the new attribute, and documentation comments are updated to explain its intended use. No breaking changes or alterations to existing logic are introduced.
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 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.Explain this complex logic.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 explain this code block.@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 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 explain its main purpose.@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.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration 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.
Any update on this?
Hello @jonahallibone and @HamadUllah16 - apologies for the delay. We're currently discussing about this internally, we'll have an update for you within the day. Thank you!
Hello @jonahallibone and @HamadUllah16 - apologies for the delay. We're currently discussing about this internally, we'll have an update for you within the day. Thank you!
Thanks! While this PR does exist I think that the Clerk team could take the implementation a step further and automatically spend the SRI, so there are no API facing changes required for developers.
Hello 👋
We currently close PRs after 60 days of inactivity. It's been 50 days since the last update here. If we missed this PR, please reply here. Otherwise, we'll close this PR in 10 days.
Thanks for being a part of the Clerk community! 🙏
Hello @jonahallibone and @HamadUllah16 - apologies for the delay. We're currently discussing about this internally, we'll have an update for you within the day. Thank you!
Wondering if there was ever any movement on this? Thanks!
Hello 👋
We currently close PRs after 60 days of inactivity. It's been 50 days since the last update here. If we missed this PR, please reply here. Otherwise, we'll close this PR in 10 days.
Thanks for being a part of the Clerk community! 🙏