1113439055

Committed 19 Dec 2023 09:01PM UTC coverage: 82.752% (-17.2%) from 99.964%

Build # 1113439055

Build Type

Pull #4258

gitlab-ci

Committed by

mender-test-bot

Commit Message

chore: Types update

Signed-off-by: Mender Test Bot <mender@northern.tech>

Pull Request Pull Request #4258: chore: Types update

Run Details

4326 of 6319 branches covered (0.0%)

8348 of 10088 relevant lines covered (82.75%)

189.39 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.44

/src/js/components/devices/troubleshoot/terminal.js

// Copyright 2020 Northern.tech AS
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
import React, { useCallback, useEffect, useMemo, useState } from 'react';

import { WebLinksAddon } from 'xterm-addon-web-links';

import { DEVICE_MESSAGE_TYPES as MessageTypes } from '../../../constants/deviceConstants';
import { toggle } from '../../../helpers';
import useWindowSize from '../../../utils/resizehook';
import XTerm from '../../common/xterm';

export const options = {
  cursorBlink: 'block',
  macOptionIsMeta: true
};

// only matching absolute paths, so: /here/there - but not ../here or ./here or here/there
const unixPathRegex = new RegExp('(\\/([^\\0\\s!$`&*()\\[\\]+\'":;\\\\])+)');

export const Terminal = ({ onDownloadClick, sendMessage, socketInitialized, textInput, xtermRef, ...xtermProps }) => {
  const [dimensions, setDimensions] = useState({});
  const [isVisible, setIsVisible] = useState(false);
  const [fitTrigger, setFitTrigger] = useState(false);
  const size = useWindowSize();

  const observer = useMemo(() => new IntersectionObserver(([entry]) => setIsVisible(entry.isIntersecting)), []);

  useEffect(() => {
    if (!socketInitialized) {
      return;
    }
    observer.observe(xtermRef.current.terminalRef.current);
    // Remove the observer as soon as the component is unmounted
    return () => {
      observer.disconnect();
    };
  }, [observer, sendMessage, socketInitialized, xtermRef]);

  useEffect(() => {
    if (!socketInitialized || !xtermRef.current?.terminal?.current) {
      return;
    }
    xtermRef.current.terminal.current.reset();
    const webLinksAddon = new WebLinksAddon((e, link) => onDownloadClick(link), { urlRegex: unixPathRegex }, true);
    xtermRef.current.terminal.current.loadAddon(webLinksAddon);
    setFitTrigger(toggle);
    xtermRef.current.terminal.current.focus();
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [onDownloadClick, socketInitialized, sendMessage]);

  useEffect(() => {
    if (!socketInitialized || !isVisible) {
      return;
    }
    setFitTrigger(toggle);
  }, [size, isVisible, socketInitialized]);

  useEffect(() => {
    if (!socketInitialized || !xtermRef.current.terminal || !textInput) {
      return;
    }
    xtermRef.current.terminal.current.paste(textInput);
  }, [socketInitialized, textInput, xtermRef]);

  const onData = useCallback(data => sendMessage({ typ: MessageTypes.Shell, body: data }), [sendMessage]);

  const onResize = useCallback(
    newDimensions => {
      if (newDimensions.rows != dimensions.rows || newDimensions.cols != dimensions.cols) {
        sendMessage({
          typ: MessageTypes.Resize,
          props: { terminal_height: newDimensions.rows, terminal_width: newDimensions.cols }
        });
        setDimensions(newDimensions);
      }
    },
    [dimensions, sendMessage]
  );

  return <XTerm xtermRef={xtermRef} options={options} onData={onData} onResize={onResize} triggerResize={fitTrigger} {...xtermProps} />;
};

export default Terminal;

1	// Copyright 2020 Northern.tech AS
2	//
3	// Licensed under the Apache License, Version 2.0 (the "License");
4	// you may not use this file except in compliance with the License.
5	// You may obtain a copy of the License at
6	//
7	// http://www.apache.org/licenses/LICENSE-2.0
8	//
9	// Unless required by applicable law or agreed to in writing, software
10	// distributed under the License is distributed on an "AS IS" BASIS,
11	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	// See the License for the specific language governing permissions and
13	// limitations under the License.
14	import React, { useCallback, useEffect, useMemo, useState } from 'react';
15
16	import { WebLinksAddon } from 'xterm-addon-web-links';
17
18	import { DEVICE_MESSAGE_TYPES as MessageTypes } from '../../../constants/deviceConstants';
19	import { toggle } from '../../../helpers';
20	import useWindowSize from '../../../utils/resizehook';
21	import XTerm from '../../common/xterm';
22
23	export const options = {	12✔
24	cursorBlink: 'block',
25	macOptionIsMeta: true
26	};
27
28	// only matching absolute paths, so: /here/there - but not ../here or ./here or here/there
29	const unixPathRegex = new RegExp('(\\/([^\\0\\s!$`&*()\\[\\]+\'":;\\\\])+)');	12✔
30
31	export const Terminal = ({ onDownloadClick, sendMessage, socketInitialized, textInput, xtermRef, ...xtermProps }) => {	12✔
32	const [dimensions, setDimensions] = useState({});	7✔
33	const [isVisible, setIsVisible] = useState(false);	7✔
34	const [fitTrigger, setFitTrigger] = useState(false);	7✔
35	const size = useWindowSize();	7✔
36
37	const observer = useMemo(() => new IntersectionObserver(([entry]) => setIsVisible(entry.isIntersecting)), []);	7✔
38
39	useEffect(() => {	7✔
40	if (!socketInitialized) {	5✔
41	return;	4✔
42	}
43	observer.observe(xtermRef.current.terminalRef.current);	1✔
44	// Remove the observer as soon as the component is unmounted
45	return () => {	1✔
46	observer.disconnect();	1✔
47	};
48	}, [observer, sendMessage, socketInitialized, xtermRef]);
49
50	useEffect(() => {	7✔
51	if (!socketInitialized \|\| !xtermRef.current?.terminal?.current) {	5✔
52	return;	4✔
53	}
54	xtermRef.current.terminal.current.reset();	1✔
55	const webLinksAddon = new WebLinksAddon((e, link) => onDownloadClick(link), { urlRegex: unixPathRegex }, true);	1✔
56	xtermRef.current.terminal.current.loadAddon(webLinksAddon);	1✔
57	setFitTrigger(toggle);	1✔
58	xtermRef.current.terminal.current.focus();	1✔
59	// eslint-disable-next-line react-hooks/exhaustive-deps
60	}, [onDownloadClick, socketInitialized, sendMessage]);
61
62	useEffect(() => {	7✔
63	if (!socketInitialized \|\| !isVisible) {	5!
64	return;	5✔
65	}
66	setFitTrigger(toggle);	×
67	}, [size, isVisible, socketInitialized]);
68
69	useEffect(() => {	7✔
70	if (!socketInitialized \|\| !xtermRef.current.terminal \|\| !textInput) {	5!
71	return;	5✔
72	}
73	xtermRef.current.terminal.current.paste(textInput);	×
74	}, [socketInitialized, textInput, xtermRef]);
75
76	const onData = useCallback(data => sendMessage({ typ: MessageTypes.Shell, body: data }), [sendMessage]);	7✔
77
78	const onResize = useCallback(	7✔
79	newDimensions => {
80	if (newDimensions.rows != dimensions.rows \|\| newDimensions.cols != dimensions.cols) {	6✔
81	sendMessage({	5✔
82	typ: MessageTypes.Resize,
83	props: { terminal_height: newDimensions.rows, terminal_width: newDimensions.cols }
84	});
85	setDimensions(newDimensions);	4✔
86	}
87	},
88	[dimensions, sendMessage]
89	);
90
91	return <XTerm xtermRef={xtermRef} options={options} onData={onData} onResize={onResize} triggerResize={fitTrigger} {...xtermProps} />;	7✔
92	};
93
94	export default Terminal;

mendersoftware / gui / 1113439055

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous