Add support for organization custom instructions (#2310)

* PR

* activation

* fix test

* wip

* update

* tests

* Update src/platform/github/common/githubService.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/extension/agents/vscode-node/organizationInstructionsProvider.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/platform/github/common/octoKitServiceImpl.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* update

* update setting name

* wip

* fix

* use enum

* PR

* nit

* add polling

* tests

* cleanup

* use helper

* remove instructions

* clean

* Revert "clean"

This reverts commit d00db38.

* Revert "remove instructions"

This reverts commit 24f3e2e.

* update

* update per discussion

* clean

* update

* update

* Update

* update

* update

* clean

* test

* test

* fixes

* fixes

* fix tests

* update test

* yaml

* fix

* config update

* clean

* fix

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: pwang347

package.json

@@ -84,7 +84,8 @@
 		"onUri",
 		"onFileSystem:ccreq",
 		"onFileSystem:ccsettings",
-		"onCustomAgentProvider"
+		"onCustomAgentProvider",
+		"onInstructionsProvider"
 	],
 	"main": "./dist/extension",
 	"l10n": "./l10n",
@@ -2761,6 +2762,16 @@
 						"default": true,
 						"description": "%github.copilot.config.customInstructionsInSystemMessage%"
 					},
+					"github.copilot.chat.organizationCustomAgents.enabled": {
+						"type": "boolean",
+						"default": true,
+						"description": "%github.copilot.config.organizationCustomAgents.enabled%"
+					},
+					"github.copilot.chat.organizationInstructions.enabled": {
+						"type": "boolean",
+						"default": true,
+						"description": "%github.copilot.config.organizationInstructions.enabled%"
+					},
 					"github.copilot.chat.agent.currentEditorContext.enabled": {
 						"type": "boolean",
 						"default": true,
@@ -3558,14 +3569,6 @@
 							"electron-fetch",
 							"node-fetch"
 						]
-					},
-					"github.copilot.chat.customAgents.showOrganizationAndEnterpriseAgents": {
-						"type": "boolean",
-						"default": false,
-						"description": "%github.copilot.config.customAgents.showOrganizationAndEnterpriseAgents%",
-						"tags": [
-							"experimental"
-						]
 					}
 				}
 			},

package.nls.json

@@ -298,7 +298,8 @@
 	"copilot.tools.createDirectory.description": "Create new directories in your workspace",
 	"github.copilot.config.agent.currentEditorContext.enabled": "When enabled, Copilot will include the name of the current active editor in the context for agent mode.",
 	"github.copilot.config.customInstructionsInSystemMessage": "When enabled, custom instructions and mode instructions will be appended to the system message instead of a user message.",
-	"github.copilot.config.customAgents.showOrganizationAndEnterpriseAgents": "Enable custom agents from GitHub Enterprise and Organizations. When disabled, custom agents from your organization or enterprise will not be available in Copilot.",
+	"github.copilot.config.organizationCustomAgents.enabled": "When enabled, Copilot will load custom agents defined by your GitHub Organization.",
+	"github.copilot.config.organizationInstructions.enabled": "When enabled, Copilot will load custom instructions defined by your GitHub Organization.",
 	"copilot.toolSet.editing.description": "Edit files in your workspace",
 	"copilot.toolSet.read.description": "Read files in your workspace",
 	"copilot.toolSet.search.description": "Search files in your workspace",

src/extension/agents/vscode-node/githubOrgChatResourcesService.ts

@@ -0,0 +1,332 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import { AGENT_FILE_EXTENSION, INSTRUCTION_FILE_EXTENSION, PromptsType } from '../../../platform/customInstructions/common/promptTypes';
+import { IVSCodeExtensionContext } from '../../../platform/extContext/common/extensionContext';
+import { IFileSystemService } from '../../../platform/filesystem/common/fileSystemService';
+import { FileType } from '../../../platform/filesystem/common/fileTypes';
+import { getGithubRepoIdFromFetchUrl, IGitService } from '../../../platform/git/common/gitService';
+import { IOctoKitService } from '../../../platform/github/common/githubService';
+import { ILogService } from '../../../platform/log/common/logService';
+import { IWorkspaceService } from '../../../platform/workspace/common/workspaceService';
+import { Disposable, DisposableStore, IDisposable, toDisposable } from '../../../util/vs/base/common/lifecycle';
+import { createDecorator } from '../../../util/vs/platform/instantiation/common/instantiation';
+
+export interface IGitHubOrgChatResourcesService extends IDisposable {
+	/**
+	 * Returns the organization that should be used for the current session.
+	 */
+	getPreferredOrganizationName(): Promise<string | undefined>;
+
+	/**
+	 * Creates a polling subscription with a custom interval.
+	 * The callback will be invoked at the specified interval.
+	 * @param intervalMs The polling interval in milliseconds
+	 * @param callback The callback to invoke on each poll cycle
+	 * @returns A disposable that stops the polling when disposed
+	 */
+	startPolling(intervalMs: number, callback: (orgName: string) => Promise<void>): IDisposable;
+
+	/**
+	 * Reads a specific cached resource.
+	 * @returns The content of the resource, or undefined if not found
+	 */
+	readCacheFile(type: PromptsType, orgName: string, filename: string): Promise<string | undefined>;
+
+	/**
+	 * Writes a resource to the cache.
+	 * @returns True if the content was changed, false if unchanged
+	 */
+	writeCacheFile(type: PromptsType, orgName: string, filename: string, content: string, options?: { checkForChanges?: boolean }): Promise<boolean>;
+
+	/**
+	 * Deletes all cached resources of specified type for an organization.
+	 * Optionally provide set of filenames to exclude from deletion.
+	 */
+	clearCache(type: PromptsType, orgName: string, exclude?: Set<string>): Promise<void>;
+
+	/**
+	 * Lists all cached resources for a specific organization and type.
+	 * @returns The list of cached resources.
+	 */
+	listCachedFiles(type: PromptsType, orgName: string): Promise<vscode.ChatResource[]>;
+}
+
+export const IGitHubOrgChatResourcesService = createDecorator<IGitHubOrgChatResourcesService>('IGitHubPromptFileService');
+
+/**
+ * Maps PromptsType to the cache subdirectory name.
+ */
+function getCacheSubdirectory(type: PromptsType): string {
+	switch (type) {
+		case PromptsType.instructions:
+			return 'instructions';
+		case PromptsType.agent:
+			return 'agents';
+		default:
+			throw new Error(`Unsupported PromptsType: ${type}`);
+	}
+}
+
+/**
+ * Returns true if the filename is valid for the given PromptsType.
+ */
+function isValidFile(type: PromptsType, fileName: string): boolean {
+	switch (type) {
+		case PromptsType.instructions:
+			return fileName.endsWith(INSTRUCTION_FILE_EXTENSION);
+		case PromptsType.agent:
+			return fileName.endsWith(AGENT_FILE_EXTENSION);
+		default:
+			throw new Error(`Unsupported PromptsType: ${type}`);
+	}
+}
+
+export class GitHubOrgChatResourcesService extends Disposable implements IGitHubOrgChatResourcesService {
+	private static readonly CACHE_ROOT = 'github';
+
+	private readonly _pollingSubscriptions = this._register(new DisposableStore());
+	private _cachedPreferredOrgName: Promise<string | undefined> | undefined;
+
+	constructor(
+		@IVSCodeExtensionContext private readonly extensionContext: IVSCodeExtensionContext,
+		@IFileSystemService private readonly fileSystem: IFileSystemService,
+		@IGitService private readonly gitService: IGitService,
+		@ILogService private readonly logService: ILogService,
+		@IOctoKitService private readonly octoKitService: IOctoKitService,
+		@IWorkspaceService private readonly workspaceService: IWorkspaceService,
+	) {
+		super();
+
+		// Invalidate cached org name when workspace folders change
+		this._register(this.workspaceService.onDidChangeWorkspaceFolders(() => {
+			this.logService.trace('[GitHubOrgChatResourcesService] Workspace folders changed, invalidating cached org name');
+			this._cachedPreferredOrgName = undefined;
+		}));
+	}
+
+	async getPreferredOrganizationName(): Promise<string | undefined> {
+		if (!this._cachedPreferredOrgName) {
+			this._cachedPreferredOrgName = this.computePreferredOrganizationName();
+		}
+		return this._cachedPreferredOrgName;
+	}
+
+	private async computePreferredOrganizationName(): Promise<string | undefined> {
+		// Check if user is signed in first
+		const currentUser = await this.octoKitService.getCurrentAuthedUser();
+		if (!currentUser) {
+			this.logService.trace('[GitHubOrgChatResourcesService] User is not signed in');
+			return undefined;
+		}
+
+		// Get the organizations the user is a member of
+		let userOrganizations: string[];
+		try {
+			userOrganizations = await this.octoKitService.getUserOrganizations({ createIfNone: true });
+			if (userOrganizations.length === 0) {
+				this.logService.trace('[GitHubOrgChatResourcesService] No organizations found for user');
+				return undefined;
+			}
+		} catch (error) {
+			this.logService.error(`[GitHubOrgChatResourcesService] Error getting user organizations: ${error}`);
+			return undefined;
+		}
+
+		// Check if workspace repo belongs to an organization the user is a member of
+		const workspaceOrg = await this.getWorkspaceRepositoryOrganization();
+		if (workspaceOrg && userOrganizations.includes(workspaceOrg)) {
+			return workspaceOrg;
+		}
+
+		// Fall back to the first organization the user belongs to
+		return userOrganizations[0];
+	}
+
+	/**
+	 * Gets the organization from the current workspace's git repository, if any.
+	 */
+	private async getWorkspaceRepositoryOrganization(): Promise<string | undefined> {
+		const workspaceFolders = this.workspaceService.getWorkspaceFolders();
+		if (workspaceFolders.length === 0) {
+			return undefined;
+		}
+
+		try {
+			// TODO: Support multi-root workspaces by checking all folders.
+			// This would need workspace-aware context for deciding when to use which org, which is currently not in scope.
+			const repoInfo = await this.gitService.getRepositoryFetchUrls(workspaceFolders[0]);
+			if (!repoInfo?.remoteFetchUrls?.length) {
+				return undefined;
+			}
+
+			// Try each remote URL to find a GitHub repo
+			for (const fetchUrl of repoInfo.remoteFetchUrls) {
+				if (!fetchUrl) {
+					continue;
+				}
+				const repoId = getGithubRepoIdFromFetchUrl(fetchUrl);
+				if (repoId) {
+					this.logService.trace(`[GitHubOrgChatResourcesService] Found GitHub repo: ${repoId.org}/${repoId.repo}`);
+					return repoId.org;
+				}
+			}
+		} catch (error) {
+			this.logService.trace(`[GitHubOrgChatResourcesService] Error getting workspace repository: ${error}`);
+		}
+
+		return undefined;
+	}
+
+	startPolling(intervalMs: number, callback: (orgName: string) => Promise<void>): IDisposable {
+		const disposables = new DisposableStore();
+
+		let isPolling = false;
+		const poll = async () => {
+			if (isPolling) {
+				return;
+			}
+			isPolling = true;
+			try {
+				const orgName = await this.getPreferredOrganizationName();
+				if (orgName) {
+					try {
+						await callback(orgName);
+					} catch (error) {
+						this.logService.error(`[GitHubOrgChatResourcesService] Error in polling callback: ${error}`);
+					}
+				}
+			} finally {
+				isPolling = false;
+			}
+		};
+
+		// Initial poll
+		void poll();
+
+		// Set up interval polling
+		const intervalId = setInterval(() => poll(), intervalMs);
+		disposables.add(toDisposable(() => clearInterval(intervalId)));
+
+		this._pollingSubscriptions.add(disposables);
+
+		return disposables;
+	}
+
+	private getCacheDir(orgName: string, type: PromptsType): vscode.Uri {
+		const sanitizedOrg = this.sanitizeFilename(orgName);
+		const subdirectory = getCacheSubdirectory(type);
+		return vscode.Uri.joinPath(
+			this.extensionContext.globalStorageUri,
+			GitHubOrgChatResourcesService.CACHE_ROOT,
+			sanitizedOrg,
+			subdirectory
+		);
+	}
+
+	private getCacheFileUri(orgName: string, type: PromptsType, filename: string): vscode.Uri {
+		return vscode.Uri.joinPath(this.getCacheDir(orgName, type), filename);
+	}
+
+	private sanitizeFilename(name: string): string {
+		return name.replace(/[^a-z0-9_-]/gi, '_').toLowerCase();
+	}
+
+	private async ensureCacheDir(orgName: string, type: PromptsType): Promise<void> {
+		const cacheDir = this.getCacheDir(orgName, type);
+		try {
+			await this.fileSystem.stat(cacheDir);
+		} catch {
+			// createDirectory should create parent directories recursively
+			await this.fileSystem.createDirectory(cacheDir);
+		}
+	}
+
+	async readCacheFile(type: PromptsType, orgName: string, filename: string): Promise<string | undefined> {
+		try {
+			const fileUri = this.getCacheFileUri(orgName, type, filename);
+			const content = await this.fileSystem.readFile(fileUri);
+			return new TextDecoder().decode(content);
+		} catch {
+			this.logService.error(`[GitHubOrgChatResourcesService] Cache file not found: ${filename}`);
+			return undefined;
+		}
+	}
+
+	async writeCacheFile(type: PromptsType, orgName: string, filename: string, content: string, options?: { checkForChanges?: boolean }): Promise<boolean> {
+		await this.ensureCacheDir(orgName, type);
+		const fileUri = this.getCacheFileUri(orgName, type, filename);
+		const contentBytes = new TextEncoder().encode(content);
+
+		// Check for changes if requested
+		let hasChanges = true;
+		if (options?.checkForChanges) {
+			try {
+				hasChanges = false;
+
+				// First check file size to avoid reading file if size differs
+				const stat = await this.fileSystem.stat(fileUri);
+				if (stat.size !== contentBytes.length) {
+					hasChanges = true;
+				}
+
+				// Sizes match, need to compare content
+				const existingContent = await this.fileSystem.readFile(fileUri);
+				const existingText = new TextDecoder().decode(existingContent);
+				if (existingText !== content) {
+					this.logService.trace(`[GitHubOrgChatResourcesService] Skipped writing cache file: ${fileUri.toString()}`);
+					hasChanges = true;
+				} else {
+					// Content is the same, no need to write
+					return false;
+				}
+			} catch {
+				// File doesn't exist, so we have changes
+				hasChanges = true;
+			}
+		}
+
+		await this.fileSystem.writeFile(fileUri, contentBytes);
+		this.logService.trace(`[GitHubOrgChatResourcesService] Wrote cache file: ${fileUri.toString()}`);
+		return hasChanges;
+	}
+
+	async clearCache(type: PromptsType, orgName: string, exclude?: Set<string>): Promise<void> {
+		const cacheDir = this.getCacheDir(orgName, type);
+
+		try {
+			const files = await this.fileSystem.readDirectory(cacheDir);
+			for (const [filename, fileType] of files) {
+				if (fileType === FileType.File && isValidFile(type, filename) && !exclude?.has(filename)) {
+					await this.fileSystem.delete(vscode.Uri.joinPath(cacheDir, filename));
+					this.logService.trace(`[GitHubOrgChatResourcesService] Deleted cache file: ${filename}`);
+				}
+			}
+		} catch {
+			// Directory might not exist
+		}
+	}
+
+	async listCachedFiles(type: PromptsType, orgName: string): Promise<vscode.ChatResource[]> {
+		const resources: vscode.ChatResource[] = [];
+		const cacheDir = this.getCacheDir(orgName, type);
+
+		try {
+			const files = await this.fileSystem.readDirectory(cacheDir);
+			for (const [filename, fileType] of files) {
+				if (fileType === FileType.File && isValidFile(type, filename)) {
+					const fileUri = vscode.Uri.joinPath(cacheDir, filename);
+					resources.push({ uri: fileUri });
+				}
+			}
+		} catch {
+			// Directory might not exist yet
+			this.logService.trace(`[GitHubOrgChatResourcesService] Cache directory does not exist: ${cacheDir.toString()}`);
+		}
+
+		return resources;
+	}
+}