[filesystem] Fix missing "out of sync error"

which should be shown if one try to save pending editor changes to a file which was modified in background. Fixes #7102
eclipse-theia · Feb 12, 2020 · 574bf69 · akosyakov · Feb 12, 2020 · 574bf69
1 parent 46a2d51
commit 574bf69
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 9 deletions.
diff --git a/packages/core/src/common/resource.ts b/packages/core/src/common/resource.ts
@@ -27,8 +27,17 @@ import { ApplicationError } from './application-error';
 export interface Resource extends Disposable {
     readonly uri: URI;
     readContents(options?: { encoding?: string }): Promise<string>;
+    /**
+     * Use `Resource.save` to apply changes.
+     */
     saveContents?(content: string, options?: { encoding?: string }): Promise<void>;
-    saveContentChanges?(changes: TextDocumentContentChangeEvent[], options?: { encoding?: string }): Promise<void>;
+    /**
+     * Use `Resource.save` to apply changes.
+     *
+     * Returns whether incremental changes can be applied to the current state.
+     * If not then `saveContents` should be used.
+     */
+    saveContentChanges?(changes: TextDocumentContentChangeEvent[], options?: { encoding?: string }): Promise<void | boolean>;
     readonly onDidChangeContents?: Event<void>;
     guessEncoding?(): Promise<string | undefined>
 }
@@ -55,12 +64,12 @@ export namespace Resource {
             return false;
         }
         try {
-            await resource.saveContentChanges(context.changes, context.options);
+            const result = await resource.saveContentChanges(context.changes, context.options);
+            return typeof result === 'boolean' ? result : true;
         } catch (e) {
             console.error(e);
             return false;
         }
-        return true;
     }
     export function shouldSaveContent({ content, changes }: SaveContext): boolean {
         if (!changes) {

diff --git a/packages/filesystem/src/browser/file-resource.ts b/packages/filesystem/src/browser/file-resource.ts
@@ -91,18 +91,33 @@ export class FileResource implements Resource {
         }
     }
     protected async doSaveContents(content: string, options?: { encoding?: string }): Promise<FileStat> {
-        const stat = await this.getFileStat();
+        const stat = this.stat || await this.getFileStat();
         if (stat) {
-            return this.fileSystem.setContent(stat, content, options);
+            try {
+                return await this.fileSystem.setContent(stat, content, options);
+            } catch (e) {
+                if (FileSystemError.FileNotFound.is(e)) {
+                    return this.fileSystem.createFile(this.uriString, { content, ...options });
+                }
+                throw e;
+            }
         }
         return this.fileSystem.createFile(this.uriString, { content, ...options });
     }
 
-    async saveContentChanges(changes: TextDocumentContentChangeEvent[], options?: { encoding?: string, overwriteEncoding?: string }): Promise<void> {
+    async saveContentChanges(changes: TextDocumentContentChangeEvent[], options?: { encoding?: string, overwriteEncoding?: string }): Promise<boolean> {
         if (!this.stat) {
-            throw new Error(this.uriString + ' has not been read yet');
+            return false;
+        }
+        try {
+            this.stat = await this.fileSystem.updateContent(this.stat, changes, options);
+            return true;
+        } catch (e) {
+            if (FileSystemError.FileNotFound.is(e)) {
+                return false;
+            }
+            throw e;
         }
-        this.stat = await this.fileSystem.updateContent(this.stat, changes, options);
     }
 
     async guessEncoding(): Promise<string | undefined> {

diff --git a/packages/filesystem/src/node/node-filesystem.ts b/packages/filesystem/src/node/node-filesystem.ts
@@ -117,7 +117,7 @@ export class FileSystemNode implements FileSystem {
         if (stat.isDirectory) {
             throw FileSystemError.FileIsDirectory(file.uri, 'Cannot set the content.');
         }
-        if (!this.checkInSync(file, stat)) {
+        if (!(await this.isInSync(file, stat))) {
             throw this.createOutOfSyncError(file, stat);
         }
         if (contentChanges.length === 0 && !(options && options.overwriteEncoding)) {