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
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2021 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
module Operation
# Context for operations.
#
# Holds various objects needed to make decisions about operation execution
# in a single container, and provides facade methods for the contained
# objects.
#
# The context contains parameters for operations, and as such while an
# operation is being prepared nothing in the context should change.
# When the result of the operation is being processed, the data
# returned by the context may change (for example, because a transaction
# is aborted), but at that point the operation should no longer read
# anything from the context. Because context data may change during
# operation execution, context objects should not be reused for multiple
# operations.
#
# @api private
class Context < CsotTimeoutHolder
def initialize(
client: nil,
session: nil,
connection_global_id: nil,
operation_timeouts: {},
view: nil,
options: nil
)
if options
if client
raise ArgumentError, 'Client and options cannot both be specified'
end
if session
raise ArgumentError, 'Session and options cannot both be specified'
end
end
if connection_global_id && session&.pinned_connection_global_id
raise ArgumentError, 'Trying to pin context to a connection when the session is already pinned to a connection.'
end
@client = client
@session = session
@view = view
@connection_global_id = connection_global_id
@options = options
super(session: session, operation_timeouts: operation_timeouts)
end
attr_reader :client
attr_reader :session
attr_reader :view
attr_reader :options
# Returns a new Operation::Context with the deadline refreshed
# and relative to the current moment.
#
# @return [ Operation::Context ] the refreshed context
def refresh(connection_global_id: @connection_global_id, timeout_ms: nil, view: nil)
operation_timeouts = @operation_timeouts
operation_timeouts = operation_timeouts.merge(operation_timeout_ms: timeout_ms) if timeout_ms
self.class.new(client: client,
session: session,
connection_global_id: connection_global_id,
operation_timeouts: operation_timeouts,
view: view || self.view,
options: options)
end
def connection_global_id
@connection_global_id || session&.pinned_connection_global_id
end
def in_transaction?
session&.in_transaction? || false
end
def starting_transaction?
session&.starting_transaction? || false
end
def committing_transaction?
in_transaction? && session.committing_transaction?
end
def aborting_transaction?
in_transaction? && session.aborting_transaction?
end
def modern_retry_writes?
client && client.options[:retry_writes]
end
def legacy_retry_writes?
client && !client.options[:retry_writes] && client.max_write_retries > 0
end
def any_retry_writes?
modern_retry_writes? || legacy_retry_writes?
end
def server_api
if client
client.options[:server_api]
elsif options
options[:server_api]
end
end
# Whether the operation is a retry (true) or an initial attempt (false).
def retry?
!!@is_retry
end
# Returns a new context with the parameters changed as per the
# provided arguments.
#
# @option opts [ true|false ] :is_retry Whether the operation is a retry
# or a first attempt.
def with(**opts)
dup.tap do |copy|
opts.each do |k, v|
copy.instance_variable_set("@#{k}", v)
end
end
end
def encrypt?
client&.encrypter&.encrypt? || false
end
def encrypt(db_name, cmd)
encrypter.encrypt(db_name, cmd, self)
end
def decrypt?
!!client&.encrypter
end
def decrypt(cmd)
encrypter.decrypt(cmd, self)
end
def encrypter
if client&.encrypter
client.encrypter
else
raise Error::InternalDriverError, 'Encrypter should only be accessed when encryption is to be performed'
end
end
def inspect
"#<#{self.class} connection_global_id=#{connection_global_id.inspect} deadline=#{deadline.inspect} options=#{options.inspect} operation_timeouts=#{operation_timeouts.inspect}>"
end
end
end
end
|
