mongo 2.3.1 → 2.4.0.rc0

data/spec/support/max_staleness/ReplicaSetWithPrimary/SecondaryPreferred_tags2.yml

@@ -0,0 +1,43 @@
+# maxStalenessMS is applied before tag sets. With tag sets
+# [{data_center: nyc}, {data_center: tokyo}], if the only secondary in NYC is
+# stale then use Tokyo.
+---
+heartbeatFrequencyMS: 25000  # 25 seconds.
+topology_description:
+  type: ReplicaSetWithPrimary
+  servers:
+  - &1
+    address: a:27017
+    type: RSPrimary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    lastWrite: {lastWriteDate: {$numberLong: "25002"}}
+    maxWireVersion: 5
+  - &2
+    address: b:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    lastWrite: {lastWriteDate: {$numberLong: "2"}}
+    maxWireVersion: 5
+    tags:
+      data_center: tokyo
+  - &3
+    address: c:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}  # Too stale.
+    maxWireVersion: 5
+    tags:
+      data_center: nyc
+read_preference:
+  mode: SecondaryPreferred
+  maxStalenessMS: 50000
+  tag_sets:
+  - data_center: nyc
+  - data_center: tokyo
+suitable_servers:
+- *2
+in_latency_window:
+- *2

data/spec/support/max_staleness/ReplicaSetWithPrimary/Secondary_tags.yml

@@ -0,0 +1,59 @@
+# Primary's lastWriteDate is used normally with SecondaryPreferred and tags.
+---
+heartbeatFrequencyMS: 25000  # 25 seconds.
+topology_description:
+  type: ReplicaSetWithPrimary
+  servers:
+  - &1
+    address: a:27017
+    type: RSPrimary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "25002"}}
+  - &2
+    address: b:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "2"}}  # 25 sec stale + 25 sec heartbeat <= 50 sec maxStaleness.
+    tags:
+      data_center: nyc
+  - &3
+    address: c:27017
+    type: RSSecondary
+    avg_rtt_ms: 50  # Too far.
+    lastUpdateTime: 1
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1000001"}}  # Not used in estimate since we have a primary.
+    tags:
+      data_center: nyc
+  - &4
+    address: d:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}  # Too stale.
+    tags:
+      data_center: nyc
+  - &5
+    address: e:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "2"}}
+    tags:
+      data_center: tokyo  # No match.
+read_preference:
+  mode: Secondary
+  maxStalenessMS: 50000
+  tag_sets:
+  - data_center: nyc
+suitable_servers:
+- *2
+- *3
+in_latency_window:
+- *2

data/spec/support/max_staleness/ReplicaSetWithPrimary/Secondary_tags2.yml

@@ -0,0 +1,43 @@
+# maxStalenessMS is applied before tag sets. With tag sets
+# [{data_center: nyc}, {data_center: tokyo}], if the only secondary in NYC is
+# stale then use Tokyo.
+---
+heartbeatFrequencyMS: 25000  # 25 seconds.
+topology_description:
+  type: ReplicaSetWithPrimary
+  servers:
+  - &1
+    address: a:27017
+    type: RSPrimary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    lastWrite: {lastWriteDate: {$numberLong: "25002"}}
+    maxWireVersion: 5
+  - &2
+    address: b:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    lastWrite: {lastWriteDate: {$numberLong: "2"}}
+    maxWireVersion: 5
+    tags:
+      data_center: tokyo
+  - &3
+    address: c:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}  # Too stale.
+    maxWireVersion: 5
+    tags:
+      data_center: nyc
+read_preference:
+  mode: Secondary
+  maxStalenessMS: 50000
+  tag_sets:
+  - data_center: nyc
+  - data_center: tokyo
+suitable_servers:
+- *2
+in_latency_window:
+- *2

data/spec/support/max_staleness/ReplicaSetWithPrimary/ShortHeartbeartShortMaxStaleness.yml

@@ -0,0 +1,29 @@
+# Users can configure a shorter ``heartbeatFrequencyMS`` than the default to
+# allow a smaller ``maxStalenessMS`` with replica sets.
+---
+heartbeatFrequencyMS: 1000  # 1 second.
+topology_description:
+  type: ReplicaSetWithPrimary
+  servers:
+  - &1
+    address: a:27017
+    type: RSPrimary
+    avg_rtt_ms: 50  # Too far.
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+  - &2
+    address: b:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+read_preference:
+  mode: Nearest
+  maxStalenessMS: 2000  # 2 seconds, permitted.
+suitable_servers:
+- *1
+- *2
+in_latency_window:
+- *2

data/spec/support/max_staleness/ReplicaSetWithPrimary/ShortHeartbeartShortMaxStaleness2.yml

@@ -0,0 +1,29 @@
+# Users can configure a shorter ``heartbeatFrequencyMS`` than the default to
+# allow a smaller ``maxStalenessMS`` with replica sets.
+---
+heartbeatFrequencyMS: 1000  # 1 second.
+topology_description:
+  type: ReplicaSetWithPrimary
+  servers:
+  - &1
+    address: a:27017
+    type: RSPrimary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+  - &2
+    address: b:27017
+    type: RSSecondary
+    avg_rtt_ms: 50  # Too far.
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+read_preference:
+  mode: Nearest
+  maxStalenessMS: 2000  # 2 seconds, permitted.
+suitable_servers:
+- *1
+- *2
+in_latency_window:
+- *1

data/spec/support/max_staleness/ReplicaSetWithPrimary/ZeroMaxStaleness.yml

@@ -0,0 +1,27 @@
+# A ``maxStalenessMS`` of zero or null MUST mean "no maximum".
+---
+topology_description:
+  type: ReplicaSetWithPrimary
+  servers:
+  - &1
+    address: a:27017
+    type: RSPrimary
+    avg_rtt_ms: 50  # Too far.
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1000001"}}
+  - &2
+    address: b:27017
+    type: RSSecondary
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}  # Very stale.
+read_preference:
+  mode: Nearest
+  maxStalenessMS: 0  # Means "no max staleness".
+suitable_servers:  # Very stale server is fine.
+- *1
+- *2
+in_latency_window:
+- *2

data/spec/support/max_staleness/Sharded/Incompatible.yml

@@ -0,0 +1,25 @@
+# During server selection,
+# clients (drivers or mongos) MUST raise an error if ``maxStalenessMS`` is not zero or null,
+# and any server's ``maxWireVersion`` is less than 5 (`SERVER-23893`_).
+---
+topology_description:
+  type: Sharded
+  servers:
+  - &1
+    address: a:27017
+    type: Mongos
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+  - &2
+    address: b:27017
+    type: Mongos
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 4  # Incompatible.
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+read_preference:
+  mode: Nearest
+  maxStalenessMS: 120000
+error: true

data/spec/support/max_staleness/Sharded/SmallMaxStaleness.yml

@@ -0,0 +1,20 @@
+# Driver doesn't validate maxStalenessMS for mongos
+---
+heartbeatFrequencyMS: 10000
+topology_description:
+  type: Sharded
+  servers:
+  - &1
+    address: a:27017
+    type: Mongos
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+read_preference:
+  mode: Nearest
+  maxStalenessMS: 1  # OK for sharding.
+suitable_servers:
+- *1
+in_latency_window:
+- *1

data/spec/support/max_staleness/Single/Incompatible.yml

@@ -0,0 +1,18 @@
+# During server selection,
+# clients (drivers or mongos) MUST raise an error if ``maxStalenessMS`` is not zero or null,
+# and any server's ``maxWireVersion`` is less than 5 (`SERVER-23893`_).
+---
+topology_description:
+  type: Single
+  servers:
+  - &1
+    address: a:27017
+    type: Standalone
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 4  # Incompatible.
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+read_preference:
+  mode: Nearest
+  maxStalenessMS: 120000
+error: true

data/spec/support/max_staleness/Single/SmallMaxStaleness.yml

@@ -0,0 +1,20 @@
+# Driver doesn't validate maxStalenessMS for direct connection.
+---
+heartbeatFrequencyMS: 10000
+topology_description:
+  type: Single
+  servers:
+  - &1
+    address: a:27017
+    type: Standalone
+    avg_rtt_ms: 5
+    lastUpdateTime: 0
+    maxWireVersion: 5
+    lastWrite: {lastWriteDate: {$numberLong: "1"}}
+read_preference:
+  mode: Nearest
+  maxStalenessMS: 1
+suitable_servers:
+- *1
+in_latency_window:
+- *1

data/spec/support/server_selection.rb

@@ -39,6 +39,16 @@ module Mongo
         # @since 2.0.0
         attr_reader :read_preference
 
+        # @return [ Integer ] heartbeat_frequency The heartbeat frequency to be set on the client.
+        #
+        # @since 2.4.0
+        attr_reader :heartbeat_frequency
+
+        # @return [ Integer ] max_staleness The max_staleness.
+        #
+        # @since 2.4.0
+        attr_reader :max_staleness
+
         # @return [ Array<Hash> ] candidate_servers The candidate servers.
         #
         # @since 2.0.0
@@ -74,8 +84,10 @@ module Mongo
           @test = YAML.load(ERB.new(file.read).result)
           file.close
           @description = "#{@test['topology_description']['type']}: #{File.basename(file)}"
+          @heartbeat_frequency = @test['heartbeatFrequencyMS']
           @read_preference = @test['read_preference']
           @read_preference['mode'] = READ_PREFERENCES[@read_preference['mode']]
+          @max_staleness = @read_preference['maxStalenessMS']
           @candidate_servers = @test['topology_description']['servers']
           @suitable_servers = @test['suitable_servers']
           @in_latency_window = @test['in_latency_window']
@@ -106,6 +118,19 @@ module Mongo
           !in_latency_window.empty?
         end
 
+        # Is the max staleness setting invalid.
+        #
+        # @example Will the max staleness setting be valid with other options.
+        #   spec.invalid_max_staleness?
+        #
+        # @return [ true, false ] If an error will be raised by the max staleness setting.
+        #
+        # @since 2.4.0
+        def invalid_max_staleness?
+          @test['error'] ||
+            candidate_servers.any? { |server| server['maxWireVersion'] < 5 }
+        end
+
         # The subset of suitable servers that falls within the allowable latency
         #   window.
         # We have to correct for our server selection algorithm that adds the primary

data/spec/support/server_selection/selection/ReplicaSetNoPrimary/read/Nearest_multiple.yml

@@ -0,0 +1,27 @@
+---
+topology_description:
+  type: ReplicaSetNoPrimary
+  servers:
+  - &1
+    address: b:27017
+    avg_rtt_ms: 10
+    type: RSSecondary
+    tags:
+      data_center: nyc
+  - &2
+    address: c:27017
+    avg_rtt_ms: 20
+    type: RSSecondary
+    tags:
+      data_center: nyc
+operation: read
+read_preference:
+  mode: Nearest
+  tag_sets:
+  - data_center: nyc
+suitable_servers:
+- *1
+- *2
+in_latency_window:
+- *1
+- *2

data/spec/support/server_selection/selection/ReplicaSetNoPrimary/read/Secondary_multi_tags.yml

@@ -0,0 +1,31 @@
+# Catch bugs like CDRIVER-1447, ensure clients select a server that matches all
+# tags, even when the other server mismatches multiple tags.
+---
+topology_description:
+  type: ReplicaSetNoPrimary
+  servers:
+  - &1
+    address: b:27017
+    avg_rtt_ms: 5
+    type: RSSecondary
+    tags:
+      rack: one
+      data_center: nyc
+  - &2
+    address: c:27017
+    avg_rtt_ms: 5
+    type: RSSecondary
+    tags:
+      rack: two
+      data_center: sf
+operation: read
+read_preference:
+  mode: Secondary
+  tag_sets:
+  - data_center: nyc
+    rack: one
+  - other_tag: doesntexist
+suitable_servers:
+- *1
+in_latency_window:
+- *1

data/spec/support/server_selection/selection/ReplicaSetNoPrimary/read/Secondary_multi_tags2.yml

@@ -0,0 +1,31 @@
+# Ensure clients select a server that matches all tags, even when the other
+# server matches one tag and doesn't match the other.
+---
+topology_description:
+  type: ReplicaSetNoPrimary
+  servers:
+  - &1
+    address: b:27017
+    avg_rtt_ms: 5
+    type: RSSecondary
+    tags:
+      rack: one
+      data_center: nyc
+  - &2
+    address: c:27017
+    avg_rtt_ms: 5
+    type: RSSecondary
+    tags:
+      rack: two           # mismatch
+      data_center: nyc    # match
+operation: read
+read_preference:
+  mode: Secondary
+  tag_sets:
+  - data_center: nyc
+    rack: one
+  - other_tag: doesntexist
+suitable_servers:
+- *1
+in_latency_window:
+- *1