Skip to content

Commit ae4d69c

Browse files
committed
fix(core): prevent perpetual re-election in case of sequence node overflow
Once sequence node is incremented beyond 2147483647, the sequence overflows into the negative space. When getting predecessors, cast the node sequence from String to int before comparing. Closes #730
1 parent 92bd0c2 commit ae4d69c

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

kazoo/recipe/lock.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,15 +276,15 @@ def _get_predecessor(self, node):
276276
(e.g. rlock), this and also edge cases where the lock's ephemeral node
277277
is gone.
278278
"""
279-
node_sequence = node[len(self.prefix) :]
279+
node_sequence = int(node[len(self.prefix) :])
280280
children = self.client.get_children(self.path)
281281
found_self = False
282282
# Filter out the contenders using the computed regex
283283
contender_matches = []
284284
for child in children:
285285
match = self._contenders_re.search(child)
286286
if match is not None:
287-
contender_sequence = match.group(1)
287+
contender_sequence = int(match.group(1))
288288
# Only consider contenders with a smaller sequence number.
289289
# A contender with a smaller sequence number has a higher
290290
# priority.

kazoo/tests/test_lock.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,36 @@ def _thread(sem, event, timeout):
798798

799799

800800
class TestSequence(unittest.TestCase):
801+
801802
def test_get_predecessor(self):
803+
"""Validate selection of predecessors."""
804+
pyLock_prefix = "514e5a831836450cb1a56c741e990fd8__lock__"
805+
pyLock_predecessor = f"{pyLock_prefix}0000000030"
806+
pyLock = f"{pyLock_prefix}0000000031"
807+
pyLock_successor = f"{pyLock_prefix}0000000032"
808+
children = ["hello", pyLock_predecessor, "world", pyLock, pyLock_successor]
809+
client = MagicMock()
810+
client.get_children.return_value = children
811+
lock = Lock(client, "test")
812+
assert lock._get_predecessor(pyLock) == pyLock_predecessor
813+
814+
def test_get_predecessor_with_overflowed_sequence(self):
815+
"""Validate selection of predecessors with negative sequence.
816+
817+
This can occur in case of an integer overflow, if the sequence counter is
818+
incremented beyond 2147483647.
819+
"""
820+
pyLock_prefix = "514e5a831836450cb1a56c741e990fd8__lock__"
821+
pyLock_predecessor = f"{pyLock_prefix}-0000000032"
822+
pyLock = f"{pyLock_prefix}-0000000031"
823+
pyLock_successor = f"{pyLock_prefix}-0000000030"
824+
children = ["hello", pyLock_predecessor, "world", pyLock, pyLock_successor]
825+
client = MagicMock()
826+
client.get_children.return_value = children
827+
lock = Lock(client, "test")
828+
assert lock._get_predecessor(pyLock) == pyLock_predecessor
829+
830+
def test_get_predecessor_no_predecessor(self):
802831
"""Validate selection of predecessors."""
803832
goLock = "_c_8eb60557ba51e0da67eefc47467d3f34-lock-0000000031"
804833
pyLock = "514e5a831836450cb1a56c741e990fd8__lock__0000000032"

0 commit comments

Comments
 (0)