Prompt user to install func cli before debugging (#957)

ejizba · web-flow · commit ffd39c338163 · 2019-02-04T15:37:37.000-08:00
And remove prompt after creating project
diff --git a/package.json b/package.json
@@ -765,11 +765,6 @@
                         "description": "%azFunc.pickProcessTimeoutDescription%",
                         "default": 60
                     },
-                    "azureFunctions.showFuncInstallation": {
-                        "type": "boolean",
-                        "description": "%azFunc.showFuncInstallationDescription%",
-                        "default": true
-                    },
                     "azureFunctions.templateVersion": {
                         "type": "string",
                         "description": "%azFunc.templateVersion%"
diff --git a/package.nls.json b/package.nls.json
@@ -41,7 +41,6 @@
     "azFunc.enableRemoteDebugging": "Enable remote debugging, an experimental feature that only supports Java-based Functions Apps.",
     "azFunc.deleteProxy": "Delete Proxy...",
     "azFunc.pickProcessTimeoutDescription": "The timeout (in seconds) to be used when searching for the Azure Functions host process. Since a build is required every time you F5, you may need to adjust this based on how long your build takes.",
-    "azFunc.showFuncInstallationDescription": "Show a warning to install Azure Functions Core Tools CLI when you create a new project if the CLI is not installed.",
     "azFunc.templateVersion": "A runtime release version (any runtime) that species which templates will be used rather than the latest templates.  This version will be used for ALL runtimes. (Requires a restart of VS Code to take effect)",
     "azFunc.projectOpenBehaviorDescription": "The behavior to use after creating a new project. The options are \"AddToWorkspace\", \"OpenInNewWindow\", or \"OpenInCurrentWindow\".",
     "azFunc.uninstallFuncCoreTools": "Uninstall Azure Functions Core Tools",
diff --git a/src/commands/createNewProject/PythonProjectCreator.ts b/src/commands/createNewProject/PythonProjectCreator.ts
@@ -53,7 +53,7 @@ export class PythonProjectCreator extends ScriptProjectCreatorBase {
 
     public async onCreateNewProject(): Promise<void> {
         const funcCoreRequired: string = localize('funcCoreRequired', 'Azure Functions Core Tools must be installed to create, debug, and deploy local Python Functions projects.');
-        if (!await validateFuncCoreToolsInstalled(true /* forcePrompt */, funcCoreRequired)) {
+        if (!await validateFuncCoreToolsInstalled(funcCoreRequired)) {
             throw new UserCancelledError();
         }
 
diff --git a/src/commands/createNewProject/createNewProject.ts b/src/commands/createNewProject/createNewProject.ts
@@ -9,7 +9,6 @@ import { IActionContext } from 'vscode-azureextensionui';
 import { ProjectLanguage, projectLanguageSetting, ProjectRuntime } from '../../constants';
 import { ext } from '../../extensionVariables';
 import { addLocalFuncTelemetry } from '../../funcCoreTools/getLocalFuncCoreToolsVersion';
-import { validateFuncCoreToolsInstalled } from '../../funcCoreTools/validateFuncCoreToolsInstalled';
 import { localize } from '../../localize';
 import { convertStringToRuntime, getGlobalFuncExtensionSetting } from '../../ProjectSettings';
 import { gitUtils } from '../../utils/gitUtils';
@@ -80,10 +79,6 @@ export async function createNewProject(
     // don't wait
     window.showInformationMessage(localize('finishedCreating', 'Finished creating project.'));
 
-    // don't wait
-    // tslint:disable-next-line:no-floating-promises
-    validateFuncCoreToolsInstalled();
-
     if (openFolder) {
         await workspaceUtil.ensureFolderIsOpen(functionAppPath, actionContext);
     }
diff --git a/src/commands/pickFuncProcess.ts b/src/commands/pickFuncProcess.ts
@@ -14,7 +14,7 @@ import { getFuncExtensionSetting } from '../ProjectSettings';
 import { getWindowsProcessTree, IProcessTreeNode, IWindowsProcessTree } from '../utils/windowsProcessTree';
 
 export async function pickFuncProcess(this: IActionContext): Promise<string | undefined> {
-    if (!await validateFuncCoreToolsInstalled(true /* forcePrompt */)) {
+    if (!await validateFuncCoreToolsInstalled()) {
         throw new UserCancelledError();
     }
 
diff --git a/src/debug/FuncDebugProviderBase.ts b/src/debug/FuncDebugProviderBase.ts
@@ -5,6 +5,8 @@
 
 import { CancellationToken, DebugConfiguration, DebugConfigurationProvider, ShellExecution, WorkspaceFolder } from 'vscode';
 import { isFunctionProject } from '../commands/createNewProject/isFunctionProject';
+import { hostStartTaskName } from '../constants';
+import { validateFuncCoreToolsInstalled } from '../funcCoreTools/validateFuncCoreToolsInstalled';
 
 export abstract class FuncDebugProviderBase implements DebugConfigurationProvider {
     protected abstract defaultPort: number;
@@ -25,8 +27,14 @@ export abstract class FuncDebugProviderBase implements DebugConfigurationProvide
         return result;
     }
 
-    public async resolveDebugConfiguration?(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, _token?: CancellationToken): Promise<DebugConfiguration> {
+    public async resolveDebugConfiguration(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, _token?: CancellationToken): Promise<DebugConfiguration | undefined> {
         this._debugPorts.set(folder, <number | undefined>debugConfiguration.port);
+        if (debugConfiguration.preLaunchTask === hostStartTaskName) {
+            if (!await validateFuncCoreToolsInstalled()) {
+                return undefined;
+            }
+        }
+
         return debugConfiguration;
     }
 
diff --git a/src/funcCoreTools/validateFuncCoreToolsInstalled.ts b/src/funcCoreTools/validateFuncCoreToolsInstalled.ts
@@ -10,61 +10,41 @@ import { callWithTelemetryAndErrorHandling, DialogResponses, IActionContext } fr
 import { PackageManager } from '../constants';
 import { ext } from '../extensionVariables';
 import { localize } from '../localize';
-import { getFuncExtensionSetting, updateGlobalSetting } from '../ProjectSettings';
 import { cpUtils } from '../utils/cpUtils';
 import { getFuncPackageManager } from './getFuncPackageManager';
 import { installFuncCoreTools } from './installFuncCoreTools';
 
-export async function validateFuncCoreToolsInstalled(forcePrompt: boolean = false, customMessage?: string): Promise<boolean> {
+export async function validateFuncCoreToolsInstalled(customMessage?: string): Promise<boolean> {
     let input: MessageItem | undefined;
     let installed: boolean = false;
     const install: MessageItem = { title: localize('install', 'Install') };
 
     await callWithTelemetryAndErrorHandling('azureFunctions.validateFuncCoreToolsInstalled', async function (this: IActionContext): Promise<void> {
         this.suppressErrorDisplay = true;
-        this.properties.forcePrompt = String(forcePrompt);
 
-        const settingKey: string = 'showFuncInstallation';
-        if (forcePrompt || getFuncExtensionSetting<boolean>(settingKey)) {
-            if (await funcToolsInstalled()) {
-                installed = true;
+        if (await funcToolsInstalled()) {
+            installed = true;
+        } else {
+            const items: MessageItem[] = [];
+            const message: string = customMessage ? customMessage : localize('installFuncTools', 'You must have the Azure Functions Core Tools installed to debug your local functions.');
+            const packageManager: PackageManager | undefined = await getFuncPackageManager(false /* isFuncInstalled */);
+            if (packageManager !== undefined) {
+                items.push(install);
             } else {
-                const items: MessageItem[] = [];
-                const message: string = customMessage ? customMessage : localize('installFuncTools', 'You must have the Azure Functions Core Tools installed to debug your local functions.');
-                const packageManager: PackageManager | undefined = await getFuncPackageManager(false /* isFuncInstalled */);
-                if (packageManager !== undefined) {
-                    items.push(install);
-                    if (!forcePrompt) {
-                        items.push(DialogResponses.skipForNow);
-                    } else {
-                        items.push(DialogResponses.cancel);
-                    }
-                } else {
-                    items.push(DialogResponses.learnMore);
-                }
-
-                if (!forcePrompt) {
-                    items.push(DialogResponses.dontWarnAgain);
-                }
+                items.push(DialogResponses.learnMore);
+            }
 
-                if (forcePrompt) {
-                    // See issue: https://github.com/Microsoft/vscode-azurefunctions/issues/535
-                    input = await ext.ui.showWarningMessage(message, { modal: true }, ...items);
-                } else {
-                    input = await ext.ui.showWarningMessage(message, ...items);
-                }
+            // See issue: https://github.com/Microsoft/vscode-azurefunctions/issues/535
+            input = await ext.ui.showWarningMessage(message, { modal: true }, ...items);
 
-                this.properties.dialogResult = input.title;
+            this.properties.dialogResult = input.title;
 
-                if (input === install) {
-                    // tslint:disable-next-line:no-non-null-assertion
-                    await installFuncCoreTools(packageManager!);
-                    installed = true;
-                } else if (input === DialogResponses.dontWarnAgain) {
-                    await updateGlobalSetting(settingKey, false);
-                } else if (input === DialogResponses.learnMore) {
-                    await opn('https://aka.ms/Dqur4e');
-                }
+            if (input === install) {
+                // tslint:disable-next-line:no-non-null-assertion
+                await installFuncCoreTools(packageManager!);
+                installed = true;
+            } else if (input === DialogResponses.learnMore) {
+                await opn('https://aka.ms/Dqur4e');
             }
         }
     });

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ export class PythonProjectCreator extends ScriptProjectCreatorBase {`
`53`	`53`
`54`	`54`	`public async onCreateNewProject(): Promise<void> {`
`55`	`55`	`const funcCoreRequired: string = localize('funcCoreRequired', 'Azure Functions Core Tools must be installed to create, debug, and deploy local Python Functions projects.');`
`56`		`- if (!await validateFuncCoreToolsInstalled(true /* forcePrompt */, funcCoreRequired)) {`
	`56`	`+ if (!await validateFuncCoreToolsInstalled(funcCoreRequired)) {`
`57`	`57`	`throw new UserCancelledError();`
`58`	`58`	`}`
`59`	`59`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import { getFuncExtensionSetting } from '../ProjectSettings';`
`14`	`14`	`import { getWindowsProcessTree, IProcessTreeNode, IWindowsProcessTree } from '../utils/windowsProcessTree';`
`15`	`15`
`16`	`16`	`export async function pickFuncProcess(this: IActionContext): Promise<string \| undefined> {`
`17`		`- if (!await validateFuncCoreToolsInstalled(true /* forcePrompt */)) {`
	`17`	`+ if (!await validateFuncCoreToolsInstalled()) {`
`18`	`18`	`throw new UserCancelledError();`
`19`	`19`	`}`
`20`	`20`