fix(web): standardize user picker and message detail

This commit is contained in:
2026-06-18 00:30:01 +08:00
parent b0537f87ae
commit 16393c183c
9 changed files with 429 additions and 71 deletions

View File

@@ -0,0 +1,9 @@
export const OPEN_MESSAGE_DETAIL_EVENT = 'eip4:open-message-detail';
export const MESSAGE_DETAIL_CHANGED_EVENT = 'eip4:message-detail-changed';
export interface MessageDetailRequest {
kind: 'received' | 'sent';
receiveId?: string;
messageId?: string;
title?: string;
}

View File

@@ -0,0 +1,76 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { OPEN_MESSAGE_DETAIL_EVENT } from './messageActionEvents';
import { registerMessageAction, __resetMessageActionForTest } from './registerMessageAction';
interface RunCtx {
run: (action: { args?: Record<string, unknown> }, renderer: unknown, event: unknown) => Promise<void>;
}
describe('registerMessageAction', () => {
beforeEach(() => {
__resetMessageActionForTest();
});
it('amis-core 缺 registerAction 时返回 false', () => {
expect(registerMessageAction(null)).toBe(false);
expect(registerMessageAction({})).toBe(false);
});
it('注册 openMessageDetail 动作(幂等)', () => {
const registerAction = vi.fn();
const core = { registerAction };
expect(registerMessageAction(core)).toBe(true);
expect(registerAction).toHaveBeenCalledTimes(1);
expect(registerAction.mock.calls[0][0]).toBe('openMessageDetail');
expect(registerMessageAction(core)).toBe(true);
expect(registerAction).toHaveBeenCalledTimes(1);
});
it('received 消息派发 receiveId', async () => {
let captured: RunCtx | null = null;
registerMessageAction({
registerAction: (_type: string, action: RunCtx) => {
captured = action;
},
});
const seen: unknown[] = [];
const listener = (event: Event) => seen.push((event as CustomEvent).detail);
window.addEventListener(OPEN_MESSAGE_DETAIL_EVENT, listener);
try {
await captured!.run({
args: { kind: 'received', receiveId: 'recv-1', title: '消息' },
}, {}, {});
} finally {
window.removeEventListener(OPEN_MESSAGE_DETAIL_EVENT, listener);
}
expect(seen).toEqual([{ kind: 'received', receiveId: 'recv-1', messageId: undefined, title: '消息' }]);
});
it('sent 消息派发 messageId,缺 id 不派发', async () => {
let captured: RunCtx | null = null;
registerMessageAction({
registerAction: (_type: string, action: RunCtx) => {
captured = action;
},
});
const listener = vi.fn();
window.addEventListener(OPEN_MESSAGE_DETAIL_EVENT, listener);
try {
await captured!.run({ args: { kind: 'sent' } }, {}, {});
await captured!.run({ args: { kind: 'sent', messageId: 'msg-1' } }, {}, {});
} finally {
window.removeEventListener(OPEN_MESSAGE_DETAIL_EVENT, listener);
}
expect(listener).toHaveBeenCalledTimes(1);
expect((listener.mock.calls[0][0] as CustomEvent).detail).toEqual({
kind: 'sent',
receiveId: undefined,
messageId: 'msg-1',
title: undefined,
});
});
});

View File

@@ -0,0 +1,65 @@
import { OPEN_MESSAGE_DETAIL_EVENT, type MessageDetailRequest } from './messageActionEvents';
interface OpenMessageActionArg {
args?: {
kind?: unknown;
receiveId?: unknown;
messageId?: unknown;
title?: unknown;
};
[key: string]: unknown;
}
interface AmisRenderer {
[key: string]: unknown;
}
interface AmisEvent {
[key: string]: unknown;
}
interface AmisCore {
registerAction?: (type: string, action: unknown) => void;
}
let registered = false;
function asString(v: unknown): string | undefined {
if (v === null || v === undefined) return undefined;
const s = String(v).trim();
return s ? s : undefined;
}
function asKind(v: unknown): MessageDetailRequest['kind'] {
return asString(v) === 'sent' ? 'sent' : 'received';
}
export function registerMessageAction(amisCore: AmisCore | undefined | null): boolean {
if (registered) return true;
if (!amisCore || typeof amisCore.registerAction !== 'function') return false;
amisCore.registerAction('openMessageDetail', {
async run(action: OpenMessageActionArg, _renderer: AmisRenderer, _event: AmisEvent) {
const args = action?.args ?? {};
const kind = asKind(args.kind);
const receiveId = asString(args.receiveId);
const messageId = asString(args.messageId);
if (kind === 'received' && !receiveId) return;
if (kind === 'sent' && !messageId) return;
const detail: MessageDetailRequest = {
kind,
receiveId,
messageId,
title: asString(args.title),
};
window.dispatchEvent(new CustomEvent<MessageDetailRequest>(OPEN_MESSAGE_DETAIL_EVENT, { detail }));
},
});
registered = true;
return true;
}
export function __resetMessageActionForTest(): void {
registered = false;
}

View File

@@ -4,7 +4,6 @@ import {
registerUserTransferPicker,
__resetUserTransferPickerForTest,
} from './registerUserTransferPicker';
import { UserTransferPicker } from '../components/UserTransferPicker';
describe('registerUserTransferPicker', () => {
beforeEach(() => {
@@ -16,22 +15,6 @@ describe('registerUserTransferPicker', () => {
expect(registerUserTransferPicker({})).toBe(false);
});
it('优先按 FormItem 注册,保留 label 和表单值绑定', () => {
const registerFormItem = vi.fn();
const registerRenderer = vi.fn();
expect(registerUserTransferPicker({ registerFormItem, registerRenderer })).toBe(true);
expect(registerFormItem).toHaveBeenCalledTimes(1);
expect(registerRenderer).not.toHaveBeenCalled();
expect(registerFormItem.mock.calls[0][0]).toMatchObject({
type: 'user-transfer-picker',
name: 'user-transfer-picker',
component: UserTransferPicker,
strictMode: false,
override: true,
});
});
it('注册 schema filter,把老单选用户框改成标准 picker', () => {
let filter: ((schema: Record<string, unknown>) => Record<string, unknown>) | null = null;
const addSchemaFilter = vi.fn((fn) => {
@@ -57,32 +40,12 @@ describe('registerUserTransferPicker', () => {
expect(filter!({ type: 'select', mode: 'multiple' })).toEqual({ type: 'select', mode: 'multiple' });
});
it('没有 registerFormItem 时退回 renderer 注册(幂等)', () => {
const registerRenderer = vi.fn();
expect(registerUserTransferPicker({ registerRenderer })).toBe(true);
expect(registerRenderer).toHaveBeenCalledTimes(1);
expect(registerRenderer.mock.calls[0][0]).toMatchObject({
type: 'user-transfer-picker',
name: 'user-transfer-picker',
component: UserTransferPicker,
isFormItem: true,
override: true,
});
expect(registerUserTransferPicker({ registerRenderer })).toBe(true);
expect(registerRenderer).toHaveBeenCalledTimes(1);
});
it('renderer 已注册后仍允许补注册 schema filter', () => {
it('只注册 schema filter,不再注册旧自定义控件', () => {
const registerFormItem = vi.fn();
const addSchemaFilter = vi.fn();
expect(registerUserTransferPicker({ registerFormItem })).toBe(true);
expect(registerFormItem).toHaveBeenCalledTimes(1);
expect(registerUserTransferPicker({ addSchemaFilter, registerFormItem })).toBe(true);
expect(registerFormItem).toHaveBeenCalledTimes(1);
expect(registerFormItem).not.toHaveBeenCalled();
expect(addSchemaFilter).toHaveBeenCalledTimes(1);
});
@@ -114,6 +77,10 @@ describe('registerUserTransferPicker', () => {
labelField: '_label',
valueField: '_id',
placeholder: '请点击右侧的图标',
overflowConfig: {
maxTagCount: 1,
displayPosition: ['select'],
},
},
],
});

View File

@@ -1,13 +1,7 @@
import { UserTransferPicker } from '../components/UserTransferPicker';
type AmisRendererRegistry = {
registerRenderer?: (config: Record<string, unknown>) => unknown;
registerFormItem?: (config: Record<string, unknown>) => unknown;
addSchemaFilter?: (filter: (schema: Record<string, unknown>) => Record<string, unknown>) => unknown;
getRendererByName?: (name: string) => unknown;
};
let rendererRegistered = false;
let schemaFilterRegistered = false;
const USER_SELECT_MODES = new Set(['controlled', 'all', 'org', 'attendance']);
@@ -35,6 +29,10 @@ function userPickerSchema(schema: Record<string, unknown>, mode: string, multipl
next.clearable = next.clearable ?? true;
if (multiple) {
next.multiple = true;
next.overflowConfig = next.overflowConfig ?? {
maxTagCount: 1,
displayPosition: ['select'],
};
}
next.source = `/api/picker/${USER_SELECT_DIALOG_IDS_BY_MODE[mode] ?? USER_SELECT_DIALOG_IDS_BY_MODE.controlled}/list`;
next.labelField = '_label';
@@ -101,33 +99,9 @@ export function registerUserTransferPicker(amisCore: AmisRendererRegistry | unde
schemaFilterRegistered = true;
}
if (rendererRegistered) return true;
if (typeof amisCore.registerFormItem === 'function') {
amisCore.registerFormItem({
type: 'user-transfer-picker',
name: 'user-transfer-picker',
component: UserTransferPicker,
strictMode: false,
override: true,
});
rendererRegistered = true;
return true;
}
if (typeof amisCore.registerRenderer !== 'function') return false;
amisCore.registerRenderer({
type: 'user-transfer-picker',
name: 'user-transfer-picker',
isFormItem: true,
component: UserTransferPicker,
override: true,
});
rendererRegistered = true;
return true;
return schemaFilterRegistered;
}
export function __resetUserTransferPickerForTest(): void {
rendererRegistered = false;
schemaFilterRegistered = false;
}