Merge pull request WolvenKit#2664 from WolvenKit/feature/wscript-debugger

Debugging for WScripts

Author: seberoth

WolvenKit.App/Services/AppScriptService.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
@@ -64,10 +64,10 @@ public AppScriptService(
         return _projectExplorerViewModel;
     }
 
-    public async Task ExecuteAsync(string code)
+    public async Task ExecuteAsync(string code, bool enableDebugging = false)
     {
         GetProjectExplorerViewModel()?.SuspendFileWatcher();
-        await ExecuteAsync(code, DefaultHostObject);
+        await ExecuteAsync(code, DefaultHostObject, null, enableDebugging);
         GetProjectExplorerViewModel()?.ResumeFileWatcher();
     }
 
@@ -88,11 +88,11 @@ public IList<ScriptFile> GetScripts()
         return result;
     }
 
-    protected override V8ScriptEngine GetScriptEngine(Dictionary<string, object>? hostObjects = null, List<string>? searchPaths = null)
+    protected override V8ScriptEngine GetScriptEngine(Dictionary<string, object>? hostObjects = null, List<string>? searchPaths = null, bool enableDebugging = false)
     {
         searchPaths ??= new List<string> { ISettingsManager.GetWScriptDir(), Path.GetFullPath(@"Resources\Scripts") };
 
-        var engine = base.GetScriptEngine(hostObjects, searchPaths);
+        var engine = base.GetScriptEngine(hostObjects, searchPaths, enableDebugging);
 
         engine.AddHostType(typeof(EUncookExtension));
         engine.AddHostType(typeof(MeshExporterType));

WolvenKit.App/ViewModels/Documents/WScriptDocumentViewModel.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.IO;
@@ -36,6 +36,7 @@ private void _scriptService_PropertyChanged(object? sender, PropertyChangedEvent
         if(e.PropertyName == nameof(ScriptService.IsRunning))
         {
             RunCommand.NotifyCanExecuteChanged();
+            DebugCommand.NotifyCanExecuteChanged();
             StopCommand.NotifyCanExecuteChanged();
         }
     }
@@ -69,6 +70,9 @@ private void _scriptService_PropertyChanged(object? sender, PropertyChangedEvent
     [RelayCommand(CanExecute = nameof(CanRun))]
     private async Task Run() => await _scriptService.ExecuteAsync(Text);
 
+    [RelayCommand(CanExecute = nameof(CanRun))]
+    private async Task Debug() => await _scriptService.ExecuteAsync(Text, true);
+
     private bool CanStop() => _scriptService.IsRunning;
     [RelayCommand(CanExecute = nameof(CanStop))]
     private void Stop() => _scriptService.Stop();
@@ -178,4 +182,4 @@ private void GetScriptType(string fileName)
             IsNormalScript = true;
         }
     }
-}
+}

WolvenKit.Modkit/Scripting/ScriptService.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Diagnostics;
@@ -29,7 +29,7 @@ public partial class ScriptService : ObservableObject
 
     public ScriptService(ILoggerService loggerService) => _loggerService = loggerService;
 
-    public async Task ExecuteAsync(string code, Dictionary<string, object>? hostObjects = null, List<string>? searchPaths = null)
+    public async Task ExecuteAsync(string code, Dictionary<string, object>? hostObjects = null, List<string>? searchPaths = null, bool enableDebugging = false)
     {
         if (_mainEngine != null)
         {
@@ -41,7 +41,7 @@ public async Task ExecuteAsync(string code, Dictionary<string, object>? hostObje
 
         var sw = Stopwatch.StartNew();
 
-        _mainEngine = GetScriptEngine(hostObjects, searchPaths);
+        _mainEngine = GetScriptEngine(hostObjects, searchPaths, enableDebugging);
 
         try
         {
@@ -91,9 +91,16 @@ public void Stop()
         IsRunning = false;
     }
 
-    protected virtual V8ScriptEngine GetScriptEngine(Dictionary<string, object>? hostObjects = null, List<string>? searchPaths = null)
+    protected virtual V8ScriptEngine GetScriptEngine(Dictionary<string, object>? hostObjects = null, List<string>? searchPaths = null, bool enableDebugging = false)
     {
-        var engine = new V8ScriptEngine();
+        var flags = V8ScriptEngineFlags.None;
+        if (enableDebugging)
+        {
+            flags |= V8ScriptEngineFlags.EnableDebugging;
+            flags |= V8ScriptEngineFlags.AwaitDebuggerAndPauseOnStart;
+        }
+
+        var engine = new V8ScriptEngine(flags);
 
         engine.AddHostType(typeof(OpenAs));
         engine.AddHostObject("logger", _loggerService);
@@ -151,4 +158,4 @@ public virtual IList<ScriptFile> GetScripts(string path)
     }
 
     public void RemoveFromCache(string path) => _scriptCache.Remove(path, out _);
-}
+}

WolvenKit/Views/Documents/WScriptDocumentView.xaml

@@ -1,4 +1,4 @@
-<reactiveUi:ReactiveUserControl
+<reactiveUi:ReactiveUserControl
     x:Class="WolvenKit.Views.Documents.WScriptDocumentView"
     x:TypeArguments="documents:WScriptDocumentViewModel"
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
@@ -69,6 +69,21 @@
                 </MenuItem.Icon>
             </MenuItem>
 
+            <MenuItem
+                Visibility="{Binding IsNormalScript,
+                                     Converter={StaticResource BooleanToVisibilityConverter}}"
+                Command="{Binding DebugCommand}"
+                CommandParameter="{Binding Document.Text}"
+                Header="Debug"
+                ToolTip="Waits for debugger on port 9222">
+                <MenuItem.Icon>
+                    <templates:IconBox
+                        IconPack="Material"
+                        Kind="BugPlay"
+                        Foreground="{StaticResource WolvenKitGreen}" />
+                </MenuItem.Icon>
+            </MenuItem>
+
             <MenuItem
                 Visibility="{Binding IsNormalScript,
                                      Converter={StaticResource BooleanToVisibilityConverter}}"