-
Notifications
You must be signed in to change notification settings - Fork 1
/
ApiToolKit.cs
573 lines (478 loc) · 18.7 KB
/
ApiToolKit.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
using Google.Apis.Auth.OAuth2;
using Google.Cloud.PubSub.V1;
using Google.Protobuf.WellKnownTypes;
using Google.Protobuf;
using Microsoft.AspNetCore.Http.Extensions;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using NUnit.Framework;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json;
using System.Diagnostics;
using System.Text.Json;
using static System.Web.HttpUtility;
namespace ApiToolkit.Net
{
public class APIToolkit
{
private readonly RequestDelegate _next;
private readonly Client _client;
public APIToolkit(RequestDelegate next, Client client)
{
_next = next;
_client = client;
}
public async Task InvokeAsync(HttpContext context)
{
Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();
context.Request.EnableBuffering(); // so we can read the body stream multiple times
var responseBodyStream = new MemoryStream();
var originalResponseBodyStream = context.Response.Body;
context.Response.Body = responseBodyStream;
Guid uuid = Guid.NewGuid();
var msg_id = uuid.ToString();
context.Items["APITOOLKIT_MSG_ID"] = msg_id;
int statusCode = 0;
var requestBody = await new StreamReader(context.Request.Body).ReadToEndAsync();
context.Request.Body.Position = 0; // reset the body stream to the beginning
try
{
await _next(context); // execute the next middleware in the pipeline
}
catch (Exception ex)
{
statusCode = 500;
Client.ReportError(context, ex);
throw;
}
finally
{
responseBodyStream.Seek(0, SeekOrigin.Begin);
var responseBody = await new StreamReader(responseBodyStream).ReadToEndAsync();
responseBodyStream.Seek(0, SeekOrigin.Begin);
await responseBodyStream.CopyToAsync(originalResponseBodyStream);
context.Response.Body = originalResponseBodyStream;
var pathParams = context.GetRouteData().Values
.Where(v => !string.IsNullOrEmpty(v.Value?.ToString()))
.ToDictionary(v => v.Key, v => v.Value.ToString());
var urlPath = "";
var endpoint = context.GetEndpoint();
if (endpoint != null)
{
var routePattern = (endpoint as Microsoft.AspNetCore.Routing.RouteEndpoint)?.RoutePattern?.RawText;
if (routePattern != null)
{
urlPath = routePattern;
}
}
var responseHeaders = context.Response.Headers.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.ToList());
var errors = new List<ATError>();
if (context.Items.TryGetValue("APITOOLKIT_ERRORS", out var errorListObj) && errorListObj is List<ATError> errorList)
{
errors = (List<ATError>)errorListObj;
}
if (statusCode == 0)
{
statusCode = context.Response.StatusCode;
}
var contentType = context.Request.ContentType;
if (contentType != null && contentType.StartsWith("application/x-www-form-urlencoded"))
{
var parsedData = ParseQueryString(requestBody);
var dictionary = parsedData.AllKeys
.Where(key => key != null)
.ToDictionary(key => key ?? string.Empty, key => parsedData[key]);
requestBody = JsonConvert.SerializeObject(dictionary);
}
else if (contentType != null && contentType.StartsWith("multipart/form-data"))
{
try
{
var form = await context.Request.ReadFormAsync();
var formData = form.ToDictionary(x => x.Key, x => x.Value.ToString());
requestBody = System.Text.Json.JsonSerializer.Serialize(formData);
}
catch (Exception) { }
}
var payload = _client.BuildPayload("DotNet", stopwatch, context.Request, statusCode,
System.Text.Encoding.UTF8.GetBytes(requestBody), System.Text.Encoding.UTF8.GetBytes(responseBody),
responseHeaders, pathParams, urlPath, errors, msg_id);
await _client.PublishMessageAsync(payload);
}
}
public static async Task<Client> NewClientAsync(Config cfg)
{
var url = "https://app.apitoolkit.io";
if (!string.IsNullOrEmpty(cfg.RootUrl))
{
url = cfg.RootUrl;
}
using HttpResponseMessage response = await new HttpClient
{
DefaultRequestHeaders = {
{
"Authorization", $"Bearer {cfg.ApiKey}"
}
}
}.GetAsync($"{url}/api/client_metadata");
if (!response.IsSuccessStatusCode)
{
throw new Exception($"APIToolkit: Unable to query apitoolkit for client metadata: {response.StatusCode}");
}
var clientMetadata = JsonConvert.DeserializeObject<ClientMetadata>(await response.Content.ReadAsStringAsync());
if (clientMetadata is null)
{
throw new Exception("APIToolkit: Unable to deserialize client metadata response");
}
var credentials = GoogleCredential
.FromJson(clientMetadata.PubsubPushServiceAccount.ToString())
.CreateScoped(PublisherServiceApiClient.DefaultScopes);
var publisher = new PublisherClientBuilder();
publisher.Credential = credentials;
publisher.TopicName = new TopicName(clientMetadata.PubsubProjectId, clientMetadata.TopicId);
var pubsubClient = publisher.Build();
var client = new Client(pubsubClient, null, cfg, clientMetadata);
if (client.Config.Debug)
{
Console.WriteLine("APIToolkit: client initialized successfully");
}
return client;
}
}
public class Client
{
public readonly PublisherClient PubSubClient;
public readonly TopicName TopicName;
public readonly Config Config;
public readonly ClientMetadata Metadata;
public Client(PublisherClient pubSubClient, TopicName topicName, Config config, ClientMetadata metadata)
{
PubSubClient = pubSubClient;
TopicName = topicName;
Config = config;
Metadata = metadata;
}
public async Task PublishMessageAsync(Payload payload)
{
if (PubSubClient == null)
{
if (Config.Debug)
{
Console.WriteLine("APIToolkit: topic is not initialized. Check client initialization. Messages are not being sent to apitoolkit");
}
return;
}
await PubSubClient.PublishAsync(new PubsubMessage
{
Data = ByteString.CopyFromUtf8(JsonConvert.SerializeObject(payload)),
PublishTime = Timestamp.FromDateTime(DateTime.UtcNow),
});
if (Config.Debug)
{
Console.WriteLine("APIToolkit: message published to pubsub topic");
if (Config.VerboseDebug)
{
Console.WriteLine($"APIToolkit: {JsonConvert.SerializeObject(payload)}");
}
}
}
public ObservingHandler APIToolkitObservingHandler(HttpContext? context = null, ATOptions? options = null)
{
return new ObservingHandler(PublishMessageAsync, Metadata.ProjectId, context, options);
}
public static void ReportError(HttpContext context, Exception error)
{
var atError = BuildError(error);
if (context.Items.TryGetValue("APITOOLKIT_ERRORS", out var errorListObj) && errorListObj is List<ATError> errorList)
{
errorList.Add(atError);
}
else
{
errorList = new List<ATError> { atError };
context.Items["APITOOLKIT_ERRORS"] = errorList;
}
}
public Payload BuildPayload(string SDKType, Stopwatch stopwatch, HttpRequest req, int statusCode, byte[] reqBody, byte[] respBody, Dictionary<string, List<string>> respHeader, Dictionary<string, string> pathParams, string urlPath, List<ATError> errors, string msg_id)
{
if (req == null || Metadata is null)
{
// Early return with empty payload to prevent any null reference exceptions
if (Config.Debug)
{
Console.WriteLine("APIToolkit: null request or client or url while building payload.");
}
return new Payload();
}
string projectId = Metadata is null ? "" : Metadata.ProjectId;
var reqHeaders = req.Headers.ToDictionary(h => h.Key, h => h.Value.ToList());
int[] versionParts = req.Protocol.Split('/', '.').Skip(1).Select(int.Parse).ToArray();
var (majorVersion, minorVersion) = versionParts.Length >= 2 ? (versionParts[0], versionParts[1]) : (1, 1);
stopwatch.Stop();
return new Payload
{
Duration = stopwatch.ElapsedTicks * 100,
Host = req.Host.Host,
Method = req.Method,
PathParams = pathParams,
ProjectId = projectId,
ProtoMajor = majorVersion,
ProtoMinor = minorVersion,
QueryParams = req.Query.ToDictionary(kv => kv.Key, kv => kv.Value.ToString()),
RawUrl = req.GetEncodedPathAndQuery(),
Referer = req.Headers.ContainsKey("Referer") ? req.Headers["Referer"].ToString() : "",
RequestBody = RedactJSON(reqBody, Config.RedactRequestBody),
RequestHeaders = RedactHeaders(reqHeaders, Config.RedactHeaders),
ResponseBody = RedactJSON(respBody, Config.RedactResponseBody),
ResponseHeaders = RedactHeaders(respHeader, Config.RedactHeaders),
SdkType = SDKType,
StatusCode = statusCode,
Timestamp = DateTime.UtcNow,
UrlPath = urlPath,
Errors = errors,
ServiceVersion = Config.ServiceVersion,
Tags = Config.Tags ?? new List<string> { },
MsgId = msg_id
};
}
private static ATError BuildError(Exception error)
{
// Create an instance of ATError
var atError = new ATError
{
When = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ"),
ErrorType = error.GetType().Name,
Message = error.Message,
StackTrace = error.StackTrace ?? ""
};
// Try to obtain RootErrorType and RootErrorMessage from inner exceptions
var innerException = error;
while (innerException.InnerException != null)
{
innerException = innerException.InnerException;
}
atError.RootErrorType = innerException.GetType().Name;
atError.RootErrorMessage = innerException.Message;
return atError;
}
public static byte[] RedactJSON(byte[] data, List<string> jsonPaths)
{
if (jsonPaths is null || jsonPaths.Count == 0 || !data.Any()) return data;
try
{
JObject jsonObject = JObject.Parse(System.Text.Encoding.UTF8.GetString(data));
(jsonPaths ?? new List<string>()).ForEach(jPath => jsonObject.SelectTokens(jPath).ToList().ForEach(token => token.Replace("[CLIENT_REDACTED]")));
return System.Text.Encoding.UTF8.GetBytes(jsonObject.ToString());
}
catch (Exception)
{
return data;
}
}
public static Dictionary<string, List<string>> RedactHeaders(Dictionary<string, List<string>> headers, List<string> redactList)
{
redactList = (redactList ?? new List<string>()).Select(s => s.ToLower()).ToList();
return headers
.ToDictionary(
kvp => redactList.Contains(kvp.Key.ToLower()) ? kvp.Key : kvp.Key,
kvp => redactList.Contains(kvp.Key.ToLower()) ? new List<string> { "[CLIENT_REDACTED]" } : kvp.Value
);
}
}
public class ClientMetadata
{
[JsonProperty("project_id")]
public string ProjectId { get; set; }
[JsonProperty("pubsub_project_id")]
public string PubsubProjectId { get; set; }
[JsonProperty("topic_id")]
public string TopicId { get; set; }
[JsonProperty("pubsub_push_service_account")]
public JRaw PubsubPushServiceAccount { get; set; }
}
public class Config
{
public bool Debug { get; set; }
public bool VerboseDebug { get; set; }
public string RootUrl { get; set; }
public string ApiKey { get; set; }
public string ServiceVersion { get; set; }
public List<string> Tags { get; set; }
public List<string> RedactHeaders { get; set; }
public List<string> RedactRequestBody { get; set; }
public List<string> RedactResponseBody { get; set; }
}
public class Payload
{
[JsonProperty("timestamp")]
public DateTime Timestamp { get; set; }
[JsonProperty("request_headers")]
public Dictionary<string, List<string>> RequestHeaders { get; set; }
[JsonProperty("query_params")]
public Dictionary<string, string> QueryParams { get; set; }
[JsonProperty("path_params")]
public Dictionary<string, string> PathParams { get; set; }
[JsonProperty("response_headers")]
public Dictionary<string, List<string>> ResponseHeaders { get; set; }
[JsonProperty("method")]
public string Method { get; set; }
[JsonProperty("sdk_type")]
public string SdkType { get; set; }
[JsonProperty("host")]
public string Host { get; set; }
[JsonProperty("raw_url")]
public string RawUrl { get; set; }
[JsonProperty("referer")]
public string Referer { get; set; }
[JsonProperty("project_id")]
public string ProjectId { get; set; }
[JsonProperty("url_path")]
public string UrlPath { get; set; }
[JsonProperty("response_body")]
public byte[] ResponseBody { get; set; }
[JsonProperty("request_body")]
public byte[] RequestBody { get; set; }
[JsonProperty("proto_minor")]
public int ProtoMinor { get; set; }
[JsonProperty("status_code")]
public int StatusCode { get; set; }
[JsonProperty("proto_major")]
public int ProtoMajor { get; set; }
//Nanoseconds
[JsonProperty("duration")]
public long Duration { get; set; }
[JsonProperty("errors")]
public List<ATError>? Errors { get; set; }
[JsonProperty("tags")]
public List<string> Tags { get; set; }
[JsonProperty("service_version")]
public string ServiceVersion { get; set; }
[JsonProperty("parent_id")]
public string? ParentId { get; set; }
[JsonProperty("msg_id")]
public string? MsgId { get; set; }
}
public class ATError
{
[JsonProperty("when")]
public string When { get; set; }
[JsonProperty("error_type")]
public string ErrorType { get; set; }
[JsonProperty("root_error_type")]
public string RootErrorType { get; set; }
[JsonProperty("message")]
public string Message { get; set; }
[JsonProperty("root_error_message")]
public string RootErrorMessage { get; set; }
[JsonProperty("stack_trace")]
public string StackTrace { get; set; }
}
public class ATOptions
{
public string? PathWildCard { get; set; }
public List<string> RedactHeaders { get; set; }
public List<string> RedactRequestBody { get; set; }
public List<string> RedactResponseBody { get; set; }
}
public class ObservingHandler : DelegatingHandler
{
private readonly HttpContext _context;
private readonly Func<Payload, Task> _publishMessageAsync;
private readonly ATOptions _options;
private readonly string _project_id;
private readonly string? _msg_id;
public ObservingHandler(Func<Payload, Task> publishMessage, string project_id, HttpContext? httpContext = null, ATOptions? options = null) : base(new HttpClientHandler())
{
_context = httpContext ?? throw new ArgumentNullException(nameof(httpContext));
_publishMessageAsync = publishMessage;
_options = options ?? new ATOptions { RedactHeaders = new List<string> { }, RedactRequestBody = new List<string> { }, RedactResponseBody = new List<string> { } };
_project_id = project_id;
if (httpContext != null)
{
if (httpContext.Items.TryGetValue("APITOOLKIT_MSG_ID", out var msg_id) && msg_id != null)
{
_msg_id = msg_id.ToString();
}
}
}
protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
var StartTime = DateTimeOffset.UtcNow;
var Method = request.Method;
var RequestUri = request.RequestUri;
var reqHeaders = request.Headers.ToDictionary(h => h.Key, h => h.Value.ToList());
var reqBody = "";
if (request != null && request.Content != null)
{
reqBody = await request.Content.ReadAsStringAsync(cancellationToken);
}
Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();
var response = await base.SendAsync(request, cancellationToken);
try
{
var Duration = DateTimeOffset.UtcNow;
var StatusCode = response.StatusCode;
var respHeaders = response.Headers.ToDictionary(h => h.Key, h => h.Value.ToList());
var respBody = await response.Content.ReadAsStringAsync();
var queryDictCol = ParseQueryString(RequestUri?.Query ?? "");
var queryDict = new Dictionary<string, string>();
foreach (string key in queryDictCol)
{
queryDict[key] = queryDictCol[key] ?? "";
}
stopwatch.Stop();
var payload = new Payload
{
Duration = stopwatch.ElapsedTicks * 100,
Host = RequestUri?.Host.ToString() ?? "",
Method = Method.ToString(),
PathParams = ParsePathPattern(_options.PathWildCard ?? RequestUri?.AbsolutePath ?? "", RequestUri?.AbsolutePath ?? ""),
ProjectId = _project_id,
ProtoMajor = 1,
ProtoMinor = 1,
QueryParams = queryDict,
RawUrl = RequestUri?.PathAndQuery ?? "",
Referer = "",
RequestBody = Client.RedactJSON(System.Text.Encoding.UTF8.GetBytes(reqBody), _options.RedactRequestBody ?? new List<string> { }),
RequestHeaders = Client.RedactHeaders(reqHeaders, _options.RedactHeaders ?? new List<string> { }),
ResponseBody = Client.RedactJSON(System.Text.Encoding.UTF8.GetBytes(respBody), _options.RedactResponseBody ?? new List<string> { }),
ResponseHeaders = Client.RedactHeaders(respHeaders, _options.RedactHeaders ?? new List<string> { }),
SdkType = "DotNetOutgoing",
StatusCode = (int)StatusCode,
ParentId = _msg_id,
Timestamp = DateTime.UtcNow,
UrlPath = _options.PathWildCard ?? RequestUri?.AbsolutePath ?? "",
};
await _publishMessageAsync(payload);
return response;
}
catch (Exception _err)
{
return response;
}
}
static Dictionary<string, string> ParsePathPattern(string pattern, string url)
{
var result = new Dictionary<string, string>();
var patternParts = pattern.Split('/');
var urlParts = url.Split('/');
for (int i = 0; i < patternParts.Length; i++)
{
string patternPart = patternParts[i];
if (patternPart.StartsWith('{') && patternPart.EndsWith('}'))
{
string variableName = patternPart.Trim('{', '}');
string urlPart = "";
if (i < urlParts.Length)
{
urlPart = urlParts[i];
}
result[variableName] = urlPart;
}
}
return result;
}
}
}