@theia/filesystem 1.55.1 → 1.57.0-next.112

package/src/common/remote-file-system-provider.ts

@@ -46,7 +46,7 @@ export interface RemoteFileSystemServer extends RpcServer<RemoteFileSystemClient
     open(resource: string, opts: FileOpenOptions): Promise<number>;
     close(fd: number): Promise<void>;
     read(fd: number, pos: number, length: number): Promise<{ bytes: Uint8Array; bytesRead: number; }>;
-    readFileStream(resource: string, opts: FileReadStreamOptions, token: CancellationToken): Promise<number>;
+    readFileStream(resource: string, handle: number, opts: FileReadStreamOptions, token: CancellationToken): Promise<void>;
     readFile(resource: string): Promise<Uint8Array>;
     write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
     writeFile(resource: string, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
@@ -162,6 +162,8 @@ export class RemoteFileSystemProvider implements Required<FileSystemProvider>, D
     protected readonly readyDeferred = new Deferred<void>();
     readonly ready = this.readyDeferred.promise;
 
+    protected streamHandleSeq = 0;
+
     /**
      * Wrapped remote filesystem.
      */
@@ -251,36 +253,35 @@ export class RemoteFileSystemProvider implements Required<FileSystemProvider>, D
 
     readFileStream(resource: URI, opts: FileReadStreamOptions, token: CancellationToken): ReadableStreamEvents<Uint8Array> {
         const capturedError = new Error();
-        // eslint-disable-next-line @typescript-eslint/no-shadow
-        const stream = newWriteableStream<Uint8Array>(data => BinaryBuffer.concat(data.map(data => BinaryBuffer.wrap(data))).buffer);
-        this.server.readFileStream(resource.toString(), opts, token).then(streamHandle => {
+        const stream = newWriteableStream<Uint8Array>(data => BinaryBuffer.concat(data.map(item => BinaryBuffer.wrap(item))).buffer);
+        const streamHandle = this.streamHandleSeq++;
+        const toDispose = new DisposableCollection(
+            token.onCancellationRequested(() => stream.end(cancelled())),
+            this.onFileStreamData(([handle, data]) => {
+                if (streamHandle === handle) {
+                    stream.write(data);
+                }
+            }),
+            this.onFileStreamEnd(([handle, error]) => {
+                if (streamHandle === handle) {
+                    if (error) {
+                        const code = ('code' in error && error.code) || FileSystemProviderErrorCode.Unknown;
+                        const fileOperationError = new FileSystemProviderError(error.message, code);
+                        fileOperationError.name = error.name;
+                        const capturedStack = capturedError.stack || '';
+                        fileOperationError.stack = `${capturedStack}\nCaused by: ${error.stack}`;
+                        stream.end(fileOperationError);
+                    } else {
+                        stream.end();
+                    }
+                }
+            })
+        );
+        stream.on('end', () => toDispose.dispose());
+        this.server.readFileStream(resource.toString(), streamHandle, opts, token).then(() => {
             if (token.isCancellationRequested) {
                 stream.end(cancelled());
-                return;
             }
-            const toDispose = new DisposableCollection(
-                token.onCancellationRequested(() => stream.end(cancelled())),
-                this.onFileStreamData(([handle, data]) => {
-                    if (streamHandle === handle) {
-                        stream.write(data);
-                    }
-                }),
-                this.onFileStreamEnd(([handle, error]) => {
-                    if (streamHandle === handle) {
-                        if (error) {
-                            const code = ('code' in error && error.code) || FileSystemProviderErrorCode.Unknown;
-                            const fileOperationError = new FileSystemProviderError(error.message, code);
-                            fileOperationError.name = error.name;
-                            const capturedStack = capturedError.stack || '';
-                            fileOperationError.stack = `${capturedStack}\nCaused by: ${error.stack}`;
-                            stream.end(fileOperationError);
-                        } else {
-                            stream.end();
-                        }
-                    }
-                })
-            );
-            stream.on('end', () => toDispose.dispose());
         }, error => stream.end(error));
         return stream;
     }
@@ -528,11 +529,8 @@ export class FileSystemProviderServer implements RemoteFileSystemServer {
         }
     }
 
-    protected readFileStreamSeq = 0;
-
-    async readFileStream(resource: string, opts: FileReadStreamOptions, token: CancellationToken): Promise<number> {
+    async readFileStream(resource: string, handle: number, opts: FileReadStreamOptions, token: CancellationToken): Promise<void> {
         if (hasFileReadStreamCapability(this.provider)) {
-            const handle = this.readFileStreamSeq++;
             const stream = this.provider.readFileStream(new URI(resource), opts, token);
             stream.on('data', data => this.client?.onFileStreamData(handle, data));
             stream.on('error', error => {
@@ -541,9 +539,9 @@ export class FileSystemProviderServer implements RemoteFileSystemServer {
                 this.client?.onFileStreamEnd(handle, { code, name, message, stack });
             });
             stream.on('end', () => this.client?.onFileStreamEnd(handle, undefined));
-            return handle;
+        } else {
+            throw new Error('not supported');
         }
-        throw new Error('not supported');
     }
 
 }

package/lib/browser-only/browserfs-filesystem-initialization.d.ts

@@ -1,13 +0,0 @@
-import type { FSModule } from 'browserfs/dist/node/core/FS';
-import type { BrowserFSFileSystemProvider } from './browserfs-filesystem-provider';
-import MountableFileSystem from 'browserfs/dist/node/backend/MountableFileSystem';
-export declare const BrowserFSInitialization: unique symbol;
-export interface BrowserFSInitialization {
-    createMountableFileSystem(): Promise<MountableFileSystem>;
-    initializeFS: (fs: FSModule, provider: BrowserFSFileSystemProvider) => Promise<void>;
-}
-export declare class DefaultBrowserFSInitialization implements BrowserFSInitialization {
-    createMountableFileSystem(): Promise<MountableFileSystem>;
-    initializeFS(fs: FSModule, provider: BrowserFSFileSystemProvider): Promise<void>;
-}
-//# sourceMappingURL=browserfs-filesystem-initialization.d.ts.map

package/lib/browser-only/browserfs-filesystem-initialization.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browserfs-filesystem-initialization.d.ts","sourceRoot":"","sources":["../../src/browser-only/browserfs-filesystem-initialization.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAGnF,OAAO,mBAAmB,MAAM,iDAAiD,CAAC;AAElF,eAAO,MAAM,uBAAuB,eAAoC,CAAC;AACzE,MAAM,WAAW,uBAAuB;IACpC,yBAAyB,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAA;IACzD,YAAY,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,2BAA2B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACxF;AAED,qBACa,8BAA+B,YAAW,uBAAuB;IAE1E,yBAAyB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IA0BnD,YAAY,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzF"}

package/lib/browser-only/browserfs-filesystem-initialization.js

@@ -1,55 +0,0 @@
-"use strict";
-// *****************************************************************************
-// Copyright (C) 2023 EclipseSource and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultBrowserFSInitialization = exports.BrowserFSInitialization = void 0;
-const tslib_1 = require("tslib");
-const inversify_1 = require("@theia/core/shared/inversify");
-const browserfs_1 = require("browserfs");
-exports.BrowserFSInitialization = Symbol('BrowserFSInitialization');
-let DefaultBrowserFSInitialization = class DefaultBrowserFSInitialization {
-    createMountableFileSystem() {
-        return new Promise(resolve => {
-            browserfs_1.FileSystem.IndexedDB.Create({}, (e, persistedFS) => {
-                if (e) {
-                    throw e;
-                }
-                if (!persistedFS) {
-                    throw Error('Could not create filesystem');
-                }
-                browserfs_1.FileSystem.MountableFileSystem.Create({
-                    '/home': persistedFS
-                }, (error, mountableFS) => {
-                    if (error) {
-                        throw error;
-                    }
-                    if (!mountableFS) {
-                        throw Error('Could not create filesystem');
-                    }
-                    (0, browserfs_1.initialize)(mountableFS);
-                    resolve(mountableFS);
-                });
-            });
-        });
-    }
-    async initializeFS(fs, provider) {
-    }
-};
-exports.DefaultBrowserFSInitialization = DefaultBrowserFSInitialization;
-exports.DefaultBrowserFSInitialization = DefaultBrowserFSInitialization = tslib_1.__decorate([
-    (0, inversify_1.injectable)()
-], DefaultBrowserFSInitialization);
-//# sourceMappingURL=browserfs-filesystem-initialization.js.map

package/lib/browser-only/browserfs-filesystem-initialization.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"browserfs-filesystem-initialization.js","sourceRoot":"","sources":["../../src/browser-only/browserfs-filesystem-initialization.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,+CAA+C;AAC/C,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;;AAIhF,4DAA0D;AAC1D,yCAAmD;AAGtC,QAAA,uBAAuB,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAOlE,IAAM,8BAA8B,GAApC,MAAM,8BAA8B;IAEvC,yBAAyB;QACrB,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YACzB,sBAAU,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE;gBAC/C,IAAI,CAAC,EAAE,CAAC;oBACJ,MAAM,CAAC,CAAC;gBACZ,CAAC;gBACD,IAAI,CAAC,WAAW,EAAE,CAAC;oBACf,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC;gBAC/C,CAAC;gBACD,sBAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC;oBAClC,OAAO,EAAE,WAAW;iBAEvB,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;oBACtB,IAAI,KAAK,EAAE,CAAC;wBACR,MAAM,KAAK,CAAC;oBAChB,CAAC;oBACD,IAAI,CAAC,WAAW,EAAE,CAAC;wBACf,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC;oBAC/C,CAAC;oBACD,IAAA,sBAAU,EAAC,WAAW,CAAC,CAAC;oBACxB,OAAO,CAAC,WAAW,CAAC,CAAC;gBACzB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,EAAY,EAAE,QAAqC;IAEtE,CAAC;CACJ,CAAA;AA/BY,wEAA8B;yCAA9B,8BAA8B;IAD1C,IAAA,sBAAU,GAAE;GACA,8BAA8B,CA+B1C"}

package/lib/browser-only/browserfs-filesystem-provider.d.ts

@@ -1,46 +0,0 @@
-import { FileChange, FileDeleteOptions, FileOpenOptions, FileOverwriteOptions, FileReadStreamOptions, FileSystemProviderCapabilities, FileSystemProviderWithFileReadWriteCapability, FileType, FileUpdateOptions, FileUpdateResult, FileWriteOptions, Stat, WatchOptions } from '../common/files';
-import { Event, URI, Disposable, CancellationToken } from '@theia/core';
-import { TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
-import { ReadableStreamEvents } from '@theia/core/lib/common/stream';
-import type { FileSystem } from 'browserfs/dist/node/core/file_system';
-import { BrowserFSInitialization } from './browserfs-filesystem-initialization';
-export declare class BrowserFSFileSystemProvider implements FileSystemProviderWithFileReadWriteCapability {
-    readonly initialization: BrowserFSInitialization;
-    capabilities: FileSystemProviderCapabilities;
-    onDidChangeCapabilities: Event<void>;
-    onDidChangeFile: Event<readonly FileChange[]>;
-    onFileWatchError: Event<void>;
-    private mapHandleToPos;
-    private writeHandles;
-    private canFlush;
-    private fs;
-    private mountableFS;
-    private initialized;
-    constructor(initialization: BrowserFSInitialization);
-    mount(mountPoint: string, fs: FileSystem): Promise<void>;
-    watch(_resource: URI, _opts: WatchOptions): Disposable;
-    stat(resource: URI): Promise<Stat>;
-    mkdir(resource: URI): Promise<void>;
-    readdir(resource: URI): Promise<[string, FileType][]>;
-    delete(resource: URI, _opts: FileDeleteOptions): Promise<void>;
-    rename(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void>;
-    copy?(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void>;
-    readFile(resource: URI): Promise<Uint8Array>;
-    writeFile(resource: URI, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
-    readFileStream?(resource: URI, opts: FileReadStreamOptions, token: CancellationToken): ReadableStreamEvents<Uint8Array>;
-    open(resource: URI, opts: FileOpenOptions): Promise<number>;
-    close(fd: number): Promise<void>;
-    read(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
-    write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
-    private doWrite;
-    private normalizePos;
-    private updatePos;
-    access?(resource: URI, mode?: number | undefined): Promise<void>;
-    fsPath?(resource: URI): Promise<string>;
-    updateFile?(resource: URI, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>;
-    private toFilePath;
-    private toType;
-    private promisify;
-    private toFileSystemProviderError;
-}
-//# sourceMappingURL=browserfs-filesystem-provider.d.ts.map

package/lib/browser-only/browserfs-filesystem-provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browserfs-filesystem-provider.d.ts","sourceRoot":"","sources":["../../src/browser-only/browserfs-filesystem-provider.ts"],"names":[],"mappings":"AAwBA,OAAO,EACH,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAC9C,oBAAoB,EAAE,qBAAqB,EAAE,8BAA8B,EAG3E,6CAA6C,EAC7C,QAAQ,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,EAAE,YAAY,EACtF,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,8BAA8B,EAAE,MAAM,mDAAmD,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAGrE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAKvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAGhF,qBACa,2BAA4B,YAAW,6CAA6C;IAahD,QAAQ,CAAC,cAAc,EAAE,uBAAuB;IAZ7F,YAAY,EAAE,8BAA8B,CAAgD;IAC5F,uBAAuB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAc;IAClD,eAAe,EAAE,KAAK,CAAC,SAAS,UAAU,EAAE,CAAC,CAAc;IAC3D,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAc;IAC3C,OAAO,CAAC,cAAc,CAAkC;IACxD,OAAO,CAAC,YAAY,CAA0B;IAC9C,OAAO,CAAC,QAAQ,CAAiB;IAEjC,OAAO,CAAC,EAAE,CAAW;IACrB,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,WAAW,CAAgB;gBAEmB,cAAc,EAAE,uBAAuB;IAiBvF,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9D,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,YAAY,GAAG,UAAU;IAGhD,IAAI,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBlC,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnC,OAAO,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;IAoBrD,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAS9D,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAyCrE,IAAI,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE,QAAQ,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC;IAS5C,SAAS,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC1F,cAAc,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,iBAAiB,GAAG,oBAAoB,CAAC,UAAU,CAAC;IAGjH,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC3D,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBhC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBhG,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAQzF,OAAO;IAsBrB,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,SAAS;IAqBX,MAAM,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,MAAM,CAAC,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC,UAAU,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,8BAA8B,EAAE,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK/H,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,MAAM;IAyBd,OAAO,CAAC,SAAS;IAUjB,OAAO,CAAC,yBAAyB;CA6BpC"}