Merge pull request #610 from fortran-lang/feat/improve-downloads

gnikit · web-flow · commit 501ffe310805 · 2022-08-11T15:13:47.000+01:00
feat: uses a vscode.Task for downloading
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+- Changed packaging download to use `vscode.Tasks`
+  ([#608](https://github.com/fortran-lang/vscode-fortran-support/issues/608))
 - Renamed the default repository branch from `master` to `main`
   ([#590](https://github.com/fortran-lang/vscode-fortran-support/issues/590))
 - Changed the way messages are logged and added `log` syntax highlighting
diff --git a/README.md b/README.md
@@ -6,7 +6,6 @@
 
 [![Downloads](https://vsmarketplacebadge.apphb.com/downloads-short/fortran-lang.linter-gfortran.svg)](https://marketplace.visualstudio.com/items?itemName=fortran-lang.linter-gfortran)
 [![Installs](https://vsmarketplacebadge.apphb.com/installs-short/fortran-lang.linter-gfortran.svg)](https://marketplace.visualstudio.com/items?itemName=fortran-lang.linter-gfortran)
-[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![GitHub Actions](https://github.com/fortran-lang/vscode-fortran-support/actions/workflows/main.yaml/badge.svg)](https://github.com/fortran-lang/vscode-fortran-support/actions)
 [![VS Marketplace](https://vsmarketplacebadge.apphb.com/version-short/fortran-lang.linter-gfortran.svg)](https://marketplace.visualstudio.com/items?itemName=fortran-lang.linter-gfortran)
 [![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://raw.githubusercontent.com/fortran-lang/vscode-fortran-support/master/LICENSE)
diff --git a/src/features/formatting-provider.ts b/src/features/formatting-provider.ts
@@ -46,8 +46,9 @@ export class FortranFormattingProvider implements vscode.DocumentFormattingEditP
   private async doFormatFprettify(document: vscode.TextDocument): Promise<vscode.TextEdit[]> {
     // fprettify can only do FortranFreeFrom
     if (document.languageId !== 'FortranFreeForm') {
-      this.logger.error(`[format] fprettify can only format FortranFreeForm, change
-                            to findent for FortranFixedForm formatting`);
+      this.logger.error(
+        `[format] fprettify can only format FortranFreeForm, change to findent for FortranFixedForm formatting`
+      );
       return undefined;
     }
 
@@ -58,7 +59,7 @@ export class FortranFormattingProvider implements vscode.DocumentFormattingEditP
     if (!which.sync(formatter, { nothrow: true })) {
       this.logger.warn(`[format] ${formatterName} not found. Attempting to install now.`);
       const msg = `Installing ${formatterName} through pip with --user option`;
-      promptForMissingTool(formatterName, msg, 'Python', ['Install'], this.logger);
+      promptForMissingTool(formatterName, msg, 'Python', ['Install']);
     }
 
     const args: string[] = ['--stdout', ...this.getFormatterArgs()];
@@ -83,7 +84,7 @@ export class FortranFormattingProvider implements vscode.DocumentFormattingEditP
     if (!which.sync(formatter, { nothrow: true })) {
       this.logger.warn(`[format] ${formatterName} not found! Attempting to install now.`);
       const msg = `Installing ${formatterName} through pip with --user option`;
-      promptForMissingTool(formatterName, msg, 'Python', ['Install'], this.logger);
+      promptForMissingTool(formatterName, msg, 'Python', ['Install']);
     }
 
     const args: string[] = this.getFormatterArgs();
diff --git a/src/lib/tools.ts b/src/lib/tools.ts
@@ -2,7 +2,6 @@ import * as os from 'os';
 import * as vscode from 'vscode';
 import * as assert from 'assert';
 import * as cp from 'child_process';
-import { Logger } from '../services/logging';
 import { isString, isArrayOfString } from './helper';
 
 export const LS_NAME = 'fortls';
@@ -98,36 +97,31 @@ export function getOuterMostWorkspaceFolder(
  * @param msg message for installing said package
  * @param toolType type of tool, supports `Python` (through pip) and 'VSExt'
  * @param opts options for the prompt. "Install" and "Don't Show Again" are coded
- * @param logger log channel output
  * @param action a void function for an action to perform when "Don't Show Again" is pressed
  */
 export async function promptForMissingTool(
   tool: string,
   msg: string,
   toolType: string,
   opts: string[],
-  logger?: Logger,
   action?: () => void
 ) {
   const items = ['Install'];
-  return vscode.window.showInformationMessage(msg, ...opts).then(selected => {
+  return vscode.window.showInformationMessage(msg, ...opts).then(async selected => {
     if (selected === 'Install') {
-      switch (toolType) {
-        case 'Python':
-          installPythonTool(tool, logger);
-          break;
-
-        case 'VSExt':
-          logger.info(`Installing VS Marketplace Extension with id: ${tool}`);
-          vscode.commands.executeCommand('extension.open', tool);
-          vscode.commands.executeCommand('workbench.extensions.installExtension', tool);
-          logger.info(`Extension ${tool} successfully installed`);
-          break;
-
-        default:
-          logger.error(`Failed to install tool: ${tool}`);
-          vscode.window.showErrorMessage(`Failed to install tool: ${tool}`);
-          break;
+      if (toolType === 'Python') {
+        try {
+          const inst_msg = await pipInstall(tool);
+          vscode.window.showInformationMessage(inst_msg);
+        } catch (error) {
+          vscode.window.showErrorMessage(error);
+        }
+      } else if (toolType === 'VSExt') {
+        // Installing VS Marketplace Extension
+        vscode.commands.executeCommand('extension.open', tool);
+        vscode.commands.executeCommand('workbench.extensions.installExtension', tool);
+      } else {
+        vscode.window.showErrorMessage(`Failed to install tool: ${tool}`);
       }
     } else if (selected === "Don't Show Again") {
       action();
@@ -140,25 +134,35 @@ export async function promptForMissingTool(
  * Does not explicitly check if `pip` is installed.
  *
  * @param pyPackage name of python package in PyPi
- * @param logger `optional` logging channel for output
  */
-export function installPythonTool(pyPackage: string, logger?: Logger) {
-  const installProcess = cp.spawnSync(
-    'pip',
-    'install --user --upgrade '.concat(pyPackage).split(' ')
+export async function pipInstall(pyPackage: string): Promise<string> {
+  const py = 'python3'; // Fetches the top-most python in the Shell
+  const args = ['-m', 'pip', 'install', '--user', '--upgrade', pyPackage];
+  return await shellTask(py, args, `pip: ${pyPackage}`);
+}
+
+export async function shellTask(command: string, args: string[], name: string): Promise<string> {
+  const task = new vscode.Task(
+    { type: 'shell' },
+    vscode.TaskScope.Workspace,
+    name,
+    'Modern Fortran',
+    new vscode.ShellExecution(command, args)
   );
-  if (installProcess.error) {
-    logger.error(
-      `Python package ${pyPackage} failed to install with code: ${installProcess.error}`
-    );
-  }
-  if (installProcess.stdout) {
-    const sep = '-'.repeat(80);
-    logger.info(
-      `pip install --user --upgrade ${pyPackage}:\n${sep}\n${installProcess.stdout}${sep}`
-    );
-    logger.info(`pip install was successful`);
-  }
+  // Temporay fix to https://github.com/microsoft/vscode/issues/157756
+  (<vscode.Task>task).definition = { type: 'shell', command: command };
+  const execution = await vscode.tasks.executeTask(task);
+  return await new Promise<string>((resolve, reject) => {
+    const disposable = vscode.tasks.onDidEndTaskProcess(e => {
+      if (e.execution === execution) {
+        disposable.dispose();
+        if (e.exitCode !== 0) {
+          reject(`ERROR: ${e.execution.task.name} failed with code ${e.exitCode}`);
+        }
+        resolve(`${name}: shell task completed successfully.`);
+      }
+    });
+  });
 }
 
 /**
diff --git a/src/lsp/client.ts b/src/lsp/client.ts
@@ -11,6 +11,7 @@ import {
   LS_NAME,
   isFortran,
   getOuterMostWorkspaceFolder,
+  pipInstall,
 } from '../lib/tools';
 import { Logger } from '../services/logging';
 import { RestartLS } from '../features/commands';
@@ -310,26 +311,26 @@ export class FortlsClient {
     const msg = `It is highly recommended to use the fortls to enable IDE features like hover, peeking, GoTos and many more. 
       For a full list of features the language server adds see: https://github.com/gnikit/fortls`;
     return new Promise<boolean>(resolve => {
-      let fortlsDisabled = false;
       if (results.error) {
         const selection = window.showInformationMessage(msg, 'Install', 'Disable');
-        selection.then(opt => {
+        selection.then(async opt => {
           if (opt === 'Install') {
-            const install = spawnSync('pip', ['install', '--user', '--upgrade', LS_NAME]);
-            if (install.error) {
-              this.logger.error(`[lsp.client] Unable to install fortls:`, install.error);
-              window.showErrorMessage('Had trouble installing fortls, please install manually');
-              fortlsDisabled = true;
-            }
-            if (install.stdout) {
-              this.logger.info(`[lsp.client] ${install.stdout.toString()}`);
-              fortlsDisabled = false;
+            try {
+              this.logger.info(`[lsp.client] Downloading ${LS_NAME}`);
+              const msg = await pipInstall(LS_NAME);
+              window.showInformationMessage(msg);
+              this.logger.info(`[lsp.client] ${LS_NAME} installed`);
+              resolve(false);
+            } catch (error) {
+              this.logger.error(`[lsp.client] Error installing ${LS_NAME}: ${error}`);
+              window.showErrorMessage(error);
+              resolve(true);
             }
           } else if (opt == 'Disable') {
             config.update('fortls.disabled', true);
-            fortlsDisabled = true;
+            this.logger.info(`[lsp.client] ${LS_NAME} disabled in settings`);
+            resolve(true);
           }
-          resolve(fortlsDisabled);
         });
       } else {
         resolve(false);
diff --git a/test/tools.test.ts b/test/tools.test.ts
@@ -0,0 +1,19 @@
+import * as assert from 'assert';
+import { shellTask } from '../src/lib/tools';
+
+suite('Tools tests', () => {
+  test('shellTask returns correct output', async () => {
+    const name = 'pip: fortls';
+    const output = await shellTask(
+      'python3',
+      ['-m', 'pip', 'install', '--upgrade', '--force', 'fortls'],
+      name
+    );
+    assert.strictEqual(output, `${name}: shell task completed successfully.`);
+  });
+
+  test('shellTask returns rejected promise', async () => {
+    const name = 'pip: fortls';
+    assert.rejects(shellTask('python3', ['-m', 'pip', 'install', 'fortls2'], name));
+  });
+});
