Don't invoke a provider if we know its code actions will be excluded

mjbvz · mjbvz · commit b602c14b802a · 2020-01-21T16:49:39.000-08:00
Fixes microsoft#84602
diff --git a/src/vs/editor/contrib/codeAction/test/codeAction.test.ts b/src/vs/editor/contrib/codeAction/test/codeAction.test.ts
@@ -220,6 +220,43 @@ suite('CodeAction', () => {
 		}
 	});
 
+	test('getCodeActions no invoke a provider that has been excluded #84602', async function () {
+		const baseType = CodeActionKind.Refactor;
+		const subType = CodeActionKind.Refactor.append('sub');
+
+		disposables.add(modes.CodeActionProviderRegistry.register('fooLang', staticCodeActionProvider(
+			{ title: 'a', kind: baseType.value }
+		)));
+
+		let didInvoke = false;
+		disposables.add(modes.CodeActionProviderRegistry.register('fooLang', new class implements modes.CodeActionProvider {
+
+			providedCodeActionKinds = [subType.value];
+
+			provideCodeActions(): modes.ProviderResult<modes.CodeActionList> {
+				didInvoke = true;
+				return {
+					actions: [
+						{ title: 'x', kind: subType.value }
+					],
+					dispose: () => { }
+				};
+			}
+		}));
+
+		{
+			const { validActions: actions } = await getCodeActions(model, new Range(1, 1, 2, 1), {
+				type: modes.CodeActionTriggerType.Auto, filter: {
+					include: baseType,
+					excludes: [subType],
+				}
+			}, CancellationToken.None);
+			assert.strictEqual(didInvoke, false);
+			assert.equal(actions.length, 1);
+			assert.strictEqual(actions[0].title, 'a');
+		}
+	});
+
 	test('getCodeActions should not invoke code action providers filtered out by providedCodeActionKinds', async function () {
 		let wasInvoked = false;
 		const provider = new class implements modes.CodeActionProvider {
diff --git a/src/vs/editor/contrib/codeAction/types.ts b/src/vs/editor/contrib/codeAction/types.ts
@@ -58,6 +58,12 @@ export function mayIncludeActionsOfKind(filter: CodeActionFilter, providedKind:
 		return false;
 	}
 
+	if (filter.excludes) {
+		if (filter.excludes.some(exclude => excludesAction(providedKind, exclude, filter.include))) {
+			return false;
+		}
+	}
+
 	// Don't return source actions unless they are explicitly requested
 	if (!filter.includeSourceActions && CodeActionKind.Source.contains(providedKind)) {
 		return false;
@@ -77,10 +83,7 @@ export function filtersAction(filter: CodeActionFilter, action: CodeAction): boo
 	}
 
 	if (filter.excludes) {
-		if (actionKind && filter.excludes.some(exclude => {
-			// Excludes are overwritten by includes
-			return exclude.contains(actionKind) && (!filter.include || !filter.include.contains(actionKind));
-		})) {
+		if (actionKind && filter.excludes.some(exclude => excludesAction(actionKind, exclude, filter.include))) {
 			return false;
 		}
 	}
@@ -101,6 +104,17 @@ export function filtersAction(filter: CodeActionFilter, action: CodeAction): boo
 	return true;
 }
 
+function excludesAction(providedKind: CodeActionKind, exclude: CodeActionKind, include: CodeActionKind | undefined): boolean {
+	if (!exclude.contains(providedKind)) {
+		return false;
+	}
+	if (include && exclude.contains(include)) {
+		// The include is more specific, don't filter out
+		return false;
+	}
+	return true;
+}
+
 export interface CodeActionTrigger {
 	readonly type: CodeActionTriggerType;
 	readonly filter?: CodeActionFilter;
