Fix: Clean up temporary test directories after each test #518
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Store temporary directory paths in global scope to survive jest.resetModules() calls. This ensures all temporary directories created by testSettings() are properly cleaned up after tests complete. Co-authored-by: manusa <488391+manusa@users.noreply.github.com>
Add test suite to verify that testSettings() creates temporary directories correctly and they are cleaned up after tests complete. Co-authored-by: manusa <488391+manusa@users.noreply.github.com>
Add test case that specifically reproduces the original issue where jest.resetModules() would prevent cleanup. Verifies that the fix using global scope works correctly. Co-authored-by: manusa <488391+manusa@users.noreply.github.com>
manusa
reviewed
Sep 30, 2025
src/__tests__/setup-jest.js
Outdated
Comment on lines
21
to
25
|
|
||
| // Clean up the current settings appDir if it's in tmpdir | ||
| if (os.tmpdir && settings?.paths?.appDir && settings.paths.appDir.startsWith(os.tmpdir())) { | ||
| await fs.promises.rm(settings.paths.appDir, {recursive: true, force: true}); | ||
| } |
Owner
There was a problem hiding this comment.
This should no longer be needed since any usage of testSettings will register the directory
Contributor
Author
There was a problem hiding this comment.
Removed in 76c1532. Since testSettings() now tracks all directories in the global array, this redundant cleanup is no longer needed.
Copilot
AI
changed the title
The testSettings function in src/__tests__/settings.js creates temporary directories to hold the settings.json file for tests.
This is working great, however, these directories are not removed.
It would be great if the directories were automatically cl...
Fix: Clean up temporary test directories after each test
Sep 30, 2025
Copilot finished work on behalf of
manusa
September 30, 2025 12:48
manusa
reviewed
Sep 30, 2025
src/__tests__/settings.test.js
Outdated
manusa
reviewed
Sep 30, 2025
src/__tests__/settings.js
Outdated
| const settings = require('../settings'); | ||
| settings.paths.appDir = await fs.promises.mkdtemp(path.join(os.tmpdir(), 'electronim-test-')); | ||
| settings.paths.settingsPath = path.join(settings.paths.appDir, 'settings.json'); | ||
| // Track the directory for cleanup in global scope |
manusa
reviewed
Sep 30, 2025
src/__tests__/setup-jest.js
Outdated
Comment on lines
27
to
28
| // Clean up all tracked temporary directories created by testSettings() | ||
| // Using global scope to survive jest.resetModules() calls |
Owner
There was a problem hiding this comment.
Suggested change
| // Clean up all tracked temporary directories created by testSettings() | |
| // Using global scope to survive jest.resetModules() calls | |
| // Clean up all tracked temporary directories |
- Remove redundant cleanup logic for current settings appDir since testSettings tracks all directories - Remove settings.test.js file as requested - Remove unnecessary comment from settings.js - Simplify comment in setup-jest.js Co-authored-by: manusa <488391+manusa@users.noreply.github.com>
Copilot finished work on behalf of
manusa
September 30, 2025 12:55
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a resource leak issue where temporary test directories created by the testSettings() function were not being cleaned up after test execution, particularly when jest.resetModules() cleared the module cache and lost track of directory paths.
- Stores temporary directory paths in a global array that survives module resets
- Implements cleanup logic in the Jest teardown to remove all tracked directories
- Ensures proper resource cleanup even when the module cache is cleared during tests
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/__tests__/settings.js |
Adds global tracking of temporary directory paths to survive module cache resets |
src/__tests__/setup-jest.js |
Implements cleanup logic to remove all tracked temporary directories after each test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✅ COMPLETE - Temporary directory cleanup issue resolved
Problem Statement
The
testSettings()function creates temporary directories that were not being removed after test completion, especially when tests calledjest.resetModules().Root Cause
When
jest.resetModules()is called, the module cache is cleared. The cleanup logic insetup-jest.jswould then load a fresh settings module instance with default paths, losing track of the temporary directory path.Solution
Store temporary directory paths in
global.__testTempDirectories__array, which persists across module resets.Changes Made
src/__tests__/settings.js- Track directories in global scope that survivesjest.resetModules()src/__tests__/setup-jest.js- Clean up all tracked directories from the global arrayVerification Results
jest.resetModules()correctlyOriginal prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.