Implement cleaner error messages for user-friendly exit codes

Co-authored-by: nagilson <[email protected]>

Author: Copilot

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

@@ -455,9 +455,15 @@ To keep your .NET version up to date, please reconnect to the internet at your s
 
         if (installerResult !== '0')
         {
+            // For user-friendly exit codes, show only the interpreted message without verbose details
+            const interpretedMessage = WinMacGlobalInstaller.InterpretExitCode(installerResult);
+            const errorMessage = WinMacGlobalInstaller.IsUserFriendlyExitCode(installerResult)
+                ? interpretedMessage
+                : `An error was raised by the .NET SDK installer. The exit code it gave us: ${installerResult}.
+${interpretedMessage}`;
+
             const err = new DotnetNonZeroInstallerExitCodeError(new EventBasedError('DotnetNonZeroInstallerExitCodeError',
-                `An error was raised by the .NET SDK installer. The exit code it gave us: ${installerResult}.
-${WinMacGlobalInstaller.InterpretExitCode(installerResult)}`), install);
+                errorMessage), install);
             context.eventStream.post(err);
             throw err;
         }

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

@@ -85,6 +85,16 @@ We cannot verify our .NET file host at this time. Please try again later or inst
         this.registry = registryReader ?? new RegistryReader(context, utilContext);
     }
 
+    /**
+     * Determines if the given exit code has a user-friendly, self-contained error message
+     * that doesn't need additional technical details to be helpful to the user.
+     */
+    public static IsUserFriendlyExitCode(code: string): boolean
+    {
+        const userFriendlyExitCodes = ['5', '112', '255', '1618', '2147942405', UNABLE_TO_ACQUIRE_GLOBAL_LOCK_ERR];
+        return userFriendlyExitCodes.includes(code);
+    }
+
     public static InterpretExitCode(code: string): string
     {
         const reportLogMessage = `Please provide your .NET Installer log (note our privacy notice), which can be found at %temp%.

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

@@ -223,6 +223,49 @@ ${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);
+        }
+    }).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');
+    });
 });