-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[v16] Add search functionality to Web UI and Connect ssh terminal
Backport #48776 to branch/v16 changelog: You can now search text within ssh sessions in the Web UI and Teleport Connect
- Loading branch information
Showing
20 changed files
with
702 additions
and
108 deletions.
There are no files selected for viewing
This file contains 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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 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 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 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 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
48 changes: 48 additions & 0 deletions
48
web/packages/shared/components/TerminalSearch/TerminalSearch.story.tsx
This file contains 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,48 @@ | ||
| /** | ||
| * Teleport | ||
| * Copyright (C) 2024 Gravitational, Inc. | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| import { SearchAddon } from '@xterm/addon-search'; | ||
|
|
||
| import { TerminalSearch, TerminalSearcher } from './TerminalSearch'; | ||
|
|
||
| // Create a mock XTerm implementation that matches the new TerminalWithSearch interface | ||
| const createTerminalMock = (): TerminalSearcher => { | ||
| return { | ||
| getSearchAddon: () => new SearchAddon(), | ||
| focus: () => {}, | ||
| registerCustomKeyEventHandler: () => { | ||
| return { | ||
| unregister() {}, | ||
| }; | ||
| }, | ||
| }; | ||
| }; | ||
|
|
||
| export default { | ||
| title: 'Shared/TerminalSearch', | ||
| }; | ||
|
|
||
| export const Open = () => ( | ||
| <TerminalSearch | ||
| terminalSearcher={createTerminalMock()} | ||
| show={true} | ||
| onClose={() => {}} | ||
| onOpen={() => {}} | ||
| isSearchKeyboardEvent={() => false} | ||
| /> | ||
| ); |
155 changes: 155 additions & 0 deletions
155
web/packages/shared/components/TerminalSearch/TerminalSearch.test.tsx
This file contains 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,155 @@ | ||
| /** | ||
| * Teleport | ||
| * Copyright (C) 2024 Gravitational, Inc. | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| import { render, act, screen } from 'design/utils/testing'; | ||
| import { SearchAddon } from '@xterm/addon-search'; | ||
|
|
||
| import { TerminalSearch } from './TerminalSearch'; | ||
|
|
||
| let searchCallback: SearchCallbackType; | ||
| type SearchCallbackType = (results: { | ||
| resultIndex: number; | ||
| resultCount: number; | ||
| }) => void; | ||
|
|
||
| jest.mock('@xterm/addon-search', () => ({ | ||
| SearchAddon: jest.fn().mockImplementation(() => ({ | ||
| findNext: jest.fn(), | ||
| findPrevious: jest.fn(), | ||
| clearDecorations: jest.fn(), | ||
| onDidChangeResults: jest.fn(callback => { | ||
| searchCallback = callback; | ||
| return { dispose: jest.fn() }; | ||
| }), | ||
| })), | ||
| })); | ||
|
|
||
| const createTerminalMock = () => { | ||
| const keyEventHandlers = new Set<(e: KeyboardEvent) => boolean>(); | ||
|
|
||
| return { | ||
| getSearchAddon: () => new SearchAddon(), | ||
| focus: jest.fn(), | ||
| registerCustomKeyEventHandler: (handler: (e: KeyboardEvent) => boolean) => { | ||
| keyEventHandlers.add(handler); | ||
| return { | ||
| unregister: () => keyEventHandlers.delete(handler), | ||
| }; | ||
| }, | ||
| // Helper to simulate keyboard events | ||
| triggerKeyEvent: (eventProps: Partial<KeyboardEvent>) => { | ||
| const event = new KeyboardEvent('keydown', eventProps); | ||
| keyEventHandlers.forEach(handler => handler(event)); | ||
| }, | ||
| // Helper to simulate search results | ||
| triggerSearchResults: (resultIndex: number, resultCount: number) => { | ||
| searchCallback?.({ resultIndex, resultCount }); | ||
| }, | ||
| }; | ||
| }; | ||
|
|
||
| const renderComponent = (props = {}) => { | ||
| const terminalMock = createTerminalMock(); | ||
| const defaultProps = { | ||
| terminalSearcher: terminalMock, | ||
| show: true, | ||
| onClose: jest.fn(), | ||
| isSearchKeyboardEvent: jest.fn(), | ||
| onOpen: jest.fn(), | ||
| ...props, | ||
| }; | ||
|
|
||
| return { | ||
| ...render(<TerminalSearch {...defaultProps} />), | ||
| terminalMock, | ||
| props: defaultProps, | ||
| }; | ||
| }; | ||
|
|
||
| const terminalSearchTestId = 'terminal-search'; | ||
| const searchNext = /search next/i; | ||
| const searchPrevious = /search previous/i; | ||
| const closeSearch = /close search/i; | ||
|
|
||
| describe('TerminalSearch', () => { | ||
| beforeEach(() => { | ||
| jest.clearAllMocks(); | ||
| searchCallback = null; | ||
| }); | ||
|
|
||
| test('no render when show is false', () => { | ||
| renderComponent({ show: false }); | ||
| expect(screen.queryByTestId(terminalSearchTestId)).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| test('render search input and buttons when show is true', () => { | ||
| renderComponent(); | ||
| expect(screen.getByTestId(terminalSearchTestId)).toBeInTheDocument(); | ||
| expect(screen.getByTitle(searchNext)).toBeInTheDocument(); | ||
| expect(screen.getByTitle(searchPrevious)).toBeInTheDocument(); | ||
| expect(screen.getByTitle(closeSearch)).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| test('show initial search results as 0/0', () => { | ||
| renderComponent(); | ||
| expect(screen.getByText('0/0')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| test('open search when Ctrl+F is pressed', () => { | ||
| const isSearchKeyboardEvent = jest.fn().mockReturnValue(true); | ||
| const { props, terminalMock } = renderComponent({ isSearchKeyboardEvent }); | ||
|
|
||
| terminalMock.triggerKeyEvent({ | ||
| key: 'f', | ||
| ctrlKey: true, | ||
| type: 'keydown', | ||
| }); | ||
|
|
||
| expect(props.onOpen).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| test('open search when Cmd+F is pressed (Mac)', () => { | ||
| const isSearchKeyboardEvent = jest.fn().mockReturnValue(true); | ||
| const { props, terminalMock } = renderComponent({ isSearchKeyboardEvent }); | ||
|
|
||
| terminalMock.triggerKeyEvent({ | ||
| key: 'f', | ||
| metaKey: true, | ||
| type: 'keydown', | ||
| }); | ||
|
|
||
| expect(props.onOpen).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| test('show result counts', async () => { | ||
| const { terminalMock } = renderComponent(); | ||
|
|
||
| const testCases = [ | ||
| { resultIndex: 0, resultCount: 1, expected: '1/1' }, | ||
| { resultIndex: 1, resultCount: 3, expected: '2/3' }, | ||
| { resultIndex: 4, resultCount: 10, expected: '5/10' }, | ||
| ]; | ||
|
|
||
| for (const { resultIndex, resultCount, expected } of testCases) { | ||
| await act(async () => { | ||
| terminalMock.triggerSearchResults(resultIndex, resultCount); | ||
| }); | ||
| expect(screen.getByText(expected)).toBeInTheDocument(); | ||
| } | ||
| }); | ||
| }); |
Oops, something went wrong.