fix: 兼容低版本浏览器消息复制
- 为 Chrome 90 增加剪贴板兼容回退 - 统一聊天与智能体试运行的原色对勾反馈
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
<script setup lang="ts">
|
||||
import {Copy, RotateCw} from '@easyflow/icons';
|
||||
import { onBeforeUnmount, ref } from 'vue';
|
||||
|
||||
import { Check, Copy, RotateCw } from '@easyflow/icons';
|
||||
|
||||
import ChatVariantNavigator from './ChatVariantNavigator.vue';
|
||||
|
||||
@@ -8,6 +10,7 @@ const props = withDefaults(
|
||||
align?: 'end' | 'start';
|
||||
allowCopy?: boolean;
|
||||
allowRegenerate?: boolean;
|
||||
copyAction?: () => boolean | Promise<boolean>;
|
||||
disabledVariantNext?: boolean;
|
||||
disabledVariantPrevious?: boolean;
|
||||
regenerateDisabled?: boolean;
|
||||
@@ -20,6 +23,7 @@ const props = withDefaults(
|
||||
align: 'start',
|
||||
allowCopy: false,
|
||||
allowRegenerate: false,
|
||||
copyAction: undefined,
|
||||
disabledVariantNext: false,
|
||||
disabledVariantPrevious: false,
|
||||
regenerateDisabled: false,
|
||||
@@ -37,12 +41,53 @@ const emit = defineEmits<{
|
||||
selectPreviousVariant: [];
|
||||
}>();
|
||||
|
||||
const copied = ref(false);
|
||||
const copying = ref(false);
|
||||
const COPIED_FEEDBACK_DURATION_MS = 3000;
|
||||
let copiedResetTimer: ReturnType<typeof setTimeout> | undefined;
|
||||
|
||||
async function handleCopy() {
|
||||
if (copying.value) {
|
||||
return;
|
||||
}
|
||||
if (!props.copyAction) {
|
||||
emit('copy');
|
||||
return;
|
||||
}
|
||||
|
||||
copying.value = true;
|
||||
try {
|
||||
const success = await props.copyAction();
|
||||
if (!success) {
|
||||
return;
|
||||
}
|
||||
copied.value = true;
|
||||
if (copiedResetTimer) {
|
||||
clearTimeout(copiedResetTimer);
|
||||
}
|
||||
copiedResetTimer = setTimeout(() => {
|
||||
copied.value = false;
|
||||
copiedResetTimer = undefined;
|
||||
}, COPIED_FEEDBACK_DURATION_MS);
|
||||
} catch (error) {
|
||||
console.error('复制消息失败:', error);
|
||||
} finally {
|
||||
copying.value = false;
|
||||
}
|
||||
}
|
||||
|
||||
function handleRegenerate() {
|
||||
if (props.regenerateDisabled) {
|
||||
return;
|
||||
}
|
||||
emit('regenerate');
|
||||
}
|
||||
|
||||
onBeforeUnmount(() => {
|
||||
if (copiedResetTimer) {
|
||||
clearTimeout(copiedResetTimer);
|
||||
}
|
||||
});
|
||||
</script>
|
||||
|
||||
<template>
|
||||
@@ -55,11 +100,15 @@ function handleRegenerate() {
|
||||
v-if="allowCopy"
|
||||
type="button"
|
||||
class="chat-message-toolbar__button"
|
||||
aria-label="复制消息"
|
||||
title="复制"
|
||||
@click="emit('copy')"
|
||||
:aria-busy="copying"
|
||||
:aria-label="copied ? '复制成功' : '复制消息'"
|
||||
:title="copied ? '复制成功' : '复制'"
|
||||
@click="handleCopy"
|
||||
>
|
||||
<Copy />
|
||||
<Transition name="chat-message-toolbar__icon" mode="out-in">
|
||||
<Check v-if="copied" key="check" />
|
||||
<Copy v-else key="copy" />
|
||||
</Transition>
|
||||
</button>
|
||||
<button
|
||||
v-if="allowRegenerate"
|
||||
@@ -140,4 +189,17 @@ function handleRegenerate() {
|
||||
width: 14px;
|
||||
height: 14px;
|
||||
}
|
||||
|
||||
.chat-message-toolbar__icon-enter-active,
|
||||
.chat-message-toolbar__icon-leave-active {
|
||||
transition:
|
||||
opacity var(--motion-duration-fast) var(--motion-ease-standard),
|
||||
transform var(--motion-duration-fast) var(--motion-ease-standard);
|
||||
}
|
||||
|
||||
.chat-message-toolbar__icon-enter-from,
|
||||
.chat-message-toolbar__icon-leave-to {
|
||||
opacity: 0;
|
||||
transform: scale(0.88);
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -13,6 +13,7 @@ import ChatTimelineItem from './ChatTimelineItem.vue';
|
||||
const props = defineProps<{
|
||||
approvalLoading?: boolean;
|
||||
copyable?: (item: ChatTimelineMessageItem) => boolean;
|
||||
copyAction?: (item: ChatTimelineMessageItem) => boolean | Promise<boolean>;
|
||||
emptyText?: string;
|
||||
imageLoader?: ChatImageLoader;
|
||||
items: ChatTimelineItemType[];
|
||||
@@ -157,6 +158,7 @@ watch(
|
||||
:item="item"
|
||||
:image-loader="imageLoader"
|
||||
:approval-loading="approvalLoading"
|
||||
:copy-action="copyAction"
|
||||
:copyable="canCopyMessage(item)"
|
||||
:regenerable="canRegenerateMessage(item)"
|
||||
:regenerate-disabled="regenerateDisabled"
|
||||
|
||||
@@ -21,6 +21,7 @@ import ChatToolCard from './ChatToolCard.vue';
|
||||
const props = defineProps<{
|
||||
approvalLoading?: boolean;
|
||||
copyable?: boolean;
|
||||
copyAction?: (item: ChatTimelineMessageItem) => boolean | Promise<boolean>;
|
||||
regenerable?: boolean;
|
||||
regenerateDisabled?: boolean;
|
||||
assistantActionsVisible?: boolean;
|
||||
@@ -118,6 +119,14 @@ function updateThinkingExpanded(partId: string, expanded: boolean) {
|
||||
part.expanded = expanded;
|
||||
}
|
||||
}
|
||||
|
||||
function handleCopyAction() {
|
||||
const item = messageItem.value;
|
||||
if (!item || !props.copyAction) {
|
||||
return false;
|
||||
}
|
||||
return props.copyAction(item);
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
@@ -161,6 +170,7 @@ function updateThinkingExpanded(partId: string, expanded: boolean) {
|
||||
:align="messageItem.role === 'user' ? 'end' : 'start'"
|
||||
:allow-copy="copyable"
|
||||
:allow-regenerate="regenerable"
|
||||
:copy-action="copyAction ? handleCopyAction : undefined"
|
||||
:disabled-variant-next="disabledVariantNext"
|
||||
:disabled-variant-previous="disabledVariantPrevious"
|
||||
:regenerate-disabled="regenerateDisabled"
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import type {ChatTimelineItem} from '../types';
|
||||
|
||||
import {mount} from '@vue/test-utils';
|
||||
import {flushPromises, mount} from '@vue/test-utils';
|
||||
|
||||
import {describe, expect, it} from 'vitest';
|
||||
import {afterEach, describe, expect, it, vi} from 'vitest';
|
||||
|
||||
import ChatTimeline from '../ChatTimeline.vue';
|
||||
|
||||
@@ -28,6 +28,10 @@ function textMessage(
|
||||
}
|
||||
|
||||
describe('ChatTimeline toolbar', () => {
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it('shows copy button for user messages and emits copy-message', async () => {
|
||||
const userMessage = textMessage('user', '用户问题');
|
||||
const wrapper = mount(ChatTimeline, {
|
||||
@@ -70,6 +74,32 @@ describe('ChatTimeline toolbar', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('shows a check icon after the copy action succeeds', async () => {
|
||||
vi.useFakeTimers();
|
||||
const copyAction = vi.fn().mockResolvedValue(true);
|
||||
const userMessage = textMessage('user', '用户问题');
|
||||
const wrapper = mount(ChatTimeline, {
|
||||
props: {
|
||||
copyAction,
|
||||
copyable: () => true,
|
||||
items: [userMessage],
|
||||
},
|
||||
});
|
||||
|
||||
await wrapper.get('[aria-label="复制消息"]').trigger('click');
|
||||
await flushPromises();
|
||||
|
||||
expect(copyAction).toHaveBeenCalledWith(userMessage);
|
||||
expect(wrapper.get('button').attributes('aria-label')).toBe('复制成功');
|
||||
expect(
|
||||
wrapper.find('.chat-message-toolbar__button.is-copied').exists(),
|
||||
).toBe(false);
|
||||
expect(wrapper.emitted('copyMessage')).toBeUndefined();
|
||||
|
||||
await vi.advanceTimersByTimeAsync(3000);
|
||||
expect(wrapper.get('button').attributes('aria-label')).toBe('复制消息');
|
||||
});
|
||||
|
||||
it('renders variant navigator and disables boundary buttons', async () => {
|
||||
const assistantMessage = textMessage('assistant', '助手回答', {
|
||||
roundId: 'round-1',
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
|
||||
import { copyTextToClipboard } from '../clipboard';
|
||||
|
||||
describe('copyTextToClipboard', () => {
|
||||
const originalClipboard = Object.getOwnPropertyDescriptor(
|
||||
navigator,
|
||||
'clipboard',
|
||||
);
|
||||
const originalExecCommand = Object.getOwnPropertyDescriptor(
|
||||
document,
|
||||
'execCommand',
|
||||
);
|
||||
const originalSecureContext = Object.getOwnPropertyDescriptor(
|
||||
globalThis,
|
||||
'isSecureContext',
|
||||
);
|
||||
|
||||
beforeEach(() => {
|
||||
Object.defineProperty(document, 'execCommand', {
|
||||
configurable: true,
|
||||
value: vi.fn(() => true),
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
restoreProperty(navigator, 'clipboard', originalClipboard);
|
||||
restoreProperty(document, 'execCommand', originalExecCommand);
|
||||
restoreProperty(globalThis, 'isSecureContext', originalSecureContext);
|
||||
document
|
||||
.querySelectorAll('textarea[aria-hidden="true"]')
|
||||
.forEach((node) => node.remove());
|
||||
});
|
||||
|
||||
it('uses Clipboard API in a secure context', async () => {
|
||||
const writeText = vi.fn().mockResolvedValue(undefined);
|
||||
stubSecureContext(true);
|
||||
stubClipboard(writeText);
|
||||
|
||||
await expect(copyTextToClipboard('测试内容')).resolves.toBe(
|
||||
'clipboard-api',
|
||||
);
|
||||
expect(writeText).toHaveBeenCalledWith('测试内容');
|
||||
expect(document.execCommand).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('falls back to execCommand in an insecure context', async () => {
|
||||
const writeText = vi.fn().mockResolvedValue(undefined);
|
||||
stubSecureContext(false);
|
||||
stubClipboard(writeText);
|
||||
|
||||
await expect(copyTextToClipboard('Chrome 90')).resolves.toBe(
|
||||
'exec-command',
|
||||
);
|
||||
expect(writeText).not.toHaveBeenCalled();
|
||||
expect(document.execCommand).toHaveBeenCalledWith('copy');
|
||||
expect(document.querySelector('textarea[aria-hidden="true"]')).toBeNull();
|
||||
});
|
||||
|
||||
it('falls back when Clipboard API is denied', async () => {
|
||||
const writeText = vi.fn().mockRejectedValue(new DOMException('denied'));
|
||||
stubSecureContext(true);
|
||||
stubClipboard(writeText);
|
||||
|
||||
await expect(copyTextToClipboard('兼容内容')).resolves.toBe('exec-command');
|
||||
expect(document.execCommand).toHaveBeenCalledWith('copy');
|
||||
});
|
||||
|
||||
it('throws and cleans up when all copy methods fail', async () => {
|
||||
stubSecureContext(false);
|
||||
Object.defineProperty(document, 'execCommand', {
|
||||
configurable: true,
|
||||
value: vi.fn(() => false),
|
||||
});
|
||||
|
||||
await expect(copyTextToClipboard('失败内容')).rejects.toThrow(
|
||||
'浏览器拒绝了复制操作',
|
||||
);
|
||||
expect(document.querySelector('textarea[aria-hidden="true"]')).toBeNull();
|
||||
});
|
||||
|
||||
function stubClipboard(writeText: ReturnType<typeof vi.fn>) {
|
||||
Object.defineProperty(navigator, 'clipboard', {
|
||||
configurable: true,
|
||||
value: { writeText },
|
||||
});
|
||||
}
|
||||
|
||||
function stubSecureContext(value: boolean) {
|
||||
Object.defineProperty(globalThis, 'isSecureContext', {
|
||||
configurable: true,
|
||||
value,
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
function restoreProperty(
|
||||
target: object,
|
||||
property: PropertyKey,
|
||||
descriptor?: PropertyDescriptor,
|
||||
) {
|
||||
if (descriptor) {
|
||||
Object.defineProperty(target, property, descriptor);
|
||||
return;
|
||||
}
|
||||
Reflect.deleteProperty(target, property);
|
||||
}
|
||||
52
easyflow-ui-admin/packages/utils/src/helpers/clipboard.ts
Normal file
52
easyflow-ui-admin/packages/utils/src/helpers/clipboard.ts
Normal file
@@ -0,0 +1,52 @@
|
||||
export type ClipboardCopyMethod = 'clipboard-api' | 'exec-command';
|
||||
|
||||
/**
|
||||
* 将文本写入系统剪贴板,并在现代 Clipboard API 不可用时降级处理。
|
||||
*
|
||||
* @param text 要复制的文本。
|
||||
* @returns 实际使用的复制方式。
|
||||
* @throws 当浏览器环境不可用或所有复制方式均失败时抛出异常。
|
||||
*/
|
||||
export async function copyTextToClipboard(
|
||||
text: string,
|
||||
): Promise<ClipboardCopyMethod> {
|
||||
if (typeof document === 'undefined' || typeof navigator === 'undefined') {
|
||||
throw new TypeError('当前环境不支持剪贴板操作');
|
||||
}
|
||||
|
||||
if (globalThis.isSecureContext && navigator.clipboard?.writeText) {
|
||||
try {
|
||||
await navigator.clipboard.writeText(text);
|
||||
return 'clipboard-api';
|
||||
} catch {
|
||||
// 权限或浏览器策略拒绝时继续使用兼容方案。
|
||||
}
|
||||
}
|
||||
|
||||
const textArea = document.createElement('textarea');
|
||||
const activeElement = document.activeElement;
|
||||
textArea.value = text;
|
||||
textArea.readOnly = true;
|
||||
textArea.setAttribute('aria-hidden', 'true');
|
||||
textArea.style.position = 'fixed';
|
||||
textArea.style.top = '0';
|
||||
textArea.style.left = '-9999px';
|
||||
textArea.style.opacity = '0';
|
||||
|
||||
try {
|
||||
document.body.append(textArea);
|
||||
textArea.focus({ preventScroll: true });
|
||||
textArea.select();
|
||||
textArea.setSelectionRange(0, textArea.value.length);
|
||||
|
||||
if (!document.execCommand('copy')) {
|
||||
throw new Error('浏览器拒绝了复制操作');
|
||||
}
|
||||
return 'exec-command';
|
||||
} finally {
|
||||
textArea.remove();
|
||||
if (activeElement instanceof HTMLElement) {
|
||||
activeElement.focus({ preventScroll: true });
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
export * from './chat-time';
|
||||
export * from './chat-variant-switch';
|
||||
export * from './clipboard';
|
||||
export * from './find-menu-by-path';
|
||||
export * from './generate-menus';
|
||||
export * from './generate-routes-backend';
|
||||
|
||||
Reference in New Issue
Block a user