Refactor quick pick filters

src/api/v2/quickPickWizard/AppResourceFilter.ts

@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.txt in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { AppResource, AppResourceFilter as AppResourceFilterOptions } from "@microsoft/vscode-azext-utils/hostapi";
+import { Filter } from "../v2AzureResourcesApi";
+
+export class AppResourceFilter implements Filter<AppResource> {
+
+    constructor(private readonly options: AppResourceFilterOptions) { }
+
+    public matches(resource: AppResource): boolean {
+        if (this.options.type !== resource.type) {
+            return false;
+        }
+
+        if (this.options.kind && this.options.kind !== resource.kind) {
+            return false;
+        }
+
+        if (this.options.tags) {
+            for (const tag of Object.keys(this.options.tags)) {
+                if (this.options.tags[tag] !== resource.tags?.[tag]) {
+                    return false;
+                }
+            }
+        }
+
+        return true;
+    }
+}

src/api/v2/quickPickWizard/ContextValueFilter.ts

@@ -3,25 +3,29 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { ResourceModelBase } from '../v2AzureResourcesApi';
+import { Filter, ResourceModelBase } from '../v2AzureResourcesApi';
 
-export type ContextValueFilter = string | RegExp | (string | RegExp)[];
+export class ContextValueFilter implements Filter<ResourceModelBase> {
 
-export function matchesContextValueFilter(resource: ResourceModelBase, filter: ContextValueFilter): boolean {
-    if (!resource?.quickPickOptions) {
-        return false;
-    }
+    constructor(private readonly expectedContextValue: string | RegExp | (string | RegExp)[]) { }
+
+    matches(resource: ResourceModelBase): boolean {
 
-    const filterArray = Array.isArray(filter) ? filter : [filter];
+        const filterArray = Array.isArray(this.expectedContextValue) ? this.expectedContextValue : [this.expectedContextValue];
 
-    return filterArray.some(filter => {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return resource.quickPickOptions!.contexts.some(contextValue => {
-            if (typeof filter === 'string') {
-                return filter === contextValue;
-            } else {
-                return filter.test(contextValue);
-            }
-        })
-    });
+        if (!resource.quickPickOptions) {
+            return false;
+        }
+
+        return filterArray.some(filter => {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            return resource.quickPickOptions!.contexts.some(contextValue => {
+                if (typeof filter === 'string') {
+                    return filter === contextValue;
+                } else {
+                    return filter.test(contextValue);
+                }
+            })
+        });
+    }
 }

src/api/v2/quickPickWizard/GenericQuickPickStep.ts

@@ -5,16 +5,15 @@
 
 import { AzureWizardPromptStep, IAzureQuickPickItem, NoResourceFoundError } from '@microsoft/vscode-azext-utils';
 import * as vscode from 'vscode';
-import { ResourceModelBase } from '../v2AzureResourcesApi';
-import { ContextValueFilter, matchesContextValueFilter } from './ContextValueFilter';
+import { Filter, ResourceModelBase } from '../v2AzureResourcesApi';
 import { QuickPickWizardContext } from './QuickPickWizardContext';
 
 export class GenericQuickPickStep<TModel extends ResourceModelBase> extends AzureWizardPromptStep<QuickPickWizardContext<TModel>> {
     public supportsDuplicateSteps = true;
 
     public constructor(
         protected readonly treeDataProvider: vscode.TreeDataProvider<TModel>,
-        protected readonly contextValueFilter: ContextValueFilter,
+        protected readonly contextValueFilter: Filter<TModel>,
     ) {
         super();
     }
@@ -31,7 +30,7 @@ export class GenericQuickPickStep<TModel extends ResourceModelBase> extends Azur
     protected async getPicks(wizardContext: QuickPickWizardContext<TModel>): Promise<IAzureQuickPickItem<TModel>[]> {
         const children = (await this.treeDataProvider.getChildren(wizardContext.currentNode)) || [];
 
-        const matchingChildren = children.filter(c => matchesContextValueFilter(c, this.contextValueFilter));
+        const matchingChildren = children.filter(this.contextValueFilter.matches);
         const nonLeafChildren = children.filter(c => c.quickPickOptions?.isLeaf === false);
 
         let promptChoices: TModel[];

src/api/v2/quickPickWizard/QuickPickAppResourceStep.ts

@@ -3,20 +3,34 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { AzureWizardPromptStep, IAzureQuickPickItem, IWizardOptions } from '@microsoft/vscode-azext-utils';
-import { PickAppResourceOptions } from '@microsoft/vscode-azext-utils/hostapi';
+import { AzureWizardPromptStep, IAzureQuickPickItem, IAzureQuickPickOptions, IWizardOptions } from '@microsoft/vscode-azext-utils';
+import { AppResource } from '@microsoft/vscode-azext-utils/hostapi';
 import { BranchDataProviderManager } from '../../../tree/v2/providers/BranchDataProviderManager';
 import { ApplicationResourceProviderManager } from '../providers/ApplicationResourceProviderManager';
-import { ApplicationResource, ResourceModelBase } from '../v2AzureResourcesApi';
-import { matchesContextValueFilter } from './ContextValueFilter';
+import { ApplicationResource, Filter, ResourceModelBase } from '../v2AzureResourcesApi';
 import { QuickPickAppResourceWizardContext } from './QuickPickAppResourceWizardContext';
 import { RecursiveQuickPickStep } from './RecursiveQuickPickStep';
 
+export interface PickAppResourceOptions2 extends IAzureQuickPickOptions {
+    /**
+     * Set this to pick a child of the selected app resource
+     */
+    childFilter?: Filter<ResourceModelBase>;
+
+    /**
+     * Whether `AppResourceTreeItem`s should be resolved before displaying them as quick picks, or only once one has been selected
+     * If a client extension needs to change label/description/something visible on the quick pick via `resolve`, set to true,
+     * otherwise set to false. Default will be false.
+     */
+    resolveQuickPicksBeforeDisplay?: boolean;
+}
+
 export class QuickPickAppResourceStep<TModel extends ResourceModelBase> extends AzureWizardPromptStep<QuickPickAppResourceWizardContext<TModel>> {
     public constructor(
         private readonly resourceProviderManager: ApplicationResourceProviderManager,
         private readonly branchDataProviderManager: BranchDataProviderManager,
-        private readonly options: PickAppResourceOptions
+        private readonly filter?: Filter<AppResource> | Filter<AppResource>[],
+        private readonly options?: PickAppResourceOptions2
     ) {
         super();
     }
@@ -39,8 +53,8 @@ export class QuickPickAppResourceStep<TModel extends ResourceModelBase> extends
     }
 
     public async getSubWizard(wizardContext: QuickPickAppResourceWizardContext<TModel>): Promise<IWizardOptions<QuickPickAppResourceWizardContext<TModel>> | undefined> {
-        if (this.options.expectedChildContextValue) {
-            if (matchesContextValueFilter(wizardContext.currentNode as TModel, this.options.expectedChildContextValue)) {
+        if (this.options?.childFilter) {
+            if (this.options.childFilter?.matches(wizardContext.currentNode as TModel)) {
                 return undefined;
             }
 
@@ -49,7 +63,7 @@ export class QuickPickAppResourceStep<TModel extends ResourceModelBase> extends
             return {
                 hideStepCount: true,
                 promptSteps: [
-                    new RecursiveQuickPickStep(bdp, this.options.expectedChildContextValue),
+                    new RecursiveQuickPickStep(bdp, this.options.childFilter),
                 ],
             };
         }
@@ -65,30 +79,11 @@ export class QuickPickAppResourceStep<TModel extends ResourceModelBase> extends
     }
 
     private matchesAppResource(resource: ApplicationResource): boolean {
-        if (!this.options.filter) {
+        if (!this.filter) {
             return true;
         }
 
-        const filterArray = Array.isArray(this.options.filter) ? this.options.filter : [this.options.filter];
-
-        return filterArray.some(filter => {
-            if (filter.type !== resource.type) {
-                return false;
-            }
-
-            if (filter.kind && filter.kind !== resource.kind) {
-                return false;
-            }
-
-            if (filter.tags) {
-                for (const tag of Object.keys(filter.tags)) {
-                    if (filter.tags[tag] !== resource.tags?.[tag]) {
-                        return false;
-                    }
-                }
-            }
-
-            return true;
-        })
+        const filterArray = Array.isArray(this.filter) ? this.filter : [this.filter];
+        return filterArray.some((filter) => filter.matches(resource));
     }
 }

src/api/v2/quickPickWizard/RecursiveQuickPickStep.ts

@@ -10,7 +10,7 @@ import { QuickPickWizardContext } from './QuickPickWizardContext';
 
 export class RecursiveQuickPickStep<TModel extends ResourceModelBase> extends GenericQuickPickStep<TModel> {
     public async getSubWizard(wizardContext: QuickPickWizardContext<TModel>): Promise<IWizardOptions<QuickPickWizardContext<TModel>> | undefined> {
-        if (this.matchesContextValue(wizardContext.currentNode)) {
+        if (this.contextValueFilter.matches(wizardContext.currentNode as TModel)) {
             return undefined;
         } else {
             return {

src/api/v2/v2AzureResourcesApi.ts

@@ -205,3 +205,7 @@ export interface AzureResourcesApiManager {
      */
     getApi<T extends AzureResourcesApiBase>(versionRange: string): T | undefined
 }
+
+export interface Filter<T> {
+    matches(value: T): boolean;
+}