/
Server.cs
634 lines (525 loc) · 17.1 KB
/
Server.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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
#nullable disable
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Timers;
using Speckle.Core.Credentials;
using Speckle.Core.Helpers;
using Speckle.Core.Logging;
using Speckle.Newtonsoft.Json;
using Timer = System.Timers.Timer;
// ReSharper disable InconsistentNaming
#pragma warning disable IDE1006, IDE0018, CA2000, CA1031, CS1634, CS1570, CS1696, CA1836, CA1854, CA1834, CA2201, CA1725, CA1861, CA1024
namespace Speckle.Core.Transports;
/// <summary>
/// Sends data to a speckle server.
/// </summary>
[Obsolete("Use " + nameof(ServerTransport))]
public sealed class ServerTransportV1 : IDisposable, ICloneable, ITransport
{
private const int DownloadBatchSize = 1000;
private bool _isWriting;
private const int MaxBufferSize = 1_000_000;
private const int MaxMultipartCount = 50;
private ConcurrentQueue<(string, string, int)> _queue = new();
private int _totalElapsed;
private const int PollInterval = 100;
private Timer _writeTimer;
public ServerTransportV1(Account account, string streamId, int timeoutSeconds = 60)
{
Account = account;
Initialize(account.serverInfo.url, streamId, account.token, timeoutSeconds);
}
public string BaseUri { get; private set; }
public string StreamId { get; set; }
private HttpClient Client { get; set; }
public bool CompressPayloads { get; set; } = true;
public int TotalSentBytes { get; set; }
public Account Account { get; set; }
public object Clone()
{
return new ServerTransport(Account, StreamId)
{
OnErrorAction = OnErrorAction,
OnProgressAction = OnProgressAction,
CancellationToken = CancellationToken
};
}
public void Dispose()
{
// TODO: check if it's writing first?
Client?.Dispose();
_writeTimer.Dispose();
}
public string TransportName { get; set; } = "RemoteTransport";
public Dictionary<string, object> TransportContext =>
new()
{
{ "name", TransportName },
{ "type", GetType().Name },
{ "streamId", StreamId },
{ "serverUrl", BaseUri }
};
public CancellationToken CancellationToken { get; set; }
public int SavedObjectCount { get; private set; }
public Action<string, int> OnProgressAction { get; set; }
public Action<string, Exception> OnErrorAction { get; set; }
// not implementing this for V1, just a dummy 0 value
public TimeSpan Elapsed => TimeSpan.Zero;
public void BeginWrite()
{
if (!GetWriteCompletionStatus())
{
throw new SpeckleException("Transport is still writing.");
}
TotalSentBytes = 0;
SavedObjectCount = 0;
}
public void EndWrite() { }
public async Task<Dictionary<string, bool>> HasObjects(IReadOnlyList<string> objectIds)
{
var payload = new Dictionary<string, string> { { "objects", JsonConvert.SerializeObject(objectIds) } };
var uri = new Uri($"/api/diff/{StreamId}", UriKind.Relative);
var response = await Client
.PostAsync(
uri,
new StringContent(JsonConvert.SerializeObject(payload), Encoding.UTF8, "application/json"),
CancellationToken
)
.ConfigureAwait(false);
response.EnsureSuccessStatusCode();
var hasObjectsJson = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
var hasObjects = JsonConvert.DeserializeObject<Dictionary<string, bool>>(hasObjectsJson);
return hasObjects;
}
private void Initialize(string baseUri, string streamId, string authorizationToken, int timeoutSeconds = 60)
{
SpeckleLog.Logger.Information("Initializing New Remote V1 Transport for {baseUri}", baseUri);
BaseUri = baseUri;
StreamId = streamId;
Client = Http.GetHttpProxyClient(
new SpeckleHttpClientHandler { AutomaticDecompression = DecompressionMethods.GZip }
);
Client.BaseAddress = new Uri(baseUri);
Client.Timeout = new TimeSpan(0, 0, timeoutSeconds);
Http.AddAuthHeader(Client, authorizationToken);
_writeTimer = new Timer
{
AutoReset = true,
Enabled = false,
Interval = PollInterval
};
_writeTimer.Elapsed += WriteTimerElapsed;
}
public override string ToString()
{
return $"Server Transport @{Account.serverInfo.url}";
}
internal class Placeholder
{
public Dictionary<string, int> __closure { get; set; } = new();
}
#region Writing objects
public async Task WriteComplete()
{
await Utilities
.WaitUntil(
() =>
{
return GetWriteCompletionStatus();
},
50
)
.ConfigureAwait(false);
}
public bool GetWriteCompletionStatus()
{
return _queue.Count == 0 && !_isWriting;
}
private void WriteTimerElapsed(object sender, ElapsedEventArgs e)
{
_totalElapsed += PollInterval;
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
_isWriting = false;
return;
}
if (_totalElapsed > 300 && _isWriting == false && _queue.Count != 0)
{
_totalElapsed = 0;
_writeTimer.Enabled = false;
#pragma warning disable CS4014
ConsumeQueue();
#pragma warning restore CS4014
}
}
/// <summary>
/// Consumes a batch of objects from Queue, of MAX_BUFFER_SIZE or until queue is empty, and filters out the objects that already exist on the server
/// </summary>
/// <returns>
/// Tuple of:
/// - int: the number of objects consumed from the queue (useful to report progress)
/// - List<(string, string, int)>: List of queued objects that are not already on the server
/// </returns>
private async Task<(int, List<(string, string, int)>)> ConsumeNewBatch()
{
// Read a batch from the queue
List<(string, string, int)> queuedBatch = new();
List<string> queuedBatchIds = new();
ValueTuple<string, string, int> queueElement;
var payloadBufferSize = 0;
while (_queue.TryPeek(out queueElement) && payloadBufferSize < MaxBufferSize)
{
if (CancellationToken.IsCancellationRequested)
{
return (queuedBatch.Count, null);
}
_queue.TryDequeue(out queueElement);
queuedBatch.Add(queueElement);
queuedBatchIds.Add(queueElement.Item1);
payloadBufferSize += queueElement.Item3;
}
// Ask the server which objects from the batch it already has
Dictionary<string, bool> hasObjects = null;
try
{
hasObjects = await HasObjects(queuedBatchIds).ConfigureAwait(false);
}
catch (Exception e)
{
OnErrorAction?.Invoke(TransportName, e);
return (queuedBatch.Count, null);
}
// Filter the queued batch to only return new objects
List<(string, string, int)> newBatch = new();
foreach (var queuedItem in queuedBatch)
{
if (!hasObjects.ContainsKey(queuedItem.Item1) || !hasObjects[queuedItem.Item1])
{
newBatch.Add(queuedItem);
}
}
return (queuedBatch.Count, newBatch);
}
private async Task ConsumeQueue()
{
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
_isWriting = false;
return;
}
if (_queue.Count == 0)
{
return;
}
_isWriting = true;
using var message = new HttpRequestMessage
{
RequestUri = new Uri($"/objects/{StreamId}", UriKind.Relative),
Method = HttpMethod.Post
};
using var multipart = new MultipartFormDataContent("--obj--");
SavedObjectCount = 0;
var addedMpCount = 0;
while (addedMpCount < MaxMultipartCount && _queue.Count != 0)
{
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
_isWriting = false;
return;
}
(int consumedQueuedObjects, List<(string, string, int)> batch) = await ConsumeNewBatch().ConfigureAwait(false);
if (batch == null)
{
// Canceled or error happened (which was already reported)
_queue = new ConcurrentQueue<(string, string, int)>();
_isWriting = false;
return;
}
if (batch.Count == 0)
{
// The server already has all objects from the queued batch
SavedObjectCount += consumedQueuedObjects;
continue;
}
var _ctBuilder = new StringBuilder("[");
for (int i = 0; i < batch.Count; i++)
{
if (i > 0)
{
_ctBuilder.Append(",");
}
_ctBuilder.Append(batch[i].Item2);
TotalSentBytes += batch[i].Item3;
}
_ctBuilder.Append("]");
string _ct = _ctBuilder.ToString();
if (CompressPayloads)
{
var content = new GzipContent(new StringContent(_ct, Encoding.UTF8));
content.Headers.ContentType = new MediaTypeHeaderValue("application/gzip");
multipart.Add(content, $"batch-{addedMpCount}", $"batch-{addedMpCount}");
}
else
{
multipart.Add(new StringContent(_ct, Encoding.UTF8), $"batch-{addedMpCount}", $"batch-{addedMpCount}");
}
addedMpCount++;
SavedObjectCount += consumedQueuedObjects;
}
message.Content = multipart;
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
_isWriting = false;
return;
}
if (addedMpCount > 0)
{
try
{
var response = await Client.SendAsync(message, CancellationToken).ConfigureAwait(false);
response.EnsureSuccessStatusCode();
}
catch (Exception e)
{
_isWriting = false;
OnErrorAction?.Invoke(
TransportName,
new Exception($"Remote error: {Account.serverInfo.url} is not reachable. \n {e.Message}", e)
);
_queue = new ConcurrentQueue<(string, string, int)>();
return;
}
}
_isWriting = false;
OnProgressAction?.Invoke(TransportName, SavedObjectCount);
if (!_writeTimer.Enabled)
{
_writeTimer.Enabled = true;
_writeTimer.Start();
}
}
public void SaveObject(string hash, string serializedObject)
{
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
_isWriting = false;
return;
}
_queue.Enqueue((hash, serializedObject, Encoding.UTF8.GetByteCount(serializedObject)));
if (!_writeTimer.Enabled && !_isWriting)
{
_writeTimer.Enabled = true;
_writeTimer.Start();
}
}
public void SaveObject(string hash, ITransport sourceTransport)
{
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
_isWriting = false;
return;
}
var serializedObject = sourceTransport.GetObject(hash);
_queue.Enqueue((hash, serializedObject, Encoding.UTF8.GetByteCount(serializedObject)));
if (!_writeTimer.Enabled && !_isWriting)
{
_writeTimer.Enabled = true;
_writeTimer.Start();
}
}
#endregion
#region Getting objects
public string GetObject(string id)
{
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
return null;
}
using var message = new HttpRequestMessage
{
RequestUri = new Uri($"/objects/{StreamId}/{id}/single", UriKind.Relative),
Method = HttpMethod.Get
};
var response = Client
.SendAsync(message, HttpCompletionOption.ResponseContentRead, CancellationToken)
.Result.Content;
return response.ReadAsStringAsync().Result;
}
public async Task<string> CopyObjectAndChildren(
string id,
ITransport targetTransport,
Action<int> onTotalChildrenCountKnown
)
{
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
return null;
}
// Get root object
using var rootHttpMessage = new HttpRequestMessage
{
RequestUri = new Uri($"/objects/{StreamId}/{id}/single", UriKind.Relative),
Method = HttpMethod.Get
};
HttpResponseMessage rootHttpResponse = null;
try
{
rootHttpResponse = await Client
.SendAsync(rootHttpMessage, HttpCompletionOption.ResponseContentRead, CancellationToken)
.ConfigureAwait(false);
rootHttpResponse.EnsureSuccessStatusCode();
}
catch (Exception e)
{
OnErrorAction?.Invoke(TransportName, e);
return null;
}
string rootObjectStr = await rootHttpResponse.Content.ReadAsStringAsync().ConfigureAwait(false);
List<string> childrenIds = new();
var rootPartial = JsonConvert.DeserializeObject<Placeholder>(rootObjectStr);
if (rootPartial.__closure != null)
{
childrenIds = new List<string>(rootPartial.__closure.Keys);
}
onTotalChildrenCountKnown?.Invoke(childrenIds.Count);
var childrenFoundMap = await targetTransport.HasObjects(childrenIds).ConfigureAwait(false);
List<string> newChildrenIds = new(from objId in childrenFoundMap.Keys where !childrenFoundMap[objId] select objId);
targetTransport.BeginWrite();
// Get the children that are not already in the targetTransport
List<string> childrenIdBatch = new(DownloadBatchSize);
bool downloadBatchResult;
foreach (var objectId in newChildrenIds)
{
childrenIdBatch.Add(objectId);
if (childrenIdBatch.Count >= DownloadBatchSize)
{
downloadBatchResult = await CopyObjects(childrenIdBatch, targetTransport).ConfigureAwait(false);
if (!downloadBatchResult)
{
return null;
}
childrenIdBatch = new List<string>(DownloadBatchSize);
}
}
if (childrenIdBatch.Count > 0)
{
downloadBatchResult = await CopyObjects(childrenIdBatch, targetTransport).ConfigureAwait(false);
if (!downloadBatchResult)
{
return null;
}
}
targetTransport.SaveObject(id, rootObjectStr);
await targetTransport.WriteComplete().ConfigureAwait(false);
return rootObjectStr;
}
private async Task<bool> CopyObjects(List<string> hashes, ITransport targetTransport)
{
Stream childrenStream = null;
if (hashes.Count <= 0)
{
childrenStream = new MemoryStream();
}
else
{
using var childrenHttpMessage = new HttpRequestMessage
{
RequestUri = new Uri($"/api/getobjects/{StreamId}", UriKind.Relative),
Method = HttpMethod.Post
};
Dictionary<string, string> postParameters = new();
postParameters.Add("objects", JsonConvert.SerializeObject(hashes));
childrenHttpMessage.Content = new FormUrlEncodedContent(postParameters);
childrenHttpMessage.Headers.Add("Accept", "text/plain");
HttpResponseMessage childrenHttpResponse = null;
try
{
childrenHttpResponse = await Client
.SendAsync(childrenHttpMessage, HttpCompletionOption.ResponseHeadersRead, CancellationToken)
.ConfigureAwait(false);
childrenHttpResponse.EnsureSuccessStatusCode();
}
catch (Exception e)
{
OnErrorAction?.Invoke(TransportName, e);
return false;
}
childrenStream = await childrenHttpResponse.Content.ReadAsStreamAsync().ConfigureAwait(false);
}
using var stream = childrenStream;
using var reader = new StreamReader(stream, Encoding.UTF8);
string line;
while ((line = reader.ReadLine()) != null)
{
if (CancellationToken.IsCancellationRequested)
{
_queue = new ConcurrentQueue<(string, string, int)>();
return false;
}
var pcs = line.Split(new[] { '\t' }, 2);
targetTransport.SaveObject(pcs[0], pcs[1]);
OnProgressAction?.Invoke(TransportName, 1); // possibly make this more friendly
}
return true;
}
#endregion
}
/// <summary>
/// https://cymbeline.ch/2014/03/16/gzip-encoding-an-http-post-request-body/
/// </summary>
[Obsolete("Use " + nameof(ServerUtils.GzipContent))]
internal sealed class GzipContent : HttpContent
{
private readonly HttpContent _content;
public GzipContent(HttpContent content)
{
this._content = content;
// Keep the original content's headers ...
if (content != null)
{
foreach (KeyValuePair<string, IEnumerable<string>> header in content.Headers)
{
Headers.TryAddWithoutValidation(header.Key, header.Value);
}
}
// ... and let the server know we've Gzip-compressed the body of this request.
Headers.ContentEncoding.Add("gzip");
}
protected override async Task SerializeToStreamAsync(Stream stream, TransportContext context)
{
// Open a GZipStream that writes to the specified output stream.
using GZipStream gzip = new(stream, CompressionMode.Compress, true);
if (_content != null)
{
await _content.CopyToAsync(gzip).ConfigureAwait(false);
}
else
{
await new StringContent(string.Empty).CopyToAsync(gzip).ConfigureAwait(false);
}
}
protected override bool TryComputeLength(out long length)
{
length = -1;
return false;
}
}
#pragma warning restore IDE1006, IDE0018, CA2000, CA1031, CS1634, CS1570, CS1696, CA1836, CA1854, CA1834, CA2201, CA1725, CA1861, CA1024