fileService.ts ×18

Frontier kind: Code frontier

unlabeled · c_67e2d166e00d

1763 tests · 10819 LOC · 44 files · introduces 0 tests · 102 LOC · 2 files

Introduces — evidence that enters the hierarchy at this concept

Code
22 ranges102 lines · 2 files
Tests
0 tests

Contains — complete concept membership

All code (extent)
1579 ranges10819 lines · 44 files · Browse complete extent
All tests (intent)
1763 testsBrowse complete intent

Neighbourhood graph

The orange circle is the focus. Violet and green circles are every ancestor and descendant, broader and narrower, at any distance; blue squares and pink diamonds are the introduced files and exact introduced tests of every visible concept, not only the focus's. Arrows point from broader to narrower concepts and bridge only concepts omitted from this view. Undirected links show source or test introduction. Concept and file size follows LOC; exact test nodes use test-count units.

Introduced files, introduced tests, and structurally relevant concept specialization

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 native relationship evidence on this page.

Graph controls are ready.

Interactive rendering requires JavaScript and WebGL. Use the native relationship evidence on this page while the interactive map is unavailable.

Native relationship evidence

Every exact file and test below is linked only from the concept that introduces it.

Introduced tests

Every collected test enters the hierarchy at exactly one concept.

No tests are introduced at this concept. Its intent tests are introduced by other concepts.

Introduced code

Every collected source range enters the hierarchy at exactly one concept.

2 files ranked by introduced lines: 102 introduced LOC across 22 ranges. Expand a file to inspect source; the > gutter marks introduced lines.

src/vs/platform/files/common/fileService.ts 70 introduced LOC · 18 ranges

Open complete file

1 > /*--------------------------------------------------------------------------------------------- fileService.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 { coalesce } from '../../../base/common/arrays.js';
7 > import { Promises, ResourceQueue } from '../../../base/common/async.js';
8 > import { bufferedStreamToBuffer, bufferToReadable, newWriteableBufferStream, readableToBuffer, streamToBuffer, VSBuffer, VSBufferReadable, VSBufferReadableBufferedStream, VSBufferReadableStream } from '../../../base/common/buffer.js';
9 > import { CancellationToken, CancellationTokenSource } from '../../../base/common/cancellation.js';
10 > import { Emitter } from '../../../base/common/event.js';
11 > import { hash } from '../../../base/common/hash.js';
12 > import { Iterable } from '../../../base/common/iterator.js';
13 > import { Disposable, DisposableStore, dispose, IDisposable, toDisposable } from '../../../base/common/lifecycle.js';
14 > import { TernarySearchTree } from '../../../base/common/ternarySearchTree.js';
15 > import { Schemas } from '../../../base/common/network.js';
16 > import { mark } from '../../../base/common/performance.js';
17 > import { extUri, extUriIgnorePathCase, IExtUri, isAbsolutePath } from '../../../base/common/resources.js';
18 > import { consumeStream, isReadableBufferedStream, isReadableStream, listenStream, newWriteableStream, peekReadable, peekStream, transform } from '../../../base/common/stream.js';
19 > import { URI } from '../../../base/common/uri.js';
20 > import { localize } from '../../../nls.js';
21 > import { ensureFileSystemProviderError, etag, ETAG_DISABLED, FileChangesEvent, IFileDeleteOptions, FileOperation, FileOperationError, FileOperationEvent, FileOperationResult, FilePermission, FileSystemProviderCapabilities, FileSystemProviderErrorCode, FileType, hasFileAppendCapability, hasFileAtomicReadCapability, hasFileFolderCopyCapability, hasFileReadStreamCapability, hasOpenReadWriteCloseCapability, hasReadWriteCapability, ICreateFileOptions, IFileContent, IFileService, IFileStat, IFileStatWithMetadata, IFileStreamContent, IFileSystemProvider, IFileSystemProviderActivationEvent, IFileSystemProviderCapabilitiesChangeEvent, IFileSystemProviderRegistrationEvent, IFileSystemProviderWithFileAtomicReadCapability, IFileSystemProviderWithFileReadStreamCapability, IFileSystemProviderWithFileReadWriteCapability, IFileSystemProviderWithOpenReadWriteCloseCapability, IReadFileOptions, IReadFileStreamOptions, IResolveFileOptions, IFileStatResult, IFileStatResultWithMetadata, IResolveMetadataFileOptions, IStat, IFileStatWithPartialMetadata, IWatchOptions, IWriteFileOptions, NotModifiedSinceFileOperationError, toFileOperationResult, toFileSystemProviderErrorCode, hasFileCloneCapability, TooLargeFileOperationError, hasFileAtomicDeleteCapability, hasFileAtomicWriteCapability, IWatchOptionsWithCorrelation, IFileSystemWatcher, IWatchOptionsWithoutCorrelation, hasFileRealpathCapability } from './files.js';
22 > import { readFileIntoStream } from './io.js';
23 > import { ILogService } from '../../log/common/log.js';
24 > import { ErrorNoTelemetry } from '../../../base/common/errors.js';
25 >
26 > export class FileService extends Disposable implements IFileService {
27 >
28 > declare readonly _serviceBrand: undefined;
29 >
30 > // Choose a buffer size that is a balance between memory needs and
31 > // manageable IPC overhead. The larger the buffer size, the less
32 > // roundtrips we have to do for reading/writing data.
33 > private readonly BUFFER_SIZE = 256 * 1024;
34 >
35 > constructor(@ILogService private readonly logService: ILogService) {
36 super();
37 }
1264
1265 private readonly writeQueue = this._register(new ResourceQueue());
1267 > private async doWriteBuffered(provider: IFileSystemProviderWithOpenReadWriteCloseCapability, resource: URI, options: IWriteFileOptions | undefined, readableOrStreamOrBufferedStream: VSBufferReadable | VSBufferReadableStream | VSBufferReadableBufferedStream): Promise<void> {
1268 return this.writeQueue.queueFor(resource, async () => {
1269
1287 }, this.getExtUri(provider).providerExtUri);
1288 }
1290 > private async doWriteStreamBufferedQueued(provider: IFileSystemProviderWithOpenReadWriteCloseCapability, handle: number, streamOrBufferedStream: VSBufferReadableStream | VSBufferReadableBufferedStream): Promise<void> {
1291 let posInFile = 0;
1292 let stream: VSBufferReadableStream;
1341 });
1342 }
1344 > private async doWriteReadableBufferedQueued(provider: IFileSystemProviderWithOpenReadWriteCloseCapability, handle: number, readable: VSBufferReadable): Promise<void> {
1345 let posInFile = 0;
1346
1352 }
1353 }
1355 > private async doWriteBuffer(provider: IFileSystemProviderWithOpenReadWriteCloseCapability, handle: number, buffer: VSBuffer, length: number, posInFile: number, posInBuffer: number): Promise<void> {
1356 let totalBytesWritten = 0;
1357 while (totalBytesWritten < length) {
1362 }
1363 }
1365 > private async doWriteUnbuffered(provider: IFileSystemProviderWithFileReadWriteCapability, resource: URI, options: IWriteFileOptions | undefined, bufferOrReadableOrStreamOrBufferedStream: VSBuffer | VSBufferReadable | VSBufferReadableStream | VSBufferReadableBufferedStream): Promise<void> {
1366 return this.writeQueue.queueFor(resource, () => this.doWriteUnbufferedQueued(provider, resource, options, bufferOrReadableOrStreamOrBufferedStream), this.getExtUri(provider).providerExtUri);
1367 }
1369 > private async doWriteUnbufferedQueued(provider: IFileSystemProviderWithFileReadWriteCapability, resource: URI, options: IWriteFileOptions | undefined, bufferOrReadableOrStreamOrBufferedStream: VSBuffer | VSBufferReadable | VSBufferReadableStream | VSBufferReadableBufferedStream): Promise<void> {
1370 let buffer: VSBuffer;
1371 if (bufferOrReadableOrStreamOrBufferedStream instanceof VSBuffer) {
1382 await provider.writeFile(resource, buffer.buffer, { create: true, overwrite: true, unlock: options?.unlock ?? false, atomic: options?.atomic ?? false, append: options?.append ?? false });
1383 }
1385 > private async doPipeBuffered(sourceProvider: IFileSystemProviderWithOpenReadWriteCloseCapability, source: URI, targetProvider: IFileSystemProviderWithOpenReadWriteCloseCapability, target: URI): Promise<void> {
1386 return this.writeQueue.queueFor(target, () => this.doPipeBufferedQueued(sourceProvider, source, targetProvider, target), this.getExtUri(targetProvider).providerExtUri);
1387 }
1389 > private async doPipeBufferedQueued(sourceProvider: IFileSystemProviderWithOpenReadWriteCloseCapability, source: URI, targetProvider: IFileSystemProviderWithOpenReadWriteCloseCapability, target: URI): Promise<void> {
1390 let sourceHandle: number | undefined = undefined;
1391 let targetHandle: number | undefined = undefined;
1428 }
1429 }
1431 > private async doPipeUnbuffered(sourceProvider: IFileSystemProviderWithFileReadWriteCapability, source: URI, targetProvider: IFileSystemProviderWithFileReadWriteCapability, target: URI): Promise<void> {
1432 return this.writeQueue.queueFor(target, () => this.doPipeUnbufferedQueued(sourceProvider, source, targetProvider, target), this.getExtUri(targetProvider).providerExtUri);
1433 }
1435 > private async doPipeUnbufferedQueued(sourceProvider: IFileSystemProviderWithFileReadWriteCapability, source: URI, targetProvider: IFileSystemProviderWithFileReadWriteCapability, target: URI): Promise<void> {
1436 return targetProvider.writeFile(target, await sourceProvider.readFile(source), { create: true, overwrite: true, unlock: false, atomic: false });
1437 }
1439 > private async doPipeUnbufferedToBuffered(sourceProvider: IFileSystemProviderWithFileReadWriteCapability, source: URI, targetProvider: IFileSystemProviderWithOpenReadWriteCloseCapability, target: URI): Promise<void> {
1440 return this.writeQueue.queueFor(target, () => this.doPipeUnbufferedToBufferedQueued(sourceProvider, source, targetProvider, target), this.getExtUri(targetProvider).providerExtUri);
1441 }
1443 > private async doPipeUnbufferedToBufferedQueued(sourceProvider: IFileSystemProviderWithFileReadWriteCapability, source: URI, targetProvider: IFileSystemProviderWithOpenReadWriteCloseCapability, target: URI): Promise<void> {
1444
1445 // Open handle
1456 }
1457 }
1459 > private async doPipeBufferedToUnbuffered(sourceProvider: IFileSystemProviderWithOpenReadWriteCloseCapability, source: URI, targetProvider: IFileSystemProviderWithFileReadWriteCapability, target: URI): Promise<void> {
1460
1461 // Read buffer via stream buffered
1465 await this.doWriteUnbuffered(targetProvider, target, undefined, buffer);
1466 }
1468 > protected throwIfFileSystemIsReadonly<T extends IFileSystemProvider>(provider: T, resource: URI): T {
1469 if (provider.capabilities & FileSystemProviderCapabilities.Readonly) {
1470 throw new FileOperationError(localize('err.readonly', "Unable to modify read-only file '{0}'", this.resourceForError(resource)), FileOperationResult.FILE_PERMISSION_DENIED);
1473 return provider;
1474 }
1476 > private throwIfFileIsReadonly(resource: URI, stat: IStat): void {
1477 if ((stat.permissions ?? 0) & FilePermission.Readonly) {
1478 throw new FileOperationError(localize('err.readonly', "Unable to modify read-only file '{0}'", this.resourceForError(resource)), FileOperationResult.FILE_PERMISSION_DENIED);
1479 }
1480 }
1482 > private resourceForError(resource: URI): string {
1483 if (resource.scheme === Schemas.file) {
1484 return resource.fsPath;
1487 return resource.toString(true);
1488 }
1490 > //#endregion
1491 > }
src/vs/platform/files/common/io.ts 32 introduced LOC · 4 ranges

Open complete file

1 > /*--------------------------------------------------------------------------------------------- io.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 { VSBuffer } from '../../../base/common/buffer.js';
7 > import { CancellationToken } from '../../../base/common/cancellation.js';
8 > import { canceled } from '../../../base/common/errors.js';
9 > import { IDataTransformer, IErrorTransformer, WriteableStream } from '../../../base/common/stream.js';
10 > import { URI } from '../../../base/common/uri.js';
11 > import { localize } from '../../../nls.js';
12 > import { createFileSystemProviderError, ensureFileSystemProviderError, IFileReadStreamOptions, FileSystemProviderErrorCode, IFileSystemProviderWithOpenReadWriteCloseCapability } from './files.js';
13 >
14 > export interface ICreateReadStreamOptions extends IFileReadStreamOptions {
15 >
16 > /**
17 > * The size of the buffer to use before sending to the stream.
18 > */
19 > readonly bufferSize: number;
20 >
21 > /**
22 > * Allows to massage any possibly error that happens during reading.
23 > */
24 > readonly errorTransformer?: IErrorTransformer;
25 > }
26 >
27 > /**
28 > * A helper to read a file from a provider with open/read/close capability into a stream.
29 > */
30 export async function readFileIntoStream<T>(
31 provider: IFileSystemProviderWithOpenReadWriteCloseCapability,
54 }
55 }
56 > io.ts
57 async function doReadFileIntoStream<T>(provider: IFileSystemProviderWithOpenReadWriteCloseCapability, resource: URI, target: WriteableStream<T>, transformer: IDataTransformer<VSBuffer, T>, options: ICreateReadStreamOptions, token: CancellationToken): Promise<void> {
58
114 }
115 }
116 > io.ts
117 function throwIfCancelled(token: CancellationToken): boolean {
118 if (token.isCancellationRequested) {
122 return true;
123 }
124 > io.ts
125 function throwIfTooLarge(totalBytesRead: number, options: ICreateReadStreamOptions): boolean {
126