-
Notifications
You must be signed in to change notification settings - Fork 71
Expand file tree
/
Copy pathWebView.JavascriptExecutor.cs
More file actions
324 lines (270 loc) · 14.7 KB
/
WebView.JavascriptExecutor.cs
File metadata and controls
324 lines (270 loc) · 14.7 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
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
using Xilium.CefGlue;
using Xilium.CefGlue.Common.Events;
namespace WebViewControl {
partial class WebView {
[DataContract]
internal class JsError {
[DataMember(Name = "stack")]
public string Stack;
[DataMember(Name = "name")]
public string Name;
[DataMember(Name = "message")]
public string Message;
}
internal class ScriptTask {
public ScriptTask(string script, string functionName, Action<string> evaluate = null) {
Script = script;
Evaluate = evaluate;
FunctionName = functionName;
}
public string Script { get; }
/// <summary>
/// We store the function name apart from the script and use it later in the exception details
/// this prevents any params to be shown in the message because they can contain sensitive information
/// </summary>
public string FunctionName { get; }
public Action<string> Evaluate { get; }
}
internal class JavascriptExecutor : IDisposable {
private const string InternalException = "|WebViewInternalException";
private static readonly TimeSpan DefaultTimeout = TimeSpan.FromSeconds(60);
private static readonly TimeSpan InitializationTimeout = TimeSpan.FromSeconds(15);
private static Regex StackFrameRegex { get; } = new(@"at\s*(?<method>.*?)\s\(?(?<location>[^\s]+):(?<line>\d+):(?<column>\d+)", RegexOptions.Compiled);
private BlockingCollection<ScriptTask> PendingScripts { get; } = new();
private CancellationTokenSource FlushTaskCancellationToken { get; } = new();
private WebView OwnerWebView { get; }
#if DEBUG
private string Id { get; } = Guid.NewGuid().ToString();
#endif
private CefFrame frame;
private Task flushTask;
public JavascriptExecutor(WebView owner, CefFrame frame = null) {
OwnerWebView = owner;
this.frame = frame;
}
public bool IsValid => frame == null || frame.IsValid; // consider valid when not bound (yet) or frame is valid
private bool IsFlushTaskInitializing => flushTask == null || flushTask.Status < TaskStatus.Running;
public void StartFlush(CefFrame frame) {
#if DEBUG
System.Diagnostics.Debug.WriteLine($"{nameof(StartFlush)} ('{Id}')");
#endif
lock (FlushTaskCancellationToken) {
if (flushTask != null || !frame.IsValid || FlushTaskCancellationToken.IsCancellationRequested) {
return;
}
this.frame = frame;
flushTask = Task.Factory.StartNew(FlushScripts, FlushTaskCancellationToken.Token, TaskCreationOptions.LongRunning, TaskScheduler.Default);
}
}
private void StopFlush() {
#if DEBUG
System.Diagnostics.Debug.WriteLine($"{nameof(StopFlush)} ('{Id}')");
#endif
try {
lock (FlushTaskCancellationToken) {
if (FlushTaskCancellationToken.IsCancellationRequested) {
return;
}
FlushTaskCancellationToken.Cancel();
PendingScripts.CompleteAdding();
}
} catch (ObjectDisposedException) { }
}
private ScriptTask QueueScript(string script, string functionName = null, Action<string> evaluate = null) {
lock (FlushTaskCancellationToken) {
if (FlushTaskCancellationToken.IsCancellationRequested) {
return null;
}
var scriptTask = new ScriptTask(script, functionName, evaluate);
PendingScripts.Add(scriptTask);
return scriptTask;
}
}
private void FlushScripts() {
#if DEBUG
System.Diagnostics.Debug.WriteLine($"{nameof(FlushScripts)} running ('{Id}')");
#endif
OwnerWebView.ExecuteWithAsyncErrorHandling(InnerFlushScripts);
}
private void InnerFlushScripts() {
try {
var scriptsToExecute = new List<ScriptTask>();
foreach (var scriptTask in PendingScripts.GetConsumingEnumerable()) {
if (scriptTask.Evaluate == null) {
scriptsToExecute.Add(scriptTask);
}
if ((PendingScripts.Count == 0 || scriptTask.Evaluate != null) && scriptsToExecute.Count > 0) {
BulkExecuteScripts(scriptsToExecute);
scriptsToExecute.Clear();
}
scriptTask.Evaluate?.Invoke(scriptTask.Script);
}
} catch (OperationCanceledException) {
// stop
} finally {
PendingScripts.Dispose();
FlushTaskCancellationToken.Dispose();
}
}
private void BulkExecuteScripts(IEnumerable<ScriptTask> scriptsToExecute) {
var script = string.Join(";" + Environment.NewLine, scriptsToExecute.Select(s => s.Script));
if (frame.IsValid) {
var frameName = frame.Name;
try {
var timeout = OwnerWebView.DefaultScriptsExecutionTimeout ?? DefaultTimeout;
var task = OwnerWebView.chromium.EvaluateJavaScript<object>(WrapScriptWithErrorHandling(script), timeout: timeout);
task.Wait(FlushTaskCancellationToken.Token);
} catch (OperationCanceledException) {
// ignore
} catch (Exception e) {
var evaluatedScriptFunctions = scriptsToExecute.Select(s => s.FunctionName);
OwnerWebView.ForwardUnhandledAsyncException(ParseException(e, evaluatedScriptFunctions), frameName);
}
}
}
public async Task<T> EvaluateScript<T>(string script, string functionName = null, TimeSpan? timeout = null) {
const string TimeoutExceptionName = "Timeout";
#if DEBUG
System.Diagnostics.Debug.WriteLine($"{nameof(EvaluateScript)} '{script}' on ('{Id}')");
#endif
var evaluationTask = new TaskCompletionSource<T>(TaskCreationOptions.RunContinuationsAsynchronously);
void Evaluate(string scriptToEvaluate) {
#if DEBUG
System.Diagnostics.Debug.WriteLine($"Evaluating '{script}' on ('{Id}')");
#endif
try {
var innerEvaluationTask = OwnerWebView.chromium.EvaluateJavaScript<T>(WrapScriptWithErrorHandling(scriptToEvaluate), timeout: timeout);
innerEvaluationTask.Wait(FlushTaskCancellationToken.Token);
evaluationTask.SetResult(GetResult<T>(innerEvaluationTask.Result));
} catch (Exception e) {
if (FlushTaskCancellationToken.IsCancellationRequested) {
evaluationTask.SetResult(GetResult<T>(default(T)));
} else if (e.InnerException is TaskCanceledException) {
evaluationTask.SetException(new JavascriptException(TimeoutExceptionName, "Script evaluation timed out"));
} else {
evaluationTask.SetException(ParseException(e, new[] { functionName }));
}
}
}
var scriptTask = QueueScript(script, functionName, Evaluate);
if (scriptTask == null) {
return default;
}
if (timeout.HasValue) {
var tasks = new [] {
evaluationTask.Task,
Task.Delay(timeout.Value)
};
// wait with timeout if flush is not running yet to avoid hanging forever
var task = await Task.WhenAny(tasks).ConfigureAwait(false);
if (task != evaluationTask.Task) {
if (IsFlushTaskInitializing) {
throw new JavascriptException(TimeoutExceptionName, $"Javascript engine is not initialized after {InitializationTimeout.Seconds}s");
}
// flush is already running, timeout will fire from the evaluation
}
}
return await evaluationTask.Task;
}
public Task<T> EvaluateScriptFunction<T>(string functionName, bool serializeParams, params object[] args) {
return EvaluateScript<T>(MakeScript(functionName, serializeParams, args, emitReturn: true), functionName);
}
public void ExecuteScriptFunction(string functionName, bool serializeParams, params object[] args) {
QueueScript(MakeScript(functionName, serializeParams, args, emitReturn: false), functionName);
}
public void ExecuteScript(string script) {
QueueScript(script);
}
private T GetResult<T>(object result) {
var targetType = typeof(T);
if (result == null) {
if (targetType.IsArray) {
// return empty arrays when value is null and return type is array
return (T)(object)Array.CreateInstance(targetType.GetElementType(), 0);
}
return default(T); // return default T (its safer, because we allow returning null and converting into a default struct value)
}
if (IsBasicType(targetType)) {
return (T)result;
}
return (T)result;
}
public void Dispose() {
StopFlush();
}
private static bool IsBasicType(Type type) {
return type.IsPrimitive || type.IsEnum || type == typeof(string);
}
private static string MakeScript(string functionName, bool serializeParams, object[] args, bool emitReturn) {
string SerializeParam(object value) {
if (serializeParams || value == null) {
return JavascriptSerializer.Serialize(value);
}
// TODO complex types
return value.ToString();
}
var argsSerialized = args.Select(SerializeParam);
return $"{(emitReturn ? "return " : string.Empty)}{functionName}({string.Join(",", argsSerialized)})";
}
private static string WrapScriptWithErrorHandling(string script) {
return "try {" + script + Environment.NewLine + "} catch (e) { throw JSON.stringify({ stack: e.stack, message: e.message, name: e.name }) + '" + InternalException + "' }";
}
private static T DeserializeJSON<T>(string json) {
var serializer = new DataContractJsonSerializer(typeof(JsError));
using (var stream = new MemoryStream(Encoding.UTF8.GetBytes(json))) {
return (T)serializer.ReadObject(stream);
}
}
private static Exception MakeTimeoutException(string functionName, TimeSpan timeout) {
return new JavascriptException("Timeout", $"More than {timeout.TotalMilliseconds}ms elapsed evaluating: '{functionName}'");
}
private static Exception ParseException(Exception exception, IEnumerable<string> evaluatedScriptFunctions) {
var jsErrorJSON = ((exception is AggregateException aggregateException) ? aggregateException.InnerExceptions.FirstOrDefault(e => IsInternalException(e.Message))?.Message : exception.Message) ?? "";
// try parse js exception
jsErrorJSON = jsErrorJSON.Substring(Math.Max(0, jsErrorJSON.IndexOf("{")));
jsErrorJSON = jsErrorJSON.Substring(0, jsErrorJSON.LastIndexOf("}") + 1);
var evaluatedStackFrames = evaluatedScriptFunctions.Where(f => !string.IsNullOrEmpty(f))
.Select(f => new JavascriptStackFrame(f, "eval", 0, 0));
if (!string.IsNullOrEmpty(jsErrorJSON)) {
JsError jsError = null;
try {
jsError = DeserializeJSON<JsError>(jsErrorJSON);
} catch {
// ignore will throw error at the end
}
if (jsError != null) {
jsError.Name = jsError.Name ?? "";
jsError.Message = jsError.Message ?? "";
jsError.Stack = jsError.Stack ?? "";
var jsStack = jsError.Stack.Substring(Math.Min(jsError.Stack.Length, (jsError.Name + ": " + jsError.Message).Length))
.Split(new[] { '\n' }, StringSplitOptions.RemoveEmptyEntries);
var parsedStack = new List<JavascriptStackFrame>();
parsedStack.AddRange(evaluatedStackFrames);
foreach (var stackFrame in jsStack) {
var frameParts = StackFrameRegex.Match(stackFrame);
if (frameParts.Success) {
parsedStack.Add(new JavascriptStackFrame(frameParts.Groups["method"].Value, frameParts.Groups["location"].Value, int.Parse(frameParts.Groups["column"].Value), int.Parse(frameParts.Groups["line"].Value)));
}
}
return new JavascriptException(jsError.Name, jsError.Message, parsedStack);
}
}
return new JavascriptException(exception.Message, evaluatedStackFrames, exception.StackTrace);
}
internal static bool IsInternalException(string exceptionMessage) {
return exceptionMessage.EndsWith(InternalException);
}
}
}
}