src/vs/platform/agentHost/node/agentHostGitHubEndpointService.ts
127 LOC · 125 covered · 2 uncovered · 19 ranges · 2595 concepts · 7 introducers · 1270 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
agentHostGitHubEndpointService.ts ×9
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { Emitter, Event } from '../../../base/common/event.js';
7
>
import { Disposable } from '../../../base/common/lifecycle.js';
8
>
import { createDecorator } from '../../instantiation/common/instantiation.js';
9
>
import { ILogService } from '../../log/common/log.js';
10
>
import { AgentHostConfigKey, agentHostCustomizationConfigSchema } from '../common/agentHostCustomizationConfig.js';
11
>
import { deriveGitHubEndpoints, gitHubCopilotResource, gitHubRepoResource, IGitHubEndpoints } from '../common/githubEndpoints.js';
12
>
import { ProtectedResourceMetadata } from '../common/state/protocol/state.js';
13
>
import { IAgentConfigurationService } from './agentConfigurationService.js';
14
>
15
>
export const IAgentHostGitHubEndpointService = createDecorator<IAgentHostGitHubEndpointService>('agentHostGitHubEndpointService');
16
>
17
>
/**
18
>
* Single source of truth for the GitHub endpoints (protected resources + REST /
19
>
* GraphQL hosts) the agent host talks to. Computed from the optional
20
>
* `githubEnterpriseUri` root config so that every consumer — agent
21
>
* `authenticate` / `getProtectedResources`, changeset operation `getAuthToken`
22
>
* lookups, and the REST client — agrees on the same resource identifiers and API
23
>
* base. With no enterprise URI configured, the values are byte-for-byte the
24
>
* github.com defaults.
25
>
*/
26
>
export interface IAgentHostGitHubEndpointService {
27
>
readonly _serviceBrand: undefined;
28
>
29
>
/**
30
>
* Fires when the configured GitHub endpoints change (e.g. `githubEnterpriseUri`
31
>
* was set, cleared, or repointed). Does NOT fire for unrelated root-config
32
>
* changes.
33
>
*/
34
>
readonly onDidChange: Event<void>;
35
>
36
>
/** The GitHub Copilot protected resource, computed against the configured endpoints. */
37
>
getCopilotResource(): ProtectedResourceMetadata;
38
>
39
>
/** The GitHub repository protected resource, computed against the configured endpoints. */
40
>
getRepoResource(): ProtectedResourceMetadata;
41
>
42
>
/** The REST API base URI (no trailing slash), e.g. `https://api.github.com`. */
43
>
getApiBaseUri(): string;
44
>
45
>
/** The GraphQL endpoint URI, e.g. `https://api.github.com/graphql`. */
46
>
getGraphQlUri(): string;
47
>
48
>
/**
49
>
* The configured GitHub Enterprise host (authority only, e.g. `acme.ghe.com`),
50
>
* or `undefined` for github.com. Used to set `COPILOT_GH_HOST` for the Copilot CLI.
51
>
*/
52
>
getEnterpriseHost(): string | undefined;
53
>
54
>
/**
55
>
* The raw configured GitHub Enterprise base URI (e.g. `https://acme.ghe.com`),
56
>
* or `undefined` for github.com. This is the value the `@vscode/copilot-api`
57
>
* `CAPIClient.updateDomains(..., enterpriseUrlConfig)` expects: it derives the
58
>
* GitHub API host (`api.<host>`) used for `copilot_internal` endpoints (token
59
>
* mint, etc.) from it. Distinct from {@link getApiBaseUri} (the already-derived
60
>
* `api.` host) - the package does that derivation itself.
61
>
*/
62
>
getEnterpriseUri(): string | undefined;
63
>
}
64
>
65
>
export class AgentHostGitHubEndpointService extends Disposable implements IAgentHostGitHubEndpointService {
66
>
67
>
declare readonly _serviceBrand: undefined;
68
>
69
>
private readonly _onDidChange = this._register(new Emitter<void>());
70
>
readonly onDidChange = this._onDidChange.event;
71
>
72
>
private _endpoints: IGitHubEndpoints;
73
>
private _enterpriseUri: string | undefined;
74
>
75
>
constructor(
76
>
@IAgentConfigurationService private readonly _configurationService: IAgentConfigurationService,
agentHostGitHubEndpointService.ts ×3
77
>
@ILogService private readonly _logService: ILogService,
78
>
) {
79
>
super();
80
>
const resolved = this._resolve();
81
>
this._endpoints = resolved.endpoints;
82
>
this._enterpriseUri = resolved.enterpriseUri;
83
>
this._register(this._configurationService.onDidRootConfigChange(() => {
85
>
// `onDidRootConfigChange` fires for every root-config key; only react
86
>
// when the derived GitHub endpoints actually change.
87
>
if (next.endpoints.apiBaseUri === this._endpoints.apiBaseUri
88
>
&& next.endpoints.graphQlUri === this._endpoints.graphQlUri
89
>
&& next.endpoints.oauthServer === this._endpoints.oauthServer) {
90
>
return;
91
>
}
92
>
this._logService.info(`[AgentHost] GitHub endpoints changed (api=${next.endpoints.apiBaseUri})`);
agentHostGitHubEndpointService.ts ×1
93
>
this._endpoints = next.endpoints;
94
>
this._enterpriseUri = next.enterpriseUri;
95
>
this._onDidChange.fire();
97
>
}
99
>
private _resolve(): { endpoints: IGitHubEndpoints; enterpriseUri: string | undefined } {
100
>
const enterpriseUri = this._configurationService.getRootValue(agentHostCustomizationConfigSchema, AgentHostConfigKey.GithubEnterpriseUri);
agentHostGitHubEndpointService.ts ×3
101
>
return { endpoints: deriveGitHubEndpoints(enterpriseUri), enterpriseUri: enterpriseUri || undefined };
102
>
}
104
>
getApiBaseUri(): string {
106
>
}
108
>
getGraphQlUri(): string {
110
>
}
112
>
getEnterpriseHost(): string | undefined {
114
>
}
116
>
getEnterpriseUri(): string | undefined {
117
return this._enterpriseUri;
118
}
120
>
getCopilotResource(): ProtectedResourceMetadata {
122
>
}
124
>
getRepoResource(): ProtectedResourceMetadata {
126
>
}