Skip to content

fix(core): handle invalid custom plans directory gracefully#26560

Merged
Adib234 merged 5 commits intomainfrom
fix/custom-plan-dir
May 6, 2026
Merged

fix(core): handle invalid custom plans directory gracefully#26560
Adib234 merged 5 commits intomainfrom
fix/custom-plan-dir

Conversation

@cynthialong0-0
Copy link
Copy Markdown
Contributor

@cynthialong0-0 cynthialong0-0 commented May 6, 2026

Summary

This PR addresses a crash in the Gemini CLI (issue #25566) caused by an unhandled promise rejection during startup. The crash occurred when a customPlansDir was configured outside the project root, triggering a validation error that wasn't caught in Config._initialize().

Details

Updated Config._initialize() in packages/core/src/config/config.ts to wrap the this.storage.getPlansDir() call in a try/catch block. If an error occurs, the CLI now:

  1. Emits a user-friendly warning via coreEvents.
  2. Resets the customPlansDir for the session to undefined.
  3. Falls back to the default project temporary plans directory.

Related Issues

Fixes #25566

How to Validate

  1. Configure a customPlansDir in your settings that is outside your project root (e.g., in your home directory while the project is elsewhere).
  2. Start the cli and observe that the CLI starts successfully, shows a warning message about the invalid directory, and uses the default plans path instead of crashing.
  3. Run unit tests: npm test -w @google/gemini-cli-core -- src/config/config.test.ts.

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

@gemini-cli gemini-cli Bot added area/core Issues related to User Interface, OS Support, Core Functionality 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item. labels May 6, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Size Change: +442 B (0%)

Total Size: 34 MB

Filename Size Change
./bundle/chunk-6OSG4UZL.js 0 B -658 kB (removed) 🏆
./bundle/chunk-7C4436CE.js 0 B -49.2 kB (removed) 🏆
./bundle/chunk-BHGH5RMQ.js 0 B -12.5 kB (removed) 🏆
./bundle/chunk-LC4RATJF.js 0 B -3.43 kB (removed) 🏆
./bundle/chunk-NKF55S6N.js 0 B -3.8 kB (removed) 🏆
./bundle/chunk-NTSL2R6V.js 0 B -14.8 MB (removed) 🏆
./bundle/chunk-PYZUJ67P.js 0 B -19.5 kB (removed) 🏆
./bundle/chunk-VCDLTPVP.js 0 B -2.78 MB (removed) 🏆
./bundle/core-EQMPM6GI.js 0 B -48.8 kB (removed) 🏆
./bundle/devtoolsService-YIAKOGJH.js 0 B -28 kB (removed) 🏆
./bundle/gemini-RU2WAFHT.js 0 B -584 kB (removed) 🏆
./bundle/interactiveCli-LII372I3.js 0 B -1.29 MB (removed) 🏆
./bundle/liteRtServerManager-QHRPIGQS.js 0 B -2.11 kB (removed) 🏆
./bundle/oauth2-provider-PRJ5Q6JA.js 0 B -9.16 kB (removed) 🏆
./bundle/chunk-5DKO6URK.js 49.2 kB +49.2 kB (new file) 🆕
./bundle/chunk-7MUGNYP2.js 19.5 kB +19.5 kB (new file) 🆕
./bundle/chunk-BU7WXW3A.js 3.8 kB +3.8 kB (new file) 🆕
./bundle/chunk-NBVOEQNS.js 3.43 kB +3.43 kB (new file) 🆕
./bundle/chunk-QMVUEDYV.js 12.5 kB +12.5 kB (new file) 🆕
./bundle/chunk-W2ZGPM47.js 658 kB +658 kB (new file) 🆕
./bundle/chunk-XYLLTGK2.js 14.8 MB +14.8 MB (new file) 🆕
./bundle/chunk-YCJWTC6S.js 2.78 MB +2.78 MB (new file) 🆕
./bundle/core-IKA6ORTN.js 48.8 kB +48.8 kB (new file) 🆕
./bundle/devtoolsService-7C2TPTRU.js 28 kB +28 kB (new file) 🆕
./bundle/gemini-MEYJO2GP.js 584 kB +584 kB (new file) 🆕
./bundle/interactiveCli-YBHSJCSA.js 1.29 MB +1.29 MB (new file) 🆕
./bundle/liteRtServerManager-MOQFRYNB.js 2.11 kB +2.11 kB (new file) 🆕
./bundle/oauth2-provider-OEFZCPSG.js 9.16 kB +9.16 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./bundle/bundled/third_party/index.js 8 MB 0 B
./bundle/chunk-34MYV7JD.js 2.45 kB 0 B
./bundle/chunk-5AUYMPVF.js 858 B 0 B
./bundle/chunk-5PS3AYFU.js 1.18 kB 0 B
./bundle/chunk-664ZODQF.js 124 kB 0 B
./bundle/chunk-DAHVX5MI.js 206 kB 0 B
./bundle/chunk-IUUIT4SU.js 56.5 kB 0 B
./bundle/chunk-RJTRUG2J.js 39.8 kB 0 B
./bundle/chunk-VJSUVOZ4.js 1.97 MB 0 B
./bundle/cleanup-ZS53QKHG.js 0 B -932 B (removed) 🏆
./bundle/devtools-36NN55EP.js 696 kB 0 B
./bundle/dist-T73EYRDX.js 356 B 0 B
./bundle/events-XB7DADIJ.js 418 B 0 B
./bundle/examples/hooks/scripts/on-start.js 188 B 0 B
./bundle/examples/mcp-server/example.js 1.43 kB 0 B
./bundle/gemini.js 5.1 kB 0 B
./bundle/getMachineId-bsd-TXG52NKR.js 1.55 kB 0 B
./bundle/getMachineId-darwin-7OE4DDZ6.js 1.55 kB 0 B
./bundle/getMachineId-linux-SHIFKOOX.js 1.34 kB 0 B
./bundle/getMachineId-unsupported-5U5DOEYY.js 1.06 kB 0 B
./bundle/getMachineId-win-6KLLGOI4.js 1.72 kB 0 B
./bundle/memoryDiscovery-NGHTMHWQ.js 980 B 0 B
./bundle/multipart-parser-KPBZEGQU.js 11.7 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 222 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 229 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 13.4 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B
./bundle/src-QVCVGIUX.js 47 kB 0 B
./bundle/start-4QWJD4LP.js 0 B -652 B (removed) 🏆
./bundle/tree-sitter-7U6MW5PS.js 274 kB 0 B
./bundle/tree-sitter-bash-34ZGLXVX.js 1.84 MB 0 B
./bundle/cleanup-37GRISI4.js 932 B +932 B (new file) 🆕
./bundle/start-Q3RK2PNI.js 652 B +652 B (new file) 🆕

compressed-size-action

@cynthialong0-0 cynthialong0-0 marked this pull request as ready for review May 6, 2026 02:09
@cynthialong0-0 cynthialong0-0 requested a review from a team as a code owner May 6, 2026 02:09
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a crash in the Gemini CLI occurring during startup when a custom plans directory is misconfigured. By introducing robust error handling during the configuration initialization phase, the CLI can now detect invalid paths, notify the user, and safely fall back to the default storage location instead of terminating unexpectedly.

Highlights

  • Error Handling: Implemented a try/catch block in Config._initialize() to gracefully handle errors when retrieving a custom plans directory.
  • Fallback Mechanism: Added logic to emit a warning and revert to the default project temporary plans directory if the custom configuration is invalid.
  • Testing: Added a new unit test case to verify that the system correctly falls back to the default directory when an invalid custom path is provided.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request implements a fallback mechanism for the plans directory initialization in Config.ts, ensuring that if a custom directory cannot be retrieved, the system reverts to the default project temporary directory. A new test case validates this graceful fallback and the emission of a warning. The review feedback recommends broadening the error handling to catch non-Error objects and improving debuggability by including the original error in the feedback emission.

Comment thread packages/core/src/config/config.ts
@cynthialong0-0
Copy link
Copy Markdown
Contributor Author

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces error handling for the plans directory initialization in the Config class. It now wraps the retrieval of the plans directory in a try-catch block, ensuring that if a custom directory is invalid, the system emits a warning feedback and gracefully falls back to the default project temporary directory. A new test case has been added to config.test.ts to verify this fallback logic and the associated warning emission. I have no feedback to provide as there were no review comments to evaluate.

@Adib234 Adib234 added this pull request to the merge queue May 6, 2026
Merged via the queue into main with commit 80e091a May 6, 2026
27 checks passed
@Adib234 Adib234 deleted the fix/custom-plan-dir branch May 6, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Issues related to User Interface, OS Support, Core Functionality 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug report requested by app.

2 participants