-
-
Notifications
You must be signed in to change notification settings - Fork 34.6k
repl: fix flaky test-repl-programmatic-history #61614
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
repl: fix flaky test-repl-programmatic-history #61614
Conversation
56947c3 to
e2afc62
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #61614 +/- ##
==========================================
- Coverage 89.76% 89.75% -0.02%
==========================================
Files 673 674 +1
Lines 203944 204088 +144
Branches 39191 39238 +47
==========================================
+ Hits 183080 183171 +91
- Misses 13194 13238 +44
- Partials 7670 7679 +9
🚀 New features to boost your workflow:
|
lib/internal/repl/history.js
Outdated
| debug('Error closing history file:', err); | ||
| } | ||
| } | ||
| this[kContext].emit('historyHandleClosed'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this new event used for?
lib/repl.js
Outdated
| if (this.terminal && this.historyManager?.closeHandle && !this._historyHandleClosed) { | ||
| this._historyHandleClosed = true; | ||
| this.historyManager.closeHandle().then(() => { | ||
| process.nextTick(() => super.close()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is process.nextTick() needed here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I generically prefer this to exit the promise chain. It's probably safe to avoid here
The test was flaky because the FileHandle for the history file could be garbage collected before being explicitly closed, causing ERR_INVALID_STATE errors when the handle was already closed by the GC finalizer. This fix adds an explicit closeHandle() method to ReplHistory and ensures that REPLServer.close() waits for the history file handle to be properly closed before completing the close operation. Refs: nodejs/reliability#1450
e2afc62 to
d715296
Compare
Summary
Fixes flaky test
test/parallel/test-repl-programmatic-history.js.Problem
The test was flaky because the FileHandle for the history file could be garbage collected before being explicitly closed, causing
ERR_INVALID_STATEerrors when the handle was already closed by the GC finalizer.Solution
closeHandle()method toReplHistoryclassREPLServer.close()to wait for the history file handle to be properly closed before completing the close operationVerification
Verified with
python3 tools/test.py --repeat 1000 test/parallel/test-repl-programmatic-history.js- all 1000 runs passed with 0 failures.Refs: nodejs/reliability#1450