1
>
/*---------------------------------------------------------------------------------------------
agentHostFileSystemProvider.ts
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 { decodeBase64, VSBuffer } from '../../../base/common/buffer.js';
7
>
import { disposableTimeout } from '../../../base/common/async.js';
8
>
import { Emitter, Event } from '../../../base/common/event.js';
9
>
import { Disposable, DisposableStore, IDisposable, MutableDisposable, toDisposable } from '../../../base/common/lifecycle.js';
10
>
import { URI } from '../../../base/common/uri.js';
11
>
import { createFileSystemProviderError, FileChangeType, FilePermission, FileSystemProviderCapabilities, FileSystemProviderErrorCode, FileType, IFileChange, IFileDeleteOptions, IFileOverwriteOptions, IFileSystemProvider, IFileSystemProviderWithFileRealpathCapability, IFileWriteOptions, IStat, IWatchOptions } from '../../files/common/files.js';
12
>
import { fromAgentHostUri, toAgentHostUri } from './agentHostUri.js';
13
>
import { ContentEncoding, type CreateResourceWatchParams, type DirectoryEntry, type ResourceCopyParams, type ResourceCopyResult, type ResourceDeleteParams, type ResourceDeleteResult, type ResourceListResult, type ResourceMkdirParams, type ResourceMkdirResult, type ResourceMoveParams, type ResourceMoveResult, type ResourceReadResult, type ResourceRequestParams, type ResourceRequestResult, type ResourceResolveParams, type ResourceResolveResult, type ResourceWriteParams, type ResourceWriteResult } from './state/protocol/commands.js';
14
>
import { AhpErrorCodes } from './state/protocol/errors.js';
15
>
import { ProtocolError } from './state/sessionProtocol.js';
16
>
import { ActionType, type ActionEnvelope } from './state/sessionActions.js';
17
>
import { ROOT_STATE_URI } from './state/sessionState.js';
18
>
19
>
/**
20
>
* Interface for performing resource operations on a remote endpoint.
21
>
*
22
>
* Both {@link IAgentConnection} (client→server) and client-exposed
23
>
* filesystems (server→client) satisfy this contract.
24
>
*/
25
>
export interface IRemoteFilesystemConnection {
26
>
resourceList(uri: URI): Promise<ResourceListResult>;
27
>
resourceRead(uri: URI): Promise<ResourceReadResult>;
28
>
resourceWrite(params: ResourceWriteParams): Promise<ResourceWriteResult>;
29
>
resourceDelete(params: ResourceDeleteParams): Promise<ResourceDeleteResult>;
30
>
resourceMove(params: ResourceMoveParams): Promise<ResourceMoveResult>;
31
>
/** Copy a resource on the remote endpoint. */
32
>
resourceCopy(params: ResourceCopyParams): Promise<ResourceCopyResult>;
33
>
/**
34
>
* Negotiate access to a resource the receiver mediates. Optional because
35
>
* not every connection in the codebase carries one — only the agent-host
36
>
* server-to-client direction needs to send `resourceRequest` today.
37
>
*/
38
>
resourceRequest?(params: ResourceRequestParams): Promise<ResourceRequestResult>;
39
>
/** Resolve (stat + realpath) a resource on the remote endpoint. */
40
>
resourceResolve(params: ResourceResolveParams): Promise<ResourceResolveResult>;
41
>
/** Create a directory on the remote endpoint (mkdir -p semantics). */
42
>
resourceMkdir(params: ResourceMkdirParams): Promise<ResourceMkdirResult>;
43
>
/**
44
>
* Start a file-system watcher on the remote endpoint and return a
45
>
* handle whose `onDidChange` event fires for every change the remote
46
>
* reports under the watched root. Disposing the handle unsubscribes
47
>
* the watch (subject to the receiver's grace window).
48
>
*
49
>
* Optional: implementations without subscription machinery omit it; the
50
>
* filesystem provider degrades to a no-op `watch()` in that case.
51
>
*/
52
>
watchResource?(params: CreateResourceWatchParams): Promise<IRemoteWatchHandle>;
53
>
}
54
>
55
>
/**
56
>
* Handle for a remote file-system watcher returned by
57
>
* {@link IRemoteFilesystemConnection.watchResource}. Mirrors the shape
58
>
* of `IFileSystemWatcher` from `../../files/common/files.js` so the FS
59
>
* provider can plug events straight into its own `onDidChangeFile`
60
>
* emitter.
61
>
*/
62
>
export interface IRemoteWatchHandle extends IDisposable {
63
>
readonly onDidChange: Event<readonly IFileChange[]>;
64
>
}
65
>
66
>
/**
67
>
* Shared implementation of {@link IAgentConnection.watchResource} —
68
>
* bundles `createResourceWatch` + `subscribe` + a per-channel listener
69
>
* on the action stream into an {@link IRemoteWatchHandle}. Used by
70
>
* every transport that exposes those four primitives so we don't need
71
>
* to duplicate the wire bookkeeping in each `IAgentConnection`
72
>
* implementation.
73
>
*/
74
export async function createRemoteWatchHandle(
75
primitives: {