2016-03-31 01:48:46 +02:00
|
|
|
/*
|
|
|
|
Copyright 2016 OpenMarket Ltd
|
2019-11-26 20:06:02 +01:00
|
|
|
Copyright 2019 The Matrix.org Foundation C.I.C.
|
2016-03-31 01:48:46 +02:00
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2017-10-29 08:43:52 +01:00
|
|
|
import SettingsStore from "../../../src/settings/SettingsStore";
|
|
|
|
|
2019-09-06 16:04:46 +02:00
|
|
|
import React from 'react';
|
|
|
|
import createReactClass from 'create-react-class';
|
|
|
|
import ReactDOM from "react-dom";
|
2019-07-31 13:19:29 +02:00
|
|
|
import PropTypes from "prop-types";
|
2019-08-24 12:47:07 +02:00
|
|
|
const TestUtils = require('react-dom/test-utils');
|
2017-10-11 18:56:17 +02:00
|
|
|
const expect = require('expect');
|
2017-07-07 16:26:55 +02:00
|
|
|
import sinon from 'sinon';
|
2019-03-15 09:57:26 +01:00
|
|
|
import { EventEmitter } from "events";
|
2016-03-31 01:48:46 +02:00
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
const sdk = require('matrix-react-sdk');
|
2016-03-31 01:48:46 +02:00
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
const MessagePanel = sdk.getComponent('structures.MessagePanel');
|
2017-09-15 04:47:24 +02:00
|
|
|
import MatrixClientPeg from '../../../src/MatrixClientPeg';
|
2018-11-13 09:34:54 +01:00
|
|
|
import Matrix from 'matrix-js-sdk';
|
2016-03-31 01:48:46 +02:00
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
const test_utils = require('test-utils');
|
|
|
|
const mockclock = require('mock-clock');
|
2016-03-31 01:48:46 +02:00
|
|
|
|
2019-03-20 18:43:19 +01:00
|
|
|
import Velocity from 'velocity-animate';
|
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
let client;
|
2018-11-13 09:34:54 +01:00
|
|
|
const room = new Matrix.Room();
|
2016-11-14 19:20:15 +01:00
|
|
|
|
|
|
|
// wrap MessagePanel with a component which provides the MatrixClient in the context.
|
2019-09-06 16:04:46 +02:00
|
|
|
const WrappedMessagePanel = createReactClass({
|
2016-11-14 19:20:15 +01:00
|
|
|
childContextTypes: {
|
2019-07-31 13:19:29 +02:00
|
|
|
matrixClient: PropTypes.object,
|
2019-07-31 13:21:00 +02:00
|
|
|
room: PropTypes.object,
|
2016-11-14 19:20:15 +01:00
|
|
|
},
|
|
|
|
|
|
|
|
getChildContext: function() {
|
|
|
|
return {
|
|
|
|
matrixClient: client,
|
2019-07-31 12:17:24 +02:00
|
|
|
room: {
|
|
|
|
canReact: true,
|
|
|
|
canReply: true,
|
|
|
|
},
|
2016-11-14 19:20:15 +01:00
|
|
|
};
|
|
|
|
},
|
|
|
|
|
2019-03-15 09:57:26 +01:00
|
|
|
getInitialState: function() {
|
|
|
|
return {
|
|
|
|
resizeNotifier: new EventEmitter(),
|
|
|
|
};
|
|
|
|
},
|
|
|
|
|
2016-11-14 19:20:15 +01:00
|
|
|
render: function() {
|
2019-03-15 09:57:26 +01:00
|
|
|
return <MessagePanel room={room} {...this.props} resizeNotifier={this.state.resizeNotifier} />;
|
2016-11-14 19:20:15 +01:00
|
|
|
},
|
|
|
|
});
|
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
describe('MessagePanel', function() {
|
|
|
|
const clock = mockclock.clock();
|
|
|
|
const realSetTimeout = window.setTimeout;
|
|
|
|
const events = mkEvents();
|
|
|
|
let sandbox = null;
|
2016-03-31 01:48:46 +02:00
|
|
|
|
2016-04-07 17:47:17 +02:00
|
|
|
beforeEach(function() {
|
|
|
|
test_utils.beforeEach(this);
|
2017-09-15 04:47:24 +02:00
|
|
|
sandbox = test_utils.stubClient();
|
|
|
|
client = MatrixClientPeg.get();
|
2016-04-19 22:10:23 +02:00
|
|
|
client.credentials = {userId: '@me:here'};
|
2017-10-29 08:43:52 +01:00
|
|
|
|
|
|
|
// HACK: We assume all settings want to be disabled
|
|
|
|
SettingsStore.getValue = sinon.stub().returns(false);
|
2019-11-26 20:06:02 +01:00
|
|
|
SettingsStore.getValue.withArgs('showDisplaynameChanges').returns(true);
|
2019-03-20 18:43:19 +01:00
|
|
|
|
2019-03-20 19:11:42 +01:00
|
|
|
// This option clobbers the duration of all animations to be 1ms
|
2019-03-20 18:43:19 +01:00
|
|
|
// which makes unit testing a lot simpler (the animation doesn't
|
|
|
|
// complete without this even if we mock the clock and tick it
|
|
|
|
// what should be the correct amount of time).
|
|
|
|
Velocity.mock = true;
|
2016-04-07 17:47:17 +02:00
|
|
|
});
|
|
|
|
|
2017-07-07 16:26:55 +02:00
|
|
|
afterEach(function() {
|
2019-03-20 18:43:19 +01:00
|
|
|
delete Velocity.mock;
|
|
|
|
|
2016-03-31 01:48:46 +02:00
|
|
|
clock.uninstall();
|
2017-09-15 04:47:24 +02:00
|
|
|
sandbox.restore();
|
2016-03-31 01:48:46 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
function mkEvents() {
|
2017-10-11 18:56:17 +02:00
|
|
|
const events = [];
|
|
|
|
const ts0 = Date.now();
|
|
|
|
for (let i = 0; i < 10; i++) {
|
2016-03-31 01:48:46 +02:00
|
|
|
events.push(test_utils.mkMessage(
|
|
|
|
{
|
|
|
|
event: true, room: "!room:id", user: "@user:id",
|
|
|
|
ts: ts0 + i*1000,
|
|
|
|
}));
|
|
|
|
}
|
|
|
|
return events;
|
|
|
|
}
|
|
|
|
|
2019-11-26 20:06:02 +01:00
|
|
|
|
|
|
|
// make a collection of events with some member events that should be collapsed
|
|
|
|
// with a MemberEventListSummary
|
|
|
|
function mkMelsEvents() {
|
|
|
|
const events = [];
|
|
|
|
const ts0 = Date.now();
|
|
|
|
|
|
|
|
let i = 0;
|
|
|
|
events.push(test_utils.mkMessage({
|
|
|
|
event: true, room: "!room:id", user: "@user:id",
|
|
|
|
ts: ts0 + ++i*1000,
|
|
|
|
}));
|
|
|
|
|
|
|
|
for (i = 0; i < 10; i++) {
|
|
|
|
events.push(test_utils.mkMembership({
|
|
|
|
event: true, room: "!room:id", user: "@user:id",
|
|
|
|
target: {
|
|
|
|
userId: "@user:id",
|
|
|
|
name: "Bob",
|
|
|
|
getAvatarUrl: () => {
|
|
|
|
return "avatar.jpeg";
|
|
|
|
},
|
|
|
|
},
|
|
|
|
ts: ts0 + i*1000,
|
|
|
|
mship: 'join',
|
|
|
|
prevMship: 'join',
|
|
|
|
name: 'A user',
|
|
|
|
}));
|
|
|
|
}
|
|
|
|
|
|
|
|
events.push(test_utils.mkMessage({
|
|
|
|
event: true, room: "!room:id", user: "@user:id",
|
|
|
|
ts: ts0 + ++i*1000,
|
|
|
|
}));
|
|
|
|
|
|
|
|
return events;
|
|
|
|
}
|
|
|
|
|
2016-03-31 01:48:46 +02:00
|
|
|
it('should show the events', function() {
|
2017-10-11 18:56:17 +02:00
|
|
|
const res = TestUtils.renderIntoDocument(
|
|
|
|
<WrappedMessagePanel className="cls" events={events} />,
|
2016-03-31 01:48:46 +02:00
|
|
|
);
|
|
|
|
|
|
|
|
// just check we have the right number of tiles for now
|
2017-10-11 18:56:17 +02:00
|
|
|
const tiles = TestUtils.scryRenderedComponentsWithType(
|
2016-03-31 01:48:46 +02:00
|
|
|
res, sdk.getComponent('rooms.EventTile'));
|
|
|
|
expect(tiles.length).toEqual(10);
|
|
|
|
});
|
|
|
|
|
2019-11-26 20:06:02 +01:00
|
|
|
it('should collapse adjacent member events', function() {
|
|
|
|
const res = TestUtils.renderIntoDocument(
|
|
|
|
<WrappedMessagePanel className="cls" events={mkMelsEvents()} />,
|
|
|
|
);
|
|
|
|
|
|
|
|
// just check we have the right number of tiles for now
|
|
|
|
const tiles = TestUtils.scryRenderedComponentsWithType(
|
|
|
|
res, sdk.getComponent('rooms.EventTile'),
|
|
|
|
);
|
|
|
|
expect(tiles.length).toEqual(2);
|
|
|
|
|
|
|
|
const summaryTiles = TestUtils.scryRenderedComponentsWithType(
|
|
|
|
res, sdk.getComponent('elements.MemberEventListSummary'),
|
|
|
|
);
|
|
|
|
expect(summaryTiles.length).toEqual(1);
|
|
|
|
});
|
|
|
|
|
2016-03-31 01:48:46 +02:00
|
|
|
it('should show the read-marker in the right place', function() {
|
2017-10-11 18:56:17 +02:00
|
|
|
const res = TestUtils.renderIntoDocument(
|
2016-11-14 19:20:15 +01:00
|
|
|
<WrappedMessagePanel className="cls" events={events} readMarkerEventId={events[4].getId()}
|
2017-10-11 18:56:17 +02:00
|
|
|
readMarkerVisible={true} />,
|
2016-03-31 01:48:46 +02:00
|
|
|
);
|
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
const tiles = TestUtils.scryRenderedComponentsWithType(
|
2016-03-31 01:48:46 +02:00
|
|
|
res, sdk.getComponent('rooms.EventTile'));
|
|
|
|
|
|
|
|
// find the <li> which wraps the read marker
|
2017-10-11 18:56:17 +02:00
|
|
|
const rm = TestUtils.findRenderedDOMComponentWithClass(res, 'mx_RoomView_myReadMarker_container');
|
2016-03-31 01:48:46 +02:00
|
|
|
|
|
|
|
// it should follow the <li> which wraps the event tile for event 4
|
2017-10-11 18:56:17 +02:00
|
|
|
const eventContainer = ReactDOM.findDOMNode(tiles[4]).parentNode;
|
2016-03-31 01:48:46 +02:00
|
|
|
expect(rm.previousSibling).toEqual(eventContainer);
|
|
|
|
});
|
|
|
|
|
2019-11-26 20:06:02 +01:00
|
|
|
it('should show the read-marker that fall in summarised events after the summary', function() {
|
|
|
|
const melsEvents = mkMelsEvents();
|
|
|
|
const res = TestUtils.renderIntoDocument(
|
|
|
|
<WrappedMessagePanel className="cls" events={melsEvents} readMarkerEventId={melsEvents[4].getId()}
|
|
|
|
readMarkerVisible={true} />,
|
|
|
|
);
|
|
|
|
|
|
|
|
const summary = TestUtils.findRenderedDOMComponentWithClass(res, 'mx_EventListSummary');
|
|
|
|
|
|
|
|
// find the <li> which wraps the read marker
|
|
|
|
const rm = TestUtils.findRenderedDOMComponentWithClass(res, 'mx_RoomView_myReadMarker_container');
|
|
|
|
|
|
|
|
expect(rm.previousSibling).toEqual(summary);
|
|
|
|
});
|
|
|
|
|
2016-03-31 01:48:46 +02:00
|
|
|
it('shows a ghost read-marker when the read-marker moves', function(done) {
|
|
|
|
// fake the clock so that we can test the velocity animation.
|
|
|
|
clock.install();
|
|
|
|
clock.mockDate();
|
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
const parentDiv = document.createElement('div');
|
2016-03-31 01:48:46 +02:00
|
|
|
|
|
|
|
// first render with the RM in one place
|
2017-10-11 18:56:17 +02:00
|
|
|
let mp = ReactDOM.render(
|
2016-11-14 19:20:15 +01:00
|
|
|
<WrappedMessagePanel className="cls" events={events} readMarkerEventId={events[4].getId()}
|
2016-04-19 22:10:23 +02:00
|
|
|
readMarkerVisible={true}
|
2016-03-31 01:48:46 +02:00
|
|
|
/>, parentDiv);
|
|
|
|
|
2017-10-11 18:56:17 +02:00
|
|
|
const tiles = TestUtils.scryRenderedComponentsWithType(
|
2016-03-31 01:48:46 +02:00
|
|
|
mp, sdk.getComponent('rooms.EventTile'));
|
2017-10-11 18:56:17 +02:00
|
|
|
const tileContainers = tiles.map(function(t) {
|
2016-03-31 18:01:11 +02:00
|
|
|
return ReactDOM.findDOMNode(t).parentNode;
|
|
|
|
});
|
2016-03-31 01:48:46 +02:00
|
|
|
|
|
|
|
// find the <li> which wraps the read marker
|
2017-10-11 18:56:17 +02:00
|
|
|
const rm = TestUtils.findRenderedDOMComponentWithClass(mp, 'mx_RoomView_myReadMarker_container');
|
2016-03-31 18:01:11 +02:00
|
|
|
expect(rm.previousSibling).toEqual(tileContainers[4]);
|
2016-03-31 01:48:46 +02:00
|
|
|
|
|
|
|
// now move the RM
|
|
|
|
mp = ReactDOM.render(
|
2016-11-14 19:20:15 +01:00
|
|
|
<WrappedMessagePanel className="cls" events={events} readMarkerEventId={events[6].getId()}
|
2016-04-19 22:10:23 +02:00
|
|
|
readMarkerVisible={true}
|
2016-03-31 01:48:46 +02:00
|
|
|
/>, parentDiv);
|
|
|
|
|
|
|
|
// now there should be two RM containers
|
2017-10-11 18:56:17 +02:00
|
|
|
const found = TestUtils.scryRenderedDOMComponentsWithClass(mp, 'mx_RoomView_myReadMarker_container');
|
2016-03-31 01:48:46 +02:00
|
|
|
expect(found.length).toEqual(2);
|
2016-04-19 22:10:23 +02:00
|
|
|
|
2016-03-31 01:48:46 +02:00
|
|
|
// the first should be the ghost
|
2016-03-31 18:01:11 +02:00
|
|
|
expect(found[0].previousSibling).toEqual(tileContainers[4]);
|
2017-10-11 18:56:17 +02:00
|
|
|
const hr = found[0].children[0];
|
2016-03-31 01:48:46 +02:00
|
|
|
|
|
|
|
// the second should be the real thing
|
2016-03-31 18:01:11 +02:00
|
|
|
expect(found[1].previousSibling).toEqual(tileContainers[6]);
|
2016-03-31 01:48:46 +02:00
|
|
|
|
|
|
|
// advance the clock, and then let the browser run an animation frame,
|
|
|
|
// to let the animation start
|
|
|
|
clock.tick(1500);
|
2016-04-19 22:10:23 +02:00
|
|
|
|
2016-03-31 01:48:46 +02:00
|
|
|
realSetTimeout(() => {
|
|
|
|
// then advance it again to let it complete
|
|
|
|
clock.tick(1000);
|
|
|
|
realSetTimeout(() => {
|
|
|
|
// the ghost should now have finished
|
2016-03-31 02:01:49 +02:00
|
|
|
expect(hr.style.opacity).toEqual('0');
|
2016-03-31 01:48:46 +02:00
|
|
|
done();
|
|
|
|
}, 100);
|
|
|
|
}, 100);
|
|
|
|
});
|
|
|
|
});
|