fix: do not enqueue write operations on conflict

Closes #2051

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/src/browser/theia/filesystem/file-resource.ts

@@ -9,6 +9,7 @@ import {
 } from '@theia/filesystem/lib/browser/file-resource';
 import { FileService } from '@theia/filesystem/lib/browser/file-service';
 import {
+  ETAG_DISABLED,
   FileOperationError,
   FileOperationResult,
   FileStat,
@@ -66,6 +67,10 @@ class WriteQueuedFileResource extends FileResource {
     content: string | Readable<string>,
     options?: ResourceSaveOptions
   ): Promise<void> {
+    if (isETagDisabledResourceSaveOptions(options)) {
+      // When force overriding without auto-save do not enqueue the modification. Otherwise, it will never resolve.
+      return super.doWrite(content, options);
+    }
     return this.writeQueue.add(() => super.doWrite(content, options));
   }
 
@@ -76,3 +81,23 @@ class WriteQueuedFileResource extends FileResource {
     return super.isInSync();
   }
 }
+
+// Theia incorrectly sets the disabled ETag on the `stat` instead of the `version` so `FileResourceVersion#is` is unusable.
+// https://github.com/eclipse-theia/theia/blob/f9063625b861b8433341fcd1a29a0d0298778f4c/packages/filesystem/src/browser/file-resource.ts#L210
+// https://github.com/eclipse-theia/theia/blob/f9063625b861b8433341fcd1a29a0d0298778f4c/packages/filesystem/src/browser/file-resource.ts#L34
+function isETagDisabledResourceSaveOptions(
+  options?: ResourceSaveOptions
+): boolean {
+  if (typeof options === 'object') {
+    if ('version' in options && typeof options['version'] === 'object') {
+      const version = <Record<string, unknown>>options['version'];
+      if (version && 'stat' in version && typeof version['stat'] === 'object') {
+        const stat = <Record<string, unknown>>version['stat'];
+        if (stat) {
+          return 'etag' in stat && stat['etag'] === ETAG_DISABLED;
+        }
+      }
+    }
+  }
+  return false;
+}