From 046f9fe39281d73781e24e43010908a912914c14 Mon Sep 17 00:00:00 2001
From: Thomas Waldmann <tw@waldmann-edv.de>
Date: Thu, 16 Nov 2023 14:40:06 +0100
Subject: [PATCH] LockRoster.modify: no KeyError if element was already gone,
 fixes #7937

The intention of LockRoster.modify(key, REMOVE) is to remove self.id.

Using set.discard will just ignore it if self.id is not present there anymore.

Previously, using set.remove triggered a KeyError that has been frequently
seen in tracebacks of teardowns involving Repository.__del__ and Repository.__exit__.

I added a REMOVE2 op to serve one caller that needs to get the KeyError if
self.id was not present.

Thanks to @herrmanntom for the workaround!
---
 src/borg/locking.py           | 9 +++++++--
 src/borg/testsuite/locking.py | 2 +-
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/src/borg/locking.py b/src/borg/locking.py
index ca64eeb06e..59508180dd 100644
--- a/src/borg/locking.py
+++ b/src/borg/locking.py
@@ -8,7 +8,7 @@
 from .helpers import Error, ErrorWithTraceback
 from .logger import create_logger
 
-ADD, REMOVE = "add", "remove"
+ADD, REMOVE, REMOVE2 = "add", "remove", "remove2"
 SHARED, EXCLUSIVE = "shared", "exclusive"
 
 logger = create_logger(__name__)
@@ -326,6 +326,11 @@ def modify(self, key, op):
         if op == ADD:
             elements.add(self.id)
         elif op == REMOVE:
+            # note: we ignore it if the element is already not present anymore.
+            # this has been frequently seen in teardowns involving Repository.__del__ and Repository.__exit__.
+            elements.discard(self.id)
+        elif op == REMOVE2:
+            # needed for callers that do not want to ignore.
             elements.remove(self.id)
         else:
             raise ValueError("Unknown LockRoster op %r" % op)
@@ -340,7 +345,7 @@ def migrate_lock(self, key, old_id, new_id):
         killing, self.kill_stale_locks = self.kill_stale_locks, False
         try:
             try:
-                self.modify(key, REMOVE)
+                self.modify(key, REMOVE2)
             except KeyError:
                 # entry was not there, so no need to add a new one, but still update our id
                 self.id = new_id
diff --git a/src/borg/testsuite/locking.py b/src/borg/testsuite/locking.py
index ea1bdb5f55..131fdef3ab 100644
--- a/src/borg/testsuite/locking.py
+++ b/src/borg/testsuite/locking.py
@@ -280,7 +280,7 @@ def test_kill_stale(self, lockpath, free_pid):
             assert roster.get(SHARED) == {our_id}
         assert roster.get(EXCLUSIVE) == set()
         assert roster.get(SHARED) == set()
-        with pytest.raises(KeyError):
+        with pytest.raises(NotLocked):
             dead_lock.release()
 
         with Lock(lockpath, id=cant_know_if_dead_id, exclusive=True):