publicWagsHome/KasmVNC
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Properly limit mouse moves to once every 17 ms

Browse Source 
Previous attempt in c958269 had a number of issues, this is a full
rewrite, complete with improved unit tests.

Fixes github issue #1402
This commit is contained in:
Samuel Mannehed
2020-05-09 20:03:06 +02:00
committed by Lauri Kasanen
parent 8a8fa1d906
commit 19c473f792
4 changed files with 165 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
kasmweb/tests/test.mouse.js
View File

@@ -300,72 +300,4 @@ describe('Mouse Event Handling', function () {
expect(mouse.onmousebutton).to.have.callCount(4); // mouse down and up
});
});
describe('Move events should be limited to one each 17 ms', function () {
let mouse;
beforeEach(function () {
this.clock = sinon.useFakeTimers(Date.now());
mouse = new Mouse(target);
mouse.onmousemove = sinon.spy();
});
afterEach(function () {
this.clock.restore();
});
it('should send a single move instantly', function () {
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 1, clientY: 2 }));
expect(mouse.onmousemove).to.have.callCount(1);
});
it('should delay one if two events are too close', function () {
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 18, clientY: 30 }));
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 20, clientY: 50 }));
expect(mouse.onmousemove).to.have.callCount(1);
this.clock.tick(100);
expect(mouse.onmousemove).to.have.callCount(2);
});
it('should only send first and last of many close events', function () {
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 18, clientY: 30 }));
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 20, clientY: 50 }));
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 21, clientY: 55 }));
// Check positions to verify that the correct calls got through.
//
// The test canvas starts 10px from top and 10 px from left,
// that means the relative coordinates are clientCoords - 10px
expect(mouse.onmousemove).to.have.been.calledWith(8, 20);
this.clock.tick(60);
expect(mouse.onmousemove).to.have.callCount(2);
expect(mouse.onmousemove).to.have.been.calledWith(11, 45);
});
it('should send events with enough time apart normally', function () {
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 58, clientY: 60 }));
expect(mouse.onmousemove).to.have.callCount(1);
this.clock.tick(20);
mouse._handleMouseMove(mouseevent(
'mousemove', { clientX: 25, clientY: 60 }));
expect(mouse.onmousemove).to.have.callCount(2);
});
});
});

137
kasmweb/tests/test.rfb.js
View File

@@ -2730,56 +2730,145 @@ describe('Remote Frame Buffer Protocol Client', function () {
});
describe('Mouse event handlers', function () {
beforeEach(function () {
this.clock = sinon.useFakeTimers(Date.now());
sinon.spy(RFB.messages, 'pointerEvent');
});
afterEach(function () {
this.clock.restore();
RFB.messages.pointerEvent.restore();
});
it('should not send button messages in view-only mode', function () {
client._viewOnly = true;
sinon.spy(client._sock, 'flush');
client._handleMouseButton(0, 0, 1, 0x001);
expect(client._sock.flush).to.not.have.been.called;
expect(RFB.messages.pointerEvent).to.not.have.been.called;
});
it('should not send movement messages in view-only mode', function () {
client._viewOnly = true;
sinon.spy(client._sock, 'flush');
client._handleMouseMove(0, 0);
expect(client._sock.flush).to.not.have.been.called;
expect(RFB.messages.pointerEvent).to.not.have.been.called;
});
it('should send a pointer event on mouse button presses', function () {
client._handleMouseButton(10, 12, 1, 0x001);
const pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: () => {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x001);
expect(client._sock).to.have.sent(pointer_msg._sQ);
expect(RFB.messages.pointerEvent).to.have.been.calledOnce;
});
it('should send a mask of 1 on mousedown', function () {
client._handleMouseButton(10, 12, 1, 0x001);
const pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: () => {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x001);
expect(client._sock).to.have.sent(pointer_msg._sQ);
client._handleMouseButton(11, 13, 1, 0x001);
expect(RFB.messages.pointerEvent).to.have.been.calledWith(
client._sock, 11, 13, 0x001);
});
it('should send a mask of 0 on mouseup', function () {
client._mouse_buttonMask = 0x001;
client._handleMouseButton(10, 12, 0, 0x001);
const pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: () => {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x000);
expect(client._sock).to.have.sent(pointer_msg._sQ);
client._handleMouseButton(105, 120, 0, 0x001);
expect(RFB.messages.pointerEvent).to.have.been.calledWith(
client._sock, 105, 120, 0x000);
});
it('should send a pointer event on mouse movement', function () {
client._handleMouseMove(10, 12);
const pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: () => {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x000);
expect(client._sock).to.have.sent(pointer_msg._sQ);
it('should send a mask of 0 on mousemove', function () {
client._handleMouseMove(100, 200);
expect(RFB.messages.pointerEvent).to.have.been.calledWith(
client._sock, 100, 200, 0x000);
});
it('should set the button mask so that future mouse movements use it', function () {
client._handleMouseButton(10, 12, 1, 0x010);
client._handleMouseMove(13, 9);
const pointer_msg = {_sQ: new Uint8Array(12), _sQlen: 0, flush: () => {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x010);
RFB.messages.pointerEvent(pointer_msg, 13, 9, 0x010);
expect(client._sock).to.have.sent(pointer_msg._sQ);
expect(RFB.messages.pointerEvent).to.have.been.calledTwice;
expect(RFB.messages.pointerEvent).to.have.been.calledWith(
client._sock, 13, 9, 0x010);
});
it('should send a single pointer event on mouse movement', function () {
client._handleMouseMove(100, 200);
this.clock.tick(100);
expect(RFB.messages.pointerEvent).to.have.been.calledOnce;
});
it('should delay one move if two events are too close', function () {
client._handleMouseMove(18, 30);
client._handleMouseMove(20, 50);
expect(RFB.messages.pointerEvent).to.have.been.calledOnce;
this.clock.tick(100);
expect(RFB.messages.pointerEvent).to.have.been.calledTwice;
});
it('should only send first and last move of many close events', function () {
client._handleMouseMove(18, 40);
client._handleMouseMove(20, 50);
client._handleMouseMove(21, 55);
expect(RFB.messages.pointerEvent).to.have.been.calledOnce;
this.clock.tick(60);
expect(RFB.messages.pointerEvent).to.have.been.calledTwice;
expect(RFB.messages.pointerEvent.firstCall).to.have.been.calledWith(
client._sock, 18, 40, 0x000);
expect(RFB.messages.pointerEvent.secondCall).to.have.been.calledWith(
client._sock, 21, 55, 0x000);
});
// We selected the 17ms since that is ~60 FPS
it('should send move events every 17 ms', function () {
client._handleMouseMove(1, 10); // instant send
this.clock.tick(10);
client._handleMouseMove(2, 20); // delayed
this.clock.tick(10); // timeout send
client._handleMouseMove(3, 30); // delayed
this.clock.tick(10);
client._handleMouseMove(4, 40); // delayed
this.clock.tick(10); // timeout send
client._handleMouseMove(5, 50); // delayed
expect(RFB.messages.pointerEvent).to.have.callCount(3);
expect(RFB.messages.pointerEvent.firstCall).to.have.been.calledWith(
client._sock, 1, 10, 0x000);
expect(RFB.messages.pointerEvent.secondCall).to.have.been.calledWith(
client._sock, 2, 20, 0x000);
expect(RFB.messages.pointerEvent.thirdCall).to.have.been.calledWith(
client._sock, 4, 40, 0x000);
});
it('should send waiting move events before a button press', function () {
client._handleMouseMove(13, 9);
client._handleMouseMove(20, 70);
client._handleMouseButton(10, 12, 1, 0x100);
expect(RFB.messages.pointerEvent).to.have.been.calledThrice;
expect(RFB.messages.pointerEvent.firstCall).to.have.been.calledWith(
client._sock, 13, 9, 0x000);
expect(RFB.messages.pointerEvent.secondCall).to.have.been.calledWith(
client._sock, 10, 12, 0x000);
expect(RFB.messages.pointerEvent.thirdCall).to.have.been.calledWith(
client._sock, 10, 12, 0x100);
});
it('should not delay events when button mask changes', function () {
client._handleMouseMove(13, 9); // instant
client._handleMouseMove(11, 10); // delayed
client._handleMouseButton(10, 12, 1, 0x010); // flush delayed
expect(RFB.messages.pointerEvent).to.have.been.calledThrice;
});
it('should send move events with enough time apart normally', function () {
client._handleMouseMove(58, 60);
expect(RFB.messages.pointerEvent).to.have.been.calledOnce;
this.clock.tick(20);
client._handleMouseMove(25, 60);
expect(RFB.messages.pointerEvent).to.have.been.calledTwice;
});
it('should not send waiting move events if disconnected', function () {
client._handleMouseMove(88, 99);
client._handleMouseMove(66, 77);
client.disconnect();
this.clock.tick(20);
expect(RFB.messages.pointerEvent).to.have.been.calledOnce;
});
});