From eadcc2b4812191eadaa90b2624118c4ff8183c99 Mon Sep 17 00:00:00 2001 From: Linus Rath <139418639+rathlinus@users.noreply.github.com> Date: Sun, 11 Oct 2026 19:46:36 +0200 Subject: [PATCH] fix: put the caret in the body when a reply opens --- .../__tests__/composer-reply-focus.test.tsx | 228 ++++++++++++++++++ components/email/email-composer.tsx | 22 +- 2 files changed, 249 insertions(+), 1 deletion(-) create mode 100644 components/email/__tests__/composer-reply-focus.test.tsx diff --git a/components/email/__tests__/composer-reply-focus.test.tsx b/components/email/__tests__/composer-reply-focus.test.tsx new file mode 100644 index 000000000..545440f3d --- /dev/null +++ b/components/email/__tests__/composer-reply-focus.test.tsx @@ -0,0 +1,228 @@ +import { render, act } from '@testing-library/react'; +import { describe, it, expect, vi, beforeEach } from 'vitest'; +import React from 'react'; +import { EmailComposer } from '../email-composer'; +import { useSettingsStore } from '@/stores/settings-store'; + +// ─── Heavy component mocks (mirrors reply-addressing.test.tsx) ──────────────── + +const toastError = vi.hoisted(() => vi.fn()); + +const editorFocus = vi.hoisted(() => vi.fn()); + +// Reports a stub editor as ready, the way the real one does once mounted. +vi.mock('@/components/email/rich-text-editor', () => ({ + RichTextEditor: ({ onEditorReady }: { onEditorReady?: (editor: unknown) => void }) => { + React.useEffect(() => { + onEditorReady?.({ commands: { focus: editorFocus, setContent: () => {} }, isDestroyed: false }); + }, [onEditorReady]); + return React.createElement('div', { 'data-testid': 'rich-text-editor' }); + }, +})); + +vi.mock('@/components/plugins/plugin-slot', () => ({ PluginSlot: () => null })); +vi.mock('@/components/ui/avatar', () => ({ Avatar: () => null })); +vi.mock('@/components/identity/sub-address-helper', () => ({ SubAddressHelper: () => null })); +vi.mock('@/components/templates/template-picker', () => ({ TemplatePicker: () => null })); +vi.mock('@/components/templates/template-form', () => ({ TemplateForm: () => null })); +vi.mock('@/components/files/file-preview-modal', () => ({ FilePreviewModal: () => null })); +vi.mock('@/hooks/use-focus-trap', () => ({ + useFocusTrap: () => ({ current: null }), +})); +vi.mock('@/hooks/use-pro-multi-account-identities', () => ({ + useProMultiAccountIdentities: () => ({ enabled: false, groups: [], allIdentities: [] }), + stripCrossAccountIdentityPrefix: (id: string) => ({ localAccountId: null, rawId: id }), +})); + +// ─── Store mocks ────────────────────────────────────────────────────────────── + +vi.mock('@/stores/auth-store', () => { + const state = { + client: null, + identities: [], + primaryIdentity: null, + isAuthenticated: false, + isDemoMode: false, + activeAccountId: null, + connectionLost: false, + getClientForAccount: () => undefined, + getAllConnectedClients: () => new Map(), + syncIdentities: () => {}, + refreshIdentities: async () => {}, + }; + const hook = (sel?: (s: typeof state) => unknown) => + typeof sel === 'function' ? sel(state) : state; + hook.getState = () => state; + hook.setState = (p: Partial) => Object.assign(state, p); + return { useAuthStore: hook }; +}); + +vi.mock('@/stores/identity-store', () => { + const state = { + identities: [{ id: 'id-me', email: 'me@example.com', name: 'Me' }], + defaultIdentityId: 'id-me', + }; + const hook = (sel?: (s: typeof state) => unknown) => + typeof sel === 'function' ? sel(state) : state; + hook.getState = () => state; + hook.setState = (p: Partial) => Object.assign(state, p); + return { useIdentityStore: hook }; +}); + +vi.mock('@/stores/account-store', () => { + const state = { accounts: [], getAccountById: () => undefined }; + const hook = (sel?: (s: typeof state) => unknown) => + typeof sel === 'function' ? sel(state) : state; + hook.getState = () => state; + hook.setState = (p: Partial) => Object.assign(state, p); + return { useAccountStore: hook }; +}); + +vi.mock('@/stores/email-store', () => { + const state = { + draftSaveEnabled: false, + sendRawEmail: async () => ({ sent: true }), + }; + const hook = (sel?: (s: typeof state) => unknown) => + typeof sel === 'function' ? sel(state) : state; + hook.getState = () => state; + hook.setState = (p: Partial) => Object.assign(state, p); + return { useEmailStore: hook }; +}); + +const updateSetting = vi.fn(); + +vi.mock('@/stores/settings-store', () => { + const state = { + timeFormat: '24h', + plainTextMode: false, + subAddressDelimiter: '+', + autoSelectReplyIdentity: true, + attachmentReminderEnabled: false, + attachmentReminderKeywords: [], + emptySubjectWarningEnabled: true, + sendDelaySeconds: 0, + signaturePosition: 'above_quote', + signatureSeparatorEnabled: false, + requestReadReceiptDefault: false, + addTrustedSender: () => {}, + trustedSendersAddressBook: null, + updateSetting: (...args: unknown[]) => updateSetting(...args), + }; + const hook = (sel?: (s: typeof state) => unknown) => + typeof sel === 'function' ? sel(state) : state; + hook.getState = () => state; + hook.setState = (p: Partial) => Object.assign(state, p); + return { useSettingsStore: hook }; +}); + +vi.mock('@/stores/contact-store', () => { + const state = { + contacts: [], + getAutocomplete: async () => [], + addToTrustedSendersBook: async () => {}, + }; + const hook = (sel?: (s: typeof state) => unknown) => + typeof sel === 'function' ? sel(state) : state; + hook.getState = () => state; + hook.setState = (p: Partial) => Object.assign(state, p); + return { useContactStore: hook }; +}); + +vi.mock('@/stores/template-store', () => { + const state = { templates: [], addTemplate: async () => {} }; + const hook = (sel?: (s: typeof state) => unknown) => + typeof sel === 'function' ? sel(state) : state; + hook.getState = () => state; + hook.setState = (p: Partial) => Object.assign(state, p); + return { useTemplateStore: hook }; +}); + +// ─── Misc dependency mocks ──────────────────────────────────────────────────── + +vi.mock('@/stores/toast-store', () => ({ + toast: { info: () => {}, error: toastError, success: () => {} }, +})); + +vi.mock('@/lib/plugin-hooks', () => ({ + emailHooks: { + onComposerOpen: { call: async () => [] }, + onRecipientChange: { call: async () => [] }, + getRecipientSuggestions: { call: async () => [] }, + onRecipientChipsChange: { transform: async (chips: unknown) => chips }, + onDraftChange: { emit: () => {} }, + onBeforeDraftAutoSave: { transform: async (draft: unknown) => draft }, + onBeforeEmailSend: { intercept: async () => true }, + onComposeSend: { takeOver: async () => 'default' }, + onTransformOutgoingEmail: { transform: async (email: unknown) => email }, + }, + contactHooks: { + search: { call: async () => [] }, + onProvideRecipientSuggestions: { transform: async (initial: unknown) => initial }, + }, +})); + +vi.mock('@/lib/email-sanitization', () => ({ + sanitizeSignatureHtml: (v: string) => v, + sanitizeEmailHtml: (v: string) => v, + parseHtmlSafely: (html: string) => new DOMParser().parseFromString(html, 'text/html'), +})); + +vi.mock('@/lib/email-threading', () => ({ + computeReplyThreadingHeaders: () => ({ inReplyTo: [], references: [] }), +})); +vi.mock('@/lib/signature-utils', () => ({ + appendPlainTextSignature: (body: string) => body, + getPlainTextSignature: () => '', + plainTextBodyHasSignature: () => false, + plainTextBodyWithoutSignature: (body: string) => body, +})); +vi.mock('@/lib/sub-addressing', () => ({ generateSubAddress: () => '' })); +vi.mock('@/lib/debug', () => ({ debug: { log: () => {}, warn: () => {}, error: () => {} } })); +vi.mock('@/components/email/quoted-html', () => ({ + buildQuotedHtmlBlock: () => '', + serializeEditorContent: () => '', +})); +vi.mock('@/lib/template-utils', () => ({ substitutePlaceholders: (s: string) => s })); + +// ─── Tests ──────────────────────────────────────────────────────────────────── + +// A reply opened with nothing focused, so typing right away went nowhere. + +const DATA = { + to: 'bob@example.com', + cc: '', + bcc: '', + subject: 'Re: Lunch', + body: '

Hello there

', + showCc: false, + showBcc: false, + selectedIdentityId: 'id-me', + subAddressTag: '', + draftId: null, +}; + +describe('composer initial focus', () => { + beforeEach(() => { + editorFocus.mockClear(); + useSettingsStore.setState({ plainTextMode: false }); + }); + + it('puts the caret at the start of a reply body', () => { + render(); + expect(editorFocus).toHaveBeenCalledTimes(1); + expect(editorFocus).toHaveBeenCalledWith('start'); + }); + + it('leaves a new message to focus the To field', () => { + render(); + expect(editorFocus).not.toHaveBeenCalled(); + }); + + it('focuses the plain text body of a reply', async () => { + useSettingsStore.setState({ plainTextMode: true }); + render(); + await act(() => new Promise((r) => setTimeout(r, 150))); + expect(document.activeElement?.tagName).toBe('TEXTAREA'); + }); +}); diff --git a/components/email/email-composer.tsx b/components/email/email-composer.tsx index e4e9dbfe5..393d310d7 100644 --- a/components/email/email-composer.tsx +++ b/components/email/email-composer.tsx @@ -840,6 +840,9 @@ export function EmailComposer({ // when the user switches identity in "above quote" mode without rebuilding // the whole body (which would lose user edits to the surrounding draft). const editorRef = useRef(null); + // Set once a reply's body got its initial focus, so switching formats later + // does not move the caret back to the start. + const replyFocusedRef = useRef(false); const prevSignatureIdentityIdRef = useRef(signatureIdentity?.id); const prevSignatureSeparatorRef = useRef(signatureSeparatorEnabled); @@ -1264,6 +1267,17 @@ export function EmailComposer({ }, 100); return () => clearTimeout(timer); } + // A reply has its recipients already: put the caret at the start of the + // body, above the quote. Nothing had focus, so typing went nowhere. The + // rich text editor focuses itself once it is ready (onEditorReady below). + if ((mode === 'reply' || mode === 'replyAll') && plainTextMode) { + const timer = setTimeout(() => { + bodyRef.current?.focus(); + bodyRef.current?.setSelectionRange(0, 0); + }, 100); + return () => clearTimeout(timer); + } + // eslint-disable-next-line react-hooks/exhaustive-deps }, [mode]); const [autocompleteResults, setAutocompleteResults] = useState>([]); @@ -3332,7 +3346,13 @@ export function EmailComposer({ onImageUpload={handleImageUpload} placeholder={t('body_placeholder')} hasError={validationErrors.body} - onEditorReady={(ed) => { editorRef.current = ed; }} + onEditorReady={(ed) => { + editorRef.current = ed; + if (!replyFocusedRef.current && (mode === 'reply' || mode === 'replyAll')) { + replyFocusedRef.current = true; + ed.commands.focus('start'); + } + }} mentionCandidates={recipientMentionsEnabled ? mentionCandidates : undefined} />