Make commands async and internal processes cancelable

13 files changed, 75 insertions, 45 deletions

diff --git a/src/WixToolset.Core.TestPackage/WixRunner.cs b/src/WixToolset.Core.TestPackage/WixRunner.cs
index 082e9e10..679956bd 100644
--- a/src/WixToolset.Core.TestPackage/WixRunner.cs
+++ b/src/WixToolset.Core.TestPackage/WixRunner.cs
@@ -4,6 +4,8 @@ namespace WixToolset.Core.TestPackage
 {
     using System;
     using System.Collections.Generic;
+    using System.Threading;
+    using System.Threading.Tasks;
     using WixToolset.Data;
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
@@ -13,17 +15,18 @@ namespace WixToolset.Core.TestPackage
         public static int Execute(string[] args, out List<Message> messages)
         {
             var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider();
-            return Execute(args, serviceProvider, out messages);
+            var task = Execute(args, serviceProvider, out messages);
+            return task.Result;
         }
 
         public static WixRunnerResult Execute(params string[] args)
         {
             var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider();
             var exitCode = Execute(args, serviceProvider, out var messages);
-            return new WixRunnerResult { ExitCode = exitCode, Messages = messages.ToArray() };
+            return new WixRunnerResult { ExitCode = exitCode.Result, Messages = messages.ToArray() };
         }
 
-        public static int Execute(string[] args, IWixToolsetServiceProvider serviceProvider, out List<Message> messages)
+        public static Task<int> Execute(string[] args, IWixToolsetServiceProvider serviceProvider, out List<Message> messages)
         {
             var listener = new TestMessageListener();
 
@@ -39,7 +42,7 @@ namespace WixToolset.Core.TestPackage
             commandLine.ExtensionManager = CreateExtensionManagerWithStandardBackends(serviceProvider, arguments.Extensions);
             commandLine.Arguments = arguments;
             var command = commandLine.ParseStandardCommandLine();
-            return command?.Execute() ?? 1;
+            return command?.ExecuteAsync(CancellationToken.None) ?? Task.FromResult(1);
         }
 
         private static IExtensionManager CreateExtensionManagerWithStandardBackends(IWixToolsetServiceProvider serviceProvider, string[] extensions)
diff --git a/src/WixToolset.Core/BindContext.cs b/src/WixToolset.Core/BindContext.cs
index 3d7563c6..47375fb0 100644
--- a/src/WixToolset.Core/BindContext.cs
+++ b/src/WixToolset.Core/BindContext.cs
@@ -2,8 +2,8 @@
 
 namespace WixToolset.Core
 {
-    using System;
     using System.Collections.Generic;
+    using System.Threading;
     using WixToolset.Data;
     using WixToolset.Extensibility;
     using WixToolset.Extensibility.Data;
@@ -55,5 +55,7 @@ namespace WixToolset.Core
         public bool SuppressValidation { get; set; }
 
         public bool SuppressLayout { get; set; }
+
+        public CancellationToken CancellationToken { get; set; }
     }
 }
diff --git a/src/WixToolset.Core/CommandLine/BuildCommand.cs b/src/WixToolset.Core/CommandLine/BuildCommand.cs
index 8392131f..8602c514 100644
--- a/src/WixToolset.Core/CommandLine/BuildCommand.cs
+++ b/src/WixToolset.Core/CommandLine/BuildCommand.cs
@@ -6,6 +6,8 @@ namespace WixToolset.Core.CommandLine
     using System.Collections.Generic;
     using System.IO;
     using System.Linq;
+    using System.Threading;
+    using System.Threading.Tasks;
     using System.Xml.Linq;
     using WixToolset.Data;
     using WixToolset.Extensibility;
@@ -54,12 +56,12 @@ namespace WixToolset.Core.CommandLine
 
         private string BuiltOutputsFile { get; set; }
 
-        public int Execute()
+        public Task<int> ExecuteAsync(CancellationToken cancellationToken)
         {
             if (this.commandLine.ShowHelp)
             {
                 Console.WriteLine("TODO: Show build command help");
-                return -1;
+                return Task.FromResult(-1);
             }
 
             this.IntermediateFolder = this.commandLine.CalculateIntermedateFolder();
@@ -107,23 +109,23 @@ namespace WixToolset.Core.CommandLine
 
             if (this.Messaging.EncounteredError)
             {
-                return this.Messaging.LastErrorNumber;
+                return Task.FromResult(this.Messaging.LastErrorNumber);
             }
 
-            var wixobjs = this.CompilePhase(preprocessorVariables, codeFiles);
+            var wixobjs = this.CompilePhase(preprocessorVariables, codeFiles, cancellationToken);
 
-            var wxls = this.LoadLocalizationFiles(this.commandLine.LocalizationFilePaths, preprocessorVariables);
+            var wxls = this.LoadLocalizationFiles(this.commandLine.LocalizationFilePaths, preprocessorVariables, cancellationToken);
 
             if (this.Messaging.EncounteredError)
             {
-                return this.Messaging.LastErrorNumber;
+                return Task.FromResult(this.Messaging.LastErrorNumber);
             }
 
             if (this.OutputType == OutputType.Library)
             {
                 using (new IntermediateFieldContext("wix.lib"))
                 {
-                    var wixlib = this.LibraryPhase(wixobjs, wxls, this.commandLine.BindFiles, this.commandLine.BindPaths);
+                    var wixlib = this.LibraryPhase(wixobjs, wxls, this.commandLine.BindFiles, this.commandLine.BindPaths, cancellationToken);
 
                     if (!this.Messaging.EncounteredError)
                     {
@@ -137,7 +139,7 @@ namespace WixToolset.Core.CommandLine
                 {
                     if (wixipl == null)
                     {
-                        wixipl = this.LinkPhase(wixobjs, this.commandLine.LibraryFilePaths, creator);
+                        wixipl = this.LinkPhase(wixobjs, this.commandLine.LibraryFilePaths, creator, cancellationToken);
                     }
 
                     if (!this.Messaging.EncounteredError)
@@ -157,14 +159,14 @@ namespace WixToolset.Core.CommandLine
                         {
                             using (new IntermediateFieldContext("wix.bind"))
                             {
-                                this.BindPhase(wixipl, wxls, filterCultures, this.commandLine.CabCachePath, this.commandLine.BindPaths);
+                                this.BindPhase(wixipl, wxls, filterCultures, this.commandLine.CabCachePath, this.commandLine.BindPaths, cancellationToken);
                             }
                         }
                     }
                 }
             }
 
-            return this.Messaging.LastErrorNumber;
+            return Task.FromResult(this.Messaging.LastErrorNumber);
         }
 
         public bool TryParseArgument(ICommandLineParser parser, string argument)
@@ -210,13 +212,13 @@ namespace WixToolset.Core.CommandLine
             }
         }
 
-        private IEnumerable<Intermediate> CompilePhase(IDictionary<string, string> preprocessorVariables, IEnumerable<SourceFile> sourceFiles)
+        private IEnumerable<Intermediate> CompilePhase(IDictionary<string, string> preprocessorVariables, IEnumerable<SourceFile> sourceFiles, CancellationToken cancellationToken)
         {
             var intermediates = new List<Intermediate>();
 
             foreach (var sourceFile in sourceFiles)
             {
-                var document = this.Preprocess(preprocessorVariables, sourceFile.SourcePath);
+                var document = this.Preprocess(preprocessorVariables, sourceFile.SourcePath, cancellationToken);
 
                 if (this.Messaging.EncounteredError)
                 {
@@ -228,6 +230,7 @@ namespace WixToolset.Core.CommandLine
                 context.OutputPath = sourceFile.OutputPath;
                 context.Platform = this.Platform;
                 context.Source = document;
+                context.CancellationToken = cancellationToken;
 
                 Intermediate intermediate = null;
                 try
@@ -251,7 +254,7 @@ namespace WixToolset.Core.CommandLine
             return intermediates;
         }
 
-        private Intermediate LibraryPhase(IEnumerable<Intermediate> intermediates, IEnumerable<Localization> localizations, bool bindFiles, IEnumerable<IBindPath> bindPaths)
+        private Intermediate LibraryPhase(IEnumerable<Intermediate> intermediates, IEnumerable<Localization> localizations, bool bindFiles, IEnumerable<IBindPath> bindPaths, CancellationToken cancellationToken)
         {
             var context = this.ServiceProvider.GetService<ILibraryContext>();
             context.BindFiles = bindFiles;
@@ -259,6 +262,7 @@ namespace WixToolset.Core.CommandLine
             context.Extensions = this.ExtensionManager.GetServices<ILibrarianExtension>();
             context.Localizations = localizations;
             context.Intermediates = intermediates;
+            context.CancellationToken = cancellationToken;
 
             Intermediate library = null;
             try
@@ -274,7 +278,7 @@ namespace WixToolset.Core.CommandLine
             return library;
         }
 
-        private Intermediate LinkPhase(IEnumerable<Intermediate> intermediates, IEnumerable<string> libraryFiles, ITupleDefinitionCreator creator)
+        private Intermediate LinkPhase(IEnumerable<Intermediate> intermediates, IEnumerable<string> libraryFiles, ITupleDefinitionCreator creator, CancellationToken cancellationToken)
         {
             var libraries = this.LoadLibraries(libraryFiles, creator);
 
@@ -289,12 +293,13 @@ namespace WixToolset.Core.CommandLine
             context.ExpectedOutputType = this.OutputType;
             context.Intermediates = intermediates.Concat(libraries).ToList();
             context.TupleDefinitionCreator = creator;
+            context.CancellationToken = cancellationToken;
 
             var linker = this.ServiceProvider.GetService<ILinker>();
             return linker.Link(context);
         }
 
-        private void BindPhase(Intermediate output, IEnumerable<Localization> localizations, IEnumerable<string> filterCultures, string cabCachePath, IEnumerable<IBindPath> bindPaths)
+        private void BindPhase(Intermediate output, IEnumerable<Localization> localizations, IEnumerable<string> filterCultures, string cabCachePath, IEnumerable<IBindPath> bindPaths, CancellationToken cancellationToken)
         {
             var intermediateFolder = this.IntermediateFolder;
             if (String.IsNullOrEmpty(intermediateFolder))
@@ -312,6 +317,7 @@ namespace WixToolset.Core.CommandLine
                 context.IntermediateFolder = intermediateFolder;
                 context.IntermediateRepresentation = output;
                 context.Localizations = localizations;
+                context.CancellationToken = cancellationToken;
 
                 var resolver = this.ServiceProvider.GetService<IResolver>();
                 resolveResult = resolver.Resolve(context);
@@ -343,6 +349,7 @@ namespace WixToolset.Core.CommandLine
                     context.PdbPath = this.PdbType == PdbType.None ? null : this.PdbFile ?? Path.ChangeExtension(this.OutputFile, ".wixpdb");
                     context.SuppressIces = Array.Empty<string>(); // TODO: set this correctly
                     context.SuppressValidation = true; // TODO: set this correctly
+                    context.CancellationToken = cancellationToken;
 
                     var binder = this.ServiceProvider.GetService<IBinder>();
                     bindResult = binder.Bind(context);
@@ -363,6 +370,7 @@ namespace WixToolset.Core.CommandLine
                     context.OutputsFile = this.OutputsFile;
                     context.BuiltOutputsFile = this.BuiltOutputsFile;
                     context.SuppressAclReset = false; // TODO: correctly set SuppressAclReset
+                    context.CancellationToken = cancellationToken;
 
                     var layout = this.ServiceProvider.GetService<ILayoutCreator>();
                     layout.Layout(context);
@@ -392,14 +400,14 @@ namespace WixToolset.Core.CommandLine
             return Array.Empty<Intermediate>();
         }
 
-        private IEnumerable<Localization> LoadLocalizationFiles(IEnumerable<string> locFiles, IDictionary<string, string> preprocessorVariables)
+        private IEnumerable<Localization> LoadLocalizationFiles(IEnumerable<string> locFiles, IDictionary<string, string> preprocessorVariables, CancellationToken cancellationToken)
         {
             var localizations = new List<Localization>();
             var parser = this.ServiceProvider.GetService<ILocalizationParser>();
 
             foreach (var loc in locFiles)
             {
-                var document = this.Preprocess(preprocessorVariables, loc);
+                var document = this.Preprocess(preprocessorVariables, loc, cancellationToken);
 
                 if (this.Messaging.EncounteredError)
                 {
@@ -413,7 +421,7 @@ namespace WixToolset.Core.CommandLine
             return localizations;
         }
 
-        private XDocument Preprocess(IDictionary<string, string> preprocessorVariables, string sourcePath)
+        private XDocument Preprocess(IDictionary<string, string> preprocessorVariables, string sourcePath, CancellationToken cancellationToken)
         {
             var context = this.ServiceProvider.GetService<IPreprocessContext>();
             context.Extensions = this.ExtensionManager.GetServices<IPreprocessorExtension>();
@@ -421,6 +429,7 @@ namespace WixToolset.Core.CommandLine
             context.IncludeSearchPaths = this.IncludeSearchPaths;
             context.SourcePath = sourcePath;
             context.Variables = preprocessorVariables;
+            context.CancellationToken = cancellationToken;
 
             IPreprocessResult result = null;
             try
diff --git a/src/WixToolset.Core/CommandLine/CompileCommand.cs b/src/WixToolset.Core/CommandLine/CompileCommand.cs
index 67756947..d16c7a46 100644
--- a/src/WixToolset.Core/CommandLine/CompileCommand.cs
+++ b/src/WixToolset.Core/CommandLine/CompileCommand.cs
@@ -4,7 +4,8 @@ namespace WixToolset.Core.CommandLine
 {
     using System;
     using System.Collections.Generic;
-    using System.Xml.Linq;
+    using System.Threading;
+    using System.Threading.Tasks;
     using WixToolset.Data;
     using WixToolset.Extensibility;
     using WixToolset.Extensibility.Data;
@@ -47,12 +48,9 @@ namespace WixToolset.Core.CommandLine
 
         public bool StopParsing => throw new NotImplementedException();
 
-        public bool TryParseArgument(ICommandLineParser parseHelper, string argument)
-        {
-            throw new NotImplementedException();
-        }
+        public bool TryParseArgument(ICommandLineParser parseHelper, string argument) => throw new NotImplementedException();
 
-        public int Execute()
+        public Task<int> ExecuteAsync(CancellationToken _)
         {
             foreach (var sourceFile in this.SourceFiles)
             {
@@ -91,7 +89,7 @@ namespace WixToolset.Core.CommandLine
                 intermediate.Save(sourceFile.OutputPath);
             }
 
-            return 0;
+            return Task.FromResult(0);
         }
     }
 }
diff --git a/src/WixToolset.Core/CommandLine/DecompileCommand.cs b/src/WixToolset.Core/CommandLine/DecompileCommand.cs
index 0e21a4f4..1e11ae52 100644
--- a/src/WixToolset.Core/CommandLine/DecompileCommand.cs
+++ b/src/WixToolset.Core/CommandLine/DecompileCommand.cs
@@ -4,6 +4,8 @@ namespace WixToolset.Core.CommandLine
 {
     using System;
     using System.IO;
+    using System.Threading;
+    using System.Threading.Tasks;
     using System.Xml.Linq;
     using WixToolset.Data;
     using WixToolset.Extensibility;
@@ -29,12 +31,12 @@ namespace WixToolset.Core.CommandLine
 
         public IMessaging Messaging { get; }
 
-        public int Execute()
+        public Task<int> ExecuteAsync(CancellationToken _)
         {
             if (this.commandLine.ShowHelp)
             {
                 Console.WriteLine("TODO: Show decompile command help");
-                return -1;
+                return Task.FromResult(-1);
             }
 
             var context = this.ServiceProvider.GetService<IDecompileContext>();
@@ -61,10 +63,10 @@ namespace WixToolset.Core.CommandLine
 
             if (this.Messaging.EncounteredError)
             {
-                return 1;
+                return Task.FromResult(1);
             }
 
-            return 0;
+            return Task.FromResult(0);
         }
 
         public bool TryParseArgument(ICommandLineParser parser, string argument)
diff --git a/src/WixToolset.Core/CommandLine/HelpCommand.cs b/src/WixToolset.Core/CommandLine/HelpCommand.cs
index 224b154c..78845189 100644
--- a/src/WixToolset.Core/CommandLine/HelpCommand.cs
+++ b/src/WixToolset.Core/CommandLine/HelpCommand.cs
@@ -1,8 +1,10 @@
-// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
 
 namespace WixToolset.Core.CommandLine
 {
     using System;
+    using System.Threading;
+    using System.Threading.Tasks;
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
 
@@ -12,11 +14,11 @@ namespace WixToolset.Core.CommandLine
 
         public bool StopParsing => true;
 
-        public int Execute()
+        public Task<int> ExecuteAsync(CancellationToken _)
         {
             Console.WriteLine("TODO: Show list of available commands");
 
-            return -1;
+            return Task.FromResult(-1);
         }
 
         public bool TryParseArgument(ICommandLineParser parseHelper, string argument)
diff --git a/src/WixToolset.Core/CommandLine/VersionCommand.cs b/src/WixToolset.Core/CommandLine/VersionCommand.cs
index 50e90a93..6ce2a89d 100644
--- a/src/WixToolset.Core/CommandLine/VersionCommand.cs
+++ b/src/WixToolset.Core/CommandLine/VersionCommand.cs
@@ -3,6 +3,8 @@
 namespace WixToolset.Core.CommandLine
 {
     using System;
+    using System.Threading;
+    using System.Threading.Tasks;
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
 
@@ -12,12 +14,12 @@ namespace WixToolset.Core.CommandLine
 
         public bool StopParsing => true;
 
-        public int Execute()
+        public Task<int> ExecuteAsync(CancellationToken cancellationToken)
         {
             Console.WriteLine("wix version {0}", ThisAssembly.AssemblyInformationalVersion);
             Console.WriteLine();
 
-            return 0;
+            return Task.FromResult(0);
         }
 
         public bool TryParseArgument(ICommandLineParser parseHelper, string argument) => true; // eat any arguments
diff --git a/src/WixToolset.Core/CompileContext.cs b/src/WixToolset.Core/CompileContext.cs
index f92a131d..7dc862b9 100644
--- a/src/WixToolset.Core/CompileContext.cs
+++ b/src/WixToolset.Core/CompileContext.cs
@@ -2,8 +2,8 @@
 
 namespace WixToolset.Core
 {
-    using System;
     using System.Collections.Generic;
+    using System.Threading;
     using System.Xml.Linq;
     using WixToolset.Data;
     using WixToolset.Extensibility;
@@ -28,5 +28,7 @@ namespace WixToolset.Core
         public Platform Platform { get; set; }
 
         public XDocument Source { get; set; }
+
+        public CancellationToken CancellationToken { get; set; }
     }
 }
diff --git a/src/WixToolset.Core/LayoutContext.cs b/src/WixToolset.Core/LayoutContext.cs
index 385aa610..7bbae0c0 100644
--- a/src/WixToolset.Core/LayoutContext.cs
+++ b/src/WixToolset.Core/LayoutContext.cs
@@ -2,8 +2,8 @@
 
 namespace WixToolset.Core
 {
-    using System;
     using System.Collections.Generic;
+    using System.Threading;
     using WixToolset.Extensibility;
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
@@ -34,5 +34,7 @@ namespace WixToolset.Core
         public string BuiltOutputsFile { get; set; }
 
         public bool SuppressAclReset { get; set; }
+
+        public CancellationToken CancellationToken { get; set; }
     }
 }
diff --git a/src/WixToolset.Core/LibraryContext.cs b/src/WixToolset.Core/LibraryContext.cs
index 4df19702..9fd76cf5 100644
--- a/src/WixToolset.Core/LibraryContext.cs
+++ b/src/WixToolset.Core/LibraryContext.cs
@@ -2,8 +2,8 @@
 
 namespace WixToolset.Core
 {
-    using System;
     using System.Collections.Generic;
+    using System.Threading;
     using WixToolset.Data;
     using WixToolset.Extensibility;
     using WixToolset.Extensibility.Data;
@@ -31,5 +31,7 @@ namespace WixToolset.Core
         public IEnumerable<Localization> Localizations { get; set; }
 
         public IEnumerable<Intermediate> Intermediates { get; set; }
+
+        public CancellationToken CancellationToken { get; set; }
     }
 }
diff --git a/src/WixToolset.Core/LinkContext.cs b/src/WixToolset.Core/LinkContext.cs
index 64dd2320..65b1179e 100644
--- a/src/WixToolset.Core/LinkContext.cs
+++ b/src/WixToolset.Core/LinkContext.cs
@@ -2,8 +2,8 @@
 
 namespace WixToolset.Core
 {
-    using System;
     using System.Collections.Generic;
+    using System.Threading;
     using WixToolset.Data;
     using WixToolset.Extensibility;
     using WixToolset.Extensibility.Data;
@@ -27,5 +27,7 @@ namespace WixToolset.Core
         public IEnumerable<Intermediate> Intermediates { get; set; }
 
         public ITupleDefinitionCreator TupleDefinitionCreator { get; set; }
+
+        public CancellationToken CancellationToken { get; set; }
     }
 }
diff --git a/src/WixToolset.Core/PreprocessContext.cs b/src/WixToolset.Core/PreprocessContext.cs
index 15529d24..d273d76b 100644
--- a/src/WixToolset.Core/PreprocessContext.cs
+++ b/src/WixToolset.Core/PreprocessContext.cs
@@ -2,8 +2,8 @@
 
 namespace WixToolset.Core
 {
-    using System;
     using System.Collections.Generic;
+    using System.Threading;
     using WixToolset.Data;
     using WixToolset.Extensibility;
     using WixToolset.Extensibility.Data;
@@ -29,5 +29,7 @@ namespace WixToolset.Core
         public IDictionary<string, string> Variables { get; set; }
 
         public SourceLineNumber CurrentSourceLineNumber { get; set; }
+
+        public CancellationToken CancellationToken { get; set; }
     }
 }
diff --git a/src/WixToolset.Core/ResolveContext.cs b/src/WixToolset.Core/ResolveContext.cs
index 34da34d1..6e1718b6 100644
--- a/src/WixToolset.Core/ResolveContext.cs
+++ b/src/WixToolset.Core/ResolveContext.cs
@@ -2,8 +2,8 @@
 
 namespace WixToolset.Core
 {
-    using System;
     using System.Collections.Generic;
+    using System.Threading;
     using WixToolset.Data;
     using WixToolset.Extensibility;
     using WixToolset.Extensibility.Data;
@@ -35,5 +35,7 @@ namespace WixToolset.Core
         public IVariableResolver VariableResolver { get; set; }
 
         public bool AllowUnresolvedVariables { get; set; }
+
+        public CancellationToken CancellationToken { get; set; }
     }
 }