- ![]({require("../../../res/img/feather-customised/warning-triangle.svg")} "{_t(\"Warning\")}")
-
-
-
- {this._renderLegal()}
- {this._renderCredits()}
+ {this.renderLegal()}
+ {this.renderCredits()}
- { title }
-
-
- { content }
+ return <>
+
;
+ ;
}
- // return suitable content for the main (text) part of the status bar.
- _getContent() {
+ render() {
if (this._shouldShowConnectionError()) {
return (
-
+
-
+
+
+
+
+
+ { title }
+
+
+ { _t("You can select all or individual messages to retry or delete") }
+
+
+ {buttonRow}
+
-
-
-
- {
+ constructor(props) {
+ super(props);
this.state = {
hover: false,
@@ -1211,14 +1254,13 @@ class E2ePadlock extends React.Component {
render() {
let tooltip = null;
if (this.state.hover) {
- tooltip = {
- constructor() {
- super();
+ constructor(props) {
+ super(props);
this.state = {
hover: false,
@@ -1253,11 +1295,19 @@ class SentReceipt extends React.PureComponent
+ {nonCssBadge}
{tooltip}
;
diff --git a/src/components/views/rooms/MessageComposer.js b/src/components/views/rooms/MessageComposer.tsx
similarity index 80%
rename from src/components/views/rooms/MessageComposer.js
rename to src/components/views/rooms/MessageComposer.tsx
index 5178d52305..3671069903 100644
--- a/src/components/views/rooms/MessageComposer.js
+++ b/src/components/views/rooms/MessageComposer.tsx
@@ -1,5 +1,5 @@
/*
-Copyright 2015-2018, 2020, 2021 The Matrix.org Foundation C.I.C.
+Copyright 2015-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -13,15 +13,18 @@ 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.
*/
-import React, {createRef} from 'react';
+import React from 'react';
import classNames from 'classnames';
-import PropTypes from 'prop-types';
import { _t } from '../../../languageHandler';
import {MatrixClientPeg} from '../../../MatrixClientPeg';
import * as sdk from '../../../index';
+import {MatrixEvent} from "matrix-js-sdk/src/models/event";
+import {Room} from "matrix-js-sdk/src/models/room";
+import {RoomMember} from "matrix-js-sdk/src/models/room-member";
import dis from '../../../dispatcher/dispatcher';
+import { ActionPayload } from "../../../dispatcher/payloads";
import Stickerpicker from './Stickerpicker';
-import { makeRoomPermalink } from '../../../utils/permalinks/Permalinks';
+import { makeRoomPermalink, RoomPermalinkCreator } from '../../../utils/permalinks/Permalinks';
import ContentMessages from '../../../ContentMessages';
import E2EIcon from './E2EIcon';
import SettingsStore from "../../../settings/SettingsStore";
@@ -35,19 +38,26 @@ import VoiceRecordComposerTile from "./VoiceRecordComposerTile";
import {VoiceRecordingStore} from "../../../stores/VoiceRecordingStore";
import {RecordingState} from "../../../voice/VoiceRecording";
import Tooltip, {Alignment} from "../elements/Tooltip";
+import ResizeNotifier from "../../../utils/ResizeNotifier";
+import { E2EStatus } from '../../../utils/ShieldUtils';
+import SendMessageComposer from "./SendMessageComposer";
-function ComposerAvatar(props) {
+interface IComposerAvatarProps {
+ me: object;
+}
+
+function ComposerAvatar(props: IComposerAvatarProps) {
const MemberStatusMessageAvatar = sdk.getComponent('avatars.MemberStatusMessageAvatar');
return
{
const [menuDisplayed, button, openMenu, closeMenu] = useContextMenu();
@@ -68,7 +74,7 @@ const EmojiButton = ({addEmoji}) => {
if (menuDisplayed) {
const buttonRect = button.current.getBoundingClientRect();
const EmojiPicker = sdk.getComponent('emojipicker.EmojiPicker');
- contextMenu =
+ contextMenu =
;
}
@@ -98,39 +104,39 @@ const EmojiButton = ({addEmoji}) => {
;
};
-class UploadButton extends React.Component {
- static propTypes = {
- roomId: PropTypes.string.isRequired,
- }
+interface IUploadButtonProps {
+ roomId: string;
+}
+
+class UploadButton extends React.Component {
+ private uploadInput = React.createRef();
+ private dispatcherRef: string;
constructor(props) {
super(props);
- this.onUploadClick = this.onUploadClick.bind(this);
- this.onUploadFileInputChange = this.onUploadFileInputChange.bind(this);
- this._uploadInput = createRef();
- this._dispatcherRef = dis.register(this.onAction);
+ this.dispatcherRef = dis.register(this.onAction);
}
componentWillUnmount() {
- dis.unregister(this._dispatcherRef);
+ dis.unregister(this.dispatcherRef);
}
- onAction = payload => {
+ private onAction = (payload: ActionPayload) => {
if (payload.action === "upload_file") {
this.onUploadClick();
}
};
- onUploadClick(ev) {
+ private onUploadClick = () => {
if (MatrixClientPeg.get().isGuest()) {
dis.dispatch({action: 'require_registration'});
return;
}
- this._uploadInput.current.click();
+ this.uploadInput.current.click();
}
- onUploadFileInputChange(ev) {
+ private onUploadFileInputChange = (ev: React.ChangeEvent) => {
if (ev.target.files.length === 0) return;
// take a copy so we can safely reset the value of the form control
@@ -160,7 +166,7 @@ class UploadButton extends React.Component {
title={_t('Upload file')}
>
{
+ private dispatcherRef: string;
+ private messageComposerInput: SendMessageComposer;
+ private voiceRecordingButton: VoiceRecordComposerTile;
+
constructor(props) {
super(props);
- this.onInputStateChanged = this.onInputStateChanged.bind(this);
- this._onRoomStateEvents = this._onRoomStateEvents.bind(this);
- this._onTombstoneClick = this._onTombstoneClick.bind(this);
- this.renderPlaceholderText = this.renderPlaceholderText.bind(this);
- VoiceRecordingStore.instance.on(UPDATE_EVENT, this._onVoiceStoreUpdate);
- this._dispatcherRef = null;
+ VoiceRecordingStore.instance.on(UPDATE_EVENT, this.onVoiceStoreUpdate);
this.state = {
- tombstone: this._getRoomTombstone(),
+ tombstone: this.getRoomTombstone(),
canSendMessages: this.props.room.maySendMessage(),
isComposerEmpty: true,
haveRecording: false,
@@ -191,7 +213,13 @@ export default class MessageComposer extends React.Component {
};
}
- onAction = (payload) => {
+ componentDidMount() {
+ this.dispatcherRef = dis.register(this.onAction);
+ MatrixClientPeg.get().on("RoomState.events", this.onRoomStateEvents);
+ this.waitForOwnMember();
+ }
+
+ private onAction = (payload: ActionPayload) => {
if (payload.action === 'reply_to_event') {
// add a timeout for the reply preview to be rendered, so
// that the ScrollPanel listening to the resizeNotifier can
@@ -203,13 +231,7 @@ export default class MessageComposer extends React.Component {
}
};
- componentDidMount() {
- this.dispatcherRef = dis.register(this.onAction);
- MatrixClientPeg.get().on("RoomState.events", this._onRoomStateEvents);
- this._waitForOwnMember();
- }
-
- _waitForOwnMember() {
+ private waitForOwnMember() {
// if we have the member already, do that
const me = this.props.room.getMember(MatrixClientPeg.get().getUserId());
if (me) {
@@ -227,34 +249,28 @@ export default class MessageComposer extends React.Component {
componentWillUnmount() {
if (MatrixClientPeg.get()) {
- MatrixClientPeg.get().removeListener("RoomState.events", this._onRoomStateEvents);
+ MatrixClientPeg.get().removeListener("RoomState.events", this.onRoomStateEvents);
}
- VoiceRecordingStore.instance.off(UPDATE_EVENT, this._onVoiceStoreUpdate);
+ VoiceRecordingStore.instance.off(UPDATE_EVENT, this.onVoiceStoreUpdate);
dis.unregister(this.dispatcherRef);
}
- _onRoomStateEvents(ev, state) {
+ private onRoomStateEvents = (ev, state) => {
if (ev.getRoomId() !== this.props.room.roomId) return;
if (ev.getType() === 'm.room.tombstone') {
- this.setState({tombstone: this._getRoomTombstone()});
+ this.setState({tombstone: this.getRoomTombstone()});
}
if (ev.getType() === 'm.room.power_levels') {
this.setState({canSendMessages: this.props.room.maySendMessage()});
}
}
- _getRoomTombstone() {
+ private getRoomTombstone() {
return this.props.room.currentState.getStateEvents('m.room.tombstone', '');
}
- onInputStateChanged(inputState) {
- // Merge the new input state with old to support partial updates
- inputState = Object.assign({}, this.state.inputState, inputState);
- this.setState({inputState});
- }
-
- _onTombstoneClick(ev) {
+ private onTombstoneClick = (ev) => {
ev.preventDefault();
const replacementRoomId = this.state.tombstone.getContent()['replacement_room'];
@@ -284,7 +300,7 @@ export default class MessageComposer extends React.Component {
});
}
- renderPlaceholderText() {
+ private renderPlaceholderText = () => {
if (this.props.replyToEvent) {
if (this.props.e2eStatus) {
return _t('Send an encrypted reply…');
@@ -307,7 +323,15 @@ export default class MessageComposer extends React.Component {
});
}
- sendMessage = () => {
+ sendMessage = async () => {
+ if (this.state.haveRecording && this.voiceRecordingButton) {
+ // There shouldn't be any text message to send when a voice recording is active, so
+ // just send out the voice recording.
+ await this.voiceRecordingButton.send();
+ return;
+ }
+
+ // XXX: Private function access
this.messageComposerInput._sendMessage();
}
@@ -317,7 +341,7 @@ export default class MessageComposer extends React.Component {
});
}
- _onVoiceStoreUpdate = () => {
+ private onVoiceStoreUpdate = () => {
const recording = VoiceRecordingStore.instance.activeRecording;
this.setState({haveRecording: !!recording});
if (recording) {
@@ -372,6 +396,7 @@ export default class MessageComposer extends React.Component {
if (SettingsStore.getValue("feature_voice_messages")) {
controls.push( this.voiceRecordingButton = c}
room={this.props.room} />);
}
@@ -386,7 +411,7 @@ export default class MessageComposer extends React.Component {
const continuesLink = replacementRoomId ? (
{_t("The conversation continues here.")}
@@ -394,7 +419,9 @@ export default class MessageComposer extends React.Component {
controls.push(
{_t("Invite people")}
}
-
{_t("Explore rooms")}
-
+ }
;
} else if (Object.values(this.state.sublists).some(list => list.length > 0)) {
const unfilteredLists = RoomListStore.instance.unfilteredLists
diff --git a/src/components/views/rooms/RoomSublist.tsx b/src/components/views/rooms/RoomSublist.tsx
index a726ab99fc..fb367349a2 100644
--- a/src/components/views/rooms/RoomSublist.tsx
+++ b/src/components/views/rooms/RoomSublist.tsx
@@ -763,7 +763,9 @@ export default class RoomSublist extends React.Component {
'mx_RoomSublist': true,
'mx_RoomSublist_hasMenuOpen': !!this.state.contextMenuPosition,
'mx_RoomSublist_minimized': this.props.isMinimized,
- 'mx_RoomSublist_hidden': !this.state.rooms.length && this.props.alwaysVisible !== true,
+ 'mx_RoomSublist_hidden': (
+ !this.state.rooms.length && !this.props.extraTiles?.length && this.props.alwaysVisible !== true
+ ),
});
let content = null;
diff --git a/src/components/views/rooms/RoomTile.tsx b/src/components/views/rooms/RoomTile.tsx
index b2a07d7e06..8521992fa1 100644
--- a/src/components/views/rooms/RoomTile.tsx
+++ b/src/components/views/rooms/RoomTile.tsx
@@ -1,8 +1,6 @@
/*
-Copyright 2015, 2016 OpenMarket Ltd
-Copyright 2017 New Vector Ltd
Copyright 2018 Michael Telatynski <7t3chguy@gmail.com>
-Copyright 2019, 2020 The Matrix.org Foundation C.I.C.
+Copyright 2015-2017, 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -19,6 +17,7 @@ limitations under the License.
import React, { createRef } from "react";
import { Room } from "matrix-js-sdk/src/models/room";
+import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import classNames from "classnames";
import { RovingTabIndexWrapper } from "../../../accessibility/RovingTabIndex";
import AccessibleButton, { ButtonEvent } from "../../views/elements/AccessibleButton";
@@ -51,7 +50,9 @@ import IconizedContextMenu, {
IconizedContextMenuRadio,
} from "../context_menus/IconizedContextMenu";
import { CommunityPrototypeStore, IRoomProfile } from "../../../stores/CommunityPrototypeStore";
-import {replaceableComponent} from "../../../utils/replaceableComponent";
+import { replaceableComponent } from "../../../utils/replaceableComponent";
+import { getUnsentMessages } from "../../structures/RoomStatusBar";
+import { StaticNotificationState } from "../../../stores/notifications/StaticNotificationState";
interface IProps {
room: Room;
@@ -67,6 +68,7 @@ interface IState {
notificationsMenuPosition: PartialDOMRect;
generalMenuPosition: PartialDOMRect;
messagePreview?: string;
+ hasUnsentEvents: boolean;
}
const messagePreviewId = (roomId: string) => `mx_RoomTile_messagePreview_${roomId}`;
@@ -93,6 +95,7 @@ export default class RoomTile extends React.PureComponent {
selected: ActiveRoomObserver.activeRoomId === this.props.room.roomId,
notificationsMenuPosition: null,
generalMenuPosition: null,
+ hasUnsentEvents: this.countUnsentEvents() > 0,
// generatePreview() will return nothing if the user has previews disabled
messagePreview: this.generatePreview(),
@@ -101,6 +104,10 @@ export default class RoomTile extends React.PureComponent {
this.roomProps = EchoChamber.forRoom(this.props.room);
}
+ private countUnsentEvents(): number {
+ return getUnsentMessages(this.props.room).length;
+ }
+
private onRoomNameUpdate = (room) => {
this.forceUpdate();
}
@@ -109,6 +116,11 @@ export default class RoomTile extends React.PureComponent {
this.forceUpdate(); // notification state changed - update
};
+ private onLocalEchoUpdated = (ev: MatrixEvent, room: Room) => {
+ if (!room?.roomId === this.props.room.roomId) return;
+ this.setState({hasUnsentEvents: this.countUnsentEvents() > 0});
+ };
+
private onRoomPropertyUpdate = (property: CachedRoomKey) => {
if (property === CachedRoomKey.NotificationVolume) this.onNotificationUpdate();
// else ignore - not important for this tile
@@ -167,6 +179,7 @@ export default class RoomTile extends React.PureComponent {
CommunityPrototypeStore.getUpdateEventName(this.props.room.roomId),
this.onCommunityUpdate,
);
+ MatrixClientPeg.get().on("Room.localEchoUpdated", this.onLocalEchoUpdated);
}
public componentWillUnmount() {
@@ -191,6 +204,7 @@ export default class RoomTile extends React.PureComponent {
CommunityPrototypeStore.getUpdateEventName(this.props.room.roomId),
this.onCommunityUpdate,
);
+ MatrixClientPeg.get()?.removeListener("Room.localEchoUpdated", this.onLocalEchoUpdated);
}
private onAction = (payload: ActionPayload) => {
@@ -554,17 +568,30 @@ export default class RoomTile extends React.PureComponent {
/>;
let badge: React.ReactNode;
- if (!this.props.isMinimized && this.notificationState) {
+ if (!this.props.isMinimized) {
// aria-hidden because we summarise the unread count/highlight status in a manual aria-label below
- badge = (
-
- );
+ if (this.state.hasUnsentEvents) {
+ // hardcode the badge to a danger state when there's unsent messages
+ badge = (
+
+ );
+ } else if (this.notificationState) {
+ badge = (
+
+ );
+ }
}
let messagePreview = null;
diff --git a/src/components/views/rooms/SendMessageComposer.js b/src/components/views/rooms/SendMessageComposer.js
index 0d3a174766..d60eba00ec 100644
--- a/src/components/views/rooms/SendMessageComposer.js
+++ b/src/components/views/rooms/SendMessageComposer.js
@@ -506,9 +506,8 @@ export default class SendMessageComposer extends React.Component {
member.rawDisplayName : userId;
const caret = this._editorRef.getCaret();
const position = model.positionForOffset(caret.offset, caret.atNodeEnd);
- // index is -1 if there are no parts but we only care for if this would be the part in position 0
- const insertIndex = position.index > 0 ? position.index : 0;
- const parts = partCreator.createMentionParts(insertIndex, displayName, userId);
+ // Insert suffix only if the caret is at the start of the composer
+ const parts = partCreator.createMentionParts(caret.offset === 0, displayName, userId);
model.transform(() => {
const addedLen = model.insert(parts, position);
return model.positionForOffset(caret.offset + addedLen, true);
diff --git a/src/components/views/rooms/ThirdPartyMemberInfo.js b/src/components/views/rooms/ThirdPartyMemberInfo.tsx
similarity index 94%
rename from src/components/views/rooms/ThirdPartyMemberInfo.js
rename to src/components/views/rooms/ThirdPartyMemberInfo.tsx
index 67b86538c9..78fdc8b404 100644
--- a/src/components/views/rooms/ThirdPartyMemberInfo.js
+++ b/src/components/views/rooms/ThirdPartyMemberInfo.tsx
@@ -1,5 +1,5 @@
/*
-Copyright 2019 New Vector Ltd.
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,9 +15,9 @@ limitations under the License.
*/
import React from 'react';
-import PropTypes from 'prop-types';
import {MatrixClientPeg} from "../../../MatrixClientPeg";
import {MatrixEvent} from "matrix-js-sdk/src/models/event";
+import {Room} from "matrix-js-sdk/src/models/room";
import {_t} from "../../../languageHandler";
import dis from "../../../dispatcher/dispatcher";
import * as sdk from "../../../index";
@@ -27,11 +27,22 @@ import RoomAvatar from "../avatars/RoomAvatar";
import RoomName from "../elements/RoomName";
import {replaceableComponent} from "../../../utils/replaceableComponent";
+interface IProps {
+ event: MatrixEvent;
+}
+
+interface IState {
+ stateKey: string;
+ roomId: string;
+ displayName: string;
+ invited: boolean;
+ canKick: boolean;
+ senderName: string;
+}
+
@replaceableComponent("views.rooms.ThirdPartyMemberInfo")
-export default class ThirdPartyMemberInfo extends React.Component {
- static propTypes = {
- event: PropTypes.instanceOf(MatrixEvent).isRequired,
- };
+export default class ThirdPartyMemberInfo extends React.Component {
+ private room: Room;
constructor(props) {
super(props);
diff --git a/src/components/views/rooms/VoiceRecordComposerTile.tsx b/src/components/views/rooms/VoiceRecordComposerTile.tsx
index 1210a44958..bab95291ba 100644
--- a/src/components/views/rooms/VoiceRecordComposerTile.tsx
+++ b/src/components/views/rooms/VoiceRecordComposerTile.tsx
@@ -16,8 +16,8 @@ limitations under the License.
import AccessibleTooltipButton from "../elements/AccessibleTooltipButton";
import {_t} from "../../../languageHandler";
-import React from "react";
-import {VoiceRecording} from "../../../voice/VoiceRecording";
+import React, {ReactNode} from "react";
+import {RecordingState, VoiceRecording} from "../../../voice/VoiceRecording";
import {Room} from "matrix-js-sdk/src/models/room";
import {MatrixClientPeg} from "../../../MatrixClientPeg";
import classNames from "classnames";
@@ -25,6 +25,8 @@ import LiveRecordingWaveform from "../voice_messages/LiveRecordingWaveform";
import {replaceableComponent} from "../../../utils/replaceableComponent";
import LiveRecordingClock from "../voice_messages/LiveRecordingClock";
import {VoiceRecordingStore} from "../../../stores/VoiceRecordingStore";
+import {UPDATE_EVENT} from "../../../stores/AsyncStore";
+import RecordingPlayback from "../voice_messages/RecordingPlayback";
interface IProps {
room: Room;
@@ -32,6 +34,7 @@ interface IProps {
interface IState {
recorder?: VoiceRecording;
+ recordingPhase?: RecordingState;
}
/**
@@ -43,58 +46,141 @@ export default class VoiceRecordComposerTile extends React.PureComponent {
- // TODO: @@ TravisR: We do not want to auto-send on stop.
+ public async componentWillUnmount() {
+ await VoiceRecordingStore.instance.disposeRecording();
+ }
+
+ // called by composer
+ public async send() {
+ if (!this.state.recorder) {
+ throw new Error("No recording started - cannot send anything");
+ }
+
+ await this.state.recorder.stop();
+ const mxc = await this.state.recorder.upload();
+ MatrixClientPeg.get().sendMessage(this.props.room.roomId, {
+ "body": "Voice message",
+ "msgtype": "org.matrix.msc2516.voice",
+ //"msgtype": MsgType.Audio,
+ "url": mxc,
+ "info": {
+ duration: Math.round(this.state.recorder.durationSeconds * 1000),
+ mimetype: this.state.recorder.contentType,
+ size: this.state.recorder.contentLength,
+ },
+
+ // MSC1767 experiment
+ "org.matrix.msc1767.text": "Voice message",
+ "org.matrix.msc1767.file": {
+ url: mxc,
+ name: "Voice message.ogg",
+ mimetype: this.state.recorder.contentType,
+ size: this.state.recorder.contentLength,
+ },
+ "org.matrix.msc1767.audio": {
+ duration: Math.round(this.state.recorder.durationSeconds * 1000),
+ // TODO: @@ TravisR: Waveform? (MSC1767 decision)
+ },
+ "org.matrix.experimental.msc2516.voice": { // MSC2516+MSC1767 experiment
+ duration: Math.round(this.state.recorder.durationSeconds * 1000),
+
+ // Events can't have floats, so we try to maintain resolution by using 1024
+ // as a maximum value. The waveform contains values between zero and 1, so this
+ // should come out largely sane.
+ //
+ // We're expecting about one data point per second of audio.
+ waveform: this.state.recorder.getPlayback().waveform.map(v => Math.round(v * 1024)),
+ },
+ });
+ await this.disposeRecording();
+ }
+
+ private async disposeRecording() {
+ await VoiceRecordingStore.instance.disposeRecording();
+
+ // Reset back to no recording, which means no phase (ie: restart component entirely)
+ this.setState({recorder: null, recordingPhase: null});
+ }
+
+ private onCancel = async () => {
+ await this.disposeRecording();
+ };
+
+ private onRecordStartEndClick = async () => {
if (this.state.recorder) {
await this.state.recorder.stop();
- const mxc = await this.state.recorder.upload();
- MatrixClientPeg.get().sendMessage(this.props.room.roomId, {
- body: "Voice message",
- msgtype: "org.matrix.msc2516.voice",
- url: mxc,
- });
- await VoiceRecordingStore.instance.disposeRecording();
- this.setState({recorder: null});
return;
}
const recorder = VoiceRecordingStore.instance.startRecording();
await recorder.start();
- this.setState({recorder});
+
+ // We don't need to remove the listener: the recorder will clean that up for us.
+ recorder.on(UPDATE_EVENT, (ev: RecordingState) => {
+ if (ev === RecordingState.EndingSoon) return; // ignore this state: it has no UI purpose here
+ this.setState({recordingPhase: ev});
+ });
+
+ this.setState({recorder, recordingPhase: RecordingState.Started});
};
- private renderWaveformArea() {
- if (!this.state.recorder) return null;
+ private renderWaveformArea(): ReactNode {
+ if (!this.state.recorder) return null; // no recorder means we're not recording: no waveform
- return
{_t("Who can access this room?")}
{
+ constructor(props) {
+ super(props);
this.state = {
appVersion: null,
@@ -53,7 +56,7 @@ export default class HelpUserSettingsTab extends React.Component {
});
}
- _onClearCacheAndReload = (e) => {
+ private onClearCacheAndReload = (e) => {
if (!PlatformPeg.get()) return;
// Dev note: please keep this log line, it's useful when troubleshooting a MatrixClient suddenly
@@ -65,7 +68,7 @@ export default class HelpUserSettingsTab extends React.Component {
});
};
- _onBugReport = (e) => {
+ private onBugReport = (e) => {
const BugReportDialog = sdk.getComponent("dialogs.BugReportDialog");
if (!BugReportDialog) {
return;
@@ -73,7 +76,7 @@ export default class HelpUserSettingsTab extends React.Component {
Modal.createTrackedDialog('Bug Report Dialog', '', BugReportDialog, {});
};
- _onStartBotChat = (e) => {
+ private onStartBotChat = (e) => {
this.props.closeSettingsFn();
createRoom({
dmUserId: SdkConfig.get().welcomeUserId,
@@ -81,7 +84,7 @@ export default class HelpUserSettingsTab extends React.Component {
});
};
- _showSpoiler = (event) => {
+ private showSpoiler = (event) => {
const target = event.target;
target.innerHTML = target.getAttribute('data-spoiler');
@@ -93,7 +96,7 @@ export default class HelpUserSettingsTab extends React.Component {
selection.addRange(range);
};
- _renderLegal() {
+ private renderLegal() {
const tocLinks = SdkConfig.get().terms_and_conditions_links;
if (!tocLinks) return null;
@@ -114,7 +117,7 @@ export default class HelpUserSettingsTab extends React.Component {
);
}
- _renderCredits() {
+ private renderCredits() {
// Note: This is not translated because it is legal text.
// Also, is ugly but necessary.
return (
@@ -122,28 +125,28 @@ export default class HelpUserSettingsTab extends React.Component {
{_t("Credits")}
@@ -188,7 +191,7 @@ export default class HelpUserSettingsTab extends React.Component {
},
)}
- { _t('Connectivity to the server has been lost.') }
-
-
- { _t('Sent messages will be stored until your connection has returned.') }
+ = ({
let url: string;
if (room.avatar_url) {
- url = mediaFromMxc(room.avatar_url).getSquareThumbnailHttp(Math.floor(20 * window.devicePixelRatio));
+ url = mediaFromMxc(room.avatar_url).getSquareThumbnailHttp(20);
}
let description = _t("%(count)s members", { count: room.num_joined_members });
@@ -312,11 +312,12 @@ export const HierarchyLevel = ({
// mutate argument refreshToken to force a reload
export const useSpaceSummary = (cli: MatrixClient, space: Room, refreshToken?: any): [
+ null,
ISpaceSummaryRoom[],
- Map>,
- Map>,
- Map>,
-] | [] => {
+ Map>?,
+ Map>?,
+ Map>?,
+] | [Error] => {
// TODO pagination
return useAsyncMemo(async () => {
try {
@@ -336,13 +337,12 @@ export const useSpaceSummary = (cli: MatrixClient, space: Room, refreshToken?: a
}
});
- return [data.rooms as ISpaceSummaryRoom[], parentChildRelations, viaMap, childParentRelations];
+ return [null, data.rooms as ISpaceSummaryRoom[], parentChildRelations, viaMap, childParentRelations];
} catch (e) {
console.error(e); // TODO
+ return [e];
}
-
- return [];
- }, [space, refreshToken], []);
+ }, [space, refreshToken], [undefined]);
};
export const SpaceHierarchy: React.FC = ({
@@ -358,7 +358,7 @@ export const SpaceHierarchy: React.FC = ({
const [selected, setSelected] = useState(new Map>()); // Map>
- const [rooms, parentChildMap, viaMap, childParentMap] = useSpaceSummary(cli, space, refreshToken);
+ const [summaryError, rooms, parentChildMap, viaMap, childParentMap] = useSpaceSummary(cli, space, refreshToken);
const roomsMap = useMemo(() => {
if (!rooms) return null;
@@ -397,6 +397,10 @@ export const SpaceHierarchy: React.FC = ({
const [removing, setRemoving] = useState(false);
const [saving, setSaving] = useState(false);
+ if (summaryError) {
+ return = ({
{ children }
;
- } else if (!rooms) {
- content = {
+ constructor(props) {
+ super(props);
this.state = {
loginView: LOGIN_VIEW.LOADING,
keyBackupNeeded: true, // assume we do while we figure it out (see componentDidMount)
-
busy: false,
password: "",
errorText: "",
+ flows: [],
};
}
@@ -72,7 +83,7 @@ export default class SoftLogout extends React.Component {
return;
}
- this._initLogin();
+ this.initLogin();
const cli = MatrixClientPeg.get();
if (cli.isCryptoEnabled()) {
@@ -94,7 +105,7 @@ export default class SoftLogout extends React.Component {
});
};
- async _initLogin() {
+ private async initLogin() {
const queryParams = this.props.realQueryParams;
const hasAllParams = queryParams && queryParams['loginToken'];
if (hasAllParams) {
@@ -189,7 +200,7 @@ export default class SoftLogout extends React.Component {
});
}
- _renderSignInSection() {
+ private renderSignInSection() {
if (this.state.loginView === LOGIN_VIEW.LOADING) {
const Spinner = sdk.getComponent("elements.Spinner");
return
);
@@ -1091,7 +1125,7 @@ export default class EventTile extends React.Component {
this.props.mxEvent,
this.props.onHeightChanged,
this.props.permalinkCreator,
- this._replyThread,
+ this.replyThread,
this.props.layout,
);
@@ -1105,15 +1139,16 @@ export default class EventTile extends React.Component {
{ groupTimestamp }
{ groupPadlock }
{ thread }
-
+
);
}
- if (this.state.unsentMessages.length > 0) {
+ if (this.state.unsentMessages.length > 0 || this.state.isResending) {
return this._getUnsentMessageContent();
}
return null;
}
-
- render() {
- const content = this._getContent();
-
- return (
-
+
+
+
+
+
+ {_t('Connectivity to the server has been lost.')}
+
+
+ {_t('Sent messages will be stored until your connection has returned.')}
+
+
-
- );
- }
}
diff --git a/src/components/structures/ScrollPanel.js b/src/components/structures/ScrollPanel.js
index 976734680c..a014a6e4fe 100644
--- a/src/components/structures/ScrollPanel.js
+++ b/src/components/structures/ScrollPanel.js
@@ -525,7 +525,7 @@ export default class ScrollPanel extends React.Component {
*/
scrollRelative = mult => {
const scrollNode = this._getScrollNode();
- const delta = mult * scrollNode.clientHeight * 0.5;
+ const delta = mult * scrollNode.clientHeight * 0.9;
scrollNode.scrollBy(0, delta);
this._saveScrollState();
};
diff --git a/src/components/structures/SpaceRoomDirectory.tsx b/src/components/structures/SpaceRoomDirectory.tsx
index 930cfa15a9..8d6c9f0a70 100644
--- a/src/components/structures/SpaceRoomDirectory.tsx
+++ b/src/components/structures/SpaceRoomDirectory.tsx
@@ -136,7 +136,7 @@ const Tile: React.FC
- { content }
-
- {_t("Your server does not support showing space hierarchies.")}
; + } + let content; if (roomsMap) { const numRooms = Array.from(roomsMap.values()).filter(r => r.room_type !== RoomType.Space).length; @@ -538,10 +542,8 @@ export const SpaceHierarchy: React.FC{_t("Your server does not support showing space hierarchies.")}
; + content =
@@ -289,7 +300,7 @@ export default class SoftLogout extends React.Component {
{
let imageUrl = null;
if (props.member.getMxcAvatarUrl()) {
imageUrl = mediaFromMxc(props.member.getMxcAvatarUrl()).getThumbnailOfSourceHttp(
- Math.floor(props.width * window.devicePixelRatio),
- Math.floor(props.height * window.devicePixelRatio),
+ props.width,
+ props.height,
props.resizeMethod,
);
}
diff --git a/src/components/views/avatars/RoomAvatar.tsx b/src/components/views/avatars/RoomAvatar.tsx
index ad0eb45a52..4693d907ba 100644
--- a/src/components/views/avatars/RoomAvatar.tsx
+++ b/src/components/views/avatars/RoomAvatar.tsx
@@ -93,8 +93,8 @@ export default class RoomAvatar extends React.Component {
let oobAvatar = null;
if (props.oobData.avatarUrl) {
oobAvatar = mediaFromMxc(props.oobData.avatarUrl).getThumbnailOfSourceHttp(
- Math.floor(props.width * window.devicePixelRatio),
- Math.floor(props.height * window.devicePixelRatio),
+ props.width,
+ props.height,
props.resizeMethod,
);
}
@@ -109,12 +109,7 @@ export default class RoomAvatar extends React.Component {
private static getRoomAvatarUrl(props: IProps): string {
if (!props.room) return null;
- return Avatar.avatarUrlForRoom(
- props.room,
- Math.floor(props.width * window.devicePixelRatio),
- Math.floor(props.height * window.devicePixelRatio),
- props.resizeMethod,
- );
+ return Avatar.avatarUrlForRoom(props.room, props.width, props.height, props.resizeMethod);
}
private onRoomAvatarClick = () => {
diff --git a/src/components/views/context_menus/MessageContextMenu.js b/src/components/views/context_menus/MessageContextMenu.js
index f86cd26f32..142b8c80a8 100644
--- a/src/components/views/context_menus/MessageContextMenu.js
+++ b/src/components/views/context_menus/MessageContextMenu.js
@@ -1,8 +1,6 @@
/*
-Copyright 2015, 2016 OpenMarket Ltd
-Copyright 2018 New Vector Ltd
Copyright 2019 Michael Telatynski <7t3chguy@gmail.com>
-Copyright 2019 The Matrix.org Foundation C.I.C.
+Copyright 2015, 2016, 2018, 2019, 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -34,7 +32,7 @@ import {MenuItem} from "../../structures/ContextMenu";
import {EventType} from "matrix-js-sdk/src/@types/event";
import {replaceableComponent} from "../../../utils/replaceableComponent";
-function canCancel(eventStatus) {
+export function canCancel(eventStatus) {
return eventStatus === EventStatus.QUEUED || eventStatus === EventStatus.NOT_SENT;
}
@@ -98,21 +96,6 @@ export default class MessageContextMenu extends React.Component {
return content.pinned && Array.isArray(content.pinned) && content.pinned.includes(this.props.mxEvent.getId());
}
- onResendClick = () => {
- Resend.resend(this.props.mxEvent);
- this.closeMenu();
- };
-
- onResendEditClick = () => {
- Resend.resend(this.props.mxEvent.replacingEvent());
- this.closeMenu();
- };
-
- onResendRedactionClick = () => {
- Resend.resend(this.props.mxEvent.localRedactionEvent());
- this.closeMenu();
- };
-
onResendReactionsClick = () => {
for (const reaction of this._getUnsentReactions()) {
Resend.resend(reaction);
@@ -170,29 +153,6 @@ export default class MessageContextMenu extends React.Component {
this.closeMenu();
};
- onCancelSendClick = () => {
- const mxEvent = this.props.mxEvent;
- const editEvent = mxEvent.replacingEvent();
- const redactEvent = mxEvent.localRedactionEvent();
- const pendingReactions = this._getPendingReactions();
-
- if (editEvent && canCancel(editEvent.status)) {
- Resend.removeFromQueue(editEvent);
- }
- if (redactEvent && canCancel(redactEvent.status)) {
- Resend.removeFromQueue(redactEvent);
- }
- if (pendingReactions.length) {
- for (const reaction of pendingReactions) {
- Resend.removeFromQueue(reaction);
- }
- }
- if (canCancel(mxEvent.status)) {
- Resend.removeFromQueue(this.props.mxEvent);
- }
- this.closeMenu();
- };
-
onForwardClick = () => {
if (this.props.onCloseDialog) this.props.onCloseDialog();
dis.dispatch({
@@ -285,20 +245,9 @@ export default class MessageContextMenu extends React.Component {
const me = cli.getUserId();
const mxEvent = this.props.mxEvent;
const eventStatus = mxEvent.status;
- const editStatus = mxEvent.replacingEvent() && mxEvent.replacingEvent().status;
- const redactStatus = mxEvent.localRedactionEvent() && mxEvent.localRedactionEvent().status;
const unsentReactionsCount = this._getUnsentReactions().length;
- const pendingReactionsCount = this._getPendingReactions().length;
- const allowCancel = canCancel(mxEvent.status) ||
- canCancel(editStatus) ||
- canCancel(redactStatus) ||
- pendingReactionsCount !== 0;
- let resendButton;
- let resendEditButton;
let resendReactionsButton;
- let resendRedactionButton;
let redactButton;
- let cancelButton;
let forwardButton;
let pinButton;
let unhidePreviewButton;
@@ -309,22 +258,6 @@ export default class MessageContextMenu extends React.Component {
// status is SENT before remote-echo, null after
const isSent = !eventStatus || eventStatus === EventStatus.SENT;
if (!mxEvent.isRedacted()) {
- if (eventStatus === EventStatus.NOT_SENT) {
- resendButton = (
-
- );
- }
-
- if (editStatus === EventStatus.NOT_SENT) {
- resendEditButton = (
-
- );
- }
-
if (unsentReactionsCount !== 0) {
resendReactionsButton = (
- {_t("Sign in")}
- {this._renderSignInSection()}
+ {this.renderSignInSection()}
{_t("Clear personal data")}
diff --git a/src/components/views/avatars/MemberAvatar.tsx b/src/components/views/avatars/MemberAvatar.tsx index c79cbc0d32..3205ca372c 100644 --- a/src/components/views/avatars/MemberAvatar.tsx +++ b/src/components/views/avatars/MemberAvatar.tsx @@ -68,8 +68,8 @@ export default class MemberAvatar extends React.Component
+
;
}
- let serverName = serverConfig.isNameResolvable ? serverConfig.hsName : serverConfig.hsUrl;
+ let serverName: React.ReactNode = serverConfig.isNameResolvable ? serverConfig.hsName : serverConfig.hsUrl;
if (serverConfig.hsNameIsDifferent) {
serverName =
{serverConfig.hsName}
diff --git a/src/components/views/elements/TextWithTooltip.js b/src/components/views/elements/TextWithTooltip.js
index 0bd491768c..a6fc00fc2e 100644
--- a/src/components/views/elements/TextWithTooltip.js
+++ b/src/components/views/elements/TextWithTooltip.js
@@ -25,6 +25,7 @@ export default class TextWithTooltip extends React.Component {
class: PropTypes.string,
tooltipClass: PropTypes.string,
tooltip: PropTypes.node.isRequired,
+ tooltipProps: PropTypes.object,
};
constructor() {
@@ -46,15 +47,17 @@ export default class TextWithTooltip extends React.Component {
render() {
const Tooltip = sdk.getComponent("elements.Tooltip");
- const {class: className, children, tooltip, tooltipClass, ...props} = this.props;
+ const {class: className, children, tooltip, tooltipClass, tooltipProps, ...props} = this.props;
return (
{children}
{this.state.hover &&
diff --git a/src/components/views/messages/MImageBody.js b/src/components/views/messages/MImageBody.js
index 5af2063c84..07a12d70a8 100644
--- a/src/components/views/messages/MImageBody.js
+++ b/src/components/views/messages/MImageBody.js
@@ -185,9 +185,8 @@ export default class MImageBody extends React.Component {
// So either we need to support custom timeline widths here, or reimpose the cap, otherwise the
// thumbnail resolution will be unnecessarily reduced.
// custom timeline widths seems preferable.
- const pixelRatio = window.devicePixelRatio;
- const thumbWidth = Math.round(800 * pixelRatio);
- const thumbHeight = Math.round(600 * pixelRatio);
+ const thumbWidth = 800;
+ const thumbHeight = 600;
const content = this.props.mxEvent.getContent();
const media = mediaFromContent(content);
@@ -218,7 +217,7 @@ export default class MImageBody extends React.Component {
const info = content.info;
if (
this._isGif() ||
- pixelRatio === 1.0 ||
+ window.devicePixelRatio === 1.0 ||
(!info || !info.w || !info.h || !info.size)
) {
return media.getThumbnailOfSourceHttp(thumbWidth, thumbHeight);
diff --git a/src/components/views/messages/MessageActionBar.js b/src/components/views/messages/MessageActionBar.js
index 5a6e7d87b7..b2f7f8a692 100644
--- a/src/components/views/messages/MessageActionBar.js
+++ b/src/components/views/messages/MessageActionBar.js
@@ -29,6 +29,8 @@ import RoomContext from "../../../contexts/RoomContext";
import Toolbar from "../../../accessibility/Toolbar";
import {RovingAccessibleTooltipButton, useRovingTabIndex} from "../../../accessibility/RovingTabIndex";
import {replaceableComponent} from "../../../utils/replaceableComponent";
+import {canCancel} from "../context_menus/MessageContextMenu";
+import Resend from "../../../Resend";
const OptionsButton = ({mxEvent, getTile, getReplyThread, permalinkCreator, onFocusChange}) => {
const [menuDisplayed, button, openMenu, closeMenu] = useContextMenu();
@@ -169,45 +171,118 @@ export default class MessageActionBar extends React.PureComponent {
});
};
- render() {
- let reactButton;
- let replyButton;
- let editButton;
+ /**
+ * Runs a given fn on the set of possible events to test. The first event
+ * that passes the checkFn will have fn executed on it. Both functions take
+ * a MatrixEvent object. If no particular conditions are needed, checkFn can
+ * be null/undefined. If no functions pass the checkFn, no action will be
+ * taken.
+ * @param {Function} fn The execution function.
+ * @param {Function} checkFn The test function.
+ */
+ runActionOnFailedEv(fn, checkFn) {
+ if (!checkFn) checkFn = () => true;
- if (isContentActionable(this.props.mxEvent)) {
- if (this.context.canReact) {
- reactButton = (
-
- {reactButton}
- {replyButton}
- {editButton}
-
+ {toolbarOpts}
;
}
}
diff --git a/src/components/views/rooms/EventTile.js b/src/components/views/rooms/EventTile.tsx
similarity index 79%
rename from src/components/views/rooms/EventTile.js
rename to src/components/views/rooms/EventTile.tsx
index f6fb83c064..19c5a7acaa 100644
--- a/src/components/views/rooms/EventTile.js
+++ b/src/components/views/rooms/EventTile.tsx
@@ -1,6 +1,6 @@
/*
+Copyright 2015-2021 The Matrix.org Foundation C.I.C.
Copyright 2019 Michael Telatynski <7t3chguy@gmail.com>
-Copyright 2019 - 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,11 +15,13 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import React, {createRef} from 'react';
-import PropTypes from 'prop-types';
+import React from 'react';
import classNames from "classnames";
-import {EventType} from "matrix-js-sdk/src/@types/event";
-import {EventStatus} from 'matrix-js-sdk/src/models/event';
+
+import { EventType } from "matrix-js-sdk/src/@types/event";
+import { EventStatus, MatrixEvent } from "matrix-js-sdk/src/models/event";
+import { Relations } from "matrix-js-sdk/src/models/relations";
+import { RoomMember } from "matrix-js-sdk/src/models/room-member";
import ReplyThread from "../elements/ReplyThread";
import { _t } from '../../../languageHandler';
@@ -27,7 +29,7 @@ import * as TextForEvent from "../../../TextForEvent";
import * as sdk from "../../../index";
import dis from '../../../dispatcher/dispatcher';
import SettingsStore from "../../../settings/SettingsStore";
-import {Layout, LayoutPropType} from "../../../settings/Layout";
+import {Layout} from "../../../settings/Layout";
import {formatTime} from "../../../DateUtils";
import {MatrixClientPeg} from '../../../MatrixClientPeg';
import {ALL_RULE_TYPES} from "../../../mjolnir/BanList";
@@ -40,6 +42,10 @@ import {WIDGET_LAYOUT_EVENT_TYPE} from "../../../stores/widgets/WidgetLayoutStor
import {objectHasDiff} from "../../../utils/objects";
import {replaceableComponent} from "../../../utils/replaceableComponent";
import Tooltip from "../elements/Tooltip";
+import { EditorStateTransfer } from "../../../utils/EditorStateTransfer";
+import { RoomPermalinkCreator } from '../../../utils/permalinks/Permalinks';
+import {StaticNotificationState} from "../../../stores/notifications/StaticNotificationState";
+import NotificationBadge from "./NotificationBadge";
const eventTileTypes = {
[EventType.RoomMessage]: 'messages.MessageEvent',
@@ -169,101 +175,130 @@ const MAX_READ_AVATARS = 5;
// | '--------------------------------------' |
// '----------------------------------------------------------'
+interface IReadReceiptProps {
+ userId: string;
+ roomMember: RoomMember;
+ ts: number;
+}
+
+interface IProps {
+ // the MatrixEvent to show
+ mxEvent: MatrixEvent;
+
+ // true if mxEvent is redacted. This is a prop because using mxEvent.isRedacted()
+ // might not be enough when deciding shouldComponentUpdate - prevProps.mxEvent
+ // references the same this.props.mxEvent.
+ isRedacted?: boolean;
+
+ // true if this is a continuation of the previous event (which has the
+ // effect of not showing another avatar/displayname
+ continuation?: boolean;
+
+ // true if this is the last event in the timeline (which has the effect
+ // of always showing the timestamp)
+ last?: boolean;
+
+ // true if the event is the last event in a section (adds a css class for
+ // targeting)
+ lastInSection?: boolean;
+
+ // True if the event is the last successful (sent) event.
+ lastSuccessful?: boolean;
+
+ // true if this is search context (which has the effect of greying out
+ // the text
+ contextual?: boolean;
+
+ // a list of words to highlight, ordered by longest first
+ highlights?: string[];
+
+ // link URL for the highlights
+ highlightLink?: string;
+
+ // should show URL previews for this event
+ showUrlPreview?: boolean;
+
+ // is this the focused event
+ isSelectedEvent?: boolean;
+
+ // callback called when dynamic content in events are loaded
+ onHeightChanged?: () => void;
+
+ // a list of read-receipts we should show. Each object has a 'roomMember' and 'ts'.
+ readReceipts?: IReadReceiptProps[];
+
+ // opaque readreceipt info for each userId; used by ReadReceiptMarker
+ // to manage its animations. Should be an empty object when the room
+ // first loads
+ readReceiptMap?: any;
+
+ // A function which is used to check if the parent panel is being
+ // unmounted, to avoid unnecessary work. Should return true if we
+ // are being unmounted.
+ checkUnmounting?: () => boolean;
+
+ // the status of this event - ie, mxEvent.status. Denormalised to here so
+ // that we can tell when it changes.
+ eventSendStatus?: string;
+
+ // the shape of the tile. by default, the layout is intended for the
+ // normal room timeline. alternative values are: "file_list", "file_grid"
+ // and "notif". This could be done by CSS, but it'd be horribly inefficient.
+ // It could also be done by subclassing EventTile, but that'd be quite
+ // boiilerplatey. So just make the necessary render decisions conditional
+ // for now.
+ tileShape?: 'notif' | 'file_grid' | 'reply' | 'reply_preview';
+
+ // show twelve hour timestamps
+ isTwelveHour?: boolean;
+
+ // helper function to access relations for this event
+ getRelationsForEvent?: (eventId: string, relationType: string, eventType: string) => Relations;
+
+ // whether to show reactions for this event
+ showReactions?: boolean;
+
+ // which layout to use
+ layout: Layout;
+
+ // whether or not to show flair at all
+ enableFlair?: boolean;
+
+ // whether or not to show read receipts
+ showReadReceipts?: boolean;
+
+ // Used while editing, to pass the event, and to preserve editor state
+ // from one editor instance to another when remounting the editor
+ // upon receiving the remote echo for an unsent event.
+ editState?: EditorStateTransfer;
+
+ // Event ID of the event replacing the content of this event, if any
+ replacingEventId?: string;
+
+ // Helper to build permalinks for the room
+ permalinkCreator?: RoomPermalinkCreator;
+}
+
+interface IState {
+ // Whether the action bar is focused.
+ actionBarFocused: boolean;
+ // Whether all read receipts are being displayed. If not, only display
+ // a truncation of them.
+ allReadAvatars: boolean;
+ // Whether the event's sender has been verified.
+ verified: string;
+ // Whether onRequestKeysClick has been called since mounting.
+ previouslyRequestedKeys: boolean;
+ // The Relations model from the JS SDK for reactions to `mxEvent`
+ reactions: Relations;
+}
+
@replaceableComponent("views.rooms.EventTile")
-export default class EventTile extends React.Component {
- static propTypes = {
- /* the MatrixEvent to show */
- mxEvent: PropTypes.object.isRequired,
-
- /* true if mxEvent is redacted. This is a prop because using mxEvent.isRedacted()
- * might not be enough when deciding shouldComponentUpdate - prevProps.mxEvent
- * references the same this.props.mxEvent.
- */
- isRedacted: PropTypes.bool,
-
- /* true if this is a continuation of the previous event (which has the
- * effect of not showing another avatar/displayname
- */
- continuation: PropTypes.bool,
-
- /* true if this is the last event in the timeline (which has the effect
- * of always showing the timestamp)
- */
- last: PropTypes.bool,
-
- // true if the event is the last event in a section (adds a css class for
- // targeting)
- lastInSection: PropTypes.bool,
-
- // True if the event is the last successful (sent) event.
- isLastSuccessful: PropTypes.bool,
-
- /* true if this is search context (which has the effect of greying out
- * the text
- */
- contextual: PropTypes.bool,
-
- /* a list of words to highlight, ordered by longest first */
- highlights: PropTypes.array,
-
- /* link URL for the highlights */
- highlightLink: PropTypes.string,
-
- /* should show URL previews for this event */
- showUrlPreview: PropTypes.bool,
-
- /* is this the focused event */
- isSelectedEvent: PropTypes.bool,
-
- /* callback called when dynamic content in events are loaded */
- onHeightChanged: PropTypes.func,
-
- /* a list of read-receipts we should show. Each object has a 'roomMember' and 'ts'. */
- readReceipts: PropTypes.arrayOf(PropTypes.object),
-
- /* opaque readreceipt info for each userId; used by ReadReceiptMarker
- * to manage its animations. Should be an empty object when the room
- * first loads
- */
- readReceiptMap: PropTypes.object,
-
- /* A function which is used to check if the parent panel is being
- * unmounted, to avoid unnecessary work. Should return true if we
- * are being unmounted.
- */
- checkUnmounting: PropTypes.func,
-
- /* the status of this event - ie, mxEvent.status. Denormalised to here so
- * that we can tell when it changes. */
- eventSendStatus: PropTypes.string,
-
- /* the shape of the tile. by default, the layout is intended for the
- * normal room timeline. alternative values are: "file_list", "file_grid"
- * and "notif". This could be done by CSS, but it'd be horribly inefficient.
- * It could also be done by subclassing EventTile, but that'd be quite
- * boiilerplatey. So just make the necessary render decisions conditional
- * for now.
- */
- tileShape: PropTypes.string,
-
- // show twelve hour timestamps
- isTwelveHour: PropTypes.bool,
-
- // helper function to access relations for this event
- getRelationsForEvent: PropTypes.func,
-
- // whether to show reactions for this event
- showReactions: PropTypes.bool,
-
- // which layout to use
- layout: LayoutPropType,
-
- // whether or not to show flair at all
- enableFlair: PropTypes.bool,
-
- // whether or not to show read receipts
- showReadReceipts: PropTypes.bool,
- };
+export default class EventTile extends React.Component {
+ private suppressReadReceiptAnimation: boolean;
+ private isListeningForReceipts: boolean;
+ private tile = React.createRef();
+ private replyThread = React.createRef();
static defaultProps = {
// no-op function because onHeightChanged is optional yet some sub-components assume its existence
@@ -290,26 +325,22 @@ export default class EventTile extends React.Component {
};
// don't do RR animations until we are mounted
- this._suppressReadReceiptAnimation = true;
-
- this._tile = createRef();
- this._replyThread = createRef();
+ this.suppressReadReceiptAnimation = true;
// Throughout the component we manage a read receipt listener to see if our tile still
// qualifies for a "sent" or "sending" state (based on their relevant conditions). We
// don't want to over-subscribe to the read receipt events being fired, so we use a flag
// to determine if we've already subscribed and use a combination of other flags to find
// out if we should even be subscribed at all.
- this._isListeningForReceipts = false;
+ this.isListeningForReceipts = false;
}
/**
* When true, the tile qualifies for some sort of special read receipt. This could be a 'sending'
* or 'sent' receipt, for example.
* @returns {boolean}
- * @private
*/
- get _isEligibleForSpecialReceipt() {
+ private get isEligibleForSpecialReceipt() {
// First, if there are other read receipts then just short-circuit this.
if (this.props.readReceipts && this.props.readReceipts.length > 0) return false;
if (!this.props.mxEvent) return false;
@@ -338,9 +369,9 @@ export default class EventTile extends React.Component {
return true;
}
- get _shouldShowSentReceipt() {
+ private get shouldShowSentReceipt() {
// If we're not even eligible, don't show the receipt.
- if (!this._isEligibleForSpecialReceipt) return false;
+ if (!this.isEligibleForSpecialReceipt) return false;
// We only show the 'sent' receipt on the last successful event.
if (!this.props.lastSuccessful) return false;
@@ -358,9 +389,9 @@ export default class EventTile extends React.Component {
return true;
}
- get _shouldShowSendingReceipt() {
+ private get shouldShowSendingReceipt() {
// If we're not even eligible, don't show the receipt.
- if (!this._isEligibleForSpecialReceipt) return false;
+ if (!this.isEligibleForSpecialReceipt) return false;
// Check the event send status to see if we are pending. Null/undefined status means the
// message was sent, so check for that and 'sent' explicitly.
@@ -374,22 +405,22 @@ export default class EventTile extends React.Component {
// TODO: [REACT-WARNING] Move into constructor
// eslint-disable-next-line camelcase
UNSAFE_componentWillMount() {
- this._verifyEvent(this.props.mxEvent);
+ this.verifyEvent(this.props.mxEvent);
}
componentDidMount() {
- this._suppressReadReceiptAnimation = false;
+ this.suppressReadReceiptAnimation = false;
const client = this.context;
client.on("deviceVerificationChanged", this.onDeviceVerificationChanged);
client.on("userTrustStatusChanged", this.onUserVerificationChanged);
- this.props.mxEvent.on("Event.decrypted", this._onDecrypted);
+ this.props.mxEvent.on("Event.decrypted", this.onDecrypted);
if (this.props.showReactions) {
- this.props.mxEvent.on("Event.relationsCreated", this._onReactionsCreated);
+ this.props.mxEvent.on("Event.relationsCreated", this.onReactionsCreated);
}
- if (this._shouldShowSentReceipt || this._shouldShowSendingReceipt) {
- client.on("Room.receipt", this._onRoomReceipt);
- this._isListeningForReceipts = true;
+ if (this.shouldShowSentReceipt || this.shouldShowSendingReceipt) {
+ client.on("Room.receipt", this.onRoomReceipt);
+ this.isListeningForReceipts = true;
}
}
@@ -399,7 +430,7 @@ export default class EventTile extends React.Component {
// re-check the sender verification as outgoing events progress through
// the send process.
if (nextProps.eventSendStatus !== this.props.eventSendStatus) {
- this._verifyEvent(nextProps.mxEvent);
+ this.verifyEvent(nextProps.mxEvent);
}
}
@@ -408,35 +439,35 @@ export default class EventTile extends React.Component {
return true;
}
- return !this._propsEqual(this.props, nextProps);
+ return !this.propsEqual(this.props, nextProps);
}
componentWillUnmount() {
const client = this.context;
client.removeListener("deviceVerificationChanged", this.onDeviceVerificationChanged);
client.removeListener("userTrustStatusChanged", this.onUserVerificationChanged);
- client.removeListener("Room.receipt", this._onRoomReceipt);
- this._isListeningForReceipts = false;
- this.props.mxEvent.removeListener("Event.decrypted", this._onDecrypted);
+ client.removeListener("Room.receipt", this.onRoomReceipt);
+ this.isListeningForReceipts = false;
+ this.props.mxEvent.removeListener("Event.decrypted", this.onDecrypted);
if (this.props.showReactions) {
- this.props.mxEvent.removeListener("Event.relationsCreated", this._onReactionsCreated);
+ this.props.mxEvent.removeListener("Event.relationsCreated", this.onReactionsCreated);
}
}
componentDidUpdate(prevProps, prevState, snapshot) {
// If we're not listening for receipts and expect to be, register a listener.
- if (!this._isListeningForReceipts && (this._shouldShowSentReceipt || this._shouldShowSendingReceipt)) {
- this.context.on("Room.receipt", this._onRoomReceipt);
- this._isListeningForReceipts = true;
+ if (!this.isListeningForReceipts && (this.shouldShowSentReceipt || this.shouldShowSendingReceipt)) {
+ this.context.on("Room.receipt", this.onRoomReceipt);
+ this.isListeningForReceipts = true;
}
}
- _onRoomReceipt = (ev, room) => {
+ private onRoomReceipt = (ev, room) => {
// ignore events for other rooms
const tileRoom = MatrixClientPeg.get().getRoom(this.props.mxEvent.getRoomId());
if (room !== tileRoom) return;
- if (!this._shouldShowSentReceipt && !this._shouldShowSendingReceipt && !this._isListeningForReceipts) {
+ if (!this.shouldShowSentReceipt && !this.shouldShowSendingReceipt && !this.isListeningForReceipts) {
return;
}
@@ -444,36 +475,36 @@ export default class EventTile extends React.Component {
// the getters we use here to determine what needs rendering.
this.forceUpdate(() => {
// Per elsewhere in this file, we can remove the listener once we will have no further purpose for it.
- if (!this._shouldShowSentReceipt && !this._shouldShowSendingReceipt) {
- this.context.removeListener("Room.receipt", this._onRoomReceipt);
- this._isListeningForReceipts = false;
+ if (!this.shouldShowSentReceipt && !this.shouldShowSendingReceipt) {
+ this.context.removeListener("Room.receipt", this.onRoomReceipt);
+ this.isListeningForReceipts = false;
}
});
};
/** called when the event is decrypted after we show it.
*/
- _onDecrypted = () => {
+ private onDecrypted = () => {
// we need to re-verify the sending device.
- // (we call onHeightChanged in _verifyEvent to handle the case where decryption
+ // (we call onHeightChanged in verifyEvent to handle the case where decryption
// has caused a change in size of the event tile)
- this._verifyEvent(this.props.mxEvent);
+ this.verifyEvent(this.props.mxEvent);
this.forceUpdate();
};
- onDeviceVerificationChanged = (userId, device) => {
+ private onDeviceVerificationChanged = (userId, device) => {
if (userId === this.props.mxEvent.getSender()) {
- this._verifyEvent(this.props.mxEvent);
+ this.verifyEvent(this.props.mxEvent);
}
};
- onUserVerificationChanged = (userId, _trustStatus) => {
+ private onUserVerificationChanged = (userId, _trustStatus) => {
if (userId === this.props.mxEvent.getSender()) {
- this._verifyEvent(this.props.mxEvent);
+ this.verifyEvent(this.props.mxEvent);
}
};
- async _verifyEvent(mxEvent) {
+ private async verifyEvent(mxEvent) {
if (!mxEvent.isEncrypted()) {
return;
}
@@ -527,7 +558,7 @@ export default class EventTile extends React.Component {
}, this.props.onHeightChanged); // Decryption may have caused a change in size
}
- _propsEqual(objA, objB) {
+ private propsEqual(objA, objB) {
const keysA = Object.keys(objA);
const keysB = Object.keys(objB);
@@ -594,7 +625,7 @@ export default class EventTile extends React.Component {
};
getReadAvatars() {
- if (this._shouldShowSentReceipt || this._shouldShowSendingReceipt) {
+ if (this.shouldShowSentReceipt || this.shouldShowSendingReceipt) {
return
);
@@ -1032,13 +1064,14 @@ export default class EventTile extends React.Component {
return (
-
{tooltip}
@@ -1235,8 +1277,8 @@ interface ISentReceiptState {
}
class SentReceipt extends React.PureComponent
- ![]({require("../../../../res/img/room_replaced.svg")})
+
{_t("This room has been replaced and is no longer active.")}
@@ -431,14 +458,3 @@ export default class MessageComposer extends React.Component { ); } } - -MessageComposer.propTypes = { - // js-sdk Room object - room: PropTypes.object.isRequired, - - // string representing the current voip call state - callState: PropTypes.string, - - // string representing the current room app drawer state - showApps: PropTypes.bool, -}; diff --git a/src/components/views/rooms/NotificationBadge.tsx b/src/components/views/rooms/NotificationBadge.tsx index 36a52e260d..4b843bfc29 100644 --- a/src/components/views/rooms/NotificationBadge.tsx +++ b/src/components/views/rooms/NotificationBadge.tsx @@ -30,7 +30,7 @@ interface IProps { * If true, the badge will show a count if at all possible. This is typically * used to override the user's preference for things like room sublists. */ - forceCount: boolean; + forceCount?: boolean; /** * The room ID, if any, the badge represents. diff --git a/src/components/views/rooms/RoomList.tsx b/src/components/views/rooms/RoomList.tsx index 8ac706fc15..a155e1b5cd 100644 --- a/src/components/views/rooms/RoomList.tsx +++ b/src/components/views/rooms/RoomList.tsx @@ -1,7 +1,5 @@ /* -Copyright 2015, 2016 OpenMarket Ltd -Copyright 2017, 2018 Vector Creations Ltd -Copyright 2020 The Matrix.org Foundation C.I.C. +Copyright 2015-2018, 2020, 2021 The Matrix.org Foundation C.I.C. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -37,7 +35,6 @@ import { MatrixClientPeg } from "../../../MatrixClientPeg"; import GroupAvatar from "../avatars/GroupAvatar"; import ExtraTile from "./ExtraTile"; import { StaticNotificationState } from "../../../stores/notifications/StaticNotificationState"; -import { NotificationColor } from "../../../stores/notifications/NotificationColor"; import { Action } from "../../../dispatcher/actions"; import { ViewRoomDeltaPayload } from "../../../dispatcher/payloads/ViewRoomDeltaPayload"; import { RoomNotificationStateStore } from "../../../stores/notifications/RoomNotificationStateStore"; @@ -492,7 +489,7 @@ export default class RoomList extends React.PureComponent {
isSelected={false}
displayName={g.name}
avatar={avatar}
- notificationState={StaticNotificationState.forSymbol("!", NotificationColor.Red)}
+ notificationState={StaticNotificationState.RED_EXCLAMATION}
onClick={openGroup}
key={`temporaryGroupTile_${g.groupId}`}
/>
@@ -548,6 +545,9 @@ export default class RoomList extends React.PureComponent {
}
public render() {
+ const cli = MatrixClientPeg.get();
+ const userId = cli.getUserId();
+
let explorePrompt: JSX.Element;
if (!this.props.isMinimized) {
if (this.state.isNameFiltering) {
@@ -568,21 +568,23 @@ export default class RoomList extends React.PureComponent {
{ this.props.activeSpace ? _t("Explore rooms") : _t("Explore all public rooms") }
;
- } else if (this.props.activeSpace) {
+ } else if (
+ this.props.activeSpace?.canInvite(userId) || this.props.activeSpace?.getMyMembership() === "join"
+ ) {
explorePrompt =
+
{_t("This room has been replaced and is no longer active.")}
@@ -431,14 +458,3 @@ export default class MessageComposer extends React.Component { ); } } - -MessageComposer.propTypes = { - // js-sdk Room object - room: PropTypes.object.isRequired, - - // string representing the current voip call state - callState: PropTypes.string, - - // string representing the current room app drawer state - showApps: PropTypes.bool, -}; diff --git a/src/components/views/rooms/NotificationBadge.tsx b/src/components/views/rooms/NotificationBadge.tsx index 36a52e260d..4b843bfc29 100644 --- a/src/components/views/rooms/NotificationBadge.tsx +++ b/src/components/views/rooms/NotificationBadge.tsx @@ -30,7 +30,7 @@ interface IProps { * If true, the badge will show a count if at all possible. This is typically * used to override the user's preference for things like room sublists. */ - forceCount: boolean; + forceCount?: boolean; /** * The room ID, if any, the badge represents. diff --git a/src/components/views/rooms/RoomList.tsx b/src/components/views/rooms/RoomList.tsx index 8ac706fc15..a155e1b5cd 100644 --- a/src/components/views/rooms/RoomList.tsx +++ b/src/components/views/rooms/RoomList.tsx @@ -1,7 +1,5 @@ /* -Copyright 2015, 2016 OpenMarket Ltd -Copyright 2017, 2018 Vector Creations Ltd -Copyright 2020 The Matrix.org Foundation C.I.C. +Copyright 2015-2018, 2020, 2021 The Matrix.org Foundation C.I.C. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -37,7 +35,6 @@ import { MatrixClientPeg } from "../../../MatrixClientPeg"; import GroupAvatar from "../avatars/GroupAvatar"; import ExtraTile from "./ExtraTile"; import { StaticNotificationState } from "../../../stores/notifications/StaticNotificationState"; -import { NotificationColor } from "../../../stores/notifications/NotificationColor"; import { Action } from "../../../dispatcher/actions"; import { ViewRoomDeltaPayload } from "../../../dispatcher/payloads/ViewRoomDeltaPayload"; import { RoomNotificationStateStore } from "../../../stores/notifications/RoomNotificationStateStore"; @@ -492,7 +489,7 @@ export default class RoomList extends React.PureComponent
{ _t("Quick actions") }
- { this.props.activeSpace.canInvite(MatrixClientPeg.get().getUserId()) &&
+ if (this.state.recordingPhase !== RecordingState.Started) {
+ // TODO: @@ TR: Should we disable this during upload? What does a failed upload look like?
+ return
{encryptionSettings}
- {
+ constructor(props) {
+ super(props);
this.state = {
- joinRule: "invite",
- guestAccess: "can_join",
- history: "shared",
+ joinRule: JoinRule.Invite,
+ guestAccess: GuestAccess.CanJoin,
+ history: HistoryVisibility.Shared,
hasAliases: false,
encrypted: false,
};
}
// TODO: [REACT-WARNING] Move this to constructor
- async UNSAFE_componentWillMount(): void { // eslint-disable-line camelcase
- MatrixClientPeg.get().on("RoomState.events", this._onStateEvent);
+ async UNSAFE_componentWillMount() { // eslint-disable-line camelcase
+ MatrixClientPeg.get().on("RoomState.events", this.onStateEvent);
const room = MatrixClientPeg.get().getRoom(this.props.roomId);
const state = room.currentState;
- const joinRule = this._pullContentPropertyFromEvent(
+ const joinRule: JoinRule = this.pullContentPropertyFromEvent(
state.getStateEvents("m.room.join_rules", ""),
'join_rule',
- 'invite',
+ JoinRule.Invite,
);
- const guestAccess = this._pullContentPropertyFromEvent(
+ const guestAccess: GuestAccess = this.pullContentPropertyFromEvent(
state.getStateEvents("m.room.guest_access", ""),
'guest_access',
- 'forbidden',
+ GuestAccess.Forbidden,
);
- const history = this._pullContentPropertyFromEvent(
+ const history: HistoryVisibility = this.pullContentPropertyFromEvent(
state.getStateEvents("m.room.history_visibility", ""),
'history_visibility',
- 'shared',
+ HistoryVisibility.Shared,
);
const encrypted = MatrixClientPeg.get().isRoomEncrypted(this.props.roomId);
this.setState({joinRule, guestAccess, history, encrypted});
- const hasAliases = await this._hasAliases();
+ const hasAliases = await this.hasAliases();
this.setState({hasAliases});
}
- _pullContentPropertyFromEvent(event, key, defaultValue) {
+ private pullContentPropertyFromEvent(event: MatrixEvent, key: string, defaultValue: T): T {
if (!event || !event.getContent()) return defaultValue;
return event.getContent()[key] || defaultValue;
}
- componentWillUnmount(): void {
- MatrixClientPeg.get().removeListener("RoomState.events", this._onStateEvent);
+ componentWillUnmount() {
+ MatrixClientPeg.get().removeListener("RoomState.events", this.onStateEvent);
}
- _onStateEvent = (e) => {
+ private onStateEvent = (e: MatrixEvent) => {
const refreshWhenTypes = [
'm.room.join_rules',
'm.room.guest_access',
@@ -93,7 +121,7 @@ export default class SecurityRoomSettingsTab extends React.Component {
if (refreshWhenTypes.includes(e.getType())) this.forceUpdate();
};
- _onEncryptionChange = (e) => {
+ private onEncryptionChange = (e: React.ChangeEvent) => {
Modal.createTrackedDialog('Enable encryption', '', QuestionDialog, {
title: _t('Enable encryption?'),
description: _t(
@@ -102,10 +130,9 @@ export default class SecurityRoomSettingsTab extends React.Component {
"may prevent many bots and bridges from working correctly. Learn more about encryption.",
{},
{
- 'a': (sub) => {
- return {sub};
- },
+ a: sub => {sub},
},
),
onFinished: (confirm) => {
@@ -127,12 +154,12 @@ export default class SecurityRoomSettingsTab extends React.Component {
});
};
- _fixGuestAccess = (e) => {
+ private fixGuestAccess = (e: React.MouseEvent) => {
e.preventDefault();
e.stopPropagation();
- const joinRule = "invite";
- const guestAccess = "can_join";
+ const joinRule = JoinRule.Invite;
+ const guestAccess = GuestAccess.CanJoin;
const beforeJoinRule = this.state.joinRule;
const beforeGuestAccess = this.state.guestAccess;
@@ -149,7 +176,7 @@ export default class SecurityRoomSettingsTab extends React.Component {
});
};
- _onRoomAccessRadioToggle = (roomAccess) => {
+ private onRoomAccessRadioToggle = (roomAccess: string) => {
// join_rule
// INVITE | PUBLIC
// ----------------------+----------------
@@ -163,20 +190,20 @@ export default class SecurityRoomSettingsTab extends React.Component {
// invite them, you clearly want them to join, whether they're a
// guest or not. In practice, guest_access should probably have
// been implemented as part of the join_rules enum.
- let joinRule = "invite";
- let guestAccess = "can_join";
+ let joinRule = JoinRule.Invite;
+ let guestAccess = GuestAccess.CanJoin;
switch (roomAccess) {
case "invite_only":
// no change - use defaults above
break;
case "public_no_guests":
- joinRule = "public";
- guestAccess = "forbidden";
+ joinRule = JoinRule.Public;
+ guestAccess = GuestAccess.Forbidden;
break;
case "public_with_guests":
- joinRule = "public";
- guestAccess = "can_join";
+ joinRule = JoinRule.Public;
+ guestAccess = GuestAccess.CanJoin;
break;
}
@@ -195,7 +222,7 @@ export default class SecurityRoomSettingsTab extends React.Component {
});
};
- _onHistoryRadioToggle = (history) => {
+ private onHistoryRadioToggle = (history: HistoryVisibility) => {
const beforeHistory = this.state.history;
this.setState({history: history});
MatrixClientPeg.get().sendStateEvent(this.props.roomId, "m.room.history_visibility", {
@@ -206,11 +233,11 @@ export default class SecurityRoomSettingsTab extends React.Component {
});
};
- _updateBlacklistDevicesFlag = (checked) => {
+ private updateBlacklistDevicesFlag = (checked: boolean) => {
MatrixClientPeg.get().getRoom(this.props.roomId).setBlacklistUnverifiedDevices(checked);
};
- async _hasAliases() {
+ private async hasAliases(): Promise {
const cli = MatrixClientPeg.get();
if (await cli.doesServerSupportUnstableFeature("org.matrix.msc2432")) {
const response = await cli.unstableGetLocalAliases(this.props.roomId);
@@ -224,7 +251,7 @@ export default class SecurityRoomSettingsTab extends React.Component {
}
}
- _renderRoomAccess() {
+ private renderRoomAccess() {
const client = MatrixClientPeg.get();
const room = client.getRoom(this.props.roomId);
const joinRule = this.state.joinRule;
@@ -240,7 +267,7 @@ export default class SecurityRoomSettingsTab extends React.Component {
![]({require("../../../../../../res/img/warning.svg")})
{_t("Guests cannot join this room even if explicitly invited.")}
- {_t("Click here to fix")}
+ {_t("Click here to fix")}
);
@@ -265,7 +292,7 @@ export default class SecurityRoomSettingsTab extends React.Component {
- {_t("Securely cache encrypted messages locally for them " +
- "to appear in search results, using %(size)s to store messages from %(rooms)s rooms.",
- {
- size: formatBytes(this.state.eventIndexSize, 0),
- // This drives the singular / plural string
- // selection for "room" / "rooms" only.
- count: this.state.roomCount,
- rooms: formatCountLong(this.state.roomCount),
- },
- )}
-
+ {_t(
+ "Securely cache encrypted messages locally for them " +
+ "to appear in search results, using %(size)s to store messages from %(rooms)s rooms.",
+ {
+ size: formatBytes(this.state.eventIndexSize, 0),
+ // This drives the singular / plural string
+ // selection for "room" / "rooms" only.
+ count: this.state.roomCount,
+ rooms: formatCountLong(this.state.roomCount),
+ },
+ )}
-
+
{_t("Manage")}
@@ -167,13 +174,13 @@ export default class EventIndexPanel extends React.Component {
} else if (!this.state.eventIndexingEnabled && EventIndexPeg.supportIsInstalled()) {
eventIndexingSettings = (
-
+ onClick={this.onEnable}>
{_t("Enable")}
{this.state.enabling ? {
+ private dispatcherRef: string;
+
+ constructor(props) {
+ super(props);
let defaultIdServer = '';
if (!MatrixClientPeg.get().getIdentityServerUrl() && getDefaultIdentityServerUrl()) {
@@ -96,7 +108,7 @@ export default class SetIdServer extends React.Component {
dis.unregister(this.dispatcherRef);
}
- onAction = (payload) => {
+ private onAction = (payload: ActionPayload) => {
// We react to changes in the ID server in the event the user is staring at this form
// when changing their identity server on another device.
if (payload.action !== "id_server_changed") return;
@@ -106,13 +118,13 @@ export default class SetIdServer extends React.Component {
});
};
- _onIdentityServerChanged = (ev) => {
+ private onIdentityServerChanged = (ev) => {
const u = ev.target.value;
this.setState({idServer: u});
};
- _getTooltip = () => {
+ private getTooltip = () => {
if (this.state.checking) {
const InlineSpinner = sdk.getComponent('views.elements.InlineSpinner');
return
);
diff --git a/src/components/views/settings/tabs/room/SecurityRoomSettingsTab.js b/src/components/views/settings/tabs/room/SecurityRoomSettingsTab.tsx
similarity index 79%
rename from src/components/views/settings/tabs/room/SecurityRoomSettingsTab.js
rename to src/components/views/settings/tabs/room/SecurityRoomSettingsTab.tsx
index ce883c6d23..02bbcfb751 100644
--- a/src/components/views/settings/tabs/room/SecurityRoomSettingsTab.js
+++ b/src/components/views/settings/tabs/room/SecurityRoomSettingsTab.tsx
@@ -1,5 +1,5 @@
/*
-Copyright 2019 New Vector Ltd
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@ limitations under the License.
*/
import React from 'react';
-import PropTypes from 'prop-types';
+import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import {_t} from "../../../../../languageHandler";
import {MatrixClientPeg} from "../../../../../MatrixClientPeg";
import * as sdk from "../../../../..";
@@ -26,64 +26,92 @@ import StyledRadioGroup from '../../../elements/StyledRadioGroup';
import {SettingLevel} from "../../../../../settings/SettingLevel";
import SettingsStore from "../../../../../settings/SettingsStore";
import {UIFeature} from "../../../../../settings/UIFeature";
-import {replaceableComponent} from "../../../../../utils/replaceableComponent";
+import { replaceableComponent } from "../../../../../utils/replaceableComponent";
+
+// Knock and private are reserved keywords which are not yet implemented.
+enum JoinRule {
+ Public = "public",
+ Knock = "knock",
+ Invite = "invite",
+ Private = "private",
+}
+
+enum GuestAccess {
+ CanJoin = "can_join",
+ Forbidden = "forbidden",
+}
+
+enum HistoryVisibility {
+ Invited = "invited",
+ Joined = "joined",
+ Shared = "shared",
+ WorldReadable = "world_readable",
+}
+
+interface IProps {
+ roomId: string;
+}
+
+interface IState {
+ joinRule: JoinRule;
+ guestAccess: GuestAccess;
+ history: HistoryVisibility;
+ hasAliases: boolean;
+ encrypted: boolean;
+}
@replaceableComponent("views.settings.tabs.room.SecurityRoomSettingsTab")
-export default class SecurityRoomSettingsTab extends React.Component {
- static propTypes = {
- roomId: PropTypes.string.isRequired,
- };
-
- constructor() {
- super();
+export default class SecurityRoomSettingsTab extends React.Component
- {_t( "Securely cache encrypted messages locally for them to " +
- "appear in search results.")}
-
+ {_t(
+ "Securely cache encrypted messages locally for them to " +
+ "appear in search results.",
+ )}
+
);
} else if (!EventIndexPeg.platformHasSupport()) {
eventIndexingSettings = (
- {_t(
+ "%(brand)s is missing some components required for securely " +
+ "caching encrypted messages locally. If you'd like to " +
+ "experiment with this feature, build a custom %(brand)s Desktop " +
+ "with search components added .",
{
- _t( "%(brand)s is missing some components required for securely " +
- "caching encrypted messages locally. If you'd like to " +
- "experiment with this feature, build a custom %(brand)s Desktop " +
- "with search components added .",
- {
- brand,
- },
- {
- 'nativeLink': (sub) => {sub},
- },
- )
- }
-
+ brand,
+ },
+ {
+ nativeLink: sub => {sub},
+ },
+ )}
+
);
} else {
eventIndexingSettings = (
@@ -233,19 +236,18 @@ export default class EventIndexPanel extends React.Component {
}
{EventIndexPeg.error && (
- {_t(
+ "%(brand)s can't securely cache encrypted messages locally " +
+ "while running in a web browser. Use %(brand)s Desktop " +
+ "for encrypted messages to appear in search results.",
{
- _t( "%(brand)s can't securely cache encrypted messages locally " +
- "while running in a web browser. Use %(brand)s Desktop " +
- "for encrypted messages to appear in search results.",
- {
- brand,
- },
- {
- 'desktopLink': (sub) => {sub},
- },
- )
- }
-
+ brand,
+ },
+ {
+ desktopLink: sub => {sub},
+ },
+ )}
-
+ {_t("Advanced")}
-
- {EventIndexPeg.error.message}
-
-
-
+
)}
-
{_t("Advanced")}
+
+ {EventIndexPeg.error.message}
+
+
+
@@ -126,11 +138,11 @@ export default class SetIdServer extends React.Component {
}
};
- _idServerChangeEnabled = () => {
+ private idServerChangeEnabled = () => {
return !!this.state.idServer && !this.state.busy;
};
- _saveIdServer = (fullUrl) => {
+ private saveIdServer = (fullUrl) => {
// Account data change will update localstorage, client, etc through dispatcher
MatrixClientPeg.get().setAccountData("m.identity_server", {
base_url: fullUrl,
@@ -143,7 +155,7 @@ export default class SetIdServer extends React.Component {
});
};
- _checkIdServer = async (e) => {
+ private checkIdServer = async (e) => {
e.preventDefault();
const { idServer, currentClientIdServer } = this.state;
@@ -166,14 +178,14 @@ export default class SetIdServer extends React.Component {
// Double check that the identity server even has terms of service.
const hasTerms = await doesIdentityServerHaveTerms(fullUrl);
if (!hasTerms) {
- const [confirmed] = await this._showNoTermsWarning(fullUrl);
+ const [confirmed] = await this.showNoTermsWarning(fullUrl);
save = confirmed;
}
// Show a general warning, possibly with details about any bound
// 3PIDs that would be left behind.
if (save && currentClientIdServer && fullUrl !== currentClientIdServer) {
- const [confirmed] = await this._showServerChangeWarning({
+ const [confirmed] = await this.showServerChangeWarning({
title: _t("Change identity server"),
unboundMessage: _t(
"Disconnect from the identity server {
+ private onUnbanClick = (e) => {
MatrixClientPeg.get().unban(this.props.member.roomId, this.props.member.userId).catch((err) => {
const ErrorDialog = sdk.getComponent("dialogs.ErrorDialog");
console.error("Failed to unban: " + err);
@@ -87,8 +89,10 @@ export class BannedUser extends React.Component {
if (this.props.canUnban) {
unbanButton = (
-
+
{ _t('Unban') }
);
@@ -107,29 +111,29 @@ export class BannedUser extends React.Component {
}
}
-@replaceableComponent("views.settings.tabs.room.RolesRoomSettingsTab")
-export default class RolesRoomSettingsTab extends React.Component {
- static propTypes = {
- roomId: PropTypes.string.isRequired,
- };
+interface IProps {
+ roomId: string;
+}
- componentDidMount(): void {
- MatrixClientPeg.get().on("RoomState.members", this._onRoomMembership);
+@replaceableComponent("views.settings.tabs.room.RolesRoomSettingsTab")
+export default class RolesRoomSettingsTab extends React.Component {
+ componentDidMount() {
+ MatrixClientPeg.get().on("RoomState.members", this.onRoomMembership);
}
- componentWillUnmount(): void {
+ componentWillUnmount() {
const client = MatrixClientPeg.get();
if (client) {
- client.removeListener("RoomState.members", this._onRoomMembership);
+ client.removeListener("RoomState.members", this.onRoomMembership);
}
}
- _onRoomMembership = (event, state, member) => {
+ private onRoomMembership = (event: MatrixEvent, state: RoomState, member: RoomMember) => {
if (state.roomId !== this.props.roomId) return;
this.forceUpdate();
};
- _populateDefaultPlEvents(eventsSection, stateLevel, eventsLevel) {
+ private populateDefaultPlEvents(eventsSection: Record, stateLevel: number, eventsLevel: number) {
for (const desiredEvent of Object.keys(plEventsToShow)) {
if (!(desiredEvent in eventsSection)) {
eventsSection[desiredEvent] = (plEventsToShow[desiredEvent].isState ? stateLevel : eventsLevel);
@@ -137,7 +141,7 @@ export default class RolesRoomSettingsTab extends React.Component {
}
}
- _onPowerLevelsChanged = (value, powerLevelKey) => {
+ private onPowerLevelsChanged = (inputValue: string, powerLevelKey: string) => {
const client = MatrixClientPeg.get();
const room = client.getRoom(this.props.roomId);
const plEvent = room.currentState.getStateEvents('m.room.power_levels', '');
@@ -148,7 +152,7 @@ export default class RolesRoomSettingsTab extends React.Component {
const eventsLevelPrefix = "event_levels_";
- value = parseInt(value);
+ const value = parseInt(inputValue);
if (powerLevelKey.startsWith(eventsLevelPrefix)) {
// deep copy "events" object, Object.assign itself won't deep copy
@@ -182,7 +186,7 @@ export default class RolesRoomSettingsTab extends React.Component {
});
};
- _onUserPowerLevelChanged = (value, powerLevelKey) => {
+ private onUserPowerLevelChanged = (value: string, powerLevelKey: string) => {
const client = MatrixClientPeg.get();
const room = client.getRoom(this.props.roomId);
const plEvent = room.currentState.getStateEvents('m.room.power_levels', '');
@@ -266,7 +270,7 @@ export default class RolesRoomSettingsTab extends React.Component {
currentUserLevel = defaultUserLevel;
}
- this._populateDefaultPlEvents(
+ this.populateDefaultPlEvents(
eventsLevels,
parseIntWithDefault(plContent.state_default, powerLevelDescriptors.state_default.defaultValue),
parseIntWithDefault(plContent.events_default, powerLevelDescriptors.events_default.defaultValue),
@@ -288,7 +292,7 @@ export default class RolesRoomSettingsTab extends React.Component {
label={user}
key={user}
powerLevelKey={user} // Will be sent as the second parameter to `onChange`
- onChange={this._onUserPowerLevelChanged}
+ onChange={this.onUserPowerLevelChanged}
/>,
);
} else if (userLevels[user] < defaultUserLevel) { // muted
@@ -299,7 +303,7 @@ export default class RolesRoomSettingsTab extends React.Component {
label={user}
key={user}
powerLevelKey={user} // Will be sent as the second parameter to `onChange`
- onChange={this._onUserPowerLevelChanged}
+ onChange={this.onUserPowerLevelChanged}
/>,
);
}
@@ -345,8 +349,9 @@ export default class RolesRoomSettingsTab extends React.Component {
if (sender) bannedBy = sender.name;
return (
;
});
@@ -398,7 +403,7 @@ export default class RolesRoomSettingsTab extends React.Component {
usersDefault={defaultUserLevel}
disabled={!canChangeLevels || currentUserLevel < eventsLevels[eventType]}
powerLevelKey={"event_levels_" + eventType}
- onChange={this._onPowerLevelsChanged}
+ onChange={this.onPowerLevelsChanged}
/>
{discoBodyText}
-
+
{discoButtonContent}
;
}
return (
-
diff --git a/src/components/views/settings/tabs/room/RolesRoomSettingsTab.js b/src/components/views/settings/tabs/room/RolesRoomSettingsTab.tsx
similarity index 89%
rename from src/components/views/settings/tabs/room/RolesRoomSettingsTab.js
rename to src/components/views/settings/tabs/room/RolesRoomSettingsTab.tsx
index 59a175906d..4fa521f598 100644
--- a/src/components/views/settings/tabs/room/RolesRoomSettingsTab.js
+++ b/src/components/views/settings/tabs/room/RolesRoomSettingsTab.tsx
@@ -1,5 +1,5 @@
/*
-Copyright 2019, 2021 The Matrix.org Foundation C.I.C.
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@ limitations under the License.
*/
import React from 'react';
-import PropTypes from 'prop-types';
import {_t, _td} from "../../../../../languageHandler";
import {MatrixClientPeg} from "../../../../../MatrixClientPeg";
import * as sdk from "../../../../..";
@@ -23,6 +22,9 @@ import AccessibleButton from "../../../elements/AccessibleButton";
import Modal from "../../../../../Modal";
import {replaceableComponent} from "../../../../../utils/replaceableComponent";
import {EventType} from "matrix-js-sdk/src/@types/event";
+import { RoomMember } from "matrix-js-sdk/src/models/room-member";
+import { MatrixEvent } from "matrix-js-sdk/src/models/event";
+import { RoomState } from "matrix-js-sdk/src/models/room-state";
const plEventsToLabels = {
// These will be translated for us later.
@@ -63,15 +65,15 @@ function parseIntWithDefault(val, def) {
return isNaN(res) ? def : res;
}
-export class BannedUser extends React.Component {
- static propTypes = {
- canUnban: PropTypes.bool,
- member: PropTypes.object.isRequired, // js-sdk RoomMember
- by: PropTypes.string.isRequired,
- reason: PropTypes.string,
- };
+interface IBannedUserProps {
+ canUnban?: boolean;
+ member: RoomMember;
+ by: string;
+ reason?: string;
+}
- _onUnbanClick = (e) => {
+export class BannedUser extends React.Component
{_t("Guests cannot join this room even if explicitly invited.")}
- {_t("Click here to fix")}
+ {_t("Click here to fix")}
- {this._renderHistory()}
+ {this.renderHistory()}
);
if (!SettingsStore.getValue(UIFeature.RoomHistorySettings)) {
@@ -373,15 +400,16 @@ export default class SecurityRoomSettingsTab extends React.Component {
{_t("Once enabled, encryption cannot be disabled.")}
-
- {this._renderRoomAccess()}
+ {this.renderRoomAccess()}
{historySection}
diff --git a/src/components/views/settings/tabs/user/GeneralUserSettingsTab.js b/src/components/views/settings/tabs/user/GeneralUserSettingsTab.js
index b1ad9f3d23..a216aeccbe 100644
--- a/src/components/views/settings/tabs/user/GeneralUserSettingsTab.js
+++ b/src/components/views/settings/tabs/user/GeneralUserSettingsTab.js
@@ -192,7 +192,11 @@ export default class GeneralUserSettingsTab extends React.Component {
SettingsStore.setValue("language", null, SettingLevel.DEVICE, newLanguage);
this.setState({language: newLanguage});
- PlatformPeg.get().reload();
+ const platform = PlatformPeg.get();
+ if (platform) {
+ platform.setLanguage(newLanguage);
+ platform.reload();
+ }
};
_onSpellCheckLanguagesChange = (languages) => {
diff --git a/src/components/views/settings/tabs/user/HelpUserSettingsTab.js b/src/components/views/settings/tabs/user/HelpUserSettingsTab.tsx
similarity index 75%
rename from src/components/views/settings/tabs/user/HelpUserSettingsTab.js
rename to src/components/views/settings/tabs/user/HelpUserSettingsTab.tsx
index e16ee686f5..a009ead064 100644
--- a/src/components/views/settings/tabs/user/HelpUserSettingsTab.js
+++ b/src/components/views/settings/tabs/user/HelpUserSettingsTab.tsx
@@ -1,6 +1,5 @@
/*
-Copyright 2019 New Vector Ltd
-Copyright 2020 The Matrix.org Foundation C.I.C.
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -16,27 +15,31 @@ limitations under the License.
*/
import React from 'react';
-import PropTypes from 'prop-types';
import {_t, getCurrentLanguage} from "../../../../../languageHandler";
import {MatrixClientPeg} from "../../../../../MatrixClientPeg";
import AccessibleButton from "../../../elements/AccessibleButton";
import SdkConfig from "../../../../../SdkConfig";
import createRoom from "../../../../../createRoom";
import Modal from "../../../../../Modal";
-import * as sdk from "../../../../../";
+import * as sdk from "../../../../..";
import PlatformPeg from "../../../../../PlatformPeg";
import * as KeyboardShortcuts from "../../../../../accessibility/KeyboardShortcuts";
import UpdateCheckButton from "../../UpdateCheckButton";
-import {replaceableComponent} from "../../../../../utils/replaceableComponent";
+import { replaceableComponent } from "../../../../../utils/replaceableComponent";
+
+interface IProps {
+ closeSettingsFn: () => {};
+}
+
+interface IState {
+ appVersion: string;
+ canUpdate: boolean;
+}
@replaceableComponent("views.settings.tabs.user.HelpUserSettingsTab")
-export default class HelpUserSettingsTab extends React.Component {
- static propTypes = {
- closeSettingsFn: PropTypes.func.isRequired,
- };
-
- constructor() {
- super();
+export default class HelpUserSettingsTab extends React.Component- - The - default cover photo is © - Jesús Roncero{' '} - used under the terms of - - CC-BY-SA 4.0. + The default cover photo is © + Jesús Roncero used under the terms of + CC-BY-SA 4.0.
- The twemoji-colr font is © - Mozilla Foundation{' '} - used under the terms of - - Apache 2.0. + target="_blank">twemoji-colr font is © + Mozilla Foundation used under the terms of + Apache 2.0.
- - The - Twemoji emoji art is © - Twitter, Inc and other - contributors used under the terms of - - CC-BY 4.0. + The Twemoji emoji art is © + Twitter, Inc and other contributors used under the terms of + CC-BY 4.0.
-
+
{_t("Chat with %(brand)s Bot", { brand })}
@@ -212,28 +215,27 @@ export default class HelpUserSettingsTab extends React.Component {
{_t('Bug reporting')}
);
@@ -260,20 +262,21 @@ export default class HelpUserSettingsTab extends React.Component {
{updateButton}
- {
- _t( "If you've submitted a bug via GitHub, debug logs can help " +
- "us track down the problem. Debug logs contain application " +
- "usage data including your username, the IDs or aliases of " +
- "the rooms or groups you have visited and the usernames of " +
- "other users. They do not contain messages.",
- )
- }
+ {_t(
+ "If you've submitted a bug via GitHub, debug logs can help " +
+ "us track down the problem. Debug logs contain application " +
+ "usage data including your username, the IDs or aliases of " +
+ "the rooms or groups you have visited and the usernames of " +
+ "other users. They do not contain messages.",
+ )}
-
+
{_t("Submit debug logs")}
- {
- _t( "To report a Matrix-related security issue, please read the Matrix.org " +
- "Security Disclosure Policy.", {},
- {
- 'a': (sub) =>
- {sub},
- })
- }
+ {_t(
+ "To report a Matrix-related security issue, please read the Matrix.org " +
+ "Security Disclosure Policy.", {},
+ {
+ a: sub => {sub},
+ },
+ )}
{_t("Advanced")}
= ({
;
}
-const useSpaces = (): [Room[], Room | null] => {
+const useSpaces = (): [Room[], Room[], Room | null] => {
+ const [invites, setInvites] = useState(SpaceStore.instance.invitedSpaces);
+ useEventEmitter(SpaceStore.instance, UPDATE_INVITED_SPACES, setInvites);
const [spaces, setSpaces] = useState(SpaceStore.instance.spacePanelSpaces);
useEventEmitter(SpaceStore.instance, UPDATE_TOP_LEVEL_SPACES, setSpaces);
const [activeSpace, setActiveSpace] = useState(SpaceStore.instance.activeSpace);
useEventEmitter(SpaceStore.instance, UPDATE_SELECTED_SPACE, setActiveSpace);
- return [spaces, activeSpace];
+ return [invites, spaces, activeSpace];
};
const SpacePanel = () => {
// We don't need the handle as we position the menu in a constant location
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const [menuDisplayed, handle, openMenu, closeMenu] = useContextMenu();
- const [spaces, activeSpace] = useSpaces();
+ const [invites, spaces, activeSpace] = useSpaces();
const [isPanelCollapsed, setPanelCollapsed] = useState(true);
const newClasses = classNames("mx_SpaceButton_new", {
@@ -209,6 +216,13 @@ const SpacePanel = () => {
notificationState={SpaceStore.instance.getNotificationState(HOME_SPACE)}
isNarrow={isPanelCollapsed}
/>
+ { invites.map(s => setPanelCollapsed(false)}
+ />) }
{ spaces.map(s => {
super(props);
this.state = {
- collapsed: !props.isNested, // default to collapsed for root items
+ collapsed: !props.isNested, // default to collapsed for root items
contextMenuPosition: null,
};
}
@@ -83,6 +85,7 @@ export class SpaceItem extends React.PureComponent {
}
private onContextMenu = (ev: React.MouseEvent) => {
+ if (this.props.space.getMyMembership() !== "join") return;
ev.preventDefault();
ev.stopPropagation();
this.setState({
@@ -185,6 +188,8 @@ export class SpaceItem extends React.PureComponent {
};
private renderContextMenu(): React.ReactElement {
+ if (this.props.space.getMyMembership() !== "join") return null;
+
let contextMenu = null;
if (this.state.contextMenuPosition) {
const userId = this.context.getUserId();
@@ -300,7 +305,9 @@ export class SpaceItem extends React.PureComponent {
mx_SpaceButton_hasMenuOpen: !!this.state.contextMenuPosition,
mx_SpaceButton_narrow: isNarrow,
});
- const notificationState = SpaceStore.instance.getNotificationState(space.roomId);
+ const notificationState = space.getMyMembership() === "invite"
+ ? StaticNotificationState.forSymbol("!", NotificationColor.Red)
+ : SpaceStore.instance.getNotificationState(space.roomId);
let childItems;
if (childSpaces && !collapsed) {
diff --git a/src/components/views/voice_messages/Clock.tsx b/src/components/views/voice_messages/Clock.tsx
index 6c256957e9..23e6762c52 100644
--- a/src/components/views/voice_messages/Clock.tsx
+++ b/src/components/views/voice_messages/Clock.tsx
@@ -29,14 +29,20 @@ interface IState {
* displayed, making it possible to see "82:29".
*/
@replaceableComponent("views.voice_messages.Clock")
-export default class Clock extends React.PureComponent {
+export default class Clock extends React.Component {
public constructor(props) {
super(props);
}
+ shouldComponentUpdate(nextProps: Readonly, nextState: Readonly, nextContext: any): boolean {
+ const currentFloor = Math.floor(this.props.seconds);
+ const nextFloor = Math.floor(nextProps.seconds);
+ return currentFloor !== nextFloor;
+ }
+
public render() {
const minutes = Math.floor(this.props.seconds / 60).toFixed(0).padStart(2, '0');
- const seconds = Math.round(this.props.seconds % 60).toFixed(0).padStart(2, '0'); // hide millis
+ const seconds = Math.floor(this.props.seconds % 60).toFixed(0).padStart(2, '0'); // hide millis
return {minutes}:{seconds};
}
}
diff --git a/src/components/views/voice_messages/LiveRecordingClock.tsx b/src/components/views/voice_messages/LiveRecordingClock.tsx
index 5e9006c6ab..b82539eb16 100644
--- a/src/components/views/voice_messages/LiveRecordingClock.tsx
+++ b/src/components/views/voice_messages/LiveRecordingClock.tsx
@@ -31,7 +31,7 @@ interface IState {
* A clock for a live recording.
*/
@replaceableComponent("views.voice_messages.LiveRecordingClock")
-export default class LiveRecordingClock extends React.Component {
+export default class LiveRecordingClock extends React.PureComponent {
public constructor(props) {
super(props);
@@ -39,12 +39,6 @@ export default class LiveRecordingClock extends React.Component
this.props.recorder.liveData.onUpdate(this.onRecordingUpdate);
}
- shouldComponentUpdate(nextProps: Readonly, nextState: Readonly, nextContext: any): boolean {
- const currentFloor = Math.floor(this.state.seconds);
- const nextFloor = Math.floor(nextState.seconds);
- return currentFloor !== nextFloor;
- }
-
private onRecordingUpdate = (update: IRecordingUpdate) => {
this.setState({seconds: update.timeSeconds});
};
diff --git a/src/components/views/voice_messages/LiveRecordingWaveform.tsx b/src/components/views/voice_messages/LiveRecordingWaveform.tsx
index c1f5e97fff..e7c34c9177 100644
--- a/src/components/views/voice_messages/LiveRecordingWaveform.tsx
+++ b/src/components/views/voice_messages/LiveRecordingWaveform.tsx
@@ -20,6 +20,7 @@ import {replaceableComponent} from "../../../utils/replaceableComponent";
import {arrayFastResample, arraySeed} from "../../../utils/arrays";
import {percentageOf} from "../../../utils/numbers";
import Waveform from "./Waveform";
+import {PLAYBACK_WAVEFORM_SAMPLES} from "../../../voice/Playback";
interface IProps {
recorder: VoiceRecording;
@@ -29,8 +30,6 @@ interface IState {
heights: number[];
}
-const DOWNSAMPLE_TARGET = 35; // number of bars we want
-
/**
* A waveform which shows the waveform of a live recording
*/
@@ -39,14 +38,14 @@ export default class LiveRecordingWaveform extends React.PureComponent {
// The waveform and the downsample target are pretty close, so we should be fine to
// do this, despite the docs on arrayFastResample.
- const bars = arrayFastResample(Array.from(update.waveform), DOWNSAMPLE_TARGET);
+ const bars = arrayFastResample(Array.from(update.waveform), PLAYBACK_WAVEFORM_SAMPLES);
this.setState({
// The incoming data is between zero and one, but typically even screaming into a
// microphone won't send you over 0.6, so we artificially adjust the gain for the
diff --git a/src/components/views/voice_messages/PlayPauseButton.tsx b/src/components/views/voice_messages/PlayPauseButton.tsx
new file mode 100644
index 0000000000..1f87eb012d
--- /dev/null
+++ b/src/components/views/voice_messages/PlayPauseButton.tsx
@@ -0,0 +1,61 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import React, {ReactNode} from "react";
+import {replaceableComponent} from "../../../utils/replaceableComponent";
+import AccessibleTooltipButton from "../elements/AccessibleTooltipButton";
+import {_t} from "../../../languageHandler";
+import {Playback, PlaybackState} from "../../../voice/Playback";
+import classNames from "classnames";
+
+interface IProps {
+ // Playback instance to manipulate. Cannot change during the component lifecycle.
+ playback: Playback;
+
+ // The playback phase to render. Able to change during the component lifecycle.
+ playbackPhase: PlaybackState;
+}
+
+/**
+ * Displays a play/pause button (activating the play/pause function of the recorder)
+ * to be displayed in reference to a recording.
+ */
+@replaceableComponent("views.voice_messages.PlayPauseButton")
+export default class PlayPauseButton extends React.PureComponent {
+ public constructor(props) {
+ super(props);
+ }
+
+ private onClick = async () => {
+ await this.props.playback.toggle();
+ };
+
+ public render(): ReactNode {
+ const isPlaying = this.props.playback.isPlaying;
+ const isDisabled = this.props.playbackPhase === PlaybackState.Decoding;
+ const classes = classNames('mx_PlayPauseButton', {
+ 'mx_PlayPauseButton_play': !isPlaying,
+ 'mx_PlayPauseButton_pause': isPlaying,
+ 'mx_PlayPauseButton_disabled': isDisabled,
+ });
+ return {
+ public constructor(props) {
+ super(props);
+
+ this.state = {
+ seconds: this.props.playback.clockInfo.timeSeconds,
+ // we track the duration on state because we won't really know what the clip duration
+ // is until the first time update, and as a PureComponent we are trying to dedupe state
+ // updates as much as possible. This is just the easiest way to avoid a forceUpdate() or
+ // member property to track "did we get a duration".
+ durationSeconds: this.props.playback.clockInfo.durationSeconds,
+ playbackPhase: PlaybackState.Stopped, // assume not started, so full clock
+ };
+ this.props.playback.on(UPDATE_EVENT, this.onPlaybackUpdate);
+ this.props.playback.clockInfo.liveData.onUpdate(this.onTimeUpdate);
+ }
+
+ private onPlaybackUpdate = (ev: PlaybackState) => {
+ // Convert Decoding -> Stopped because we don't care about the distinction here
+ if (ev === PlaybackState.Decoding) ev = PlaybackState.Stopped;
+ this.setState({playbackPhase: ev});
+ };
+
+ private onTimeUpdate = (time: number[]) => {
+ this.setState({seconds: time[0], durationSeconds: time[1]});
+ };
+
+ public render() {
+ let seconds = this.state.seconds;
+ if (this.state.playbackPhase === PlaybackState.Stopped) {
+ seconds = this.state.durationSeconds;
+ }
+ return {
+ public constructor(props) {
+ super(props);
+
+ this.state = {
+ heights: this.toHeights(this.props.playback.waveform),
+ progress: 0, // default no progress
+ };
+
+ this.props.playback.waveformData.onUpdate(this.onWaveformUpdate);
+ this.props.playback.clockInfo.liveData.onUpdate(this.onTimeUpdate);
+ }
+
+ private toHeights(waveform: number[]) {
+ const seed = arraySeed(0, PLAYBACK_WAVEFORM_SAMPLES);
+ return arrayTrimFill(waveform, PLAYBACK_WAVEFORM_SAMPLES, seed);
+ }
+
+ private onWaveformUpdate = (waveform: number[]) => {
+ this.setState({heights: this.toHeights(waveform)});
+ };
+
+ private onTimeUpdate = (time: number[]) => {
+ // Track percentages to very coarse precision, otherwise 0.002 ends up highlighting a bar.
+ const progress = Number(percentageOf(time[0], 0, time[1]).toFixed(1));
+ this.setState({progress});
+ };
+
+ public render() {
+ return {
+ constructor(props: IProps) {
+ super(props);
+
+ this.state = {
+ playbackPhase: PlaybackState.Decoding, // default assumption
+ };
+
+ // We don't need to de-register: the class handles this for us internally
+ this.props.playback.on(UPDATE_EVENT, this.onPlaybackUpdate);
+
+ // Don't wait for the promise to complete - it will emit a progress update when it
+ // is done, and it's not meant to take long anyhow.
+ // noinspection JSIgnoredPromiseFromCall
+ this.props.playback.prepare();
+ }
+
+ private onPlaybackUpdate = (ev: PlaybackState) => {
+ this.setState({playbackPhase: ev});
+ };
+
+ public render(): ReactNode {
+ return {
+ public static defaultProps = {
+ progress: 1,
+ };
+
public constructor(props) {
super(props);
}
@@ -38,7 +47,13 @@ export default class Waveform extends React.PureComponent {
public render() {
return {
switch (payload.action) {
// listen for call state changes to prod the render method, which
// may hide the global CallView if the call it is tracking is dead
+ case Action.CallChangeRoom:
case 'call_state': {
const [primaryCall, secondaryCalls] = getPrimarySecondaryCalls(
CallHandler.sharedInstance().getAllActiveCallsNotInRoom(this.state.roomId),
diff --git a/src/components/views/voip/CallView.tsx b/src/components/views/voip/CallView.tsx
index 8a6ed75fee..6745713845 100644
--- a/src/components/views/voip/CallView.tsx
+++ b/src/components/views/voip/CallView.tsx
@@ -208,7 +208,7 @@ export default class CallView extends React.Component {
};
private onExpandClick = () => {
- const userFacingRoomId = CallHandler.roomIdForCall(this.props.call);
+ const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call);
dis.dispatch({
action: 'view_room',
room_id: userFacingRoomId,
@@ -337,7 +337,7 @@ export default class CallView extends React.Component {
};
private onRoomAvatarClick = () => {
- const userFacingRoomId = CallHandler.roomIdForCall(this.props.call);
+ const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call);
dis.dispatch({
action: 'view_room',
room_id: userFacingRoomId,
@@ -345,7 +345,7 @@ export default class CallView extends React.Component {
}
private onSecondaryRoomAvatarClick = () => {
- const userFacingRoomId = CallHandler.roomIdForCall(this.props.secondaryCall);
+ const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.secondaryCall);
dis.dispatch({
action: 'view_room',
@@ -354,7 +354,7 @@ export default class CallView extends React.Component {
}
private onCallResumeClick = () => {
- const userFacingRoomId = CallHandler.roomIdForCall(this.props.call);
+ const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call);
CallHandler.sharedInstance().setActiveCallRoomId(userFacingRoomId);
}
@@ -365,8 +365,8 @@ export default class CallView extends React.Component {
public render() {
const client = MatrixClientPeg.get();
- const callRoomId = CallHandler.roomIdForCall(this.props.call);
- const secondaryCallRoomId = CallHandler.roomIdForCall(this.props.secondaryCall);
+ const callRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call);
+ const secondaryCallRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.secondaryCall);
const callRoom = client.getRoom(callRoomId);
const secCallRoom = this.props.secondaryCall ? client.getRoom(secondaryCallRoomId) : null;
@@ -482,11 +482,13 @@ export default class CallView extends React.Component {
const isOnHold = this.state.isLocalOnHold || this.state.isRemoteOnHold;
let holdTransferContent;
if (transfereeCall) {
- const transferTargetRoom = MatrixClientPeg.get().getRoom(CallHandler.roomIdForCall(this.props.call));
+ const transferTargetRoom = MatrixClientPeg.get().getRoom(
+ CallHandler.sharedInstance().roomIdForCall(this.props.call),
+ );
const transferTargetName = transferTargetRoom ? transferTargetRoom.name : _t("unknown person");
const transfereeRoom = MatrixClientPeg.get().getRoom(
- CallHandler.roomIdForCall(transfereeCall),
+ CallHandler.sharedInstance().roomIdForCall(transfereeCall),
);
const transfereeName = transfereeRoom ? transfereeRoom.name : _t("unknown person");
diff --git a/src/components/views/voip/CallViewForRoom.tsx b/src/components/views/voip/CallViewForRoom.tsx
index 878b6af20f..7540dbc8d9 100644
--- a/src/components/views/voip/CallViewForRoom.tsx
+++ b/src/components/views/voip/CallViewForRoom.tsx
@@ -22,6 +22,7 @@ import dis from '../../../dispatcher/dispatcher';
import {Resizable} from "re-resizable";
import ResizeNotifier from "../../../utils/ResizeNotifier";
import {replaceableComponent} from "../../../utils/replaceableComponent";
+import { Action } from '../../../dispatcher/actions';
interface IProps {
// What room we should display the call for
@@ -62,6 +63,7 @@ export default class CallViewForRoom extends React.Component {
private onAction = (payload) => {
switch (payload.action) {
+ case Action.CallChangeRoom:
case 'call_state': {
const newCall = this.getCall();
if (newCall !== this.state.call) {
diff --git a/src/components/views/voip/IncomingCallBox.tsx b/src/components/views/voip/IncomingCallBox.tsx
index 0ca2a196c2..2abdc0641d 100644
--- a/src/components/views/voip/IncomingCallBox.tsx
+++ b/src/components/views/voip/IncomingCallBox.tsx
@@ -72,7 +72,7 @@ export default class IncomingCallBox extends React.Component {
e.stopPropagation();
dis.dispatch({
action: 'answer',
- room_id: CallHandler.roomIdForCall(this.state.incomingCall),
+ room_id: CallHandler.sharedInstance().roomIdForCall(this.state.incomingCall),
});
};
@@ -80,7 +80,7 @@ export default class IncomingCallBox extends React.Component {
e.stopPropagation();
dis.dispatch({
action: 'reject',
- room_id: CallHandler.roomIdForCall(this.state.incomingCall),
+ room_id: CallHandler.sharedInstance().roomIdForCall(this.state.incomingCall),
});
};
@@ -91,7 +91,7 @@ export default class IncomingCallBox extends React.Component {
let room = null;
if (this.state.incomingCall) {
- room = MatrixClientPeg.get().getRoom(CallHandler.roomIdForCall(this.state.incomingCall));
+ room = MatrixClientPeg.get().getRoom(CallHandler.sharedInstance().roomIdForCall(this.state.incomingCall));
}
const caller = room ? room.name : _t("Unknown caller");
diff --git a/src/customisations/Media.ts b/src/customisations/Media.ts
index b651e40a3b..f9d957b60c 100644
--- a/src/customisations/Media.ts
+++ b/src/customisations/Media.ts
@@ -96,6 +96,9 @@ export class Media {
*/
public getThumbnailHttp(width: number, height: number, mode: ResizeMethod = "scale"): string | null | undefined {
if (!this.hasThumbnail) return null;
+ // scale using the device pixel ratio to keep images clear
+ width = Math.floor(width * window.devicePixelRatio);
+ height = Math.floor(height * window.devicePixelRatio);
return this.client.mxcUrlToHttp(this.thumbnailMxc, width, height, mode);
}
@@ -107,6 +110,9 @@ export class Media {
* @returns {string} The HTTP URL which points to the thumbnail.
*/
public getThumbnailOfSourceHttp(width: number, height: number, mode: ResizeMethod = "scale"): string {
+ // scale using the device pixel ratio to keep images clear
+ width = Math.floor(width * window.devicePixelRatio);
+ height = Math.floor(height * window.devicePixelRatio);
return this.client.mxcUrlToHttp(this.srcMxc, width, height, mode);
}
@@ -117,6 +123,7 @@ export class Media {
* @returns {string} An HTTP URL for the thumbnail.
*/
public getSquareThumbnailHttp(dim: number): string {
+ dim = Math.floor(dim * window.devicePixelRatio); // scale using the device pixel ratio to keep images clear
if (this.hasThumbnail) {
return this.getThumbnailHttp(dim, dim, 'crop');
}
diff --git a/src/dispatcher/actions.ts b/src/dispatcher/actions.ts
index cd32c3743f..46c962f160 100644
--- a/src/dispatcher/actions.ts
+++ b/src/dispatcher/actions.ts
@@ -114,6 +114,9 @@ export enum Action {
*/
VirtualRoomSupportUpdated = "virtual_room_support_updated",
+ // Probably would be better to have a VoIP states in a store and have the store emit changes
+ CallChangeRoom = "call_change_room",
+
/**
* Fired when an upload has started. Should be used with UploadStartedPayload.
*/
diff --git a/src/editor/autocomplete.ts b/src/editor/autocomplete.ts
index 2f56494ea0..240ed2d96b 100644
--- a/src/editor/autocomplete.ts
+++ b/src/editor/autocomplete.ts
@@ -125,10 +125,8 @@ export default class AutocompleteWrapperModel {
case "at-room":
return [this.partCreator.atRoomPill(completionId), this.partCreator.plain(completion.suffix)];
case "user":
- // not using suffix here, because we also need to calculate
- // the suffix when clicking a display name to insert a mention,
- // which happens in createMentionParts
- return this.partCreator.createMentionParts(this.partIndex, text, completionId);
+ // Insert suffix only if the pill is the part with index 0 - we are at the start of the composer
+ return this.partCreator.createMentionParts(this.partIndex === 0, text, completionId);
case "command":
// command needs special handling for auto complete, but also renders as plain texts
return [(this.partCreator as CommandPartCreator).command(text)];
diff --git a/src/editor/parts.ts b/src/editor/parts.ts
index ccd90da3e2..02c5d64895 100644
--- a/src/editor/parts.ts
+++ b/src/editor/parts.ts
@@ -341,11 +341,7 @@ class RoomPillPart extends PillPart {
setAvatar(node: HTMLElement) {
let initialLetter = "";
- let avatarUrl = Avatar.avatarUrlForRoom(
- this.room,
- 16 * window.devicePixelRatio,
- 16 * window.devicePixelRatio,
- "crop");
+ let avatarUrl = Avatar.avatarUrlForRoom(this.room, 16, 16, "crop");
if (!avatarUrl) {
initialLetter = Avatar.getInitialLetter(this.room ? this.room.name : this.resourceId);
avatarUrl = Avatar.defaultAvatarUrlForString(this.room ? this.room.roomId : this.resourceId);
@@ -383,11 +379,7 @@ class UserPillPart extends PillPart {
}
const name = this.member.name || this.member.userId;
const defaultAvatarUrl = Avatar.defaultAvatarUrlForString(this.member.userId);
- const avatarUrl = Avatar.avatarUrlForMember(
- this.member,
- 16 * window.devicePixelRatio,
- 16 * window.devicePixelRatio,
- "crop");
+ const avatarUrl = Avatar.avatarUrlForMember(this.member, 16, 16, "crop");
let initialLetter = "";
if (avatarUrl === defaultAvatarUrl) {
initialLetter = Avatar.getInitialLetter(name);
@@ -543,9 +535,9 @@ export class PartCreator {
return new UserPillPart(userId, displayName, member);
}
- createMentionParts(partIndex: number, displayName: string, userId: string) {
+ createMentionParts(insertTrailingCharacter: boolean, displayName: string, userId: string) {
const pill = this.userPill(displayName, userId);
- const postfix = this.plain(partIndex === 0 ? ": " : " ");
+ const postfix = this.plain(insertTrailingCharacter ? ": " : " ");
return [pill, postfix];
}
}
diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
index 133d24e3c8..33f42765d2 100644
--- a/src/i18n/strings/en_EN.json
+++ b/src/i18n/strings/en_EN.json
@@ -658,7 +658,6 @@
"No homeserver URL provided": "No homeserver URL provided",
"Unexpected error resolving homeserver configuration": "Unexpected error resolving homeserver configuration",
"Unexpected error resolving identity server configuration": "Unexpected error resolving identity server configuration",
- "The message you are trying to send is too large.": "The message you are trying to send is too large.",
"This homeserver has hit its Monthly Active User limit.": "This homeserver has hit its Monthly Active User limit.",
"This homeserver has been blocked by its administrator.": "This homeserver has been blocked by its administrator.",
"This homeserver has exceeded one of its resource limits.": "This homeserver has exceeded one of its resource limits.",
@@ -900,6 +899,8 @@
"Incoming call": "Incoming call",
"Decline": "Decline",
"Accept": "Accept",
+ "Pause": "Pause",
+ "Play": "Play",
"The other party cancelled the verification.": "The other party cancelled the verification.",
"Verified!": "Verified!",
"You've successfully verified this user.": "You've successfully verified this user.",
@@ -1306,6 +1307,7 @@
"Cryptography": "Cryptography",
"Session ID:": "Session ID:",
"Session key:": "Session key:",
+ "You have no ignored users.": "You have no ignored users.",
"Bulk options": "Bulk options",
"Accept all %(invitedRooms)s invites": "Accept all %(invitedRooms)s invites",
"Reject all %(invitedRooms)s invites": "Reject all %(invitedRooms)s invites",
@@ -1453,6 +1455,7 @@
"Sending your message...": "Sending your message...",
"Encrypting your message...": "Encrypting your message...",
"Your message was sent": "Your message was sent",
+ "Failed to send": "Failed to send",
"Please select the destination room for this message": "Please select the destination room for this message",
"Scroll to most recent messages": "Scroll to most recent messages",
"Close preview": "Close preview",
@@ -1645,7 +1648,8 @@
"Jump to first unread message.": "Jump to first unread message.",
"Mark all as read": "Mark all as read",
"Record a voice message": "Record a voice message",
- "Stop & send recording": "Stop & send recording",
+ "Stop the recording": "Stop the recording",
+ "Delete recording": "Delete recording",
"Error updating main address": "Error updating main address",
"There was an error updating the room's main address. It may not be allowed by the server or a temporary failure occurred.": "There was an error updating the room's main address. It may not be allowed by the server or a temporary failure occurred.",
"There was an error updating the room's alternative addresses. It may not be allowed by the server or a temporary failure occurred.": "There was an error updating the room's alternative addresses. It may not be allowed by the server or a temporary failure occurred.",
@@ -1811,8 +1815,9 @@
"The encryption used by this room isn't supported.": "The encryption used by this room isn't supported.",
"Error decrypting audio": "Error decrypting audio",
"React": "React",
- "Reply": "Reply",
"Edit": "Edit",
+ "Retry": "Retry",
+ "Reply": "Reply",
"Message Actions": "Message Actions",
"Attachment": "Attachment",
"Error decrypting attachment": "Error decrypting attachment",
@@ -1916,11 +1921,17 @@
"Please create a new issue on GitHub so that we can investigate this bug.": "Please create a new issue on GitHub so that we can investigate this bug.",
"collapse": "collapse",
"expand": "expand",
+ "View all %(count)s members|other": "View all %(count)s members",
+ "View all %(count)s members|one": "View 1 member",
+ "Including %(commaSeparatedMembers)s": "Including %(commaSeparatedMembers)s",
+ "%(count)s members including %(commaSeparatedMembers)s|other": "%(count)s members including %(commaSeparatedMembers)s",
+ "%(count)s members including %(commaSeparatedMembers)s|one": "%(commaSeparatedMembers)s",
"%(count)s people you know have already joined|other": "%(count)s people you know have already joined",
- "Rotate Right": "Rotate Right",
- "Rotate Left": "Rotate Left",
+ "%(count)s people you know have already joined|one": "%(count)s person you know has already joined",
"Zoom out": "Zoom out",
"Zoom in": "Zoom in",
+ "Rotate Right": "Rotate Right",
+ "Rotate Left": "Rotate Left",
"Download": "Download",
"Information": "Information",
"View message": "View message",
@@ -2391,7 +2402,6 @@
"Confirm encryption setup": "Confirm encryption setup",
"Click the button below to confirm setting up encryption.": "Click the button below to confirm setting up encryption.",
"Unable to set up keys": "Unable to set up keys",
- "Retry": "Retry",
"Restoring keys from backup": "Restoring keys from backup",
"Fetching keys from server...": "Fetching keys from server...",
"%(completed)s of %(total)s keys restored": "%(completed)s of %(total)s keys restored",
@@ -2420,10 +2430,7 @@
"Reject invitation": "Reject invitation",
"Are you sure you want to reject the invitation?": "Are you sure you want to reject the invitation?",
"Unable to reject invite": "Unable to reject invite",
- "Resend edit": "Resend edit",
"Resend %(unsentCount)s reaction(s)": "Resend %(unsentCount)s reaction(s)",
- "Resend removal": "Resend removal",
- "Cancel Sending": "Cancel Sending",
"Forward Message": "Forward Message",
"Pin Message": "Pin Message",
"Unhide Preview": "Unhide Preview",
@@ -2611,10 +2618,11 @@
"Your message wasn't sent because this homeserver has hit its Monthly Active User Limit. Please contact your service administrator to continue using the service.": "Your message wasn't sent because this homeserver has hit its Monthly Active User Limit. Please contact your service administrator to continue using the service.",
"Your message wasn't sent because this homeserver has been blocked by it's administrator. Please contact your service administrator to continue using the service.": "Your message wasn't sent because this homeserver has been blocked by it's administrator. Please contact your service administrator to continue using the service.",
"Your message wasn't sent because this homeserver has exceeded a resource limit. Please contact your service administrator to continue using the service.": "Your message wasn't sent because this homeserver has exceeded a resource limit. Please contact your service administrator to continue using the service.",
- "%(count)s of your messages have not been sent.|other": "Some of your messages have not been sent.",
- "%(count)s of your messages have not been sent.|one": "Your message was not sent.",
- "%(count)s Resend all or cancel all now. You can also select individual messages to resend or cancel.|other": "Resend all or cancel all now. You can also select individual messages to resend or cancel.",
- "%(count)s Resend all or cancel all now. You can also select individual messages to resend or cancel.|one": "Resend message or cancel message now.",
+ "Some of your messages have not been sent": "Some of your messages have not been sent",
+ "Delete all": "Delete all",
+ "Retry all": "Retry all",
+ "Sending": "Sending",
+ "You can select all or individual messages to retry or delete": "You can select all or individual messages to retry or delete",
"Connectivity to the server has been lost.": "Connectivity to the server has been lost.",
"Sent messages will be stored until your connection has returned.": "Sent messages will be stored until your connection has returned.",
"You seem to be uploading files, are you sure you want to quit?": "You seem to be uploading files, are you sure you want to quit?",
@@ -2634,6 +2642,7 @@
"%(count)s rooms|one": "%(count)s room",
"This room is suggested as a good one to join": "This room is suggested as a good one to join",
"Suggested": "Suggested",
+ "Your server does not support showing space hierarchies.": "Your server does not support showing space hierarchies.",
"%(count)s rooms and %(numSpaces)s spaces|other": "%(count)s rooms and %(numSpaces)s spaces",
"%(count)s rooms and %(numSpaces)s spaces|one": "%(count)s room and %(numSpaces)s spaces",
"%(count)s rooms and 1 space|other": "%(count)s rooms and 1 space",
@@ -2644,7 +2653,6 @@
"Mark as suggested": "Mark as suggested",
"No results found": "No results found",
"You may want to try a different search or check for typos.": "You may want to try a different search or check for typos.",
- "Your server does not support showing space hierarchies.": "Your server does not support showing space hierarchies.",
"Search names and description": "Search names and description",
"If you can't find the room you're looking for, ask for an invite or create a new room.": "If you can't find the room you're looking for, ask for an invite or create a new room.",
"Create room": "Create room",
diff --git a/src/indexing/BaseEventIndexManager.ts b/src/indexing/BaseEventIndexManager.ts
index 2474406618..6349f31524 100644
--- a/src/indexing/BaseEventIndexManager.ts
+++ b/src/indexing/BaseEventIndexManager.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2019, 2020 The Matrix.org Foundation C.I.C.
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -133,6 +133,10 @@ export default abstract class BaseEventIndexManager {
throw new Error("Unimplemented");
}
+ async isEventIndexEmpty(): Promise {
+ throw new Error("Unimplemented");
+ }
+
/**
* Check if our event index is empty.
*/
diff --git a/src/indexing/EventIndexPeg.js b/src/indexing/EventIndexPeg.ts
similarity index 94%
rename from src/indexing/EventIndexPeg.js
rename to src/indexing/EventIndexPeg.ts
index 7004efc554..4356d882d5 100644
--- a/src/indexing/EventIndexPeg.js
+++ b/src/indexing/EventIndexPeg.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2019 The Matrix.org Foundation C.I.C.
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -27,12 +27,11 @@ import {SettingLevel} from "../settings/SettingLevel";
const INDEX_VERSION = 1;
-class EventIndexPeg {
- constructor() {
- this.index = null;
- this._supportIsInstalled = false;
- this.error = null;
- }
+export class EventIndexPeg {
+ public index: EventIndex = null;
+ public error: Error = null;
+
+ private _supportIsInstalled = false;
/**
* Initialize the EventIndexPeg and if event indexing is enabled initialize
@@ -181,7 +180,7 @@ class EventIndexPeg {
}
}
-if (!global.mxEventIndexPeg) {
- global.mxEventIndexPeg = new EventIndexPeg();
+if (!window.mxEventIndexPeg) {
+ window.mxEventIndexPeg = new EventIndexPeg();
}
-export default global.mxEventIndexPeg;
+export default window.mxEventIndexPeg;
diff --git a/src/mjolnir/BanList.js b/src/mjolnir/BanList.ts
similarity index 100%
rename from src/mjolnir/BanList.js
rename to src/mjolnir/BanList.ts
diff --git a/src/mjolnir/ListRule.js b/src/mjolnir/ListRule.ts
similarity index 100%
rename from src/mjolnir/ListRule.js
rename to src/mjolnir/ListRule.ts
diff --git a/src/mjolnir/Mjolnir.js b/src/mjolnir/Mjolnir.ts
similarity index 100%
rename from src/mjolnir/Mjolnir.js
rename to src/mjolnir/Mjolnir.ts
diff --git a/src/stores/SpaceStore.tsx b/src/stores/SpaceStore.tsx
index 7ee6067805..ec6227e45e 100644
--- a/src/stores/SpaceStore.tsx
+++ b/src/stores/SpaceStore.tsx
@@ -46,16 +46,13 @@ export const HOME_SPACE = Symbol("home-space");
export const SUGGESTED_ROOMS = Symbol("suggested-rooms");
export const UPDATE_TOP_LEVEL_SPACES = Symbol("top-level-spaces");
+export const UPDATE_INVITED_SPACES = Symbol("invited-spaces");
export const UPDATE_SELECTED_SPACE = Symbol("selected-space");
// Space Room ID/HOME_SPACE will be emitted when a Space's children change
const MAX_SUGGESTED_ROOMS = 20;
-const getLastViewedRoomsStorageKey = (space?: Room) => {
- const lastViewRooms = "mx_last_viewed_rooms";
- const homeSpace = "home_space";
- return `${lastViewRooms}_${space?.roomId || homeSpace}`;
-}
+const getSpaceContextKey = (space?: Room) => `mx_space_context_${space?.roomId || "home_space"}`;
const partitionSpacesAndRooms = (arr: Room[]): [Room[], Room[]] => { // [spaces, rooms]
return arr.reduce((result, room: Room) => {
@@ -97,6 +94,11 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
// The space currently selected in the Space Panel - if null then `Home` is selected
private _activeSpace?: Room = null;
private _suggestedRooms: ISpaceSummaryRoom[] = [];
+ private _invitedSpaces = new Set();
+
+ public get invitedSpaces(): Room[] {
+ return Array.from(this._invitedSpaces);
+ }
public get spacePanelSpaces(): Room[] {
return this.rootSpaces;
@@ -110,32 +112,39 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
return this._suggestedRooms;
}
- public async setActiveSpace(space: Room | null) {
- if (space === this.activeSpace) return;
+ public async setActiveSpace(space: Room | null, contextSwitch = true) {
+ if (space === this.activeSpace || (space && !space?.isSpaceRoom())) return;
this._activeSpace = space;
this.emit(UPDATE_SELECTED_SPACE, this.activeSpace);
this.emit(SUGGESTED_ROOMS, this._suggestedRooms = []);
- // view last selected room from space
- const roomId = window.localStorage.getItem(getLastViewedRoomsStorageKey(this.activeSpace));
+ if (contextSwitch) {
+ // view last selected room from space
+ const roomId = window.localStorage.getItem(getSpaceContextKey(this.activeSpace));
- if (roomId && this.matrixClient?.getRoom(roomId)?.getMyMembership() === "join") {
- defaultDispatcher.dispatch({
- action: "view_room",
- room_id: roomId,
- context_switch: true,
- });
- } else if (space) {
- defaultDispatcher.dispatch({
- action: "view_room",
- room_id: space.roomId,
- context_switch: true,
- });
- } else {
- defaultDispatcher.dispatch({
- action: "view_home_page",
- });
+ // if the space being selected is an invite then always view that invite
+ // else if the last viewed room in this space is joined then view that
+ // else view space home or home depending on what is being clicked on
+ if (space?.getMyMembership !== "invite" &&
+ this.matrixClient?.getRoom(roomId)?.getMyMembership() === "join"
+ ) {
+ defaultDispatcher.dispatch({
+ action: "view_room",
+ room_id: roomId,
+ context_switch: true,
+ });
+ } else if (space) {
+ defaultDispatcher.dispatch({
+ action: "view_room",
+ room_id: space.roomId,
+ context_switch: true,
+ });
+ } else {
+ defaultDispatcher.dispatch({
+ action: "view_home_page",
+ });
+ }
}
// persist space selected
@@ -186,7 +195,7 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
const childEvents = room?.currentState.getStateEvents(EventType.SpaceChild).filter(ev => ev.getContent()?.via);
return sortBy(childEvents, getOrder)
.map(ev => this.matrixClient.getRoom(ev.getStateKey()))
- .filter(room => room?.getMyMembership() === "join") || [];
+ .filter(room => room?.getMyMembership() === "join" || room?.getMyMembership() === "invite") || [];
}
public getChildRooms(spaceId: string): Room[] {
@@ -194,7 +203,8 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
}
public getChildSpaces(spaceId: string): Room[] {
- return this.getChildren(spaceId).filter(r => r.isSpaceRoom());
+ // don't show invited subspaces as they surface at the top level for better visibility
+ return this.getChildren(spaceId).filter(r => r.isSpaceRoom() && r.getMyMembership() === "join");
}
public getParents(roomId: string, canonicalOnly = false): Room[] {
@@ -216,25 +226,27 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
return sortBy(parents, r => r.roomId)?.[0] || null;
}
- public getSpaces = () => {
- return this.matrixClient.getRooms().filter(r => r.isSpaceRoom() && r.getMyMembership() === "join");
- };
-
public getSpaceFilteredRoomIds = (space: Room | null): Set => {
return this.spaceFilteredRooms.get(space?.roomId || HOME_SPACE) || new Set();
};
private rebuild = throttle(() => {
- // get all most-upgraded rooms & spaces except spaces which have been left (historical)
- const visibleRooms = this.matrixClient.getVisibleRooms().filter(r => {
- return !r.isSpaceRoom() || r.getMyMembership() === "join";
- });
+ const [visibleSpaces, visibleRooms] = partitionSpacesAndRooms(this.matrixClient.getVisibleRooms());
+ const [joinedSpaces, invitedSpaces] = visibleSpaces.reduce((arr, s) => {
+ if (s.getMyMembership() === "join") {
+ arr[0].push(s);
+ } else if (s.getMyMembership() === "invite") {
+ arr[1].push(s);
+ }
+ return arr;
+ }, [[], []]);
- const unseenChildren = new Set(visibleRooms);
+ // exclude invited spaces from unseenChildren as they will be forcibly shown at the top level of the treeview
+ const unseenChildren = new Set([...visibleRooms, ...joinedSpaces]);
const backrefs = new EnhancedMap>();
// Sort spaces by room ID to force the cycle breaking to be deterministic
- const spaces = sortBy(visibleRooms.filter(r => r.isSpaceRoom()), space => space.roomId);
+ const spaces = sortBy(joinedSpaces, space => space.roomId);
// TODO handle cleaning up links when a Space is removed
spaces.forEach(space => {
@@ -298,6 +310,10 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
this.onRoomsUpdate(); // TODO only do this if a change has happened
this.emit(UPDATE_TOP_LEVEL_SPACES, this.spacePanelSpaces);
+
+ // build initial state of invited spaces as we would have missed the emitted events about the room at launch
+ this._invitedSpaces = new Set(invitedSpaces);
+ this.emit(UPDATE_INVITED_SPACES, this.invitedSpaces);
}, 100, {trailing: true, leading: true});
onSpaceUpdate = () => {
@@ -305,6 +321,7 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
}
private showInHomeSpace = (room: Room) => {
+ if (room.isSpaceRoom()) return false;
return !this.parentMap.get(room.roomId)?.size // put all orphaned rooms in the Home Space
|| DMRoomMap.shared().getUserIdForRoomId(room.roomId) // put all DMs in the Home Space
|| RoomListStore.instance.getTagsForRoom(room).includes(DefaultTagID.Favourite) // show all favourites
@@ -335,8 +352,8 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
const oldFilteredRooms = this.spaceFilteredRooms;
this.spaceFilteredRooms = new Map();
- // put all invites (rooms & spaces) in the Home Space
- const invites = this.matrixClient.getRooms().filter(r => r.getMyMembership() === "invite");
+ // put all room invites in the Home Space
+ const invites = visibleRooms.filter(r => !r.isSpaceRoom() && r.getMyMembership() === "invite");
this.spaceFilteredRooms.set(HOME_SPACE, new Set(invites.map(room => room.roomId)));
visibleRooms.forEach(room => {
@@ -389,31 +406,43 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
this.spaceFilteredRooms.forEach((roomIds, s) => {
// Update NotificationStates
- const rooms = this.matrixClient.getRooms().filter(room => roomIds.has(room.roomId));
- this.getNotificationState(s)?.setRooms(rooms);
+ this.getNotificationState(s)?.setRooms(visibleRooms.filter(room => roomIds.has(room.roomId)));
});
}, 100, {trailing: true, leading: true});
- private onRoom = (room: Room) => {
- if (room?.isSpaceRoom()) {
- this.onSpaceUpdate();
- this.emit(room.roomId);
- } else {
+ private onRoom = (room: Room, newMembership?: string, oldMembership?: string) => {
+ const membership = newMembership || room.getMyMembership();
+
+ if (!room.isSpaceRoom()) {
// this.onRoomUpdate(room);
this.onRoomsUpdate();
- }
- if (room.getMyMembership() === "join") {
- if (!room.isSpaceRoom()) {
+ if (membership === "join") {
+ // the user just joined a room, remove it from the suggested list if it was there
const numSuggestedRooms = this._suggestedRooms.length;
this._suggestedRooms = this._suggestedRooms.filter(r => r.room_id !== room.roomId);
if (numSuggestedRooms !== this._suggestedRooms.length) {
this.emit(SUGGESTED_ROOMS, this._suggestedRooms);
}
- } else if (room.roomId === RoomViewStore.getRoomId()) {
- // if the user was looking at the space and then joined: select that space
- this.setActiveSpace(room);
}
+ return;
+ }
+
+ // Space
+ if (membership === "invite") {
+ this._invitedSpaces.add(room);
+ this.emit(UPDATE_INVITED_SPACES, this.invitedSpaces);
+ } else if (oldMembership === "invite" && membership !== "join") {
+ this._invitedSpaces.delete(room);
+ this.emit(UPDATE_INVITED_SPACES, this.invitedSpaces);
+ } else {
+ this.onSpaceUpdate();
+ this.emit(room.roomId);
+ }
+
+ if (membership === "join" && room.roomId === RoomViewStore.getRoomId()) {
+ // if the user was looking at the space and then joined: select that space
+ this.setActiveSpace(room);
}
};
@@ -477,6 +506,17 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
}
};
+ protected async reset() {
+ this.rootSpaces = [];
+ this.orphanedRooms = new Set();
+ this.parentMap = new EnhancedMap();
+ this.notificationStateMap = new Map();
+ this.spaceFilteredRooms = new Map();
+ this._activeSpace = null;
+ this._suggestedRooms = [];
+ this._invitedSpaces = new Set();
+ }
+
protected async onNotReady() {
if (!SettingsStore.getValue("feature_spaces")) return;
if (this.matrixClient) {
@@ -486,7 +526,7 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
this.matrixClient.removeListener("Room.accountData", this.onRoomAccountData);
this.matrixClient.removeListener("accountData", this.onAccountData);
}
- await this.reset({});
+ await this.reset();
}
protected async onReady() {
@@ -517,37 +557,29 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
// Don't auto-switch rooms when reacting to a context-switch
// as this is not helpful and can create loops of rooms/space switching
- if (payload.context_switch) break;
+ if (!room || payload.context_switch) break;
- // persist last viewed room from a space
-
- // Don't save if the room is a space room. This would cause a problem:
- // When switching to a space home, we first view that room and
- // only after that we switch to that space. This causes us to
- // save the space home to be the last viewed room in the home
- // space.
- if (room && !room.isSpaceRoom()) {
- window.localStorage.setItem(getLastViewedRoomsStorageKey(this.activeSpace), payload.room_id);
- }
-
- if (room?.getMyMembership() === "join") {
- if (room.isSpaceRoom()) {
- this.setActiveSpace(room);
- } else if (!this.spaceFilteredRooms.get(this._activeSpace?.roomId || HOME_SPACE).has(room.roomId)) {
- // TODO maybe reverse these first 2 clauses once space panel active is fixed
- let parent = this.rootSpaces.find(s => this.spaceFilteredRooms.get(s.roomId)?.has(room.roomId));
- if (!parent) {
- parent = this.getCanonicalParent(room.roomId);
- }
- if (!parent) {
- const parents = Array.from(this.parentMap.get(room.roomId) || []);
- parent = parents.find(p => this.matrixClient.getRoom(p));
- }
- if (parent) {
- this.setActiveSpace(parent);
- }
+ if (room.isSpaceRoom()) {
+ // Don't context switch when navigating to the space room
+ // as it will cause you to end up in the wrong room
+ this.setActiveSpace(room, false);
+ } else if (!this.getSpaceFilteredRoomIds(this.activeSpace).has(room.roomId)) {
+ let parent = this.getCanonicalParent(room.roomId);
+ if (!parent) {
+ parent = this.rootSpaces.find(s => this.spaceFilteredRooms.get(s.roomId)?.has(room.roomId));
}
+ if (!parent) {
+ const parents = Array.from(this.parentMap.get(room.roomId) || []);
+ parent = parents.find(p => this.matrixClient.getRoom(p));
+ }
+ // don't trigger a context switch when we are switching a space to match the chosen room
+ this.setActiveSpace(parent || null, false);
}
+
+ // Persist last viewed room from a space
+ // we don't await setActiveSpace above as we only care about this.activeSpace being up to date
+ // synchronously for the below code - everything else can and should be async.
+ window.localStorage.setItem(getSpaceContextKey(this.activeSpace), payload.room_id);
break;
}
case "after_leave_room":
@@ -568,7 +600,9 @@ export class SpaceStoreClass extends AsyncStoreWithClient {
return state;
}
- // traverse space tree with DFS calling fn on each space including the given root one
+ // traverse space tree with DFS calling fn on each space including the given root one,
+ // if includeRooms is true then fn will be called on each leaf room, if it is present in multiple sub-spaces
+ // then fn will be called with it multiple times.
public traverseSpace(
spaceId: string,
fn: (roomId: string) => void,
diff --git a/src/stores/TypingStore.js b/src/stores/TypingStore.ts
similarity index 84%
rename from src/stores/TypingStore.js
rename to src/stores/TypingStore.ts
index e86d698eac..d5177a33a0 100644
--- a/src/stores/TypingStore.js
+++ b/src/stores/TypingStore.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2019 The Matrix.org Foundation C.I.C.
+Copyright 2019, 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -25,15 +25,23 @@ const TYPING_SERVER_TIMEOUT = 30000;
* Tracks typing state for users.
*/
export default class TypingStore {
+ private typingStates: {
+ [roomId: string]: {
+ isTyping: boolean,
+ userTimer: Timer,
+ serverTimer: Timer,
+ },
+ };
+
constructor() {
this.reset();
}
static sharedInstance(): TypingStore {
- if (global.mxTypingStore === undefined) {
- global.mxTypingStore = new TypingStore();
+ if (window.mxTypingStore === undefined) {
+ window.mxTypingStore = new TypingStore();
}
- return global.mxTypingStore;
+ return window.mxTypingStore;
}
/**
@@ -41,7 +49,7 @@ export default class TypingStore {
* MatrixClientPeg client changes.
*/
reset() {
- this._typingStates = {
+ this.typingStates = {
// "roomId": {
// isTyping: bool, // Whether the user is typing or not
// userTimer: Timer, // Local timeout for "user has stopped typing"
@@ -59,14 +67,14 @@ export default class TypingStore {
if (!SettingsStore.getValue('sendTypingNotifications')) return;
if (SettingsStore.getValue('lowBandwidth')) return;
- let currentTyping = this._typingStates[roomId];
+ let currentTyping = this.typingStates[roomId];
if ((!isTyping && !currentTyping) || (currentTyping && currentTyping.isTyping === isTyping)) {
// No change in state, so don't do anything. We'll let the timer run its course.
return;
}
if (!currentTyping) {
- currentTyping = this._typingStates[roomId] = {
+ currentTyping = this.typingStates[roomId] = {
isTyping: isTyping,
serverTimer: new Timer(TYPING_SERVER_TIMEOUT),
userTimer: new Timer(TYPING_USER_TIMEOUT),
@@ -78,7 +86,7 @@ export default class TypingStore {
if (isTyping) {
if (!currentTyping.serverTimer.isRunning()) {
currentTyping.serverTimer.restart().finished().then(() => {
- const currentTyping = this._typingStates[roomId];
+ const currentTyping = this.typingStates[roomId];
if (currentTyping) currentTyping.isTyping = false;
// The server will (should) time us out on typing, so we don't
diff --git a/src/stores/VoiceRecordingStore.ts b/src/stores/VoiceRecordingStore.ts
index cc999f23f8..8ee44359fb 100644
--- a/src/stores/VoiceRecordingStore.ts
+++ b/src/stores/VoiceRecordingStore.ts
@@ -78,3 +78,5 @@ export class VoiceRecordingStore extends AsyncStoreWithClient {
return this.updateState({recording: null});
}
}
+
+window.mxVoiceRecordingStore = VoiceRecordingStore.instance;
diff --git a/src/stores/WidgetEchoStore.js b/src/stores/WidgetEchoStore.ts
similarity index 71%
rename from src/stores/WidgetEchoStore.js
rename to src/stores/WidgetEchoStore.ts
index 3aef1beb3e..09120d6108 100644
--- a/src/stores/WidgetEchoStore.js
+++ b/src/stores/WidgetEchoStore.ts
@@ -1,6 +1,5 @@
/*
-Copyright 2018 New Vector Ltd
-Copyright 2019 The Matrix.org Foundation C.I.C.
+Copyright 2018-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -16,6 +15,8 @@ limitations under the License.
*/
import EventEmitter from 'events';
+import { IWidget } from 'matrix-widget-api';
+import MatrixEvent from "matrix-js-sdk/src/models/event";
import {WidgetType} from "../widgets/WidgetType";
/**
@@ -23,14 +24,20 @@ import {WidgetType} from "../widgets/WidgetType";
* proxying through state from the js-sdk.
*/
class WidgetEchoStore extends EventEmitter {
+ private roomWidgetEcho: {
+ [roomId: string]: {
+ [widgetId: string]: IWidget,
+ },
+ };
+
constructor() {
super();
- this._roomWidgetEcho = {
+ this.roomWidgetEcho = {
// Map as below. Object is the content of the widget state event,
// so for widgets that have been deleted locally, the object is empty.
// roomId: {
- // widgetId: [object]
+ // widgetId: IWidget
// }
};
}
@@ -42,14 +49,14 @@ class WidgetEchoStore extends EventEmitter {
* and we don't really need the actual widget events anyway since we just want to
* show a spinner / prevent widgets being added twice.
*
- * @param {Room} roomId The ID of the room to get widgets for
+ * @param {string} roomId The ID of the room to get widgets for
* @param {MatrixEvent[]} currentRoomWidgets Current widgets for the room
* @returns {MatrixEvent[]} List of widgets in the room, minus any pending removal
*/
- getEchoedRoomWidgets(roomId, currentRoomWidgets) {
+ getEchoedRoomWidgets(roomId: string, currentRoomWidgets: MatrixEvent[]): MatrixEvent[] {
const echoedWidgets = [];
- const roomEchoState = Object.assign({}, this._roomWidgetEcho[roomId]);
+ const roomEchoState = Object.assign({}, this.roomWidgetEcho[roomId]);
for (const w of currentRoomWidgets) {
const widgetId = w.getStateKey();
@@ -65,8 +72,8 @@ class WidgetEchoStore extends EventEmitter {
return echoedWidgets;
}
- roomHasPendingWidgetsOfType(roomId, currentRoomWidgets, type: WidgetType) {
- const roomEchoState = Object.assign({}, this._roomWidgetEcho[roomId]);
+ roomHasPendingWidgetsOfType(roomId: string, currentRoomWidgets: MatrixEvent[], type?: WidgetType): boolean {
+ const roomEchoState = Object.assign({}, this.roomWidgetEcho[roomId]);
// any widget IDs that are already in the room are not pending, so
// echoes for them don't count as pending.
@@ -85,20 +92,20 @@ class WidgetEchoStore extends EventEmitter {
}
}
- roomHasPendingWidgets(roomId, currentRoomWidgets) {
+ roomHasPendingWidgets(roomId: string, currentRoomWidgets: MatrixEvent[]): boolean {
return this.roomHasPendingWidgetsOfType(roomId, currentRoomWidgets);
}
- setRoomWidgetEcho(roomId, widgetId, state) {
- if (this._roomWidgetEcho[roomId] === undefined) this._roomWidgetEcho[roomId] = {};
+ setRoomWidgetEcho(roomId: string, widgetId: string, state: IWidget) {
+ if (this.roomWidgetEcho[roomId] === undefined) this.roomWidgetEcho[roomId] = {};
- this._roomWidgetEcho[roomId][widgetId] = state;
+ this.roomWidgetEcho[roomId][widgetId] = state;
this.emit('update', roomId, widgetId);
}
- removeRoomWidgetEcho(roomId, widgetId) {
- delete this._roomWidgetEcho[roomId][widgetId];
- if (Object.keys(this._roomWidgetEcho[roomId]).length === 0) delete this._roomWidgetEcho[roomId];
+ removeRoomWidgetEcho(roomId: string, widgetId: string) {
+ delete this.roomWidgetEcho[roomId][widgetId];
+ if (Object.keys(this.roomWidgetEcho[roomId]).length === 0) delete this.roomWidgetEcho[roomId];
this.emit('update', roomId, widgetId);
}
}
diff --git a/src/stores/notifications/StaticNotificationState.ts b/src/stores/notifications/StaticNotificationState.ts
index 0392ed3716..b18aa78e0f 100644
--- a/src/stores/notifications/StaticNotificationState.ts
+++ b/src/stores/notifications/StaticNotificationState.ts
@@ -18,6 +18,8 @@ import { NotificationColor } from "./NotificationColor";
import { NotificationState } from "./NotificationState";
export class StaticNotificationState extends NotificationState {
+ public static readonly RED_EXCLAMATION = StaticNotificationState.forSymbol("!", NotificationColor.Red);
+
constructor(symbol: string, count: number, color: NotificationColor) {
super();
this._symbol = symbol;
diff --git a/src/stores/room-list/RoomListStore.ts b/src/stores/room-list/RoomListStore.ts
index 88df05b5d0..caab46a0c2 100644
--- a/src/stores/room-list/RoomListStore.ts
+++ b/src/stores/room-list/RoomListStore.ts
@@ -599,11 +599,7 @@ export class RoomListStoreClass extends AsyncStoreWithClient {
private getPlausibleRooms(): Room[] {
if (!this.matrixClient) return [];
- let rooms = [
- ...this.matrixClient.getVisibleRooms(),
- // also show space invites in the room list
- ...this.matrixClient.getRooms().filter(r => r.isSpaceRoom() && r.getMyMembership() === "invite"),
- ].filter(r => VisibilityProvider.instance.isRoomVisible(r));
+ let rooms = this.matrixClient.getVisibleRooms().filter(r => VisibilityProvider.instance.isRoomVisible(r));
if (this.prefilterConditions.length > 0) {
rooms = rooms.filter(r => {
diff --git a/src/stores/room-list/filters/VisibilityProvider.ts b/src/stores/room-list/filters/VisibilityProvider.ts
index 388bb061e3..f212b1f9d9 100644
--- a/src/stores/room-list/filters/VisibilityProvider.ts
+++ b/src/stores/room-list/filters/VisibilityProvider.ts
@@ -37,7 +37,11 @@ export class VisibilityProvider {
await VoipUserMapper.sharedInstance().onNewInvitedRoom(room);
}
- public isRoomVisible(room: Room): boolean {
+ public isRoomVisible(room?: Room): boolean {
+ if (!room) {
+ return false;
+ }
+
if (
CallHandler.sharedInstance().getSupportsVirtualRooms() &&
VoipUserMapper.sharedInstance().isVirtualRoom(room)
diff --git a/src/stores/room-list/previews/MessageEventPreview.ts b/src/stores/room-list/previews/MessageEventPreview.ts
index deed7dcf2c..b900afc13f 100644
--- a/src/stores/room-list/previews/MessageEventPreview.ts
+++ b/src/stores/room-list/previews/MessageEventPreview.ts
@@ -20,7 +20,7 @@ import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import { _t } from "../../../languageHandler";
import { getSenderName, isSelf, shouldPrefixMessagesIn } from "./utils";
import ReplyThread from "../../../components/views/elements/ReplyThread";
-import { sanitizedHtmlNodeInnerText } from "../../../HtmlUtils";
+import { getHtmlText } from "../../../HtmlUtils";
export class MessageEventPreview implements IPreview {
public getTextFor(event: MatrixEvent, tagId?: TagID): string {
@@ -55,7 +55,7 @@ export class MessageEventPreview implements IPreview {
}
if (hasHtml) {
- body = sanitizedHtmlNodeInnerText(body);
+ body = getHtmlText(body);
}
if (msgtype === 'm.emote') {
diff --git a/src/utils/AutoDiscoveryUtils.js b/src/utils/AutoDiscoveryUtils.tsx
similarity index 91%
rename from src/utils/AutoDiscoveryUtils.js
rename to src/utils/AutoDiscoveryUtils.tsx
index 614aa4cea8..e3a7fd2d0b 100644
--- a/src/utils/AutoDiscoveryUtils.js
+++ b/src/utils/AutoDiscoveryUtils.tsx
@@ -1,6 +1,5 @@
/*
-Copyright 2019 New Vector Ltd
-Copyright 2019, 2020 The Matrix.org Foundation C.I.C.
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,13 +14,13 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import React from 'react';
+import React, { ReactNode } from 'react';
import {AutoDiscovery} from "matrix-js-sdk/src/autodiscovery";
import {_t, _td, newTranslatableError} from "../languageHandler";
import {makeType} from "./TypeUtils";
import SdkConfig from '../SdkConfig';
-const LIVELINESS_DISCOVERY_ERRORS = [
+const LIVELINESS_DISCOVERY_ERRORS: string[] = [
AutoDiscovery.ERROR_INVALID_HOMESERVER,
AutoDiscovery.ERROR_INVALID_IDENTITY_SERVER,
];
@@ -40,17 +39,23 @@ export class ValidatedServerConfig {
warning: string;
}
+export interface IAuthComponentState {
+ serverIsAlive: boolean;
+ serverErrorIsFatal: boolean;
+ serverDeadError?: ReactNode;
+}
+
export default class AutoDiscoveryUtils {
/**
* Checks if a given error or error message is considered an error
* relating to the liveliness of the server. Must be an error returned
* from this AutoDiscoveryUtils class.
- * @param {string|Error} error The error to check
+ * @param {string | Error} error The error to check
* @returns {boolean} True if the error is a liveliness error.
*/
- static isLivelinessError(error: string|Error): boolean {
+ static isLivelinessError(error: string | Error): boolean {
if (!error) return false;
- return !!LIVELINESS_DISCOVERY_ERRORS.find(e => e === error || e === error.message);
+ return !!LIVELINESS_DISCOVERY_ERRORS.find(e => typeof error === "string" ? e === error : e === error.message);
}
/**
@@ -61,7 +66,7 @@ export default class AutoDiscoveryUtils {
* implementation for known values.
* @returns {*} The state for the component, given the error.
*/
- static authComponentStateForError(err: string | Error | null, pageName = "login"): Object {
+ static authComponentStateForError(err: string | Error | null, pageName = "login"): IAuthComponentState {
if (!err) {
return {
serverIsAlive: true,
@@ -70,7 +75,7 @@ export default class AutoDiscoveryUtils {
};
}
let title = _t("Cannot reach homeserver");
- let body = _t("Ensure you have a stable internet connection, or get in touch with the server admin");
+ let body: ReactNode = _t("Ensure you have a stable internet connection, or get in touch with the server admin");
if (!AutoDiscoveryUtils.isLivelinessError(err)) {
const brand = SdkConfig.get().brand;
title = _t("Your %(brand)s is misconfigured", { brand });
@@ -92,7 +97,7 @@ export default class AutoDiscoveryUtils {
}
let isFatalError = true;
- const errorMessage = err.message ? err.message : err;
+ const errorMessage = typeof err === "string" ? err : err.message;
if (errorMessage === AutoDiscovery.ERROR_INVALID_IDENTITY_SERVER) {
isFatalError = false;
title = _t("Cannot reach identity server");
@@ -141,7 +146,10 @@ export default class AutoDiscoveryUtils {
* @returns {Promise} Resolves to the validated configuration.
*/
static async validateServerConfigWithStaticUrls(
- homeserverUrl: string, identityUrl: string, syntaxOnly = false): ValidatedServerConfig {
+ homeserverUrl: string,
+ identityUrl?: string,
+ syntaxOnly = false,
+ ): Promise {
if (!homeserverUrl) {
throw newTranslatableError(_td("No homeserver URL provided"));
}
@@ -171,7 +179,7 @@ export default class AutoDiscoveryUtils {
* @param {string} serverName The homeserver domain name (eg: "matrix.org") to validate.
* @returns {Promise} Resolves to the validated configuration.
*/
- static async validateServerName(serverName: string): ValidatedServerConfig {
+ static async validateServerName(serverName: string): Promise {
const result = await AutoDiscovery.findClientConfig(serverName);
return AutoDiscoveryUtils.buildValidatedConfigFromDiscovery(serverName, result);
}
diff --git a/src/utils/DMRoomMap.ts b/src/utils/DMRoomMap.ts
index e49b74c380..b166674043 100644
--- a/src/utils/DMRoomMap.ts
+++ b/src/utils/DMRoomMap.ts
@@ -55,6 +55,15 @@ export default class DMRoomMap {
return DMRoomMap.sharedInstance;
}
+ /**
+ * Set the shared instance to the instance supplied
+ * Used by tests
+ * @param inst the new shared instance
+ */
+ public static setShared(inst: DMRoomMap) {
+ DMRoomMap.sharedInstance = inst;
+ }
+
/**
* Returns a shared instance of the class
* that uses the singleton matrix client
diff --git a/src/utils/ErrorUtils.js b/src/utils/ErrorUtils.js
index 2c6acd5503..b5bd5b0af0 100644
--- a/src/utils/ErrorUtils.js
+++ b/src/utils/ErrorUtils.js
@@ -49,12 +49,6 @@ export function messageForResourceLimitError(limitType, adminContact, strings, e
}
}
-export function messageForSendError(errorData) {
- if (errorData.errcode === "M_TOO_LARGE") {
- return _t("The message you are trying to send is too large.");
- }
-}
-
export function messageForSyncError(err) {
if (err.errcode === 'M_RESOURCE_LIMIT_EXCEEDED') {
const limitError = messageForResourceLimitError(
diff --git a/src/utils/MatrixGlob.js b/src/utils/MatrixGlob.ts
similarity index 100%
rename from src/utils/MatrixGlob.js
rename to src/utils/MatrixGlob.ts
diff --git a/src/utils/Mouse.ts b/src/utils/Mouse.ts
new file mode 100644
index 0000000000..a85c6492c4
--- /dev/null
+++ b/src/utils/Mouse.ts
@@ -0,0 +1,50 @@
+/*
+Copyright 2021 Šimon Brandner
+
+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.
+*/
+
+/**
+ * Different browsers use different deltaModes. This causes different behaviour.
+ * To avoid that we use this function to convert any event to pixels.
+ * @param {WheelEvent} event to normalize
+ * @returns {WheelEvent} normalized event event
+ */
+export function normalizeWheelEvent(event: WheelEvent): WheelEvent {
+ const LINE_HEIGHT = 18;
+
+ let deltaX;
+ let deltaY;
+ let deltaZ;
+
+ if (event.deltaMode === 1) { // Units are lines
+ deltaX = (event.deltaX * LINE_HEIGHT);
+ deltaY = (event.deltaY * LINE_HEIGHT);
+ deltaZ = (event.deltaZ * LINE_HEIGHT);
+ } else {
+ deltaX = event.deltaX;
+ deltaY = event.deltaY;
+ deltaZ = event.deltaZ;
+ }
+
+ return new WheelEvent(
+ "syntheticWheel",
+ {
+ deltaMode: 0,
+ deltaY: deltaY,
+ deltaX: deltaX,
+ deltaZ: deltaZ,
+ ...event,
+ },
+ );
+}
diff --git a/src/utils/StorageManager.js b/src/utils/StorageManager.ts
similarity index 96%
rename from src/utils/StorageManager.js
rename to src/utils/StorageManager.ts
index 23c27a2d1c..883c032771 100644
--- a/src/utils/StorageManager.js
+++ b/src/utils/StorageManager.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2019 New Vector Ltd
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -32,15 +32,15 @@ try {
const SYNC_STORE_NAME = "riot-web-sync";
const CRYPTO_STORE_NAME = "matrix-js-sdk:crypto";
-function log(msg) {
+function log(msg: string) {
console.log(`StorageManager: ${msg}`);
}
-function error(msg) {
- console.error(`StorageManager: ${msg}`);
+function error(msg: string, ...args: string[]) {
+ console.error(`StorageManager: ${msg}`, ...args);
}
-function track(action) {
+function track(action: string) {
Analytics.trackEvent("StorageManager", action);
}
@@ -73,7 +73,7 @@ export async function checkConsistency() {
dataInLocalStorage = localStorage.length > 0;
log(`Local storage contains data? ${dataInLocalStorage}`);
- cryptoInited = localStorage.getItem("mx_crypto_initialised");
+ cryptoInited = !!localStorage.getItem("mx_crypto_initialised");
log(`Crypto initialised? ${cryptoInited}`);
} else {
healthy = false;
diff --git a/src/utils/Timer.js b/src/utils/Timer.ts
similarity index 60%
rename from src/utils/Timer.js
rename to src/utils/Timer.ts
index ca06237fbf..9760631d09 100644
--- a/src/utils/Timer.js
+++ b/src/utils/Timer.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2018 New Vector Ltd
+Copyright 2018, 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -26,44 +26,48 @@ Once a timer is finished or aborted, it can't be started again
a new one through `clone()` or `cloneIfRun()`.
*/
export default class Timer {
- constructor(timeout) {
- this._timeout = timeout;
- this._onTimeout = this._onTimeout.bind(this);
- this._setNotStarted();
+ private timerHandle: NodeJS.Timeout;
+ private startTs: number;
+ private promise: Promise;
+ private resolve: () => void;
+ private reject: (Error) => void;
+
+ constructor(private timeout: number) {
+ this.setNotStarted();
}
- _setNotStarted() {
- this._timerHandle = null;
- this._startTs = null;
- this._promise = new Promise((resolve, reject) => {
- this._resolve = resolve;
- this._reject = reject;
+ private setNotStarted() {
+ this.timerHandle = null;
+ this.startTs = null;
+ this.promise = new Promise((resolve, reject) => {
+ this.resolve = resolve;
+ this.reject = reject;
}).finally(() => {
- this._timerHandle = null;
+ this.timerHandle = null;
});
}
- _onTimeout() {
+ private onTimeout = () => {
const now = Date.now();
- const elapsed = now - this._startTs;
- if (elapsed >= this._timeout) {
- this._resolve();
- this._setNotStarted();
+ const elapsed = now - this.startTs;
+ if (elapsed >= this.timeout) {
+ this.resolve();
+ this.setNotStarted();
} else {
- const delta = this._timeout - elapsed;
- this._timerHandle = setTimeout(this._onTimeout, delta);
+ const delta = this.timeout - elapsed;
+ this.timerHandle = setTimeout(this.onTimeout, delta);
}
}
- changeTimeout(timeout) {
- if (timeout === this._timeout) {
+ changeTimeout(timeout: number) {
+ if (timeout === this.timeout) {
return;
}
- const isSmallerTimeout = timeout < this._timeout;
- this._timeout = timeout;
+ const isSmallerTimeout = timeout < this.timeout;
+ this.timeout = timeout;
if (this.isRunning() && isSmallerTimeout) {
- clearTimeout(this._timerHandle);
- this._onTimeout();
+ clearTimeout(this.timerHandle);
+ this.onTimeout();
}
}
@@ -73,8 +77,8 @@ export default class Timer {
*/
start() {
if (!this.isRunning()) {
- this._startTs = Date.now();
- this._timerHandle = setTimeout(this._onTimeout, this._timeout);
+ this.startTs = Date.now();
+ this.timerHandle = setTimeout(this.onTimeout, this.timeout);
}
return this;
}
@@ -89,7 +93,7 @@ export default class Timer {
// can be called in fast succession,
// instead just take note and compare
// when the already running timeout expires
- this._startTs = Date.now();
+ this.startTs = Date.now();
return this;
} else {
return this.start();
@@ -103,9 +107,9 @@ export default class Timer {
*/
abort() {
if (this.isRunning()) {
- clearTimeout(this._timerHandle);
- this._reject(new Error("Timer was aborted."));
- this._setNotStarted();
+ clearTimeout(this.timerHandle);
+ this.reject(new Error("Timer was aborted."));
+ this.setNotStarted();
}
return this;
}
@@ -116,10 +120,10 @@ export default class Timer {
*@return {Promise}
*/
finished() {
- return this._promise;
+ return this.promise;
}
isRunning() {
- return this._timerHandle !== null;
+ return this.timerHandle !== null;
}
}
diff --git a/src/utils/TypeUtils.js b/src/utils/TypeUtils.ts
similarity index 100%
rename from src/utils/TypeUtils.js
rename to src/utils/TypeUtils.ts
diff --git a/src/utils/arrays.ts b/src/utils/arrays.ts
index 52308937f7..f7e693452b 100644
--- a/src/utils/arrays.ts
+++ b/src/utils/arrays.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2020 The Matrix.org Foundation C.I.C.
+Copyright 2020, 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,23 +15,47 @@ limitations under the License.
*/
/**
- * Quickly resample an array to have less data points. This isn't a perfect representation,
- * though this does work best if given a large array to downsample to a much smaller array.
- * @param {number[]} input The input array to downsample.
+ * Quickly resample an array to have less/more data points. If an input which is larger
+ * than the desired size is provided, it will be downsampled. Similarly, if the input
+ * is smaller than the desired size then it will be upsampled.
+ * @param {number[]} input The input array to resample.
* @param {number} points The number of samples to end up with.
- * @returns {number[]} The downsampled array.
+ * @returns {number[]} The resampled array.
*/
export function arrayFastResample(input: number[], points: number): number[] {
- // Heavily inpired by matrix-media-repo (used with permission)
+ if (input.length === points) return input; // short-circuit a complicated call
+
+ // Heavily inspired by matrix-media-repo (used with permission)
// https://github.com/turt2live/matrix-media-repo/blob/abe72c87d2e29/util/util_audio/fastsample.go#L10
- const everyNth = Math.round(input.length / points);
- const samples: number[] = [];
- for (let i = 0; i < input.length; i += everyNth) {
- samples.push(input[i]);
+ let samples: number[] = [];
+ if (input.length > points) {
+ // Danger: this loop can cause out of memory conditions if the input is too small.
+ const everyNth = Math.round(input.length / points);
+ for (let i = 0; i < input.length; i += everyNth) {
+ samples.push(input[i]);
+ }
+ } else {
+ // Smaller inputs mean we have to spread the values over the desired length. We
+ // end up overshooting the target length in doing this, so we'll resample down
+ // before returning. This recursion is risky, but mathematically should not go
+ // further than 1 level deep.
+ const spreadFactor = Math.ceil(points / input.length);
+ for (const val of input) {
+ samples.push(...arraySeed(val, spreadFactor));
+ }
+ samples = arrayFastResample(samples, points);
}
+
+ // Sanity fill, just in case
while (samples.length < points) {
samples.push(input[input.length - 1]);
}
+
+ // Sanity trim, just in case
+ if (samples.length > points) {
+ samples = samples.slice(0, points);
+ }
+
return samples;
}
@@ -49,12 +73,32 @@ export function arraySeed(val: T, length: number): T[] {
return a;
}
+/**
+ * Trims or fills the array to ensure it meets the desired length. The seed array
+ * given is pulled from to fill any missing slots - it is recommended that this be
+ * at least `len` long. The resulting array will be exactly `len` long, either
+ * trimmed from the source or filled with the some/all of the seed array.
+ * @param {T[]} a The array to trim/fill.
+ * @param {number} len The length to trim or fill to, as needed.
+ * @param {T[]} seed Values to pull from if the array needs filling.
+ * @returns {T[]} The resulting array of `len` length.
+ */
+export function arrayTrimFill(a: T[], len: number, seed: T[]): T[] {
+ // Dev note: we do length checks because the spread operator can result in some
+ // performance penalties in more critical code paths. As a utility, it should be
+ // as fast as possible to not cause a problem for the call stack, no matter how
+ // critical that stack is.
+ if (a.length === len) return a;
+ if (a.length > len) return a.slice(0, len);
+ return a.concat(seed.slice(0, len - a.length));
+}
+
/**
* Clones an array as fast as possible, retaining references of the array's values.
* @param a The array to clone. Must be defined.
* @returns A copy of the array.
*/
-export function arrayFastClone(a: any[]): any[] {
+export function arrayFastClone(a: T[]): T[] {
return a.slice(0, a.length);
}
@@ -178,6 +222,13 @@ export class GroupedArray {
constructor(private val: Map) {
}
+ /**
+ * The value of this group, after all applicable alterations.
+ */
+ public get value(): Map {
+ return this.val;
+ }
+
/**
* Orders the grouping into an array using the provided key order.
* @param keyOrder The key order.
diff --git a/src/utils/enums.ts b/src/utils/enums.ts
index f7f4787896..d3ca318c28 100644
--- a/src/utils/enums.ts
+++ b/src/utils/enums.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2020 The Matrix.org Foundation C.I.C.
+Copyright 2020, 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -19,11 +19,23 @@ limitations under the License.
* @param e The enum.
* @returns The enum values.
*/
-export function getEnumValues(e: any): T[] {
+export function getEnumValues(e: any): (string | number)[] {
+ // String-based enums will simply be objects ({Key: "value"}), but number-based
+ // enums will instead map themselves twice: in one direction for {Key: 12} and
+ // the reverse for easy lookup, presumably ({12: Key}). In the reverse mapping,
+ // the key is a string, not a number.
+ //
+ // For this reason, we try to determine what kind of enum we're dealing with.
+
const keys = Object.keys(e);
- return keys
- .filter(k => ['string', 'number'].includes(typeof(e[k])))
- .map(k => e[k]);
+ const values: (string | number)[] = [];
+ for (const key of keys) {
+ const value = e[key];
+ if (Number.isFinite(value) || e[value.toString()] !== Number(key)) {
+ values.push(value);
+ }
+ }
+ return values;
}
/**
diff --git a/src/utils/objects.ts b/src/utils/objects.ts
index e7f4f0f907..2c9361beba 100644
--- a/src/utils/objects.ts
+++ b/src/utils/objects.ts
@@ -1,5 +1,5 @@
/*
-Copyright 2020 The Matrix.org Foundation C.I.C.
+Copyright 2020, 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -141,3 +141,21 @@ export function objectKeyChanges(a: O, b: O): (keyof O)[] {
export function objectClone(obj: O): O {
return JSON.parse(JSON.stringify(obj));
}
+
+/**
+ * Converts a series of entries to an object.
+ * @param entries The entries to convert.
+ * @returns The converted object.
+ */
+// NOTE: Deprecated once we have Object.fromEntries() support.
+// @ts-ignore - return type is complaining about non-string keys, but we know better
+export function objectFromEntries(entries: Iterable<[K, V]>): {[k: K]: V} {
+ const obj: {
+ // @ts-ignore - same as return type
+ [k: K]: V} = {};
+ for (const e of entries) {
+ // @ts-ignore - same as return type
+ obj[e[0]] = e[1];
+ }
+ return obj;
+}
diff --git a/src/utils/permalinks/ElementPermalinkConstructor.js b/src/utils/permalinks/ElementPermalinkConstructor.ts
similarity index 82%
rename from src/utils/permalinks/ElementPermalinkConstructor.js
rename to src/utils/permalinks/ElementPermalinkConstructor.ts
index da7f5797ea..cd7f2b9d2c 100644
--- a/src/utils/permalinks/ElementPermalinkConstructor.js
+++ b/src/utils/permalinks/ElementPermalinkConstructor.ts
@@ -20,31 +20,31 @@ import PermalinkConstructor, {PermalinkParts} from "./PermalinkConstructor";
* Generates permalinks that self-reference the running webapp
*/
export default class ElementPermalinkConstructor extends PermalinkConstructor {
- _elementUrl: string;
+ private elementUrl: string;
constructor(elementUrl: string) {
super();
- this._elementUrl = elementUrl;
+ this.elementUrl = elementUrl;
- if (!this._elementUrl.startsWith("http:") && !this._elementUrl.startsWith("https:")) {
+ if (!this.elementUrl.startsWith("http:") && !this.elementUrl.startsWith("https:")) {
throw new Error("Element prefix URL does not appear to be an HTTP(S) URL");
}
}
forEvent(roomId: string, eventId: string, serverCandidates: string[]): string {
- return `${this._elementUrl}/#/room/${roomId}/${eventId}${this.encodeServerCandidates(serverCandidates)}`;
+ return `${this.elementUrl}/#/room/${roomId}/${eventId}${this.encodeServerCandidates(serverCandidates)}`;
}
- forRoom(roomIdOrAlias: string, serverCandidates: string[]): string {
- return `${this._elementUrl}/#/room/${roomIdOrAlias}${this.encodeServerCandidates(serverCandidates)}`;
+ forRoom(roomIdOrAlias: string, serverCandidates?: string[]): string {
+ return `${this.elementUrl}/#/room/${roomIdOrAlias}${this.encodeServerCandidates(serverCandidates)}`;
}
forUser(userId: string): string {
- return `${this._elementUrl}/#/user/${userId}`;
+ return `${this.elementUrl}/#/user/${userId}`;
}
forGroup(groupId: string): string {
- return `${this._elementUrl}/#/group/${groupId}`;
+ return `${this.elementUrl}/#/group/${groupId}`;
}
forEntity(entityId: string): string {
@@ -58,11 +58,11 @@ export default class ElementPermalinkConstructor extends PermalinkConstructor {
}
isPermalinkHost(testHost: string): boolean {
- const parsedUrl = new URL(this._elementUrl);
+ const parsedUrl = new URL(this.elementUrl);
return testHost === (parsedUrl.host || parsedUrl.hostname); // one of the hosts should match
}
- encodeServerCandidates(candidates: string[]) {
+ encodeServerCandidates(candidates?: string[]) {
if (!candidates || candidates.length === 0) return '';
return `?via=${candidates.map(c => encodeURIComponent(c)).join("&via=")}`;
}
@@ -71,11 +71,11 @@ export default class ElementPermalinkConstructor extends PermalinkConstructor {
// https://github.com/turt2live/matrix-js-bot-sdk/blob/7c4665c9a25c2c8e0fe4e509f2616505b5b66a1c/src/Permalinks.ts#L33-L61
// Adapted for Element's URL format
parsePermalink(fullUrl: string): PermalinkParts {
- if (!fullUrl || !fullUrl.startsWith(this._elementUrl)) {
+ if (!fullUrl || !fullUrl.startsWith(this.elementUrl)) {
throw new Error("Does not appear to be a permalink");
}
- const parts = fullUrl.substring(`${this._elementUrl}/#/`.length);
+ const parts = fullUrl.substring(`${this.elementUrl}/#/`.length);
return ElementPermalinkConstructor.parseAppRoute(parts);
}
diff --git a/src/utils/permalinks/PermalinkConstructor.js b/src/utils/permalinks/PermalinkConstructor.ts
similarity index 100%
rename from src/utils/permalinks/PermalinkConstructor.js
rename to src/utils/permalinks/PermalinkConstructor.ts
diff --git a/src/utils/permalinks/Permalinks.js b/src/utils/permalinks/Permalinks.ts
similarity index 77%
rename from src/utils/permalinks/Permalinks.js
rename to src/utils/permalinks/Permalinks.ts
index 2db8b9f998..015ecca22e 100644
--- a/src/utils/permalinks/Permalinks.js
+++ b/src/utils/permalinks/Permalinks.ts
@@ -17,6 +17,9 @@ limitations under the License.
import isIp from "is-ip";
import * as utils from "matrix-js-sdk/src/utils";
import {Room} from "matrix-js-sdk/src/models/room";
+import {EventType} from "matrix-js-sdk/src/@types/event";
+import { MatrixEvent } from "matrix-js-sdk/src/models/event";
+import { RoomMember } from "matrix-js-sdk/src/models/room-member";
import {MatrixClientPeg} from "../../MatrixClientPeg";
import SpecPermalinkConstructor, {baseUrl as matrixtoBaseUrl} from "./SpecPermalinkConstructor";
@@ -74,29 +77,35 @@ const MAX_SERVER_CANDIDATES = 3;
// the list and magically have the link work.
export class RoomPermalinkCreator {
+ private room: Room;
+ private roomId: string;
+ private highestPlUserId: string;
+ private populationMap: { [serverName: string]: number };
+ private bannedHostsRegexps: RegExp[];
+ private allowedHostsRegexps: RegExp[];
+ private _serverCandidates: string[];
+ private started: boolean;
+
// We support being given a roomId as a fallback in the event the `room` object
// doesn't exist or is not healthy for us to rely on. For example, loading a
// permalink to a room which the MatrixClient doesn't know about.
- constructor(room, roomId = null) {
- this._room = room;
- this._roomId = room ? room.roomId : roomId;
- this._highestPlUserId = null;
- this._populationMap = null;
- this._bannedHostsRegexps = null;
- this._allowedHostsRegexps = null;
+ constructor(room: Room, roomId: string = null) {
+ this.room = room;
+ this.roomId = room ? room.roomId : roomId;
+ this.highestPlUserId = null;
+ this.populationMap = null;
+ this.bannedHostsRegexps = null;
+ this.allowedHostsRegexps = null;
this._serverCandidates = null;
- this._started = false;
+ this.started = false;
- if (!this._roomId) {
+ if (!this.roomId) {
throw new Error("Failed to resolve a roomId for the permalink creator to use");
}
-
- this.onMembership = this.onMembership.bind(this);
- this.onRoomState = this.onRoomState.bind(this);
}
load() {
- if (!this._room || !this._room.currentState) {
+ if (!this.room || !this.room.currentState) {
// Under rare and unknown circumstances it is possible to have a room with no
// currentState, at least potentially at the early stages of joining a room.
// To avoid breaking everything, we'll just warn rather than throw as well as
@@ -104,23 +113,23 @@ export class RoomPermalinkCreator {
console.warn("Tried to load a permalink creator with no room state");
return;
}
- this._updateAllowedServers();
- this._updateHighestPlUser();
- this._updatePopulationMap();
- this._updateServerCandidates();
+ this.updateAllowedServers();
+ this.updateHighestPlUser();
+ this.updatePopulationMap();
+ this.updateServerCandidates();
}
start() {
this.load();
- this._room.on("RoomMember.membership", this.onMembership);
- this._room.on("RoomState.events", this.onRoomState);
- this._started = true;
+ this.room.on("RoomMember.membership", this.onMembership);
+ this.room.on("RoomState.events", this.onRoomState);
+ this.started = true;
}
stop() {
- this._room.removeListener("RoomMember.membership", this.onMembership);
- this._room.removeListener("RoomState.events", this.onRoomState);
- this._started = false;
+ this.room.removeListener("RoomMember.membership", this.onMembership);
+ this.room.removeListener("RoomState.events", this.onRoomState);
+ this.started = false;
}
get serverCandidates() {
@@ -128,44 +137,44 @@ export class RoomPermalinkCreator {
}
isStarted() {
- return this._started;
+ return this.started;
}
- forEvent(eventId) {
- return getPermalinkConstructor().forEvent(this._roomId, eventId, this._serverCandidates);
+ forEvent(eventId: string): string {
+ return getPermalinkConstructor().forEvent(this.roomId, eventId, this._serverCandidates);
}
- forShareableRoom() {
- if (this._room) {
+ forShareableRoom(): string {
+ if (this.room) {
// Prefer to use canonical alias for permalink if possible
- const alias = this._room.getCanonicalAlias();
+ const alias = this.room.getCanonicalAlias();
if (alias) {
return getPermalinkConstructor().forRoom(alias, this._serverCandidates);
}
}
- return getPermalinkConstructor().forRoom(this._roomId, this._serverCandidates);
+ return getPermalinkConstructor().forRoom(this.roomId, this._serverCandidates);
}
- forRoom() {
- return getPermalinkConstructor().forRoom(this._roomId, this._serverCandidates);
+ forRoom(): string {
+ return getPermalinkConstructor().forRoom(this.roomId, this._serverCandidates);
}
- onRoomState(event) {
+ private onRoomState = (event: MatrixEvent) => {
switch (event.getType()) {
- case "m.room.server_acl":
- this._updateAllowedServers();
- this._updateHighestPlUser();
- this._updatePopulationMap();
- this._updateServerCandidates();
+ case EventType.RoomServerAcl:
+ this.updateAllowedServers();
+ this.updateHighestPlUser();
+ this.updatePopulationMap();
+ this.updateServerCandidates();
return;
- case "m.room.power_levels":
- this._updateHighestPlUser();
- this._updateServerCandidates();
+ case EventType.RoomPowerLevels:
+ this.updateHighestPlUser();
+ this.updateServerCandidates();
return;
}
}
- onMembership(evt, member, oldMembership) {
+ private onMembership = (evt: MatrixEvent, member: RoomMember, oldMembership: string) => {
const userId = member.userId;
const membership = member.membership;
const serverName = getServerName(userId);
@@ -173,17 +182,17 @@ export class RoomPermalinkCreator {
const hasLeft = oldMembership === "join" && membership !== "join";
if (hasLeft) {
- this._populationMap[serverName]--;
+ this.populationMap[serverName]--;
} else if (hasJoined) {
- this._populationMap[serverName]++;
+ this.populationMap[serverName]++;
}
- this._updateHighestPlUser();
- this._updateServerCandidates();
+ this.updateHighestPlUser();
+ this.updateServerCandidates();
}
- _updateHighestPlUser() {
- const plEvent = this._room.currentState.getStateEvents("m.room.power_levels", "");
+ private updateHighestPlUser() {
+ const plEvent = this.room.currentState.getStateEvents("m.room.power_levels", "");
if (plEvent) {
const content = plEvent.getContent();
if (content) {
@@ -191,14 +200,14 @@ export class RoomPermalinkCreator {
if (users) {
const entries = Object.entries(users);
const allowedEntries = entries.filter(([userId]) => {
- const member = this._room.getMember(userId);
+ const member = this.room.getMember(userId);
if (!member || member.membership !== "join") {
return false;
}
const serverName = getServerName(userId);
return !isHostnameIpAddress(serverName) &&
- !isHostInRegex(serverName, this._bannedHostsRegexps) &&
- isHostInRegex(serverName, this._allowedHostsRegexps);
+ !isHostInRegex(serverName, this.bannedHostsRegexps) &&
+ isHostInRegex(serverName, this.allowedHostsRegexps);
});
const maxEntry = allowedEntries.reduce((max, entry) => {
return (entry[1] > max[1]) ? entry : max;
@@ -206,20 +215,20 @@ export class RoomPermalinkCreator {
const [userId, powerLevel] = maxEntry;
// object wasn't empty, and max entry wasn't a demotion from the default
if (userId !== null && powerLevel >= 50) {
- this._highestPlUserId = userId;
+ this.highestPlUserId = userId;
return;
}
}
}
}
- this._highestPlUserId = null;
+ this.highestPlUserId = null;
}
- _updateAllowedServers() {
+ private updateAllowedServers() {
const bannedHostsRegexps = [];
let allowedHostsRegexps = [new RegExp(".*")]; // default allow everyone
- if (this._room.currentState) {
- const aclEvent = this._room.currentState.getStateEvents("m.room.server_acl", "");
+ if (this.room.currentState) {
+ const aclEvent = this.room.currentState.getStateEvents("m.room.server_acl", "");
if (aclEvent && aclEvent.getContent()) {
const getRegex = (hostname) => new RegExp("^" + utils.globToRegexp(hostname, false) + "$");
@@ -231,35 +240,35 @@ export class RoomPermalinkCreator {
allowed.forEach(h => allowedHostsRegexps.push(getRegex(h)));
}
}
- this._bannedHostsRegexps = bannedHostsRegexps;
- this._allowedHostsRegexps = allowedHostsRegexps;
+ this.bannedHostsRegexps = bannedHostsRegexps;
+ this.allowedHostsRegexps = allowedHostsRegexps;
}
- _updatePopulationMap() {
+ private updatePopulationMap() {
const populationMap: { [server: string]: number } = {};
- for (const member of this._room.getJoinedMembers()) {
+ for (const member of this.room.getJoinedMembers()) {
const serverName = getServerName(member.userId);
if (!populationMap[serverName]) {
populationMap[serverName] = 0;
}
populationMap[serverName]++;
}
- this._populationMap = populationMap;
+ this.populationMap = populationMap;
}
- _updateServerCandidates() {
+ private updateServerCandidates() {
let candidates = [];
- if (this._highestPlUserId) {
- candidates.push(getServerName(this._highestPlUserId));
+ if (this.highestPlUserId) {
+ candidates.push(getServerName(this.highestPlUserId));
}
- const serversByPopulation = Object.keys(this._populationMap)
- .sort((a, b) => this._populationMap[b] - this._populationMap[a])
+ const serversByPopulation = Object.keys(this.populationMap)
+ .sort((a, b) => this.populationMap[b] - this.populationMap[a])
.filter(a => {
return !candidates.includes(a) &&
!isHostnameIpAddress(a) &&
- !isHostInRegex(a, this._bannedHostsRegexps) &&
- isHostInRegex(a, this._allowedHostsRegexps);
+ !isHostInRegex(a, this.bannedHostsRegexps) &&
+ isHostInRegex(a, this.allowedHostsRegexps);
});
const remainingServers = serversByPopulation.slice(0, MAX_SERVER_CANDIDATES - candidates.length);
@@ -273,11 +282,11 @@ export function makeGenericPermalink(entityId: string): string {
return getPermalinkConstructor().forEntity(entityId);
}
-export function makeUserPermalink(userId) {
+export function makeUserPermalink(userId: string): string {
return getPermalinkConstructor().forUser(userId);
}
-export function makeRoomPermalink(roomId) {
+export function makeRoomPermalink(roomId: string): string {
if (!roomId) {
throw new Error("can't permalink a falsey roomId");
}
@@ -296,7 +305,7 @@ export function makeRoomPermalink(roomId) {
return permalinkCreator.forRoom();
}
-export function makeGroupPermalink(groupId) {
+export function makeGroupPermalink(groupId: string): string {
return getPermalinkConstructor().forGroup(groupId);
}
@@ -428,24 +437,24 @@ export function parseAppLocalLink(localLink: string): PermalinkParts {
return null;
}
-function getServerName(userId) {
+function getServerName(userId: string): string {
return userId.split(":").splice(1).join(":");
}
-function getHostnameFromMatrixDomain(domain) {
+function getHostnameFromMatrixDomain(domain: string): string {
if (!domain) return null;
return new URL(`https://${domain}`).hostname;
}
-function isHostInRegex(hostname, regexps) {
+function isHostInRegex(hostname: string, regexps: RegExp[]) {
hostname = getHostnameFromMatrixDomain(hostname);
if (!hostname) return true; // assumed
- if (regexps.length > 0 && !regexps[0].test) throw new Error(regexps[0]);
+ if (regexps.length > 0 && !regexps[0].test) throw new Error(regexps[0].toString());
return regexps.filter(h => h.test(hostname)).length > 0;
}
-function isHostnameIpAddress(hostname) {
+function isHostnameIpAddress(hostname: string): boolean {
hostname = getHostnameFromMatrixDomain(hostname);
if (!hostname) return false;
diff --git a/src/utils/permalinks/SpecPermalinkConstructor.js b/src/utils/permalinks/SpecPermalinkConstructor.ts
similarity index 100%
rename from src/utils/permalinks/SpecPermalinkConstructor.js
rename to src/utils/permalinks/SpecPermalinkConstructor.ts
diff --git a/src/voice/Playback.ts b/src/voice/Playback.ts
new file mode 100644
index 0000000000..99b1f62866
--- /dev/null
+++ b/src/voice/Playback.ts
@@ -0,0 +1,141 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import EventEmitter from "events";
+import {UPDATE_EVENT} from "../stores/AsyncStore";
+import {arrayFastResample, arraySeed} from "../utils/arrays";
+import {SimpleObservable} from "matrix-widget-api";
+import {IDestroyable} from "../utils/IDestroyable";
+import {PlaybackClock} from "./PlaybackClock";
+
+export enum PlaybackState {
+ Decoding = "decoding",
+ Stopped = "stopped", // no progress on timeline
+ Paused = "paused", // some progress on timeline
+ Playing = "playing", // active progress through timeline
+}
+
+export const PLAYBACK_WAVEFORM_SAMPLES = 35;
+const DEFAULT_WAVEFORM = arraySeed(0, PLAYBACK_WAVEFORM_SAMPLES);
+
+export class Playback extends EventEmitter implements IDestroyable {
+ private readonly context: AudioContext;
+ private source: AudioBufferSourceNode;
+ private state = PlaybackState.Decoding;
+ private audioBuf: AudioBuffer;
+ private resampledWaveform: number[];
+ private waveformObservable = new SimpleObservable();
+ private readonly clock: PlaybackClock;
+
+ /**
+ * Creates a new playback instance from a buffer.
+ * @param {ArrayBuffer} buf The buffer containing the sound sample.
+ * @param {number[]} seedWaveform Optional seed waveform to present until the proper waveform
+ * can be calculated. Contains values between zero and one, inclusive.
+ */
+ constructor(private buf: ArrayBuffer, seedWaveform = DEFAULT_WAVEFORM) {
+ super();
+ this.context = new AudioContext();
+ this.resampledWaveform = arrayFastResample(seedWaveform, PLAYBACK_WAVEFORM_SAMPLES);
+ this.waveformObservable.update(this.resampledWaveform);
+ this.clock = new PlaybackClock(this.context);
+
+ // TODO: @@ TR: Calculate real waveform
+ }
+
+ public get waveform(): number[] {
+ return this.resampledWaveform;
+ }
+
+ public get waveformData(): SimpleObservable {
+ return this.waveformObservable;
+ }
+
+ public get clockInfo(): PlaybackClock {
+ return this.clock;
+ }
+
+ public get currentState(): PlaybackState {
+ return this.state;
+ }
+
+ public get isPlaying(): boolean {
+ return this.currentState === PlaybackState.Playing;
+ }
+
+ public emit(event: PlaybackState, ...args: any[]): boolean {
+ this.state = event;
+ super.emit(event, ...args);
+ super.emit(UPDATE_EVENT, event, ...args);
+ return true; // we don't ever care if the event had listeners, so just return "yes"
+ }
+
+ public destroy() {
+ // noinspection JSIgnoredPromiseFromCall - not concerned about being called async here
+ this.stop();
+ this.removeAllListeners();
+ this.clock.destroy();
+ this.waveformObservable.close();
+ }
+
+ public async prepare() {
+ this.audioBuf = await this.context.decodeAudioData(this.buf);
+ this.emit(PlaybackState.Stopped); // signal that we're not decoding anymore
+ this.clock.durationSeconds = this.audioBuf.duration;
+ }
+
+ private onPlaybackEnd = async () => {
+ await this.context.suspend();
+ this.emit(PlaybackState.Stopped);
+ };
+
+ public async play() {
+ // We can't restart a buffer source, so we need to create a new one if we hit the end
+ if (this.state === PlaybackState.Stopped) {
+ if (this.source) {
+ this.source.disconnect();
+ this.source.removeEventListener("ended", this.onPlaybackEnd);
+ }
+
+ this.source = this.context.createBufferSource();
+ this.source.connect(this.context.destination);
+ this.source.buffer = this.audioBuf;
+ this.source.start(); // start immediately
+ this.source.addEventListener("ended", this.onPlaybackEnd);
+ }
+
+ // We use the context suspend/resume functions because it allows us to pause a source
+ // node, but that still doesn't help us when the source node runs out (see above).
+ await this.context.resume();
+ this.clock.flagStart();
+ this.emit(PlaybackState.Playing);
+ }
+
+ public async pause() {
+ await this.context.suspend();
+ this.emit(PlaybackState.Paused);
+ }
+
+ public async stop() {
+ await this.onPlaybackEnd();
+ this.clock.flagStop();
+ }
+
+ public async toggle() {
+ if (this.isPlaying) await this.pause();
+ else await this.play();
+ }
+}
diff --git a/src/voice/PlaybackClock.ts b/src/voice/PlaybackClock.ts
new file mode 100644
index 0000000000..06d6381691
--- /dev/null
+++ b/src/voice/PlaybackClock.ts
@@ -0,0 +1,78 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {SimpleObservable} from "matrix-widget-api";
+import {IDestroyable} from "../utils/IDestroyable";
+
+// Because keeping track of time is sufficiently complicated...
+export class PlaybackClock implements IDestroyable {
+ private clipStart = 0;
+ private stopped = true;
+ private lastCheck = 0;
+ private observable = new SimpleObservable();
+ private timerId: number;
+ private clipDuration = 0;
+
+ public constructor(private context: AudioContext) {
+ }
+
+ public get durationSeconds(): number {
+ return this.clipDuration;
+ }
+
+ public set durationSeconds(val: number) {
+ this.clipDuration = val;
+ this.observable.update([this.timeSeconds, this.clipDuration]);
+ }
+
+ public get timeSeconds(): number {
+ return (this.context.currentTime - this.clipStart) % this.clipDuration;
+ }
+
+ public get liveData(): SimpleObservable {
+ return this.observable;
+ }
+
+ private checkTime = () => {
+ const now = this.timeSeconds;
+ if (this.lastCheck !== now) {
+ this.observable.update([now, this.durationSeconds]);
+ this.lastCheck = now;
+ }
+ };
+
+ public flagStart() {
+ if (this.stopped) {
+ this.clipStart = this.context.currentTime;
+ this.stopped = false;
+ }
+
+ if (!this.timerId) {
+ // case to number because the types are wrong
+ // 100ms interval to make sure the time is as accurate as possible
+ this.timerId = setInterval(this.checkTime, 100);
+ }
+ }
+
+ public flagStop() {
+ this.stopped = true;
+ }
+
+ public destroy() {
+ this.observable.close();
+ if (this.timerId) clearInterval(this.timerId);
+ }
+}
diff --git a/src/voice/RecorderWorklet.ts b/src/voice/RecorderWorklet.ts
new file mode 100644
index 0000000000..7343d37066
--- /dev/null
+++ b/src/voice/RecorderWorklet.ts
@@ -0,0 +1,67 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {IAmplitudePayload, ITimingPayload, PayloadEvent, WORKLET_NAME} from "./consts";
+import {percentageOf} from "../utils/numbers";
+
+// from AudioWorkletGlobalScope: https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletGlobalScope
+declare const currentTime: number;
+// declare const currentFrame: number;
+// declare const sampleRate: number;
+
+class MxVoiceWorklet extends AudioWorkletProcessor {
+ private nextAmplitudeSecond = 0;
+
+ process(inputs, outputs, parameters) {
+ // We only fire amplitude updates once a second to avoid flooding the recording instance
+ // with useless data. Much of the data would end up discarded, so we ratelimit ourselves
+ // here.
+ const currentSecond = Math.round(currentTime);
+ if (currentSecond === this.nextAmplitudeSecond) {
+ // We're expecting exactly one mono input source, so just grab the very first frame of
+ // samples for the analysis.
+ const monoChan = inputs[0][0];
+
+ // The amplitude of the frame's samples is effectively the loudness of the frame. This
+ // translates into a bar which can be rendered as part of the whole recording clip's
+ // waveform.
+ //
+ // We translate the amplitude down to 0-1 for sanity's sake.
+ const minVal = Math.min(...monoChan);
+ const maxVal = Math.max(...monoChan);
+ const amplitude = percentageOf(maxVal, -1, 1) - percentageOf(minVal, -1, 1);
+
+ this.port.postMessage({
+ ev: PayloadEvent.AmplitudeMark,
+ amplitude: amplitude,
+ forSecond: currentSecond,
+ });
+ this.nextAmplitudeSecond++;
+ }
+
+ // We mostly use this worklet to fire regular clock updates through to components
+ this.port.postMessage({ev: PayloadEvent.Timekeep, timeSeconds: currentTime});
+
+ // We're supposed to return false when we're "done" with the audio clip, but seeing as
+ // we are acting as a passive processor we are never truly "done". The browser will clean
+ // us up when it is done with us.
+ return true;
+ }
+}
+
+registerProcessor(WORKLET_NAME, MxVoiceWorklet);
+
+export default null; // to appease module loaders (we never use the export)
diff --git a/src/voice/VoiceRecording.ts b/src/voice/VoiceRecording.ts
index 55775ff786..eb705200ca 100644
--- a/src/voice/VoiceRecording.ts
+++ b/src/voice/VoiceRecording.ts
@@ -23,6 +23,9 @@ import {clamp} from "../utils/numbers";
import EventEmitter from "events";
import {IDestroyable} from "../utils/IDestroyable";
import {Singleflight} from "../utils/Singleflight";
+import {PayloadEvent, WORKLET_NAME} from "./consts";
+import {UPDATE_EVENT} from "../stores/AsyncStore";
+import {Playback} from "./Playback";
const CHANNELS = 1; // stereo isn't important
const SAMPLE_RATE = 48000; // 48khz is what WebRTC uses. 12khz is where we lose quality.
@@ -49,16 +52,41 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
private recorderSource: MediaStreamAudioSourceNode;
private recorderStream: MediaStream;
private recorderFFT: AnalyserNode;
- private recorderProcessor: ScriptProcessorNode;
- private buffer = new Uint8Array(0);
+ private recorderWorklet: AudioWorkletNode;
+ private buffer = new Uint8Array(0); // use this.audioBuffer to access
private mxc: string;
private recording = false;
private observable: SimpleObservable;
+ private amplitudes: number[] = []; // at each second mark, generated
+ private playback: Playback;
public constructor(private client: MatrixClient) {
super();
}
+ public get contentType(): string {
+ return "audio/ogg";
+ }
+
+ public get contentLength(): number {
+ return this.buffer.length;
+ }
+
+ public get durationSeconds(): number {
+ if (!this.recorder) throw new Error("Duration not available without a recording");
+ return this.recorderContext.currentTime;
+ }
+
+ public get isRecording(): boolean {
+ return this.recording;
+ }
+
+ public emit(event: string, ...args: any[]): boolean {
+ super.emit(event, ...args);
+ super.emit(UPDATE_EVENT, event, ...args);
+ return true; // we don't ever care if the event had listeners, so just return "yes"
+ }
+
private async makeRecorder() {
this.recorderStream = await navigator.mediaDevices.getUserMedia({
audio: {
@@ -80,18 +108,34 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
// it makes the time domain less than helpful.
this.recorderFFT.fftSize = 64;
- // We use an audio processor to get accurate timing information.
- // The size of the audio buffer largely decides how quickly we push timing/waveform data
- // out of this class. Smaller buffers mean we update more frequently as we can't hold as
- // many bytes. Larger buffers mean slower updates. For scale, 1024 gives us about 30Hz of
- // updates and 2048 gives us about 20Hz. We use 1024 to get as close to perceived realtime
- // as possible. Must be a power of 2.
- this.recorderProcessor = this.recorderContext.createScriptProcessor(1024, CHANNELS, CHANNELS);
+ // Set up our worklet. We use this for timing information and waveform analysis: the
+ // web audio API prefers this be done async to avoid holding the main thread with math.
+ const mxRecorderWorkletPath = document.body.dataset.vectorRecorderWorkletScript;
+ if (!mxRecorderWorkletPath) {
+ throw new Error("Unable to create recorder: no worklet script registered");
+ }
+ await this.recorderContext.audioWorklet.addModule(mxRecorderWorkletPath);
+ this.recorderWorklet = new AudioWorkletNode(this.recorderContext, WORKLET_NAME);
// Connect our inputs and outputs
this.recorderSource.connect(this.recorderFFT);
- this.recorderSource.connect(this.recorderProcessor);
- this.recorderProcessor.connect(this.recorderContext.destination);
+ this.recorderSource.connect(this.recorderWorklet);
+ this.recorderWorklet.connect(this.recorderContext.destination);
+
+ // Dev note: we can't use `addEventListener` for some reason. It just doesn't work.
+ this.recorderWorklet.port.onmessage = (ev) => {
+ switch (ev.data['ev']) {
+ case PayloadEvent.Timekeep:
+ this.processAudioUpdate(ev.data['timeSeconds']);
+ break;
+ case PayloadEvent.AmplitudeMark:
+ // Sanity check to make sure we're adding about one sample per second
+ if (ev.data['forSecond'] === this.amplitudes.length) {
+ this.amplitudes.push(ev.data['amplitude']);
+ }
+ break;
+ }
+ };
this.recorder = new Recorder({
encoderPath, // magic from webpack
@@ -118,6 +162,12 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
};
}
+ private get audioBuffer(): Uint8Array {
+ // We need a clone of the buffer to avoid accidentally changing the position
+ // on the real thing.
+ return this.buffer.slice(0);
+ }
+
public get liveData(): SimpleObservable {
if (!this.recording) throw new Error("No observable when not recording");
return this.observable;
@@ -138,7 +188,7 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
return this.mxc;
}
- private processAudioUpdate = (ev: AudioProcessingEvent) => {
+ private processAudioUpdate = (timeSeconds: number) => {
if (!this.recording) return;
// The time domain is the input to the FFT, which means we use an array of the same
@@ -162,13 +212,24 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
this.observable.update({
waveform: translatedData,
- timeSeconds: ev.playbackTime,
+ timeSeconds: timeSeconds,
});
// Now that we've updated the data/waveform, let's do a time check. We don't want to
// go horribly over the limit. We also emit a warning state if needed.
- const secondsLeft = TARGET_MAX_LENGTH - ev.playbackTime;
- if (secondsLeft <= 0) {
+ //
+ // We use the recorder's perspective of time to make sure we don't cut off the last
+ // frame of audio, otherwise we end up with a 1:59 clip (119.68 seconds). This extra
+ // safety can allow us to overshoot the target a bit, but at least when we say 2min
+ // maximum we actually mean it.
+ //
+ // In testing, recorder time and worker time lag by about 400ms, which is roughly the
+ // time needed to encode a sample/frame.
+ //
+ // Ref for recorderSeconds: https://github.com/chris-rudmin/opus-recorder#instance-fields
+ const recorderSeconds = this.recorder.encodedSamplePosition / 48000;
+ const secondsLeft = TARGET_MAX_LENGTH - recorderSeconds;
+ if (secondsLeft < 0) { // go over to make sure we definitely capture that last frame
// noinspection JSIgnoredPromiseFromCall - we aren't concerned with it overlapping
this.stop();
} else if (secondsLeft <= TARGET_WARN_TIME_LEFT) {
@@ -191,7 +252,6 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
}
this.observable = new SimpleObservable();
await this.makeRecorder();
- this.recorderProcessor.addEventListener("audioprocess", this.processAudioUpdate);
await this.recorder.start();
this.recording = true;
this.emit(RecordingState.Started);
@@ -204,8 +264,9 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
}
// Disconnect the source early to start shutting down resources
+ await this.recorder.stop(); // stop first to flush the last frame
this.recorderSource.disconnect();
- await this.recorder.stop();
+ this.recorderWorklet.disconnect();
// close the context after the recorder so the recorder doesn't try to
// connect anything to the context (this would generate a warning)
@@ -216,19 +277,36 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
// Finally do our post-processing and clean up
this.recording = false;
- this.recorderProcessor.removeEventListener("audioprocess", this.processAudioUpdate);
await this.recorder.close();
this.emit(RecordingState.Ended);
- return this.buffer;
+ return this.audioBuffer;
});
}
+ /**
+ * Gets a playback instance for this voice recording. Note that the playback will not
+ * have been prepared fully, meaning the `prepare()` function needs to be called on it.
+ *
+ * The same playback instance is returned each time.
+ *
+ * @returns {Playback} The playback instance.
+ */
+ public getPlayback(): Playback {
+ this.playback = Singleflight.for(this, "playback").do(() => {
+ return new Playback(this.audioBuffer.buffer, this.amplitudes); // cast to ArrayBuffer proper;
+ });
+ return this.playback;
+ }
+
public destroy() {
// noinspection JSIgnoredPromiseFromCall - not concerned about stop() being called async here
this.stop();
this.removeAllListeners();
Singleflight.forgetAllFor(this);
+ // noinspection JSIgnoredPromiseFromCall - not concerned about being called async here
+ this.playback?.destroy();
+ this.observable.close();
}
public async upload(): Promise {
@@ -239,8 +317,8 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
if (this.mxc) return this.mxc;
this.emit(RecordingState.Uploading);
- this.mxc = await this.client.uploadContent(new Blob([this.buffer], {
- type: "audio/ogg",
+ this.mxc = await this.client.uploadContent(new Blob([this.audioBuffer], {
+ type: this.contentType,
}), {
onlyContentUri: false, // to stop the warnings in the console
}).then(r => r['content_uri']);
@@ -248,5 +326,3 @@ export class VoiceRecording extends EventEmitter implements IDestroyable {
return this.mxc;
}
}
-
-window.mxVoiceRecorder = VoiceRecording;
diff --git a/src/voice/consts.ts b/src/voice/consts.ts
new file mode 100644
index 0000000000..c530c60f0b
--- /dev/null
+++ b/src/voice/consts.ts
@@ -0,0 +1,37 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+export const WORKLET_NAME = "mx-voice-worklet";
+
+export enum PayloadEvent {
+ Timekeep = "timekeep",
+ AmplitudeMark = "amplitude_mark",
+}
+
+export interface IPayload {
+ ev: PayloadEvent;
+}
+
+export interface ITimingPayload extends IPayload {
+ ev: PayloadEvent.Timekeep;
+ timeSeconds: number;
+}
+
+export interface IAmplitudePayload extends IPayload {
+ ev: PayloadEvent.AmplitudeMark;
+ forSecond: number;
+ amplitude: number;
+}
diff --git a/test/CallHandler-test.ts b/test/CallHandler-test.ts
new file mode 100644
index 0000000000..754610b223
--- /dev/null
+++ b/test/CallHandler-test.ts
@@ -0,0 +1,216 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import './skinned-sdk';
+
+import CallHandler, { PlaceCallType } from '../src/CallHandler';
+import { stubClient, mkStubRoom } from './test-utils';
+import { MatrixClientPeg } from '../src/MatrixClientPeg';
+import dis from '../src/dispatcher/dispatcher';
+import { CallEvent, CallState } from 'matrix-js-sdk/src/webrtc/call';
+import DMRoomMap from '../src/utils/DMRoomMap';
+import EventEmitter from 'events';
+import { Action } from '../src/dispatcher/actions';
+import SdkConfig from '../src/SdkConfig';
+
+const REAL_ROOM_ID = '$room1:example.org';
+const MAPPED_ROOM_ID = '$room2:example.org';
+const MAPPED_ROOM_ID_2 = '$room3:example.org';
+
+function mkStubDM(roomId, userId) {
+ const room = mkStubRoom(roomId);
+ room.getJoinedMembers = jest.fn().mockReturnValue([
+ {
+ userId: '@me:example.org',
+ name: 'Member',
+ rawDisplayName: 'Member',
+ roomId: roomId,
+ membership: 'join',
+ getAvatarUrl: () => 'mxc://avatar.url/image.png',
+ getMxcAvatarUrl: () => 'mxc://avatar.url/image.png',
+ },
+ {
+ userId: userId,
+ name: 'Member',
+ rawDisplayName: 'Member',
+ roomId: roomId,
+ membership: 'join',
+ getAvatarUrl: () => 'mxc://avatar.url/image.png',
+ getMxcAvatarUrl: () => 'mxc://avatar.url/image.png',
+ },
+ ]);
+ room.currentState.getMembers = room.getJoinedMembers;
+
+ return room;
+}
+
+class FakeCall extends EventEmitter {
+ roomId: string;
+ callId = "fake call id";
+
+ constructor(roomId) {
+ super();
+
+ this.roomId = roomId;
+ }
+
+ setRemoteOnHold() {}
+ setRemoteAudioElement() {}
+
+ placeVoiceCall() {
+ this.emit(CallEvent.State, CallState.Connected, null);
+ }
+}
+
+describe('CallHandler', () => {
+ let dmRoomMap;
+ let callHandler;
+ let audioElement;
+ let fakeCall;
+
+ beforeEach(() => {
+ stubClient();
+ MatrixClientPeg.get().createCall = roomId => {
+ if (fakeCall && fakeCall.roomId !== roomId) {
+ throw new Error("Only one call is supported!");
+ }
+ fakeCall = new FakeCall(roomId);
+ return fakeCall;
+ };
+
+ callHandler = new CallHandler();
+ callHandler.start();
+
+ dmRoomMap = {
+ getUserIdForRoomId: roomId => {
+ if (roomId === REAL_ROOM_ID) {
+ return '@user1:example.org';
+ } else if (roomId === MAPPED_ROOM_ID) {
+ return '@user2:example.org';
+ } else if (roomId === MAPPED_ROOM_ID_2) {
+ return '@user3:example.org';
+ } else {
+ return null;
+ }
+ },
+ getDMRoomsForUserId: userId => {
+ if (userId === '@user2:example.org') {
+ return [MAPPED_ROOM_ID];
+ } else if (userId === '@user3:example.org') {
+ return [MAPPED_ROOM_ID_2];
+ } else {
+ return [];
+ }
+ },
+ };
+ DMRoomMap.setShared(dmRoomMap);
+
+ audioElement = document.createElement('audio');
+ audioElement.id = "remoteAudio";
+ document.body.appendChild(audioElement);
+ });
+
+ afterEach(() => {
+ callHandler.stop();
+ DMRoomMap.setShared(null);
+ // @ts-ignore
+ window.mxCallHandler = null;
+ MatrixClientPeg.unset();
+
+ document.body.removeChild(audioElement);
+ SdkConfig.unset();
+ });
+
+ it('should move calls between rooms when remote asserted identity changes', async () => {
+ const realRoom = mkStubDM(REAL_ROOM_ID, '@user1:example.org');
+ const mappedRoom = mkStubDM(MAPPED_ROOM_ID, '@user2:example.org');
+ const mappedRoom2 = mkStubDM(MAPPED_ROOM_ID_2, '@user3:example.org');
+
+ MatrixClientPeg.get().getRoom = roomId => {
+ switch (roomId) {
+ case REAL_ROOM_ID:
+ return realRoom;
+ case MAPPED_ROOM_ID:
+ return mappedRoom;
+ case MAPPED_ROOM_ID_2:
+ return mappedRoom2;
+ }
+ };
+
+ dis.dispatch({
+ action: 'place_call',
+ type: PlaceCallType.Voice,
+ room_id: REAL_ROOM_ID,
+ }, true);
+
+ let dispatchHandle;
+ // wait for the call to be set up
+ await new Promise(resolve => {
+ dispatchHandle = dis.register(payload => {
+ if (payload.action === 'call_state') {
+ resolve();
+ }
+ });
+ });
+ dis.unregister(dispatchHandle);
+
+ // should start off in the actual room ID it's in at the protocol level
+ expect(callHandler.getCallForRoom(REAL_ROOM_ID)).toBe(fakeCall);
+
+ let callRoomChangeEventCount = 0;
+ const roomChangePromise = new Promise(resolve => {
+ dispatchHandle = dis.register(payload => {
+ if (payload.action === Action.CallChangeRoom) {
+ ++callRoomChangeEventCount;
+ resolve();
+ }
+ });
+ });
+
+ // Now emit an asserted identity for user2: this should be ignored
+ // because we haven't set the config option to obey asserted identity
+ fakeCall.getRemoteAssertedIdentity = jest.fn().mockReturnValue({
+ id: "@user2:example.org",
+ });
+ fakeCall.emit(CallEvent.AssertedIdentityChanged);
+
+ // Now set the config option
+ SdkConfig.put({
+ voip: {
+ obeyAssertedIdentity: true,
+ },
+ });
+
+ // ...and send another asserted identity event for a different user
+ fakeCall.getRemoteAssertedIdentity = jest.fn().mockReturnValue({
+ id: "@user3:example.org",
+ });
+ fakeCall.emit(CallEvent.AssertedIdentityChanged);
+
+ await roomChangePromise;
+ dis.unregister(dispatchHandle);
+
+ // If everything's gone well, we should have seen only one room change
+ // event and the call should now be in user 3's room.
+ // If it's not obeying any, the call will still be in REAL_ROOM_ID.
+ // If it incorrectly obeyed both asserted identity changes, either it will
+ // have just processed one and the call will be in the wrong room, or we'll
+ // have seen two room change dispatches.
+ expect(callRoomChangeEventCount).toEqual(1);
+ expect(callHandler.getCallForRoom(REAL_ROOM_ID)).toBeNull();
+ expect(callHandler.getCallForRoom(MAPPED_ROOM_ID_2)).toBe(fakeCall);
+ });
+});
diff --git a/test/ScalarAuthClient-test.js b/test/ScalarAuthClient-test.js
index 83f357811a..3435f70932 100644
--- a/test/ScalarAuthClient-test.js
+++ b/test/ScalarAuthClient-test.js
@@ -29,7 +29,7 @@ describe('ScalarAuthClient', function() {
it('should request a new token if the old one fails', async function() {
const sac = new ScalarAuthClient();
- sac._getAccountName = jest.fn((arg) => {
+ sac.getAccountName = jest.fn((arg) => {
switch (arg) {
case "brokentoken":
return Promise.reject({
diff --git a/test/components/views/rooms/RoomList-test.js b/test/components/views/rooms/RoomList-test.js
index fcdd71629e..d3211f564c 100644
--- a/test/components/views/rooms/RoomList-test.js
+++ b/test/components/views/rooms/RoomList-test.js
@@ -29,7 +29,10 @@ function waitForRoomListStoreUpdate() {
describe('RoomList', () => {
function createRoom(opts) {
- const room = new Room(generateRoomId(), null, client.getUserId());
+ const room = new Room(generateRoomId(), MatrixClientPeg.get(), client.getUserId(), {
+ // The room list now uses getPendingEvents(), so we need a detached ordering.
+ pendingEventOrdering: "detached",
+ });
if (opts) {
Object.assign(room, opts);
}
diff --git a/test/stores/SpaceStore-test.ts b/test/stores/SpaceStore-test.ts
new file mode 100644
index 0000000000..aef788647d
--- /dev/null
+++ b/test/stores/SpaceStore-test.ts
@@ -0,0 +1,714 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import { EventEmitter } from "events";
+import { EventType } from "matrix-js-sdk/src/@types/event";
+
+import "../skinned-sdk"; // Must be first for skinning to work
+import SpaceStore, {
+ UPDATE_INVITED_SPACES,
+ UPDATE_SELECTED_SPACE,
+ UPDATE_TOP_LEVEL_SPACES
+} from "../../src/stores/SpaceStore";
+import { resetAsyncStoreWithClient, setupAsyncStoreWithClient } from "../utils/test-utils";
+import { mkEvent, mkStubRoom, stubClient } from "../test-utils";
+import { EnhancedMap } from "../../src/utils/maps";
+import SettingsStore from "../../src/settings/SettingsStore";
+import DMRoomMap from "../../src/utils/DMRoomMap";
+import { MatrixClientPeg } from "../../src/MatrixClientPeg";
+import defaultDispatcher from "../../src/dispatcher/dispatcher";
+
+type MatrixEvent = any; // importing from js-sdk upsets things
+
+jest.useFakeTimers();
+
+const mockStateEventImplementation = (events: MatrixEvent[]) => {
+ const stateMap = new EnhancedMap>();
+ events.forEach(event => {
+ stateMap.getOrCreate(event.getType(), new Map()).set(event.getStateKey(), event);
+ });
+
+ return (eventType: string, stateKey?: string) => {
+ if (stateKey || stateKey === "") {
+ return stateMap.get(eventType)?.get(stateKey) || null;
+ }
+ return Array.from(stateMap.get(eventType)?.values() || []);
+ };
+};
+
+const emitPromise = (e: EventEmitter, k: string | symbol) => new Promise(r => e.once(k, r));
+
+const testUserId = "@test:user";
+
+let rooms = [];
+
+const mkRoom = (roomId: string) => {
+ const room = mkStubRoom(roomId);
+ room.currentState.getStateEvents.mockImplementation(mockStateEventImplementation([]));
+ rooms.push(room);
+ return room;
+};
+
+const mkSpace = (spaceId: string, children: string[] = []) => {
+ const space = mkRoom(spaceId);
+ space.isSpaceRoom.mockReturnValue(true);
+ space.currentState.getStateEvents.mockImplementation(mockStateEventImplementation(children.map(roomId =>
+ mkEvent({
+ event: true,
+ type: EventType.SpaceChild,
+ room: spaceId,
+ user: testUserId,
+ skey: roomId,
+ content: { via: [] },
+ ts: Date.now(),
+ }),
+ )));
+ return space;
+};
+
+const getValue = jest.fn();
+SettingsStore.getValue = getValue;
+
+const getUserIdForRoomId = jest.fn();
+// @ts-ignore
+DMRoomMap.sharedInstance = { getUserIdForRoomId };
+
+const fav1 = "!fav1:server";
+const fav2 = "!fav2:server";
+const fav3 = "!fav3:server";
+const dm1 = "!dm1:server";
+const dm1Partner = "@dm1Partner:server";
+const dm2 = "!dm2:server";
+const dm2Partner = "@dm2Partner:server";
+const dm3 = "!dm3:server";
+const dm3Partner = "@dm3Partner:server";
+const orphan1 = "!orphan1:server";
+const orphan2 = "!orphan2:server";
+const invite1 = "!invite1:server";
+const invite2 = "!invite2:server";
+const room1 = "!room1:server";
+const room2 = "!room2:server";
+const space1 = "!space1:server";
+const space2 = "!space2:server";
+const space3 = "!space3:server";
+
+describe("SpaceStore", () => {
+ stubClient();
+ const store = SpaceStore.instance;
+ const client = MatrixClientPeg.get();
+
+ const viewRoom = roomId => defaultDispatcher.dispatch({ action: "view_room", room_id: roomId }, true);
+
+ const run = async () => {
+ client.getRoom.mockImplementation(roomId => rooms.find(room => room.roomId === roomId));
+ await setupAsyncStoreWithClient(store, client);
+ jest.runAllTimers();
+ };
+
+ beforeEach(() => {
+ jest.runAllTimers();
+ client.getVisibleRooms.mockReturnValue(rooms = []);
+ getValue.mockImplementation(settingName => {
+ if (settingName === "feature_spaces") {
+ return true;
+ }
+ });
+ });
+ afterEach(async () => {
+ await resetAsyncStoreWithClient(store);
+ });
+
+ describe("static hierarchy resolution tests", () => {
+ it("handles no spaces", async () => {
+ await run();
+
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+ });
+
+ it("handles 3 joined top level spaces", async () => {
+ mkSpace("!space1:server");
+ mkSpace("!space2:server");
+ mkSpace("!space3:server");
+ await run();
+
+ expect(store.spacePanelSpaces.sort()).toStrictEqual(client.getVisibleRooms().sort());
+ expect(store.invitedSpaces).toStrictEqual([]);
+ });
+
+ it("handles a basic hierarchy", async () => {
+ mkSpace("!space1:server");
+ mkSpace("!space2:server");
+ mkSpace("!company:server", [
+ mkSpace("!company_dept1:server", [
+ mkSpace("!company_dept1_group1:server").roomId,
+ ]).roomId,
+ mkSpace("!company_dept2:server").roomId,
+ ]);
+ await run();
+
+ expect(store.spacePanelSpaces.map(r => r.roomId).sort()).toStrictEqual([
+ "!space1:server",
+ "!space2:server",
+ "!company:server",
+ ].sort());
+ expect(store.invitedSpaces).toStrictEqual([]);
+
+ expect(store.getChildRooms("!space1:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!space1:server")).toStrictEqual([]);
+ expect(store.getChildRooms("!space2:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!space2:server")).toStrictEqual([]);
+ expect(store.getChildRooms("!company:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company:server")).toStrictEqual([
+ client.getRoom("!company_dept1:server"),
+ client.getRoom("!company_dept2:server"),
+ ]);
+ expect(store.getChildRooms("!company_dept1:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company_dept1:server")).toStrictEqual([
+ client.getRoom("!company_dept1_group1:server"),
+ ]);
+ expect(store.getChildRooms("!company_dept1_group1:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company_dept1_group1:server")).toStrictEqual([]);
+ expect(store.getChildRooms("!company_dept2:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company_dept2:server")).toStrictEqual([]);
+ });
+
+ it("handles a sub-space existing in multiple places in the space tree", async () => {
+ const subspace = mkSpace("!subspace:server");
+ mkSpace("!space1:server");
+ mkSpace("!space2:server");
+ mkSpace("!company:server", [
+ mkSpace("!company_dept1:server", [
+ mkSpace("!company_dept1_group1:server", [subspace.roomId]).roomId,
+ ]).roomId,
+ mkSpace("!company_dept2:server", [subspace.roomId]).roomId,
+ subspace.roomId,
+ ]);
+ await run();
+
+ expect(store.spacePanelSpaces.map(r => r.roomId).sort()).toStrictEqual([
+ "!space1:server",
+ "!space2:server",
+ "!company:server",
+ ].sort());
+ expect(store.invitedSpaces).toStrictEqual([]);
+
+ expect(store.getChildRooms("!space1:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!space1:server")).toStrictEqual([]);
+ expect(store.getChildRooms("!space2:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!space2:server")).toStrictEqual([]);
+ expect(store.getChildRooms("!company:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company:server")).toStrictEqual([
+ client.getRoom("!company_dept1:server"),
+ client.getRoom("!company_dept2:server"),
+ subspace,
+ ]);
+ expect(store.getChildRooms("!company_dept1:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company_dept1:server")).toStrictEqual([
+ client.getRoom("!company_dept1_group1:server"),
+ ]);
+ expect(store.getChildRooms("!company_dept1_group1:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company_dept1_group1:server")).toStrictEqual([subspace]);
+ expect(store.getChildRooms("!company_dept2:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!company_dept2:server")).toStrictEqual([subspace]);
+ });
+
+ it("handles full cycles", async () => {
+ mkSpace("!a:server", [
+ mkSpace("!b:server", [
+ mkSpace("!c:server", [
+ "!a:server",
+ ]).roomId,
+ ]).roomId,
+ ]);
+ await run();
+
+ expect(store.spacePanelSpaces.map(r => r.roomId)).toStrictEqual(["!a:server"]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+
+ expect(store.getChildRooms("!a:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!a:server")).toStrictEqual([client.getRoom("!b:server")]);
+ expect(store.getChildRooms("!b:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!b:server")).toStrictEqual([client.getRoom("!c:server")]);
+ expect(store.getChildRooms("!c:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!c:server")).toStrictEqual([client.getRoom("!a:server")]);
+ });
+
+ it("handles partial cycles", async () => {
+ mkSpace("!b:server", [
+ mkSpace("!a:server", [
+ mkSpace("!c:server", [
+ "!a:server",
+ ]).roomId,
+ ]).roomId,
+ ]);
+ await run();
+
+ expect(store.spacePanelSpaces.map(r => r.roomId)).toStrictEqual(["!b:server"]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+
+ expect(store.getChildRooms("!b:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!b:server")).toStrictEqual([client.getRoom("!a:server")]);
+ expect(store.getChildRooms("!a:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!a:server")).toStrictEqual([client.getRoom("!c:server")]);
+ expect(store.getChildRooms("!c:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!c:server")).toStrictEqual([client.getRoom("!a:server")]);
+ });
+
+ it("handles partial cycles with additional spaces coming off them", async () => {
+ // TODO this test should be failing right now
+ mkSpace("!a:server", [
+ mkSpace("!b:server", [
+ mkSpace("!c:server", [
+ "!a:server",
+ mkSpace("!d:server").roomId,
+ ]).roomId,
+ ]).roomId,
+ ]);
+ await run();
+
+ expect(store.spacePanelSpaces.map(r => r.roomId)).toStrictEqual(["!a:server"]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+
+ expect(store.getChildRooms("!a:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!a:server")).toStrictEqual([client.getRoom("!b:server")]);
+ expect(store.getChildRooms("!b:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!b:server")).toStrictEqual([client.getRoom("!c:server")]);
+ expect(store.getChildRooms("!c:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!c:server")).toStrictEqual([
+ client.getRoom("!a:server"),
+ client.getRoom("!d:server"),
+ ]);
+ expect(store.getChildRooms("!d:server")).toStrictEqual([]);
+ expect(store.getChildSpaces("!d:server")).toStrictEqual([]);
+ });
+
+ it("invite to a subspace is only shown at the top level", async () => {
+ mkSpace(invite1).getMyMembership.mockReturnValue("invite");
+ mkSpace(space1, [invite1]);
+ await run();
+
+ expect(store.spacePanelSpaces).toStrictEqual([client.getRoom(space1)]);
+ expect(store.getChildSpaces(space1)).toStrictEqual([]);
+ expect(store.getChildRooms(space1)).toStrictEqual([]);
+ expect(store.invitedSpaces).toStrictEqual([client.getRoom(invite1)]);
+ });
+
+ describe("test fixture 1", () => {
+ beforeEach(async () => {
+ [fav1, fav2, fav3, dm1, dm2, dm3, orphan1, orphan2, invite1, invite2, room1].forEach(mkRoom);
+ mkSpace(space1, [fav1, room1]);
+ mkSpace(space2, [fav1, fav2, fav3, room1]);
+ mkSpace(space3, [invite2]);
+
+ [fav1, fav2, fav3].forEach(roomId => {
+ client.getRoom(roomId).tags = {
+ "m.favourite": {
+ order: 0.5,
+ },
+ };
+ });
+
+ [invite1, invite2].forEach(roomId => {
+ client.getRoom(roomId).getMyMembership.mockReturnValue("invite");
+ });
+
+ getUserIdForRoomId.mockImplementation(roomId => {
+ return {
+ [dm1]: dm1Partner,
+ [dm2]: dm2Partner,
+ [dm3]: dm3Partner,
+ }[roomId];
+ });
+ await run();
+ });
+
+ it("home space contains orphaned rooms", () => {
+ expect(store.getSpaceFilteredRoomIds(null).has(orphan1)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(null).has(orphan2)).toBeTruthy();
+ });
+
+ it("home space contains favourites", () => {
+ expect(store.getSpaceFilteredRoomIds(null).has(fav1)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(null).has(fav2)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(null).has(fav3)).toBeTruthy();
+ });
+
+ it("home space contains dm rooms", () => {
+ expect(store.getSpaceFilteredRoomIds(null).has(dm1)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(null).has(dm2)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(null).has(dm3)).toBeTruthy();
+ });
+
+ it("home space contains invites", () => {
+ expect(store.getSpaceFilteredRoomIds(null).has(invite1)).toBeTruthy();
+ });
+
+ it("home space contains invites even if they are also shown in a space", () => {
+ expect(store.getSpaceFilteredRoomIds(null).has(invite2)).toBeTruthy();
+ });
+
+ it("home space does not contain rooms/low priority from rooms within spaces", () => {
+ expect(store.getSpaceFilteredRoomIds(null).has(room1)).toBeFalsy();
+ });
+
+ it("space contains child rooms", () => {
+ const space = client.getRoom(space1);
+ expect(store.getSpaceFilteredRoomIds(space).has(fav1)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(space).has(room1)).toBeTruthy();
+ });
+
+ it("space contains child favourites", () => {
+ const space = client.getRoom(space2);
+ expect(store.getSpaceFilteredRoomIds(space).has(fav1)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(space).has(fav2)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(space).has(fav3)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(space).has(room1)).toBeTruthy();
+ });
+
+ it("space contains child invites", () => {
+ const space = client.getRoom(space3);
+ expect(store.getSpaceFilteredRoomIds(space).has(invite2)).toBeTruthy();
+ });
+ });
+ });
+
+ describe("hierarchy resolution update tests", () => {
+ let emitter: EventEmitter;
+ beforeEach(async () => {
+ emitter = new EventEmitter();
+ client.on.mockImplementation(emitter.on.bind(emitter));
+ client.removeListener.mockImplementation(emitter.removeListener.bind(emitter));
+ });
+ afterEach(() => {
+ client.on.mockReset();
+ client.removeListener.mockReset();
+ });
+
+ it("updates state when spaces are joined", async () => {
+ await run();
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ const space = mkSpace(space1);
+ const prom = emitPromise(store, UPDATE_TOP_LEVEL_SPACES);
+ emitter.emit("Room", space);
+ await prom;
+ expect(store.spacePanelSpaces).toStrictEqual([space]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+ });
+
+ it("updates state when spaces are left", async () => {
+ const space = mkSpace(space1);
+ await run();
+
+ expect(store.spacePanelSpaces).toStrictEqual([space]);
+ space.getMyMembership.mockReturnValue("leave");
+ const prom = emitPromise(store, UPDATE_TOP_LEVEL_SPACES);
+ emitter.emit("Room.myMembership", space, "leave", "join");
+ await prom;
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ });
+
+ it("updates state when space invite comes in", async () => {
+ await run();
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+ const space = mkSpace(space1);
+ space.getMyMembership.mockReturnValue("invite");
+ const prom = emitPromise(store, UPDATE_INVITED_SPACES);
+ emitter.emit("Room", space);
+ await prom;
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ expect(store.invitedSpaces).toStrictEqual([space]);
+ });
+
+ it("updates state when space invite is accepted", async () => {
+ const space = mkSpace(space1);
+ space.getMyMembership.mockReturnValue("invite");
+ await run();
+
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ expect(store.invitedSpaces).toStrictEqual([space]);
+ space.getMyMembership.mockReturnValue("join");
+ const prom = emitPromise(store, UPDATE_TOP_LEVEL_SPACES);
+ emitter.emit("Room.myMembership", space, "join", "invite");
+ await prom;
+ expect(store.spacePanelSpaces).toStrictEqual([space]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+ });
+
+ it("updates state when space invite is rejected", async () => {
+ const space = mkSpace(space1);
+ space.getMyMembership.mockReturnValue("invite");
+ await run();
+
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ expect(store.invitedSpaces).toStrictEqual([space]);
+ space.getMyMembership.mockReturnValue("leave");
+ const prom = emitPromise(store, UPDATE_INVITED_SPACES);
+ emitter.emit("Room.myMembership", space, "leave", "invite");
+ await prom;
+ expect(store.spacePanelSpaces).toStrictEqual([]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+ });
+
+ it("room invite gets added to relevant space filters", async () => {
+ const space = mkSpace(space1, [invite1]);
+ await run();
+
+ expect(store.spacePanelSpaces).toStrictEqual([space]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+ expect(store.getChildSpaces(space1)).toStrictEqual([]);
+ expect(store.getChildRooms(space1)).toStrictEqual([]);
+ expect(store.getSpaceFilteredRoomIds(client.getRoom(space1)).has(invite1)).toBeFalsy();
+ expect(store.getSpaceFilteredRoomIds(null).has(invite1)).toBeFalsy();
+
+ const invite = mkRoom(invite1);
+ invite.getMyMembership.mockReturnValue("invite");
+ const prom = emitPromise(store, space1);
+ emitter.emit("Room", space);
+ await prom;
+
+ expect(store.spacePanelSpaces).toStrictEqual([space]);
+ expect(store.invitedSpaces).toStrictEqual([]);
+ expect(store.getChildSpaces(space1)).toStrictEqual([]);
+ expect(store.getChildRooms(space1)).toStrictEqual([invite]);
+ expect(store.getSpaceFilteredRoomIds(client.getRoom(space1)).has(invite1)).toBeTruthy();
+ expect(store.getSpaceFilteredRoomIds(null).has(invite1)).toBeTruthy();
+ });
+ });
+
+ describe("active space switching tests", () => {
+ const fn = jest.spyOn(store, "emit");
+
+ beforeEach(async () => {
+ mkRoom(room1); // not a space
+ mkSpace(space1, [
+ mkSpace(space2).roomId,
+ ]);
+ mkSpace(space3).getMyMembership.mockReturnValue("invite");
+ await run();
+ await store.setActiveSpace(null);
+ expect(store.activeSpace).toBe(null);
+ });
+ afterEach(() => {
+ fn.mockClear();
+ });
+
+ it("switch to home space", async () => {
+ await store.setActiveSpace(client.getRoom(space1));
+ fn.mockClear();
+
+ await store.setActiveSpace(null);
+ expect(fn).toHaveBeenCalledWith(UPDATE_SELECTED_SPACE, null);
+ expect(store.activeSpace).toBe(null);
+ });
+
+ it("switch to invited space", async () => {
+ const space = client.getRoom(space3);
+ await store.setActiveSpace(space);
+ expect(fn).toHaveBeenCalledWith(UPDATE_SELECTED_SPACE, space);
+ expect(store.activeSpace).toBe(space);
+ });
+
+ it("switch to top level space", async () => {
+ const space = client.getRoom(space1);
+ await store.setActiveSpace(space);
+ expect(fn).toHaveBeenCalledWith(UPDATE_SELECTED_SPACE, space);
+ expect(store.activeSpace).toBe(space);
+ });
+
+ it("switch to subspace", async () => {
+ const space = client.getRoom(space2);
+ await store.setActiveSpace(space);
+ expect(fn).toHaveBeenCalledWith(UPDATE_SELECTED_SPACE, space);
+ expect(store.activeSpace).toBe(space);
+ });
+
+ it("switch to unknown space is a nop", async () => {
+ expect(store.activeSpace).toBe(null);
+ const space = client.getRoom(room1); // not a space
+ await store.setActiveSpace(space);
+ expect(fn).not.toHaveBeenCalledWith(UPDATE_SELECTED_SPACE, space);
+ expect(store.activeSpace).toBe(null);
+ });
+ });
+
+ describe("context switching tests", () => {
+ const fn = jest.spyOn(defaultDispatcher, "dispatch");
+
+ beforeEach(async () => {
+ [room1, room2, orphan1].forEach(mkRoom);
+ mkSpace(space1, [room1, room2]);
+ mkSpace(space2, [room2]);
+ await run();
+ });
+ afterEach(() => {
+ fn.mockClear();
+ localStorage.clear();
+ });
+
+ const getCurrentRoom = () => fn.mock.calls.reverse().find(([p]) => p.action === "view_room")?.[0].room_id;
+
+ it("last viewed room in target space is the current viewed and in both spaces", async () => {
+ await store.setActiveSpace(client.getRoom(space1));
+ viewRoom(room2);
+ await store.setActiveSpace(client.getRoom(space2));
+ viewRoom(room2);
+ await store.setActiveSpace(client.getRoom(space1));
+ expect(getCurrentRoom()).toBe(room2);
+ });
+
+ it("last viewed room in target space is in the current space", async () => {
+ await store.setActiveSpace(client.getRoom(space1));
+ viewRoom(room2);
+ await store.setActiveSpace(client.getRoom(space2));
+ expect(getCurrentRoom()).toBe(space2);
+ await store.setActiveSpace(client.getRoom(space1));
+ expect(getCurrentRoom()).toBe(room2);
+ });
+
+ it("last viewed room in target space is not in the current space", async () => {
+ await store.setActiveSpace(client.getRoom(space1));
+ viewRoom(room1);
+ await store.setActiveSpace(client.getRoom(space2));
+ viewRoom(room2);
+ await store.setActiveSpace(client.getRoom(space1));
+ expect(getCurrentRoom()).toBe(room1);
+ });
+
+ it("last viewed room is target space is not known", async () => {
+ await store.setActiveSpace(client.getRoom(space1));
+ viewRoom(room1);
+ localStorage.setItem(`mx_space_context_${space2}`, orphan2);
+ await store.setActiveSpace(client.getRoom(space2));
+ expect(getCurrentRoom()).toBe(space2);
+ });
+
+ it("no last viewed room in target space", async () => {
+ await store.setActiveSpace(client.getRoom(space1));
+ viewRoom(room1);
+ await store.setActiveSpace(client.getRoom(space2));
+ expect(getCurrentRoom()).toBe(space2);
+ });
+
+ it("no last viewed room in home space", async () => {
+ await store.setActiveSpace(client.getRoom(space1));
+ viewRoom(room1);
+ await store.setActiveSpace(null);
+ expect(fn.mock.calls[fn.mock.calls.length - 1][0]).toStrictEqual({ action: "view_home_page" });
+ });
+ });
+
+ describe("space auto switching tests", () => {
+ beforeEach(async () => {
+ [room1, room2, orphan1].forEach(mkRoom);
+ mkSpace(space1, [room1, room2]);
+ mkSpace(space2, [room1, room2]);
+
+ client.getRoom(room2).currentState.getStateEvents.mockImplementation(mockStateEventImplementation([
+ mkEvent({
+ event: true,
+ type: EventType.SpaceParent,
+ room: room2,
+ user: testUserId,
+ skey: space2,
+ content: { via: [], canonical: true },
+ ts: Date.now(),
+ }),
+ ]));
+ await run();
+ });
+
+ it("no switch required, room is in current space", async () => {
+ viewRoom(room1);
+ await store.setActiveSpace(client.getRoom(space1), false);
+ viewRoom(room2);
+ expect(store.activeSpace).toBe(client.getRoom(space1));
+ });
+
+ it("switch to canonical parent space for room", async () => {
+ viewRoom(room1);
+ await store.setActiveSpace(null, false);
+ viewRoom(room2);
+ expect(store.activeSpace).toBe(client.getRoom(space2));
+ });
+
+ it("switch to first containing space for room", async () => {
+ viewRoom(room2);
+ await store.setActiveSpace(null, false);
+ viewRoom(room1);
+ expect(store.activeSpace).toBe(client.getRoom(space1));
+ });
+
+ it("switch to home for orphaned room", async () => {
+ viewRoom(room1);
+ await store.setActiveSpace(client.getRoom(space1), false);
+ viewRoom(orphan1);
+ expect(store.activeSpace).toBeNull();
+ });
+ });
+
+ describe("traverseSpace", () => {
+ beforeEach(() => {
+ mkSpace("!a:server", [
+ mkSpace("!b:server", [
+ mkSpace("!c:server", [
+ "!a:server",
+ mkRoom("!c-child:server").roomId,
+ mkRoom("!shared-child:server").roomId,
+ ]).roomId,
+ mkRoom("!b-child:server").roomId,
+ ]).roomId,
+ mkRoom("!a-child:server").roomId,
+ "!shared-child:server",
+ ]);
+ });
+
+ it("avoids cycles", () => {
+ const fn = jest.fn();
+ store.traverseSpace("!b:server", fn);
+
+ expect(fn).toBeCalledTimes(3);
+ expect(fn).toBeCalledWith("!a:server");
+ expect(fn).toBeCalledWith("!b:server");
+ expect(fn).toBeCalledWith("!c:server");
+ });
+
+ it("including rooms", () => {
+ const fn = jest.fn();
+ store.traverseSpace("!b:server", fn, true);
+
+ expect(fn).toBeCalledTimes(8); // twice for shared-child
+ expect(fn).toBeCalledWith("!a:server");
+ expect(fn).toBeCalledWith("!a-child:server");
+ expect(fn).toBeCalledWith("!b:server");
+ expect(fn).toBeCalledWith("!b-child:server");
+ expect(fn).toBeCalledWith("!c:server");
+ expect(fn).toBeCalledWith("!c-child:server");
+ expect(fn).toBeCalledWith("!shared-child:server");
+ });
+
+ it("excluding rooms", () => {
+ const fn = jest.fn();
+ store.traverseSpace("!b:server", fn, false);
+
+ expect(fn).toBeCalledTimes(3);
+ expect(fn).toBeCalledWith("!a:server");
+ expect(fn).toBeCalledWith("!b:server");
+ expect(fn).toBeCalledWith("!c:server");
+ });
+ });
+});
diff --git a/test/test-utils.js b/test/test-utils.js
index d259fcb95f..6dc02463a5 100644
--- a/test/test-utils.js
+++ b/test/test-utils.js
@@ -64,6 +64,11 @@ export function createTestClient() {
getRoomIdForAlias: jest.fn().mockResolvedValue(undefined),
getRoomDirectoryVisibility: jest.fn().mockResolvedValue(undefined),
getProfileInfo: jest.fn().mockResolvedValue({}),
+ getThirdpartyProtocols: jest.fn().mockResolvedValue({}),
+ getClientWellKnown: jest.fn().mockReturnValue(null),
+ supportsVoip: jest.fn().mockReturnValue(true),
+ getTurnServersExpiry: jest.fn().mockReturnValue(2^32),
+ getThirdpartyUser: jest.fn().mockResolvedValue([]),
getAccountData: (type) => {
return mkEvent({
type,
@@ -79,6 +84,17 @@ export function createTestClient() {
generateClientSecret: () => "t35tcl1Ent5ECr3T",
isGuest: () => false,
isCryptoEnabled: () => false,
+ getSpaceSummary: jest.fn().mockReturnValue({
+ rooms: [],
+ events: [],
+ }),
+
+ // Used by various internal bits we aren't concerned with (yet)
+ _sessionStore: {
+ store: {
+ getItem: jest.fn(),
+ },
+ },
};
}
@@ -88,8 +104,8 @@ export function createTestClient() {
* @param {string} opts.type The event.type
* @param {string} opts.room The event.room_id
* @param {string} opts.user The event.user_id
- * @param {string} opts.skey Optional. The state key (auto inserts empty string)
- * @param {Number} opts.ts Optional. Timestamp for the event
+ * @param {string=} opts.skey Optional. The state key (auto inserts empty string)
+ * @param {number=} opts.ts Optional. Timestamp for the event
* @param {Object} opts.content The event.content
* @param {boolean} opts.event True to make a MatrixEvent.
* @return {Object} a JSON object representing this event.
@@ -224,7 +240,7 @@ export function mkStubRoom(roomId = null) {
hasMembershipState: () => null,
getVersion: () => '1',
shouldUpgradeToVersion: () => null,
- getMyMembership: () => "join",
+ getMyMembership: jest.fn().mockReturnValue("join"),
maySendMessage: jest.fn().mockReturnValue(true),
currentState: {
getStateEvents: jest.fn(),
@@ -233,17 +249,17 @@ export function mkStubRoom(roomId = null) {
maySendEvent: jest.fn().mockReturnValue(true),
members: [],
},
- tags: {
- "m.favourite": {
- order: 0.5,
- },
- },
+ tags: {},
setBlacklistUnverifiedDevices: jest.fn(),
on: jest.fn(),
removeListener: jest.fn(),
getDMInviter: jest.fn(),
getAvatarUrl: () => 'mxc://avatar.url/room.png',
getMxcAvatarUrl: () => 'mxc://avatar.url/room.png',
+ isSpaceRoom: jest.fn(() => false),
+ getUnreadNotificationCount: jest.fn(() => 0),
+ getEventReadUpTo: jest.fn(() => null),
+ timeline: [],
};
}
diff --git a/test/utils/ShieldUtils-test.js b/test/utils/ShieldUtils-test.js
index 8e3b19c1c4..bea3d26565 100644
--- a/test/utils/ShieldUtils-test.js
+++ b/test/utils/ShieldUtils-test.js
@@ -128,7 +128,7 @@ describe("shieldStatusForMembership self-trust behaviour", function() {
describe("shieldStatusForMembership other-trust behaviour", function() {
beforeAll(() => {
- DMRoomMap._sharedInstance = {
+ DMRoomMap.sharedInstance = {
getUserIdForRoomId: (roomId) => roomId === "DM" ? "@any:h" : null,
};
});
diff --git a/test/Singleflight-test.ts b/test/utils/Singleflight-test.ts
similarity index 98%
rename from test/Singleflight-test.ts
rename to test/utils/Singleflight-test.ts
index 4f0c6e0da3..80258701bb 100644
--- a/test/Singleflight-test.ts
+++ b/test/utils/Singleflight-test.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import {Singleflight} from "../src/utils/Singleflight";
+import {Singleflight} from "../../src/utils/Singleflight";
describe('Singleflight', () => {
afterEach(() => {
diff --git a/test/utils/arrays-test.ts b/test/utils/arrays-test.ts
new file mode 100644
index 0000000000..c5be59ab43
--- /dev/null
+++ b/test/utils/arrays-test.ts
@@ -0,0 +1,327 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {
+ arrayDiff,
+ arrayFastClone,
+ arrayFastResample,
+ arrayHasDiff,
+ arrayHasOrderChange,
+ arrayMerge,
+ arraySeed,
+ arrayTrimFill,
+ arrayUnion,
+ ArrayUtil,
+ GroupedArray,
+} from "../../src/utils/arrays";
+import {objectFromEntries} from "../../src/utils/objects";
+
+function expectSample(i: number, input: number[], expected: number[]) {
+ console.log(`Resample case index: ${i}`); // for debugging test failures
+ const result = arrayFastResample(input, expected.length);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(expected.length);
+ expect(result).toEqual(expected);
+}
+
+describe('arrays', () => {
+ describe('arrayFastResample', () => {
+ it('should downsample', () => {
+ [
+ {input: [1, 2, 3, 4, 5], output: [1, 4]}, // Odd -> Even
+ {input: [1, 2, 3, 4, 5], output: [1, 3, 5]}, // Odd -> Odd
+ {input: [1, 2, 3, 4], output: [1, 2, 3]}, // Even -> Odd
+ {input: [1, 2, 3, 4], output: [1, 3]}, // Even -> Even
+ ].forEach((c, i) => expectSample(i, c.input, c.output));
+ });
+
+ it('should upsample', () => {
+ [
+ {input: [1, 2, 3], output: [1, 1, 2, 2, 3, 3]}, // Odd -> Even
+ {input: [1, 2, 3], output: [1, 1, 2, 2, 3]}, // Odd -> Odd
+ {input: [1, 2], output: [1, 1, 1, 2, 2]}, // Even -> Odd
+ {input: [1, 2], output: [1, 1, 1, 2, 2, 2]}, // Even -> Even
+ ].forEach((c, i) => expectSample(i, c.input, c.output));
+ });
+
+ it('should maintain sample', () => {
+ [
+ {input: [1, 2, 3], output: [1, 2, 3]}, // Odd
+ {input: [1, 2], output: [1, 2]}, // Even
+ ].forEach((c, i) => expectSample(i, c.input, c.output));
+ });
+ });
+
+ describe('arrayTrimFill', () => {
+ it('should shrink arrays', () => {
+ const input = [1, 2, 3];
+ const output = [1, 2];
+ const seed = [4, 5, 6];
+ const result = arrayTrimFill(input, output.length, seed);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(output.length);
+ expect(result).toEqual(output);
+ });
+
+ it('should expand arrays', () => {
+ const input = [1, 2, 3];
+ const output = [1, 2, 3, 4, 5];
+ const seed = [4, 5, 6];
+ const result = arrayTrimFill(input, output.length, seed);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(output.length);
+ expect(result).toEqual(output);
+ });
+
+ it('should keep arrays the same', () => {
+ const input = [1, 2, 3];
+ const output = [1, 2, 3];
+ const seed = [4, 5, 6];
+ const result = arrayTrimFill(input, output.length, seed);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(output.length);
+ expect(result).toEqual(output);
+ });
+ });
+
+ describe('arraySeed', () => {
+ it('should create an array of given length', () => {
+ const val = 1;
+ const output = [val, val, val];
+ const result = arraySeed(val, output.length);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(output.length);
+ expect(result).toEqual(output);
+ });
+ it('should maintain pointers', () => {
+ const val = {}; // this works because `{} !== {}`, which is what toEqual checks
+ const output = [val, val, val];
+ const result = arraySeed(val, output.length);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(output.length);
+ expect(result).toEqual(output);
+ });
+ });
+
+ describe('arrayFastClone', () => {
+ it('should break pointer reference on source array', () => {
+ const val = {}; // we'll test to make sure the values maintain pointers too
+ const input = [val, val, val];
+ const result = arrayFastClone(input);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(input.length);
+ expect(result).toEqual(input); // we want the array contents to match...
+ expect(result).not.toBe(input); // ... but be a different reference
+ });
+ });
+
+ describe('arrayHasOrderChange', () => {
+ it('should flag true on B ordering difference', () => {
+ const a = [1, 2, 3];
+ const b = [3, 2, 1];
+ const result = arrayHasOrderChange(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag false on no ordering difference', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 3];
+ const result = arrayHasOrderChange(a, b);
+ expect(result).toBe(false);
+ });
+
+ it('should flag true on A length > B length', () => {
+ const a = [1, 2, 3, 4];
+ const b = [1, 2, 3];
+ const result = arrayHasOrderChange(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag true on A length < B length', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 3, 4];
+ const result = arrayHasOrderChange(a, b);
+ expect(result).toBe(true);
+ });
+ });
+
+ describe('arrayHasDiff', () => {
+ it('should flag true on A length > B length', () => {
+ const a = [1, 2, 3, 4];
+ const b = [1, 2, 3];
+ const result = arrayHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag true on A length < B length', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 3, 4];
+ const result = arrayHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag true on element differences', () => {
+ const a = [1, 2, 3];
+ const b = [4, 5, 6];
+ const result = arrayHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag false if same but order different', () => {
+ const a = [1, 2, 3];
+ const b = [3, 1, 2];
+ const result = arrayHasDiff(a, b);
+ expect(result).toBe(false);
+ });
+
+ it('should flag false if same', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 3];
+ const result = arrayHasDiff(a, b);
+ expect(result).toBe(false);
+ });
+ });
+
+ describe('arrayDiff', () => {
+ it('should see added from A->B', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 3, 4];
+ const result = arrayDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(0);
+ expect(result.added).toEqual([4]);
+ });
+
+ it('should see removed from A->B', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2];
+ const result = arrayDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(1);
+ expect(result.removed).toEqual([3]);
+ });
+
+ it('should see added and removed in the same set', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 4]; // note diff
+ const result = arrayDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(1);
+ expect(result.added).toEqual([4]);
+ expect(result.removed).toEqual([3]);
+ });
+ });
+
+ describe('arrayUnion', () => {
+ it('should return a union', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 4]; // note diff
+ const result = arrayUnion(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(2);
+ expect(result).toEqual([1, 2]);
+ });
+
+ it('should return an empty array on no matches', () => {
+ const a = [1, 2, 3];
+ const b = [4, 5, 6];
+ const result = arrayUnion(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(0);
+ });
+ });
+
+ describe('arrayMerge', () => {
+ it('should merge 3 arrays with deduplication', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 4, 5]; // note missing 3
+ const c = [6, 7, 8, 9];
+ const result = arrayMerge(a, b, c);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(9);
+ expect(result).toEqual([1, 2, 3, 4, 5, 6, 7, 8, 9]);
+ });
+
+ it('should deduplicate a single array', () => {
+ // dev note: this is technically an edge case, but it is described behaviour if the
+ // function is only provided one function (it'll merge the array against itself)
+ const a = [1, 1, 2, 2, 3, 3];
+ const result = arrayMerge(a);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(3);
+ expect(result).toEqual([1, 2, 3]);
+ });
+ });
+
+ describe('ArrayUtil', () => {
+ it('should maintain the pointer to the given array', () => {
+ const input = [1, 2, 3];
+ const result = new ArrayUtil(input);
+ expect(result.value).toBe(input);
+ });
+
+ it('should group appropriately', () => {
+ const input = [['a', 1], ['b', 2], ['c', 3], ['a', 4], ['a', 5], ['b', 6]];
+ const output = {
+ 'a': [['a', 1], ['a', 4], ['a', 5]],
+ 'b': [['b', 2], ['b', 6]],
+ 'c': [['c', 3]],
+ };
+ const result = new ArrayUtil(input).groupBy(p => p[0]);
+ expect(result).toBeDefined();
+ expect(result.value).toBeDefined();
+
+ const asObject = objectFromEntries(result.value.entries());
+ expect(asObject).toMatchObject(output);
+ });
+ });
+
+ describe('GroupedArray', () => {
+ it('should maintain the pointer to the given map', () => {
+ const input = new Map([
+ ['a', [1, 2, 3]],
+ ['b', [7, 8, 9]],
+ ['c', [4, 5, 6]],
+ ]);
+ const result = new GroupedArray(input);
+ expect(result.value).toBe(input);
+ });
+
+ it('should ordering by the provided key order', () => {
+ const input = new Map([
+ ['a', [1, 2, 3]],
+ ['b', [7, 8, 9]], // note counting diff
+ ['c', [4, 5, 6]],
+ ]);
+ const output = [4, 5, 6, 1, 2, 3, 7, 8, 9];
+ const keyOrder = ['c', 'a', 'b']; // note weird order to cause the `output` to be strange
+ const result = new GroupedArray(input).orderBy(keyOrder);
+ expect(result).toBeDefined();
+ expect(result.value).toBeDefined();
+ expect(result.value).toEqual(output);
+ });
+ });
+});
+
diff --git a/test/utils/enums-test.ts b/test/utils/enums-test.ts
new file mode 100644
index 0000000000..423b135f77
--- /dev/null
+++ b/test/utils/enums-test.ts
@@ -0,0 +1,67 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {getEnumValues, isEnumValue} from "../../src/utils/enums";
+
+enum TestStringEnum {
+ First = "__first__",
+ Second = "__second__",
+}
+
+enum TestNumberEnum {
+ FirstKey = 10,
+ SecondKey = 20,
+}
+
+describe('enums', () => {
+ describe('getEnumValues', () => {
+ it('should work on string enums', () => {
+ const result = getEnumValues(TestStringEnum);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(2);
+ expect(result).toEqual(['__first__', '__second__']);
+ });
+
+ it('should work on number enums', () => {
+ const result = getEnumValues(TestNumberEnum);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(2);
+ expect(result).toEqual([10, 20]);
+ });
+ });
+
+ describe('isEnumValue', () => {
+ it('should return true on values in a string enum', () => {
+ const result = isEnumValue(TestStringEnum, '__first__');
+ expect(result).toBe(true);
+ });
+
+ it('should return false on values not in a string enum', () => {
+ const result = isEnumValue(TestStringEnum, 'not a value');
+ expect(result).toBe(false);
+ });
+
+ it('should return true on values in a number enum', () => {
+ const result = isEnumValue(TestNumberEnum, 10);
+ expect(result).toBe(true);
+ });
+
+ it('should return false on values not in a number enum', () => {
+ const result = isEnumValue(TestStringEnum, 99);
+ expect(result).toBe(false);
+ });
+ });
+});
diff --git a/test/utils/iterables-test.ts b/test/utils/iterables-test.ts
new file mode 100644
index 0000000000..9b30b6241c
--- /dev/null
+++ b/test/utils/iterables-test.ts
@@ -0,0 +1,77 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {iterableDiff, iterableUnion} from "../../src/utils/iterables";
+
+describe('iterables', () => {
+ describe('iterableUnion', () => {
+ it('should return a union', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 4]; // note diff
+ const result = iterableUnion(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(2);
+ expect(result).toEqual([1, 2]);
+ });
+
+ it('should return an empty array on no matches', () => {
+ const a = [1, 2, 3];
+ const b = [4, 5, 6];
+ const result = iterableUnion(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(0);
+ });
+ });
+
+ describe('iterableDiff', () => {
+ it('should see added from A->B', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 3, 4];
+ const result = iterableDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(0);
+ expect(result.added).toEqual([4]);
+ });
+
+ it('should see removed from A->B', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2];
+ const result = iterableDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(1);
+ expect(result.removed).toEqual([3]);
+ });
+
+ it('should see added and removed in the same set', () => {
+ const a = [1, 2, 3];
+ const b = [1, 2, 4]; // note diff
+ const result = iterableDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(1);
+ expect(result.added).toEqual([4]);
+ expect(result.removed).toEqual([3]);
+ });
+ });
+});
diff --git a/test/utils/maps-test.ts b/test/utils/maps-test.ts
new file mode 100644
index 0000000000..8764a8f2cf
--- /dev/null
+++ b/test/utils/maps-test.ts
@@ -0,0 +1,245 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {EnhancedMap, mapDiff, mapKeyChanges} from "../../src/utils/maps";
+
+describe('maps', () => {
+ describe('mapDiff', () => {
+ it('should indicate no differences when the pointers are the same', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const result = mapDiff(a, a);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(0);
+ expect(result.changed).toHaveLength(0);
+ });
+
+ it('should indicate no differences when there are none', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 2], [3, 3]]);
+ const result = mapDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(0);
+ expect(result.changed).toHaveLength(0);
+ });
+
+ it('should indicate added properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 2], [3, 3], [4, 4]]);
+ const result = mapDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(0);
+ expect(result.changed).toHaveLength(0);
+ expect(result.added).toEqual([4]);
+ });
+
+ it('should indicate removed properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 2]]);
+ const result = mapDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(1);
+ expect(result.changed).toHaveLength(0);
+ expect(result.removed).toEqual([3]);
+ });
+
+ it('should indicate changed properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 2], [3, 4]]); // note change
+ const result = mapDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(0);
+ expect(result.changed).toHaveLength(1);
+ expect(result.changed).toEqual([3]);
+ });
+
+ it('should indicate changed, added, and removed properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 8], [4, 4]]); // note change
+ const result = mapDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(1);
+ expect(result.changed).toHaveLength(1);
+ expect(result.added).toEqual([4]);
+ expect(result.removed).toEqual([3]);
+ expect(result.changed).toEqual([2]);
+ });
+
+ it('should indicate changes for difference in pointers', () => {
+ const a = new Map([[1, {}]]); // {} always creates a new object
+ const b = new Map([[1, {}]]);
+ const result = mapDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(0);
+ expect(result.changed).toHaveLength(1);
+ expect(result.changed).toEqual([1]);
+ });
+ });
+
+ describe('mapKeyChanges', () => {
+ it('should indicate no changes for unchanged pointers', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const result = mapKeyChanges(a, a);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(0);
+ });
+
+ it('should indicate no changes for unchanged maps with different pointers', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 2], [3, 3]]);
+ const result = mapKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(0);
+ });
+
+ it('should indicate changes for added properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 2], [3, 3], [4, 4]]);
+ const result = mapKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(1);
+ expect(result).toEqual([4]);
+ });
+
+ it('should indicate changes for removed properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3], [4, 4]]);
+ const b = new Map([[1, 1], [2, 2], [3, 3]]);
+ const result = mapKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(1);
+ expect(result).toEqual([4]);
+ });
+
+ it('should indicate changes for changed properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3], [4, 4]]);
+ const b = new Map([[1, 1], [2, 2], [3, 3], [4, 55]]);
+ const result = mapKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(1);
+ expect(result).toEqual([4]);
+ });
+
+ it('should indicate changes for properties with different pointers', () => {
+ const a = new Map([[1, {}]]); // {} always creates a new object
+ const b = new Map([[1, {}]]);
+ const result = mapKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(1);
+ expect(result).toEqual([1]);
+ });
+
+ it('should indicate changes for changed, added, and removed properties', () => {
+ const a = new Map([[1, 1], [2, 2], [3, 3]]);
+ const b = new Map([[1, 1], [2, 8], [4, 4]]); // note change
+ const result = mapKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(3);
+ expect(result).toEqual([3, 4, 2]); // order irrelevant, but the test cares
+ });
+ });
+
+ describe('EnhancedMap', () => {
+ // Most of these tests will make sure it implements the Map class
+
+ it('should be empty by default', () => {
+ const result = new EnhancedMap();
+ expect(result.size).toBe(0);
+ });
+
+ it('should use the provided entries', () => {
+ const obj = {a: 1, b: 2};
+ const result = new EnhancedMap(Object.entries(obj));
+ expect(result.size).toBe(2);
+ expect(result.get('a')).toBe(1);
+ expect(result.get('b')).toBe(2);
+ });
+
+ it('should create keys if they do not exist', () => {
+ const key = 'a';
+ const val = {}; // we'll check pointers
+
+ const result = new EnhancedMap();
+ expect(result.size).toBe(0);
+
+ let get = result.getOrCreate(key, val);
+ expect(get).toBeDefined();
+ expect(get).toBe(val);
+ expect(result.size).toBe(1);
+
+ get = result.getOrCreate(key, 44); // specifically change `val`
+ expect(get).toBeDefined();
+ expect(get).toBe(val);
+ expect(result.size).toBe(1);
+
+ get = result.get(key); // use the base class function
+ expect(get).toBeDefined();
+ expect(get).toBe(val);
+ expect(result.size).toBe(1);
+ });
+
+ it('should proxy remove to delete and return it', () => {
+ const val = {};
+ const result = new EnhancedMap();
+ result.set('a', val);
+
+ expect(result.size).toBe(1);
+
+ const removed = result.remove('a');
+ expect(result.size).toBe(0);
+ expect(removed).toBeDefined();
+ expect(removed).toBe(val);
+ });
+
+ it('should support removing unknown keys', () => {
+ const val = {};
+ const result = new EnhancedMap();
+ result.set('a', val);
+
+ expect(result.size).toBe(1);
+
+ const removed = result.remove('not-a');
+ expect(result.size).toBe(1);
+ expect(removed).not.toBeDefined();
+ });
+ });
+});
diff --git a/test/utils/numbers-test.ts b/test/utils/numbers-test.ts
new file mode 100644
index 0000000000..36e7d4f7e7
--- /dev/null
+++ b/test/utils/numbers-test.ts
@@ -0,0 +1,163 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {clamp, defaultNumber, percentageOf, percentageWithin, sum} from "../../src/utils/numbers";
+
+describe('numbers', () => {
+ describe('defaultNumber', () => {
+ it('should use the default when the input is not a number', () => {
+ const def = 42;
+
+ let result = defaultNumber(null, def);
+ expect(result).toBe(def);
+
+ result = defaultNumber(undefined, def);
+ expect(result).toBe(def);
+
+ result = defaultNumber(Number.NaN, def);
+ expect(result).toBe(def);
+ });
+
+ it('should use the number when it is a number', () => {
+ const input = 24;
+ const def = 42;
+ const result = defaultNumber(input, def);
+ expect(result).toBe(input);
+ });
+ });
+
+ describe('clamp', () => {
+ it('should clamp high numbers', () => {
+ const input = 101;
+ const min = 0;
+ const max = 100;
+ const result = clamp(input, min, max);
+ expect(result).toBe(max);
+ });
+
+ it('should clamp low numbers', () => {
+ const input = -1;
+ const min = 0;
+ const max = 100;
+ const result = clamp(input, min, max);
+ expect(result).toBe(min);
+ });
+
+ it('should not clamp numbers in range', () => {
+ const input = 50;
+ const min = 0;
+ const max = 100;
+ const result = clamp(input, min, max);
+ expect(result).toBe(input);
+ });
+
+ it('should clamp floats', () => {
+ const min = -0.10;
+ const max = +0.10;
+
+ let result = clamp(-1.2, min, max);
+ expect(result).toBe(min);
+
+ result = clamp(1.2, min, max);
+ expect(result).toBe(max);
+
+ result = clamp(0.02, min, max);
+ expect(result).toBe(0.02);
+ });
+ });
+
+ describe('sum', () => {
+ it('should sum', () => { // duh
+ const result = sum(1, 2, 1, 4);
+ expect(result).toBe(8);
+ });
+ });
+
+ describe('percentageWithin', () => {
+ it('should work within 0-100', () => {
+ const result = percentageWithin(0.4, 0, 100);
+ expect(result).toBe(40);
+ });
+
+ it('should work within 0-100 when pct > 1', () => {
+ const result = percentageWithin(1.4, 0, 100);
+ expect(result).toBe(140);
+ });
+
+ it('should work within 0-100 when pct < 0', () => {
+ const result = percentageWithin(-1.4, 0, 100);
+ expect(result).toBe(-140);
+ });
+
+ it('should work with ranges other than 0-100', () => {
+ const result = percentageWithin(0.4, 10, 20);
+ expect(result).toBe(14);
+ });
+
+ it('should work with ranges other than 0-100 when pct > 1', () => {
+ const result = percentageWithin(1.4, 10, 20);
+ expect(result).toBe(24);
+ });
+
+ it('should work with ranges other than 0-100 when pct < 0', () => {
+ const result = percentageWithin(-1.4, 10, 20);
+ expect(result).toBe(-4);
+ });
+
+ it('should work with floats', () => {
+ const result = percentageWithin(0.4, 10.2, 20.4);
+ expect(result).toBe(14.28);
+ });
+ });
+
+ // These are the inverse of percentageWithin
+ describe('percentageOf', () => {
+ it('should work within 0-100', () => {
+ const result = percentageOf(40, 0, 100);
+ expect(result).toBe(0.4);
+ });
+
+ it('should work within 0-100 when val > 100', () => {
+ const result = percentageOf(140, 0, 100);
+ expect(result).toBe(1.40);
+ });
+
+ it('should work within 0-100 when val < 0', () => {
+ const result = percentageOf(-140, 0, 100);
+ expect(result).toBe(-1.40);
+ });
+
+ it('should work with ranges other than 0-100', () => {
+ const result = percentageOf(14, 10, 20);
+ expect(result).toBe(0.4);
+ });
+
+ it('should work with ranges other than 0-100 when val > 100', () => {
+ const result = percentageOf(24, 10, 20);
+ expect(result).toBe(1.4);
+ });
+
+ it('should work with ranges other than 0-100 when val < 0', () => {
+ const result = percentageOf(-4, 10, 20);
+ expect(result).toBe(-1.4);
+ });
+
+ it('should work with floats', () => {
+ const result = percentageOf(14.28, 10.2, 20.4);
+ expect(result).toBe(0.4);
+ });
+ });
+});
diff --git a/test/utils/objects-test.ts b/test/utils/objects-test.ts
new file mode 100644
index 0000000000..b7a80e6761
--- /dev/null
+++ b/test/utils/objects-test.ts
@@ -0,0 +1,262 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {
+ objectClone,
+ objectDiff,
+ objectExcluding,
+ objectFromEntries,
+ objectHasDiff,
+ objectKeyChanges,
+ objectShallowClone,
+ objectWithOnly,
+} from "../../src/utils/objects";
+
+describe('objects', () => {
+ describe('objectExcluding', () => {
+ it('should exclude the given properties', () => {
+ const input = {hello: "world", test: true};
+ const output = {hello: "world"};
+ const props = ["test", "doesnotexist"]; // we also make sure it doesn't explode on missing props
+ const result = objectExcluding(input, props); // any is to test the missing prop
+ expect(result).toBeDefined();
+ expect(result).toMatchObject(output);
+ });
+ });
+
+ describe('objectWithOnly', () => {
+ it('should exclusively use the given properties', () => {
+ const input = {hello: "world", test: true};
+ const output = {hello: "world"};
+ const props = ["hello", "doesnotexist"]; // we also make sure it doesn't explode on missing props
+ const result = objectWithOnly(input, props); // any is to test the missing prop
+ expect(result).toBeDefined();
+ expect(result).toMatchObject(output);
+ });
+ });
+
+ describe('objectShallowClone', () => {
+ it('should create a new object', () => {
+ const input = {test: 1};
+ const result = objectShallowClone(input);
+ expect(result).toBeDefined();
+ expect(result).not.toBe(input);
+ expect(result).toMatchObject(input);
+ });
+
+ it('should only clone the top level properties', () => {
+ const input = {a: 1, b: {c: 2}};
+ const result = objectShallowClone(input);
+ expect(result).toBeDefined();
+ expect(result).toMatchObject(input);
+ expect(result.b).toBe(input.b);
+ });
+
+ it('should support custom clone functions', () => {
+ const input = {a: 1, b: 2};
+ const output = {a: 4, b: 8};
+ const result = objectShallowClone(input, (k, v) => {
+ // XXX: inverted expectation for ease of assertion
+ expect(Object.keys(input)).toContain(k);
+
+ return v * 4;
+ });
+ expect(result).toBeDefined();
+ expect(result).toMatchObject(output);
+ });
+ });
+
+ describe('objectHasDiff', () => {
+ it('should return false for the same pointer', () => {
+ const a = {};
+ const result = objectHasDiff(a, a);
+ expect(result).toBe(false);
+ });
+
+ it('should return true if keys for A > keys for B', () => {
+ const a = {a: 1, b: 2};
+ const b = {a: 1};
+ const result = objectHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should return true if keys for A < keys for B', () => {
+ const a = {a: 1};
+ const b = {a: 1, b: 2};
+ const result = objectHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should return false if the objects are the same but different pointers', () => {
+ const a = {a: 1, b: 2};
+ const b = {a: 1, b: 2};
+ const result = objectHasDiff(a, b);
+ expect(result).toBe(false);
+ });
+
+ it('should consider pointers when testing values', () => {
+ const a = {a: {}, b: 2}; // `{}` is shorthand for `new Object()`
+ const b = {a: {}, b: 2};
+ const result = objectHasDiff(a, b);
+ expect(result).toBe(true); // even though the keys are the same, the value pointers vary
+ });
+ });
+
+ describe('objectDiff', () => {
+ it('should return empty sets for the same object', () => {
+ const a = {a: 1, b: 2};
+ const b = {a: 1, b: 2};
+ const result = objectDiff(a, b);
+ expect(result).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toHaveLength(0);
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(0);
+ });
+
+ it('should return empty sets for the same object pointer', () => {
+ const a = {a: 1, b: 2};
+ const result = objectDiff(a, a);
+ expect(result).toBeDefined();
+ expect(result.changed).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toHaveLength(0);
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(0);
+ });
+
+ it('should indicate when property changes are made', () => {
+ const a = {a: 1, b: 2};
+ const b = {a: 11, b: 2};
+ const result = objectDiff(a, b);
+ expect(result.changed).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toHaveLength(1);
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(0);
+ expect(result.changed).toEqual(['a']);
+ });
+
+ it('should indicate when properties are added', () => {
+ const a = {a: 1, b: 2};
+ const b = {a: 1, b: 2, c: 3};
+ const result = objectDiff(a, b);
+ expect(result.changed).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toHaveLength(0);
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(0);
+ expect(result.added).toEqual(['c']);
+ });
+
+ it('should indicate when properties are removed', () => {
+ const a = {a: 1, b: 2};
+ const b = {a: 1};
+ const result = objectDiff(a, b);
+ expect(result.changed).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toHaveLength(0);
+ expect(result.added).toHaveLength(0);
+ expect(result.removed).toHaveLength(1);
+ expect(result.removed).toEqual(['b']);
+ });
+
+ it('should indicate when multiple aspects change', () => {
+ const a = {a: 1, b: 2, c: 3};
+ const b: (typeof a | {d: number}) = {a: 1, b: 22, d: 4};
+ const result = objectDiff(a, b);
+ expect(result.changed).toBeDefined();
+ expect(result.added).toBeDefined();
+ expect(result.removed).toBeDefined();
+ expect(result.changed).toHaveLength(1);
+ expect(result.added).toHaveLength(1);
+ expect(result.removed).toHaveLength(1);
+ expect(result.changed).toEqual(['b']);
+ expect(result.removed).toEqual(['c']);
+ expect(result.added).toEqual(['d']);
+ });
+ });
+
+ describe('objectKeyChanges', () => {
+ it('should return an empty set if no properties changed', () => {
+ const a = {a: 1, b: 2};
+ const b = {a: 1, b: 2};
+ const result = objectKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(0);
+ });
+
+ it('should return an empty set if no properties changed for the same pointer', () => {
+ const a = {a: 1, b: 2};
+ const result = objectKeyChanges(a, a);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(0);
+ });
+
+ it('should return properties which were changed, added, or removed', () => {
+ const a = {a: 1, b: 2, c: 3};
+ const b: (typeof a | {d: number}) = {a: 1, b: 22, d: 4};
+ const result = objectKeyChanges(a, b);
+ expect(result).toBeDefined();
+ expect(result).toHaveLength(3);
+ expect(result).toEqual(['c', 'd', 'b']); // order isn't important, but the test cares
+ });
+ });
+
+ describe('objectClone', () => {
+ it('should deep clone an object', () => {
+ const a = {
+ hello: "world",
+ test: {
+ another: "property",
+ test: 42,
+ third: {
+ prop: true,
+ },
+ },
+ };
+ const result = objectClone(a);
+ expect(result).toBeDefined();
+ expect(result).not.toBe(a);
+ expect(result).toMatchObject(a);
+ expect(result.test).not.toBe(a.test);
+ expect(result.test.third).not.toBe(a.test.third);
+ });
+ });
+
+ describe('objectFromEntries', () => {
+ it('should create an object from an array of entries', () => {
+ const output = {a: 1, b: 2, c: 3};
+ const result = objectFromEntries(Object.entries(output));
+ expect(result).toBeDefined();
+ expect(result).toMatchObject(output);
+ });
+
+ it('should maintain pointers in values', () => {
+ const output = {a: {}, b: 2, c: 3};
+ const result = objectFromEntries(Object.entries(output));
+ expect(result).toBeDefined();
+ expect(result).toMatchObject(output);
+ expect(result['a']).toBe(output.a);
+ });
+ });
+});
diff --git a/test/utils/sets-test.ts b/test/utils/sets-test.ts
new file mode 100644
index 0000000000..98dc218309
--- /dev/null
+++ b/test/utils/sets-test.ts
@@ -0,0 +1,56 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import {setHasDiff} from "../../src/utils/sets";
+
+describe('sets', () => {
+ describe('setHasDiff', () => {
+ it('should flag true on A length > B length', () => {
+ const a = new Set([1, 2, 3, 4]);
+ const b = new Set([1, 2, 3]);
+ const result = setHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag true on A length < B length', () => {
+ const a = new Set([1, 2, 3]);
+ const b = new Set([1, 2, 3, 4]);
+ const result = setHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag true on element differences', () => {
+ const a = new Set([1, 2, 3]);
+ const b = new Set([4, 5, 6]);
+ const result = setHasDiff(a, b);
+ expect(result).toBe(true);
+ });
+
+ it('should flag false if same but order different', () => {
+ const a = new Set([1, 2, 3]);
+ const b = new Set([3, 1, 2]);
+ const result = setHasDiff(a, b);
+ expect(result).toBe(false);
+ });
+
+ it('should flag false if same', () => {
+ const a = new Set([1, 2, 3]);
+ const b = new Set([1, 2, 3]);
+ const result = setHasDiff(a, b);
+ expect(result).toBe(false);
+ });
+ });
+});
diff --git a/test/utils/test-utils.ts b/test/utils/test-utils.ts
new file mode 100644
index 0000000000..af92987a3d
--- /dev/null
+++ b/test/utils/test-utils.ts
@@ -0,0 +1,33 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import { MatrixClient } from "matrix-js-sdk/src/client";
+import { AsyncStoreWithClient } from "../../src/stores/AsyncStoreWithClient";
+
+// These methods make some use of some private methods on the AsyncStoreWithClient to simplify getting into a consistent
+// ready state without needing to wire up a dispatcher and pretend to be a js-sdk client.
+
+export const setupAsyncStoreWithClient = async (store: AsyncStoreWithClient, client: MatrixClient) => {
+ // @ts-ignore
+ store.readyStore.useUnitTestClient(client);
+ // @ts-ignore
+ await store.onReady();
+};
+
+export const resetAsyncStoreWithClient = async (store: AsyncStoreWithClient) => {
+ // @ts-ignore
+ await store.onNotReady();
+};
diff --git a/yarn.lock b/yarn.lock
index 66329cfa89..acdca26e55 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -26,6 +26,13 @@
dependencies:
"@babel/highlight" "^7.10.4"
+"@babel/code-frame@^7.12.13":
+ version "7.12.13"
+ resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.12.13.tgz#dcfc826beef65e75c50e21d3837d7d95798dd658"
+ integrity sha512-HV1Cm0Q3ZrpCR93tkWOYiuYIgLxZXZFVG2VgK+MBWjUqZTundupbfx2aXarXuw5Ko5aMcjtJgbSs4vUGBS5v6g==
+ dependencies:
+ "@babel/highlight" "^7.12.13"
+
"@babel/compat-data@^7.12.5", "@babel/compat-data@^7.12.7":
version "7.12.7"
resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.12.7.tgz#9329b4782a7d6bbd7eef57e11addf91ee3ef1e41"
@@ -61,6 +68,15 @@
jsesc "^2.5.1"
source-map "^0.5.0"
+"@babel/generator@^7.13.16":
+ version "7.13.16"
+ resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.13.16.tgz#0befc287031a201d84cdfc173b46b320ae472d14"
+ integrity sha512-grBBR75UnKOcUWMp8WoDxNsWCFl//XCK6HWTrBQKTr5SV9f5g0pNOjdyzi/DTBv12S9GnYPInIXQBTky7OXEMg==
+ dependencies:
+ "@babel/types" "^7.13.16"
+ jsesc "^2.5.1"
+ source-map "^0.5.0"
+
"@babel/helper-annotate-as-pure@^7.10.4", "@babel/helper-annotate-as-pure@^7.12.10":
version "7.12.10"
resolved "https://registry.yarnpkg.com/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.12.10.tgz#54ab9b000e60a93644ce17b3f37d313aaf1d115d"
@@ -130,6 +146,15 @@
"@babel/template" "^7.12.7"
"@babel/types" "^7.12.11"
+"@babel/helper-function-name@^7.12.13":
+ version "7.12.13"
+ resolved "https://registry.yarnpkg.com/@babel/helper-function-name/-/helper-function-name-7.12.13.tgz#93ad656db3c3c2232559fd7b2c3dbdcbe0eb377a"
+ integrity sha512-TZvmPn0UOqmvi5G4vvw0qZTpVptGkB1GL61R6lKvrSdIxGm5Pky7Q3fpKiIkQCAtRCBUwB0PaThlx9vebCDSwA==
+ dependencies:
+ "@babel/helper-get-function-arity" "^7.12.13"
+ "@babel/template" "^7.12.13"
+ "@babel/types" "^7.12.13"
+
"@babel/helper-get-function-arity@^7.12.10":
version "7.12.10"
resolved "https://registry.yarnpkg.com/@babel/helper-get-function-arity/-/helper-get-function-arity-7.12.10.tgz#b158817a3165b5faa2047825dfa61970ddcc16cf"
@@ -137,6 +162,13 @@
dependencies:
"@babel/types" "^7.12.10"
+"@babel/helper-get-function-arity@^7.12.13":
+ version "7.12.13"
+ resolved "https://registry.yarnpkg.com/@babel/helper-get-function-arity/-/helper-get-function-arity-7.12.13.tgz#bc63451d403a3b3082b97e1d8b3fe5bd4091e583"
+ integrity sha512-DjEVzQNz5LICkzN0REdpD5prGoidvbdYk1BVgRUOINaWJP2t6avB27X1guXK1kXNrX0WMfsrm1A/ZBthYuIMQg==
+ dependencies:
+ "@babel/types" "^7.12.13"
+
"@babel/helper-hoist-variables@^7.10.4":
version "7.10.4"
resolved "https://registry.yarnpkg.com/@babel/helper-hoist-variables/-/helper-hoist-variables-7.10.4.tgz#d49b001d1d5a68ca5e6604dda01a6297f7c9381e"
@@ -225,6 +257,13 @@
dependencies:
"@babel/types" "^7.12.11"
+"@babel/helper-split-export-declaration@^7.12.13":
+ version "7.12.13"
+ resolved "https://registry.yarnpkg.com/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.12.13.tgz#e9430be00baf3e88b0e13e6f9d4eaf2136372b05"
+ integrity sha512-tCJDltF83htUtXx5NLcaDqRmknv652ZWCHyoTETf1CXYJdPC7nohZohjUgieXhv0hTJdRf2FjDueFehdNucpzg==
+ dependencies:
+ "@babel/types" "^7.12.13"
+
"@babel/helper-validator-identifier@^7.10.4", "@babel/helper-validator-identifier@^7.12.11":
version "7.12.11"
resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.12.11.tgz#c9a1f021917dcb5ccf0d4e453e399022981fc9ed"
@@ -263,11 +302,25 @@
chalk "^2.0.0"
js-tokens "^4.0.0"
+"@babel/highlight@^7.12.13":
+ version "7.13.10"
+ resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.13.10.tgz#a8b2a66148f5b27d666b15d81774347a731d52d1"
+ integrity sha512-5aPpe5XQPzflQrFwL1/QoeHkP2MsA4JCntcXHRhEsdsfPVkvPi2w7Qix4iV7t5S/oC9OodGrggd8aco1g3SZFg==
+ dependencies:
+ "@babel/helper-validator-identifier" "^7.12.11"
+ chalk "^2.0.0"
+ js-tokens "^4.0.0"
+
"@babel/parser@^7.1.0", "@babel/parser@^7.12.10", "@babel/parser@^7.12.11", "@babel/parser@^7.12.7", "@babel/parser@^7.7.0":
version "7.12.11"
resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.12.11.tgz#9ce3595bcd74bc5c466905e86c535b8b25011e79"
integrity sha512-N3UxG+uuF4CMYoNj8AhnbAcJF0PiuJ9KHuy1lQmkYsxTer/MAH9UBNHsBoAX/4s6NvlDD047No8mYVGGzLL4hg==
+"@babel/parser@^7.12.13", "@babel/parser@^7.13.16":
+ version "7.13.16"
+ resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.13.16.tgz#0f18179b0448e6939b1f3f5c4c355a3a9bcdfd37"
+ integrity sha512-6bAg36mCwuqLO0hbR+z7PHuqWiCeP7Dzg73OpQwsAB1Eb8HnGEz5xYBzCfbu+YjoaJsJs+qheDxVAuqbt3ILEw==
+
"@babel/plugin-proposal-async-generator-functions@^7.12.1":
version "7.12.12"
resolved "https://registry.yarnpkg.com/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.12.12.tgz#04b8f24fd4532008ab4e79f788468fd5a8476566"
@@ -980,6 +1033,15 @@
"@babel/parser" "^7.12.7"
"@babel/types" "^7.12.7"
+"@babel/template@^7.12.13":
+ version "7.12.13"
+ resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.12.13.tgz#530265be8a2589dbb37523844c5bcb55947fb327"
+ integrity sha512-/7xxiGA57xMo/P2GVvdEumr8ONhFOhfgq2ihK3h1e6THqzTAkHbkXgB0xI9yeTfIUoH3+oAeHhqm/I43OTbbjA==
+ dependencies:
+ "@babel/code-frame" "^7.12.13"
+ "@babel/parser" "^7.12.13"
+ "@babel/types" "^7.12.13"
+
"@babel/traverse@^7.1.0", "@babel/traverse@^7.10.4", "@babel/traverse@^7.12.1", "@babel/traverse@^7.12.10", "@babel/traverse@^7.12.12", "@babel/traverse@^7.12.5", "@babel/traverse@^7.7.0", "@babel/traverse@^7.7.4":
version "7.12.12"
resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.12.12.tgz#d0cd87892704edd8da002d674bc811ce64743376"
@@ -995,6 +1057,20 @@
globals "^11.1.0"
lodash "^4.17.19"
+"@babel/traverse@^7.13.17":
+ version "7.13.17"
+ resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.13.17.tgz#c85415e0c7d50ac053d758baec98b28b2ecfeea3"
+ integrity sha512-BMnZn0R+X6ayqm3C3To7o1j7Q020gWdqdyP50KEoVqaCO2c/Im7sYZSmVgvefp8TTMQ+9CtwuBp0Z1CZ8V3Pvg==
+ dependencies:
+ "@babel/code-frame" "^7.12.13"
+ "@babel/generator" "^7.13.16"
+ "@babel/helper-function-name" "^7.12.13"
+ "@babel/helper-split-export-declaration" "^7.12.13"
+ "@babel/parser" "^7.13.16"
+ "@babel/types" "^7.13.17"
+ debug "^4.1.0"
+ globals "^11.1.0"
+
"@babel/types@^7.0.0", "@babel/types@^7.10.4", "@babel/types@^7.10.5", "@babel/types@^7.12.1", "@babel/types@^7.12.10", "@babel/types@^7.12.11", "@babel/types@^7.12.12", "@babel/types@^7.12.5", "@babel/types@^7.12.7", "@babel/types@^7.3.0", "@babel/types@^7.3.3", "@babel/types@^7.4.4", "@babel/types@^7.7.0":
version "7.12.12"
resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.12.12.tgz#4608a6ec313abbd87afa55004d373ad04a96c299"
@@ -1004,6 +1080,14 @@
lodash "^4.17.19"
to-fast-properties "^2.0.0"
+"@babel/types@^7.12.13", "@babel/types@^7.13.16", "@babel/types@^7.13.17":
+ version "7.13.17"
+ resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.13.17.tgz#48010a115c9fba7588b4437dd68c9469012b38b4"
+ integrity sha512-RawydLgxbOPDlTLJNtoIypwdmAy//uQIzlKt2+iBiJaRlVuI6QLUxVAyWGNfOzp8Yu4L4lLIacoCyTNtpb4wiA==
+ dependencies:
+ "@babel/helper-validator-identifier" "^7.12.11"
+ to-fast-properties "^2.0.0"
+
"@bcoe/v8-coverage@^0.2.3":
version "0.2.3"
resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39"
@@ -5588,8 +5672,8 @@ mathml-tag-names@^2.1.3:
integrity sha512-APMBEanjybaPzUrfqU0IMU5I0AswKMH7k8OTLs0vvV4KZpExkTkY87nR/zpbuTPj+gARop7aGUbl11pnDfW6xg==
"matrix-js-sdk@github:matrix-org/matrix-js-sdk#develop":
- version "9.11.0"
- resolved "https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/e277de6e3d9bbb98fbfbbedd47d86ee85f6f47e5"
+ version "10.0.0"
+ resolved "https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/c8f69c0b7937b9064938c134d708c4d064b71315"
dependencies:
"@babel/runtime" "^7.12.5"
another-json "^0.2.0"
@@ -5614,6 +5698,14 @@ matrix-react-test-utils@^0.2.2:
resolved "https://registry.yarnpkg.com/matrix-react-test-utils/-/matrix-react-test-utils-0.2.2.tgz#c87144d3b910c7edc544a6699d13c7c2bf02f853"
integrity sha512-49+7gfV6smvBIVbeloql+37IeWMTD+fiywalwCqk8Dnz53zAFjKSltB3rmWHso1uecLtQEcPtCijfhzcLXAxTQ==
+"matrix-web-i18n@github:matrix-org/matrix-web-i18n":
+ version "1.1.2"
+ resolved "https://codeload.github.com/matrix-org/matrix-web-i18n/tar.gz/63f9119bc0bc304e83d4e8e22364caa7850e7671"
+ dependencies:
+ "@babel/parser" "^7.13.16"
+ "@babel/traverse" "^7.13.17"
+ walk "^2.3.14"
+
matrix-widget-api@^0.1.0-beta.13:
version "0.1.0-beta.13"
resolved "https://registry.yarnpkg.com/matrix-widget-api/-/matrix-widget-api-0.1.0-beta.13.tgz#ebddc83eaef39bbb87b621a02a35902e1a29b9ef"
{_t("Homeserver is")}
{_t("Identity Server is")}
{_t("Access Token:") + ' '} -
+
<{ _t("click to reveal") }>
this._removePersonalRule(rule)}
+ onClick={() => this.removePersonalRule(rule)}
disabled={this.state.busy}
>
{_t("Remove")}
@@ -192,7 +198,7 @@ export default class MjolnirUserSettingsTab extends React.Component {
);
}
- _renderSubscribedBanLists() {
+ private renderSubscribedBanLists() {
const AccessibleButton = sdk.getComponent('elements.AccessibleButton');
const personalList = Mjolnir.sharedInstance().getPersonalList();
@@ -209,14 +215,14 @@ export default class MjolnirUserSettingsTab extends React.Component {
this._unsubscribeFromList(list)}
+ onClick={() => this.unsubscribeFromList(list)}
disabled={this.state.busy}
>
{_t("Unsubscribe")}
this._viewListRules(list)}
+ onClick={() => this.viewListRules(list)}
disabled={this.state.busy}
>
{_t("View rules")}
@@ -271,21 +277,21 @@ export default class MjolnirUserSettingsTab extends React.Component {
)}
{MatrixClientPeg.get().getHomeserverUrl()}{_t("Identity Server is")}
{MatrixClientPeg.get().getIdentityServerUrl()}{_t("Access Token:") + ' '} -
-
+
{_t("Clear cache and reload")}
diff --git a/src/components/views/settings/tabs/user/MjolnirUserSettingsTab.js b/src/components/views/settings/tabs/user/MjolnirUserSettingsTab.tsx
similarity index 90%
rename from src/components/views/settings/tabs/user/MjolnirUserSettingsTab.js
rename to src/components/views/settings/tabs/user/MjolnirUserSettingsTab.tsx
index 91f6728a7a..6997defea9 100644
--- a/src/components/views/settings/tabs/user/MjolnirUserSettingsTab.js
+++ b/src/components/views/settings/tabs/user/MjolnirUserSettingsTab.tsx
@@ -1,5 +1,5 @@
/*
-Copyright 2019, 2020 The Matrix.org Foundation C.I.C.
+Copyright 2019-2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -25,10 +25,16 @@ import {MatrixClientPeg} from "../../../../../MatrixClientPeg";
import * as sdk from "../../../../../index";
import {replaceableComponent} from "../../../../../utils/replaceableComponent";
+interface IState {
+ busy: boolean;
+ newPersonalRule: string;
+ newList: string;
+}
+
@replaceableComponent("views.settings.tabs.user.MjolnirUserSettingsTab")
-export default class MjolnirUserSettingsTab extends React.Component {
- constructor() {
- super();
+export default class MjolnirUserSettingsTab extends React.Component<{}, IState> {
+ constructor(props) {
+ super(props);
this.state = {
busy: false,
@@ -37,15 +43,15 @@ export default class MjolnirUserSettingsTab extends React.Component {
};
}
- _onPersonalRuleChanged = (e) => {
+ private onPersonalRuleChanged = (e) => {
this.setState({newPersonalRule: e.target.value});
};
- _onNewListChanged = (e) => {
+ private onNewListChanged = (e) => {
this.setState({newList: e.target.value});
};
- _onAddPersonalRule = async (e) => {
+ private onAddPersonalRule = async (e) => {
e.preventDefault();
e.stopPropagation();
@@ -72,7 +78,7 @@ export default class MjolnirUserSettingsTab extends React.Component {
}
};
- _onSubscribeList = async (e) => {
+ private onSubscribeList = async (e) => {
e.preventDefault();
e.stopPropagation();
@@ -94,7 +100,7 @@ export default class MjolnirUserSettingsTab extends React.Component {
}
};
- async _removePersonalRule(rule: ListRule) {
+ private async removePersonalRule(rule: ListRule) {
this.setState({busy: true});
try {
const list = Mjolnir.sharedInstance().getPersonalList();
@@ -112,7 +118,7 @@ export default class MjolnirUserSettingsTab extends React.Component {
}
}
- async _unsubscribeFromList(list: BanList) {
+ private async unsubscribeFromList(list: BanList) {
this.setState({busy: true});
try {
await Mjolnir.sharedInstance().unsubscribeFromList(list.roomId);
@@ -130,7 +136,7 @@ export default class MjolnirUserSettingsTab extends React.Component {
}
}
- _viewListRules(list: BanList) {
+ private viewListRules(list: BanList) {
const QuestionDialog = sdk.getComponent("dialogs.QuestionDialog");
const room = MatrixClientPeg.get().getRoom(list.roomId);
@@ -161,7 +167,7 @@ export default class MjolnirUserSettingsTab extends React.Component {
});
}
- _renderPersonalBanListRules() {
+ private renderPersonalBanListRules() {
const AccessibleButton = sdk.getComponent('elements.AccessibleButton');
const list = Mjolnir.sharedInstance().getPersonalList();
@@ -174,7 +180,7 @@ export default class MjolnirUserSettingsTab extends React.Component {
- {this._renderPersonalBanListRules()}
+ {this.renderPersonalBanListRules()}
-
- {this._renderSubscribedBanLists()}
+ {this.renderSubscribedBanLists()}
-
);
diff --git a/src/components/views/settings/tabs/user/SecurityUserSettingsTab.js b/src/components/views/settings/tabs/user/SecurityUserSettingsTab.js
index 8a70811399..da41f2f0dc 100644
--- a/src/components/views/settings/tabs/user/SecurityUserSettingsTab.js
+++ b/src/components/views/settings/tabs/user/SecurityUserSettingsTab.js
@@ -255,10 +255,9 @@ export default class SecurityUserSettingsTab extends React.Component {
_renderIgnoredUsers() {
const {waitingUnignored, ignoredUserIds} = this.state;
- if (!ignoredUserIds || ignoredUserIds.length === 0) return null;
-
- const userIds = ignoredUserIds
- .map((u) =>
+
+ }
+}
diff --git a/src/components/views/voice_messages/Waveform.tsx b/src/components/views/voice_messages/Waveform.tsx
index 5fa68dcadc..840a5a12b3 100644
--- a/src/components/views/voice_messages/Waveform.tsx
+++ b/src/components/views/voice_messages/Waveform.tsx
@@ -16,9 +16,11 @@ limitations under the License.
import React from "react";
import {replaceableComponent} from "../../../utils/replaceableComponent";
+import classNames from "classnames";
interface IProps {
relHeights: number[]; // relative heights (0-1)
+ progress: number; // percent complete, 0-1, default 100%
}
interface IState {
@@ -28,9 +30,16 @@ interface IState {
* A simple waveform component. This renders bars (centered vertically) for each
* height provided in the component properties. Updating the properties will update
* the rendered waveform.
+ *
+ * For CSS purposes, a mx_Waveform_bar_100pct class is added when the bar should be
+ * "filled", as a demonstration of the progress property.
*/
@replaceableComponent("views.voice_messages.Waveform")
export default class Waveform extends React.PureComponent
{this.props.relHeights.map((h, i) => {
- return ;
+ const progress = this.props.progress;
+ const isCompleteBar = (i / this.props.relHeights.length) <= progress && progress > 0;
+ const classes = classNames({
+ 'mx_Waveform_bar': true,
+ 'mx_Waveform_bar_100pct': isCompleteBar,
+ });
+ return ;
})}
;
}
diff --git a/src/components/views/voip/CallPreview.tsx b/src/components/views/voip/CallPreview.tsx
index 29de068b0c..d31afddec9 100644
--- a/src/components/views/voip/CallPreview.tsx
+++ b/src/components/views/voip/CallPreview.tsx
@@ -27,6 +27,7 @@ import SettingsStore from "../../../settings/SettingsStore";
import { CallEvent, CallState, MatrixCall } from 'matrix-js-sdk/src/webrtc/call';
import { MatrixClientPeg } from '../../../MatrixClientPeg';
import {replaceableComponent} from "../../../utils/replaceableComponent";
+import { Action } from '../../../dispatcher/actions';
const SHOW_CALL_IN_STATES = [
CallState.Connected,
@@ -142,6 +143,7 @@ export default class CallPreview extends React.Component