Fix "crypto is not defined error" on Node.js 18 in dev #1623
Conversation
…fined error" on Node.js 18 in dev
🦋 Changeset detectedLatest commit: e21c112 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
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 |
|
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
packages/core/src/v3/build/runtime.tsOops! Something went wrong! :( ESLint: 8.45.0 ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct. The config "custom" was referenced from the config file in "/.eslintrc.js". If you still have problems, please stop by https://eslint.org/chat/help to chat with the team. WalkthroughThis pull request addresses a cryptographic API compatibility issue in Node.js version 18 by introducing a new experimental command-line option Changes
Assessment against linked issues
Poem
✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/core/src/v3/build/runtime.ts (1)
51-56: Consider adding a Node.js version check before enabling the experimental flag.While adding
--experimental-global-webcryptofixes the crypto issue on Node.js 18, it's an experimental flag that's being added unconditionally. Consider adding a version check to only enable it when necessary.Here's a suggested implementation:
return [ importEntryPoint, conditions, process.env.NODE_OPTIONS, - "--experimental-global-webcrypto", + // Only add the flag for Node.js versions that need it + process.version.startsWith('v18') ? "--experimental-global-webcrypto" : undefined, ] .filter(Boolean) .flat() .join(" ");
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.changeset/green-cheetahs-scream.md(1 hunks)packages/core/src/v3/build/runtime.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: units / 🧪 Unit Tests
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
packages/core/src/v3/build/runtime.ts (1)
51-56: Verify the impact of the experimental flag across Node.js versions.Let's verify if this experimental flag has any known issues or if it's already enabled by default in certain Node.js versions.
.changeset/green-cheetahs-scream.md (1)
1-5: LGTM! Clear and accurate changeset description.The changeset correctly describes the change as a patch and clearly explains the purpose of adding the experimental flag.
@trigger.dev/build
trigger.dev
@trigger.dev/react-hooks
@trigger.dev/rsc
@trigger.dev/sdk
@trigger.dev/core
commit: |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/core/src/v3/build/runtime.ts (1)
51-56: Consider reordering command-line options.While the implementation is correct, consider reordering the options array to ensure
NODE_OPTIONScomes first, as it's a standard practice to have environment-provided options take precedence:return [ + process.env.NODE_OPTIONS, importEntryPoint, conditions, - process.env.NODE_OPTIONS, nodeRuntimeNeedsGlobalWebCryptoFlag() ? "--experimental-global-webcrypto" : undefined, ]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/core/src/v3/build/runtime.ts(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - pnpm)
- GitHub Check: units / 🧪 Unit Tests
- GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
packages/core/src/v3/build/runtime.ts (1)
67-74: Enhance version check robustness and add tests.While the implementation works for the current use case, consider these improvements:
- The version check could be more robust to enforce the "no lower than 18" requirement and handle future Node.js versions:
function nodeRuntimeNeedsGlobalWebCryptoFlag(): boolean { try { - return process.versions.node.startsWith("18."); + const version = parseInt(process.versions.node.split('.')[0], 10); + if (version < 18) throw new Error("Node.js version < 18 is not supported"); + return version === 18; } catch { return false; } }
- This function is critical for runtime behavior but appears to lack test coverage.
Run this script to check for existing tests:
Would you like me to help create test cases for this function?
fixes #1622
Summary by CodeRabbit
--experimental-global-webcryptooption to ensure web crypto API availability.