Skip to content

Commit 497e316

Browse files
ajdavisajdavis
committed
PYTHON-1104 - Support idleWritePeriodMS.
1 parent f4922da commit 497e316

14 files changed

+503
-22
lines changed

‎pymongo/common.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@
4040
MAX_WIRE_VERSION = 0
4141
MAX_WRITE_BATCH_SIZE = 1000
4242

43+
# Server Discovery and Monitoring Spec: The isMaster response of a replica set
44+
# member running MongoDB 3.4 or later may contain idleWritePeriodMillis. Set the
45+
# ServerDescription's idleWritePeriod to this value if present, else 10 seconds.
46+
IDLE_WRITE_PERIOD = 10
47+
4348
# What this version of PyMongo supports.
4449
MIN_SUPPORTED_WIRE_VERSION = 0
4550
MAX_SUPPORTED_WIRE_VERSION = 5

‎pymongo/ismaster.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,10 @@ def me(self):
144144
@property
145145
def last_write_date(self):
146146
return self._doc.get('lastWriteDate')
147+
148+
@property
149+
def idle_write_period(self):
150+
if 'idleWritePeriodMillis' in self._doc:
151+
return self._doc['idleWritePeriodMillis'] / 1000.0
152+
else:
153+
return common.IDLE_WRITE_PERIOD

‎pymongo/max_staleness_selectors.py‎

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,30 @@
3131
from pymongo.server_type import SERVER_TYPE
3232

3333

34+
def _validate_max_staleness(max_staleness,
35+
heartbeat_frequency,
36+
idle_write_period):
37+
if max_staleness < heartbeat_frequency + idle_write_period:
38+
raise ConfigurationError(
39+
"maxStalenessSeconds must be at least heartbeatFrequencyMS +"
40+
" %d seconds. maxStalenessSeconds is set to %d,"
41+
" heartbeatFrequencyMS is set to %d." % (
42+
idle_write_period, max_staleness,
43+
heartbeat_frequency * 1000))
44+
45+
3446
def _with_primary(max_staleness, selection):
3547
"""Apply max_staleness, in seconds, to a Selection with a known primary."""
3648
primary = selection.primary
49+
assert primary
50+
51+
# Server Selection Spec: If the TopologyType is ReplicaSetWithPrimary, a
52+
# client MUST raise an error if maxStaleness < heartbeatFrequency +
53+
# (primary's idleWritePeriod).
54+
_validate_max_staleness(max_staleness,
55+
selection.heartbeat_frequency,
56+
primary.idle_write_period)
57+
3758
sds = []
3859

3960
for s in selection.server_descriptions:
@@ -54,9 +75,25 @@ def _with_primary(max_staleness, selection):
5475

5576
def _no_primary(max_staleness, selection):
5677
"""Apply max_staleness, in seconds, to a Selection with no known primary."""
78+
# Secondary that's replicated the most recent writes.
5779
smax = selection.secondary_with_max_last_write_date()
80+
if not smax:
81+
# No secondaries and no primary, short-circuit out of here.
82+
return selection.with_server_descriptions([])
83+
84+
# Secondary we've most recently checked.
85+
srecent = selection.secondary_with_max_last_update_time()
86+
assert srecent
87+
5888
sds = []
5989

90+
# Server Selection Spec: If the TopologyType is ReplicaSetNoPrimary, a
91+
# client MUST raise an error if maxStaleness < heartbeatFrequency +
92+
# (idleWritePeriod of secondary with greatest lastUpdateTime).
93+
_validate_max_staleness(max_staleness,
94+
selection.heartbeat_frequency,
95+
srecent.idle_write_period)
96+
6097
for s in selection.server_descriptions:
6198
if s.server_type == SERVER_TYPE.RSSecondary:
6299
# See max-staleness.rst for explanation of this formula.
@@ -77,13 +114,6 @@ def select(max_staleness, selection):
77114
if not max_staleness:
78115
return selection
79116

80-
# Server Selection Spec: "A driver MUST raise an error if the
81-
# TopologyType is ReplicaSetWithPrimary or ReplicaSetNoPrimary and
82-
# maxStalenessSeconds * 1000 is less than twice heartbeatFrequencyMS."
83-
if max_staleness < 2 * selection.heartbeat_frequency:
84-
raise ConfigurationError(
85-
"maxStalenessSeconds must be twice heartbeatFrequencyMS")
86-
87117
if selection.primary:
88118
return _with_primary(max_staleness, selection)
89119
else:

‎pymongo/server_description.py‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ class ServerDescription(object):
4545
'_primary', '_max_bson_size', '_max_message_size',
4646
'_max_write_batch_size', '_min_wire_version', '_max_wire_version',
4747
'_round_trip_time', '_me', '_is_writable', '_is_readable', '_error',
48-
'_set_version', '_election_id', '_last_write_date', '_last_update_time')
48+
'_set_version', '_election_id', '_last_write_date', '_last_update_time',
49+
'_idle_write_period')
4950

5051
def __init__(
5152
self,
@@ -74,6 +75,7 @@ def __init__(
7475
self._round_trip_time = round_trip_time
7576
self._me = ismaster.me
7677
self._last_update_time = _time()
78+
self._idle_write_period = ismaster.idle_write_period
7779
self._error = error
7880

7981
if ismaster.last_write_date:
@@ -164,6 +166,10 @@ def last_write_date(self):
164166
def last_update_time(self):
165167
return self._last_update_time
166168

169+
@property
170+
def idle_write_period(self):
171+
return self._idle_write_period
172+
167173
@property
168174
def round_trip_time(self):
169175
"""The current average latency or None."""

‎pymongo/server_selectors.py‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,16 @@ def with_server_descriptions(self, server_descriptions):
5151
self.primary)
5252

5353
def secondary_with_max_last_write_date(self):
54-
smax = None
55-
for s in self.topology_description.known_servers:
56-
if s.server_type == SERVER_TYPE.RSSecondary:
57-
if not smax:
58-
smax = s
59-
else:
60-
if s.last_write_date > smax.last_write_date:
61-
smax = s
54+
secondaries = secondary_server_selector(self)
55+
if secondaries.server_descriptions:
56+
return max(secondaries.server_descriptions,
57+
key=lambda sd: sd.last_write_date)
6258

63-
return smax
59+
def secondary_with_max_last_update_time(self):
60+
secondaries = secondary_server_selector(self)
61+
if secondaries.server_descriptions:
62+
return max(secondaries.server_descriptions,
63+
key=lambda sd: sd.last_update_time)
6464

6565
@property
6666
def primary_selection(self):
@@ -71,6 +71,10 @@ def primary_selection(self):
7171
def heartbeat_frequency(self):
7272
return self.topology_description.heartbeat_frequency
7373

74+
@property
75+
def topology_type(self):
76+
return self.topology_description.topology_type
77+
7478
def __bool__(self):
7579
return bool(self.server_descriptions)
7680

‎test/max_staleness/ReplicaSetNoPrimary/IdleWritePeriod.json‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
{
2+
"heartbeatFrequencyMS": 500,
3+
"in_latency_window": [
4+
{
5+
"address": "a:27017",
6+
"avg_rtt_ms": 5,
7+
"idleWritePeriodMillis": 9000,
8+
"lastUpdateTime": 1,
9+
"lastWrite": {
10+
"lastWriteDate": {
11+
"$numberLong": "1"
12+
}
13+
},
14+
"maxWireVersion": 5,
15+
"type": "RSSecondary"
16+
}
17+
],
18+
"read_preference": {
19+
"maxStalenessSeconds": 10,
20+
"mode": "Nearest"
21+
},
22+
"suitable_servers": [
23+
{
24+
"address": "a:27017",
25+
"avg_rtt_ms": 5,
26+
"idleWritePeriodMillis": 9000,
27+
"lastUpdateTime": 1,
28+
"lastWrite": {
29+
"lastWriteDate": {
30+
"$numberLong": "1"
31+
}
32+
},
33+
"maxWireVersion": 5,
34+
"type": "RSSecondary"
35+
},
36+
{
37+
"address": "b:27017",
38+
"avg_rtt_ms": 50,
39+
"idleWritePeriodMillis": 11000,
40+
"lastUpdateTime": 0,
41+
"lastWrite": {
42+
"lastWriteDate": {
43+
"$numberLong": "1"
44+
}
45+
},
46+
"maxWireVersion": 5,
47+
"type": "RSSecondary"
48+
}
49+
],
50+
"topology_description": {
51+
"servers": [
52+
{
53+
"address": "a:27017",
54+
"avg_rtt_ms": 5,
55+
"idleWritePeriodMillis": 9000,
56+
"lastUpdateTime": 1,
57+
"lastWrite": {
58+
"lastWriteDate": {
59+
"$numberLong": "1"
60+
}
61+
},
62+
"maxWireVersion": 5,
63+
"type": "RSSecondary"
64+
},
65+
{
66+
"address": "b:27017",
67+
"avg_rtt_ms": 50,
68+
"idleWritePeriodMillis": 11000,
69+
"lastUpdateTime": 0,
70+
"lastWrite": {
71+
"lastWriteDate": {
72+
"$numberLong": "1"
73+
}
74+
},
75+
"maxWireVersion": 5,
76+
"type": "RSSecondary"
77+
}
78+
],
79+
"type": "ReplicaSetNoPrimary"
80+
}
81+
}

‎test/max_staleness/ReplicaSetNoPrimary/IdleWritePeriod2.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"error": true,
3+
"heartbeatFrequencyMS": 500,
4+
"read_preference": {
5+
"maxStalenessSeconds": 10.5,
6+
"mode": "Nearest"
7+
},
8+
"topology_description": {
9+
"servers": [
10+
{
11+
"address": "a:27017",
12+
"avg_rtt_ms": 5,
13+
"idleWritePeriodMillis": 9000,
14+
"lastUpdateTime": 0,
15+
"lastWrite": {
16+
"lastWriteDate": {
17+
"$numberLong": "1"
18+
}
19+
},
20+
"maxWireVersion": 5,
21+
"type": "RSSecondary"
22+
},
23+
{
24+
"address": "b:27017",
25+
"avg_rtt_ms": 5,
26+
"idleWritePeriodMillis": 11000,
27+
"lastUpdateTime": 1,
28+
"lastWrite": {
29+
"lastWriteDate": {
30+
"$numberLong": "1"
31+
}
32+
},
33+
"maxWireVersion": 5,
34+
"type": "RSSecondary"
35+
}
36+
],
37+
"type": "ReplicaSetNoPrimary"
38+
}
39+
}

‎test/max_staleness/ReplicaSetNoPrimary/MaxStalenessTooSmall.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"error": true,
3+
"heartbeatFrequencyMS": 500,
4+
"read_preference": {
5+
"maxStalenessSeconds": 10.4,
6+
"mode": "Nearest"
7+
},
8+
"topology_description": {
9+
"servers": [
10+
{
11+
"address": "a:27017",
12+
"avg_rtt_ms": 5,
13+
"lastUpdateTime": 0,
14+
"lastWrite": {
15+
"lastWriteDate": {
16+
"$numberLong": "1"
17+
}
18+
},
19+
"maxWireVersion": 5,
20+
"type": "RSSecondary"
21+
},
22+
{
23+
"address": "b:27017",
24+
"avg_rtt_ms": 5,
25+
"lastUpdateTime": 0,
26+
"lastWrite": {
27+
"lastWriteDate": {
28+
"$numberLong": "1"
29+
}
30+
},
31+
"maxWireVersion": 5,
32+
"type": "RSSecondary"
33+
}
34+
],
35+
"type": "ReplicaSetNoPrimary"
36+
}
37+
}

‎test/max_staleness/ReplicaSetWithPrimary/IdleWritePeriod.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"error": true,
3+
"heartbeatFrequencyMS": 500,
4+
"read_preference": {
5+
"maxStalenessSeconds": 10.5,
6+
"mode": "Nearest"
7+
},
8+
"topology_description": {
9+
"servers": [
10+
{
11+
"address": "a:27017",
12+
"avg_rtt_ms": 5,
13+
"idleWritePeriodMillis": 11000,
14+
"lastUpdateTime": 0,
15+
"lastWrite": {
16+
"lastWriteDate": {
17+
"$numberLong": "1"
18+
}
19+
},
20+
"maxWireVersion": 5,
21+
"type": "RSPrimary"
22+
},
23+
{
24+
"address": "b:27017",
25+
"avg_rtt_ms": 5,
26+
"idleWritePeriodMillis": 9000,
27+
"lastUpdateTime": 1,
28+
"lastWrite": {
29+
"lastWriteDate": {
30+
"$numberLong": "1"
31+
}
32+
},
33+
"maxWireVersion": 5,
34+
"type": "RSSecondary"
35+
}
36+
],
37+
"type": "ReplicaSetWithPrimary"
38+
}
39+
}

0 commit comments

Comments
 (0)