Open source Loom alternative. Beautiful, shareable screen recordings.
Rust appcapcossloommacnextjsnextjs15open-sourceossreactrecordrustscreen-capturescreen-recorderscreenshotsolidjstauritauri-apptypescriptvite
fix: avoid submitting comments during IME composition
Akshar Patel08b44663f9c2
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.ymlindex 7c6b6fa18..54d032ce7 100644--- a/.github/workflows/ci.yml+++ b/.github/workflows/ci.yml@@ -126,6 +126,7 @@ jobs:run: >-bun run --cwd apps/web test__tests__/unit/caps-keyboard.test.ts+ __tests__/unit/comment-composer-composition.test.ts__tests__/unit/dashboard-analytics-cap-access.test.ts__tests__/unit/dashboard-analytics-space-access.test.ts__tests__/unit/embed-video-playback-chrome.test.tsdiff --git a/apps/web/__tests__/unit/comment-composer-composition.test.ts b/apps/web/__tests__/unit/comment-composer-composition.test.tsnew file mode 100644index 000000000..dc9a8893b--- /dev/null+++ b/apps/web/__tests__/unit/comment-composer-composition.test.ts@@ -0,0 +1,265 @@+// @vitest-environment jsdom++import type { Comment, Organisation, User, Video } from "@cap/web-domain";+import type { ComponentProps } from "react";+import { act, createElement } from "react";+import type { Root } from "react-dom/client";+import { createRoot } from "react-dom/client";+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";+import { newComment } from "@/actions/videos/new-comment";+import CommentInput from "@/app/s/[videoId]/_components/tabs/Activity/CommentInput";+import { TimelineComposer } from "@/app/s/[videoId]/_components/timeline/TimelineComposer";+import {+ TimelineProvider,+ useTimelineActions,+} from "@/app/s/[videoId]/_components/timeline/TimelineProvider";+import { Toolbar } from "@/app/s/[videoId]/_components/Toolbar";++vi.mock("@/actions/videos/new-comment", () => ({ newComment: vi.fn() }));+vi.mock("@/app/Layout/AuthContext", () => ({+ useCurrentUser: () => ({ id: "viewer", name: "Viewer", imageUrl: null }),+}));+vi.mock("next/dynamic", () => ({ default: () => () => null }));+vi.mock("@/app/s/[videoId]/_components/AuthOverlayLazy", () => ({+ AuthOverlay: () => null,+}));+vi.mock("@/app/s/[videoId]/_components/media-comment/record-actions", () => ({+ RecordActionButtons: () => null,+}));+vi.mock("@/app/s/[videoId]/_components/timeline/TimelineBranch", () => ({+ MicGlyph: () => null,+}));+vi.mock("@cap/ui", async () => {+ const { Button } =+ await import("../../../../packages/ui/src/components/Button");+ return { Button };+});++const videoId = "video" as Video.VideoId;+const video = {+ id: videoId,+ orgId: "organization" as Organisation.OrganisationId,+ owner: { id: "owner" as User.UserId, isPro: false },+ name: "Test screenshot",+ bucket: null,+ storageIntegrationId: null,+ duration: null,+ width: null,+ height: null,+ fps: null,+ metadata: null,+ public: true,+ settings: null,+ transcriptionStatus: null,+ source: { type: "local" },+ folderId: null,+ createdAt: new Date(),+ effectiveCreatedAt: null,+ updatedAt: new Date(),+ password: null,+ xStreamInfo: null,+ firstViewEmailSentAt: null,+ isScreenshot: true,+ awsRegion: null,+ awsBucket: null,+ videoStartTime: null,+ audioStartTime: null,+ jobId: null,+ jobStatus: null,+ skipProcessing: false,+} satisfies ComponentProps<typeof Toolbar>["data"];+let root: Root;+let container: HTMLDivElement;++beforeEach(() => {+ vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);+ vi.mocked(newComment)+ .mockReset()+ .mockImplementation(async (data) => ({+ ...data,+ id: "comment" as Comment.CommentId,+ authorId: "viewer" as User.UserId,+ authorName: "Viewer",+ createdAt: new Date(),+ updatedAt: new Date(),+ mediaKey: null,+ mediaDuration: null,+ mediaMeta: null,+ sending: false,+ }));+ container = document.createElement("div");+ document.body.append(container);+ root = createRoot(container);+});++afterEach(async () => {+ await act(async () => {+ root.unmount();+ });+ container.remove();+ vi.unstubAllGlobals();+});++function TimelineHarness() {+ const actions = useTimelineActions();+ return createElement(+ "div",+ null,+ createElement(+ "button",+ { onClick: () => actions.openComposer(12) },+ "Open composer",+ ),+ createElement(TimelineComposer, {+ videoId,+ trackWidth: 800,+ windowStart: 0,+ windowEnd: 60,+ viewerSignedIn: true,+ }),+ );+}++async function renderComposer(+ kind: "comment" | "reply" | "timeline" | "toolbar",+) {+ const submit = vi.fn();+ await act(async () => {+ if (kind === "timeline") {+ root.render(+ createElement(TimelineProvider, {+ duration: 60,+ compact: false,+ hasHover: true,+ children: createElement(TimelineHarness),+ }),+ );+ return;+ }+ if (kind === "toolbar") {+ root.render(+ createElement(Toolbar, {+ data: video,+ disableReactions: true,+ }),+ );+ return;+ }+ root.render(+ createElement(CommentInput, {+ onSubmit: submit,+ buttonLabel: kind === "comment" ? "Comment" : "Reply",+ collapsible: kind === "comment",+ showCancelButton: kind === "reply",+ onCancel: vi.fn(),+ }),+ );+ });+ if (kind === "timeline" || kind === "toolbar") {+ const open = container.querySelector("button");+ if (!open) throw new Error("Composer trigger is missing");+ await act(async () => {+ open.click();+ });+ }+ const input = container.querySelector("textarea, input");+ if (+ !(input instanceof HTMLTextAreaElement || input instanceof HTMLInputElement)+ ) {+ throw new Error("Comment field is missing");+ }+ return {+ input,+ submit:+ kind === "timeline" || kind === "toolbar"+ ? vi.mocked(newComment)+ : submit,+ };+}++async function change(+ input: HTMLInputElement | HTMLTextAreaElement,+ value: string,+) {+ await act(async () => {+ const prototype =+ input instanceof HTMLTextAreaElement+ ? HTMLTextAreaElement.prototype+ : HTMLInputElement.prototype;+ const setter = Object.getOwnPropertyDescriptor(prototype, "value")?.set;+ if (!setter) throw new Error("Field value setter is missing");+ setter.call(input, value);+ input.dispatchEvent(new Event("input", { bubbles: true }));+ });+}++describe.each(["comment", "reply", "timeline", "toolbar"] as const)(+ "%s text composer",+ (kind) => {+ it("keeps the draft when Enter confirms an input method composition", async () => {+ const { input, submit } = await renderComposer(kind);+ await act(async () => {+ input.dispatchEvent(+ new CompositionEvent("compositionstart", { bubbles: true }),+ );+ });+ await change(input, "日本語");+ const confirm = new KeyboardEvent("keydown", {+ key: "Enter",+ isComposing: true,+ bubbles: true,+ cancelable: true,+ });+ await act(async () => {+ input.dispatchEvent(confirm);+ });++ expect(submit).not.toHaveBeenCalled();+ expect(input.isConnected).toBe(true);+ expect(input.value).toBe("日本語");+ expect(confirm.defaultPrevented).toBe(false);++ await act(async () => {+ input.dispatchEvent(+ new CompositionEvent("compositionend", {+ data: "日本語",+ bubbles: true,+ }),+ );+ });+ await act(async () => {+ input.dispatchEvent(+ new KeyboardEvent("keydown", {+ key: "Enter",+ bubbles: true,+ cancelable: true,+ }),+ );+ });+ expect(submit).toHaveBeenCalledOnce();+ if (kind === "comment" || kind === "reply")+ expect(submit).toHaveBeenCalledWith("日本語");+ else+ expect(submit).toHaveBeenCalledWith(+ expect.objectContaining({ content: "日本語", videoId }),+ );+ });+ },+);++it("leaves Shift+Enter available for multiline replies", async () => {+ const { input, submit } = await renderComposer("reply");+ await change(input, "First line");+ const newline = new KeyboardEvent("keydown", {+ key: "Enter",+ shiftKey: true,+ bubbles: true,+ cancelable: true,+ });+ await act(async () => {+ input.dispatchEvent(newline);+ });+ expect(newline.defaultPrevented).toBe(false);+ expect(submit).not.toHaveBeenCalled();+ expect(input.value).toBe("First line");+});diff --git a/apps/web/app/s/[videoId]/_components/Toolbar.tsx b/apps/web/app/s/[videoId]/_components/Toolbar.tsxindex 64420f05d..3401c54fe 100644--- a/apps/web/app/s/[videoId]/_components/Toolbar.tsx+++ b/apps/web/app/s/[videoId]/_components/Toolbar.tsx@@ -267,7 +267,7 @@ export const Toolbar = ({className="flex-grow px-3 h-full outline-none"maxLength={255}onKeyDown={(e) => {- if (e.key === "Enter") {+ if (e.key === "Enter" && !e.nativeEvent.isComposing) {e.preventDefault();handleCommentSubmit();}diff --git a/apps/web/app/s/[videoId]/_components/tabs/Activity/CommentInput.tsx b/apps/web/app/s/[videoId]/_components/tabs/Activity/CommentInput.tsxindex fa2781465..22acdc486 100644--- a/apps/web/app/s/[videoId]/_components/tabs/Activity/CommentInput.tsx+++ b/apps/web/app/s/[videoId]/_components/tabs/Activity/CommentInput.tsx@@ -55,7 +55,7 @@ const CommentInput: React.FC<CommentInputProps> = ({};const handleKeyDown = (e: React.KeyboardEvent<HTMLTextAreaElement>) => {- if (e.key === "Enter" && !e.shiftKey) {+ if (e.key === "Enter" && !e.shiftKey && !e.nativeEvent.isComposing) {e.preventDefault();handleSubmit();}diff --git a/apps/web/app/s/[videoId]/_components/timeline/TimelineComposer.tsx b/apps/web/app/s/[videoId]/_components/timeline/TimelineComposer.tsxindex d50017fe2..43c9dc92b 100644--- a/apps/web/app/s/[videoId]/_components/timeline/TimelineComposer.tsx+++ b/apps/web/app/s/[videoId]/_components/timeline/TimelineComposer.tsx@@ -199,7 +199,10 @@ export function TimelineComposer({if (!value.trim()) closeComposer();}}onKeyDown={(event) => {- if (event.key === "Enter") {+ if (+ event.key === "Enter" &&+ !event.nativeEvent.isComposing+ ) {event.preventDefault();void submit();}