Merge pull request #1334 from nagilson/nagilson-file-overrides

Version 1.7.3 - Introduce File Locking for Install Script

Author: nagilson

sample/package-lock.json

@@ -1277,7 +1277,7 @@
 
 "vscode-dotnet-runtime@file:../vscode-dotnet-runtime-extension":
   "resolved" "file:../vscode-dotnet-runtime-extension"
-  "version" "1.7.2"
+  "version" "1.7.3"
   dependencies:
     "axios" "^1.3.4"
     "axios-cache-interceptor" "^1.0.1"

sample/yarn.lock

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [1.7.3] - 2023-08-24
+
+Fixes an issue where install script files could have race conditions by introducing file locking mechanisms.
+
 ## [1.7.2] - 2023-08-24
 
 This release completely revamps the web request handling to a new library (axios).

vscode-dotnet-runtime-extension/CHANGELOG.md

@@ -13,7 +13,7 @@
 	"description": "This extension installs and manages different versions of the .NET Runtime.",
 	"appInsightsKey": "02dc18e0-7494-43b2-b2a3-18ada5fcb522",
 	"icon": "images/dotnetIcon.png",
-	"version": "1.7.2",
+	"version": "1.7.3",
 	"publisher": "ms-dotnettools",
 	"engines": {
 		"vscode": "^1.72.0"

vscode-dotnet-runtime-extension/package-lock.json

@@ -98,23 +98,23 @@ export function activate(context: vscode.ExtensionContext, extensionContext?: IE
     if (!fs.existsSync(context.globalStoragePath)) {
         fs.mkdirSync(context.globalStoragePath);
     }
-    const finalTimeoutValue = timeoutValue === undefined ? defaultTimeoutValue : timeoutValue;
+    const resolvedTimeoutSeconds = timeoutValue === undefined ? defaultTimeoutValue : timeoutValue;
 
     const acquisitionWorker = new DotnetCoreAcquisitionWorker({
         storagePath: context.globalStoragePath,
         extensionState: context.globalState,
         eventStream,
-        acquisitionInvoker: new AcquisitionInvoker(context.globalState, eventStream, finalTimeoutValue),
+        acquisitionInvoker: new AcquisitionInvoker(context.globalState, eventStream, resolvedTimeoutSeconds),
         installationValidator: new InstallationValidator(eventStream),
-        timeoutValue: finalTimeoutValue,
+        timeoutValue: resolvedTimeoutSeconds,
         installDirectoryProvider: new RuntimeInstallationDirectoryProvider(context.globalStoragePath),
     });
     const existingPathResolver = new ExistingPathResolver();
-    const versionResolver = new VersionResolver(context.globalState, eventStream, finalTimeoutValue);
+    const versionResolver = new VersionResolver(context.globalState, eventStream, resolvedTimeoutSeconds);
 
     const dotnetAcquireRegistration = vscode.commands.registerCommand(`${commandPrefix}.${commandKeys.acquire}`, async (commandContext: IDotnetAcquireContext) => {
         const dotnetPath = await callWithErrorHandling<Promise<IDotnetAcquireResult>>(async () => {
-            eventStream.post(new DotnetRuntimeAcquisitionStarted());
+            eventStream.post(new DotnetRuntimeAcquisitionStarted(commandContext.requestingExtensionId));
             eventStream.post(new DotnetAcquisitionRequested(commandContext.version, commandContext.requestingExtensionId));
             acquisitionWorker.setAcquisitionContext(commandContext);
 

vscode-dotnet-runtime-extension/package.json

@@ -108,7 +108,7 @@ suite('DotnetCoreAcquisitionExtension End to End', function() {
     const requestedEvent = MockTelemetryReporter.telemetryEvents.find((event: ITelemetryEvent) => event.eventName === 'DotnetAcquisitionRequested');
     assert.exists(requestedEvent);
     assert.include(requestedEvent!.properties!.AcquisitionStartVersion, '2.2');
-    assert.include(requestedEvent!.properties!.RequestingExtensionId, requestingExtensionId);
+    assert.notInclude(requestedEvent!.properties!.RequestingExtensionId, requestingExtensionId); // assert that the extension id is hashed
     const startedEvent = MockTelemetryReporter.telemetryEvents.find((event: ITelemetryEvent) => event.eventName === 'DotnetAcquisitionStarted');
     assert.exists(startedEvent);
     assert.include(startedEvent!.properties!.AcquisitionStartVersion, '2.2');

vscode-dotnet-runtime-extension/src/extension.ts

@@ -2544,6 +2544,7 @@
     "mocha" "^9.1.3"
     "open" "^8.4.0"
     "p-retry" "^4.6.1"
+    "proper-lockfile" "^4.1.2"
     "public-ip" "^5.0.0"
     "rimraf" "3.0.2"
     "shelljs" "0.8.5"

vscode-dotnet-runtime-extension/src/test/functional/DotnetCoreAcquisitionExtension.test.ts

@@ -22,6 +22,7 @@
 	},
 	"devDependencies": {
 		"@types/chai": "4.2.22",
+		"@types/proper-lockfile": "^4.1.2",
 		"glob": "^7.2.0"
 	},
 	"dependencies": {
@@ -47,6 +48,7 @@
 		"mocha": "^9.1.3",
 		"open": "^8.4.0",
 		"p-retry": "^4.6.1",
+		"proper-lockfile": "^4.1.2",
 		"public-ip": "^5.0.0",
 		"rimraf": "3.0.2",
 		"shelljs": "0.8.5",