1081664682

Committed 22 Nov 2023 02:11PM UTC coverage: 82.798% (-17.2%) from 99.964%

Build # 1081664682

Build Type

Pull #4214

gitlab-ci

Committed by

tranchitella

Commit Message

fix: Fixed the infinite page redirects when the back button is pressed

Remove the location and navigate from the useLocationParams.setValue callback
dependencies as they change the set function that is presented in other
useEffect dependencies. This happens when the back button is clicked, which
leads to the location changing infinitely.

Changelog: Title
Ticket: MEN-6847
Ticket: MEN-6796

Signed-off-by: Ihor Aleksandrychiev <ihor.aleksandrychiev@northern.tech>
Signed-off-by: Fabio Tranchitella <fabio.tranchitella@northern.tech>

Pull Request Pull Request #4214: fix: Fixed the infinite page redirects when the back button is pressed

Run Details

4319 of 6292 branches covered (0.0%)

8332 of 10063 relevant lines covered (82.8%)

191.0 hits per line

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

92.0

/src/js/components/common/xterm.js

// Copyright 2021 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, { useEffect } from 'react';

import { Terminal } from 'xterm';
import { FitAddon } from 'xterm-addon-fit';
import { SearchAddon } from 'xterm-addon-search';
import 'xterm/css/xterm.css';

const searchAddon = new SearchAddon();
const fitAddon = new FitAddon();

const addons = [fitAddon, searchAddon];
const defaultOptions = { allowProposedApi: true, scrollback: 5000 };

export const Xterm = ({ className, customKeyEventHandler, options = {}, onResize, style, triggerResize, xtermRef, ...remainingProps }) => {
  /**
   * XTerm.js Terminal object.
   */
  // This is assigned in the setupTerminal() which is called from the constructor
  // terminal: Terminal
  // const terminal = ref.current.terminal.current;

  /**
   * The ref for the containing element.
   */
  // const terminalRef = ref.current.terminalRef.current;

  useEffect(() => {
    let { terminal, terminalRef } = xtermRef.current;
    // Setup the XTerm terminal.
    terminal.current = new Terminal({ ...defaultOptions, ...options });
    // Load addons
    addons.forEach(addon => terminal.current.loadAddon(addon));

    // Create Listeners
    Object.entries(remainingProps).map(([key, value]) => (value ? terminal.current[key](value) : undefined));

    // Add Custom Key Event Handler
    if (customKeyEventHandler) {
      terminal.current.attachCustomKeyEventHandler(customKeyEventHandler);
    }

    if (terminalRef.current) {
      // Creates the terminal within the container element.
      terminal.current.open(terminalRef.current);
    }
    return () => {
      // When the component unmounts dispose of the terminal and all of its listeners.
      // eslint-disable-next-line react-hooks/exhaustive-deps
      terminal.current.dispose();
    };
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [addons, customKeyEventHandler, JSON.stringify(options), Object.keys(remainingProps).join('')]);

  useEffect(() => {
    if (!xtermRef.current.terminalRef.current) {
      return;
    }
    try {
      fitAddon.fit();
      const { rows = 40, cols = 80 } = fitAddon.proposeDimensions() || {};
      if (onResize) {
        onResize({ rows, cols });
      }
    } catch {
      /* nothing really  */
    }
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [triggerResize]);

  return <div className={className} ref={xtermRef.current.terminalRef} style={style} />;
};

export default Xterm;

1	// Copyright 2021 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, { useEffect } from 'react';
15
16	import { Terminal } from 'xterm';
17	import { FitAddon } from 'xterm-addon-fit';
18	import { SearchAddon } from 'xterm-addon-search';
19	import 'xterm/css/xterm.css';
20
21	const searchAddon = new SearchAddon();	16✔
22	const fitAddon = new FitAddon();	16✔
23
24	const addons = [fitAddon, searchAddon];	16✔
25	const defaultOptions = { allowProposedApi: true, scrollback: 5000 };	16✔
26
27	export const Xterm = ({ className, customKeyEventHandler, options = {}, onResize, style, triggerResize, xtermRef, ...remainingProps }) => {	16✔
28	/**
29	* XTerm.js Terminal object.
30	*/
31	// This is assigned in the setupTerminal() which is called from the constructor
32	// terminal: Terminal
33	// const terminal = ref.current.terminal.current;
34
35	/**
36	* The ref for the containing element.
37	*/
38	// const terminalRef = ref.current.terminalRef.current;
39
40	useEffect(() => {	8✔
41	let { terminal, terminalRef } = xtermRef.current;	6✔
42	// Setup the XTerm terminal.
43	terminal.current = new Terminal({ ...defaultOptions, ...options });	6✔
44	// Load addons
45	addons.forEach(addon => terminal.current.loadAddon(addon));	12✔
46
47	// Create Listeners
48	Object.entries(remainingProps).map(([key, value]) => (value ? terminal.current[key](value) : undefined));	6!
49
50	// Add Custom Key Event Handler
51	if (customKeyEventHandler) {	6!
52	terminal.current.attachCustomKeyEventHandler(customKeyEventHandler);	×
53	}
54
55	if (terminalRef.current) {	6!
56	// Creates the terminal within the container element.
57	terminal.current.open(terminalRef.current);	6✔
58	}
59	return () => {	6✔
60	// When the component unmounts dispose of the terminal and all of its listeners.
61	// eslint-disable-next-line react-hooks/exhaustive-deps
62	terminal.current.dispose();	6✔
63	};
64	// eslint-disable-next-line react-hooks/exhaustive-deps
65	}, [addons, customKeyEventHandler, JSON.stringify(options), Object.keys(remainingProps).join('')]);
66
67	useEffect(() => {	8✔
68	if (!xtermRef.current.terminalRef.current) {	7!
69	return;	×
70	}
71	try {	7✔
72	fitAddon.fit();	7✔
73	const { rows = 40, cols = 80 } = fitAddon.proposeDimensions() \|\| {};	7✔
74	if (onResize) {	7✔
75	onResize({ rows, cols });	6✔
76	}
77	} catch {
78	/* nothing really */
79	}
80	// eslint-disable-next-line react-hooks/exhaustive-deps
81	}, [triggerResize]);
82
83	return <div className={className} ref={xtermRef.current.terminalRef} style={style} />;	8✔
84	};
85
86	export default Xterm;

mendersoftware / gui / 1081664682

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