Allow all SKUs to use BYOK #242

pierceboggan · 2025-07-14T19:59:13Z

This PR removes a license check that was in place for "bring your own key" which previously restricted use to Copilot Free and Individual SKUs.

This also shows a warning the first time you add a BYOK model in VS Code.

…es flag

isidorn · 2025-07-15T10:00:57Z

src/extension/byok/common/byokProvider.ts

@@ -130,8 +130,41 @@ export function resolveModelInfo(modelId: string, providerName: string, knownMod
 	};
 }

+/**


No need for comments if they were not there before. I know some devs prefer code with 0 comments.

isidorn · 2025-07-15T10:02:18Z

src/extension/byok/common/byokProvider.ts

+	}
+
+	// For business and enterprise users, require Editor Preview Features to be enabled
+	if (copilotToken.copilotPlan === 'business' || copilotToken.copilotPlan === 'enterprise') {


No need to hard code 'business', 'enterprise'. There is probably some enum somewhere you can use.

I actually don't think there is an enum - this value is currently defined as a string literal union:

vscode-copilot-chat/src/platform/authentication/common/copilotToken.ts

Line 93 in 06a7481

get copilotPlan(): 'free' | 'individual' | 'individual_pro' | 'business' | 'enterprise' {

isidorn · 2025-07-15T10:05:32Z

src/extension/byok/common/byokProvider.ts

+
+	// For business and enterprise users, require Editor Preview Features to be enabled
+	if (copilotToken.copilotPlan === 'business' || copilotToken.copilotPlan === 'enterprise') {
+		return copilotToken.isEditorPreviewFeaturesEnabled();


0 enterprises have preview features enabled.
So I would not go down this route. For now I would just enable for insiders, and if GH wants a policy to disable once they deliver we can return that boolean. And I hope that is ENABLED by default.

isidorn · 2025-07-15T10:06:34Z

Thanks for this PR. I left some comments.
I think the bigger part of the work is actually notifying the user and making it obvious that the BYOK models are not covered with guarantess we have for Copilot models. I do not know if that is a dialog, notification, or just makeing it super clear in the docs.

DanielRosenwasser

Not opposed to the JSDoc comment but if you do end up removing it, just inline some of the details.

DanielRosenwasser · 2025-07-17T19:31:32Z

src/extension/byok/common/byokProvider.ts

+		return true;
+	}
+
+	// Allow for individual users without preview features gating (backward compatibility)


Suggested change

// Allow for individual users without preview features gating (backward compatibility)

// Allow for individual users without preview feature-gating (backward compatibility)

DanielRosenwasser · 2025-07-17T19:31:52Z

src/extension/byok/common/byokProvider.ts

+ *
+ * @param copilotToken The user's Copilot token (without the actual token value)
+ * @param capiClientService Service to check if running on GitHub Enterprise
+ * @returns true if BYOK should be enabled for this user


Suggested change

* @returns true if BYOK should be enabled for this user

* @returns whether BYOK should be enabled for this user

DanielRosenwasser · 2025-07-17T19:35:57Z

src/extension/byok/common/byokProvider.ts

+	}
+
+	// For business and enterprise users, require Editor Preview Features to be enabled
+	if (copilotToken.copilotPlan === 'business' || copilotToken.copilotPlan === 'enterprise') {


I actually don't think there is an enum - this value is currently defined as a string literal union:

vscode-copilot-chat/src/platform/authentication/common/copilotToken.ts

Line 93 in 06a7481

get copilotPlan(): 'free' | 'individual' | 'individual_pro' | 'business' | 'enterprise' {

…te UI messages for clarity

pierceboggan · 2025-08-05T03:37:42Z

@isidorn OK, give it another look. Just cleaned up the logic more. :)

isidorn · 2025-08-07T14:16:11Z

src/extension/byok/vscode-node/byokContribution.ts

+		// One‑time disclaimer: make it clear that BYOK models are external and not covered by Copilot guarantees.
+		if (!this._byokDisclaimerShown) {
+			this._byokDisclaimerShown = true; // ensure we only show once per session
+			const detail = 'Models you configure here are provided by external services that you choose. Your prompts and code may be sent to those services and are subject to their terms. GitHub Copilot\'s data handling, compliance, and quality guarantees do NOT apply to BYOK models.';


You might need to improve this string to be Localized. I am not 100% sure how to do it from this extension, but ask agent mode.

isidorn · 2025-08-07T14:16:33Z

src/extension/byok/vscode-node/byokContribution.ts

+		if (!this._byokDisclaimerShown) {
+			this._byokDisclaimerShown = true; // ensure we only show once per session
+			const detail = 'Models you configure here are provided by external services that you choose. Your prompts and code may be sent to those services and are subject to their terms. GitHub Copilot\'s data handling, compliance, and quality guarantees do NOT apply to BYOK models.';
+			const learnMore = 'Learn More';


Same for all these other strings. I think all user facing strings need a special syntax to be localized.

isidorn · 2025-08-07T14:17:37Z

src/extension/byok/vscode-node/byokContribution.ts

@@ -126,6 +127,25 @@ export class BYOKContrib extends Disposable implements IExtensionContribution {
 	}

 	private async registerModelCommand() {
+		// One‑time disclaimer: make it clear that BYOK models are external and not covered by Copilot guarantees.
+		if (!this._byokDisclaimerShown) {
+			this._byokDisclaimerShown = true; // ensure we only show once per session


How often is the registerModelCommand called?

If it is called only once the user adds a BYOK model - then I think this would work.

isidorn · 2025-08-07T14:18:35Z

Left some comments.

Did you get a chance to test this out? If yes, can you share a screenshot / gif so I see the flow to potentially provide more feedback.

Allow all users access to BYOK, but gate behind editor preview featur…

d5d2327

…es flag

pierceboggan requested review from lramos15 and isidorn July 14, 2025 20:00

vs-code-engineering bot assigned pierceboggan Jul 14, 2025

vs-code-engineering bot added this to the July 2025 milestone Jul 14, 2025

isidorn reviewed Jul 15, 2025

View reviewed changes

DanielRosenwasser reviewed Jul 17, 2025

View reviewed changes

osortega modified the milestones: July 2025, August 2025 Aug 1, 2025

Refactor BYOK functionality to remove preview feature gating and upda…

eaa4101

…te UI messages for clarity

pierceboggan changed the title ~~Allow all SKUs to use BYOK and enforce Editor Preview features policy~~ Allow all SKUs to use BYOK Aug 5, 2025

pierceboggan mentioned this pull request Aug 6, 2025

Unable to use 'Manage Models...' for organization accounts despite model permissions enabled microsoft/vscode#259971

Open

isidorn reviewed Aug 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow all SKUs to use BYOK #242

Allow all SKUs to use BYOK #242

pierceboggan commented Jul 14, 2025 •

edited

Loading

Uh oh!

isidorn Jul 15, 2025

Uh oh!

isidorn Jul 15, 2025

Uh oh!

DanielRosenwasser Jul 17, 2025

Uh oh!

isidorn Jul 15, 2025

Uh oh!

isidorn commented Jul 15, 2025

Uh oh!

DanielRosenwasser left a comment

Uh oh!

DanielRosenwasser Jul 17, 2025

Uh oh!

DanielRosenwasser Jul 17, 2025

Uh oh!

DanielRosenwasser Jul 17, 2025

Uh oh!

pierceboggan commented Aug 5, 2025

Uh oh!

isidorn Aug 7, 2025

Uh oh!

isidorn Aug 7, 2025

Uh oh!

isidorn Aug 7, 2025

Uh oh!

isidorn commented Aug 7, 2025

Uh oh!

Uh oh!

               	};
               }
+              /**

	// Allow for individual users without preview features gating (backward compatibility)
	// Allow for individual users without preview feature-gating (backward compatibility)

	* @returns true if BYOK should be enabled for this user
	* @returns whether BYOK should be enabled for this user

Allow all SKUs to use BYOK #242

Are you sure you want to change the base?

Allow all SKUs to use BYOK #242

Conversation

pierceboggan commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

isidorn commented Jul 15, 2025

Uh oh!

DanielRosenwasser left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pierceboggan commented Aug 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

isidorn commented Aug 7, 2025

Uh oh!

Uh oh!

pierceboggan commented Jul 14, 2025 •

edited

Loading