aboutsummaryrefslogtreecommitdiff
path: root/test/content/InputDriver.test.ts
blob: 441d10772b6ea8897f47d0c5d058d9905ff1ee3d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
import InputDriver, {keyFromKeyboardEvent} from '../../src/content/InputDriver';
import { expect } from 'chai';
import Key from '../../src/shared/settings/Key';

describe('InputDriver', () => {
  let target: HTMLElement;
  let driver: InputDriver;

  beforeEach(() => {
    target = document.createElement('div');
    document.body.appendChild(target);
    driver = new InputDriver(target);
  });

  afterEach(() => {
    target.remove();
    target = null;
    driver = null;
  });

  it('register callbacks', (done) => {
    driver.onKey((key: Key): boolean => {
      expect(key.key).to.equal('a');
      expect(key.ctrl).to.be.true;
      expect(key.shift).to.be.false;
      expect(key.alt).to.be.false;
      expect(key.meta).to.be.false;
      done();
      return true;
    });

    target.dispatchEvent(new KeyboardEvent('keydown', {
      key: 'a',
      ctrlKey: true,
      shiftKey: false,
      altKey: false,
      metaKey: false,
    }));
  });

  it('invoke callback once', () => {
    let a = 0, b = 0;
    driver.onKey((key: Key): boolean => {
      if (key.key == 'a') {
        ++a;
      } else {
        key.key == 'b'
        ++b;
      }
      return true;
    });

    let events = [
      new KeyboardEvent('keydown', { key: 'a' }),
      new KeyboardEvent('keydown', { key: 'b' }),
      new KeyboardEvent('keypress', { key: 'a' }),
      new KeyboardEvent('keyup', { key: 'a' }),
      new KeyboardEvent('keypress', { key: 'b' }),
      new KeyboardEvent('keyup', { key: 'b' }),
    ];
    for (let e of events) {
      target.dispatchEvent(e);
    }

    expect(a).to.equal(1);
    expect(b).to.equal(1);
  })

  it('propagates and stop handler chain', () => {
    let a = 0, b = 0, c = 0;
    driver.onKey((_key: Key): boolean => {
      a++;
      return false;
    });
    driver.onKey((_key: Key): boolean => {
      b++;
      return true;
    });
    driver.onKey((_key: Key): boolean => {
      c++;
      return true;
    });

    target.dispatchEvent(new KeyboardEvent('keydown', { key: 'b' }));

    expect(a).to.equal(1);
    expect(b).to.equal(1);
    expect(c).to.equal(0);
  })

  it('does not invoke only meta keys', () => {
    driver.onKey((_key: Key): boolean=> {
      expect.fail();
      return false;
    });

    target.dispatchEvent(new KeyboardEvent('keydown', { key: 'Shift' }));
    target.dispatchEvent(new KeyboardEvent('keydown', { key: 'Control' }));
    target.dispatchEvent(new KeyboardEvent('keydown', { key: 'Alt' }));
    target.dispatchEvent(new KeyboardEvent('keydown', { key: 'OS' }));
  })

  it('ignores events from input elements', () => {
    ['input', 'textarea', 'select'].forEach((name) => {
      let input = window.document.createElement(name);
      let driver = new InputDriver(input);
      driver.onKey((key: Key): boolean => {
        expect.fail();
        return false;
      });
      input.dispatchEvent(new KeyboardEvent('keydown', { key: 'x' }));
    });
  });

  it('ignores events from contenteditable elements', () => {
    let div = window.document.createElement('div');
    let driver = new InputDriver(div);
    driver.onKey((_key: Key): boolean => {
      expect.fail();
      return false;
    });

    div.setAttribute('contenteditable', '');
    div.dispatchEvent(new KeyboardEvent('keydown', { key: 'x' }));

    div.setAttribute('contenteditable', 'true');
    div.dispatchEvent(new KeyboardEvent('keydown', { key: 'x' }));
  });
});

describe("#keyFromKeyboardEvent", () => {
  it('returns from keyboard input Ctrl+X', () => {
    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
      key: 'x', shiftKey: false, ctrlKey: true, altKey: false, metaKey: true,
    }));
    expect(k.key).to.equal('x');
    expect(k.shift).to.be.false;
    expect(k.ctrl).to.be.true;
    expect(k.alt).to.be.false;
    expect(k.meta).to.be.true;
  });

  it('returns from keyboard input Shift+Esc', () => {
    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
      key: 'Escape', shiftKey: true, ctrlKey: false, altKey: false, metaKey: true
    }));
    expect(k.key).to.equal('Esc');
    expect(k.shift).to.be.true;
    expect(k.ctrl).to.be.false;
    expect(k.alt).to.be.false;
    expect(k.meta).to.be.true;
  });

  it('returns from keyboard input Ctrl+$', () => {
    // $ required shift pressing on most keyboards
    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
      key: '$', shiftKey: true, ctrlKey: true, altKey: false, metaKey: false
    }));
    expect(k.key).to.equal('$');
    expect(k.shift).to.be.false;
    expect(k.ctrl).to.be.true;
    expect(k.alt).to.be.false;
    expect(k.meta).to.be.false;
  });

  it('returns from keyboard input Crtl+Space', () => {
    let k = keyFromKeyboardEvent(new KeyboardEvent('keydown', {
      key: ' ', shiftKey: false, ctrlKey: true, altKey: false, metaKey: false
    }));
    expect(k.key).to.equal('Space');
    expect(k.shift).to.be.false;
    expect(k.ctrl).to.be.true;
    expect(k.alt).to.be.false;
    expect(k.meta).to.be.false;
  });
});