fix: make tracker.stop() idempotent - #1336
Open
davidberenstein1957 wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1336 +/- ##
==========================================
+ Coverage 91.43% 91.51% +0.07%
==========================================
Files 49 49
Lines 5057 5066 +9
==========================================
+ Hits 4624 4636 +12
+ Misses 433 430 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
davidberenstein1957
marked this pull request as ready for review
August 12, 2026 19:14
davidberenstein1957
force-pushed
the
fix/stop-idempotent
branch
from
August 19, 2026 09:18
045655e to
72b69d6
Compare
stop() used the schedulers as its state flag, so a second call re-ran the final measurement, wrote a second row and released the lock twice -- by then the lock may already belong to another tracker. Add `_stopped_at` as the single state flag: `_start_time is None` means never started, `_stopped_at is not None` means stopped. A second stop() returns the memoised emissions; a start() after stop() is refused with an error instead of half-restarting a tracker whose output handlers, lock and schedulers are already gone. Folds in #1337, which inferred the same state from `self._scheduler`. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
davidberenstein1957
force-pushed
the
fix/stop-idempotent
branch
from
August 19, 2026 14:10
72b69d6 to
334f76d
Compare
davidberenstein1957
added a commit
that referenced
this pull request
Aug 19, 2026
Handlers were installed before acquire() could fail. On the "another instance is already running" path acquire() raises, the tracker sets _another_instance_already_running and stop() returns at its early guard without ever reaching release() -- so the host application's SIGINT and SIGTERM stayed hijacked for the life of the process. Install them after open(LOCKFILE, "x") succeeds instead, and drop the _atexit_hook indirection: atexit.unregister() compares with ==, not identity, so a bound method unregisters fine. Also make release() idempotent (moved here from #1336): it edits the same few lines of release() this branch already rewrites. The deadlock test now unregisters its atexit hook, so a reverted lock.py fails the suite instead of wedging the interpreter at exit. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
davidberenstein1957
added a commit
that referenced
this pull request
Aug 20, 2026
`Lock` installed SIGINT/SIGTERM handlers and threw away the previous ones, so the host application's handlers were destroyed and Ctrl-C stopped raising KeyboardInterrupt. Save the previous handlers, chain to them from `_handle_exit`, and restore them in `release()`, unregistering the atexit hook so a released lock is not pinned. Handlers are installed in `acquire()` after `open(LOCKFILE, "x")` succeeds, not in `__init__`. On the "another instance is already running" path `acquire()` raises, the tracker sets `_another_instance_already_running`, and `stop()` returns at its early guard without ever reaching `release()` -- so handlers installed in the constructor stayed hijacked for the life of the process. The thread lock is reentrant: `_handle_exit` calls `release()`, which takes `_thread_lock`, so a signal delivered while the same thread was inside `acquire()`/`release()` deadlocked on a plain `Lock`. `release()` is also idempotent now (moved here from #1336, since it edits the same few lines this branch already rewrites), and the `_atexit_hook` indirection is dropped: `atexit.unregister()` compares with `==`, not identity, so a bound method unregisters fine. Tests cover the default and ignored signal dispositions, and the deadlock test unregisters its atexit hook so a reverted lock.py fails the suite instead of wedging the interpreter at exit. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Calling
stop()twice wrote a second complete emissions row (two CSV rows, two API POSTs, twohandler.exit()calls) for a single run, because nothing recorded that the tracker had stopped —_start_timestays set and both schedulers beingNonewas only used to emit an advisory warning.What changed
_initialize_runtime_state()now initializes_is_stopped,final_emissionsandfinal_emissions_data.stop()returns early on_is_stopped, returning the cachedfinal_emissions.stop()no longer retriesos.removeon an already-removed lock file.else: logger.warning("Tracker already stopped !")(bound to the_scheduler_monitor_powercheck) is replaced by the real terminal-state guard.Why
__exit__callsstop()unconditionally, so awithblock plus an explicitstop()— the usual way to get the return value — double counts the whole run.Verification
tests/test_emissions_tracker.py::TestCarbonTracker::test_offline_tracker_stop_is_idempotentasserts one CSV row and an identical return value after a double stop. It fails on master (2 rows) and passes with this change. Full file: 32 passed.Closes #1307
🤖 Generated with Claude Code