-
Notifications
You must be signed in to change notification settings - Fork 4
/
CanaryTracer.cs
318 lines (305 loc) · 17.3 KB
/
CanaryTracer.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
/* ***********************************************************
* CanaryTracer.cs
* Revision: 2024-06-29
* Code found at: https://jonasr.app/canary-code
* Background: https://jonasr.app/canary/
* Created by: Jonas Rapp https://jonasr.app/
*
* Writes everything from an IExecutionContext to the Plugin Trace Log.
*
* Simplest call:
* serviceProvider.TraceContext();
*
* Simple sample call:
* tracingservice.TraceContext(context);
*
* Advanced sample call:
* tracingservice.TraceContext(context,
* includeparentcontext,
* includeattributetypes,
* convertqueries,
* expandcollections,
* includestage30,
* service);
*
* Enjoy responsibly.
* **********************************************************/
namespace Rappen.Dataverse.Canary
{
using Microsoft.Crm.Sdk.Messages;
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using System;
using System.Collections.Generic;
using System.Linq;
public static class CanaryTracer
{
/// <summary>
/// Default settings to trace the context in the easiest way.
/// </summary>
/// <param name="serviceprovider">The IServiceProvider sent to IPlugin interface.</param>
public static void TraceContext(this IServiceProvider serviceprovider) => serviceprovider.TraceContext(false, true, false, false, false);
/// <summary>
/// Dump everything interested from an IServiceProvider, if it contains Tracer and Context.
/// </summary>
/// <param name="serviceprovider">The IServiceProvider sent to IPlugin interface.</param>
/// <param name="parentcontext">Set to true if any parent contexts shall be traced too.</param>
/// <param name="attributetypes">Set to true to include information about attribute types.</param>
/// <param name="convertqueries">Set to true if any QueryExpression queries shall be converted to FetchXML and traced. Requires parameter service to be set.</param>
/// <param name="expandcollections">Set to true if EntityCollection objects should list all contained Entity objects with all fields available.</param>
/// <param name="includestage30">Set to true to also include plugins in internal stage.</param>
public static void TraceContext(this IServiceProvider serviceprovider, bool parentcontext, bool attributetypes, bool convertqueries, bool expandcollections, bool includestage30)
{
var tracer = (ITracingService)serviceprovider.GetService(typeof(ITracingService));
var context = (IPluginExecutionContext)serviceprovider.GetService(typeof(IPluginExecutionContext));
tracer.TraceContext(context, parentcontext, attributetypes, convertqueries, expandcollections, includestage30, null);
}
/// <summary>
/// Default settings for the TraceContext
/// </summary>
/// <param name="tracingservice">The tracer to trace the trace.</param>
/// <param name="context">The plugin or workflow context to trace.</param>
public static void TraceContext(this ITracingService tracingservice, IExecutionContext context) => tracingservice.TraceContext(context, false, true, false, false, false, null);
/// <summary>
/// Dumps everything interesting from the plugin context to the plugin trace log
/// </summary>
/// <param name="tracingservice">The tracer to trace the trace.</param>
/// <param name="context">The plugin or workflow context to trace.</param>
/// <param name="parentcontext">Set to true if any parent contexts shall be traced too.</param>
/// <param name="attributetypes">Set to true to include information about attribute types.</param>
/// <param name="convertqueries">Set to true if any QueryExpression queries shall be converted to FetchXML and traced. Requires parameter service to be set.</param>
/// <param name="expandcollections">Set to true if EntityCollection objects should list all contained Entity objects with all fields available.</param>
/// <param name="includestage30">Set to true to also include plugins in internal stage.</param>
/// <param name="service">Service used if convertqueries is true, may be null if not used.</param>
public static void TraceContext(this ITracingService tracingservice, IExecutionContext context, bool parentcontext, bool attributetypes, bool convertqueries, bool expandcollections, bool includestage30, IOrganizationService service)
{
try
{
tracingservice.TraceContext(context, parentcontext, attributetypes, convertqueries, expandcollections, includestage30, service, 1);
}
catch (Exception ex)
{
tracingservice.Trace("--- Exception while trying to TraceContext ---");
tracingservice.Trace($"Message : {ex.Message}");
}
}
private static void TraceContext(this ITracingService tracingservice, IExecutionContext context, bool parentcontext, bool attributetypes, bool convertqueries, bool expandcollections, bool includestage30, IOrganizationService service, int depth)
{
if (tracingservice == null)
{
return;
}
if (context == null)
{
tracingservice.Trace("No Context available.");
return;
}
var plugincontext = context as IPluginExecutionContext;
var plugincontext2 = context as IPluginExecutionContext2;
var plugincontext3 = context as IPluginExecutionContext3;
var plugincontext4 = context as IPluginExecutionContext4;
var plugincontext5 = context as IPluginExecutionContext5;
if (includestage30 || plugincontext?.Stage != 30)
{
tracingservice.Trace($"--- Context {depth} Trace Start ---");
if (!string.IsNullOrEmpty(plugincontext5?.InitiatingUserAgent))
{
tracingservice.Trace($"InitUserAgent: {plugincontext5.InitiatingUserAgent}");
}
tracingservice.Trace($"UserId : {context.UserId}");
if (!context.UserId.Equals(context.InitiatingUserId))
{
tracingservice.Trace($"InitUserId : {context.InitiatingUserId}");
}
if (plugincontext3 != null)
{
if (!plugincontext3.AuthenticatedUserId.Equals(Guid.Empty) &&
!plugincontext3.AuthenticatedUserId.Equals(context.UserId) &&
!plugincontext3.AuthenticatedUserId.Equals(context.InitiatingUserId))
{
tracingservice.Trace($"AuthUserId : {plugincontext3.AuthenticatedUserId}");
}
}
if (plugincontext2 != null)
{
if (!plugincontext2.UserAzureActiveDirectoryObjectId.Equals(Guid.Empty))
{
tracingservice.Trace($"UserAzureADId: {plugincontext2.UserAzureActiveDirectoryObjectId}");
}
if (!plugincontext2.InitiatingUserAzureActiveDirectoryObjectId.Equals(Guid.Empty) && !plugincontext2.InitiatingUserAzureActiveDirectoryObjectId.Equals(plugincontext2.UserAzureActiveDirectoryObjectId))
{
tracingservice.Trace($"InitAzADUser : {plugincontext2.InitiatingUserAzureActiveDirectoryObjectId}");
}
if (!plugincontext2.InitiatingUserApplicationId.Equals(Guid.Empty))
{
tracingservice.Trace($"InitUserAppId: {plugincontext2.InitiatingUserApplicationId}");
}
if (plugincontext2.IsPortalsClientCall)
{
tracingservice.Trace($"IsPortalsCall: {plugincontext2.IsPortalsClientCall}");
}
if (!plugincontext2.PortalsContactId.Equals(Guid.Empty))
{
tracingservice.Trace($"PortalContact: {plugincontext2.PortalsContactId}");
}
}
if (context.OwningExtension != null)
{
tracingservice.Trace($"{(context.OwningExtension.LogicalName == "sdkmessageprocessingstep" ? "Step " : context.OwningExtension.LogicalName)}: {context.OwningExtension.Id} {context.OwningExtension.Name}");
}
tracingservice.Trace($"Message : {context.MessageName}");
if (plugincontext != null)
{
tracingservice.Trace($"Stage : {plugincontext.Stage}");
}
tracingservice.Trace($"Mode : {context.Mode}");
tracingservice.Trace($"Depth : {context.Depth}");
tracingservice.Trace($"Entity : {context.PrimaryEntityName}");
if (!context.PrimaryEntityId.Equals(Guid.Empty))
{
tracingservice.Trace($"Id : {context.PrimaryEntityId}");
}
tracingservice.Trace("");
tracingservice.TraceAndAlign("InputParameters", context.InputParameters, attributetypes, convertqueries, expandcollections, service);
tracingservice.TraceAndAlign("OutputParameters", context.OutputParameters, attributetypes, convertqueries, expandcollections, service);
tracingservice.TraceAndAlign("SharedVariables", context.SharedVariables, attributetypes, convertqueries, expandcollections, service);
tracingservice.TraceAndAlign("PreEntityImages", context.PreEntityImages, attributetypes, convertqueries, expandcollections, service);
tracingservice.TraceAndAlign("PostEntityImages", context.PostEntityImages, attributetypes, convertqueries, expandcollections, service);
if (plugincontext4 != null)
{
if (plugincontext4.PreEntityImagesCollection.Length != 1 || context.PreEntityImages == null)
{
tracingservice.TraceAndAlign("PreEntityImagesCollection", plugincontext4.PreEntityImagesCollection, attributetypes, convertqueries, expandcollections, service);
}
if (plugincontext4.PostEntityImagesCollection.Length != 1 || context.PostEntityImages == null)
{
tracingservice.TraceAndAlign("PostEntityImagesCollection", plugincontext4.PostEntityImagesCollection, attributetypes, convertqueries, expandcollections, service);
}
}
tracingservice.Trace("--- Context {0} Trace End ---", depth);
}
if (parentcontext && plugincontext?.ParentContext != null)
{
tracingservice.TraceContext(plugincontext.ParentContext, parentcontext, attributetypes, convertqueries, expandcollections, includestage30, service, depth + 1);
}
tracingservice.Trace("");
}
private static void TraceAndAlign<T>(this ITracingService tracingservice, string topic, IEnumerable<KeyValuePair<string, T>>[] parametercollection, bool attributetypes, bool convertqueries, bool expandcollections, IOrganizationService service)
{
if (parametercollection == null || parametercollection.Length == 0)
{
return;
}
if (parametercollection.Length == 1)
{
tracingservice.TraceAndAlign(topic, parametercollection[0], attributetypes, convertqueries, expandcollections, service);
}
else
{
tracingservice.Trace($"{topic} : {parametercollection.Count()}");
}
}
private static void TraceAndAlign<T>(this ITracingService tracingservice, string topic, IEnumerable<KeyValuePair<string, T>> parametercollection, bool attributetypes, bool convertqueries, bool expandcollections, IOrganizationService service)
{
if (parametercollection == null || parametercollection.Count() == 0) { return; }
tracingservice.Trace(topic);
var keylen = parametercollection.Max(p => p.Key.Length);
foreach (var parameter in parametercollection)
{
tracingservice.Trace($" {parameter.Key}{new string(' ', keylen - parameter.Key.Length)} = {ValueToString(parameter.Value, attributetypes, convertqueries, expandcollections, service, 2)}");
}
}
private static string GetLastType(this object value) => value?.GetType()?.ToString()?.Split('.')?.Last();
public static string ValueToString(object value, bool attributetypes, bool convertqueries, bool expandcollections, IOrganizationService service, int indent = 1)
{
var indentstring = new string(' ', indent * 2);
if (value == null)
{
return $"{indentstring}<null>";
}
else if (value is EntityCollection collection)
{
var result = $"{collection.Entities.Count} {collection.EntityName}(s)" + (attributetypes ? $" \t({value.GetLastType()})" : "");
if (collection.TotalRecordCount > 0)
{
result += $"\n TotalRecordCount: {collection.TotalRecordCount}";
}
if (collection.MoreRecords)
{
result += $"\n MoreRecords: {collection.MoreRecords}";
}
if (!string.IsNullOrWhiteSpace(collection.PagingCookie))
{
result += $"\n PagingCookie: {collection.PagingCookie}";
}
if (expandcollections && collection.Entities.Count > 0)
{
result += "\n" + ValueToString(collection.Entities, attributetypes, convertqueries, expandcollections, service, indent);
}
if (!expandcollections && collection.Entities.Count == 1)
{
result += $"\n{indentstring}" + ValueToString(collection.Entities[0], attributetypes, convertqueries, expandcollections, service, indent + 1);
}
return result;
}
else if (value is IEnumerable<Entity> entities)
{
return expandcollections ? $"{indentstring}{string.Join($"\n{indentstring}", entities.Select(e => ValueToString(e, attributetypes, convertqueries, expandcollections, service, indent + 1)))}" : string.Empty;
}
else if (value is Entity entity)
{
var keylen = entity.Attributes.Count > 0 ? entity.Attributes.Max(p => p.Key.Length) : 50;
return $"{entity.LogicalName} {entity.Id}\n{indentstring}" + string.Join($"\n{indentstring}", entity.Attributes.OrderBy(a => a.Key).Select(a => $"{a.Key}{new string(' ', keylen - a.Key.Length)} = {ValueToString(a.Value, attributetypes, convertqueries, expandcollections, service, indent + 1)}"));
}
else if (value is ColumnSet columnset)
{
var columnlist = new List<string>(columnset.Columns);
columnlist.Sort();
return $"\n{indentstring}" + string.Join($"\n{indentstring}", columnlist);
}
else if (value is FetchExpression fetchexpression)
{
return $"{value}\n{indentstring}{fetchexpression.Query}";
}
else if (value is QueryExpression queryexpression && convertqueries && service != null)
{
var fetchxml = (service.Execute(new QueryExpressionToFetchXmlRequest { Query = queryexpression }) as QueryExpressionToFetchXmlResponse).FetchXml;
return $"{queryexpression}\n{indentstring}{fetchxml}";
}
else
{
var result = string.Empty;
if (value is EntityReference entityreference)
{
result = $"{entityreference.LogicalName} {entityreference.Id} {entityreference.Name}";
}
else if (value is OptionSetValue optionsetvalue)
{
result = optionsetvalue.Value.ToString();
}
else if (value is Money money)
{
result = money.Value.ToString();
}
else if (value is AliasedValue alias)
{
result = ValueToString(alias.Value, attributetypes, convertqueries, expandcollections, service, indent);
}
else
{
result = value.ToString().Replace("\n", $"\n {indentstring}");
}
return result + (attributetypes ? $" \t({value.GetLastType()})" : "");
}
}
public static void Write(this ITracingService tracer, string text)
{
tracer.Trace(DateTime.Now.ToString("HH:mm:ss.fff ") + text);
}
public static void TraceError(this IServiceProvider serviceprovider, Exception exception)
{
var tracer = (ITracingService)serviceprovider.GetService(typeof(ITracingService));
tracer.Write(exception.ToString());
}
}
}