Skip to content

Increasing maximum number of MongoDB retries, jitter for backoff (SCP-5429) #332

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Dec 5, 2023
Merged

Increasing maximum number of MongoDB retries, jitter for backoff (SCP-5429) #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a0216d
Doubling retry attempts, increasing backoff by 2.5x
bistline Nov 30, 2023
1288e9d
correctly set MAX_ATTEMPTS
bistline Nov 30, 2023
a8e2e08
Change retry reference to MongoConnection.MAX_AUTO_RECONNECT_ATTEMPTS…
bistline Dec 4, 2023
41224b9
addressing PR comments
bistline Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions ingest/mongo_connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class MongoConnection:
A concrete class that defines a MongoDB client
"""

MAX_AUTO_RECONNECT_ATTEMPTS = 5
MAX_AUTO_RECONNECT_ATTEMPTS = 10

def __init__(self):
# Needed to run tests in test_ingest.py in CircleCI.
Expand Down Expand Up @@ -52,12 +52,11 @@ def graceful_auto_reconnect(mongo_op_func):
import random
import math

MAX_ATTEMPTS = 5
# Adopted from https://stackoverflow.com/questions/46939285

def retry(attempt_num):
if attempt_num < MAX_ATTEMPTS - 1:
exp_backoff = pow(2, attempt_num)
if attempt_num < MongoConnection.MAX_AUTO_RECONNECT_ATTEMPTS - 1:
exp_backoff = pow(2, attempt_num + 1)
max_jitter = math.ceil(exp_backoff * 0.2)
final_wait_time = exp_backoff + random.randint(
0, max_jitter
Expand All @@ -68,17 +67,17 @@ def retry(attempt_num):
@functools.wraps(mongo_op_func)
def wrapper(*args, **kwargs):
args = list(args)
for attempt in range(MAX_ATTEMPTS):
for attempt in range(MongoConnection.MAX_AUTO_RECONNECT_ATTEMPTS):
try:
return mongo_op_func(*args, **kwargs)
except AutoReconnect as e:
if attempt < MAX_ATTEMPTS - 1:
if attempt < MongoConnection.MAX_AUTO_RECONNECT_ATTEMPTS - 1:
dev_logger.warning("PyMongo auto-reconnecting... %s.", str(e))
retry(attempt)
else:
raise e
except BulkWriteError as bwe:
if attempt < MAX_ATTEMPTS - 1:
if attempt < MongoConnection.MAX_AUTO_RECONNECT_ATTEMPTS - 1:
dev_logger.warning(
"Batch ops error occurred. Reinsert attempt %s.", str(attempt)
)
Expand Down
5 changes: 3 additions & 2 deletions tests/test_expression_files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,7 @@ def test_create_gene_model(self):
)
self.assertEqual(actual_gene_model, expected_gene_model)

@patch("mongo_connection.MongoConnection.MAX_AUTO_RECONNECT_ATTEMPTS", 3)
def test_insert(self):
client_mock = MagicMock()

Expand Down Expand Up @@ -403,7 +404,7 @@ def test_insert(self):
self.assertRaises(
AutoReconnect, GeneExpression.insert, docs, "collection", client_mock
)
self.assertEqual(client_mock["collection"].insert_many.call_count, 5)
self.assertEqual(client_mock["collection"].insert_many.call_count, 3)
client_mock.reset_mock()

def raiseError(*args, **kwargs):
Expand All @@ -429,4 +430,4 @@ def raiseError(*args, **kwargs):
self.assertRaises(
BulkWriteError, GeneExpression.insert, docs, "collection", client_mock
)
self.assertEqual(client_mock["collection"].insert_many.call_count, 5)
self.assertEqual(client_mock["collection"].insert_many.call_count, 3)