feat(docs-history): preserve drawing delete semantics

Author: DR-Univer

packages/docs-drawing/src/commands/commands/__tests__/remove-doc-drawing.command.spec.ts

@@ -0,0 +1,91 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { IRemoveDocDrawingCommandParams } from '../remove-doc-drawing.command';
+import { DrawingTypeEnum, ICommandService, ImageSourceType } from '@univerjs/core';
+import { DocHistoryAction, RichTextEditingMutation } from '@univerjs/docs';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { createFacadeTestBed } from '../../../facade/__tests__/create-test-bed';
+import { RemoveDocDrawingCommand } from '../remove-doc-drawing.command';
+
+class MockImage {
+    width = 800;
+    height = 400;
+    onload: (() => void) | null = null;
+    onerror: (() => void) | null = null;
+
+    get src(): string {
+        return '';
+    }
+
+    set src(_value: string) {
+        queueMicrotask(() => this.onload?.());
+    }
+}
+
+describe('RemoveDocDrawingCommand', () => {
+    let testBed: ReturnType<typeof createFacadeTestBed>;
+
+    beforeEach(() => {
+        vi.stubGlobal('Image', MockImage);
+        testBed = createFacadeTestBed();
+    });
+
+    afterEach(() => {
+        testBed.univer.dispose();
+        vi.unstubAllGlobals();
+    });
+
+    it.each([
+        [DrawingTypeEnum.DRAWING_IMAGE, DocHistoryAction.DeleteImage],
+        [DrawingTypeEnum.DRAWING_SHAPE, DocHistoryAction.DeleteShape],
+        [DrawingTypeEnum.DRAWING_CHART, DocHistoryAction.DeleteChart],
+    ])('records the drawing type %s in history metadata', async (drawingType, historyAction) => {
+        const image = await testBed.document.insertImage({
+            source: 'data:image/png;base64,image',
+            imageSourceType: ImageSourceType.BASE64,
+            width: 160,
+            height: 90,
+            textRange: {
+                startOffset: 3,
+                endOffset: 3,
+                collapsed: true,
+                segmentId: '',
+            },
+        });
+        const commandService = testBed.injector.get(ICommandService);
+        const mutationSpy = vi.spyOn(commandService, 'syncExecuteCommand');
+
+        const result = commandService.syncExecuteCommand<IRemoveDocDrawingCommandParams>(
+            RemoveDocDrawingCommand.id,
+            {
+                unitId: 'test-doc',
+                drawings: [{
+                    unitId: 'test-doc',
+                    subUnitId: 'test-doc',
+                    drawingId: image!.getId(),
+                    drawingType,
+                }],
+            }
+        );
+
+        expect(result).toBe(true);
+        expect(mutationSpy).toHaveBeenCalledWith(
+            RichTextEditingMutation.id,
+            expect.objectContaining({ historyActions: [historyAction] })
+        );
+    });
+});

packages/docs-drawing/src/commands/commands/remove-doc-drawing.command.ts

@@ -14,11 +14,12 @@
  * limitations under the License.
  */
 
-import type { DocumentDataModel, DrawingTypeEnum, IAccessor, ICommand, IDisposable, IMutationInfo, ITextRangeParam, JSONXActions } from '@univerjs/core';
+import type { DocumentDataModel, IAccessor, ICommand, IDisposable, IMutationInfo, ITextRangeParam, JSONXActions } from '@univerjs/core';
 import type { IRichTextEditingMutationParams } from '@univerjs/docs';
 import type { IDocDrawing } from '../../services/doc-drawing.service';
 import {
     CommandType,
+    DrawingTypeEnum,
     getRichTextEditPath,
     ICommandService,
     IUndoRedoService,
@@ -29,7 +30,7 @@ import {
     TextXActionType,
     UniverInstanceType,
 } from '@univerjs/core';
-import { DocSelectionManagerService, getContentInsertRange, normalizeTextRange, RichTextEditingMutation } from '@univerjs/docs';
+import { DocHistoryAction, DocSelectionManagerService, getContentInsertRange, normalizeTextRange, RichTextEditingMutation } from '@univerjs/docs';
 import { IDocDrawingAdapterService } from '../../services/doc-drawing-adapter.service';
 
 export interface IRemoveDocDrawingCommandParam {
@@ -136,9 +137,10 @@ export const RemoveDocDrawingCommand: ICommand = {
         const memoryCursor = new MemoryCursor();
         const cursorIndex = removeCustomBlocks[0]!.startIndex;
         const textRanges = [{ startOffset: cursorIndex, endOffset: cursorIndex }] as IRichTextEditingMutationParams['textRanges'];
+        const historyActions = getHistoryActions(removeDrawings);
         const doMutation: IMutationInfo<IRichTextEditingMutationParams> = {
             id: RichTextEditingMutation.id,
-            params: { unitId, actions: [], textRanges },
+            params: { unitId, actions: [], textRanges, historyActions },
         };
         const rawActions: JSONXActions = [];
 
@@ -174,6 +176,22 @@ export const RemoveDocDrawingCommand: ICommand = {
     },
 };
 
+function getHistoryActions(drawings: IRemoveDocDrawingCommandParam[]): DocHistoryAction[] {
+    const historyActions = drawings.flatMap((drawing): DocHistoryAction[] => {
+        switch (drawing.drawingType) {
+            case DrawingTypeEnum.DRAWING_IMAGE:
+                return [DocHistoryAction.DeleteImage];
+            case DrawingTypeEnum.DRAWING_SHAPE:
+                return [DocHistoryAction.DeleteShape];
+            case DrawingTypeEnum.DRAWING_CHART:
+                return [DocHistoryAction.DeleteChart];
+            default:
+                return [];
+        }
+    });
+    return [...new Set(historyActions)];
+}
+
 function executeResourceMutationGroups(
     mutationGroups: Array<{ redoMutations: IMutationInfo[]; undoMutations: IMutationInfo[] }>,
     commandService: ICommandService

packages/docs/src/commands/mutations/core-editing.mutation.ts

@@ -23,9 +23,22 @@ import { DocSelectionManagerService } from '../../services/doc-selection-manager
 import { DocSkeletonManagerService } from '../../services/doc-skeleton-manager.service';
 import { DocStateEmitService } from '../../services/doc-state-emit.service';
 
+export enum DocHistoryAction {
+    DeleteChart = 'delete-chart',
+    DeleteDivider = 'delete-divider',
+    DeleteImage = 'delete-image',
+    DeleteShape = 'delete-shape',
+    EditTableCell = 'edit-table-cell',
+    FormatParagraph = 'format-paragraph',
+    InsertCustomRange = 'insert-custom-range',
+    UpdateImage = 'update-image',
+    UpdatePageLayout = 'update-page-layout',
+}
+
 export interface IRichTextEditingMutationParams extends IMutationCommonParams {
     unitId: string;
     historyAction?: string;
+    historyActions?: string[];
     actions: JSONXActions;
     textRanges: Nullable<ITextRangeWithStyle[]>;
     segmentId?: string;

packages/docs/src/index.ts

@@ -14,15 +14,6 @@
  * limitations under the License.
  */
 
-export enum DocHistoryAction {
-    DeleteDivider = 'delete-divider',
-    EditTableCell = 'edit-table-cell',
-    FormatParagraph = 'format-paragraph',
-    InsertCustomRange = 'insert-custom-range',
-    UpdateImage = 'update-image',
-    UpdatePageLayout = 'update-page-layout',
-}
-
 export { DeleteTextCommand, InsertTextCommand, UpdateTextCommand } from './commands/commands/core-editing.command';
 export type {
     IDeleteTextCommandParams,
@@ -47,7 +38,7 @@ export type { ISetSectionHeaderFooterLinkCommandParams } from './commands/comman
 export { UpdateDocumentParagraphStyleCommand } from './commands/commands/update-document-paragraph-style.command';
 export { DeleteDocumentSectionBreakCommand, InsertDocumentColumnBreakCommand, InsertDocumentSectionBreakCommand, UpdateDocumentSectionCommand } from './commands/commands/update-document-section.command';
 export type { IDeleteDocumentSectionBreakCommandParams, IDocumentSectionConfig, IDocumentSectionUpdate, IInsertDocumentColumnBreakCommandParams, IInsertDocumentSectionBreakCommandParams, IUpdateDocumentSectionCommandParams } from './commands/commands/update-document-section.command';
-export { RichTextEditingMutation } from './commands/mutations/core-editing.mutation';
+export { DocHistoryAction, RichTextEditingMutation } from './commands/mutations/core-editing.mutation';
 export type { IRichTextEditingMutationParams } from './commands/mutations/core-editing.mutation';
 export { SetTextSelectionsOperation } from './commands/operations/text-selection.operation';
 export type { ISetTextSelectionsOperationParams } from './commands/operations/text-selection.operation';