Add Exp setting to control the amount of emitted context items (#1183)

* WIP

* WIP

* WIP

* Add usage mode

* Add ExP setting to control the amount of emitted context items

* Revert completionsCoreContribution.ts

Author: dbaeumer

package.json

@@ -2811,6 +2811,22 @@
 						],
 						"markdownDescription": "%github.copilot.chat.languageContext.typescript.enabled%"
 					},
+					"github.copilot.chat.languageContext.typescript.items": {
+						"type": "string",
+						"enum": [
+							"minimal",
+							"double",
+							"fillHalf",
+							"fill"
+						],
+						"default": "minimal",
+						"scope": "resource",
+						"tags": [
+							"experimental",
+							"onExP"
+						],
+						"markdownDescription": "%github.copilot.chat.languageContext.typescript.items%"
+					},
 					"github.copilot.chat.languageContext.typescript.cacheTimeout": {
 						"type": "number",
 						"default": 500,

package.nls.json

@@ -228,6 +228,7 @@
 	"github.copilot.walkthrough.sparkle.media.altText": "The video shows the sparkle icon in the source control input box being clicked, triggering GitHub Copilot to generate a commit message automatically",
 	"github.copilot.chat.completionContext.typescript.mode": "The execution mode of the TypeScript Copilot context provider.",
 	"github.copilot.chat.languageContext.typescript.enabled": "Enables the TypeScript language context provider for inline completions",
+	"github.copilot.chat.languageContext.typescript.items": "Controls which kind of items are included in the TypeScript language context provider.",
 	"github.copilot.chat.languageContext.typescript.cacheTimeout": "The cache population timeout for the TypeScript language context provider in milliseconds. The default is 500 milliseconds.",
 	"github.copilot.chat.languageContext.fix.typescript.enabled": "Enables the TypeScript language context provider for /fix commands",
 	"github.copilot.chat.languageContext.inline.typescript.enabled": "Enables the TypeScript language context provider for inline chats (both generate and edit)",

src/extension/completions/vscode-node/completionsCoreContribution.ts

@@ -10,4 +10,4 @@ export class CompletionsCoreContribution extends Disposable {
 	constructor(@IInstantiationService instantiationService: IInstantiationService) {
 		super();
 	}
-}
+}

src/extension/typescriptContext/common/serverProtocol.ts

@@ -104,14 +104,15 @@ export namespace ContextItemReference {
 }
 
 export enum Priorities {
-	Locals = 1,
-	Inherited = 0.9,
-	Properties = 0.8,
-	Blueprints = 0.7,
-	Imports = 0.6,
-	NeighborFiles = 0.55,
-	Globals = 0.5,
-	Traits = 0.4,
+	Expression = 1.0,
+	Locals = 0.9,
+	Inherited = 0.8,
+	Traits = 0.7,
+	Blueprints = 0.6,
+	Properties = 0.5,
+	Imports = 0.4,
+	NeighborFiles = 0.3,
+	Globals = 0.2
 }
 
 export enum SpeculativeKind {
@@ -395,10 +396,11 @@ export type ContextRequestResult = {
 
 export interface ComputeContextRequestArgs extends tt.server.protocol.FileLocationRequestArgs {
 	startTime: number;
-	timeBudget?: number;
-	tokenBudget?: number;
-	neighborFiles?: FilePath[];
-	clientSideRunnableResults?: CachedContextRunnableResult[];
+	timeBudget: number;
+	primaryCharacterBudget: number;
+	secondaryCharacterBudget: number;
+	neighborFiles?: readonly FilePath[];
+	clientSideRunnableResults?: readonly CachedContextRunnableResult[];
 }
 
 export interface ComputeContextRequest extends tt.server.protocol.Request {

src/extension/typescriptContext/serverPlugin/src/common/baseContextProviders.ts

@@ -8,7 +8,7 @@ const ts = TS();
 
 import { CodeSnippetBuilder } from './code';
 import {
-	AbstractContextRunnable, CacheScopes, ComputeCost, ContextProvider, type ComputeContextSession,
+	AbstractContextRunnable, CacheScopes, ComputeCost, ContextProvider, SnippetLocation, type ComputeContextSession,
 	type ContextResult,
 	type ContextRunnableCollector,
 	type ProviderComputeContext, type RequestContext, type RunnableResult,
@@ -38,7 +38,7 @@ export class CompilerOptionsRunnable extends AbstractContextRunnable {
 	private readonly sourceFile: tt.SourceFile;
 
 	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, sourceFile: tt.SourceFile) {
-		super(session, languageService, context, 'CompilerOptionsRunnable', Priorities.Traits, ComputeCost.Low);
+		super(session, languageService, context, 'CompilerOptionsRunnable', SnippetLocation.Primary, Priorities.Traits, ComputeCost.Low);
 		this.sourceFile = sourceFile;
 	}
 
@@ -83,7 +83,7 @@ export abstract class FunctionLikeContextRunnable<T extends tt.FunctionLikeDecla
 	protected readonly sourceFile: tt.SourceFile;
 
 	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, id: string, declaration: T, priority: number, cost: ComputeCost) {
-		super(session, languageService, context, id, priority, cost);
+		super(session, languageService, context, id, SnippetLocation.Primary, priority, cost);
 		this.declaration = declaration;
 		this.sourceFile = declaration.getSourceFile();
 	}
@@ -168,7 +168,7 @@ export class TypeOfLocalsRunnable extends AbstractContextRunnable {
 	private runnableResult: RunnableResult | undefined;
 
 	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, tokenInfo: tss.TokenInfo, excludes: Set<tt.Symbol>, cacheScope: CacheScope | undefined, priority: number = Priorities.Locals) {
-		super(session, languageService, context, 'TypeOfLocalsRunnable', priority, ComputeCost.Medium);
+		super(session, languageService, context, 'TypeOfLocalsRunnable', SnippetLocation.Primary, priority, ComputeCost.Medium);
 		this.tokenInfo = tokenInfo;
 		this.excludes = excludes;
 		this.cacheScope = cacheScope;
@@ -239,8 +239,10 @@ export class TypesOfNeighborFilesRunnable extends AbstractContextRunnable {
 
 	private readonly tokenInfo: tss.TokenInfo;
 
+	private static SymbolsToInclude: number = ts.SymbolFlags.Class | ts.SymbolFlags.Interface | ts.SymbolFlags.TypeAlias | ts.SymbolFlags.Enum | ts.SymbolFlags.Function;
+
 	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, tokenInfo: tss.TokenInfo, priority: number = Priorities.NeighborFiles) {
-		super(session, languageService, context, 'TypesOfNeighborFilesRunnable', priority, ComputeCost.Medium);
+		super(session, languageService, context, 'TypesOfNeighborFilesRunnable', SnippetLocation.Secondary, priority, ComputeCost.Medium);
 		this.tokenInfo = tokenInfo;
 	}
 
@@ -257,7 +259,7 @@ export class TypesOfNeighborFilesRunnable extends AbstractContextRunnable {
 		const symbols = this.symbols;
 		for (const neighborFile of this.context.neighborFiles) {
 			cancellationToken.throwIfCancellationRequested();
-			if (result.isTokenBudgetExhausted()) {
+			if (result.isSecondaryBudgetExhausted()) {
 				return;
 			}
 			const neighborSourceFile = this.getProgram().getSourceFile(neighborFile);
@@ -273,7 +275,7 @@ export class TypesOfNeighborFilesRunnable extends AbstractContextRunnable {
 				for (const member of sourceFileSymbol.exports) {
 					cancellationToken.throwIfCancellationRequested();
 					const memberSymbol = member[1];
-					if ((memberSymbol.flags & (ts.SymbolFlags.Class | ts.SymbolFlags.Interface | ts.SymbolFlags.TypeAlias | ts.SymbolFlags.Enum | ts.SymbolFlags.Function)) === 0) {
+					if ((memberSymbol.flags & TypesOfNeighborFilesRunnable.SymbolsToInclude) === 0) {
 						continue;
 					}
 					if (!this.handleSymbol(memberSymbol, member[0] as string, true)) {
@@ -304,7 +306,7 @@ export class ImportsRunnable extends AbstractContextRunnable {
 	]);
 
 	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, tokenInfo: tss.TokenInfo, excludes: Set<tt.Symbol>, priority: number = Priorities.Imports) {
-		super(session, languageService, context, 'ImportsRunnable', priority, ComputeCost.Medium);
+		super(session, languageService, context, 'ImportsRunnable', SnippetLocation.Secondary, priority, ComputeCost.Medium);
 		this.tokenInfo = tokenInfo;
 		this.excludes = excludes;
 		this.runnableResult = undefined;
@@ -459,8 +461,8 @@ export class TypeOfExpressionRunnable extends AbstractContextRunnable {
 
 	private readonly expression: tt.Expression;
 
-	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, expression: tt.Expression, priority: number = Priorities.Locals) {
-		super(session, languageService, context, 'TypeOfExpressionRunnable', priority, ComputeCost.Low);
+	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, expression: tt.Expression, priority: number = Priorities.Expression) {
+		super(session, languageService, context, 'TypeOfExpressionRunnable', SnippetLocation.Primary, priority, ComputeCost.Low);
 		this.expression = expression;
 	}
 
@@ -523,15 +525,15 @@ export class TypeOfExpressionRunnable extends AbstractContextRunnable {
 			}
 			const snippetBuilder = new CodeSnippetBuilder(this.session, this.symbols, sourceFile);
 			snippetBuilder.addTypeSymbol(returnTypeSymbol, returnTypeSymbol.name);
-			result.addSnippet(snippetBuilder, undefined);
+			result.addSnippet(snippetBuilder, this.location, undefined);
 		}
 		const typeSymbol = type.getSymbol();
 		if (typeSymbol === undefined) {
 			return;
 		}
 		const snippetBuilder = new CodeSnippetBuilder(this.session, this.symbols, sourceFile);
 		snippetBuilder.addTypeSymbol(typeSymbol, typeSymbol.name);
-		result.addSnippet(snippetBuilder, undefined);
+		result.addSnippet(snippetBuilder, this.location, undefined);
 	}
 }
 

src/extension/typescriptContext/serverPlugin/src/common/classContextProvider.ts

@@ -7,7 +7,7 @@ import TS from './typescript';
 const ts = TS();
 
 import { CodeSnippetBuilder } from './code';
-import { AbstractContextRunnable, ComputeCost, ContextProvider, ContextResult, Search, type ComputeContextSession, type ContextRunnableCollector, type RequestContext, type RunnableResult } from './contextProvider';
+import { AbstractContextRunnable, ComputeCost, ContextProvider, ContextResult, Search, SnippetLocation, type ComputeContextSession, type ContextRunnableCollector, type RequestContext, type RunnableResult } from './contextProvider';
 import { EmitMode, Priorities, SpeculativeKind } from './protocol';
 import tss, { ClassDeclarations, ReferencedByVisitor, Symbols } from './typescripts';
 
@@ -264,7 +264,7 @@ export class SuperClassRunnable extends AbstractContextRunnable {
 	private readonly classDeclaration: tt.ClassDeclaration;
 
 	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, classDeclaration: tt.ClassDeclaration, priority: number = Priorities.Inherited) {
-		super(session, languageService, context, 'SuperClassRunnable', priority, ComputeCost.Medium);
+		super(session, languageService, context, 'SuperClassRunnable', SnippetLocation.Primary, priority, ComputeCost.Medium);
 		this.classDeclaration = classDeclaration;
 	}
 
@@ -296,7 +296,7 @@ class SimilarClassRunnable extends AbstractContextRunnable {
 	private readonly classDeclaration: tt.ClassDeclaration;
 
 	constructor(session: ComputeContextSession, languageService: tt.LanguageService, context: RequestContext, classDeclaration: tt.ClassDeclaration, priority: number = Priorities.Blueprints) {
-		super(session, languageService, context, 'SimilarClassRunnable', priority, ComputeCost.High);
+		super(session, languageService, context, 'SimilarClassRunnable', SnippetLocation.Primary, priority, ComputeCost.High);
 		this.classDeclaration = classDeclaration;
 	}
 
@@ -325,7 +325,7 @@ class SimilarClassRunnable extends AbstractContextRunnable {
 		}
 		const code = new CodeSnippetBuilder(this.session, this.context.getSymbols(foundInProgram), classDeclaration.getSourceFile());
 		code.addDeclaration(similarClass.declaration);
-		result.addSnippet(code, undefined);
+		result.addSnippet(code, this.location, undefined);
 	}
 }