Skip to content

chore: increase craco --max-old-space-size to 10240#38494

Merged
nidhi-nair merged 1 commit intoreleasefrom
chore/increase-craco-space-size
Jan 6, 2025
Merged

chore: increase craco --max-old-space-size to 10240#38494
nidhi-nair merged 1 commit intoreleasefrom
chore/increase-craco-space-size

Conversation

@dvj1988
Copy link

@dvj1988 dvj1988 commented Jan 6, 2025

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Chores
    • Updated build script to allocate more memory for the build process, potentially improving build performance and stability.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

Walkthrough

The pull request modifies the app/client/build.sh script by increasing the maximum old space size for the Node.js process during the build command. This adjustment allows the build process to utilize more memory, expanding from 7168 MB to 10240 MB, which could potentially improve build performance for the Create React App (CRA) project.

Changes

File Change Summary
app/client/build.sh Increased Node.js memory allocation from 7168 MB to 10240 MB for the build process

Poem

🚀 Bytes dancing, memory expanding wide
Build script tweaked with silicon pride
Node.js stretches its memory might
From 7 gigs to 10, a computational delight!
Code compiles with newfound space 🖥️


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.

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.

@dvj1988 dvj1988 requested a review from nidhi-nair January 6, 2025 09:17
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jan 6, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
app/client/build.sh (2)

21-21: Consider environment-specific configurations.

Different environments (local development vs CI/CD) might have different memory constraints. Consider making this configurable via an environment variable.

Example implementation:

-craco --max-old-space-size=10240 build --config craco.build.config.js
+NODE_MEMORY_LIMIT=${NODE_MEMORY_LIMIT:-10240}
+craco --max-old-space-size=$NODE_MEMORY_LIMIT build --config craco.build.config.js

21-21: Document memory requirements.

Add a comment explaining the memory requirements and the reason for this specific limit.

Example:

+# Increased memory limit to 10GB to handle large bundle sizes during production builds
 craco --max-old-space-size=10240 build --config craco.build.config.js
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c06e38e and d756551.

📒 Files selected for processing (1)
  • app/client/build.sh (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check
🔇 Additional comments (1)
app/client/build.sh (1)

21-21: Verify the necessity of increasing memory allocation.

The significant increase in memory allocation (from ~7GB to 10GB) requires justification. Please provide context about:

  1. What issues this change addresses
  2. Whether this has been tested in CI/CD environments

Run this script to check for related build failures:

✅ Verification successful

Memory allocation increase appears justified

The increased memory allocation is specifically for production builds, while maintaining appropriate lower limits (4GB) for development and staging environments. This environment-specific configuration follows good practices.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for Out of Memory errors or build failures in recent commits
git log -n 50 --pretty=format:"%H" | while read commit; do
  git show $commit | rg -i "out of memory|build fail|heap|memory|--max-old-space-size"
done

Length of output: 466


Script:

#!/bin/bash
# Search for memory-related configurations and build settings
echo "=== Memory configurations ==="
rg --type-add 'config:*.{js,json,sh}' -t config 'max-old-space-size'

echo -e "\n=== Build-related files ==="
fd -e js -e json -e sh . | rg -i 'build|craco'

echo -e "\n=== Package.json scripts ==="
fd package.json --exec cat {} | jq -r '.scripts | to_entries | .[] | select(.value | contains("build") or contains("craco"))'

Length of output: 3021

@nidhi-nair nidhi-nair merged commit bd32f53 into release Jan 6, 2025
@nidhi-nair nidhi-nair deleted the chore/increase-craco-space-size branch January 6, 2025 09:29
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Feb 7, 2025
## Description
> [!TIP]  
> _Add a TL;DR when the description is longer than 500 words or
extremely technical (helps the content, marketing, and DevRel team)._
>
> _Please also include relevant motivation and context. List any
dependencies that are required for this change. Add links to Notion,
Figma or any other documents that might be relevant to the PR._


Fixes #`Issue Number`  
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags=""

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!CAUTION]  
> If you modify the content in this section, you are likely to disrupt
the CI result for your PR.

<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Chores**
- Updated build script to allocate more memory for the build process,
potentially improving build performance and stability.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog Adding this label to a PR prevents it from being listed in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants