feat: add editor document model save error event (#4658)

* feat: add editor document model save error event

* test: cover editor document save error event

Author: coffeedeveloper

packages/editor/__tests__/browser/doc-model/editor-document-model.test.ts

@@ -1,10 +1,11 @@
 import uniqueId from 'lodash/uniqueId';
 
-import { IEventBus, URI } from '@opensumi/ide-core-browser';
+import { IEventBus, SaveTaskResponseState, URI } from '@opensumi/ide-core-browser';
 import { IHashCalculateService } from '@opensumi/ide-core-common/lib/hash-calculate/hash-calculate';
 import { EmptyDocCacheImpl } from '@opensumi/ide-editor/lib/browser/doc-cache';
 import { monacoApi } from '@opensumi/ide-monaco/lib/browser/monaco-api';
 import { EOL } from '@opensumi/ide-monaco/lib/browser/monaco-api/types';
+import { IMessageService } from '@opensumi/ide-overlay';
 import { isLinux, isMacintosh } from '@opensumi/monaco-editor-core/esm/vs/base/common/platform';
 
 import { createBrowserInjector } from '../../../../../tools/dev-tool/src/injector-helper';
@@ -14,8 +15,11 @@ import { EditorDocumentModel, EditorDocumentModelConstructionOptions } from '../
 import {
   EditorDocumentModelContentChangedEvent,
   EditorDocumentModelOptionChangedEvent,
+  EditorDocumentModelSaveErrorEvent,
+  IEditorDocumentModelContentRegistry,
+  IEditorDocumentModelService,
 } from '../../../src/browser/doc-model/types';
-import { IDocPersistentCacheProvider } from '../../../src/common';
+import { IDocPersistentCacheProvider, SaveReason } from '../../../src/common';
 
 describe('EditorDocumentModel', () => {
   let injector: MockInjector;
@@ -209,4 +213,54 @@ describe('EditorDocumentModel', () => {
       expect(docModelAny._tryAutoSaveAfterDelay).toBeUndefined();
     });
   });
+
+  describe('save', () => {
+    let uri: URI;
+    let docModel: EditorDocumentModel;
+    let saveEditorDocumentModel: jest.Mock;
+    let eventBus: IEventBus;
+    let saveErrorListener: jest.Mock;
+    let saveErrorDisposer: { dispose(): void };
+
+    beforeEach(() => {
+      uri = new URI(`test://save/${Math.random()}`);
+      eventBus = injector.get(IEventBus);
+      injector.mockService(IEditorDocumentModelContentRegistry, {
+        getProvider: jest.fn().mockResolvedValue({
+          isReadonly: jest.fn().mockResolvedValue(false),
+        }),
+      });
+      injector.mockService(IMessageService, {
+        error: jest.fn(),
+      });
+      saveEditorDocumentModel = jest.fn().mockResolvedValue({
+        state: SaveTaskResponseState.ERROR,
+        errorMessage: 'save failed',
+      });
+      injector.mockService(IEditorDocumentModelService, {
+        saveEditorDocumentModel,
+      });
+      docModel = injector.get(EditorDocumentModel, [uri, 'original content', { savable: true }]);
+      saveErrorListener = jest.fn();
+      saveErrorDisposer = eventBus.on(EditorDocumentModelSaveErrorEvent, saveErrorListener);
+    });
+
+    afterEach(() => {
+      saveErrorDisposer.dispose();
+      docModel.dispose();
+    });
+
+    it('should emit save error event when saving fails', async () => {
+      docModel.getMonacoModel().setValue('updated content');
+
+      const result = await docModel.save(false, SaveReason.AfterDelay);
+
+      expect(result).toBe(false);
+      expect(saveEditorDocumentModel).toHaveBeenCalledTimes(1);
+      expect(saveErrorListener).toHaveBeenCalledTimes(1);
+      const event = saveErrorListener.mock.calls[0][0];
+      expect(event.payload.uri.toString()).toBe(uri.toString());
+      expect(event.payload.errorMessage).toBe('save failed');
+    });
+  });
 });

packages/editor/src/browser/doc-model/editor-document-model.ts

@@ -56,6 +56,7 @@ import {
   EditorDocumentModelContentChangedEvent,
   EditorDocumentModelOptionChangedEvent,
   EditorDocumentModelRemovalEvent,
+  EditorDocumentModelSaveErrorEvent,
   EditorDocumentModelSavedEvent,
   EditorDocumentModelWillSaveEvent,
   IDocModelUpdateOptions,
@@ -498,6 +499,14 @@ export class EditorDocumentModel extends Disposable implements IEditorDocumentMo
         this.eventBus.fire(new EditorDocumentModelSavedEvent(this.uri));
         this.setPersist(this.savingTasks[0].alternativeVersionId);
       } else {
+        if (res.state === 'error') {
+          this.eventBus.fire(
+            new EditorDocumentModelSaveErrorEvent({
+              uri: this.uri,
+              errorMessage: res.errorMessage,
+            }),
+          );
+        }
         // 回滚 changes
         this.dirtyChanges.unshift(...changes);
       }

packages/editor/src/browser/doc-model/types.ts

@@ -209,6 +209,11 @@ export class EditorDocumentModelRemovalEvent extends BasicEvent<URI> {}
 
 export class EditorDocumentModelSavedEvent extends BasicEvent<URI> {}
 
+export class EditorDocumentModelSaveErrorEvent extends BasicEvent<{
+  uri: URI;
+  errorMessage?: string;
+}> {}
+
 export class EditorDocumentModelWillSaveEvent extends BasicEvent<{
   uri: URI;
   reason: SaveReason;