perf(kit): update env expansion regex to match nitro #30766

EvgenyWas · 2025-01-26T15:34:44Z

🔗 Linked issue

Resolves #30263
Appropriate PR for Nitro nitrojs/nitro#3037

📚 Description

The current Regex for env expansion feature is vulnerable according to Devina ReDos checker.

This Enhancement makes the Regex safe with keeping functionality.

…cker

bolt-new-by-stackblitz · 2025-01-26T15:34:47Z

Run & review this pull request in StackBlitz Codeflow.

pkg-pr-new · 2025-01-26T15:38:30Z

Open in Stackblitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@30766

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@30766

nuxt

npm i https://pkg.pr.new/nuxt@30766

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@30766

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@30766

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@30766

commit: 7553258

codspeed-hq · 2025-01-26T15:43:56Z

CodSpeed Performance Report

Merging #30766 will not alter performance

_{Comparing EvgenyWas:perf/enhance-env-expand-regex-safeness (7553258) with main (f90ed0f)}

Summary

✅ 8 untouched benchmarks

coderabbitai · 2025-01-26T16:38:19Z

Walkthrough

The pull request introduces changes to the runtime configuration handling in the Nuxt project. Specifically, the modifications focus on the environment variable expansion mechanism in the runtime-config.ts file. The primary change is an update to the regular expression (envExpandRx) used for parsing environment variables.

The new regex pattern /\{\{([^{}]*)\}\}/g is more restrictive compared to the previous version, preventing the matching of nested curly braces. This adjustment impacts how environment variables are expanded within configuration strings. Correspondingly, a new test suite has been added in runtime-config.test.ts to validate the behaviour of the useRuntimeConfig function under various scenarios, including different environment configurations and expansion settings.

The changes aim to improve the robustness of runtime configuration handling by providing more precise environment variable parsing and comprehensive test coverage.

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
@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: 0

🧹 Nitpick comments (2)

packages/kit/src/runtime-config.ts (1)

97-97: Excellent security enhancement to prevent ReDoS attacks!

The regex change from using a lazy quantifier (.*?) to a negated character class ([^{}]*) is a robust solution that:

Prevents catastrophic backtracking

Ensures correct parsing of environment variables

Maintains linear-time matching performance

Consider documenting this security enhancement in the codebase, particularly noting that nested environment variables are intentionally disallowed.
packages/kit/src/runtime-config.test.ts (1)
9-62: Add security-focused test cases

The test suite thoroughly covers the functional aspects, but would benefit from additional test cases that verify the security enhancements:

Add these test cases to the testCases array:
 const testCases = [
+  {
+    description: 'should safely handle nested braces attempts',
+    runtimeConfig: {
+      nested: '{{FOO{{BAR}}}}',
+      deep: '{{FOO}}{{BAR}}',
+    },
+    envExpansion: true,
+    env: {
+      FOO: 'foo',
+      BAR: 'bar',
+      'FOO{{BAR': 'nested',
+    },
+    expected: {
+      nested: '{{FOO{{BAR}}}}',
+      deep: 'foobar',
+    },
+  },
+  {
+    description: 'should handle malicious input patterns',
+    runtimeConfig: {
+      evil: '{{' + 'a'.repeat(1000) + '}}',
+    },
+    envExpansion: true,
+    env: {},
+    expected: {
+      evil: '{{' + 'a'.repeat(1000) + '}}',
+    },
+  },
   // ... existing test cases
 ]

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7bb9f41 and e94297f.

📒 Files selected for processing (2)

packages/kit/src/runtime-config.test.ts (1 hunks)
packages/kit/src/runtime-config.ts (1 hunks)

🔇 Additional comments (1)

packages/kit/src/runtime-config.test.ts (1)

64-76: LGTM! Well-structured test suite.

The test implementation using it.each is clean and maintainable. Good use of afterEach to clean up environment variables.

danielroe

thank you! ❤️

perf: enhance env expand regex safeness according to Devina ReDos che…

e94297f

…cker

github-actions bot added 3.x performance labels Jan 26, 2025

EvgenyWas changed the title ~~perf(runtime-config): enhance env expand regex safeness according to Devina ReDos checker~~ perf(kit): enhance env expand regex safeness according to Devina ReDos checker Jan 26, 2025

EvgenyWas marked this pull request as ready for review January 26, 2025 16:31

EvgenyWas requested a review from danielroe as a code owner January 26, 2025 16:31

coderabbitai bot reviewed Jan 26, 2025

View reviewed changes

Merge branch 'main' into perf/enhance-env-expand-regex-safeness

7553258

danielroe approved these changes Jan 28, 2025

View reviewed changes

danielroe changed the title ~~perf(kit): enhance env expand regex safeness according to Devina ReDos checker~~ perf(kit): update env expansion regex to match nitro Jan 28, 2025

danielroe merged commit 6b82e83 into nuxt:main Jan 28, 2025
48 checks passed

github-actions bot mentioned this pull request Jan 28, 2025

v4.0.0 #27716

Draft

Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025

perf(kit): update env expansion regex to match nitro (nuxt#30766)

0fe33e7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

perf(kit): update env expansion regex to match nitro #30766

perf(kit): update env expansion regex to match nitro #30766

Uh oh!

EvgenyWas commented Jan 26, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Jan 26, 2025

Uh oh!

pkg-pr-new bot commented Jan 26, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Jan 26, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 26, 2025

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!

danielroe left a comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

perf(kit): update env expansion regex to match nitro #30766

perf(kit): update env expansion regex to match nitro #30766

Uh oh!

Conversation

EvgenyWas commented Jan 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jan 26, 2025

Uh oh!

pkg-pr-new bot commented Jan 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codspeed-hq bot commented Jan 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #30766 will not alter performance

Summary

Uh oh!

coderabbitai bot commented Jan 26, 2025

Walkthrough

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!

danielroe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

EvgenyWas commented Jan 26, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 26, 2025 •

edited

Loading

codspeed-hq bot commented Jan 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)