Repository navigation
Fix History.truncate() leaving session start index stale - #1787
Merged
Merged
Conversation
Truncation dropped the oldest items without shifting session_start_index, so retained current-session entries were hidden from unbounded ranges and searches. Shift the index by the number of removed items (clamped at 0), and reuse clear() when removing all history. Fixes #1785
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1787 +/- ##
=======================================
Coverage 99.75% 99.75%
=======================================
Files 23 23
Lines 6502 6503 +1
=======================================
+ Hits 6486 6487 +1
Misses 16 16
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. |
Assert str_search() and regex_search() in all truncate session-boundary tests, import Statement once at module level, and clarify in the changelog that only direct callers of History.truncate() were affected.
This was referenced Oct 28, 2026
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.
Closes #1785
Problem
History.truncate()dropped the oldest items without adjustingsession_start_index. Retained current-sessionentries were then hidden from unbounded ranges (
span(":")),str_search(), andregex_search().Fix
session_start_indexback by the number removed, clamped at 0. If the cutreaches into the current session, every retained item counts as current-session.
max_length <= 0, callclear(), which already resets the session boundary.Tests
issue's reproduction).
0and-1): the boundary resets to 0, and items appended afterward are visible.make checkandmake testpass locally.Note
In cmd2 itself,
truncate()is only called from_persist_historyat exit, so this mainly affects code that callsHistory.truncate()directly.