Use globby instead of vscode.workspace.findFiles (#2938)

Author: ejizba

package-lock.json

@@ -1096,7 +1096,6 @@
         "copy-webpack-plugin": "^6.0.3",
         "eslint": "^7.19.0",
         "eslint-plugin-import": "^2.22.1",
-        "globby": "^11.0.3",
         "gulp": "^4.0.2",
         "gulp-chmod": "^2.0.0",
         "gulp-decompress": "^2.0.3",
@@ -1127,6 +1126,7 @@
         "escape-string-regexp": "^4.0.0",
         "extract-zip": "^2.0.1",
         "fs-extra": "^4.0.2",
+        "globby": "^11.0.3",
         "jsonc-parser": "^2.3.1",
         "open": "^8.0.4",
         "p-retry": "^4.1.0",

package.json

@@ -5,11 +5,12 @@
 
 import * as fse from 'fs-extra';
 import * as path from 'path';
-import { MessageItem, RelativePattern, workspace, WorkspaceFolder } from 'vscode';
+import { MessageItem, WorkspaceFolder } from 'vscode';
 import { DialogResponses, IActionContext, IAzureQuickPickItem } from 'vscode-azureextensionui';
 import { hostFileName, projectSubpathSetting } from '../../constants';
 import { localize } from '../../localize';
 import { telemetryUtils } from '../../utils/telemetryUtils';
+import { findFiles } from '../../utils/workspace';
 import * as api from '../../vscode-azurefunctions.api';
 import { getWorkspaceSetting, updateWorkspaceSetting } from '../../vsCodeConfig/settings';
 import { createNewProjectInternal } from './createNewProject';
@@ -41,12 +42,12 @@ export async function tryGetFunctionProjectRoot(context: IActionContext, workspa
                 if (await isFunctionProject(folderPath)) {
                     return folderPath;
                 } else {
-                    const hostJsonUris = await workspace.findFiles(new RelativePattern(workspaceFolder, `*/${hostFileName}`));
+                    const hostJsonUris = await findFiles(workspaceFolder, `*/${hostFileName}`);
                     if (hostJsonUris.length !== 1) {
                         // NOTE: If we found a single project at the root or one level down, we will use that without searching any further.
                         // This will reduce false positives in the case of compiled languages like C# where a 'host.json' file is often copied to a build/publish directory a few levels down
                         // It also maintains consistent historical behavior by giving that project priority because we used to _only_ look at the root and one level down
-                        hostJsonUris.push(...await workspace.findFiles(new RelativePattern(workspaceFolder, `*/*/**/${hostFileName}`)));
+                        hostJsonUris.push(...await findFiles(workspaceFolder, `*/*/**/${hostFileName}`));
                     }
 
                     const projectPaths = hostJsonUris.map(uri => path.dirname(uri.fsPath));

src/commands/createNewProject/verifyIsProject.ts

@@ -5,12 +5,12 @@
 
 import * as fse from 'fs-extra';
 import * as path from 'path';
-import { RelativePattern, workspace } from 'vscode';
 import { IActionContext } from 'vscode-azureextensionui';
 import { localSettingsFileName, pomXmlFileName, ProjectLanguage, workerRuntimeKey } from '../../constants';
 import { getLocalSettingsJson, ILocalSettingsJson } from '../../funcConfig/local.settings';
 import { dotnetUtils } from '../../utils/dotnetUtils';
 import { telemetryUtils } from '../../utils/telemetryUtils';
+import { findFiles } from '../../utils/workspace';
 import { getScriptFileNameFromLanguage } from '../createFunction/scriptSteps/ScriptFunctionCreateStep';
 
 /**
@@ -87,7 +87,7 @@ async function detectScriptLanguages(context: IActionContext, projectPath: strin
         for (const language of Object.values(ProjectLanguage)) {
             const functionFileName: string | undefined = getScriptFileNameFromLanguage(language);
             if (functionFileName) {
-                const uris = await workspace.findFiles(new RelativePattern(projectPath, `*/${functionFileName}`), undefined, 1 /* maxResults */);
+                const uris = await findFiles(projectPath, `*/${functionFileName}`);
                 if (uris.length > 0) {
                     detectedLangs.push(language);
                 }

src/commands/initProjectForVSCode/detectProjectLanguage.ts

@@ -6,7 +6,7 @@
 import { WebSiteManagementModels } from '@azure/arm-appservice';
 import * as fse from 'fs-extra';
 import * as path from 'path';
-import { RelativePattern, ThemeIcon, workspace } from 'vscode';
+import { ThemeIcon } from 'vscode';
 import { AzExtTreeItem, GenericTreeItem, IActionContext } from 'vscode-azureextensionui';
 import { functionJsonFileName } from '../../constants';
 import { ParsedFunctionJson } from '../../funcConfig/function';
@@ -15,6 +15,7 @@ import { localize } from '../../localize';
 import { nonNullProp } from '../../utils/nonNull';
 import { requestUtils } from '../../utils/requestUtils';
 import { telemetryUtils } from '../../utils/telemetryUtils';
+import { findFiles } from '../../utils/workspace';
 import { FunctionsTreeItemBase } from '../FunctionsTreeItemBase';
 import { LocalFunctionTreeItem } from './LocalFunctionTreeItem';
 import { LocalProjectTreeItem } from './LocalProjectTreeItem';
@@ -110,7 +111,7 @@ export class LocalFunctionsTreeItem extends FunctionsTreeItemBase {
 
 export async function getFunctionFolders(context: IActionContext, projectPath: string): Promise<string[]> {
     return await telemetryUtils.runWithDurationTelemetry(context, 'getFuncs', async () => {
-        const funcJsonUris = await workspace.findFiles(new RelativePattern(projectPath, `*/${functionJsonFileName}`));
+        const funcJsonUris = await findFiles(projectPath, `*/${functionJsonFileName}`);
         return funcJsonUris.map(uri => path.basename(path.dirname(uri.fsPath)))
     });
 }

src/tree/localProject/LocalFunctionsTreeItem.ts

@@ -5,13 +5,13 @@
 
 import * as fse from 'fs-extra';
 import * as path from 'path';
-import { RelativePattern, workspace } from 'vscode';
 import { IActionContext } from 'vscode-azureextensionui';
 import { ProjectLanguage } from '../constants';
 import { FuncVersion } from '../FuncVersion';
 import { localize } from "../localize";
 import { cliFeedUtils } from './cliFeedUtils';
 import { telemetryUtils } from './telemetryUtils';
+import { findFiles } from './workspace';
 
 export namespace dotnetUtils {
     export const isolatedSdkName: string = 'Microsoft.Azure.Functions.Worker.Sdk';
@@ -44,7 +44,7 @@ export namespace dotnetUtils {
     export async function getProjFiles(context: IActionContext, projectLanguage: ProjectLanguage, projectPath: string): Promise<ProjectFile[]> {
         return await telemetryUtils.runWithDurationTelemetry(context, 'getNetProjFiles', async () => {
             const pattern = projectLanguage === ProjectLanguage.FSharp ? '*.fsproj' : '*.csproj';
-            const uris = await workspace.findFiles(new RelativePattern(projectPath, pattern))
+            const uris = await findFiles(projectPath, pattern)
             return uris.map(uri => path.basename(uri.fsPath)).filter(f => f.toLowerCase() !== 'extensions.csproj').map(f => new ProjectFile(f, projectPath));
         });
     }

src/utils/dotnetUtils.ts

@@ -3,6 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import * as globby from 'globby';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { IActionContext, IAzureQuickPickItem } from 'vscode-azureextensionui';
@@ -14,6 +15,16 @@ export function isMultiRootWorkspace(): boolean {
         && vscode.workspace.name !== vscode.workspace.workspaceFolders[0].name; // multi-root workspaces always have something like "(Workspace)" appended to their name
 }
 
+/**
+ * Alternative to `vscode.workspace.findFiles` which always returns an empty array if no workspace is open
+ */
+export async function findFiles(base: vscode.WorkspaceFolder | string, pattern: string): Promise<vscode.Uri[]> {
+    // Per globby docs: "Note that glob patterns can only contain forward-slashes, not backward-slashes, so if you want to construct a glob pattern from path components, you need to use path.posix.join() instead of path.join()"
+    const posixBase = path.posix.normalize(typeof base === 'string' ? base : base.uri.fsPath).replace(/\\/g, '/');
+    const fullPattern = path.posix.join(posixBase, pattern);
+    return (await globby(fullPattern)).map(s => vscode.Uri.file(s));
+}
+
 export async function selectWorkspaceFolder(context: IActionContext, placeHolder: string, getSubPath?: (f: vscode.WorkspaceFolder) => string | undefined | Promise<string | undefined>): Promise<string> {
     return await selectWorkspaceItem(
         context,