-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
EndTransactionOperation.cs
298 lines (268 loc) · 10.9 KB
/
EndTransactionOperation.cs
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
/* Copyright 2018-present 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.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Serializers;
using MongoDB.Driver.Core.Bindings;
using MongoDB.Driver.Core.Misc;
using MongoDB.Driver.Core.WireProtocol.Messages.Encoders;
namespace MongoDB.Driver.Core.Operations
{
/// <summary>
/// Abstract base class for AbortTransactionOperation and CommitTransactionOperation.
/// </summary>
public abstract class EndTransactionOperation : IReadOperation<BsonDocument>
{
// private fields
private MessageEncoderSettings _messageEncoderSettings;
private readonly BsonDocument _recoveryToken;
private readonly WriteConcern _writeConcern;
// protected constructors
/// <summary>
/// Initializes a new instance of the <see cref="EndTransactionOperation"/> class.
/// </summary>
/// <param name="recoveryToken">The recovery token.</param>
/// <param name="writeConcern">The write concern.</param>
protected EndTransactionOperation(BsonDocument recoveryToken, WriteConcern writeConcern)
{
_recoveryToken = recoveryToken;
_writeConcern = Ensure.IsNotNull(writeConcern, nameof(writeConcern));
}
/// <summary>
/// Initializes a new instance of the <see cref="EndTransactionOperation"/> class.
/// </summary>
/// <param name="writeConcern">The write concern.</param>
protected EndTransactionOperation(WriteConcern writeConcern)
: this(recoveryToken: null, writeConcern)
{
}
// public properties
/// <summary>
/// Gets or sets the message encoder settings.
/// </summary>
/// <value>
/// The message encoder settings.
/// </value>
public MessageEncoderSettings MessageEncoderSettings
{
get { return _messageEncoderSettings; }
set { _messageEncoderSettings = value; }
}
/// <summary>
/// Gets the write concern.
/// </summary>
/// <value>
/// The write concern.
/// </value>
public WriteConcern WriteConcern => _writeConcern;
// protected properties
/// <summary>
/// Gets the name of the command.
/// </summary>
/// <value>
/// The name of the command.
/// </value>
protected abstract string CommandName { get; }
// public methods
/// <inheritdoc />
public virtual BsonDocument Execute(IReadBinding binding, CancellationToken cancellationToken)
{
Ensure.IsNotNull(binding, nameof(binding));
using (var channelSource = binding.GetReadChannelSource(cancellationToken))
using (var channel = channelSource.GetChannel(cancellationToken))
using (var channelBinding = new ChannelReadWriteBinding(channelSource.Server, channel, binding.Session.Fork()))
{
var operation = CreateOperation();
return operation.Execute(channelBinding, cancellationToken);
}
}
/// <inheritdoc />
public virtual async Task<BsonDocument> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)
{
Ensure.IsNotNull(binding, nameof(binding));
using (var channelSource = await binding.GetReadChannelSourceAsync(cancellationToken).ConfigureAwait(false))
using (var channel = await channelSource.GetChannelAsync(cancellationToken).ConfigureAwait(false))
using (var channelBinding = new ChannelReadWriteBinding(channelSource.Server, channel, binding.Session.Fork()))
{
var operation = CreateOperation();
return await operation.ExecuteAsync(channelBinding, cancellationToken).ConfigureAwait(false);
}
}
// protected methods
/// <summary>
/// Creates the command for the operation.
/// </summary>
/// <returns>The command.</returns>
protected virtual BsonDocument CreateCommand()
{
return new BsonDocument
{
{ CommandName, 1 },
{ "writeConcern", () => _writeConcern.ToBsonDocument(), !_writeConcern.IsServerDefault },
{ "recoveryToken", _recoveryToken, _recoveryToken != null }
};
}
// private methods
private IReadOperation<BsonDocument> CreateOperation()
{
var command = CreateCommand();
return new ReadCommandOperation<BsonDocument>(DatabaseNamespace.Admin, command, BsonDocumentSerializer.Instance, _messageEncoderSettings)
{
RetryRequested = false
};
}
}
/// <summary>
/// The abort transaction operation.
/// </summary>
public sealed class AbortTransactionOperation : EndTransactionOperation
{
// public constructors
/// <summary>
/// Initializes a new instance of the <see cref="AbortTransactionOperation"/> class.
/// </summary>
/// <param name="recoveryToken">The recovery token.</param>
/// <param name="writeConcern">The write concern.</param>
public AbortTransactionOperation(BsonDocument recoveryToken, WriteConcern writeConcern)
: base(recoveryToken, writeConcern)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="AbortTransactionOperation"/> class.
/// </summary>
/// <param name="writeConcern">The write concern.</param>
public AbortTransactionOperation(WriteConcern writeConcern)
: base(writeConcern)
{
}
// protected properties
/// <inheritdoc />
protected override string CommandName => "abortTransaction";
}
/// <summary>
/// The commit transaction operation.
/// </summary>
public sealed class CommitTransactionOperation : EndTransactionOperation
{
// private fields
private TimeSpan? _maxCommitTime;
// public constructors
/// <summary>
/// Initializes a new instance of the <see cref="AbortTransactionOperation"/> class.
/// </summary>
/// <param name="writeConcern">The write concern.</param>
public CommitTransactionOperation(WriteConcern writeConcern)
: base(writeConcern)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="AbortTransactionOperation"/> class.
/// </summary>
/// <param name="recoveryToken">The recovery token.</param>
/// <param name="writeConcern">The write concern.</param>
public CommitTransactionOperation(BsonDocument recoveryToken, WriteConcern writeConcern)
: base(recoveryToken, writeConcern)
{
}
// public properties
/// <summary>Gets the maximum commit time.</summary>
/// <value>The maximum commit time.</value>
public TimeSpan? MaxCommitTime
{
get => _maxCommitTime;
set => _maxCommitTime = Ensure.IsNullOrGreaterThanZero(value, nameof(value));
}
// protected properties
/// <inheritdoc />
protected override string CommandName => "commitTransaction";
// public methods
/// <inheritdoc />
public override BsonDocument Execute(IReadBinding binding, CancellationToken cancellationToken)
{
try
{
return base.Execute(binding, cancellationToken);
}
catch (MongoException exception) when (ShouldReplaceTransientTransactionErrorWithUnknownTransactionCommitResult(exception))
{
ReplaceTransientTransactionErrorWithUnknownTransactionCommitResult(exception);
throw;
}
}
/// <inheritdoc />
public override async Task<BsonDocument> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)
{
try
{
return await base.ExecuteAsync(binding, cancellationToken).ConfigureAwait(false);
}
catch (MongoException exception) when (ShouldReplaceTransientTransactionErrorWithUnknownTransactionCommitResult(exception))
{
ReplaceTransientTransactionErrorWithUnknownTransactionCommitResult(exception);
throw;
}
}
// protected methods
/// <inheritdoc />
protected override BsonDocument CreateCommand()
{
var command = base.CreateCommand();
if (_maxCommitTime.HasValue)
{
command.Add("maxTimeMS", (long)_maxCommitTime.Value.TotalMilliseconds);
}
return command;
}
// private methods
private void ReplaceTransientTransactionErrorWithUnknownTransactionCommitResult(MongoException exception)
{
exception.RemoveErrorLabel("TransientTransactionError");
exception.AddErrorLabel("UnknownTransactionCommitResult");
}
private bool ShouldReplaceTransientTransactionErrorWithUnknownTransactionCommitResult(MongoException exception)
{
if (exception is MongoConnectionException)
{
return true;
}
if (exception is MongoNotPrimaryException ||
exception is MongoNodeIsRecoveringException ||
exception is MongoExecutionTimeoutException) // MaxTimeMSExpired
{
return true;
}
var writeConcernException = exception as MongoWriteConcernException;
if (writeConcernException != null)
{
var writeConcernError = writeConcernException.WriteConcernResult.Response?.GetValue("writeConcernError", null)?.AsBsonDocument;
if (writeConcernError != null)
{
var code = (ServerErrorCode)writeConcernError.GetValue("code", -1).ToInt32();
switch (code)
{
case ServerErrorCode.UnsatisfiableWriteConcern:
case ServerErrorCode.UnknownReplWriteConcern:
return false;
default:
return true;
}
}
}
return false;
}
}
}