Update Linux Apt Commands to Handle Lock Timeouts

vscode-dotnet-runtime-library/distro-data/distro-support.json

@@ -6,13 +6,20 @@
                 "runUnderSudo": true,
                 "commandRoot": "apt-get",
                 "commandParts": [
+                    "-o",
+                    "DPkg::Lock::Timeout=120",
+                    "update",
+                    "||",
+                    "apt-get",
                     "update"
                 ]
             },
             {
                 "runUnderSudo": true,
                 "commandRoot": "apt-get",
                 "commandParts": [
+                    "-o",
+                    "DPkg::Lock::Timeout=120",
                     "install",
                     "-y",
                     "{packageName}"
@@ -24,6 +31,8 @@
                 "runUnderSudo": true,
                 "commandRoot": "apt-get",
                 "commandParts": [
+                    "-o",
+                    "DPkg::Lock::Timeout=120",
                     "remove",
                     "{packageName}"
                 ]
@@ -34,13 +43,17 @@
                 "runUnderSudo": true,
                 "commandRoot": "apt-get",
                 "commandParts": [
+                    "-o",
+                    "DPkg::Lock::Timeout=120",
                     "update"
                 ]
             },
             {
                 "runUnderSudo": true,
                 "commandRoot": "apt-get",
                 "commandParts": [
+                    "-o",
+                    "DPkg::Lock::Timeout=120",
                     "upgrade",
                     "-y",
                     "{packageName}"
@@ -52,6 +65,8 @@
                 "runUnderSudo": false,
                 "commandRoot": "apt-cache",
                 "commandParts": [
+                    "-o",
+                    "DPkg::Lock::Timeout=120",
                     "search",
                     "--names-only",
                     "^{packageName}$"
@@ -185,6 +200,8 @@
                         "runUnderSudo": true,
                         "commandRoot": "apt-get",
                         "commandParts": [
+                            "-o",
+                            "DPkg::Lock::Timeout=120",
                             "install",
                             "-y",
                             "wget"
@@ -211,6 +228,8 @@
                         "runUnderSudo": true,
                         "commandRoot": "apt-get",
                         "commandParts": [
+                            "-o",
+                            "DPkg::Lock::Timeout=120",
                             "update"
                         ]
                     }
@@ -223,6 +242,8 @@
                         "runUnderSudo": true,
                         "commandRoot": "apt-get",
                         "commandParts": [
+                            "-o",
+                            "DPkg::Lock::Timeout=120",
                             "update"
                         ]
                     },

vscode-dotnet-runtime-library/install scripts/interprocess-communicator.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 EXECFOLDER=$1 # First argument is the working folder as this is launched with cwd of /root
+TIMEOUT_SEC=$2
 OKSIGNALFILE="$EXECFOLDER/ok.txt"
 COMMANDTORUNFILE="$EXECFOLDER/command.txt"
 #OUTPUTFILE="/home/test_output_.txt"
@@ -19,7 +20,7 @@ do
             if test -f "$COMMANDTORUNFILE"; then
                 # echo "COMMAND FILE FOUND" >> "$OUTPUTFILE" # Leave this here as an example of debugging
                 COMMAND="$(cat "$COMMANDTORUNFILE" | awk '{$1=$1;print}')"
-                for validCmd in "${@:2}"
+                for validCmd in "${@:3}"
                 do
                     if [ "$COMMAND" == "$validCmd" ]; then
                         # Eventually we should split the cmd file to be line by line instead of space separated,
@@ -31,7 +32,7 @@ do
                     rm "$COMMANDTORUNFILE"
                     exit 111777 # Special exit code - arbitrarily picked for when the command is not expected
                 fi
-                sudo "${COMMANDARGS[@]}" 2> "$EXECFOLDER/stderr.txt" 1> "$EXECFOLDER/stdout.txt"
+                timeout $TIMEOUT_SEC sudo "${COMMANDARGS[@]}" 2> "$EXECFOLDER/stderr.txt" 1> "$EXECFOLDER/stdout.txt"
                 STATUSCODE=$?
                 echo $STATUSCODE > "$EXECFOLDER/status.txt"
                 rm "$COMMANDTORUNFILE"

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

@@ -65,8 +65,7 @@ export class GenericDistroSDKProvider extends IDistroDotnetSDKProvider
         command = CommandExecutor.replaceSubstringsInCommands(command, this.missingPackageNameKey, sdkPackage);
         const commandResult = (await this.commandRunner.executeMultipleCommands(command))[0];
 
-        const noPackageResult = 'no packages found';
-        return commandResult.stdout.toLowerCase().includes(noPackageResult);
+        return commandResult.status === '0';
     }
 
     public getExpectedDotnetDistroFeedInstallationDirectory(): string

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

@@ -83,7 +83,8 @@ export abstract class IDistroDotnetSDKProvider {
         {
             const error = new DotnetAcquisitionDistroUnknownError(new EventBasedError('DotnetAcquisitionDistroUnknownError',
             `Automated installation for the distro ${this.distroVersion.distro} is not yet supported.
-Please install the .NET SDK manually: https://dotnet.microsoft.com/download`),
+Please install the .NET SDK manually: https://dotnet.microsoft.com/download.
+If you would like to contribute to the list of supported distros, please visit: https://github.com/dotnet/vscode-dotnet-runtime/blob/main/Documentation/adding-distros.md`),
                 getInstallFromContext(this.context));
             throw error.error;
         }

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

@@ -12,6 +12,7 @@ import {
     DotnetAcquisitionStatusResolved,
     DotnetLockAttemptingAcquireEvent,
     DotnetLockErrorEvent,
+    DotnetLockReleasedEvent,
     DotnetPreinstallDetected,
     DotnetPreinstallDetectionError,
     DuplicateInstallDetected,
@@ -77,26 +78,33 @@ export class InstallTrackerSingleton
 
     protected executeWithLock = async <A extends any[], R>(alreadyHoldingLock : boolean, f: (...args: A) => R, ...args: A): Promise<R> =>
     {
-
         const trackingLock = 'tracking.lock';
         const lockPath = path.join(__dirname, trackingLock);
         fs.writeFileSync(lockPath, '', 'utf-8');
 
+        let returnResult : any;
+
         this.eventStream?.post(new DotnetLockAttemptingAcquireEvent(`Lock Acquisition request to begin.`, new Date().toISOString(), lockPath, lockPath));
         try
         {
             if(alreadyHoldingLock)
             {
                 return await f(...(args));
             }
-            const release = await lockfile.lock(lockPath, { retries: { retries: 10, minTimeout: 5, maxTimeout: 2000 } });
-            try
-            {
-                return await f(...(args));
-            }
-            finally
+            else
             {
-                await release();
+                await lockfile.lock(lockPath, { retries: { retries: 10, minTimeout: 5, maxTimeout: 10000 } })
+                .then(async (release) =>
+                {
+                    returnResult = await f(...(args));
+                    this.eventStream?.post(new DotnetLockReleasedEvent(`Lock about to be released.`, new Date().toISOString(), lockPath, lockPath));
+                    return release();
+                })
+                .catch((e : Error) =>
+                {
+                    // Either the lock could not be acquired or releasing it failed
+                    this.eventStream?.post(new DotnetLockErrorEvent(e, e.message, new Date().toISOString(), lockPath, lockPath));
+                });
             }
         }
         catch(e : any)
@@ -105,6 +113,8 @@ export class InstallTrackerSingleton
             this.eventStream.post(new DotnetLockErrorEvent(e, e?.message ?? 'Unable to acquire lock to update installation state', new Date().toISOString(), lockPath, lockPath));
             throw new EventBasedError('DotnetLockErrorEvent', e?.message, e?.stack);
         }
+
+        return returnResult;
     }
 
     public async clearPromises() : Promise<void>

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

@@ -964,7 +964,7 @@ export abstract class DotnetLockEvent extends DotnetFileEvent
     constructor(public readonly eventMessage: string, public readonly time: string, public readonly lock: string, public readonly file: string) { super(eventMessage, time, file); }
 
     public getProperties() {
-        return {Message: this.eventMessage, Time: this.time, Lock: TelemetryUtilities.HashData(this.lock), File: TelemetryUtilities.HashData(this.file)};
+        return {Message: this.eventMessage, Time: this.time, Lock: this.lock, File: this.file};
     }
 }
 
@@ -982,7 +982,7 @@ export class DotnetLockErrorEvent extends DotnetLockEvent {
         public readonly eventMessage: string, public readonly time: string, public readonly lock: string, public readonly file: string) { super(eventMessage, time, lock, file); }
 
     public getProperties() {
-        return {Error: this.error.toString(), Message: this.eventMessage, Time: this.time, Lock: TelemetryUtilities.HashData(this.lock), File: TelemetryUtilities.HashData(this.file)};
+        return {Error: this.error.toString(), Message: this.eventMessage, Time: this.time, Lock: this.lock, File: this.file};
     }
 
 }

vscode-dotnet-runtime-library/src/Utils/CommandExecutor.ts

@@ -130,7 +130,8 @@ Please install the .NET SDK manually by following https://learn.microsoft.com/en
         const options = { name: `${sanitizedCallerName ?? 'NET Install Tool'}` };
 
         fs.chmodSync(shellScriptPath, 0o500);
-        exec((`"${shellScriptPath}" "${this.sudoProcessCommunicationDir}" ${this.validSudoCommands?.join(' ')} &`), options, (error?: any, stdout?: any, stderr?: any) =>
+        const timeoutSeconds = Math.max(100, this.context.timeoutSeconds);
+        exec((`"${shellScriptPath}" "${this.sudoProcessCommunicationDir}" "${timeoutSeconds}" ${this.validSudoCommands?.join(' ')} &`), options, (error?: any, stdout?: any, stderr?: any) =>
         {
                 this.context?.eventStream.post(new CommandExecutionStdOut(`The process spawn: ${fullCommandString} encountered stdout, continuing
 ${stdout}`));
@@ -198,7 +199,7 @@ Please report this at https://github.com/dotnet/vscode-dotnet-runtime/issues.`),
 
         // Lock the directory -- this is not a system wide lock, only a library lock we must respect in the code.
         // This will allow the process to still edit the directory, but not our extension API calls from overlapping with one another.
-        await lockfile.lock(fakeLockFile, { lockfilePath: directoryLockPath, retries: { retries: 10, minTimeout: 5, maxTimeout: 2000 } } )
+        await lockfile.lock(fakeLockFile, { lockfilePath: directoryLockPath, retries: { retries: 10, minTimeout: 5, maxTimeout: 10000 } } )
         .then(async (release: () => void) =>
         {
             this.context?.eventStream.post(new DotnetLockAcquiredEvent(`Lock Acquired.`, new Date().toISOString(), directoryLockPath, fakeLockFile));
@@ -269,7 +270,7 @@ It had previously spawned: ${this.hasEverLaunchedSudoFork}.`), getInstallFromCon
         // This will allow the process to still edit the directory, but not our extension API calls from overlapping with one another.
 
 
-        await lockfile.lock(fakeLockFile, { lockfilePath: directoryLockPath, retries: { retries: 10, minTimeout : 5, maxTimeout: 2000 } } )
+        await lockfile.lock(fakeLockFile, { lockfilePath: directoryLockPath, retries: { retries: 10, minTimeout : 5, maxTimeout: 10000 } } )
         .then(async (release: () => any) =>
         {
             this.context?.eventStream.post(new DotnetLockAcquiredEvent(`Lock Acquired.`, new Date().toISOString(), directoryLockPath, fakeLockFile));
@@ -331,8 +332,9 @@ ${(commandOutputJson as CommandExecutorResult).stderr}`));
             if((commandOutputJson as CommandExecutorResult).status !== '0' && failOnNonZeroExit)
             {
                 const err = new CommandExecutionNonZeroExitFailure(new EventBasedError('CommandExecutionNonZeroExitFailure',
-                    `Cancelling .NET Install, as command ${commandToExecuteString} returned with status ${(commandOutputJson as CommandExecutorResult).status}.`),
-                    getInstallFromContext(this.context));
+                    `Cancelling .NET Install, as command ${commandToExecuteString} returned with status ${(commandOutputJson as CommandExecutorResult).status}.
+${(commandOutputJson as CommandExecutorResult).stderr}.`),
+                     getInstallFromContext(this.context));
                 this.context?.eventStream.post(err);
                 throw err.error;
             }

vscode-dotnet-runtime-library/src/Utils/FileUtilities.ts

@@ -50,7 +50,7 @@ export class FileUtilities extends IFileUtilities
        if(!alreadyHoldingLock)
        {
            eventStream?.post(new DotnetLockAttemptingAcquireEvent(`Lock Acquisition request to begin.`, new Date().toISOString(), directoryLockPath, filePath));
-           await lockfile.lock(filePath, { lockfilePath: directoryLockPath, retries: { retries: 10, minTimeout: 5, maxTimeout: 2000 } } )
+           await lockfile.lock(filePath, { lockfilePath: directoryLockPath, retries: { retries: 10, minTimeout: 5, maxTimeout: 10000 } } )
            .then(async (release) =>
            {
                eventStream?.post(new DotnetLockAcquiredEvent(`Lock Acquired.`, new Date().toISOString(), directoryLockPath, filePath));

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

@@ -36,7 +36,8 @@ suite('Linux Distro Logic Unit Tests', () =>
         if(shouldRun)
         {
             const recVersion = await provider.getRecommendedDotnetVersion(installType);
-            assert.equal(mockExecutor.attemptedCommand, 'apt-cache search --names-only ^dotnet-sdk-9.0$', 'Searched for the newest package last with regex'); // this may fail if test not exec'd first
+            assert.equal(mockExecutor.attemptedCommand,
+'apt-cache -o DPkg::Lock::Timeout=120 search --names-only ^dotnet-sdk-9.0$', 'Searched for the newest package last with regex'); // this may fail if test not exec'd first
             // the data is cached so --version may not be executed.
             assert.equal(recVersion, '8.0.1xx', 'Resolved the most recent available version : will eventually break if the mock data is not updated');
         }
@@ -151,23 +152,23 @@ Microsoft.NETCore.App 7.0.5 [/usr/lib/dotnet/shared/Microsoft.NETCore.App]`, std
         if(shouldRun)
         {
             await provider.installDotnet(mockVersion, installType);
-            assert.equal(mockExecutor.attemptedCommand, 'sudo apt-get install -y dotnet-sdk-7.0');
+            assert.equal(mockExecutor.attemptedCommand, 'sudo apt-get -o DPkg::Lock::Timeout=120 install -y dotnet-sdk-7.0');
         }
     }).timeout(standardTimeoutTime);
 
     test('Runs Correct Uninstall Command', async () => {
         if(shouldRun)
         {
             await provider.uninstallDotnet(mockVersion, installType);
-            assert.equal(mockExecutor.attemptedCommand, 'sudo apt-get remove dotnet-sdk-7.0');
+            assert.equal(mockExecutor.attemptedCommand, 'sudo apt-get -o DPkg::Lock::Timeout=120 remove dotnet-sdk-7.0');
         }
     }).timeout(standardTimeoutTime);
 
     test('Runs Correct Update Command', async () => {
         if(shouldRun)
         {
             await provider.upgradeDotnet(mockVersion, installType);
-            assert.equal(mockExecutor.attemptedCommand, 'sudo apt-get upgrade -y dotnet-sdk-7.0');
+            assert.equal(mockExecutor.attemptedCommand, 'sudo apt-get -o DPkg::Lock::Timeout=120 upgrade -y dotnet-sdk-7.0');
         }
     }).timeout(standardTimeoutTime*1000);
 });