Avoid Windows in-process test teardown deadlock#1997
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Do not retry removal of the in-process runtime's session home while its Vitest worker still owns a locked session database. Retrying until the hook timeout prevents the worker from exiting and releasing the lock. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6e902b9a-5527-4a32-a5a3-e0bf5bfef3f7
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adjusts Node.js E2E harness teardown behavior to avoid a Windows-specific deadlock in Vitest workers when using the in-process (FFI) transport and the runtime keeps session.db locked until worker exit.
Changes:
- Limit
COPILOT_HOMEtemp directory deletion to a single attempt for Windows + in-process tests to avoid afterAll retry deadlock. - Extend the
rmDirhelper to accept a configurablemaxTries, preserving existing retry behavior for other platforms/transports.
Show a summary per file
| File | Description |
|---|---|
| nodejs/test/e2e/harness/sdkTestContext.ts | Make teardown cleanup retries configurable and cap retries for Windows in-process COPILOT_HOME deletion to avoid Vitest afterAll deadlock. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
Comment on lines
332
to
336
| // Use longer retries to tolerate Windows holding SQLite session-store.db | ||
| // open briefly after the CLI subprocess exits. If the temp dir still can't | ||
| // be removed (e.g. CLI background writer racing with cleanup), warn and | ||
| // continue rather than failing the whole test run — the OS / CI runner | ||
| // will reclaim the temp dir on shutdown. |
Contributor
Cross-SDK Consistency Review ✅This PR modifies only No cross-SDK consistency issues found. This is test infrastructure specific to the Node.js test runner (Vitest) and doesn't affect any public SDK API surface. No equivalent changes are needed in other language SDKs.
|
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
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.
Windows in-process E2E workers can retain the runtime's
session.dblock until the Vitest worker exits. The existing 30-second cleanup retry runs from that worker'safterAllhook, so it prevents the exit needed to release the lock and eventually hits the hook timeout.Limit the
COPILOT_HOMEdeletion to one attempt specifically for Windows in-process tests. If the database is still locked, the existing warning and OS-cleanup path handles it, while other platforms and subprocess transports retain their retries because those locks can be released independently.Validation:
Generated by Copilot