ci: shard windows tests and fix event listener leaks

[NTaylorMullen]

Summary

This PR addresses the "Slow Test - Win" CI job failure by sharding the Windows test suite and fixing event listener memory leaks that were causing instability and timeouts. It also includes a fix for a macOS-specific local test failure.

Details

• CI Sharding: The test_windows job in .github/workflows/ci.yml has been sharded into cli and others to distribute the load and prevent timeouts.
• Memory Leak Fix: Added a global afterEach hook in packages/cli/test-setup.ts and packages/core/test-setup.ts to clear listeners from the coreEvents singleton (coreEvents.removeAllListeners()). This prevents MaxListenersExceededWarning and reduces memory consumption during test runs.
• Local Test Fix: Updated packages/cli/src/config/extension-manager-themes.spec.ts to use os.tmpdir() instead of a hardcoded /tmp path, resolving an EPERM error on macOS.

Related Issues

Part of #18597

How to Validate

1. CI Validation: Verify that the "Slow Test - Win" job (now split into shards) completes successfully in the GitHub Actions workflow for this PR.
2. Local Validation: Run the test suites locally to ensure no regressions:

   npm run test -w @google/gemini-cli
   npm run test -w @google/gemini-cli-core

Pre-Merge Checklist

• Updated relevant documentation and README (if needed)
• Added/updated tests (if needed) - Fixed existing tests and infrastructure
• 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-code-assist]

Summary of Changes

Hello @NTaylorMullen, I'm Gemini Code Assist¹! 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 significantly enhances the stability and reliability of the project's testing infrastructure. It addresses persistent CI failures on Windows by distributing the test load and resolves memory leak issues in test environments by ensuring event listeners are properly cleaned up. Additionally, it rectifies a platform-specific test failure on macOS, contributing to a more robust and consistent development experience across different operating systems.

Highlights

• CI Test Sharding: The Windows test suite in CI has been sharded into 'cli' and 'others' to improve stability and prevent timeouts in the 'Slow Test - Win' job.
• Event Listener Leak Fix: Global 'afterEach' hooks were added in 'packages/cli/test-setup.ts' and 'packages/core/test-setup.ts' to clear 'coreEvents' listeners, resolving 'MaxListenersExceededWarning' and reducing memory consumption during test runs.
• macOS Local Test Fix: The 'extension-manager-themes.spec.ts' file was updated to use 'os.tmpdir()' instead of a hardcoded '/tmp' path, fixing an 'EPERM' error on macOS.

Changelog

• packages/cli/src/config/extension-manager-themes.spec.ts
  • Imported the 'os' module to access operating system-specific functionalities.
  • Replaced the hardcoded '/tmp' directory with 'os.tmpdir()' for creating temporary directories, resolving an 'EPERM' error on macOS.
• packages/cli/test-setup.ts
  • Imported 'coreEvents' from '@google/gemini-cli-core'.
  • Introduced an 'afterEach' hook to call 'coreEvents.removeAllListeners()', preventing event listener leaks and 'MaxListenersExceededWarning' in tests.
• packages/core/test-setup.ts
  • Imported 'afterEach' from 'vitest' and 'coreEvents' from './src/utils/events.js'.
  • Added an 'afterEach' hook to clear 'coreEvents' listeners and unstub all environment variables, addressing memory leaks and ensuring test isolation.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/ci.yml

Activity

• The author identified and addressed the "Slow Test - Win" CI job failure by implementing test sharding.
• Memory leaks causing 'MaxListenersExceededWarning' and test instability were diagnosed and fixed by clearing event listeners after each test.
• A macOS-specific local test failure related to temporary directory creation was resolved.
• Validation steps for both CI and local testing were provided to ensure the fixes are effective.
• The pre-merge checklist was updated, indicating that tests were added/updated and validated on macOS.

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 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 counter productive. 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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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. ↩

[gemini-code-assist]

Code Review

This pull request introduces valuable improvements to the test suite's stability and cross-platform compatibility. Sharding the Windows tests is a good strategy to address CI timeouts. The fix for event listener leaks by clearing listeners in an afterEach hook is a crucial step towards more reliable tests. Similarly, replacing the hardcoded /tmp path with os.tmpdir() correctly addresses platform-specific issues.

I've added one suggestion to enhance test isolation further by ensuring environment variable stubs are also cleaned up in the cli package's test setup, mirroring the robust approach taken in the core package.

[github-actions]

Size Change: +602 B (0%)

Total Size: 23.9 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	23.9 MB	+602 B (0%)
./bundle/sandbox-macos-permissive-closed.sb	1.03 kB	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-closed.sb	3.29 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

_{compressed-size-action}