mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-05-24 09:23:37 +00:00
05e512b1fe
- add/remove/sort/alignCenter/moveToContainer/paste 新增 doNotSelect 选项，控制操作后是否自动触发选中变化 - doUpdate/doRemove 改为始终同步当前选中列表中的节点引用，避免 state 持有已被替换/已删除的过期节点 - 顺手修复 doUpdate 在 splice(-1) 时误改最后一个选中项的 bug - 移除 update/doUpdate 的 selectedAfterUpdate 参数（语义已内化），move 不再暴露无意义的 doNotSelect - 新增 safeOptions / safeParent 辅助函数，兜底插件机制将 dispatch 注入到形参位置的场景 Co-authored-by: Cursor <cursoragent@cursor.com>
561 lines
18 KiB
TypeScript
561 lines
18 KiB
TypeScript
/*
|
||
* Tencent is pleased to support the open source community by making TMagicEditor available.
|
||
*
|
||
* Copyright (C) 2025 Tencent. All rights reserved.
|
||
*
|
||
* 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 { beforeAll, describe, expect, test } from 'vitest';
|
||
import { cloneDeep } from 'lodash-es';
|
||
|
||
import type { MApp } from '@tmagic/core';
|
||
import { NodeType } from '@tmagic/core';
|
||
|
||
import editorService from '@editor/services/editor';
|
||
import historyService from '@editor/services/history';
|
||
import storageService from '@editor/services/storage';
|
||
import { COPY_STORAGE_KEY, setEditorConfig } from '@editor/utils';
|
||
|
||
setEditorConfig({
|
||
// eslint-disable-next-line no-eval
|
||
parseDSL: (dsl: string) => eval(dsl),
|
||
customCreateMonacoEditor: (monaco, codeEditorEl, options) => monaco.editor.create(codeEditorEl, options),
|
||
customCreateMonacoDiffEditor: (monaco, codeEditorEl, options) =>
|
||
monaco.editor.createDiffEditor(codeEditorEl, options),
|
||
});
|
||
|
||
// mock window.localStage
|
||
class LocalStorageMock {
|
||
public length = 0;
|
||
|
||
private store: Record<string, string> = {};
|
||
|
||
clear() {
|
||
this.store = {};
|
||
this.length = 0;
|
||
}
|
||
|
||
getItem(key: string) {
|
||
return this.store[key] || null;
|
||
}
|
||
|
||
setItem(key: string, value: string) {
|
||
this.store[key] = String(value);
|
||
this.length += 1;
|
||
}
|
||
|
||
removeItem(key: string) {
|
||
delete this.store[key];
|
||
this.length -= 1;
|
||
}
|
||
|
||
// 这里用不到这个方法，只是为了mock完整localStorage
|
||
key(key: number) {
|
||
return Object.keys(this.store)[key];
|
||
}
|
||
}
|
||
|
||
globalThis.localStorage = new LocalStorageMock();
|
||
|
||
enum NodeId {
|
||
// 跟节点
|
||
ROOT_ID = 1,
|
||
// 页面节点
|
||
PAGE_ID = 2,
|
||
// 普通节点
|
||
NODE_ID = 3,
|
||
// 普通节点
|
||
NODE_ID2 = 4,
|
||
// 不存在的节点
|
||
ERROR_NODE_ID = 5,
|
||
}
|
||
|
||
// mock 页面数据，包含一个页面，两个组件
|
||
const root: MApp = {
|
||
id: NodeId.ROOT_ID,
|
||
type: NodeType.ROOT,
|
||
items: [
|
||
{
|
||
id: NodeId.PAGE_ID,
|
||
layout: 'absolute',
|
||
type: NodeType.PAGE,
|
||
style: {
|
||
width: 375,
|
||
},
|
||
items: [
|
||
{
|
||
id: NodeId.NODE_ID,
|
||
type: 'text',
|
||
style: {
|
||
width: 270,
|
||
},
|
||
},
|
||
{
|
||
id: NodeId.NODE_ID2,
|
||
type: 'text',
|
||
style: {},
|
||
},
|
||
],
|
||
},
|
||
],
|
||
};
|
||
|
||
describe('get', () => {
|
||
// 同一个设置页面数据
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('get', () => {
|
||
const root = editorService.get('root');
|
||
expect(root?.id).toBe(NodeId.ROOT_ID);
|
||
});
|
||
|
||
test('get undefined', () => {
|
||
// state中不存在的key
|
||
const root = editorService.get('a' as 'root');
|
||
expect(root).toBeUndefined();
|
||
});
|
||
});
|
||
|
||
describe('multiSelect 标志位', () => {
|
||
test('disabledMultiSelect 默认值为 false', () => {
|
||
expect(editorService.get('disabledMultiSelect')).toBe(false);
|
||
});
|
||
|
||
test('alwaysMultiSelect 默认值为 false', () => {
|
||
expect(editorService.get('alwaysMultiSelect')).toBe(false);
|
||
});
|
||
|
||
test('alwaysMultiSelect 可被 set 修改并通过 get 读取', () => {
|
||
editorService.set('alwaysMultiSelect', true);
|
||
expect(editorService.get('alwaysMultiSelect')).toBe(true);
|
||
editorService.set('alwaysMultiSelect', false);
|
||
expect(editorService.get('alwaysMultiSelect')).toBe(false);
|
||
});
|
||
});
|
||
|
||
describe('getNodeInfo', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', () => {
|
||
const info = editorService.getNodeInfo(NodeId.NODE_ID);
|
||
expect(info?.node?.id).toBe(NodeId.NODE_ID);
|
||
expect(info?.parent?.id).toBe(NodeId.PAGE_ID);
|
||
expect(info?.page?.id).toBe(NodeId.PAGE_ID);
|
||
});
|
||
|
||
test('异常', () => {
|
||
const info = editorService.getNodeInfo(NodeId.ERROR_NODE_ID);
|
||
expect(info?.node).toBeNull();
|
||
expect(info?.parent?.id).toBeUndefined();
|
||
expect(info?.page).toBeNull();
|
||
});
|
||
});
|
||
|
||
describe('getNodeById', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', () => {
|
||
const node = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(node?.id).toBe(NodeId.NODE_ID);
|
||
});
|
||
|
||
test('异常', () => {
|
||
const node = editorService.getNodeById(NodeId.ERROR_NODE_ID);
|
||
expect(node).toBeNull();
|
||
});
|
||
});
|
||
|
||
describe('getParentById', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', () => {
|
||
const node = editorService.getParentById(NodeId.NODE_ID);
|
||
expect(node?.id).toBe(NodeId.PAGE_ID);
|
||
});
|
||
|
||
test('异常', () => {
|
||
const node = editorService.getParentById(NodeId.ERROR_NODE_ID);
|
||
expect(node?.id).toBeUndefined();
|
||
});
|
||
});
|
||
|
||
describe('select', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('参数是id 正常', async () => {
|
||
// 选中一个节点，会对应更新parent, page
|
||
await editorService.select(NodeId.NODE_ID);
|
||
const node = editorService.get('node');
|
||
const parent = editorService.get('parent');
|
||
const page = editorService.get('page');
|
||
expect(node?.id).toBe(NodeId.NODE_ID);
|
||
expect(parent?.id).toBe(NodeId.PAGE_ID);
|
||
expect(page?.id).toBe(NodeId.PAGE_ID);
|
||
});
|
||
|
||
test('参数是config 正常', async () => {
|
||
await editorService.select({ id: NodeId.NODE_ID, type: 'text' });
|
||
const node = editorService.get('node');
|
||
const parent = editorService.get('parent');
|
||
const page = editorService.get('page');
|
||
expect(node?.id).toBe(NodeId.NODE_ID);
|
||
expect(parent?.id).toBe(NodeId.PAGE_ID);
|
||
expect(page?.id).toBe(NodeId.PAGE_ID);
|
||
});
|
||
|
||
test('参数是id undefined', () => {
|
||
expect(() => editorService.select(NodeId.ERROR_NODE_ID)).rejects.toThrowError('获取不到组件信息');
|
||
});
|
||
|
||
test('参数是config 没有id', () => {
|
||
expect(() => editorService.select({ id: '', type: 'text' })).rejects.toThrowError('没有ID，无法选中');
|
||
});
|
||
});
|
||
|
||
describe('add', () => {
|
||
test('正常', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
// 先选中容器
|
||
await editorService.select(NodeId.PAGE_ID);
|
||
const newNode = await editorService.add({
|
||
type: 'text',
|
||
});
|
||
// 添加后会选中这个节点
|
||
const node = editorService.get('node');
|
||
const parent = editorService.get('parent');
|
||
if (!Array.isArray(newNode)) {
|
||
expect(node?.id).toBe(newNode.id);
|
||
}
|
||
expect(parent?.items).toHaveLength(3);
|
||
});
|
||
|
||
test('正常， 当前不是容器', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
// 选中不是容器的节点
|
||
await editorService.select(NodeId.NODE_ID2);
|
||
// 会加到选中节点的父节点下
|
||
const newNode = await editorService.add({
|
||
type: 'text',
|
||
});
|
||
const node = editorService.get('node');
|
||
const parent = editorService.get('parent');
|
||
if (!Array.isArray(newNode)) {
|
||
expect(node?.id).toBe(newNode.id);
|
||
}
|
||
expect(parent?.items).toHaveLength(3);
|
||
});
|
||
|
||
test('往root下添加page', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.PAGE_ID);
|
||
const rootNode = editorService.get('root');
|
||
const newNode = await editorService.add(
|
||
{
|
||
type: NodeType.PAGE,
|
||
},
|
||
rootNode,
|
||
);
|
||
const node = editorService.get('node');
|
||
if (!Array.isArray(newNode)) {
|
||
expect(node?.id).toBe(newNode.id);
|
||
}
|
||
expect(rootNode?.items.length).toBe(2);
|
||
});
|
||
|
||
test('往root下添加普通节点', () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
// 根节点下只能加页面
|
||
const rootNode = editorService.get('root');
|
||
expect(() =>
|
||
editorService.add(
|
||
{
|
||
type: 'text',
|
||
},
|
||
rootNode,
|
||
),
|
||
).rejects.toThrowError('app下不能添加组件');
|
||
});
|
||
|
||
test('doNotSelect: true 不更新选中节点', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.NODE_ID);
|
||
const beforeNodeId = editorService.get('node')?.id;
|
||
expect(beforeNodeId).toBe(NodeId.NODE_ID);
|
||
|
||
const newNode = await editorService.add({ type: 'text' }, null, { doNotSelect: true });
|
||
|
||
// 节点已被添加到 dsl
|
||
const addedId = Array.isArray(newNode) ? newNode[0].id : newNode.id;
|
||
const parentInfo = editorService.getParentById(addedId);
|
||
expect(parentInfo?.items).toHaveLength(3);
|
||
|
||
// 但当前选中节点保持原状（未自动选中新增节点）
|
||
expect(editorService.get('node')?.id).toBe(beforeNodeId);
|
||
});
|
||
});
|
||
|
||
describe('remove', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', async () => {
|
||
editorService.remove({ id: NodeId.NODE_ID, type: 'text' });
|
||
const node = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(node).toBeNull();
|
||
});
|
||
|
||
test('remove page', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
editorService.select(NodeId.PAGE_ID);
|
||
const rootNode = editorService.get('root');
|
||
// 先加一个页面
|
||
const newPage = await editorService.add(
|
||
{
|
||
type: NodeType.PAGE,
|
||
},
|
||
rootNode,
|
||
);
|
||
expect(rootNode?.items.length).toBe(2);
|
||
await editorService.remove(newPage);
|
||
expect(rootNode?.items.length).toBe(1);
|
||
});
|
||
|
||
test('undefine', async () => {
|
||
expect(() => editorService.remove({ id: NodeId.ERROR_NODE_ID, type: 'text' })).rejects.toThrow();
|
||
});
|
||
|
||
test('doNotSelect: true 不更新选中节点', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
// 选中 NODE_ID，删除另外一个 NODE_ID2
|
||
await editorService.select(NodeId.NODE_ID);
|
||
const beforeNodeId = editorService.get('node')?.id;
|
||
expect(beforeNodeId).toBe(NodeId.NODE_ID);
|
||
|
||
await editorService.remove({ id: NodeId.NODE_ID2, type: 'text' }, { doNotSelect: true });
|
||
|
||
// 节点已被删除
|
||
expect(editorService.getNodeById(NodeId.NODE_ID2)).toBeNull();
|
||
// 当前选中节点保持原状（未自动选中父节点）
|
||
expect(editorService.get('node')?.id).toBe(beforeNodeId);
|
||
});
|
||
|
||
test('被删除节点正好是当前选中节点时，state 强制移除引用', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
// 选中 NODE_ID 后再删除 NODE_ID 自身
|
||
await editorService.select(NodeId.NODE_ID);
|
||
expect(editorService.get('node')?.id).toBe(NodeId.NODE_ID);
|
||
|
||
// 即使 doNotSelect: true，被删除节点正好是当前选中节点时，state 也必须移除引用
|
||
await editorService.remove({ id: NodeId.NODE_ID, type: 'text' }, { doNotSelect: true });
|
||
|
||
// 节点已删除
|
||
expect(editorService.getNodeById(NodeId.NODE_ID)).toBeNull();
|
||
// state.nodes 中不再包含被删除的节点
|
||
expect(editorService.get('nodes').some((n) => n.id === NodeId.NODE_ID)).toBe(false);
|
||
});
|
||
});
|
||
|
||
describe('update', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', async () => {
|
||
await editorService.select(NodeId.PAGE_ID);
|
||
await editorService.update({ id: NodeId.NODE_ID, type: 'text', text: 'text' });
|
||
const node = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(node?.text).toBe('text');
|
||
});
|
||
|
||
test('没有id', async () => {
|
||
try {
|
||
await editorService.update({ type: 'text', text: 'text', id: '' });
|
||
} catch (e: any) {
|
||
expect(e.message).toBe('没有配置或者配置缺少id值');
|
||
}
|
||
});
|
||
|
||
test('没有type', async () => {
|
||
// 一般可能出现在外边扩展功能
|
||
try {
|
||
await editorService.update({ type: '', text: 'text', id: NodeId.NODE_ID });
|
||
} catch (e: any) {
|
||
expect(e.message).toBe('配置缺少type值');
|
||
}
|
||
});
|
||
|
||
test('id对应节点不存在', async () => {
|
||
try {
|
||
// 设置当前编辑的页面
|
||
await editorService.select(NodeId.PAGE_ID);
|
||
await editorService.update({ type: 'text', text: 'text', id: NodeId.ERROR_NODE_ID });
|
||
} catch (e: any) {
|
||
expect(e.message).toBe(`获取不到id为${NodeId.ERROR_NODE_ID}的节点`);
|
||
}
|
||
});
|
||
|
||
test('fixed与absolute切换', async () => {
|
||
// 设置当前编辑的页面
|
||
await editorService.select(NodeId.PAGE_ID);
|
||
await editorService.update({ id: NodeId.NODE_ID, type: 'text', style: { position: 'fixed' } });
|
||
const node = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(node?.style?.position).toBe('fixed');
|
||
await editorService.update({ id: NodeId.NODE_ID, type: 'text', style: { position: 'absolute' } });
|
||
const node2 = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(node2?.style?.position).toBe('absolute');
|
||
});
|
||
|
||
test('被更新节点正好是当前选中节点时，state.node 始终与 dsl 同步', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.NODE_ID);
|
||
|
||
await editorService.update({ id: NodeId.NODE_ID, type: 'text', text: 'updated-text' });
|
||
|
||
// dsl 已更新
|
||
expect(editorService.getNodeById(NodeId.NODE_ID)?.text).toBe('updated-text');
|
||
// state.node 引用同步到新节点，不会持有过期数据
|
||
expect(editorService.get('node')?.text).toBe('updated-text');
|
||
});
|
||
|
||
test('更新非选中节点时，不影响当前选中列表', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.NODE_ID);
|
||
const beforeSelected = editorService.get('node');
|
||
|
||
// 更新另一个非选中节点
|
||
await editorService.update({ id: NodeId.NODE_ID2, type: 'text', text: 'other-text' });
|
||
|
||
// dsl 已更新
|
||
expect(editorService.getNodeById(NodeId.NODE_ID2)?.text).toBe('other-text');
|
||
// 原选中节点引用不被错误替换（修复 splice(-1) 误改最后一个选中项的旧 bug）
|
||
expect(editorService.get('node')?.id).toBe(NodeId.NODE_ID);
|
||
expect(editorService.get('node')).toBe(beforeSelected);
|
||
});
|
||
});
|
||
|
||
describe('sort', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', async () => {
|
||
await editorService.select(NodeId.NODE_ID2);
|
||
let parent = editorService.get('parent');
|
||
expect(parent?.items[0].id).toBe(NodeId.NODE_ID);
|
||
await editorService.sort(NodeId.NODE_ID2, NodeId.NODE_ID);
|
||
parent = editorService.get('parent');
|
||
expect(parent?.items[0].id).toBe(NodeId.NODE_ID2);
|
||
});
|
||
|
||
test('doNotSelect: true 完成排序且不触发额外 select', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.NODE_ID2);
|
||
const parentBefore = editorService.get('parent');
|
||
expect(parentBefore?.items[0].id).toBe(NodeId.NODE_ID);
|
||
|
||
await editorService.sort(NodeId.NODE_ID2, NodeId.NODE_ID, { doNotSelect: true });
|
||
|
||
// dsl 顺序已更新
|
||
const parentAfter = editorService.getParentById(NodeId.NODE_ID2);
|
||
expect(parentAfter?.items[0].id).toBe(NodeId.NODE_ID2);
|
||
});
|
||
});
|
||
|
||
describe('copy', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
test('正常', async () => {
|
||
const node = editorService.getNodeById(NodeId.NODE_ID2);
|
||
await editorService.copy(node!);
|
||
const str = storageService.getItem(COPY_STORAGE_KEY);
|
||
expect(str).toHaveLength(1);
|
||
});
|
||
});
|
||
|
||
describe('paste', () => {
|
||
test('doNotSelect: true 不更新选中节点', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.NODE_ID);
|
||
|
||
const sourceNode = editorService.getNodeById(NodeId.NODE_ID2);
|
||
await editorService.copy(sourceNode!);
|
||
|
||
const beforeNodeId = editorService.get('node')?.id;
|
||
expect(beforeNodeId).toBe(NodeId.NODE_ID);
|
||
|
||
const pasted = await editorService.paste({}, undefined, { doNotSelect: true });
|
||
|
||
// 粘贴成功
|
||
expect(pasted).toBeTruthy();
|
||
// 当前选中节点保持原状
|
||
expect(editorService.get('node')?.id).toBe(beforeNodeId);
|
||
});
|
||
});
|
||
|
||
describe('moveLayer', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', async () => {
|
||
// 设置当前编辑的组件
|
||
await editorService.select(NodeId.NODE_ID);
|
||
const parent = editorService.get('parent');
|
||
await editorService.moveLayer(1);
|
||
expect(parent?.items[0].id).toBe(NodeId.NODE_ID2);
|
||
});
|
||
});
|
||
|
||
describe('插件参数兜底', () => {
|
||
test('add 的 parent 形参传入函数时不抛错，仍走默认父节点逻辑', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.NODE_ID);
|
||
|
||
// 模拟 BaseService 中间件机制在 parent 位置注入 dispatch 函数
|
||
const dispatchFn = () => {};
|
||
const newNode = await editorService.add({ type: 'text' }, dispatchFn as any);
|
||
|
||
// 默认行为：被加到了当前选中节点的父节点 (PAGE)
|
||
const addedId = Array.isArray(newNode) ? newNode[0].id : newNode.id;
|
||
const parentInfo = editorService.getParentById(addedId);
|
||
expect(parentInfo?.id).toBe(NodeId.PAGE_ID);
|
||
});
|
||
|
||
test('add 的 options 形参传入函数时不抛错，doNotSelect 回落为默认值', async () => {
|
||
editorService.set('root', cloneDeep(root));
|
||
await editorService.select(NodeId.NODE_ID);
|
||
|
||
// 模拟 BaseService 中间件机制在 options 位置注入 dispatch 函数
|
||
const dispatchFn = () => {};
|
||
const newNode = await editorService.add({ type: 'text' }, null, dispatchFn as any);
|
||
|
||
// 默认行为：当前选中节点变成了新增节点
|
||
const addedId = Array.isArray(newNode) ? newNode[0].id : newNode.id;
|
||
expect(editorService.get('node')?.id).toBe(addedId);
|
||
});
|
||
});
|
||
|
||
describe('undo redo', () => {
|
||
beforeAll(() => editorService.set('root', cloneDeep(root)));
|
||
|
||
test('正常', async () => {
|
||
historyService.reset();
|
||
// 设置当前编辑的组件
|
||
await editorService.select(NodeId.NODE_ID);
|
||
const node = editorService.get('node');
|
||
if (!node) throw new Error('未选中节点');
|
||
await editorService.remove(node);
|
||
const removedNode = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(removedNode).toBeNull();
|
||
await editorService.undo();
|
||
const undoNode = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(undoNode?.id).toBe(NodeId.NODE_ID);
|
||
await editorService.redo();
|
||
const redoNode = editorService.getNodeById(NodeId.NODE_ID);
|
||
expect(redoNode?.id).toBeUndefined();
|
||
});
|
||
});
|