src/vs/platform/agentHost/common/agentHostResourceService.ts
168 LOC · 163 covered · 5 uncovered · 2 ranges · 58 concepts · 1 introducers · 33 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
>
/*---------------------------------------------------------------------------------------------
agentHostResourceService.ts ×28
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 { IDisposable } from '../../../base/common/lifecycle.js';
8
>
import { IObservable } from '../../../base/common/observable.js';
9
>
import { URI } from '../../../base/common/uri.js';
10
>
import { createDecorator } from '../../instantiation/common/instantiation.js';
11
>
import {
12
>
DirectoryEntry,
13
>
ResourceCopyParams, ResourceDeleteParams, ResourceMkdirParams, ResourceMoveParams,
14
>
ResourceRequestParams, ResourceResolveParams, ResourceResolveResult, ResourceWriteParams,
15
>
} from './state/protocol/commands.js';
16
>
17
>
/**
18
>
* Stable sentinel address used for the in-process local agent host. Keyed
19
>
* persisted grants in user settings live under this name so that "Always
20
>
* allow" survives window reloads.
21
>
*/
22
>
export const LOCAL_AGENT_HOST_ADDRESS = 'local';
23
>
24
>
/** Configuration key for persisted per-host filesystem grants. */
25
>
export const AgentHostLocalFilePermissionsSettingId = 'chat.agentHost.localFilePermissions';
26
>
27
>
/** Persisted access mode for a granted URI. */
28
>
export const enum AgentHostAccessMode {
29
>
Read = 'r',
30
>
ReadWrite = 'rw',
31
>
}
32
>
33
>
/**
34
>
* Persisted shape of {@link AgentHostLocalFilePermissionsSettingId}:
35
>
* `{ [normalizedAddress]: { [uriString]: 'r' | 'rw' } }`.
36
>
*/
37
>
export type AgentHostPermissionsSetting = Record<string, Record<string, AgentHostAccessMode>>;
38
>
39
>
/**
40
>
* Capability a request needs from the user. The protocol-level `read` and
41
>
* `write` flags are split into one or two of these requests.
42
>
*/
43
>
export const enum AgentHostPermissionMode {
44
>
Read = 'read',
45
>
Write = 'write',
46
>
}
47
>
48
>
/** A single pending permission request awaiting user input. */
49
>
export interface IPendingResourceRequest {
50
>
readonly id: string;
51
>
readonly address: string;
52
>
readonly uri: URI;
53
>
readonly mode: AgentHostPermissionMode;
54
>
/** Approve and remember the grant in user settings. */
55
>
allowAlways(): void;
56
>
/**
57
>
* Approve the request and remember it in memory for the lifetime of the
58
>
* connection (cleared on connection close or window reload).
59
>
*/
60
>
allow(): void;
61
>
/** Reject this request. */
62
>
deny(): void;
63
>
}
64
>
65
>
/**
66
>
* Thrown by gated FS operations on {@link IAgentHostResourceService} when
67
>
* the calling address lacks the required permission. Carries the
68
>
* {@link ResourceRequestParams} that, if approved, would unlock the
69
>
* operation, so wire adapters can echo it back to the agent host inside a
70
>
* `PermissionDenied` frame and let the host run the standard
71
>
* `resourceRequest` → retry loop.
72
>
*/
73
>
export class AgentHostResourcePermissionError extends Error {
74
>
constructor(public readonly request: ResourceRequestParams | undefined) {
75
super(request
76
? `Access to ${request.uri} is not granted.`
77
: 'Access to the requested resource is not granted.');
78
this.name = 'AgentHostResourcePermissionError';
79
}
81
>
82
>
export interface IResourceReadResult {
83
>
readonly bytes: VSBuffer;
84
>
}
85
>
86
>
export interface IResourceListResult {
87
>
readonly entries: readonly DirectoryEntry[];
88
>
}
89
>
90
>
export const IAgentHostResourceService = createDecorator<IAgentHostResourceService>('agentHostResourceService');
91
>
92
>
/**
93
>
* Single owner of agent-host-facing filesystem operations and the
94
>
* permission policy that gates them. Combines what were previously two
95
>
* services (`IAgentHostPermissionService` + `IAgentHostVirtualResourceProvider`)
96
>
* into one consistent interface used by both the in-process local channel
97
>
* and the remote protocol client.
98
>
*
99
>
* Each FS method is gated by a permission check keyed on `address`: a
100
>
* normalized network host for remote agent hosts, or
101
>
* {@link LOCAL_AGENT_HOST_ADDRESS} for the local utility-process host.
102
>
* Denied operations throw {@link AgentHostResourcePermissionError} carrying
103
>
* the {@link ResourceRequestParams} that, if granted, would unlock the
104
>
* operation.
105
>
*
106
>
* Read operations transparently fall back to virtual content (untitled
107
>
* documents, notebook cells, ...) when the local file service cannot
108
>
* resolve the URI.
109
>
*/
110
>
export interface IAgentHostResourceService {
111
>
readonly _serviceBrand: undefined;
112
>
113
>
// ---- Gated filesystem operations ---------------------------------------
114
>
115
>
list(address: string, uri: URI): Promise<IResourceListResult>;
116
>
read(address: string, uri: URI): Promise<IResourceReadResult>;
117
>
write(address: string, params: ResourceWriteParams): Promise<void>;
118
>
del(address: string, params: ResourceDeleteParams): Promise<void>;
119
>
move(address: string, params: ResourceMoveParams): Promise<void>;
120
>
copy(address: string, params: ResourceCopyParams): Promise<void>;
121
>
resolve(address: string, params: ResourceResolveParams): Promise<ResourceResolveResult>;
122
>
mkdir(address: string, params: ResourceMkdirParams): Promise<void>;
123
>
124
>
// ---- Permission requests / observables (UI) ----------------------------
125
>
126
>
/**
127
>
* Returns whether {@link uri} is already granted for {@link mode} on
128
>
* {@link address}. Useful as a pre-check before sending data to a host
129
>
* that will read it back. The same gating runs implicitly inside every
130
>
* FS method on this service.
131
>
*/
132
>
check(address: string, uri: URI, mode: AgentHostPermissionMode): Promise<boolean>;
133
>
134
>
/**
135
>
* Handle an inbound `resourceRequest` from a host. Resolves once access
136
>
* is granted (immediately, if already covered); rejects with a
137
>
* `CancellationError` if the user denies or the connection closes.
138
>
*/
139
>
request(address: string, params: ResourceRequestParams): Promise<void>;
140
>
141
>
/** Per-address observable of pending requests for UI surfaces. */
142
>
pendingFor(address: string): IObservable<readonly IPendingResourceRequest[]>;
143
>
144
>
/** Observable of all pending requests across every address. */
145
>
readonly allPending: IObservable<readonly IPendingResourceRequest[]>;
146
>
147
>
/**
148
>
* Find a pending request by id, across all addresses. Returns
149
>
* `undefined` once the request has been resolved or rejected.
150
>
*/
151
>
findPending(id: string): IPendingResourceRequest | undefined;
152
>
153
>
// ---- Implicit grants and lifecycle -------------------------------------
154
>
155
>
/**
156
>
* Register an implicit read grant for {@link uri} (and descendants) on
157
>
* {@link address}. Used by call sites that are about to send a URI to a
158
>
* host and therefore expect that host to read it back. The returned
159
>
* disposable revokes the grant.
160
>
*/
161
>
grantImplicitRead(address: string, uri: URI): IDisposable;
162
>
163
>
/**
164
>
* Notify that the connection at {@link address} has closed. Drops all
165
>
* implicit grants and rejects any outstanding pending requests.
166
>
*/
167
>
connectionClosed(address: string): void;
168
>
}