-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
CrudEvents.cs
380 lines (328 loc) · 13.1 KB
/
CrudEvents.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
using System;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Threading.Tasks;
using ServiceStack.Auth;
using ServiceStack.Data;
using ServiceStack.DataAnnotations;
using ServiceStack.Host;
using ServiceStack.OrmLite;
using ServiceStack.Text;
using ServiceStack.Web;
namespace ServiceStack
{
public interface ICrudEvents
{
/// <summary>
/// Record an AutoCrudEvent Sync
/// </summary>
void Record(CrudContext context);
/// <summary>
/// Record an AutoCrudEvent Async
/// </summary>
Task RecordAsync(CrudContext context);
}
public interface ICrudEventsExecutor<in T>
where T : CrudEvent
{
Task ExecuteAsync(T crudEvent);
}
public abstract class CrudEventsBase<T>
where T : CrudEvent
{
public Func<object, string> Serializer { get; set; } = JsonSerializer.SerializeToString;
/// <summary>
///
/// </summary>
public Func<string, string> IpMask { get; set; } = CrudEventsUtils.AnonymizeLastIpSegment;
public Func<T, CrudContext, T> EventFilter { get; set; }
public T ToEvent(CrudContext context)
{
var urnValue = context.Id?.ToString() ?? context.Operation;
if (urnValue.IndexOf(':') >= 0)
urnValue = urnValue.Replace(":", "%3A");
var userSession = context.Request.GetSession();
if (userSession?.IsAuthenticated != true)
userSession = null;
var to = typeof(T).CreateInstance<T>();
to.Urn = $"urn:{context.ModelType.Name}:{urnValue}";
to.EventType = context.Operation;
to.Model = context.ModelType.Name;
to.ModelId = context.Id?.ToString();
to.EventDate = DateTime.UtcNow;
to.RowsUpdated = context.RowsUpdated;
to.RequestType = context.Dto.GetType().Name;
to.RequestBody = Serializer?.Invoke(context.Dto);
to.UserAuthId = userSession?.UserAuthId;
to.UserAuthName = userSession?.GetUserAuthName();
to.RemoteIp = IpMask(context.Request.RemoteIp);
return to;
}
}
public class CrudEventsExecutor : CrudEventsExecutor<CrudEvent>
{
public CrudEventsExecutor(IAppHost appHost) : base(appHost) { }
public CrudEventsExecutor(IServiceExecutor serviceExecutor, Func<string, Type> typeResolver) : base(serviceExecutor, typeResolver) { }
}
public class CrudEventsExecutor<T> : ICrudEventsExecutor<T>
where T : CrudEvent
{
public IServiceExecutor ServiceExecutor { get; set; }
public Func<string, Type> TypeResolver { get; set; }
public Func<object, IRequest, bool> ExecuteFilter { get; set; }
public List<Action<IRequest, IResponse, object>> RequestFilters { get; } =
new List<Action<IRequest, IResponse, object>>();
List<Func<IRequest, IResponse, object, Task>> RequestFiltersAsync { get; } =
new List<Func<IRequest, IResponse, object, Task>>();
public CrudEventsExecutor(IAppHost appHost)
: this(appHost.ServiceController, appHost.Metadata.GetOperationType)
{
RequestFilters = appHost.GlobalMessageRequestFilters;
RequestFiltersAsync = appHost.GlobalMessageRequestFiltersAsync;
}
public CrudEventsExecutor(IServiceExecutor serviceExecutor, Func<string, Type> typeResolver)
{
ServiceExecutor = serviceExecutor ?? throw new ArgumentNullException(nameof(serviceExecutor));
TypeResolver = typeResolver ?? throw new ArgumentNullException(nameof(typeResolver));
}
/// <summary>
/// (RequestDto, HttpMethod) => IRequest
/// </summary>
public Func<object, string, IRequest> RequestFactory { get; set; } = (dto,method) => new BasicRequest(dto, RequestAttributes.LocalSubnet) {
Verb = method
};
public Func<string, Type, object> Deserializer { get; set; } = JsonSerializer.DeserializeFromString;
public virtual async Task ExecuteAsync(T crudEvent)
{
var typeName = crudEvent.RequestType ?? throw new ArgumentNullException(nameof(crudEvent.RequestType));
var requestType = TypeResolver(typeName) ?? throw new TypeLoadException($"'{typeName}' was not found");
if (crudEvent.RequestBody == null)
throw new ArgumentNullException(nameof(crudEvent.RequestBody));
var requestDto = Deserializer(crudEvent.RequestBody, requestType);
var method = AutoCrudOperation.ToHttpMethod(crudEvent.EventType);
var req = RequestFactory(requestDto, method);
req.SetInProcessRequest();
if (crudEvent.RemoteIp != null && req is BasicRequest basicRequest)
basicRequest.RemoteIp = crudEvent.RemoteIp;
if (crudEvent.UserAuthId != null)
{
var result = await req.GetSessionFromSourceAsync(crudEvent.UserAuthId, validator:null).ConfigAwait();
if (result == null)
throw new NotSupportedException("An AuthRepository or IUserSessionSource is required Execute Authenticated AutoCrudEvents");
var session = result.Session;
if (session.UserAuthName == null)
session.UserAuthName = session.UserName ?? session.Email;
if (session.Roles == null)
session.Roles = result.Roles?.ToList();
if (session.Permissions == null)
session.Permissions = result.Permissions?.ToList();
req.Items[Keywords.Session] = session;
}
req.Items[Keywords.IgnoreEvent] = bool.TrueString; //don't record AutoCrudEvent
if (crudEvent.ModelId != null)
req.Items[Keywords.EventModelId] = crudEvent.ModelId;
if (RequestFilters.Count > 0)
{
foreach (var requestFilter in RequestFilters)
{
requestFilter(req, req.Response, req.Dto);
if (req.Response.IsClosed)
throw new UnauthorizedAccessException($"RequestFilters short-circuited request denying executing {typeof(T).Name} {crudEvent.Id}");
}
}
if (RequestFiltersAsync.Count > 0)
{
foreach (var requestFilter in RequestFiltersAsync)
{
await requestFilter(req, req.Response, req.Dto).ConfigAwait();
if (req.Response.IsClosed)
throw new UnauthorizedAccessException($"RequestFiltersAsync short-circuited request denying executing {typeof(T).Name} {crudEvent.Id}");
}
}
await ServiceExecutor.ExecuteAsync(requestDto, req).ConfigAwait();
}
}
public class OrmLiteCrudEvents : OrmLiteCrudEvents<CrudEvent>
{
public static int BatchSize { get; set; } = 1000;
public OrmLiteCrudEvents(IDbConnectionFactory dbFactory) : base(dbFactory) { }
}
public class OrmLiteCrudEvents<T> : CrudEventsBase<T>,
ICrudEvents, IRequiresSchema, IClearable
where T : CrudEvent
{
/// <summary>
/// Don't persist CrudEvent's in primary IDbConnectionFactory
/// </summary>
public bool ExcludePrimaryDb { get; set; }
/// <summary>
/// Additional DB Connections CrudEvent's should be persisted in
/// </summary>
public List<string> NamedConnections { get; } = new List<string>();
private IDbConnectionFactory DbFactory { get; }
public OrmLiteCrudEvents(IDbConnectionFactory dbFactory) => DbFactory = dbFactory;
/// <summary>
/// Record an CrudEvent Sync
/// </summary>
public void Record(CrudContext context)
{
var row = ToEvent(context);
if (EventFilter != null)
{
row = EventFilter(row, context);
if (row == null)
return;
}
context.Db.Insert(row);
}
/// <summary>
/// Record an CrudEvent Async
/// </summary>
public Task RecordAsync(CrudContext context)
{
var row = ToEvent(context);
if (EventFilter != null)
{
row = EventFilter(row, context);
if (row == null)
return TypeConstants.EmptyTask;
}
return context.Db.InsertAsync(row);
}
/// <summary>
/// Returns all rows in CrudEvent Table, lazily paging in batches of OrmLiteCrudEvents.BatchSize
/// </summary>
public IEnumerable<T> GetEvents(IDbConnection db)
{
List<T> results;
long lastId = 0;
do
{
var q = db.From<T>()
.Take(OrmLiteCrudEvents.BatchSize)
.OrderBy(x => x.Id);
if (lastId != default)
q.Where(x => x.Id > lastId);
results = db.Select(q);
foreach (var result in results)
{
lastId = result.Id;
yield return result;
}
} while (results.Count > 0);
}
public IEnumerable<T> GetEvents(IDbConnection db, string table, string id=null)
{
var q = db.From<T>()
.Where(x => x.Model == table);
if (id != null)
{
q.And(x => x.ModelId == id);
}
q.OrderBy(x => x.Id);
return db.Select(q);
}
/// <summary>
/// Create CrudEvent if it doesn't already exist
/// </summary>
public void InitSchema()
{
if (!ExcludePrimaryDb)
{
using (var db = DbFactory.OpenDbConnection())
{
db.CreateTableIfNotExists<T>();
}
}
foreach (var namedConnection in NamedConnections)
{
using (var db = DbFactory.OpenDbConnection(namedConnection))
{
db.CreateTableIfNotExists<T>();
}
}
}
/// <summary>
/// Delete all entries in CrudEvent Table
/// </summary>
public void Clear()
{
if (!ExcludePrimaryDb)
{
using var db = DbFactory.OpenDbConnection();
db.DeleteAll<T>();
}
foreach (var namedConnection in NamedConnections)
{
using var db = DbFactory.OpenDbConnection(namedConnection);
db.DeleteAll<T>();
}
}
/// <summary>
/// WARNING: DROP and RE-CREATE CrudEvent
/// </summary>
/// <returns></returns>
public OrmLiteCrudEvents<T> Reset()
{
if (!ExcludePrimaryDb)
{
using (var db = DbFactory.OpenDbConnection())
{
db.DropAndCreateTable<T>();
}
}
foreach (var namedConnection in NamedConnections)
{
using (var db = DbFactory.OpenDbConnection(namedConnection))
{
db.DropAndCreateTable<T>();
}
}
return this;
}
}
public static class CrudEventsUtils
{
/// <summary>
/// Returns null
/// </summary>
public static string Null(string value) => null;
/// <summary>
/// Returns itself as-is
/// </summary>
public static string Identity(string value) => value;
/// <summary>
/// Returns Single IP with empty last segment
/// </summary>
public static string AnonymizeLastIpSegment(string remoteIp)
{
if (string.IsNullOrEmpty(remoteIp))
return remoteIp;
if (remoteIp.IndexOf(',') >= 0)
remoteIp = remoteIp.LeftPart(','); // take 1st of multiple IPs
if (remoteIp == "::1")
return remoteIp;
if (remoteIp.IndexOf('.') >= 0)
return remoteIp.LastLeftPart('.') + ".0";
if (remoteIp.IndexOf(':') >= 0)
return remoteIp.LastLeftPart(':') + ":0000";
return remoteIp;
}
public static void InitSchema(this ICrudEvents events)
{
if (events is IRequiresSchema requiresSchema)
{
requiresSchema.InitSchema();
}
}
public static void Clear(this ICrudEvents events)
{
if (events is IClearable clearable)
{
clearable.Clear();
}
else throw new NotSupportedException($"{events.GetType().Name} does not implement IClearable");
}
}
}