Fix the error output

The true problem was that the error type was bundled inside another error type due to some old architectural decision. CoPilot had put a band aid over this issue and it was only partially fixed. I took the liberty of improving the error messages as well. We shouldnt include a stack in a publicly facing message.

Author: nagilson

vscode-dotnet-runtime-library/src/Acquisition/DotnetCoreAcquisitionWorker.ts

@@ -35,8 +35,7 @@ import
     DotnetWSLSecurityError,
     EventBasedError,
     EventCancellationError,
-    SuppressedAcquisitionError,
-    UtilizingExistingInstallPromise
+    SuppressedAcquisitionError
 } from '../EventStream/EventStreamEvents';
 import * as versionUtils from './VersionUtilities';
 
@@ -399,12 +398,16 @@ To keep your .NET version up to date, please reconnect to the internet at your s
     {
         if (error instanceof EventBasedError || error instanceof EventCancellationError)
         {
-            error.message = `.NET Acquisition Failed: ${error.message}, ${error?.stack}`;
             return error;
         }
         else
         {
-            // Remove this when https://github.com/typescript-eslint/typescript-eslint/issues/2728 is done
+            if (error?.error?.message !== undefined) // DotnetAcquisitionError is a bad but common pattern where the error is included in the thrown object
+            {
+                const convertedError = new EventBasedError(error.constructor.name, error.error.message, error?.stack);
+                return convertedError;
+            }
+
             // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             const newError = new EventBasedError('DotnetAcquisitionError', `.NET Acquisition Failed: ${error?.message ?? JSON.stringify(error)}`);
             return newError;

vscode-dotnet-runtime-library/src/Acquisition/WinMacGlobalInstaller.ts

@@ -91,8 +91,7 @@ We cannot verify our .NET file host at this time. Please try again later or inst
      */
     public static IsUserFriendlyExitCode(code: string): boolean
     {
-        const userFriendlyExitCodes = ['5', '112', '255', '1618', '2147942405', UNABLE_TO_ACQUIRE_GLOBAL_LOCK_ERR];
-        return userFriendlyExitCodes.includes(code);
+        return this.InterpretExitCode(code) !== '';
     }
 
     public static InterpretExitCode(code: string): string
@@ -108,23 +107,23 @@ This report should be made at https://github.com/dotnet/vscode-dotnet-runtime/is
             case '5':
                 return `Insufficient permissions are available to install .NET. Please run the installer as an administrator.`;
             case '67':
-                return `The network name cannot be found. ${reportLogMessage}`;
+                return `The network name cannot be found to install .NET. ${reportLogMessage}`;
             case '112':
                 return `The disk is full. Please free up space and try again.`;
             case '255':
                 return `The .NET Installer was terminated by another process unexpectedly. Please try again.`;
             case '1260':
-                return `The .NET SDK is blocked by group policy. Can you please report this at https://github.com/dotnet/vscode-dotnet-runtime/issues`
+                return `The .NET SDK Install is blocked by group policy. Please contact your IT Admin to install .NET.`
             case '1460':
                 return `The .NET SDK had a timeout error. ${reportLogMessage}`;
             case '1603':
                 return `Fatal error during .NET SDK installation. ${reportLogMessage}`;
             case '1618':
-                return `Another installation is already in progress. Complete that installation before proceeding with this install.`;
+                return `Another installation of .NET is already in progress. Complete that installation before proceeding with this install.`;
             case '000751':
-                return `Page fault was satisfied by reading from a secondary storage device. ${reportLogMessage}`;
+                return `.NET Installer Failed: A page fault was satisfied by reading from a secondary storage device. ${reportLogMessage}`;
             case '2147500037':
-                return `An unspecified error occurred. ${reportLogMessage}`;
+                return `.NET Installer Failed: An unspecified error occurred. ${reportLogMessage}`;
             case '2147942405':
                 return `Insufficient permissions are available to install .NET. Please try again as an administrator.`;
             case UNABLE_TO_ACQUIRE_GLOBAL_LOCK_ERR:

vscode-dotnet-runtime-library/src/EventStream/OutputChannelObserver.ts

@@ -14,16 +14,14 @@ import
     DotnetDebuggingMessage,
     DotnetExistingPathResolutionCompleted,
     DotnetInstallExpectedAbort,
-    DotnetNonZeroInstallerExitCodeError,
     DotnetOfflineInstallUsed,
     DotnetOfflineWarning,
     DotnetUpgradedEvent,
-    DotnetVisibleWarningEvent,
+    DotnetVisibleWarningEvent
 } from './EventStreamEvents';
 import { EventType } from './EventType';
 import { IEvent } from './IEvent';
 import { IEventStreamObserver } from './IEventStreamObserver';
-import { WinMacGlobalInstaller } from '../Acquisition/WinMacGlobalInstaller';
 
 export class OutputChannelObserver implements IEventStreamObserver
 {
@@ -117,37 +115,7 @@ export class OutputChannelObserver implements IEventStreamObserver
                 if (this.inProgressDownloads.includes(error?.install?.installId ?? ''))
                 {
                     this.outputChannel.appendLine(`Failed to download .NET ${error?.install?.installId}:`);
-                    
-                    // For user-friendly installer exit codes, show only the clean interpreted message
-                    if (error instanceof DotnetNonZeroInstallerExitCodeError)
-                    {
-                        const errorMessage = error?.error?.message || '';
-                        const exitCodeMatch = errorMessage.match(/The exit code it gave us: (\w+)\./);
-                        if (exitCodeMatch && WinMacGlobalInstaller.IsUserFriendlyExitCode(exitCodeMatch[1]))
-                        {
-                            // Extract just the interpreted message (everything after the exit code line)
-                            const lines = errorMessage.split('\n');
-                            if (lines.length > 1)
-                            {
-                                this.outputChannel.appendLine(lines.slice(1).join('\n'));
-                            }
-                            else
-                            {
-                                this.outputChannel.appendLine(errorMessage);
-                            }
-                        }
-                        else
-                        {
-                            // Show full error message for non-user-friendly codes
-                            this.outputChannel.appendLine(error?.error?.message);
-                        }
-                    }
-                    else
-                    {
-                        // Show full error message for non-installer errors
-                        this.outputChannel.appendLine(error?.error?.message);
-                    }
-                    
+                    this.outputChannel.appendLine(error?.error?.message);
                     this.outputChannel.appendLine('');
 
                     this.updateDownloadIndicators(error.install?.installId);

vscode-dotnet-runtime-library/src/test/unit/WinMacGlobalInstaller.test.ts

@@ -223,49 +223,25 @@ ${fs.readdirSync(installerDownloadFolder).join(', ')}`);
                 shouldNotExistOptionPath = await installer.getExpectedGlobalSDKPath(sdkVersionThatShouldNotExist, os.arch());
                 assert.equal(shouldNotExistOptionPath, standardHostPath, 'It wont use the emu path if it does not exist');
             }
-        }
-    }).timeout(standardTimeoutTime);
-
-    test('InterpretExitCode returns user-friendly messages for common exit codes', () =>
-    {
-        // Test exit code 5 - insufficient permissions
-        const exitCode5Message = WinMacGlobalInstaller.InterpretExitCode('5');
-        assert.equal(exitCode5Message, 'Insufficient permissions are available to install .NET. Please run the installer as an administrator.');
-        assert.isFalse(exitCode5Message.includes('report'), 'Exit code 5 should not ask for bug reports');
-        assert.isTrue(WinMacGlobalInstaller.IsUserFriendlyExitCode('5'), 'Exit code 5 should be marked as user-friendly');
-
-        // Test exit code 1618 - another installation in progress
-        const exitCode1618Message = WinMacGlobalInstaller.InterpretExitCode('1618');
-        assert.equal(exitCode1618Message, 'Another installation is already in progress. Complete that installation before proceeding with this install.');
-        assert.isFalse(exitCode1618Message.includes('report'), 'Exit code 1618 should not ask for bug reports');
-        assert.isTrue(WinMacGlobalInstaller.IsUserFriendlyExitCode('1618'), 'Exit code 1618 should be marked as user-friendly');
-
-        // Test exit code 112 - disk full
-        const exitCode112Message = WinMacGlobalInstaller.InterpretExitCode('112');
-        assert.equal(exitCode112Message, 'The disk is full. Please free up space and try again.');
-        assert.isFalse(exitCode112Message.includes('report'), 'Exit code 112 should not ask for bug reports');
-        assert.isTrue(WinMacGlobalInstaller.IsUserFriendlyExitCode('112'), 'Exit code 112 should be marked as user-friendly');
-
-        // Test exit code 255 - terminated by another process
-        const exitCode255Message = WinMacGlobalInstaller.InterpretExitCode('255');
-        assert.equal(exitCode255Message, 'The .NET Installer was terminated by another process unexpectedly. Please try again.');
-        assert.isFalse(exitCode255Message.includes('report'), 'Exit code 255 should not ask for bug reports');
-        assert.isTrue(WinMacGlobalInstaller.IsUserFriendlyExitCode('255'), 'Exit code 255 should be marked as user-friendly');
-
-        // Test exit code 2147942405 - insufficient permissions (alternative code)
-        const exitCode2147942405Message = WinMacGlobalInstaller.InterpretExitCode('2147942405');
-        assert.equal(exitCode2147942405Message, 'Insufficient permissions are available to install .NET. Please try again as an administrator.');
-        assert.isFalse(exitCode2147942405Message.includes('report'), 'Exit code 2147942405 should not ask for bug reports');
-        assert.isTrue(WinMacGlobalInstaller.IsUserFriendlyExitCode('2147942405'), 'Exit code 2147942405 should be marked as user-friendly');
-
-        // Test exit code 1 - generic failure (should include report message)
-        const exitCode1Message = WinMacGlobalInstaller.InterpretExitCode('1');
-        assert.isTrue(exitCode1Message.includes('report'), 'Exit code 1 should ask for bug reports');
-        assert.isFalse(WinMacGlobalInstaller.IsUserFriendlyExitCode('1'), 'Exit code 1 should not be marked as user-friendly');
-
-        // Test unknown exit code
-        const unknownCodeMessage = WinMacGlobalInstaller.InterpretExitCode('9999');
-        assert.equal(unknownCodeMessage, '', 'Unknown exit codes should return empty string');
-        assert.isFalse(WinMacGlobalInstaller.IsUserFriendlyExitCode('9999'), 'Unknown exit codes should not be marked as user-friendly');
-    });
+        }
+    }).timeout(standardTimeoutTime);
+
+    test('InterpretExitCode returns user-friendly messages for common exit codes', () =>
+    {
+        // Test exit code 5 - insufficient permissions
+        const exitCode5Message = WinMacGlobalInstaller.InterpretExitCode('5');
+        assert.equal(exitCode5Message, 'Insufficient permissions are available to install .NET. Please run the installer as an administrator.');
+        assert.isFalse(exitCode5Message.includes('report'), 'Exit code 5 should not ask for bug reports');
+        assert.isTrue(WinMacGlobalInstaller.IsUserFriendlyExitCode('5'), 'Exit code 5 should be marked as user-friendly');
+
+        // Test exit code 1 - generic failure (should include report message)
+        const exitCode1Message = WinMacGlobalInstaller.InterpretExitCode('1');
+        assert.isTrue(exitCode1Message.includes('report'), 'Exit code 1 should ask for bug reports');
+        assert.isFalse(WinMacGlobalInstaller.IsUserFriendlyExitCode('1'), 'Exit code 1 should not be marked as user-friendly');
+
+        // Test unknown exit code
+        const unknownCodeMessage = WinMacGlobalInstaller.InterpretExitCode('9999');
+        assert.equal(unknownCodeMessage, '', 'Unknown exit codes should return empty string');
+        assert.isFalse(WinMacGlobalInstaller.IsUserFriendlyExitCode('9999'), 'Unknown exit codes should not be marked as user-friendly');
+    });
 });