@theia/filesystem 1.65.0-next.55 → 1.65.0

package/lib/browser-only/opfs-filesystem-provider.js

@@ -20,18 +20,42 @@ const tslib_1 = require("tslib");
 const inversify_1 = require("@theia/core/shared/inversify");
 const files_1 = require("../common/files");
 const core_1 = require("@theia/core");
+const encoding_service_1 = require("@theia/core/lib/common/encoding-service");
+const buffer_1 = require("@theia/core/lib/common/buffer");
+const vscode_languageserver_textdocument_1 = require("vscode-languageserver-textdocument");
+const opfs_worker_1 = require("opfs-worker");
 const opfs_filesystem_initialization_1 = require("./opfs-filesystem-initialization");
+const stream_1 = require("@theia/core/lib/common/stream");
+const io_1 = require("../common/io");
+const file_uri_1 = require("@theia/core/lib/common/file-uri");
 let OPFSFileSystemProvider = class OPFSFileSystemProvider {
     constructor() {
-        this.capabilities = 2 /* FileSystemProviderCapabilities.FileReadWrite */;
+        this.BUFFER_SIZE = 64 * 1024;
+        this.capabilities = 2 /* FileSystemProviderCapabilities.FileReadWrite */ |
+            4 /* FileSystemProviderCapabilities.FileOpenReadWriteClose */ |
+            8 /* FileSystemProviderCapabilities.FileFolderCopy */ |
+            33554432 /* FileSystemProviderCapabilities.Update */;
         this.onDidChangeCapabilities = core_1.Event.None;
         this.onDidChangeFileEmitter = new core_1.Emitter();
         this.onDidChangeFile = this.onDidChangeFileEmitter.event;
         this.onFileWatchError = core_1.Event.None;
+        this.toDispose = new core_1.DisposableCollection(this.onDidChangeFileEmitter);
     }
+    /**
+     * Initializes the OPFS file system provider
+     */
     init() {
         const setup = async () => {
-            this.directoryHandle = await this.initialization.getRootDirectory();
+            const root = await this.initialization.getRootDirectory();
+            const broadcastChannel = this.initialization.getBroadcastChannel();
+            // Set up file change listening via BroadcastChannel
+            broadcastChannel.onmessage = this.handleFileSystemChange.bind(this);
+            // Initialize the file system
+            this.fs = new opfs_worker_1.OPFSFileSystem({
+                root,
+                broadcastChannel,
+                hashAlgorithm: false,
+            });
             await this.initialization.initializeFS(new Proxy(this, {
                 get(target, prop, receiver) {
                     if (prop === 'initialized') {
@@ -44,179 +68,360 @@ let OPFSFileSystemProvider = class OPFSFileSystemProvider {
         };
         this.initialized = setup();
     }
-    watch(_resource, _opts) {
-        return core_1.Disposable.NULL;
+    /**
+     * Watches a resource for file system changes
+     */
+    watch(resource, opts) {
+        if (!resource || !resource.path) {
+            return core_1.Disposable.NULL;
+        }
+        const unwatch = this.fs.watch(formatPath(resource), {
+            recursive: opts.recursive,
+            exclude: opts.excludes,
+        });
+        return core_1.Disposable.create(unwatch);
+    }
+    /**
+     * Creates an index from the map of entries
+     */
+    async createIndex(entries) {
+        const arrayEntries = [];
+        for (const [uri, content] of entries) {
+            arrayEntries.push([formatPath(uri), content]);
+        }
+        await this.fs.createIndex(arrayEntries);
     }
-    async exists(resource) {
+    /**
+     * Retrieves the current file system index
+     */
+    async index() {
+        const opfsIndex = await this.fs.index();
+        const index = new Map();
+        for (const [path, stats] of opfsIndex.entries()) {
+            const uri = new core_1.URI(path);
+            index.set(uri, formatStat(stats));
+        }
+        return index;
+    }
+    /**
+     * Clears the file system
+     */
+    async clear() {
         try {
-            await this.initialized;
-            await this.toFileSystemHandle(resource);
-            return true;
+            await this.fs.clear();
         }
         catch (error) {
+            throw toFileSystemProviderError(error);
+        }
+    }
+    /**
+     * Checks if a resource exists
+     */
+    async exists(resource) {
+        if (!resource || !resource.path) {
             return false;
         }
+        await this.initialized;
+        try {
+            return await this.fs.exists(formatPath(resource));
+        }
+        catch (error) {
+            throw toFileSystemProviderError(error);
+        }
     }
+    /**
+     * Gets file system statistics for a resource
+     */
     async stat(resource) {
+        if (!resource || !resource.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid resource URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
+        await this.initialized;
         try {
-            await this.initialized;
-            const handle = await this.toFileSystemHandle(resource);
-            if (handle.kind === 'file') {
-                const fileHandle = handle;
-                const file = await fileHandle.getFile();
-                return {
-                    type: files_1.FileType.File,
-                    ctime: file.lastModified,
-                    mtime: file.lastModified,
-                    size: file.size
-                };
-            }
-            else if (handle.kind === 'directory') {
-                return {
-                    type: files_1.FileType.Directory,
-                    ctime: 0,
-                    mtime: 0,
-                    size: 0
-                };
-            }
-            throw (0, files_1.createFileSystemProviderError)('Unknown file handle error', files_1.FileSystemProviderErrorCode.Unknown);
+            const path = formatPath(resource);
+            const stats = await this.fs.stat(path);
+            return formatStat(stats);
         }
         catch (error) {
             throw toFileSystemProviderError(error);
         }
     }
+    /**
+     * Creates a directory
+     */
     async mkdir(resource) {
+        if (!resource || !resource.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid resource URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
         await this.initialized;
         try {
-            await this.toFileSystemHandle(resource, { create: true, isDirectory: true });
+            const path = formatPath(resource);
+            await this.fs.mkdir(path, { recursive: true });
             this.onDidChangeFileEmitter.fire([{ resource, type: 1 /* FileChangeType.ADDED */ }]);
         }
         catch (error) {
-            throw toFileSystemProviderError(error, true);
+            throw toFileSystemProviderError(error);
         }
     }
+    /**
+     * Reads directory contents
+     */
     async readdir(resource) {
+        if (!resource || !resource.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid resource URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
         await this.initialized;
         try {
-            // Get the directory handle from the directoryHandle
-            const directoryHandle = await this.toFileSystemHandle(resource, { create: false, isDirectory: true });
-            const result = [];
-            // Iterate through the entries in the directory (files and subdirectories)
-            for await (const [name, handle] of directoryHandle.entries()) {
-                // Determine the type of the entry (file or directory)
-                if (handle.kind === 'file') {
-                    result.push([name, files_1.FileType.File]);
-                }
-                else if (handle.kind === 'directory') {
-                    result.push([name, files_1.FileType.Directory]);
-                }
-            }
-            return result;
+            const path = formatPath(resource);
+            const entries = await this.fs.readDir(path);
+            return entries.map(entry => [
+                entry.name,
+                entry.isFile ? files_1.FileType.File : files_1.FileType.Directory
+            ]);
         }
         catch (error) {
-            throw toFileSystemProviderError(error, true);
+            throw toFileSystemProviderError(error);
         }
     }
-    async delete(resource, _opts) {
+    /**
+     * Deletes a resource
+     */
+    async delete(resource, opts) {
+        if (!resource || !resource.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid resource URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
         await this.initialized;
         try {
-            const parentURI = resource.parent;
-            const parentHandle = await this.toFileSystemHandle(parentURI, { create: false, isDirectory: true });
-            if (parentHandle.kind !== 'directory') {
-                throw (0, files_1.createFileSystemProviderError)(new Error('Parent is not a directory'), files_1.FileSystemProviderErrorCode.FileNotADirectory);
-            }
-            const name = resource.path.base;
-            return parentHandle.removeEntry(name, { recursive: _opts.recursive });
+            const path = formatPath(resource);
+            await this.fs.remove(path, { recursive: opts.recursive });
         }
         catch (error) {
             throw toFileSystemProviderError(error);
         }
-        finally {
-            this.onDidChangeFileEmitter.fire([{ resource, type: 2 /* FileChangeType.DELETED */ }]);
-        }
     }
+    /**
+     * Renames a resource from one location to another
+     */
     async rename(from, to, opts) {
+        if (!from || !from.path || !to || !to.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid source or destination URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
         await this.initialized;
         try {
-            const fromHandle = await this.toFileSystemHandle(from);
-            // Check whether the source is a file or directory
-            if (fromHandle.kind === 'directory') {
-                // Create the new directory and get the handle
-                await this.mkdir(to);
-                const toHandle = await this.toFileSystemHandle(to);
-                await copyDirectoryContents(fromHandle, toHandle);
-                // Delete the old directory
-                await this.delete(from, { recursive: true, useTrash: false });
-            }
-            else {
-                const content = await this.readFile(from);
-                await this.writeFile(to, content, { create: true, overwrite: opts.overwrite });
-                await this.delete(from, { recursive: true, useTrash: false });
-            }
-            this.onDidChangeFileEmitter.fire([{ resource: to, type: 1 /* FileChangeType.ADDED */ }]);
+            const fromPath = formatPath(from);
+            const toPath = formatPath(to);
+            await this.fs.rename(fromPath, toPath, {
+                overwrite: opts.overwrite,
+            });
         }
         catch (error) {
             throw toFileSystemProviderError(error);
         }
     }
+    /**
+     * Copies a resource from one location to another
+     */
+    async copy(from, to, opts) {
+        if (!from || !from.path || !to || !to.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid source or destination URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
+        await this.initialized;
+        try {
+            const fromPath = formatPath(from);
+            const toPath = formatPath(to);
+            await this.fs.copy(fromPath, toPath, {
+                overwrite: opts.overwrite,
+                recursive: true,
+            });
+        }
+        catch (error) {
+            throw toFileSystemProviderError(error);
+        }
+    }
+    /**
+     * Reads file content as binary data
+     */
     async readFile(resource) {
+        if (!resource || !resource.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid resource URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
         await this.initialized;
         try {
-            // Get the file handle from the directoryHandle
-            const fileHandle = await this.toFileSystemHandle(resource, { create: false, isDirectory: false });
-            // Get the file itself (which includes the content)
-            const file = await fileHandle.getFile();
-            // Read the file as an ArrayBuffer and convert it to Uint8Array
-            const arrayBuffer = await file.arrayBuffer();
-            return new Uint8Array(arrayBuffer);
+            return await this.fs.readFile(formatPath(resource), 'binary');
         }
         catch (error) {
-            throw toFileSystemProviderError(error, false);
+            throw toFileSystemProviderError(error);
         }
     }
+    /**
+     * Reads file content as a stream
+     */
+    readFileStream(resource, opts, token) {
+        const stream = (0, stream_1.newWriteableStream)(chunks => buffer_1.BinaryBuffer.concat(chunks.map(chunk => buffer_1.BinaryBuffer.wrap(chunk))).buffer);
+        (0, io_1.readFileIntoStream)(this, resource, stream, data => data.buffer, {
+            ...opts,
+            bufferSize: this.BUFFER_SIZE
+        }, token);
+        return stream;
+    }
+    /**
+     * Writes binary content to a file
+     */
     async writeFile(resource, content, opts) {
         await this.initialized;
-        let writeableHandle = undefined;
+        let handle = undefined;
+        if (!resource || !resource.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid resource URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
+        if (!content || !(content instanceof Uint8Array)) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid content: must be Uint8Array', files_1.FileSystemProviderErrorCode.Unknown);
+        }
         try {
-            // Validate target unless { create: true, overwrite: true }
+            const path = formatPath(resource);
             if (!opts.create || !opts.overwrite) {
-                const fileExists = await this.stat(resource).then(() => true, () => false);
+                const fileExists = await this.fs.exists(path);
                 if (fileExists) {
                     if (!opts.overwrite) {
                         throw (0, files_1.createFileSystemProviderError)('File already exists', files_1.FileSystemProviderErrorCode.FileExists);
                     }
                 }
-                else {
-                    if (!opts.create) {
-                        throw (0, files_1.createFileSystemProviderError)('File does not exist', files_1.FileSystemProviderErrorCode.FileNotFound);
-                    }
+                else if (!opts.create) {
+                    throw (0, files_1.createFileSystemProviderError)('File does not exist', files_1.FileSystemProviderErrorCode.FileNotFound);
                 }
             }
-            const handle = await this.toFileSystemHandle(resource, { create: true, isDirectory: false });
             // Open
-            writeableHandle = await (handle === null || handle === void 0 ? void 0 : handle.createWritable());
+            handle = await this.open(resource, { create: true });
             // Write content at once
-            await (writeableHandle === null || writeableHandle === void 0 ? void 0 : writeableHandle.write(content));
-            this.onDidChangeFileEmitter.fire([{ resource: resource, type: 0 /* FileChangeType.UPDATED */ }]);
+            await this.write(handle, 0, content, 0, content.byteLength);
         }
         catch (error) {
-            throw toFileSystemProviderError(error, false);
+            throw toFileSystemProviderError(error);
         }
         finally {
-            if (typeof writeableHandle !== 'undefined') {
-                await writeableHandle.close();
+            if (typeof handle === 'number') {
+                await this.close(handle);
+            }
+        }
+    }
+    // #region Open/Read/Write/Close Operations
+    /**
+     * Opens a file and returns a file descriptor
+     */
+    async open(resource, opts) {
+        await this.initialized;
+        if (!resource || !resource.path) {
+            throw (0, files_1.createFileSystemProviderError)('Invalid resource URI', files_1.FileSystemProviderErrorCode.FileNotFound);
+        }
+        try {
+            const path = formatPath(resource);
+            const fileExists = await this.fs.exists(path);
+            if (!opts.create && !fileExists) {
+                throw (0, files_1.createFileSystemProviderError)('File does not exist', files_1.FileSystemProviderErrorCode.FileNotFound);
             }
+            const fd = await this.fs.open(path, {
+                create: opts.create,
+                truncate: opts.create
+            });
+            return fd;
+        }
+        catch (error) {
+            throw toFileSystemProviderError(error);
         }
     }
     /**
-     * Returns the FileSystemHandle for the given resource given by a URI.
-     * @param resource URI/path of the resource
-     * @param options Options for the creation of the handle while traversing the path
-     * @returns FileSystemHandle for the given resource
+     * Closes a file descriptor
      */
-    async toFileSystemHandle(resource, options) {
-        const pathParts = resource.path.toString().split(core_1.Path.separator).filter(Boolean);
-        return recursiveFileSystemHandle(this.directoryHandle, pathParts, options);
+    async close(fd) {
+        try {
+            await this.fs.close(fd);
+        }
+        catch (error) {
+            throw toFileSystemProviderError(error);
+        }
+    }
+    /**
+     * Reads data from a file descriptor
+     */
+    async read(fd, pos, data, offset, length) {
+        try {
+            const result = await this.fs.read(fd, data, offset, length, pos);
+            return result.bytesRead;
+        }
+        catch (error) {
+            throw toFileSystemProviderError(error);
+        }
+    }
+    /**
+     * Writes data to a file descriptor
+     */
+    async write(fd, pos, data, offset, length) {
+        try {
+            return await this.fs.write(fd, data, offset, length, pos, true);
+        }
+        catch (error) {
+            throw toFileSystemProviderError(error);
+        }
+    }
+    // #endregion
+    // #region Text File Updates
+    /**
+     * Updates a text file with content changes
+     */
+    async updateFile(resource, changes, opts) {
+        try {
+            const content = await this.readFile(resource);
+            const decoded = this.encodingService.decode(buffer_1.BinaryBuffer.wrap(content), opts.readEncoding);
+            const newContent = vscode_languageserver_textdocument_1.TextDocument.update(vscode_languageserver_textdocument_1.TextDocument.create('', '', 1, decoded), changes, 2).getText();
+            const encoding = await this.encodingService.toResourceEncoding(opts.writeEncoding, {
+                overwriteEncoding: opts.overwriteEncoding,
+                read: async (length) => {
+                    const fd = await this.open(resource, { create: false });
+                    try {
+                        const data = new Uint8Array(length);
+                        await this.read(fd, 0, data, 0, length);
+                        return data;
+                    }
+                    finally {
+                        await this.close(fd);
+                    }
+                }
+            });
+            const encoded = this.encodingService.encode(newContent, encoding);
+            await this.writeFile(resource, encoded.buffer, { create: false, overwrite: true });
+            const stat = await this.stat(resource);
+            return Object.assign(stat, { encoding: encoding.encoding });
+        }
+        catch (error) {
+            throw toFileSystemProviderError(error);
+        }
+    }
+    // #endregion
+    /**
+     * Handles file system change events from BroadcastChannel
+     */
+    async handleFileSystemChange(event) {
+        var _a;
+        if (!((_a = event.data) === null || _a === void 0 ? void 0 : _a.path)) {
+            return;
+        }
+        const resource = new core_1.URI('file://' + event.data.path);
+        let changeType;
+        if (event.data.type === opfs_worker_1.WatchEventType.Added) {
+            changeType = 1 /* FileChangeType.ADDED */;
+        }
+        else if (event.data.type === opfs_worker_1.WatchEventType.Removed) {
+            changeType = 2 /* FileChangeType.DELETED */;
+        }
+        else {
+            changeType = 0 /* FileChangeType.UPDATED */;
+        }
+        this.onDidChangeFileEmitter.fire([{ resource, type: changeType }]);
+    }
+    /**
+     * Disposes the file system provider
+     */
+    dispose() {
+        this.toDispose.dispose();
     }
 };
 exports.OPFSFileSystemProvider = OPFSFileSystemProvider;
@@ -224,6 +429,10 @@ tslib_1.__decorate([
     (0, inversify_1.inject)(opfs_filesystem_initialization_1.OPFSInitialization),
     tslib_1.__metadata("design:type", Object)
 ], OPFSFileSystemProvider.prototype, "initialization", void 0);
+tslib_1.__decorate([
+    (0, inversify_1.inject)(encoding_service_1.EncodingService),
+    tslib_1.__metadata("design:type", encoding_service_1.EncodingService)
+], OPFSFileSystemProvider.prototype, "encodingService", void 0);
 tslib_1.__decorate([
     (0, inversify_1.postConstruct)(),
     tslib_1.__metadata("design:type", Function),
@@ -233,91 +442,46 @@ tslib_1.__decorate([
 exports.OPFSFileSystemProvider = OPFSFileSystemProvider = tslib_1.__decorate([
     (0, inversify_1.injectable)()
 ], OPFSFileSystemProvider);
-// #region Helper functions
-async function recursiveFileSystemHandle(handle, pathParts, options) {
-    // We reached the end of the path, this happens only when not creating
-    if (pathParts.length === 0) {
-        return handle;
-    }
-    // If there are parts left, the handle must be a directory
-    if (handle.kind !== 'directory') {
-        throw (0, files_1.createFileSystemProviderError)('Not a directory', files_1.FileSystemProviderErrorCode.FileNotADirectory);
-    }
-    const dirHandle = handle;
-    // We need to create it and thus we need to stop early to create the file or directory
-    if (pathParts.length === 1 && (options === null || options === void 0 ? void 0 : options.create)) {
-        if (options === null || options === void 0 ? void 0 : options.isDirectory) {
-            return dirHandle.getDirectoryHandle(pathParts[0], { create: options.create });
-        }
-        else {
-            return dirHandle.getFileHandle(pathParts[0], { create: options.create });
-        }
-    }
-    // Continue to resolve the path
-    const part = pathParts.shift();
-    for await (const entry of dirHandle.entries()) {
-        // Check the entry name in the current directory
-        if (entry[0] === part) {
-            return recursiveFileSystemHandle(entry[1], pathParts, options);
-        }
-    }
-    // If we haven't found the part, we need to create it along the way
-    if (options === null || options === void 0 ? void 0 : options.create) {
-        const newHandle = await dirHandle.getDirectoryHandle(part, { create: true });
-        return recursiveFileSystemHandle(newHandle, pathParts, options);
-    }
-    throw (0, files_1.createFileSystemProviderError)('File not found', files_1.FileSystemProviderErrorCode.FileNotFound);
+/**
+ * Formats a URI or string resource to a file system path
+ */
+function formatPath(resource) {
+    return file_uri_1.FileUri.fsPath(resource);
 }
-// Function to copy directory contents recursively
-async function copyDirectoryContents(sourceHandle, destinationHandle) {
-    for await (const [name, handle] of sourceHandle.entries()) {
-        if (handle.kind === 'file') {
-            const file = await handle.getFile();
-            const newFileHandle = await destinationHandle.getFileHandle(name, { create: true });
-            const writable = await newFileHandle.createWritable();
-            try {
-                await writable.write(await file.arrayBuffer());
-            }
-            finally {
-                await writable.close();
-            }
-        }
-        else if (handle.kind === 'directory') {
-            const newSubDirHandle = await destinationHandle.getDirectoryHandle(name, { create: true });
-            await copyDirectoryContents(handle, newSubDirHandle);
-        }
-    }
+/**
+ * Creates a Stat object from OPFS stats
+ */
+function formatStat(stats) {
+    return {
+        type: stats.isDirectory ? files_1.FileType.Directory : files_1.FileType.File,
+        ctime: new Date(stats.ctime).getTime(),
+        mtime: new Date(stats.mtime).getTime(),
+        size: stats.size
+    };
 }
-function toFileSystemProviderError(error, is_dir) {
+/**
+ * Converts OPFS errors to file system provider errors
+ */
+function toFileSystemProviderError(error) {
     if (error instanceof files_1.FileSystemProviderError) {
-        return error; // avoid double conversion
+        return error;
     }
     let code;
-    switch (error.name) {
-        case 'NotFoundError':
-            code = files_1.FileSystemProviderErrorCode.FileNotFound;
-            break;
-        case 'InvalidModificationError':
-            code = files_1.FileSystemProviderErrorCode.FileExists;
-            break;
-        case 'NotAllowedError':
-            code = files_1.FileSystemProviderErrorCode.NoPermissions;
-            break;
-        case 'TypeMismatchError':
-            if (!is_dir) {
-                code = files_1.FileSystemProviderErrorCode.FileIsADirectory;
-            }
-            else {
-                code = files_1.FileSystemProviderErrorCode.FileNotADirectory;
-            }
-            break;
-        case 'QuotaExceededError':
-            code = files_1.FileSystemProviderErrorCode.FileTooLarge;
-            break;
-        default:
-            code = files_1.FileSystemProviderErrorCode.Unknown;
+    if (error.name === 'NotFoundError' || error.name === 'ENOENT') {
+        code = files_1.FileSystemProviderErrorCode.FileNotFound;
+    }
+    else if (error.name === 'NotAllowedError' || error.name === 'SecurityError' || error.name === 'EACCES') {
+        code = files_1.FileSystemProviderErrorCode.NoPermissions;
+    }
+    else if (error.name === 'QuotaExceededError' || error.name === 'ENOSPC') {
+        code = files_1.FileSystemProviderErrorCode.FileTooLarge;
+    }
+    else if (error.name === 'PathError' || error.name === 'INVALID_PATH') {
+        code = files_1.FileSystemProviderErrorCode.FileNotADirectory;
+    }
+    else {
+        code = files_1.FileSystemProviderErrorCode.Unknown;
     }
     return (0, files_1.createFileSystemProviderError)(error, code);
 }
-// #endregion
 //# sourceMappingURL=opfs-filesystem-provider.js.map