1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2014-2020 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
class Server
class Description
# Defines behavior around what features a specific server supports.
#
# @since 2.0.0
class Features
# List of features and the wire protocol version they appear in.
#
# Wire protocol versions map to server releases as follows:
# - 2 => 2.6
# - 3 => 3.0
# - 4 => 3.2
# - 5 => 3.4
# - 6 => 3.6
# - 7 => 4.0
# - 8 => 4.2
# - 9 => 4.4
# - 13 => 5.0
# - 14 => 5.1
# - 17 => 6.0
#
# @since 2.0.0
MAPPINGS = {
merge_out_on_secondary: 13,
get_more_comment: 9,
retryable_write_error_label: 9,
commit_quorum: 9,
# Server versions older than 4.2 do not reliably validate options
# provided by the client during findAndModify operations, requiring the
# driver to raise client-side errors when those options are provided.
find_and_modify_option_validation: 8,
sharded_transactions: 8,
transactions: 7,
scram_sha_256: 7,
array_filters: 6,
op_msg: 6,
sessions: 6,
collation: 5,
max_staleness: 5,
# Server versions older than 3.4 do not reliably validate options
# provided by the client during update/delete operations, requiring the
# driver to raise client-side errors when those options are provided.
update_delete_option_validation: 5,
find_command: 4,
list_collections: 3,
list_indexes: 3,
scram_sha_1: 3,
write_command: 2,
users_info: 2,
}.freeze
# Error message if the server is too old for this version of the driver.
#
# @since 2.5.0
SERVER_TOO_OLD = "Server at (%s) reports wire version (%s), but this version of the Ruby driver " +
"requires at least (%s)."
# Warning message if the server version is deprecated.
SERVER_DEPRECATED = 'Server at (%s) reports wire version (%s), but support for that wire version ' \
'is deprecated and will be removed in a future version of the Ruby driver. ' \
'Please upgrade your MongoDB server to a newer version soon.'
# Error message if the driver is too old for the version of the server.
#
# @since 2.5.0
DRIVER_TOO_OLD = "Server at (%s) requires wire version (%s), but this version of the Ruby driver " +
"only supports up to (%s)."
# An empty range constant, for use in DEPRECATED_WIRE_VERSIONS.
EMPTY_RANGE = (0...0).freeze
# The wire protocol versions that this version of the driver supports.
#
# @since 2.0.0
DRIVER_WIRE_VERSIONS = 6..25
# The wire protocol versions that are deprecated in this version of the
# driver. Support for these versions will be removed in the future.
#
# If there are multiple currently-deprecated wire versions, this should
# be set to a range of those versions.
#
# If there is only a single currently-deprecated wire version, this should
# be set to a range where the min and max are the same value.
#
# If there are no currently-deprecated wire versions, this should be
# set to an empty range (e.g. the EMPTY_RANGE constant).
DEPRECATED_WIRE_VERSIONS = 6..7
# make sure the deprecated versions are valid
if DEPRECATED_WIRE_VERSIONS.min
if DRIVER_WIRE_VERSIONS.min > DEPRECATED_WIRE_VERSIONS.max
raise ArgumentError, 'DEPRECATED_WIRE_VERSIONS must be empty, or be within DRIVER_WIRE_VERSIONS'
end
end
# Create the methods for each mapping to tell if they are supported.
#
# @since 2.0.0
MAPPINGS.each do |name, version|
# Determine whether or not the feature is supported.
#
# @example Is a feature enabled?
# features.list_collections_enabled?
#
# @return [ true, false ] Whether the feature is supported.
#
# @since 2.0.0
define_method("#{name}_enabled?") do
server_wire_versions.include?(MAPPINGS[name])
end
end
# @return [ Range ] server_wire_versions The server's supported wire
# versions.
attr_reader :server_wire_versions
# Initialize the features.
#
# @example Initialize the features.
# Features.new(0..3)
#
# @param [ Range ] server_wire_versions The server supported wire
# versions.
#
# @since 2.0.0
def initialize(server_wire_versions, address = nil)
if server_wire_versions.min.nil?
raise ArgumentError, "server_wire_versions's min is nil"
end
if server_wire_versions.max.nil?
raise ArgumentError, "server_wire_versions's max is nil"
end
@server_wire_versions = server_wire_versions
@address = address
if Mongo::Lint.enabled?
freeze
end
end
# Check that there is an overlap between the driver supported wire
# version range and the server wire version range. Also checks to see
# if the server is using a deprecated wire version.
#
# @raise [ Error::UnsupportedFeatures ] If the wire version range is
# not covered by the driver.
def check_driver_support!
if DEPRECATED_WIRE_VERSIONS.include?(@server_wire_versions.max)
feature = "wire_version:#{@address}"
Mongo::Deprecations.warn(feature, SERVER_DEPRECATED % [@address, @server_wire_versions.max])
elsif DRIVER_WIRE_VERSIONS.min > @server_wire_versions.max
raise Error::UnsupportedFeatures.new(SERVER_TOO_OLD % [@address,
@server_wire_versions.max,
DRIVER_WIRE_VERSIONS.min])
elsif DRIVER_WIRE_VERSIONS.max < @server_wire_versions.min
raise Error::UnsupportedFeatures.new(DRIVER_TOO_OLD % [@address,
@server_wire_versions.min,
DRIVER_WIRE_VERSIONS.max])
end
end
end
end
end
end
|
