Merge pull request #1373 from nagilson/nagilson-proxy-ps-chmod-fix

1.7.3 Fixes - Proxy support + Powershell Attempts

Author: nagilson

Documentation/troubleshooting-sdk.md

@@ -30,6 +30,19 @@ Learn more about configuring Visual Studio Code settings [here](https://code.vis
 }
 ```
 
+## The extension thinks you are offline with error response of 400 or 407, and you have a proxy.
+
+This is a known issue with axios, the system we use to make web-requests.
+The requests we make need to be routed through the proxy. We have logic to try to detect your proxy automatically.
+If your proxy does not get detected by us, please try adding it here.
+
+Note: GFW / China also blocks some of our requests, which may be why our extension thinks you are offline or times out.
+
+```json
+{
+    "dotnetSDKAcquisitionExtension.proxyUrl": "https://your_proxy_url:port"
+}
+
 ## Other Issues
 
 Haven't found a solution? Check out our [open issues](https://github.com/dotnet/vscode-dotnet-runtime/issues). If you don't see your issue there, please file a new issue by evoking the `.NET SDK Install Tool: Report an issue with the .NET SDK Install Tool` command from Visual Studio Code.

vscode-dotnet-runtime-extension/CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning].
 ## [1.7.3] - 2023-08-24
 
 Fixes an issue where install script files could have race conditions by introducing file locking mechanisms.
+Adds proxy detection & support that forwards calls through a proxy to axios. This is to fix a bug in axios where it does not handle proxies correctly.
+Attempts to discover powershell in more ways in case it's been removed from the PATH, or try using powershell core if only that is available.
+Improves file permissions handling to prevent issues on mac and linux where install script files may not have the correct permissions to execute.
+Remarks in error messages how users in China may experience timeouts or offline errors due to GFW blocking our download pages.
 
 ## [1.7.2] - 2023-08-24
 

vscode-dotnet-runtime-extension/README.md

@@ -50,6 +50,22 @@ It can sometimes take a while to download the .NET Runtime. While the default do
 
 You can read more about [changing the installation timeout] in our documentation.
 
+## The extension thinks you are offline with error response of 400 or 407, and you have a proxy.
+
+This is a known issue with axios, the system we use to make web-requests.
+The requests we make need to be routed through the proxy. We have logic to try to detect your proxy automatically.
+If your proxy does not get detected by us, please try adding it here.
+You may want to consider temporarily switching to version 1.7.2 of the runtime extension if you are still experiencing issues as this version does not use axios. Note that proxies that require additional credentials are not yet supported.
+
+Note: GFW / China also blocks some of our requests, which may be why our extension thinks you are offline or times out.
+
+You can add the proxy in the extension settings like following the advice above for timeouts.
+```json
+{
+    "dotnetSDKAcquisitionExtension.proxyUrl": "https://your_proxy_url:port"
+}
+```
+
 ## Information for repo contributors
 
 ### Goals: Acquiring .NET Runtimes for extensions

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

@@ -67,6 +67,10 @@
 				"dotnetAcquisitionExtension.existingDotnetPath": {
 					"type": "array",
 					"description": "File Path to an existing installation of .NET."
+				},
+				"dotnetAcquisitionExtension.proxyUrl": {
+					"type": "string",
+					"description": "URL to a proxy if you use one, such as: https://proxy:port"
 				}
 			}
 		}
@@ -91,6 +95,7 @@
 		"glob": "^7.2.0",
 		"got": "11.8.5",
 		"hmac-drbg": "^1.0.1",
+		"https-proxy-agent": "^7.0.2",
 		"is-online": "^9.0.1",
 		"mocha": "^9.1.3",
 		"open": "^8.4.0",

vscode-dotnet-runtime-extension/package.json

@@ -47,6 +47,7 @@ namespace configKeys {
     export const installTimeoutValue = 'installTimeoutValue';
     export const enableTelemetry = 'enableTelemetry';
     export const existingPath = 'existingDotnetPath';
+    export const proxyUrl = 'proxyUrl';
 }
 namespace commandKeys {
     export const acquire = 'acquire';
@@ -100,6 +101,8 @@ export function activate(context: vscode.ExtensionContext, extensionContext?: IE
     }
     const resolvedTimeoutSeconds = timeoutValue === undefined ? defaultTimeoutValue : timeoutValue;
 
+    const proxyUrl = extensionConfiguration.get<string>(configKeys.proxyUrl);
+
     const acquisitionWorker = new DotnetCoreAcquisitionWorker({
         storagePath: context.globalStoragePath,
         extensionState: context.globalState,
@@ -110,7 +113,7 @@ export function activate(context: vscode.ExtensionContext, extensionContext?: IE
         installDirectoryProvider: new RuntimeInstallationDirectoryProvider(context.globalStoragePath),
     });
     const existingPathResolver = new ExistingPathResolver();
-    const versionResolver = new VersionResolver(context.globalState, eventStream, resolvedTimeoutSeconds);
+    const versionResolver = new VersionResolver(context.globalState, eventStream, resolvedTimeoutSeconds, proxyUrl);
 
     const dotnetAcquireRegistration = vscode.commands.registerCommand(`${commandPrefix}.${commandKeys.acquire}`, async (commandContext: IDotnetAcquireContext) => {
         const dotnetPath = await callWithErrorHandling<Promise<IDotnetAcquireResult>>(async () => {

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

@@ -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.notInclude(requestedEvent!.properties!.RequestingExtensionId, requestingExtensionId); // assert that the extension id is hashed
+    assert.notInclude(requestedEvent!.properties!.RequestingExtensionId, requestingExtensionId); // assert that the extension id is hashed by checking that it DNE
     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/test/functional/DotnetCoreAcquisitionExtension.test.ts

@@ -401,6 +401,13 @@
   "resolved" "https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-npm/npm/registry/acorn/-/acorn-8.10.0.tgz"
   "version" "8.10.0"
 
+"agent-base@^7.0.2":
+  "integrity" "sha1-U2gCt2vAs0qlAZXrJEInbWE+NDQ="
+  "resolved" "https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-npm/npm/registry/agent-base/-/agent-base-7.1.0.tgz"
+  "version" "7.1.0"
+  dependencies:
+    "debug" "^4.3.4"
+
 "agent-base@6":
   "integrity" "sha1-Sf/1hXfP7j83F2/qtMIuAPhtf3c="
   "resolved" "https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-npm/npm/registry/agent-base/-/agent-base-6.0.2.tgz"
@@ -849,6 +856,13 @@
     "shebang-command" "^2.0.0"
     "which" "^2.0.1"
 
+"debug@^4.3.4":
+  "integrity" "sha1-Exn2V5NX8jONMzfSzdSRS7XcyGU="
+  "resolved" "https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-npm/npm/registry/debug/-/debug-4.3.4.tgz"
+  "version" "4.3.4"
+  dependencies:
+    "ms" "2.1.2"
+
 "debug@4", "[email protected]":
   "integrity" "sha1-BCZuC3CpjURi5uKI44JZITMytmQ="
   "resolved" "https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-npm/npm/registry/debug/-/debug-4.3.3.tgz"
@@ -1410,6 +1424,14 @@
     "agent-base" "6"
     "debug" "4"
 
+"https-proxy-agent@^7.0.2":
+  "integrity" "sha1-4mRbhGuQ6WxubzR/tbLkHxWQsJs="
+  "resolved" "https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-npm/npm/registry/https-proxy-agent/-/https-proxy-agent-7.0.2.tgz"
+  "version" "7.0.2"
+  dependencies:
+    "agent-base" "^7.0.2"
+    "debug" "4"
+
 "human-signals@^2.1.0":
   "integrity" "sha1-3JH8ukLk0G5Kuu0zs+ejwC9RTqA="
   "resolved" "https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-npm/npm/registry/human-signals/-/human-signals-2.1.0.tgz"
@@ -2538,8 +2560,10 @@
     "diff" ">=5.0.0"
     "eol" "^0.9.1"
     "es-abstract" "^1.19.1"
+    "get-proxy-settings" "^0.1.13"
     "got" "11.8.5"
     "http-cache-semantics" "4.1.1"
+    "https-proxy-agent" "^7.0.2"
     "is-online" "9.0.1"
     "mocha" "^9.1.3"
     "open" "^8.4.0"