Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions dashboard/src/components/chat/ChatInput.vue
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@
ref="inputField"
v-model="localPrompt"
@keydown="handleKeyDown"
@compositionstart="handleCompositionStart"
@compositionend="handleCompositionEnd"
@compositioncancel="handleCompositionEnd"
@blur="clearCompositionState()"
:disabled="disabled"
placeholder="Ask AstrBot..."
class="chat-textarea"
Comment thread
sourcery-ai[bot] marked this conversation as resolved.
Expand Down Expand Up @@ -307,6 +311,7 @@ import {
import { useDisplay } from "vuetify";
import { useModuleI18n } from "@/i18n/composables";
import { useCustomizerStore } from "@/stores/customizer";
import { isComposingEnter } from "@/utils/imeInput.mjs";
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In a TypeScript/Vite environment, it is standard practice to omit the file extension in import statements. This makes the code cleaner and more resilient to file type changes, such as converting the utility from .mjs to .ts.

import { isComposingEnter } from "@/utils/imeInput";

import ConfigSelector from "./ConfigSelector.vue";
import ProviderModelMenu from "./ProviderModelMenu.vue";
import StyledMenu from "@/components/shared/StyledMenu.vue";
Expand Down Expand Up @@ -379,6 +384,8 @@ const providerModelMenuRef = ref<InstanceType<typeof ProviderModelMenu> | null>(
const showProviderSelector = ref(true);
const isReplyClosing = ref(false);
const isDragging = ref(false);
const isComposing = ref(false);
const lastCompositionEndAt = ref<number | null>(null);
let dragLeaveTimeout: number | null = null;

const localPrompt = computed({
Expand Down Expand Up @@ -514,6 +521,10 @@ function handleKeyDown(e: KeyboardEvent) {
return;
}

if (isComposingEnter(e, isComposing.value, lastCompositionEndAt.value)) {
return;
}

const isSendHotkey =
e.ctrlKey ||
e.metaKey ||
Expand All @@ -533,6 +544,23 @@ function handleKeyDown(e: KeyboardEvent) {
}
}

function handleCompositionStart() {
isComposing.value = true;
lastCompositionEndAt.value = null;
}

function handleCompositionEnd(e: CompositionEvent) {
lastCompositionEndAt.value = e.timeStamp;
clearCompositionState({ keepLastEndAt: true });
}

function clearCompositionState({ keepLastEndAt = false } = {}) {
isComposing.value = false;
if (!keepLastEndAt) {
lastCompositionEndAt.value = null;
}
}

function handleKeyUp(e: KeyboardEvent) {
if (e.keyCode === 66) {
ctrlKeyDown.value = false;
Expand Down Expand Up @@ -634,6 +662,7 @@ onBeforeUnmount(() => {
if (inputField.value) {
inputField.value.removeEventListener("paste", handlePaste);
}
clearCompositionState();
document.removeEventListener("keyup", handleKeyUp);
});

Expand Down
31 changes: 31 additions & 0 deletions dashboard/src/utils/imeInput.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Some IMEs emit Enter right after compositionend; treat that same-keystroke
// window as composition so selecting a candidate does not send the message.
const RECENT_COMPOSITION_END_THRESHOLD_MS = 100;

/**
* @param {KeyboardEvent} event
* @param {boolean} compositionActive
* @param {number | null} lastCompositionEndAt
*/
export function isComposingEnter(
event,
compositionActive,
lastCompositionEndAt = null,
) {
const hasLegacyCompositionKeyCode =
typeof event.keyCode === "number" && event.keyCode === 229;
const isAfterRecentCompositionEnd =
typeof event.timeStamp === "number" &&
typeof lastCompositionEndAt === "number" &&
event.timeStamp >= lastCompositionEndAt &&
event.timeStamp - lastCompositionEndAt <
RECENT_COMPOSITION_END_THRESHOLD_MS;

return (
event.key === "Enter" &&
(compositionActive ||
event.isComposing ||
hasLegacyCompositionKeyCode ||
isAfterRecentCompositionEnd)
);
}
36 changes: 36 additions & 0 deletions dashboard/tests/imeInput.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import assert from "node:assert/strict";
import test from "node:test";

import { isComposingEnter } from "../src/utils/imeInput.mjs";

test("detects Enter while an IME composition is active", () => {
assert.equal(isComposingEnter({ key: "Enter", isComposing: true }, false), true);
assert.equal(isComposingEnter({ key: "Enter", isComposing: false }, true), true);
});

test("does not treat normal Enter as IME composition", () => {
assert.equal(isComposingEnter({ key: "Enter", isComposing: false }, false), false);
assert.equal(isComposingEnter({ key: "a", isComposing: true }, true), false);
});

test("detects Enter fired immediately after composition ended", () => {
assert.equal(
isComposingEnter(
{ key: "Enter", isComposing: false, timeStamp: 105 },
false,
100,
),
true,
);
});

test("does not treat delayed Enter after composition ended as IME composition", () => {
assert.equal(
isComposingEnter(
{ key: "Enter", isComposing: false, timeStamp: 250 },
false,
100,
),
false,
);
});
Loading