src/vs/platform/agentHost/node/shared/sessionPluginBundler.ts
184 LOC · 166 covered · 18 uncovered · 29 ranges · 54 concepts · 9 introducers · 34 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
>
/*---------------------------------------------------------------------------------------------
sessionPluginBundler.ts ×6
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 { VSBuffer } from '../../../../base/common/buffer.js';
7
>
import { CancellationToken } from '../../../../base/common/cancellation.js';
8
>
import { hash } from '../../../../base/common/hash.js';
9
>
import { Disposable } from '../../../../base/common/lifecycle.js';
10
>
import { basename, dirname } from '../../../../base/common/resources.js';
11
>
import { URI } from '../../../../base/common/uri.js';
12
>
import { IFileService } from '../../../files/common/files.js';
13
>
import { IAgentPluginManager } from '../../common/agentPluginManager.js';
14
>
import { customizationId, type ClientPluginCustomization } from '../../common/state/sessionState.js';
15
>
import { CustomizationType, type URI as ProtocolURI } from '../../common/state/protocol/state.js';
16
>
import { DiscoveredType, type IDiscoveredDirectory } from '../copilot/sessionCustomizationDiscovery.js';
17
>
18
>
const DISPLAY_NAME = 'VS Code Synced Data';
19
>
const HOST_DISCOVERY_DIR = 'host-discovery';
20
>
21
>
const MANIFEST_CONTENT = JSON.stringify({
22
>
name: DISPLAY_NAME,
23
>
description: 'Customization data discovered from this workspace and your home directory',
24
>
}, null, '\t');
25
>
26
>
/**
27
>
* Maps a {@link DiscoveredType} to the plugin sub-directory under which that
28
>
* component type lives in the Open Plugin format.
29
>
*/
30
>
function pluginDirForType(type: DiscoveredType): string | undefined {
sessionPluginBundler.ts ×10
31
>
switch (type) {
32
>
case DiscoveredType.Agent: return 'agents';
33
>
case DiscoveredType.Skill: return 'skills';
34
>
case DiscoveredType.Instruction: return 'rules';
35
>
case DiscoveredType.Hook: return 'hooks';
36
>
case DiscoveredType.AgentInstruction: return undefined;
37
>
}
38
>
}
40
>
interface IBundleResult {
41
>
readonly ref: ClientPluginCustomization;
42
>
}
43
>
44
>
/**
45
>
* Bundles host-discovered customization files into an Open Plugin layout
46
>
* on real disk under `<agentPluginManager.basePath>/host-discovery/<hash>/`.
47
>
*
48
>
* Writing to a real directory (rather than an in-memory provider) is
49
>
* required because the Copilot SDK subprocess receives skill directories
50
>
* and hook commands as on-disk paths via `fsPath`, and because the
51
>
* workbench fetches files through the agent-host filesystem bridge —
52
>
* neither of which can read a host-side in-memory FS.
53
>
*
54
>
* The directory is namespaced by a hash of the working directory so
55
>
* concurrent sessions on different folders don't collide. Repeated
56
>
* `bundle()` calls with identical content reuse the prior bundle (nonce
57
>
* match) and skip the rewrite.
58
>
*/
59
>
export class SessionPluginBundler extends Disposable {
60
>
61
>
private readonly _rootUri: URI;
62
>
private _lastNonce: string | undefined;
63
>
64
>
constructor(
66
>
@IFileService private readonly _fileService: IFileService,
67
>
@IAgentPluginManager pluginManager: IAgentPluginManager,
68
>
) {
69
>
super();
70
>
const authority = `host-${hash(workingDirectory.toString())}`;
71
>
this._rootUri = URI.joinPath(pluginManager.basePath, HOST_DISCOVERY_DIR, authority);
72
>
}
74
>
get rootUri(): URI {
76
>
}
78
>
get lastNonce(): string | undefined {
79
return this._lastNonce;
80
}
82
>
/**
83
>
* Bundles the given files into the on-disk plugin directory.
84
>
*
85
>
* Overwrites any previous bundle for this working directory. Returns a
86
>
* {@link ClientPluginCustomization} pointing at the on-disk plugin root
87
>
* with a content-based nonce, or `undefined` when there are no files or
88
>
* cancellation was requested.
89
>
*/
90
>
async bundle(directories: readonly IDiscoveredDirectory[], token: CancellationToken = CancellationToken.None): Promise<IBundleResult | undefined> {
93
>
}
95
>
const hashParts: string[] = [];
96
>
const files: { readonly destUri: URI; readonly content: VSBuffer }[] = [];
97
>
98
>
for (const discoveredDirectory of directories) {
99
>
const dir = pluginDirForType(discoveredDirectory.type);
100
>
if (!dir) {
101
continue; // do not bundle agent instructions
102
}
105
>
const fileName = basename(fileUri);
106
>
107
>
let destUri: URI;
108
>
let hashKey: string;
109
>
if (discoveredDirectory.type === DiscoveredType.Skill) {
111
>
// containing directory name so multiple skills don't collide.
112
>
const skillDirName = basename(dirname(fileUri));
113
>
destUri = URI.joinPath(this._rootUri, dir, skillDirName, fileName);
114
>
hashKey = `${dir}/${skillDirName}/${fileName}`;
116
>
destUri = URI.joinPath(this._rootUri, dir, fileName);
117
>
hashKey = `${dir}/${fileName}`;
118
>
}
119
>
120
>
const content = await this._fileService.readFile(fileUri);
121
>
if (token.isCancellationRequested) {
122
return undefined;
123
}
125
>
hashParts.push(`${hashKey}:${content.value.toString()}`);
126
>
}
128
>
if (token.isCancellationRequested) {
129
return undefined;
130
}
132
>
hashParts.sort();
133
>
const nonce = String(hash(hashParts.join('\n')));
134
>
135
>
const rootUriString = this._rootUri.toString() as ProtocolURI;
136
>
const result = {
137
>
ref: {
138
>
type: CustomizationType.Plugin,
139
>
id: customizationId(rootUriString),
140
>
uri: rootUriString,
141
>
name: DISPLAY_NAME,
142
>
enabled: true,
143
>
nonce,
144
>
},
145
>
} satisfies IBundleResult;
146
>
147
>
if (this._lastNonce === nonce) {
149
>
}
151
>
try {
152
>
await this._fileService.del(this._rootUri, { recursive: true });
153
>
} catch {
154
>
// Directory may not exist on first bundle.
155
>
}
156
>
if (token.isCancellationRequested) {
157
return undefined;
158
}
160
>
const manifestUri = URI.joinPath(this._rootUri, '.plugin', 'plugin.json');
161
>
await this._fileService.createFolder(dirname(manifestUri));
162
>
if (token.isCancellationRequested) {
163
return undefined;
164
}
165
>
await this._fileService.writeFile(manifestUri, VSBuffer.fromString(MANIFEST_CONTENT));
sessionPluginBundler.ts ×10
166
>
if (token.isCancellationRequested) {
167
return undefined;
168
}
170
>
for (const file of files) {
172
>
if (token.isCancellationRequested) {
173
return undefined;
174
}
176
>
if (token.isCancellationRequested) {
177
return undefined;
178
}
181
>
this._lastNonce = nonce;
182
>
return result;