901187442

pending completion

Build # 901187442

Build Type

Pull #3795

gitlab-ci

Committed by

mzedel

Commit Message

feat: increased chances of adopting our intended navigation patterns instead of unsupported browser navigation

Ticket: None
Changelog: None
Signed-off-by: Manuel Zedel <manuel.zedel@northern.tech>

Pull Request Pull Request #3795: feat: increased chances of adopting our intended navigation patterns instead of unsupported browser navigation

Run Details

4389 of 6365 branches covered (68.96%)

5 of 5 new or added lines in 1 file covered. (100.0%)

1729 existing lines in 165 files now uncovered.

8274 of 10019 relevant lines covered (82.58%)

144.86 hits per line

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

81.48

/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 { CanvasAddon } from 'xterm-addon-canvas';
import { SearchAddon } from 'xterm-addon-search';
import 'xterm/css/xterm.css';

const searchAddon = new SearchAddon();

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

export const Xterm = ({ addons, className, customKeyEventHandler, options = {}, style, 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;

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

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

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

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

    if (xtermRef.current.terminalRef.current) {
      // Creates the terminal within the container element.
      xtermRef.current.terminal.open(xtermRef.current.terminalRef.current);
      // we need to stick to the canvas addon, due to a lack of WebGL support in Safari
      // + to still have proper rendering performance
      xtermRef.current.terminal.loadAddon(new CanvasAddon());
    }
    return () => {
      // When the component unmounts dispose of the terminal and all of its listeners.
      xtermRef.current.terminal.dispose();
    };
  }, []);

  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 { CanvasAddon } from 'xterm-addon-canvas';
18	import { SearchAddon } from 'xterm-addon-search';
19	import 'xterm/css/xterm.css';
20
21	const searchAddon = new SearchAddon();	17✔
22
23	const defaultAddons = [searchAddon];	17✔
24	const defaultOptions = { allowProposedApi: true, scrollback: 5000 };	17✔
25
26	export const Xterm = ({ addons, className, customKeyEventHandler, options = {}, style, xtermRef, ...remainingProps }) => {	17✔
27	/**
28	* XTerm.js Terminal object.
29	*/
30	// This is assigned in the setupTerminal() which is called from the constructor
31	// terminal: Terminal
32	// const terminal = ref.current.terminal;
33
34	/**
35	* The ref for the containing element.
36	*/
37	// const terminalRef = ref.current.terminalRef;
38
39	useEffect(() => {	3✔
40	// Setup the XTerm terminal.
41	xtermRef.current.terminal = new Terminal({ ...defaultOptions, ...options });	3✔
42	// Load addons
43	defaultAddons.forEach(addon => xtermRef.current.terminal.loadAddon(addon));	3✔
44	if (addons.length) {	3!
45	addons.forEach(addon => xtermRef.current.terminal.loadAddon(addon));	3✔
46	}
47
48	// Create Listeners
49	Object.entries(remainingProps).map(([key, value]) => (value ? xtermRef.current.terminal[key](value) : undefined));	3!
50
51	// Add Custom Key Event Handler
52	if (customKeyEventHandler) {	3!
UNCOV 53	xtermRef.current.terminal.attachCustomKeyEventHandler(customKeyEventHandler);	×
54	}
55
56	if (xtermRef.current.terminalRef.current) {	3!
57	// Creates the terminal within the container element.
58	xtermRef.current.terminal.open(xtermRef.current.terminalRef.current);	3✔
59	// we need to stick to the canvas addon, due to a lack of WebGL support in Safari
60	// + to still have proper rendering performance
61	xtermRef.current.terminal.loadAddon(new CanvasAddon());	3✔
62	}
63	return () => {	3✔
64	// When the component unmounts dispose of the terminal and all of its listeners.
65	xtermRef.current.terminal.dispose();	3✔
66	};
67	}, []);
68
69	return <div className={className} ref={xtermRef.current.terminalRef} style={style} />;	3✔
70	};
71
72	export default Xterm;

mendersoftware / gui / 901187442

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