-
Notifications
You must be signed in to change notification settings - Fork 13.7k
refactor: decouple autocomplete engine via EditableTextAdapter #40925
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
ricardogarim
wants to merge
1
commit into
refactor/autocomplete-move
Choose a base branch
from
refactor/composer-autocomplete-engine
base: refactor/autocomplete-move
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
apps/meteor/client/components/AutocompletePopup/editableTextAdapter.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| export type EditableTextAdapter = { | ||
| textBeforeCaret(): string; | ||
| caret(): number; | ||
| replaceRange(text: string, start: number, end: number): void; | ||
| }; |
144 changes: 144 additions & 0 deletions
144
apps/meteor/client/components/AutocompletePopup/hooks/useComposerBoxPopup.spec.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| import { mockAppRoot } from '@rocket.chat/mock-providers'; | ||
| import { act, fireEvent, renderHook, waitFor } from '@testing-library/react'; | ||
|
|
||
| import { useComposerBoxPopup } from './useComposerBoxPopup'; | ||
| import { createMessageBoxPopupConfig } from '../ComposerPopupOption'; | ||
| import type { EditableTextAdapter } from '../editableTextAdapter'; | ||
|
|
||
| const keys = { ENTER: 13, ESC: 27, ARROW_UP: 38, ARROW_DOWN: 40 }; | ||
|
|
||
| type Item = { _id: string; username?: string }; | ||
|
|
||
| const createComposer = (text: string, caret = text.length) => ({ | ||
| substring: (start: number, end?: number) => text.substring(start, end), | ||
| selection: { start: caret, end: caret }, | ||
| replaceText: jest.fn(), | ||
| }); | ||
|
|
||
| const adapterFor = (composer: ReturnType<typeof createComposer>): EditableTextAdapter => ({ | ||
| textBeforeCaret: () => composer.substring(0, composer.selection.start), | ||
| caret: () => composer.selection.start, | ||
| replaceRange: (text, start, end) => composer.replaceText(text, { start, end }), | ||
| }); | ||
|
|
||
| const userOption = createMessageBoxPopupConfig<Item>({ | ||
| trigger: '@', | ||
| getItemsFromLocal: async () => [ | ||
| { _id: 'u1', username: 'alice' }, | ||
| { _id: 'u2', username: 'bob' }, | ||
| ], | ||
| getItemsFromServer: async () => [], | ||
| getValue: (item) => item.username ?? '', | ||
| }); | ||
|
|
||
| const emojiOption = createMessageBoxPopupConfig<Item>({ | ||
| trigger: ':', | ||
| triggerLength: 2, | ||
| getItemsFromLocal: async (filter: string) => [{ _id: `:${filter}a:` }, { _id: `:${filter}b:` }], | ||
| getItemsFromServer: async () => [], | ||
| getValue: (item) => item._id.substring(1), | ||
| }); | ||
|
|
||
| const commandOption = createMessageBoxPopupConfig<Item>({ | ||
| trigger: '/', | ||
| triggerAnywhere: false, | ||
| getItemsFromLocal: async () => [{ _id: 'archive' }], | ||
| getItemsFromServer: async () => [], | ||
| getValue: (item) => item._id, | ||
| }); | ||
|
|
||
| const options = [userOption, emojiOption, commandOption]; | ||
|
|
||
| const setup = (text: string, caret = text.length) => { | ||
| const composer = createComposer(text, caret); | ||
| const node = document.createElement('textarea'); | ||
|
|
||
| const { result } = renderHook(() => useComposerBoxPopup(options, adapterFor(composer)), { | ||
| wrapper: mockAppRoot().build(), | ||
| }); | ||
| act(() => result.current.callbackRef(node)); | ||
|
|
||
| const fire = (type: 'keyUp' | 'keyDown', which: number) => fireEvent[type](node, { which, keyCode: which }); | ||
|
|
||
| return { result, composer, fire }; | ||
| }; | ||
|
|
||
| describe('useComposerBoxPopup (characterization)', () => { | ||
| it('opens no popup when the text has no trigger', () => { | ||
| const { result, fire } = setup('hello'); | ||
| fire('keyUp', 0); | ||
| expect(result.current.option).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('detects the `@` trigger and extracts the filter', () => { | ||
| const { result, fire } = setup('hi @al'); | ||
| fire('keyUp', 0); | ||
| expect(result.current.option?.trigger).toBe('@'); | ||
| expect(result.current.filter).toBe('al'); | ||
| }); | ||
|
|
||
| it('respects triggerLength: `:` alone does not open, `:ab` does', () => { | ||
| const closed = setup('x :'); | ||
| closed.fire('keyUp', 0); | ||
| expect(closed.result.current.option).toBeUndefined(); | ||
|
|
||
| const open = setup('x :ab'); | ||
| open.fire('keyUp', 0); | ||
| expect(open.result.current.option?.trigger).toBe(':'); | ||
| expect(open.result.current.filter).toBe('ab'); | ||
| }); | ||
|
|
||
| it('only triggers a start-only (`/`) option at the very start of the text', () => { | ||
| const mid = setup('hey /arch'); | ||
| mid.fire('keyUp', 0); | ||
| expect(mid.result.current.option).toBeUndefined(); | ||
|
|
||
| const start = setup('/arch'); | ||
| start.fire('keyUp', 0); | ||
| expect(start.result.current.option?.trigger).toBe('/'); | ||
| expect(start.result.current.filter).toBe('arch'); | ||
| }); | ||
|
|
||
| it('inserts prefix + value + suffix over the trigger range on select', async () => { | ||
| const { result, composer, fire } = setup('hi @al'); | ||
| fire('keyUp', 0); | ||
| await waitFor(() => expect(result.current.focused).toBeDefined()); | ||
|
|
||
| act(() => result.current.select?.({ _id: 'u1', username: 'alice' })); | ||
|
|
||
| expect(composer.replaceText).toHaveBeenCalledWith('@alice ', { start: 3, end: 6 }); | ||
| }); | ||
|
|
||
| it('moves focus with arrow keys and wraps around', async () => { | ||
| const { result, fire } = setup('hi @'); | ||
| fire('keyUp', 0); | ||
| await waitFor(() => expect(result.current.focused?._id).toBe('u1')); | ||
|
|
||
| fire('keyDown', keys.ARROW_DOWN); | ||
| expect(result.current.focused?._id).toBe('u2'); | ||
|
|
||
| fire('keyDown', keys.ARROW_DOWN); | ||
| expect(result.current.focused?._id).toBe('u1'); | ||
|
|
||
| fire('keyDown', keys.ARROW_UP); | ||
| expect(result.current.focused?._id).toBe('u2'); | ||
| }); | ||
|
|
||
| it('selects the focused item on Enter', async () => { | ||
| const { result, composer, fire } = setup('hi @'); | ||
| fire('keyUp', 0); | ||
| await waitFor(() => expect(result.current.focused?._id).toBe('u1')); | ||
|
|
||
| fire('keyDown', keys.ENTER); | ||
| expect(composer.replaceText).toHaveBeenCalledWith('@alice ', expect.objectContaining({ end: 4 })); | ||
| }); | ||
|
|
||
| it('closes the popup on Escape', async () => { | ||
| const { result, fire } = setup('hi @al'); | ||
| fire('keyUp', 0); | ||
| await waitFor(() => expect(result.current.option?.trigger).toBe('@')); | ||
|
|
||
| fire('keyUp', keys.ESC); | ||
| expect(result.current.option).toBeUndefined(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| export { default as ComposerBoxPopup, type ComposerBoxPopupProps } from './ComposerBoxPopup'; | ||
| export { type ComposerPopupOption, createMessageBoxPopupConfig } from './ComposerPopupOption'; | ||
| export { type EditableTextAdapter } from './editableTextAdapter'; | ||
| export { useComposerBoxPopup } from './hooks/useComposerBoxPopup'; | ||
| export { useEnablePopupPreview } from './hooks/useEnablePopupPreview'; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.