Alexandre Kühn
b4f132ca21
Before this commit, chat windows could not be sync'ed between browser tabs for about 10 to 20 seconds. This issue is caused by the implementation of the crosstab longpolling, which uses a master-slave architecture with a single tab being the master tab. The master tab is responsible for performing the longpolling RPC, so that it keeps a single HTTP request for all Odoo tabs. Other tabs are synchronized through the local storage. When the master tab was closed, a new master tab election must occur. However, this process was taking up to 20 seconds, due to the tab waiting for their next tick on the local storage to initiate a new election. The tick for a slave tab is 10 seconds, and it may jumps a tick in case the master tab is closed exactly before the tick, hence extending the duration to 20 seconds. This commit fixes the problem by ensuring that the tab election for the longpolling is done right after the master tab is closed. As a result, a new master tab should follow right away. Steps to reproduce: 1. open two tabs. 2. open a chat window in one tab: it opens in both tabs. 3. fold/unfold chat window in one tab: both tab should sync. 4. refresh both tabs. 5. fold/unfold chat window in one tab: both tab should not sync. 6. after 10 or 20 seconds, both tabs should again sync. Task-ID 1911437 closes odoo/odoo#28925
320 lines
11 KiB
JavaScript
320 lines
11 KiB
JavaScript
odoo.define('web.bus_tests', function (require) {
|
|
"use strict";
|
|
|
|
var BusService = require('bus.BusService');
|
|
var AbstractStorageService = require('web.AbstractStorageService');
|
|
var RamStorage = require('web.RamStorage');
|
|
var testUtils = require('web.test_utils');
|
|
var Widget = require('web.Widget');
|
|
|
|
|
|
var LocalStorageServiceMock;
|
|
|
|
BusService = BusService.extend({
|
|
TAB_HEARTBEAT_PERIOD: 10,
|
|
MASTER_TAB_HEARTBEAT_PERIOD: 1,
|
|
});
|
|
|
|
|
|
QUnit.module('Bus', {
|
|
beforeEach: function () {
|
|
LocalStorageServiceMock = AbstractStorageService.extend({storage: new RamStorage()});
|
|
},
|
|
}, function () {
|
|
QUnit.test('notifications received from the longpolling channel', function (assert) {
|
|
assert.expect(6);
|
|
|
|
var pollDeferred = $.Deferred();
|
|
|
|
var parent = new Widget();
|
|
testUtils.addMockEnvironment(parent, {
|
|
data: {},
|
|
services: {
|
|
bus_service: BusService,
|
|
local_storage: LocalStorageServiceMock,
|
|
},
|
|
mockRPC: function (route, args) {
|
|
if (route === '/longpolling/poll') {
|
|
assert.step([route, args.channels.join(',')]);
|
|
|
|
pollDeferred = $.Deferred();
|
|
pollDeferred.abort = (function () {
|
|
this.reject({message: "XmlHttpRequestError abort"}, $.Event());
|
|
}).bind(pollDeferred);
|
|
return pollDeferred;
|
|
}
|
|
return this._super.apply(this, arguments);
|
|
}
|
|
});
|
|
|
|
var widget = new Widget(parent);
|
|
widget.appendTo($('#qunit-fixture'));
|
|
|
|
widget.call('bus_service', 'onNotification', this, function (notifications) {
|
|
assert.step(['notification', notifications]);
|
|
});
|
|
widget.call('bus_service', 'addChannel', 'lambda');
|
|
|
|
pollDeferred.resolve([{
|
|
id: 1,
|
|
channel: 'lambda',
|
|
message: 'beta',
|
|
}]);
|
|
pollDeferred.resolve([{
|
|
id: 2,
|
|
channel: 'lambda',
|
|
message: 'epsilon',
|
|
}]);
|
|
|
|
assert.verifySteps([
|
|
["/longpolling/poll", "lambda"],
|
|
["notification", [["lambda","beta"]]],
|
|
["/longpolling/poll", "lambda"],
|
|
["notification", [["lambda","epsilon"]]],
|
|
["/longpolling/poll", "lambda"]
|
|
]);
|
|
|
|
parent.destroy();
|
|
});
|
|
|
|
QUnit.test('provide notification ID of 0 by default', function (assert) {
|
|
// This test is important in order to ensure that we provide the correct
|
|
// sentinel value 0 when we are not aware of the last notification ID
|
|
// that we have received. We cannot provide an ID of -1, otherwise it
|
|
// may likely be handled incorrectly (before this test was written,
|
|
// it was providing -1 to the server, which in return sent every stored
|
|
// notifications related to this user).
|
|
assert.expect(3);
|
|
|
|
// Simulate no ID of last notification in the local storage
|
|
testUtils.patch(LocalStorageServiceMock, {
|
|
getItem: function (key) {
|
|
if (key === 'last_ts') {
|
|
return 0;
|
|
}
|
|
return this._super.apply(this, arguments);
|
|
},
|
|
});
|
|
|
|
var pollDeferred = $.Deferred();
|
|
var parent = new Widget();
|
|
testUtils.addMockEnvironment(parent, {
|
|
data: {},
|
|
services: {
|
|
bus_service: BusService,
|
|
local_storage: LocalStorageServiceMock,
|
|
},
|
|
mockRPC: function (route, args) {
|
|
if (route === '/longpolling/poll') {
|
|
assert.step(route);
|
|
assert.strictEqual(args.last, 0,
|
|
"provided last notification ID should be 0");
|
|
|
|
pollDeferred = $.Deferred();
|
|
pollDeferred.abort = (function () {
|
|
this.reject({message: "XmlHttpRequestError abort"}, $.Event());
|
|
}).bind(pollDeferred);
|
|
return pollDeferred;
|
|
}
|
|
return this._super.apply(this, arguments);
|
|
}
|
|
});
|
|
|
|
var widget = new Widget(parent);
|
|
widget.appendTo($('#qunit-fixture'));
|
|
|
|
// trigger longpolling poll RPC
|
|
widget.call('bus_service', 'addChannel', 'lambda');
|
|
assert.verifySteps(['/longpolling/poll']);
|
|
|
|
testUtils.unpatch(LocalStorageServiceMock);
|
|
parent.destroy();
|
|
});
|
|
|
|
QUnit.test('cross tab bus share message from a channel', function (assert) {
|
|
var done = assert.async();
|
|
assert.expect(5);
|
|
|
|
// master
|
|
|
|
var pollDeferredMaster = $.Deferred();
|
|
|
|
var parentMaster = new Widget();
|
|
testUtils.addMockEnvironment(parentMaster, {
|
|
data: {},
|
|
services: {
|
|
bus_service: BusService,
|
|
local_storage: LocalStorageServiceMock,
|
|
},
|
|
mockRPC: function (route, args) {
|
|
if (route === '/longpolling/poll') {
|
|
assert.step(['master', route, args.channels.join(',')]);
|
|
|
|
pollDeferredMaster = $.Deferred();
|
|
pollDeferredMaster.abort = (function () {
|
|
this.reject({message: "XmlHttpRequestError abort"}, $.Event());
|
|
}).bind(pollDeferredMaster);
|
|
return pollDeferredMaster;
|
|
}
|
|
return this._super.apply(this, arguments);
|
|
}
|
|
});
|
|
|
|
var master = new Widget(parentMaster);
|
|
master.appendTo($('#qunit-fixture'));
|
|
|
|
master.call('bus_service', 'onNotification', master, function (notifications) {
|
|
assert.step(['master', 'notification', notifications]);
|
|
});
|
|
master.call('bus_service', 'addChannel', 'lambda');
|
|
|
|
// slave
|
|
|
|
setTimeout(function () {
|
|
var parentSlave = new Widget();
|
|
testUtils.addMockEnvironment(parentSlave, {
|
|
data: {},
|
|
services: {
|
|
bus_service: BusService,
|
|
local_storage: LocalStorageServiceMock,
|
|
},
|
|
mockRPC: function (route, args) {
|
|
if (route === '/longpolling/poll') {
|
|
throw new Error("Can not use the longpolling of the slave client");
|
|
}
|
|
return this._super.apply(this, arguments);
|
|
}
|
|
});
|
|
|
|
var slave = new Widget(parentSlave);
|
|
slave.appendTo($('#qunit-fixture'));
|
|
|
|
slave.call('bus_service', 'onNotification', slave, function (notifications) {
|
|
assert.step(['slave', 'notification', notifications]);
|
|
});
|
|
slave.call('bus_service', 'addChannel', 'lambda');
|
|
|
|
pollDeferredMaster.resolve([{
|
|
id: 1,
|
|
channel: 'lambda',
|
|
message: 'beta',
|
|
}]);
|
|
|
|
assert.verifySteps([
|
|
["master", "/longpolling/poll", "lambda"],
|
|
["master", "notification", [["lambda", "beta"]]],
|
|
["slave", "notification", [["lambda", "beta"]]],
|
|
["master", "/longpolling/poll", "lambda"],
|
|
]);
|
|
|
|
parentMaster.destroy();
|
|
parentSlave.destroy();
|
|
|
|
done();
|
|
|
|
}, 3);
|
|
});
|
|
|
|
QUnit.test('cross tab bus elect new master on master unload', function (assert) {
|
|
var done = assert.async();
|
|
assert.expect(8);
|
|
|
|
// master
|
|
var pollDeferredMaster = $.Deferred();
|
|
|
|
var parentMaster = new Widget();
|
|
testUtils.addMockEnvironment(parentMaster, {
|
|
data: {},
|
|
services: {
|
|
bus_service: BusService,
|
|
local_storage: LocalStorageServiceMock,
|
|
},
|
|
mockRPC: function (route, args) {
|
|
if (route === '/longpolling/poll') {
|
|
assert.step(['master', route, args.channels.join(',')]);
|
|
|
|
pollDeferredMaster = $.Deferred();
|
|
pollDeferredMaster.abort = (function () {
|
|
this.reject({message: "XmlHttpRequestError abort"}, $.Event());
|
|
}).bind(pollDeferredMaster);
|
|
return pollDeferredMaster;
|
|
}
|
|
return this._super.apply(this, arguments);
|
|
}
|
|
});
|
|
|
|
var master = new Widget(parentMaster);
|
|
master.appendTo($('#qunit-fixture'));
|
|
|
|
master.call('bus_service', 'onNotification', master, function (notifications) {
|
|
assert.step(['master', 'notification', notifications]);
|
|
});
|
|
master.call('bus_service', 'addChannel', 'lambda');
|
|
|
|
// slave
|
|
setTimeout(function () {
|
|
var parentSlave = new Widget();
|
|
var pollDeferredSlave = $.Deferred();
|
|
testUtils.addMockEnvironment(parentSlave, {
|
|
data: {},
|
|
services: {
|
|
bus_service: BusService,
|
|
local_storage: LocalStorageServiceMock,
|
|
},
|
|
mockRPC: function (route, args) {
|
|
if (route === '/longpolling/poll') {
|
|
assert.step(['slave', route, args.channels.join(',')]);
|
|
|
|
pollDeferredSlave = $.Deferred();
|
|
pollDeferredSlave.abort = (function () {
|
|
this.reject({message: "XmlHttpRequestError abort"}, $.Event());
|
|
}).bind(pollDeferredSlave);
|
|
return pollDeferredSlave;
|
|
}
|
|
return this._super.apply(this, arguments);
|
|
}
|
|
});
|
|
|
|
var slave = new Widget(parentSlave);
|
|
slave.appendTo($('#qunit-fixture'));
|
|
|
|
slave.call('bus_service', 'onNotification', slave, function (notifications) {
|
|
assert.step(['slave', 'notification', notifications]);
|
|
});
|
|
slave.call('bus_service', 'addChannel', 'lambda');
|
|
|
|
pollDeferredMaster.resolve([{
|
|
id: 1,
|
|
channel: 'lambda',
|
|
message: 'beta',
|
|
}]);
|
|
|
|
// simulate unloading master
|
|
master.call('bus_service', '_onUnload');
|
|
|
|
pollDeferredSlave.resolve([{
|
|
id: 2,
|
|
channel: 'lambda',
|
|
message: 'gamma',
|
|
}]);
|
|
|
|
assert.verifySteps([
|
|
["master", "/longpolling/poll", "lambda"],
|
|
["master", "notification", [["lambda", "beta"]]],
|
|
["slave", "notification", [["lambda", "beta"]]],
|
|
["master", "/longpolling/poll", "lambda"],
|
|
["slave", "/longpolling/poll", "lambda"],
|
|
["slave", "notification", [["lambda", "gamma"]]],
|
|
["slave", "/longpolling/poll", "lambda"],
|
|
]);
|
|
|
|
parentMaster.destroy();
|
|
parentSlave.destroy();
|
|
|
|
done();
|
|
|
|
}, 3);
|
|
});
|
|
|
|
});});
|