@theia/filesystem 1.26.0-next.4 → 1.26.0-next.44

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@theia/filesystem",
-  "version": "1.26.0-next.4+eb0930a267c",
+  "version": "1.26.0-next.44+4099a4ec58f",
   "description": "Theia - FileSystem Extension",
   "dependencies": {
-    "@theia/core": "1.26.0-next.4+eb0930a267c",
+    "@theia/core": "1.26.0-next.44+4099a4ec58f",
     "@types/body-parser": "^1.17.0",
     "@types/multer": "^1.4.7",
     "@types/rimraf": "^2.0.2",
@@ -68,5 +68,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "eb0930a267cda577b31532474a404e45b5ae350b"
+  "gitHead": "4099a4ec58f8573a36b32514d37b7d8541db7030"
 }

package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts

@@ -16,8 +16,7 @@
 
 import { Container, interfaces, injectable, inject } from '@theia/core/shared/inversify';
 import { TreeProps, ContextMenuRenderer, TreeNode, OpenerService, open, NodeProps, defaultTreeProps } from '@theia/core/lib/browser';
-import { createFileTreeContainer, FileTreeWidget } from '../';
-import { FileTreeModel, FileStatNode } from '../file-tree';
+import { FileTreeModel, FileStatNode, createFileTreeContainer, FileTreeWidget } from '../file-tree';
 
 const BREADCRUMBS_FILETREE_CLASS = 'theia-FilepathBreadcrumbFileTree';
 

package/src/browser/file-service.ts

@@ -602,6 +602,11 @@ export class FileService {
 
     /**
      * Tests a user's permissions for the given resource.
+     * @param resource `URI` of the resource which should be tested.
+     * @param mode An optional integer that specifies the accessibility checks to be performed.
+     *      Check `FileAccess.Constants` for possible values of mode.
+     *      It is possible to create a mask consisting of the bitwise `OR` of two or more values (e.g. FileAccess.Constants.W_OK | FileAccess.Constants.R_OK).
+     *      If `mode` is not defined, `FileAccess.Constants.F_OK` will be used instead.
      */
     async access(resource: URI, mode?: number): Promise<boolean> {
         const provider = await this.withProvider(resource);

package/src/browser/file-tree/file-tree-decorator-adapter.ts

@@ -143,7 +143,7 @@ export class FileTreeDecoratorAdapter implements TreeDecorator {
     }
 
     /**
-     *  Sort higher priorities earier. I.e. positive number means right higher than left.
+     *  Sort higher priorities earlier. I.e. positive number means right higher than left.
      */
     protected compareWeight(left: Decoration, right: Decoration): number {
         return (right.weight ?? 0) - (left.weight ?? 0);

package/src/browser/file-tree/file-tree-widget.tsx

@@ -280,7 +280,7 @@ export class FileTreeWidget extends CompressedTreeWidget {
             if (node.fileStat) {
                 stat = {
                     type: node.fileStat.isDirectory ? FileType.Directory : FileType.File,
-                    mtime: node.fileStat.lastModification,
+                    mtime: node.fileStat.mtime,
                     size: node.fileStat.size
                 };
                 delete node['fileStat'];

package/src/browser/file-tree/file-tree.ts

@@ -19,7 +19,6 @@ import URI from '@theia/core/lib/common/uri';
 import { TreeNode, CompositeTreeNode, SelectableTreeNode, ExpandableTreeNode, TreeImpl } from '@theia/core/lib/browser';
 import { Mutable } from '@theia/core/lib/common/types';
 import { FileStat, Stat, FileType, FileOperationError, FileOperationResult } from '../../common/files';
-import { FileStat as DeprecatedFileStat } from '../../common/filesystem';
 import { UriSelection } from '@theia/core/lib/common/selection';
 import { MessageService } from '@theia/core/lib/common/message-service';
 import { FileSelection } from '../file-selection';
@@ -117,7 +116,7 @@ export namespace FileStatNode {
 export type FileStatNodeData = Omit<FileStatNode, 'uri' | 'fileStat'> & {
     uri: string
     stat?: Stat | { type: FileType } & Partial<Stat>
-    fileStat?: DeprecatedFileStat
+    fileStat?: FileStat
 };
 export namespace FileStatNodeData {
     export function is(node: object | undefined): node is FileStatNodeData {

package/src/browser/filesystem-frontend-module.ts

@@ -21,21 +21,14 @@ import { ResourceResolver, CommandContribution } from '@theia/core/lib/common';
 import { WebSocketConnectionProvider, FrontendApplicationContribution, LabelProviderContribution, BreadcrumbsContribution } from '@theia/core/lib/browser';
 import { FileResourceResolver } from './file-resource';
 import { bindFileSystemPreferences } from './filesystem-preferences';
-import { FileSystemWatcher } from './filesystem-watcher';
 import { FileSystemFrontendContribution } from './filesystem-frontend-contribution';
 import { FileUploadService } from './file-upload-service';
 import { FileTreeDecoratorAdapter, FileTreeLabelProvider } from './file-tree';
 import { FileService, FileServiceContribution } from './file-service';
 import { RemoteFileSystemProvider, RemoteFileSystemServer, remoteFileSystemPath, RemoteFileSystemProxyFactory } from '../common/remote-file-system-provider';
-import { FileSystem, FileStat, FileMoveOptions, FileDeleteOptions, FileSystemError } from '../common/filesystem';
-import URI from '@theia/core/lib/common/uri';
-import { FileOperationError, FileOperationResult, BaseStatWithMetadata, FileStatWithMetadata, etag } from '../common/files';
-import { TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
-import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
 import { bindContributionProvider } from '@theia/core/lib/common/contribution-provider';
 import { RemoteFileServiceContribution } from './remote-file-service-contribution';
 import { FileSystemWatcherErrorHandler } from './filesystem-watcher-error-handler';
-import { UTF8 } from '@theia/core/lib/common/encodings';
 import { FilepathBreadcrumbsContribution } from './breadcrumbs/filepath-breadcrumbs-contribution';
 import { BreadcrumbsFileTreeWidget, createFileTreeBreadcrumbsWidget } from './breadcrumbs/filepath-breadcrumbs-container';
 import { FilesystemSaveResourceService } from './filesystem-save-resource-service';
@@ -54,163 +47,8 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     bind(RemoteFileServiceContribution).toSelf().inSingletonScope();
     bind(FileServiceContribution).toService(RemoteFileServiceContribution);
 
-    bind(FileSystemWatcher).toSelf().inSingletonScope();
     bind(FileSystemWatcherErrorHandler).toSelf().inSingletonScope();
 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    bind(FileSystem).toDynamicValue(({ container }) => {
-        const fileService = container.get(FileService);
-        const environments = container.get<EnvVariablesServer>(EnvVariablesServer);
-        const convertStat: (stat: BaseStatWithMetadata | FileStatWithMetadata) => FileStat = stat => ({
-            uri: stat.resource.toString(),
-            lastModification: stat.mtime,
-            size: stat.size,
-            isDirectory: 'isDirectory' in stat && stat.isDirectory,
-            children: 'children' in stat ? stat.children?.map(convertStat) : undefined
-        });
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const rethrowError: (uri: string, error: any) => never = (uri, error) => {
-            if (error instanceof FileOperationError) {
-                if (error.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
-                    throw FileSystemError.FileNotFound(uri);
-                }
-                if (error.fileOperationResult === FileOperationResult.FILE_IS_DIRECTORY) {
-                    throw FileSystemError.FileIsDirectory(uri);
-                }
-                if (error.fileOperationResult === FileOperationResult.FILE_NOT_DIRECTORY) {
-                    throw FileSystemError.FileNotDirectory(uri);
-                }
-                if (error.fileOperationResult === FileOperationResult.FILE_MODIFIED_SINCE) {
-                    throw FileSystemError.FileIsOutOfSync(uri);
-                }
-            }
-            throw error;
-        };
-        return new class implements FileSystem {
-            async getFileStat(uri: string): Promise<FileStat | undefined> {
-                try {
-                    const stat = await fileService.resolve(new URI(uri), { resolveMetadata: true });
-                    return convertStat(stat);
-                } catch (e) {
-                    if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
-                        return undefined;
-                    }
-                    rethrowError(uri, e);
-                }
-            }
-            exists(uri: string): Promise<boolean> {
-                return fileService.exists(new URI(uri));
-            }
-            async resolveContent(uri: string, options?: { encoding?: string | undefined; } | undefined): Promise<{ stat: FileStat; content: string; }> {
-                try {
-                    const content = await fileService.read(new URI(uri), options);
-                    return {
-                        stat: convertStat(content),
-                        content: content.value
-                    };
-                } catch (e) {
-                    rethrowError(uri, e);
-                }
-            }
-            async setContent(file: FileStat, content: string, options?: { encoding?: string | undefined; } | undefined): Promise<FileStat> {
-                try {
-                    const result = await fileService.write(new URI(file.uri), content, {
-                        ...options,
-                        mtime: file.lastModification
-                    });
-                    return convertStat(result);
-                } catch (e) {
-                    rethrowError(file.uri, e);
-                }
-            }
-            async updateContent(file: FileStat, contentChanges: TextDocumentContentChangeEvent[], options?: {
-                encoding?: string | undefined;
-                overwriteEncoding?: string | undefined;
-            } | undefined): Promise<FileStat> {
-                try {
-                    const result = await fileService.update(new URI(file.uri), contentChanges, {
-                        mtime: file.lastModification,
-                        etag: etag({ size: file.size, mtime: file.lastModification }),
-                        readEncoding: options?.encoding || UTF8,
-                        encoding: options?.overwriteEncoding,
-                        overwriteEncoding: !!options?.overwriteEncoding
-                    });
-                    return convertStat(result);
-                } catch (e) {
-                    rethrowError(file.uri, e);
-                }
-            }
-            async move(sourceUri: string, targetUri: string, options?: FileMoveOptions | undefined): Promise<FileStat> {
-                try {
-                    const result = await fileService.move(new URI(sourceUri), new URI(targetUri), options);
-                    return convertStat(result);
-                } catch (e) {
-                    rethrowError(sourceUri, e);
-                }
-            }
-            async copy(sourceUri: string, targetUri: string, options?: { overwrite?: boolean | undefined; recursive?: boolean | undefined; } | undefined): Promise<FileStat> {
-                try {
-                    const result = await fileService.copy(new URI(sourceUri), new URI(targetUri), options);
-                    return convertStat(result);
-                } catch (e) {
-                    rethrowError(sourceUri, e);
-                }
-            }
-            async createFile(uri: string, options?: { content?: string | undefined; encoding?: string | undefined; } | undefined): Promise<FileStat> {
-                try {
-                    const result = await fileService.create(new URI(uri), options?.content, { encoding: options?.encoding });
-                    return convertStat(result);
-                } catch (e) {
-                    rethrowError(uri, e);
-                }
-            }
-            async createFolder(uri: string): Promise<FileStat> {
-                try {
-                    const result = await fileService.createFolder(new URI(uri));
-                    return convertStat(result);
-                } catch (e) {
-                    rethrowError(uri, e);
-                }
-            }
-            touchFile(uri: string): Promise<FileStat> {
-                throw new Error('Method not implemented.');
-            }
-            async delete(uri: string, options?: FileDeleteOptions | undefined): Promise<void> {
-                try {
-                    return await fileService.delete(new URI(uri), { useTrash: options?.moveToTrash, recursive: true });
-                } catch (e) {
-                    rethrowError(uri, e);
-                }
-            }
-            async getEncoding(uri: string): Promise<string> {
-                const { encoding } = await fileService.read(new URI(uri));
-                return encoding;
-            }
-            async guessEncoding(uri: string): Promise<string | undefined> {
-                const { encoding } = await fileService.read(new URI(uri), { autoGuessEncoding: true });
-                return encoding;
-            }
-            async getRoots(): Promise<FileStat[]> {
-                const drives = await environments.getDrives();
-                const roots = await Promise.all(drives.map(uri => this.getFileStat(uri)));
-                return roots.filter(root => !!root) as FileStat[];
-            }
-            async getCurrentUserHome(): Promise<FileStat | undefined> {
-                return this.getFileStat(await environments.getHomeDirUri());
-            }
-            getDrives(): Promise<string[]> {
-                return environments.getDrives();
-            }
-            access(uri: string, mode?: number | undefined): Promise<boolean> {
-                return fileService.access(new URI(uri), mode);
-            }
-            getFsPath(uri: string): Promise<string | undefined> {
-                return fileService.fsPath(new URI(uri));
-            }
-
-        };
-    }).inSingletonScope();
-
     bindFileResource(bind);
 
     bind(FileUploadService).toSelf().inSingletonScope();

package/src/browser/index.ts

@@ -18,5 +18,4 @@ export * from './location';
 export * from './file-tree';
 export * from './file-dialog';
 export * from './filesystem-preferences';
-export * from './filesystem-watcher';
 export * from './file-resource';

package/src/browser/location/location-renderer.tsx

@@ -187,7 +187,7 @@ export class LocationListRenderer extends ReactRenderer {
     protected renderTextInput(): React.ReactNode {
         return (
             <input className={'theia-select ' + LocationListRenderer.Styles.LOCATION_TEXT_INPUT_CLASS}
-                defaultValue={this.service.location?.path.toString()}
+                defaultValue={this.service.location?.path.fsPath()}
                 onBlur={this.handleTextInputOnBlur}
                 onChange={this.handleTextInputOnChange}
                 onKeyDown={this.handleTextInputKeyDown}
@@ -278,7 +278,7 @@ export class LocationListRenderer extends ReactRenderer {
     protected renderLocation(location: LocationListRenderer.Location): React.ReactNode {
         const { uri, isDrive } = location;
         const value = uri.toString();
-        return <option value={value} key={uri.toString()}>{isDrive ? uri.path.toString() : uri.displayName}</option>;
+        return <option value={value} key={uri.toString()}>{isDrive ? uri.path.fsPath() : uri.displayName}</option>;
     }
 
     protected onLocationChanged(e: React.ChangeEvent<HTMLSelectElement>): void {

package/src/common/files.ts

@@ -698,16 +698,25 @@ export interface FileSystemProvider {
  */
 export interface FileSystemProviderWithAccessCapability extends FileSystemProvider {
     /**
-     * Test if the user has the permission to access the given file in the specified mode.
+     * Tests a user's permissions for the file or directory specified by URI.
      * @param resource The `URI` of the file that should be tested.
-     * @param mode The access mode that should be tested.
+     * @param mode An optional integer that specifies the accessibility checks to be performed.
+     *      Check `FileAccess.Constants` for possible values of mode.
+     *      It is possible to create a mask consisting of the bitwise `OR` of two or more values (e.g. FileAccess.Constants.W_OK | FileAccess.Constants.R_OK).
+     *      If `mode` is not defined, `FileAccess.Constants.F_OK` will be used instead.
      *
      * @returns A promise that resolves if the user has the required permissions, should be rejected otherwise.
      */
     access(resource: URI, mode?: number): Promise<void>;
 
     /**
-     * Derive the platform specific file system path that is represented by the resource.
+     * Returns the path of the given file URI, specific to the backend's operating system.
+     * If the URI is not a file URI, undefined is returned.
+     *
+     * USE WITH CAUTION: You should always prefer URIs to paths if possible, as they are
+     * portable and platform independent. Paths should only be used in cases you directly
+     * interact with the OS, e.g. when running a command on the shell.
+     *
      * @param resource `URI` of the resource to derive the path from.
      *
      * @returns A promise of the corresponding file system path.
@@ -837,7 +846,7 @@ export function hasOpenReadWriteCloseCapability(provider: FileSystemProvider): p
  */
 export interface FileSystemProviderWithFileReadStreamCapability extends FileSystemProvider {
     /**
-     * Read the  contents of the given file as stream.
+     * Read the contents of the given file as stream.
      * @param resource The `URI` of the file.
      *
      * @return The `ReadableStreamEvents` for the readable stream of the given file.

package/src/common/filesystem-utils.spec.ts

@@ -14,9 +14,9 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { FileSystemUtils } from '.';
 import { FileStat } from './files';
 import { expect } from 'chai';
+import { FileSystemUtils } from './filesystem-utils';
 
 describe('generateUniqueResourceURI', () => {
     describe('Target is file', () => {

package/src/common/filesystem-watcher-protocol.ts

@@ -14,8 +14,7 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { injectable, inject } from '@theia/core/shared/inversify';
-import { JsonRpcServer, JsonRpcProxy } from '@theia/core';
+import { JsonRpcServer } from '@theia/core';
 import { FileChangeType } from './files';
 export { FileChangeType };
 
@@ -95,68 +94,3 @@ export interface FileChange {
     uri: string;
     type: FileChangeType;
 }
-
-export const FileSystemWatcherServerProxy = Symbol('FileSystemWatcherServerProxy');
-export type FileSystemWatcherServerProxy = JsonRpcProxy<FileSystemWatcherServer>;
-
-/**
- * @deprecated not used internally anymore.
- */
-@injectable()
-export class ReconnectingFileSystemWatcherServer implements FileSystemWatcherServer {
-
-    protected watcherSequence = 1;
-    protected readonly watchParams = new Map<number, {
-        uri: string;
-        options?: WatchOptions
-    }>();
-    protected readonly localToRemoteWatcher = new Map<number, number>();
-
-    constructor(
-        @inject(FileSystemWatcherServerProxy) protected readonly proxy: FileSystemWatcherServerProxy
-    ) {
-        const onInitialized = this.proxy.onDidOpenConnection(() => {
-            // skip reconnection on the first connection
-            onInitialized.dispose();
-            this.proxy.onDidOpenConnection(() => this.reconnect());
-        });
-    }
-
-    protected reconnect(): void {
-        for (const [watcher, { uri, options }] of this.watchParams.entries()) {
-            this.doWatchFileChanges(watcher, uri, options);
-        }
-    }
-
-    dispose(): void {
-        this.proxy.dispose();
-    }
-
-    watchFileChanges(uri: string, options?: WatchOptions): Promise<number> {
-        const watcher = this.watcherSequence++;
-        this.watchParams.set(watcher, { uri, options });
-        return this.doWatchFileChanges(watcher, uri, options);
-    }
-
-    protected doWatchFileChanges(watcher: number, uri: string, options?: WatchOptions): Promise<number> {
-        return this.proxy.watchFileChanges(uri, options).then(remote => {
-            this.localToRemoteWatcher.set(watcher, remote);
-            return watcher;
-        });
-    }
-
-    unwatchFileChanges(watcher: number): Promise<void> {
-        this.watchParams.delete(watcher);
-        const remote = this.localToRemoteWatcher.get(watcher);
-        if (remote) {
-            this.localToRemoteWatcher.delete(watcher);
-            return this.proxy.unwatchFileChanges(remote);
-        }
-        return Promise.resolve();
-    }
-
-    setClient(client: FileSystemWatcherClient | undefined): void {
-        this.proxy.setClient(client);
-    }
-
-}