-
Notifications
You must be signed in to change notification settings - Fork 32
Expand file tree
/
Copy pathPluginManager.cs
More file actions
498 lines (417 loc) · 24.3 KB
/
PluginManager.cs
File metadata and controls
498 lines (417 loc) · 24.3 KB
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
using DG.Tools.XrmMockup.Internal;
using DG.Tools.XrmMockup.Plugin.RegistrationStrategy;
using DG.Tools.XrmMockup.SystemPlugins;
using XrmPluginCore.Enums;
using XrmPluginCore.Interfaces.Plugin;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Metadata;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Security.Cryptography;
using System.Text;
using XrmMockupShared.Plugin;
namespace DG.Tools.XrmMockup
{
using StageToTriggerMap = Dictionary<ExecutionStage, List<PluginTrigger>>;
using EventOperation = String;
using EventOperationEnum = EventOperation;
internal class PluginManager
{
private readonly ILogger _logger;
// Static caches shared across all PluginManager instances
private static readonly ConcurrentDictionary<string, Dictionary<EventOperation, StageToTriggerMap>> _cachedRegisteredPlugins = new ConcurrentDictionary<string, Dictionary<EventOperation, StageToTriggerMap>>();
private static readonly ConcurrentDictionary<string, Dictionary<EventOperation, StageToTriggerMap>> _cachedSystemPlugins = new ConcurrentDictionary<string, Dictionary<EventOperation, StageToTriggerMap>>();
private static readonly ConcurrentDictionary<Type, IPlugin> _pluginInstanceCache = new ConcurrentDictionary<Type, IPlugin>();
private static readonly object _cacheLock = new object();
// TODO: We can probably optimize lookup by creating a key record and using that instead of a Dictionary of Dictionaries
private readonly Dictionary<EventOperation, StageToTriggerMap> registeredPlugins = new Dictionary<EventOperation, StageToTriggerMap>();
private readonly Dictionary<EventOperation, StageToTriggerMap> temporaryPlugins = new Dictionary<EventOperation, StageToTriggerMap>();
private readonly Dictionary<EventOperation, StageToTriggerMap> registeredSystemPlugins = new Dictionary<EventOperation, StageToTriggerMap>();
internal readonly List<Type> missingRegistrations = new List<Type>();
// Queue for AsyncPlugins - using ConcurrentQueue for thread safety in parallel test scenarios
private readonly ConcurrentQueue<PluginExecutionProvider> pendingAsyncPlugins = new ConcurrentQueue<PluginExecutionProvider>();
// If true, registered plugins will not be executed
private bool disableRegisteredPlugins = false;
// List of SystemPlugins to execute
private readonly List<AbstractSystemPlugin> systemPlugins = new List<AbstractSystemPlugin>
{
new UpdateInactiveIncident(),
new DefaultBusinessUnitTeams(),
new DefaultBusinessUnitTeamMembers(),
new SetAnnotationIsDocument()
};
private readonly List<IRegistrationStrategy<IPluginStepConfig>> registrationStrategies;
public PluginManager(IEnumerable<Type> basePluginTypes, Dictionary<string, EntityMetadata> metadata, List<MetaPlugin> plugins, ILogger logger = null)
{
_logger = logger ?? NullLogger.Instance;
registrationStrategies = new List<IRegistrationStrategy<IPluginStepConfig>>
{
new Plugin.RegistrationStrategy.XrmPluginCore.PluginRegistrationStrategy(_logger),
new Plugin.RegistrationStrategy.DAXIF.PluginRegistrationStrategy(_logger)
};
temporaryPlugins = new Dictionary<EventOperation, StageToTriggerMap>();
var pluginCacheKey = GeneratePluginCacheKey(basePluginTypes);
var systemCacheKey = "system_plugins";
// Check if we have cached results
if (_cachedRegisteredPlugins.ContainsKey(pluginCacheKey) && _cachedSystemPlugins.ContainsKey(systemCacheKey))
{
// Use cached results - no reflection/instantiation needed
registeredPlugins = ClonePluginDictionary(_cachedRegisteredPlugins[pluginCacheKey]);
registeredSystemPlugins = ClonePluginDictionary(_cachedSystemPlugins[systemCacheKey]);
_logger.LogDebug("Loaded {Count} plugin registrations from cache", registeredPlugins.Values.SelectMany(s => s.Values.SelectMany(l => l)).Count());
foreach (var reg in PluginRegistrations)
{
_logger.LogDebug(" Plugin: {Registration}", reg);
}
}
else
{
lock (_cacheLock)
{
// Double-check locking pattern
if (_cachedRegisteredPlugins.ContainsKey(pluginCacheKey) && _cachedSystemPlugins.ContainsKey(systemCacheKey))
{
registeredPlugins = ClonePluginDictionary(_cachedRegisteredPlugins[pluginCacheKey]);
registeredSystemPlugins = ClonePluginDictionary(_cachedSystemPlugins[systemCacheKey]);
_logger.LogDebug("Loaded {Count} plugin registrations from cache", registeredPlugins.Values.SelectMany(s => s.Values.SelectMany(l => l)).Count());
}
else
{
// First time - do the work and cache it
registeredPlugins = new Dictionary<EventOperation, StageToTriggerMap>();
registeredSystemPlugins = new Dictionary<EventOperation, StageToTriggerMap>();
_logger.LogInformation("Scanning assemblies for plugin registrations...");
RegisterPlugins(basePluginTypes, metadata, plugins, registeredPlugins);
RegisterDirectPlugins(basePluginTypes, metadata, plugins, registeredPlugins);
RegisterSystemPlugins(registeredSystemPlugins, metadata);
// Cache for future instances
_cachedRegisteredPlugins[pluginCacheKey] = ClonePluginDictionary(registeredPlugins);
_cachedSystemPlugins[systemCacheKey] = ClonePluginDictionary(registeredSystemPlugins);
foreach (var reg in PluginRegistrations)
{
_logger.LogInformation(" Registered plugin: {Registration}", reg);
}
foreach (var missing in missingRegistrations)
{
_logger.LogWarning(" Plugin type missing registration: {TypeName}", missing.FullName);
}
_logger.LogInformation("Plugin scanning complete: {Count} registrations, {MissingCount} missing",
PluginRegistrations.Count, missingRegistrations.Count);
}
}
}
}
internal List<string> PluginRegistrations => FlattenPluginDictionary(registeredPlugins);
internal List<string> TemporaryPluginRegistrations => FlattenPluginDictionary(temporaryPlugins);
internal List<string> SystemPluginRegistrations => FlattenPluginDictionary(registeredSystemPlugins);
private static List<string> FlattenPluginDictionary(Dictionary<EventOperation, StageToTriggerMap> plugins)
{
return plugins
.SelectMany(kvpOperation =>
kvpOperation.Value.SelectMany(kvpStage =>
kvpStage.Value.Select(z =>
$"{kvpOperation.Key} {kvpStage.Key} {z.EntityName ?? "AnyEntity"}: {z.PluginExecute.Target.GetType().Name}")))
.OrderBy(s => s)
.ToList();
}
private void RegisterPlugins(IEnumerable<Type> basePluginTypes, Dictionary<string, EntityMetadata> metadata, List<MetaPlugin> plugins, Dictionary<EventOperation, StageToTriggerMap> register)
{
foreach (var basePluginType in basePluginTypes)
{
if (basePluginType == null) continue;
_logger.LogDebug("Scanning for types extending base plugin type: {BaseType}", basePluginType.FullName);
// Look for any currently loaded types in the AppDomain that implement the base type
var pluginTypes = AppDomain.CurrentDomain.GetAssemblies()
.SelectMany(a =>
a.GetLoadableTypes().Where(t =>
!t.IsAbstract
&& t.IsPublic
&& t.BaseType != null
&& (t.BaseType == basePluginType || (t.BaseType.IsGenericType && t.BaseType.GetGenericTypeDefinition() == basePluginType))))
.ToList();
_logger.LogDebug("Found {Count} concrete type(s) extending {BaseType}", pluginTypes.Count, basePluginType.FullName);
foreach (var type in pluginTypes)
{
RegisterPlugin(type, metadata, plugins, register);
}
}
SortAllLists(register);
}
private void RegisterDirectPlugins(IEnumerable<Type> basePluginTypes, Dictionary<string, EntityMetadata> metadata, List<MetaPlugin> plugins, Dictionary<EventOperation, StageToTriggerMap> register)
{
if (basePluginTypes == null) return;
foreach (var pluginType in basePluginTypes)
{
if (pluginType == null) continue;
Assembly proxyTypeAssembly = pluginType.Assembly;
_logger.LogDebug("Scanning assembly {Assembly} for direct IPlugin implementations", proxyTypeAssembly.GetName().Name);
// Look for any currently loaded types in assembly that implement IPlugin
var types = proxyTypeAssembly.GetLoadableTypes()
.Where(t => t.BaseType == typeof(object) && !t.IsAbstract && t.IsPublic && typeof(IPlugin).IsAssignableFrom(t))
.ToList();
_logger.LogDebug("Found {Count} direct IPlugin type(s) in {Assembly}", types.Count, proxyTypeAssembly.GetName().Name);
foreach (var type in types)
{
RegisterPlugin(type, metadata, plugins, register);
}
}
SortAllLists(register);
}
private void RegisterPlugin(Type pluginType, Dictionary<string, EntityMetadata> metadata, List<MetaPlugin> metaPlugins, Dictionary<EventOperation, StageToTriggerMap> register)
{
_logger.LogDebug("Evaluating plugin type: {TypeName}", pluginType.FullName);
var plugin = _pluginInstanceCache.GetOrAdd(pluginType, Utility.CreatePluginInstance);
if (plugin == null)
{
_logger.LogWarning("Failed to create instance of plugin type: {TypeName}", pluginType.FullName);
return;
}
// Get the plugin step registrations from the plugin type
var steps = registrationStrategies
.SelectMany(s => s.AnalyzeType(plugin));
// If we didn't find any steps, try the MetadataRegistrationStrategy as a last resort
if (!steps.Any()) {
_logger.LogDebug("{TypeName}: no steps from primary strategies, trying MetadataRegistrationStrategy", pluginType.FullName);
steps = new MetadataRegistrationStrategy(_logger).AnalyzeType(pluginType, metaPlugins);
}
var triggers = steps.Select(t => new PluginTrigger(t.EventOperation, t.ExecutionStage, plugin.Execute, t, metadata));
if (!triggers.Any())
{
_logger.LogDebug("{TypeName}: no registrations found from any strategy", pluginType.FullName);
missingRegistrations.Add(pluginType);
return;
}
foreach (var trigger in triggers)
{
AddTrigger(trigger, register);
}
}
public void ResetPlugins()
{
disableRegisteredPlugins = false;
temporaryPlugins.Clear();
}
public void DisableRegisteredPlugins(bool disable)
{
disableRegisteredPlugins = disable;
}
public void RegisterAdditionalPlugin(Type pluginType, Dictionary<string, EntityMetadata> metadata, List<MetaPlugin> plugins, PluginRegistrationScope scope)
{
if (scope == PluginRegistrationScope.Permanent)
{
RegisterPlugin(pluginType, metadata, plugins, registeredPlugins);
}
else if (scope == PluginRegistrationScope.Temporary)
{
RegisterPlugin(pluginType, metadata, plugins, temporaryPlugins);
}
}
private void RegisterSystemPlugins(Dictionary<EventOperation, StageToTriggerMap> register, Dictionary<string, EntityMetadata> metadata)
{
var registrations = new List<IPluginStepConfig>();
// TODO: Auto-discover system plugins instead of hardcoding the types, we know they all implement the same class
foreach (var plugin in systemPlugins)
{
registrations.AddRange(plugin.GetRegistrations());
// Add discovered plugin triggers
foreach (var registration in registrations)
{
var trigger = new PluginTrigger(registration.EventOperation, registration.ExecutionStage, plugin.Execute, registration, metadata);
AddTrigger(trigger, register);
}
}
SortAllLists(register);
}
private static void AddTrigger(PluginTrigger trigger, Dictionary<EventOperation, StageToTriggerMap> register)
{
var operation = trigger.Operation;
var stage = trigger.Stage;
if (!register.TryGetValue(operation, out var operationRegister))
{
register[operation] = operationRegister = new StageToTriggerMap();
}
if (!operationRegister.TryGetValue(stage, out var stageRegister))
{
operationRegister[stage] = stageRegister = new List<PluginTrigger>();
}
stageRegister.Add(trigger);
}
/// <summary>
/// Sorts all the registered which shares the same entry point based on their given order
/// </summary>
private void SortAllLists(Dictionary<EventOperation, StageToTriggerMap> plugins)
{
foreach (var dictEntry in plugins)
{
foreach (var listEntry in dictEntry.Value)
{
listEntry.Value.Sort();
}
}
}
public void TriggerSync(string operation, ExecutionStage stage,
object entity, Entity preImage, Entity postImage, PluginContext pluginContext, Core core, Func<PluginTrigger, bool> executionOrderFilter)
{
TriggerSyncInternal(operation, stage, entity, preImage, postImage, pluginContext, core, executionOrderFilter);
// Check if this is a Single -> Multiple request
var isKnownOp = Enum.TryParse<EventOperationEnum>(operation, out var knownOp);
if (isKnownOp && Mappings.RequestToMultipleRequest.TryGetValue(knownOp, out var multipleOperation))
{
var multiplePluginContext = pluginContext.Clone();
var entityCollection = new EntityCollection()
{
EntityName = pluginContext.PrimaryEntityName,
Entities = { (Entity)entity },
};
// Try to get the request type for the multiple
var multipleRequestType = Mappings.EventOperationToRequest(multipleOperation)
?? throw new MockupException($"Could not find request type for operation {multipleOperation}");
// Now try to get the image property for the multiple request
if (!Mappings.EntityImageProperty.TryGetValue(multipleRequestType, out var imageProperty))
{
throw new MockupException($"Could not find image property for operation {multipleOperation} using request type {multipleRequestType}");
}
multiplePluginContext.InputParameters[imageProperty] = entityCollection;
multiplePluginContext.MessageName = Activator.CreateInstance(multipleRequestType) is OrganizationRequest request
? request.RequestName
: throw new MockupException($"Could not create request for operation {operation}");
// Images for Multiple operations are accessed via IPluginExecutionContext4.PreEntityImagesCollection/PostEntityImagesCollection,
// not via PreEntityImages/PostEntityImages. Pass null until IPluginExecutionContext4 is implemented.
TriggerSyncInternal(multipleOperation.ToString(), stage, entityCollection, null, null, multiplePluginContext, core, executionOrderFilter);
}
// Check if this is a Multiple -> Single request
if (isKnownOp && Mappings.SingleOperationFromMultiple(knownOp) is EventOperationEnum singleOperation)
{
// Try to get the request type for the multiple
var multipleRequestType = Mappings.EventOperationToRequest(knownOp)
?? throw new MockupException($"Could not find request type for operation {operation}");
// Now try to get the image property for the multiple request
if (!Mappings.EntityImageProperty.TryGetValue(multipleRequestType, out var multipleImageProperty))
{
throw new MockupException($"Could not find image property for operation {operation} using request type {multipleRequestType}");
}
// Try to get the request type for the single
var singleRequestType = Mappings.EventOperationToRequest(singleOperation)
?? throw new MockupException($"Could not find request type for operation {singleOperation}");
// Now try to get the image property for the single request
if (!Mappings.EntityImageProperty.TryGetValue(singleRequestType, out var singleImageProperty))
{
throw new MockupException($"Could not find image property for operation {singleOperation} using request type {singleRequestType}");
}
// Get the message for the single message
var singleMessageName = Activator.CreateInstance(singleRequestType) is OrganizationRequest request
? request.RequestName
: throw new MockupException($"Could not create request for operation {operation}");
var targets = pluginContext.InputParameters[multipleImageProperty] as EntityCollection;
foreach (var targetEntity in targets.Entities)
{
var singlePluginContext = pluginContext.Clone();
singlePluginContext.InputParameters[singleImageProperty] = targetEntity;
singlePluginContext.MessageName = singleMessageName;
var entityRef = targetEntity.ToEntityReference();
var currentImage = core.TryRetrieve(entityRef);
Entity singlePreImage;
Entity singlePostImage;
if (stage == ExecutionStage.PostOperation)
{
singlePreImage = preImage;
singlePostImage = currentImage;
}
else
{
singlePreImage = currentImage;
singlePostImage = null;
}
TriggerSyncInternal(singleOperation.ToString(), stage, targetEntity,
singlePreImage, singlePostImage, singlePluginContext, core, executionOrderFilter);
}
}
}
private void TriggerSyncInternal(EventOperation operation, ExecutionStage stage,
object entity, Entity preImage, Entity postImage, PluginContext pluginContext, Core core, Func<PluginTrigger, bool> executionOrderFilter)
{
if (!disableRegisteredPlugins && registeredPlugins.TryGetValue(operation, out var operationPlugins) && operationPlugins.TryGetValue(stage, out var stagePlugins))
stagePlugins
.Where(p => p.GetExecutionMode() == ExecutionMode.Synchronous)
.Where(executionOrderFilter)
.OrderBy(p => p.GetExecutionOrder())
.ToList()
.ForEach(p => p.ExecuteIfMatch(entity, preImage, postImage, pluginContext, core));
if (temporaryPlugins.TryGetValue(operation, out var tempOperationPlugins) && tempOperationPlugins.TryGetValue(stage, out var tempStagePlugins))
tempStagePlugins
.Where(p => p.GetExecutionMode() == ExecutionMode.Synchronous)
.Where(executionOrderFilter)
.OrderBy(p => p.GetExecutionOrder())
.ToList()
.ForEach(p => p.ExecuteIfMatch(entity, preImage, postImage, pluginContext, core));
}
public void StageAsync(EventOperation operation, ExecutionStage stage,
object entity, Entity preImage, Entity postImage, PluginContext pluginContext, Core core)
{
if (!disableRegisteredPlugins && registeredPlugins.TryGetValue(operation, out var operationPlugins) && operationPlugins.TryGetValue(stage, out var stagePlugins))
stagePlugins
.Where(p => p.GetExecutionMode() == ExecutionMode.Asynchronous)
.OrderBy(p => p.GetExecutionOrder())
.Select(p => p.ToPluginExecution(entity, preImage, postImage, pluginContext, core))
.ToList()
.ForEach(pendingAsyncPlugins.Enqueue);
if (temporaryPlugins.TryGetValue(operation, out var tempOperationPlugins) && tempOperationPlugins.TryGetValue(stage, out var tempStagePlugins))
tempStagePlugins
.Where(p => p.GetExecutionMode() == ExecutionMode.Asynchronous)
.OrderBy(p => p.GetExecutionOrder())
.Select(p => p.ToPluginExecution(entity, preImage, postImage, pluginContext, core))
.ToList()
.ForEach(pendingAsyncPlugins.Enqueue);
}
public void TriggerAsyncWaitingJobs()
{
while (pendingAsyncPlugins.TryDequeue(out var pendingPlugin))
{
pendingPlugin?.ExecuteAction();
}
}
public void TriggerSystem(EventOperation operation, ExecutionStage stage,
object entity, Entity preImage, Entity postImage, PluginContext pluginContext, Core core)
{
if (!registeredSystemPlugins.TryGetValue(operation, out var stagePlugins))
{
return;
}
if (!stagePlugins.TryGetValue(stage, out var plugins))
{
return;
}
plugins.ForEach(p => p.ExecuteIfMatch(entity, preImage, postImage, pluginContext, core));
}
private string GeneratePluginCacheKey(IEnumerable<Type> basePluginTypes)
{
if (basePluginTypes == null) return "null_types";
var typeNames = basePluginTypes.Where(t => t != null).Select(t => t.FullName).OrderBy(n => n);
var combinedTypes = string.Join("|", typeNames);
using (var sha256 = SHA256.Create())
{
var hash = sha256.ComputeHash(Encoding.UTF8.GetBytes(combinedTypes));
return Convert.ToBase64String(hash);
}
}
private Dictionary<EventOperation, StageToTriggerMap> ClonePluginDictionary(Dictionary<EventOperation, StageToTriggerMap> source)
{
var result = new Dictionary<EventOperation, StageToTriggerMap>();
foreach (var operationEntry in source)
{
var stageDict = new StageToTriggerMap();
foreach (var stageEntry in operationEntry.Value)
{
stageDict[stageEntry.Key] = new List<PluginTrigger>(stageEntry.Value);
}
result[operationEntry.Key] = stageDict;
}
return result;
}
}
}