Skip to content

Commit

Permalink
fix tty and related tests (elastic#206919)
Browse files Browse the repository at this point in the history 
## Summary

Culled from elastic#206411

This PR is informed from the work that's being done for the migration to
React 18, whilst trying out kibana with react 18 we had couple of test
fail relating to this particular component, details here
[[job]](https://buildkite.com/elastic/kibana-pull-request/builds/266993#0194655f-1466-4ee3-80ed-54e398b09492)
[[logs]](https://buildkite.com/organizations/elastic/pipelines/kibana-pull-request/builds/266993/jobs/0194655f-1466-4ee3-80ed-54e398b09492/artifacts/01946583-34ed-444a-bc55-10e684c325ef),
it's worth mentioning the way the component was written causes
unnecessary re-renders that doesn't actually make the interval for the
tty playspeed exactly constant. The approach taken here is such that
there's no need to depend on state change to cause the next line to be
written, now we setup a timer interval just once for the entire duration
that the tty is playing, and said timer only ever gets cleaned up on
pause.


P.S. This fix does not utilize any APIs from react 18 so it's backward
compatible with our current version of react.

### Checklist

<!-- Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials -->
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
<!--
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

### Identify risks

Does this PR introduce any risks? For example, consider risks like hard
to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified
risk. Invite stakeholders and evaluate how to proceed before merging.

- [ ] [See some risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
- [ ] ...

-->

Co-authored-by: Elastic Machine <[email protected]>
  • Loading branch information
@eokoneyo @elasticmachine
eokoneyo and elasticmachine authored Jan 20, 2025
1 parent 4dbad26 commit e7b5f3d
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 38 deletions.
58 changes: 31 additions & 27 deletions x-pack/solutions/security/plugins/session_view/public/components/tty_player/hooks.test.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,38 +63,38 @@ describe('TTYPlayer/hooks', () => {
});

it('mounts and renders the first line of output', async () => {
const { result: xTermResult } = renderHook((props) => useXtermPlayer(props), {
const { result: xTermResult } = renderHook(useXtermPlayer, {
initialProps,
});

const { terminal, currentLine, seekToLine } = xTermResult.current;

// there is a minor delay in updates to xtermjs after writeln is called.
jest.advanceTimersByTime(100);
await act(async () => jest.advanceTimersByTime(100));

// check that first line rendered in xtermjs
expect(terminal.buffer.active.getLine(0)?.translateToString(true)).toBe('256');
expect(currentLine).toBe(0);

act(() => {
await act(async () => {
seekToLine(VIM_LINE_START); // line where vim output starts
});

jest.advanceTimersByTime(100);
await act(async () => jest.advanceTimersByTime(100));

expect(terminal.buffer.active.getLine(0)?.translateToString(true)).toBe('#!/bin/env bash');
});

it('allows the user to seek to any line of output', async () => {
const { result: xTermResult } = renderHook((props) => useXtermPlayer(props), {
const { result: xTermResult } = renderHook(useXtermPlayer, {
initialProps,
});

act(() => {
await act(async () => {
xTermResult.current.seekToLine(VIM_LINE_START); // line where vim output starts
});

jest.advanceTimersByTime(100);
await act(async () => jest.advanceTimersByTime(100));

const { terminal, currentLine } = xTermResult.current;

Expand All @@ -103,72 +103,76 @@ describe('TTYPlayer/hooks', () => {
});

it('allows the user to play', async () => {
const { result, rerender } = renderHook((props) => useXtermPlayer(props), {
const { result, rerender } = renderHook(useXtermPlayer, {
initialProps,
});

rerender({ ...initialProps, isPlaying: true });

act(() => {
jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * 10);
});
await act(async () => jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * 10));

expect(result.current.currentLine).toBe(10);
});

it('allows the user to stop', async () => {
const { result, rerender } = renderHook((props) => useXtermPlayer(props), {
const { result, rerender } = renderHook(useXtermPlayer, {
initialProps,
});

rerender({ ...initialProps, isPlaying: true });
act(() => {
jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * 10);
});

await act(async () => jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * 10));

expect(result.current.currentLine).toBe(10);

rerender({ ...initialProps, isPlaying: false });
act(() => {
jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * 10);
});

await act(async () => jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * 10));

expect(result.current.currentLine).toBe(10); // should not have advanced
});

it('should stop when it reaches the end of the array of lines', async () => {
const { result, rerender } = renderHook((props) => useXtermPlayer(props), {
const { result, rerender } = renderHook(useXtermPlayer, {
initialProps,
});

rerender({ ...initialProps, isPlaying: true });
act(() => {
jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * initialProps.lines.length + 100);
});

await act(async () =>
jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * initialProps.lines.length + 100)
);

expect(result.current.currentLine).toBe(initialProps.lines.length - 1);
});

it('should not print the first line twice after playback starts', async () => {
const { result, rerender } = renderHook((props) => useXtermPlayer(props), {
const { result, rerender } = renderHook(useXtermPlayer, {
initialProps,
});

rerender({ ...initialProps, isPlaying: true });
act(() => {

await act(async () => {
// advance render loop
jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS);
});

rerender({ ...initialProps, isPlaying: false });

expect(result.current.terminal.buffer.active.getLine(0)?.translateToString(true)).toBe('256');
});

it('ensure the first few render loops have printed the right lines', async () => {
const { result, rerender } = renderHook((props) => useXtermPlayer(props), {
const { result, rerender } = renderHook(useXtermPlayer, {
initialProps,
});

const LOOPS = 6;

rerender({ ...initialProps, isPlaying: true });

act(() => {
await act(async () => {
// advance render loop
jest.advanceTimersByTime(DEFAULT_TTY_PLAYSPEED_MS * LOOPS);
});
Expand All @@ -193,7 +197,7 @@ describe('TTYPlayer/hooks', () => {
});

it('will allow a plain text search highlight on the last line printed', async () => {
const { result: xTermResult } = renderHook((props) => useXtermPlayer(props), {
const { result: xTermResult } = renderHook(useXtermPlayer, {
initialProps,
});

Expand Down
27 changes: 16 additions & 11 deletions x-pack/solutions/security/plugins/session_view/public/components/tty_player/hooks.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -318,21 +318,26 @@ export const useXtermPlayer = ({

useEffect(() => {
if (isPlaying) {
const timer = setTimeout(() => {
if (!hasNextPage && currentLine === lines.length - 1) {
setIsPlaying(false);
} else {
const nextLine = Math.min(lines.length - 1, currentLine + 1);
render(nextLine, false);
setCurrentLine(nextLine);
}
}, playSpeed);
const timer = setInterval(
() =>
setCurrentLine((_currentLine) => {
if (!hasNextPage && _currentLine === lines.length - 1) {
setIsPlaying(false);
return _currentLine;
} else {
const nextLine = Math.min(lines.length - 1, _currentLine + 1);
render(nextLine, false);
return nextLine;
}
}),
playSpeed
);

return () => {
clearTimeout(timer);
clearInterval(timer);
};
}
}, [lines, currentLine, isPlaying, playSpeed, render, hasNextPage, fetchNextPage, setIsPlaying]);
}, [lines, isPlaying, playSpeed, render, hasNextPage, fetchNextPage, setIsPlaying]);

const seekToLine = useCallback(
(index: any) => {
Expand Down

0 comments on commit e7b5f3d

Please sign in to comment.