@theia/core
Version:
Theia is a cloud & desktop IDE framework implemented in TypeScript.
189 lines • 9.35 kB
JavaScript
// *****************************************************************************
// Copyright (C) 2019 TypeFox and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
// *****************************************************************************
import { __decorate } from "tslib";
import { enableJSDOM } from '../test/jsdom.js';
let disableJSDOM = enableJSDOM();
import { Container, injectable } from 'inversify';
import * as chai from 'chai';
import { ILogger } from '../../common/logger.js';
import { LocalStorageService } from '../storage-service.js';
import { MessageService } from '../../common/message-service.js';
import { WindowService } from '../window/window-service.js';
import { BrowserKeyboardLayoutProvider, KeyboardTester } from './browser-keyboard-layout-provider.js';
import { Key } from './keys.js';
import { stubOS } from '../../common/test/stub-os.js';
disableJSDOM();
describe('browser keyboard layout provider', function () {
let stubOSX;
let stubWindows;
before(() => disableJSDOM = enableJSDOM());
after(() => disableJSDOM());
const setup = (system) => {
switch (system) {
case 'mac':
stubOSX = stubOS('isOSX', true);
stubWindows = stubOS('isWindows', false);
break;
case 'win':
stubOSX = stubOS('isOSX', false);
stubWindows = stubOS('isWindows', true);
break;
default:
stubOSX = stubOS('isOSX', false);
stubWindows = stubOS('isWindows', false);
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const container = new Container();
container.bind(BrowserKeyboardLayoutProvider).toSelf();
container.bind(ILogger).to(MockLogger);
container.bind(LocalStorageService).toSelf().inSingletonScope();
container.bind(MessageService).toConstantValue({});
container.bind(WindowService).toConstantValue({});
const service = container.get(BrowserKeyboardLayoutProvider);
return { service, container };
};
afterEach(() => {
stubOSX.restore();
stubWindows.restore();
});
it('detects German Mac layout', async () => {
const { service } = setup('mac');
let currentLayout = await service.getNativeLayout();
service.onDidChangeNativeLayout(l => {
currentLayout = l;
});
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.US');
service.validateKey({ code: Key.SEMICOLON.code, character: 'ö' });
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.German');
});
it('detects French Mac layout', async () => {
const { service } = setup('mac');
let currentLayout = await service.getNativeLayout();
service.onDidChangeNativeLayout(l => {
currentLayout = l;
});
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.German');
service.validateKey({ code: Key.SEMICOLON.code, character: 'm' });
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.French');
});
it('detects keyboard layout change', async () => {
const { service } = setup('mac');
let currentLayout = await service.getNativeLayout();
service.onDidChangeNativeLayout(l => {
currentLayout = l;
});
service.validateKey({ code: Key.QUOTE.code, character: 'ä' });
service.validateKey({ code: Key.SEMICOLON.code, character: 'ö' });
service.validateKey({ code: Key.BRACKET_LEFT.code, character: 'ü' });
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.German');
service.validateKey({ code: Key.SEMICOLON.code, character: 'm' });
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.French');
});
it('applies layout chosen by the user', async () => {
const { service } = setup('mac');
let currentLayout = await service.getNativeLayout();
service.onDidChangeNativeLayout(l => {
currentLayout = l;
});
service.validateKey({ code: Key.SEMICOLON.code, character: 'm' });
const spanishLayout = service.allLayoutData.find(data => data.name === 'Spanish' && data.hardware === 'mac');
await service.setLayoutData(spanishLayout);
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.Spanish');
await service.setLayoutData('autodetect');
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.French');
});
it('restores pressed keys from last session', async () => {
const { service, container } = setup('mac');
service.validateKey({ code: Key.SEMICOLON.code, character: 'm' });
const service2 = container.get(BrowserKeyboardLayoutProvider);
chai.expect(service2).to.not.equal(service);
const currentLayout = await service2.getNativeLayout();
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.French');
});
it('scores AltGraph evidence independently from command Alt', () => {
const { service } = setup('linux');
const german = service.allLayoutData.find(data => data.name === 'German' && data.hardware === 'pc');
const tester = new KeyboardTester([german]);
tester.updateScores({ code: Key.DIGIT8.code, character: '[', altGraph: true });
chai.expect(tester.topScore).to.equal(1);
tester.reset();
tester.updateScores({ code: Key.DIGIT8.code, character: '[', altKey: true });
chai.expect(tester.topScore).to.equal(0);
});
it('can correct a wrong layout score from raw AltGraph evidence', () => {
const { service } = setup('linux');
const us = service.allLayoutData.find(data => data.name === 'US' && data.hardware === 'pc');
const german = service.allLayoutData.find(data => data.name === 'German' && data.hardware === 'pc');
const tester = new KeyboardTester([us, german]);
tester.updateScores({ code: Key.KEY_Y.code, character: 'y' });
chai.expect(tester.scores[0]).to.be.greaterThan(tester.scores[1]);
tester.updateScores({ code: Key.DIGIT8.code, character: '[', altGraph: true });
chai.expect(tester.scores[1]).to.equal(tester.scores[0]);
tester.updateScores({ code: Key.DIGIT7.code, character: '{', altGraph: true });
chai.expect(tester.scores[1]).to.be.greaterThan(tester.scores[0]);
});
it('changes the provider layout from raw AltGraph evidence', async () => {
const { service } = setup('linux');
await service.getNativeLayout();
const us = service.allLayoutData.find(data => data.name === 'US' && data.hardware === 'pc');
const german = service.allLayoutData.find(data => data.name === 'German' && data.hardware === 'pc');
const internal = service;
internal.tester = new KeyboardTester([us, german]);
internal.tester.updateScores({ code: Key.KEY_Y.code, character: 'y' });
internal.currentLayout = us;
internal.source = 'pressed-keys';
let changedLayout;
service.onDidChangeNativeLayout(layout => changedLayout = layout);
service.validateKey({ code: Key.DIGIT8.code, character: '[', altGraph: true });
service.validateKey({ code: Key.DIGIT7.code, character: '{', altGraph: true });
chai.expect(changedLayout?.info).to.deep.equal(german.raw.info);
chai.expect(service.currentLayoutData).to.equal(german);
});
it('restores user selection from last session', async () => {
const { service, container } = setup('mac');
const spanishLayout = service.allLayoutData.find(data => data.name === 'Spanish' && data.hardware === 'mac');
await service.setLayoutData(spanishLayout);
const service2 = container.get(BrowserKeyboardLayoutProvider);
chai.expect(service2).to.not.equal(service);
service2.validateKey({ code: Key.SEMICOLON.code, character: 'm' });
const currentLayout = await service2.getNativeLayout();
chai.expect(currentLayout.info.id).to.equal('com.apple.keylayout.Spanish');
});
});
let MockLogger = class MockLogger {
trace(loggable) {
return Promise.resolve();
}
debug(loggable) {
return Promise.resolve();
}
info(loggable) {
return Promise.resolve();
}
warn(loggable) {
return Promise.resolve();
}
error(loggable) {
return Promise.resolve();
}
fatal(loggable) {
return Promise.resolve();
}
};
MockLogger = __decorate([
injectable()
], MockLogger);
//# sourceMappingURL=browser-keyboard-layout-provider.spec.js.map