• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

mendersoftware / gui / 1015445845

25 Sep 2023 09:43AM UTC coverage: 82.537% (-17.4%) from 99.964%
1015445845

Pull #4028

gitlab-ci

mzedel
chore: aligned release retrieval with v2 api models

Signed-off-by: Manuel Zedel <manuel.zedel@northern.tech>
Pull Request #4028: MEN-6455

4355 of 6315 branches covered (0.0%)

184 of 206 new or added lines in 19 files covered. (89.32%)

1724 existing lines in 164 files now uncovered.

8323 of 10084 relevant lines covered (82.54%)

208.49 hits per line

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

95.0
/src/js/components/common/xterm.js
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
const canvasAddon = new CanvasAddon();
17✔
23

24
const defaultAddons = [searchAddon];
17✔
25
const defaultOptions = { allowProposedApi: true, scrollback: 5000 };
17✔
26

27
export const Xterm = ({ addons, className, customKeyEventHandler, options = {}, style, xtermRef, ...remainingProps }) => {
17✔
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(() => {
3✔
41
    let { terminal, terminalRef } = xtermRef.current;
3✔
42
    // Setup the XTerm terminal.
43
    terminal.current = new Terminal({ ...defaultOptions, ...options });
3✔
44
    // Load addons
45
    defaultAddons.forEach(addon => terminal.current.loadAddon(addon));
3✔
46
    if (addons.length) {
3!
47
      addons.forEach(addon => terminal.current.loadAddon(addon));
3✔
48
    }
49

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

53
    // Add Custom Key Event Handler
54
    if (customKeyEventHandler) {
3!
UNCOV
55
      terminal.current.attachCustomKeyEventHandler(customKeyEventHandler);
×
56
    }
57

58
    if (terminalRef.current) {
3!
59
      // Creates the terminal within the container element.
60
      terminal.current.open(terminalRef.current);
3✔
61
      // we need to stick to the canvas addon, due to a lack of WebGL support in Safari
62
      // + to still have proper rendering performance
63
      terminal.current.loadAddon(canvasAddon);
3✔
64
    }
65
    return () => {
3✔
66
      // When the component unmounts dispose of the terminal and all of its listeners.
67
      // eslint-disable-next-line react-hooks/exhaustive-deps
68
      terminal.current.dispose();
3✔
69
    };
70
    // eslint-disable-next-line react-hooks/exhaustive-deps
71
  }, [addons, customKeyEventHandler, JSON.stringify(options), Object.keys(remainingProps).join('')]);
72

73
  return <div className={className} ref={xtermRef.current.terminalRef} style={style} />;
3✔
74
};
75

76
export default Xterm;
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc