[Xamarin.Android.Build.Tasks] Avoid MSB4018; use XA[A-Z]{3}7[0-9]{3} (#3609)

Changes: https://github.com/xamarin/monodroid/compare/3ed4b1921a43a6bf5718e82c923040e2512dd8cf...623845d44abe5eb7a76d9a63d48b30a27ac1bac2

Bumps to xamarin/monodroid/master@623845d4.

Errors and warning *codes* for errors and warnings reported
*within Visual Studio* from developers participating in the
[Visual Studio Customer Experience Improvement Program][0] are
reported "telemetry" events, but *only* the error and warning codes
are reported.  The warning and error message contents are not sent.

Unfortunately all unhandled exceptions not caught within our MSBuild
tasks are reported as `MSB4018`, which reduces the utility of
telemetry, making it more difficult to better understand where our
build system could be improved.

Update all of our tasks to inherit from one of the new types
`AndroidTask`, `AndroidAsyncTask`, or `AndroidToolTask`.  These tasks
add catch-all exception handlers that capture and log unhandled
exceptions instead of allowing them to leak out to MSBuild, producing
more useful error and warning message codes for telemetry.

Each error code contains:

 1. An `XA` prefix to denote that it is from Xamarin.Android so our
    codes do not collide with other components.

 2. Three-letters to designate which Task is throwing the error.
    For example, the `<Aot/>` task uses `AOT` while the
    `<LinkAssemblies/>` task uses `LNK`.

 3. A `7` to designate unhandled exceptions.

 4. Three digits to specify a particular exception type, or `000`
    for an unmapped exception type.
    
    See `src/Xamarin.Android.Build.Tasks/Utilities/UnhandledExceptionLogger.cs`
    for the mapping from exception types to numbers.

For example, a `NullReferenceException` thrown from the
`<LinkAssemblies>` task will now result in an XALNK7001 error
(instead of an MSB4018), while a `StackOverflowException` within the
`<Aot/>` task will result in an XAAOT7016 error.

[0]: https://docs.microsoft.com/en-us/visualstudio/ide/visual-studio-experience-improvement-program?view=vs-2019

Author: jpobst

.external

@@ -1,2 +1,2 @@
-xamarin/monodroid:master@3ed4b1921a43a6bf5718e82c923040e2512dd8cf
+xamarin/monodroid:master@623845d44abe5eb7a76d9a63d48b30a27ac1bac2
 mono/mono:2019-08@29b1ac19c961b959a09097dbc0fe4cd567cc5298

Documentation/guides/messages/README.md

@@ -103,7 +103,150 @@ ms.date: 08/23/2019
 
 ## XA6xxx: Internal tools
 
-## XA7xxx:	Reserved
+## XA7xxx: Unhandled MSBuild Exceptions
+
+Exceptions that have not been gracefully handled yet.  Ideally these will be fixed or replaced with better errors in the future.
+
+These take the form of `XACCC7NNN`, where `CCC` is a 3 character code denoting the MSBuild Task that is throwing the exception,
+and `NNN` is a 3 digit number indicating the type of the unhandled `Exception`.
+
+**Tasks:**
+* `A2C` - `Aapt2Compile`
+* `A2L` - `Aapt2Link`
+* `AAS` - `AndroidApkSigner`
+* `ACD` - `AndroidCreateDebugKey`
+* `ACM` - `AppendCustomMetadataToItemGroup`
+* `ADB` - `Adb`
+* `AJV` - `AdjustJavacVersionArguments`
+* `AOT` - `Aot`
+* `APT` - `Aapt`
+* `ASP` - `AndroidSignPackage`
+* `AZA` - `AndroidZipAlign`
+* `BAB` - `BuildAppBundle`
+* `BAS` - `BuildApkSet`
+* `BBA` - `BuildBaseAppBundle`
+* `BGN` - `BindingsGenerator`
+* `BLD` - `BuildApk`
+* `CAL` - `CreateAdditionalLibraryResourceCache`
+* `CAR` - `CalculateAdditionalResourceCacheDirectories`
+* `CCR` - `CopyAndConvertResources`
+* `CCV` - `ConvertCustomView`
+* `CDF` - `ConvertDebuggingFiles`
+* `CDJ` - `CheckDuplicateJavaLibraries`
+* `CFI` - `CheckForInvalidResourceFileNames`
+* `CFR` - `CheckForRemovedItems`
+* `CGJ` - `CopyGeneratedJavaResourceClasses`
+* `CGS` - `CheckGoogleSdkRequirements`
+* `CIC` - `CopyIfChanged`
+* `CIL` - `CilStrip`
+* `CLA` - `CollectLibraryAssets`
+* `CLC` - `CalculateLayoutCodeBehind`
+* `CLP` - `ClassParse`
+* `CLR` - `CreateLibraryResourceArchive`
+* `CMD` - `CreateMultiDexMainDexClassList`
+* `CML` - `CreateManagedLibraryResourceArchive`
+* `CMM` - `CreateMsymManifest`
+* `CNA` - `CompileNativeAssembly`
+* `CNE` - `CollectNonEmptyDirectories`
+* `CNL` - `CreateNativeLibraryArchive`
+* `CPD` - `CalculateProjectDependencies`
+* `CPF` - `CollectPdbFiles`
+* `CPI` - `CheckProjectItems`
+* `CPR` - `CopyResource`
+* `CPT` - `ComputeHash`
+* `CRC` - `ConvertResourcesCases`
+* `CRM` - `CreateResgenManifest`
+* `CRN` - `Crunch`
+* `CRP` - `AndroidComputeResPaths`
+* `CTD` - `CreateTemporaryDirectory`
+* `CTX` - `CompileToDalvik`
+* `DES` - `Desugar`
+* `DJL` - `DetermineJavaLibrariesToCompile`
+* `DX8` - `D8`
+* `FLB` - `FindLayoutsToBind`
+* `FLT` - `FilterAssemblies`
+* `GAD` - `GetAndroidDefineConstants`
+* `GAP` - `GetAndroidPackageName`
+* `GAR` - `GetAdditionalResourcesFromAssemblies`
+* `GAS` - `GetAppSettingsDirectory`
+* `GCB` - `GenerateCodeBehindForLayout`
+* `GCJ` - `GetConvertedJavaLibraries`
+* `GEP` - `GetExtraPackages`
+* `GFT` - `GetFilesThatExist`
+* `GIL` - `GetImportedLibraries`
+* `GJP` - `GetJavaPlatformJar`
+* `GJS` - `GenerateJavaStubs`
+* `GLB` - `GenerateLayoutBindings`
+* `GLR` - `GenerateLibraryResources`
+* `GMA` - `GenerateManagedAidlProxies`
+* `GMJ` - `GetMonoPlatformJar`
+* `GPM` - `GeneratePackageManagerJava`
+* `GRD` - `GenerateResourceDesigner`
+* `IAS` - `InstallApkSet`
+* `IJD` - `ImportJavaDoc`
+* `JDC` - `JavaDoc`
+* `JVC` - `Javac`
+* `JTX` - `JarToXml`
+* `KEY` - `KeyTool`
+* `LAS` - `LinkApplicationSharedLibraries`
+* `LEF` - `LogErrorsForFiles`
+* `LNK` - `LinkAssemblies`
+* `LNS` - `LinkAssembliesNoShrink`
+* `LNT` - `Lint`
+* `LWF` - `LogWarningsForFiles`
+* `MBN` - `MakeBundleNativeCodeExternal`
+* `MDC` - `MDoc`
+* `MER` - `MergeResources`
+* `PAI` - `PrepareAbiItems`
+* `PAW` - `ParseAndroidWearProjectAndManifest`
+* `PRO` - `Proguard`
+* `PWA` - `PrepareWearApplicationFiles`
+* `R8D` - `R8`
+* `RAM` - `ReadAndroidManifest`
+* `RAR` - `ReadAdditionalResourcesFromAssemblyCache`
+* `RAT` - `ResolveAndroidTooling`
+* `RDF` - `RemoveDirFixed`
+* `RIL` - `ReadImportedLibrariesCache`
+* `RJJ` - `ResolveJdkJvmPath`
+* `RLC` - `ReadLibraryProjectImportsCache`
+* `RLP` - `ResolveLibraryProjectImports`
+* `RRA` - `RemoveRegisterAttribute`
+* `RSA` - `ResolveAssemblies`
+* `RSD` - `ResolveSdks`
+* `RUF` - `RemoveUnknownFiles`
+* `SPL` - `SplitProperty`
+* `SVM` - `SetVsMonoAndroidRegistryKey`
+* `UNZ` - `Unzip`
+* `VJV` - `ValidateJavaVersion`
+* `WLF` - `WriteLockFile`
+
+**Exceptions:**
+
+* `7000` - Other Exception
+* `7001` - `NullReferenceException`
+* `7002` - `ArgumentOutOfRangeException`
+* `7003` - `ArgumentNullException`
+* `7004` - `ArgumentException`
+* `7005` - `FormatException`
+* `7006` - `IndexOutOfRangeException`
+* `7007` - `InvalidCastException`
+* `7008` - `ObjectDisposedException`
+* `7009` - `InvalidOperationException`
+* `7010` - `InvalidProgramException`
+* `7011` - `KeyNotFoundException`
+* `7012` - `TaskCanceledException`
+* `7013` - `OperationCanceledException`
+* `7014` - `OutOfMemoryException`
+* `7015` - `NotSupportedException`
+* `7016` - `StackOverflowException`
+* `7017` - `TimeoutException`
+* `7018` - `TypeInitializationException`
+* `7019` - `UnauthorizedAccessException`
+* `7020` - `ApplicationException`
+* `7021` - `KeyNotFoundException`
+* `7022` - `PathTooLongException`
+* `7023` - `DirectoryNotFoundException`
+* `7024` - `IOException`
 
 ## XA8xxx:	Reserved
 

src/Xamarin.Android.Build.Tasks/Tasks/Aapt.cs

@@ -17,8 +17,10 @@
 
 namespace Xamarin.Android.Tasks
 {
-	public class Aapt : AsyncTask
+	public class Aapt : AndroidAsyncTask
 	{
+		public override string TaskPrefix => "APT";
+
 		public ITaskItem[] AdditionalAndroidResourcePaths { get; set; }
 
 		public string AndroidComponentResgenFlagFile { get; set; }
@@ -212,7 +214,7 @@ void ProcessManifest (ITaskItem manifestFile)
 			return;
 		}
 
-		public override bool Execute () 
+		public override bool RunTask () 
 		{
 			resourceDirectory = ResourceDirectory.TrimEnd ('\\');
 			if (!Path.IsPathRooted (resourceDirectory))
@@ -223,7 +225,7 @@ public override bool Execute ()
 
 				task.ContinueWith (Complete);
 
-				base.Execute ();
+				base.RunTask ();
 			} finally {
 				Reacquire ();
 			}
@@ -400,7 +402,7 @@ protected void LogEventsFromTextOutput (string singleLine, MessageImportance mes
 			if (string.IsNullOrEmpty (singleLine)) 
 				return;
 
-			var match = AndroidToolTask.AndroidErrorRegex.Match (singleLine.Trim ());
+			var match = AndroidRunToolTask.AndroidErrorRegex.Match (singleLine.Trim ());
 
 			if (match.Success) {
 				var file = match.Groups["file"].Value;

src/Xamarin.Android.Build.Tasks/Tasks/Aapt2.cs

@@ -18,7 +18,7 @@
 
 namespace Xamarin.Android.Tasks {
 
-	public class Aapt2 : AsyncTask {
+	public abstract class Aapt2 : AndroidAsyncTask {
 
 		protected Dictionary<string, string> resource_name_case_map;
 
@@ -97,7 +97,7 @@ protected bool RunAapt (string commandLine, IList<OutputLine> output)
 
 		bool IsAapt2Warning (string singleLine)
 		{
-			var match = AndroidToolTask.AndroidErrorRegex.Match (singleLine.Trim ());
+			var match = AndroidRunToolTask.AndroidErrorRegex.Match (singleLine.Trim ());
 			if (match.Success) {
 				var file = match.Groups ["file"].Value;
 				var level = match.Groups ["level"].Value.ToLowerInvariant ();
@@ -117,7 +117,7 @@ protected bool LogAapt2EventsFromOutput (string singleLine, MessageImportance me
 			if (string.IsNullOrEmpty (singleLine))
 				return true;
 
-			var match = AndroidToolTask.AndroidErrorRegex.Match (singleLine.Trim ());
+			var match = AndroidRunToolTask.AndroidErrorRegex.Match (singleLine.Trim ());
 
 			if (match.Success) {
 				var file = match.Groups ["file"].Value;

src/Xamarin.Android.Build.Tasks/Tasks/Aapt2Compile.cs

@@ -16,6 +16,7 @@
 namespace Xamarin.Android.Tasks {
 
 	public class Aapt2Compile : Aapt2 {
+		public override string TaskPrefix => "A2C";
 
 		List<ITaskItem> archives = new List<ITaskItem> ();
 
@@ -28,15 +29,15 @@ public class Aapt2Compile : Aapt2 {
 		[Output]
 		public ITaskItem [] CompiledResourceFlatArchives => archives.ToArray ();
 
-		public override bool Execute ()
+		public override bool RunTask ()
 		{
 			Yield ();
 			try {
 				var task = this.RunTask (DoExecute);
 
 				task.ContinueWith (Complete);
 
-				base.Execute ();
+				base.RunTask ();
 			} finally {
 				Reacquire ();
 			}

src/Xamarin.Android.Build.Tasks/Tasks/Aapt2Link.cs

@@ -17,6 +17,8 @@ namespace Xamarin.Android.Tasks {
 
 	//aapt2 link -o resources.apk.bk --manifest Foo.xml --java . --custom-package com.infinitespace_studios.blankforms -R foo2 -v --auto-add-overlay
 	public class Aapt2Link : Aapt2 {
+		public override string TaskPrefix => "A2L";
+
 		[Required]
 		public ITaskItem [] ManifestFiles { get; set; }
 
@@ -75,15 +77,15 @@ public class Aapt2Link : Aapt2 {
 		AssemblyIdentityMap assemblyMap = new AssemblyIdentityMap ();
 		List<string> tempFiles = new List<string> ();
 
-		public override bool Execute ()
+		public override bool RunTask ()
 		{
 			Yield ();
 			try {
 				var task = this.RunTask (DoExecute);
 
 				task.ContinueWith (Complete);
 
-				base.Execute ();
+				base.RunTask ();
 			} finally {
 				Reacquire ();
 			}

src/Xamarin.Android.Build.Tasks/Tasks/AdjustJavacVersionArguments.cs

@@ -7,8 +7,10 @@
 
 namespace Xamarin.Android.Tasks
 {
-	public class AdjustJavacVersionArguments : Task
+	public class AdjustJavacVersionArguments : AndroidTask
 	{
+		public override string TaskPrefix => "AJV";
+
 		[Required]
 		public string JdkVersion { get; set; }
 
@@ -27,7 +29,7 @@ public class AdjustJavacVersionArguments : Task
 		[Output]
 		public string SourceVersion { get; set; }
 
-		public override bool Execute ()
+		public override bool RunTask ()
 		{
 			if (JdkVersion.StartsWith ("9", StringComparison.OrdinalIgnoreCase)) {
 				TargetVersion = SourceVersion = DefaultJdkVersion;

src/Xamarin.Android.Build.Tasks/Tasks/AndroidApkSigner.cs

@@ -8,6 +8,8 @@ namespace Xamarin.Android.Tasks
 {
 	public class AndroidApkSigner : JavaToolTask
 	{
+		public override string TaskPrefix => "AAS";
+
 		[Required]
 		public string ApkSignerJar { get; set; }
 
@@ -49,14 +51,14 @@ public class AndroidApkSigner : JavaToolTask
 
 		public string AdditionalArguments { get; set; }
 
-		public override bool Execute ()
+		public override bool RunTask ()
 		{
 			if (!File.Exists (GenerateFullPathToTool ())) {
 				Log.LogError ($"'{GenerateFullPathToTool ()}' does not exist. You need to install android-sdk build-tools 26.0.1 or above.");
 				return false;
 			}
 
-			return base.Execute ();
+			return base.RunTask ();
 		}
 
 		void AddStorePass (CommandLineBuilder cmd, string cmdLineSwitch, string value)

src/Xamarin.Android.Build.Tasks/Tasks/AndroidCreateDebugKey.cs

@@ -7,6 +7,8 @@ namespace Xamarin.Android.Tasks
 {
 	public class AndroidCreateDebugKey : KeyTool
 	{
+		public override string TaskPrefix => "ACD";
+
 		public int Validity { get; set; }
 
 		public string KeyAlgorithm { get; set; }

src/Xamarin.Android.Build.Tasks/Tasks/AndroidSignPackage.cs

@@ -5,8 +5,10 @@
 
 namespace Xamarin.Android.Tasks
 {
-	public class AndroidSignPackage : AndroidToolTask
+	public class AndroidSignPackage : AndroidRunToolTask
 	{
+		public override string TaskPrefix => "ASP";
+
 		bool hasWarnings;
 
 		[Required]