Live location sharing: live share warning in room (#8100)
* add duration dropdown to live location picker Signed-off-by: Kerry Archibald <kerrya@element.io> * tidy comments Signed-off-by: Kerry Archibald <kerrya@element.io> * setup component Signed-off-by: Kerry Archibald <kerrya@element.io> * replace references to beaconInfoId with beacon.identifier Signed-off-by: Kerry Archibald <kerrya@element.io> * icon Signed-off-by: Kerry Archibald <kerrya@element.io> * component for styled live beacon icon Signed-off-by: Kerry Archibald <kerrya@element.io> * emit liveness change whenever livebeaconIds changes Signed-off-by: Kerry Archibald <kerrya@element.io> * Handle multiple live beacons in room share warning, test Signed-off-by: Kerry Archibald <kerrya@element.io> * un xdescribe beaconstore tests Signed-off-by: Kerry Archibald <kerrya@element.io> * missed copyrights Signed-off-by: Kerry Archibald <kerrya@element.io> * i18n Signed-off-by: Kerry Archibald <kerrya@element.io> * tidy Signed-off-by: Kerry Archibald <kerrya@element.io>
This commit is contained in:
Kerry
GitHub
parent
c8d3b51640
commit
b04d31b5be
11 changed files with 600 additions and 42 deletions
127
src/components/views/beacon/RoomLiveShareWarning.tsx
Normal file
127
src/components/views/beacon/RoomLiveShareWarning.tsx
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
/*
|
||||
Copyright 2022 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, { useEffect, useState } from 'react';
|
||||
import classNames from 'classnames';
|
||||
import { Room } from 'matrix-js-sdk/src/matrix';
|
||||
|
||||
import { _t } from '../../../languageHandler';
|
||||
import { useEventEmitterState } from '../../../hooks/useEventEmitter';
|
||||
import { OwnBeaconStore, OwnBeaconStoreEvent } from '../../../stores/OwnBeaconStore';
|
||||
import AccessibleButton from '../elements/AccessibleButton';
|
||||
import StyledLiveBeaconIcon from './StyledLiveBeaconIcon';
|
||||
import { formatDuration } from '../../../DateUtils';
|
||||
import { getBeaconMsUntilExpiry, sortBeaconsByLatestExpiry } from '../../../utils/beacon';
|
||||
import Spinner from '../elements/Spinner';
|
||||
|
||||
interface Props {
|
||||
roomId: Room['roomId'];
|
||||
}
|
||||
|
||||
/**
|
||||
* It's technically possible to have multiple live beacons in one room
|
||||
* Select the latest expiry to display,
|
||||
* and kill all beacons on stop sharing
|
||||
*/
|
||||
type LiveBeaconsState = {
|
||||
liveBeaconIds: string[];
|
||||
msRemaining?: number;
|
||||
onStopSharing?: () => void;
|
||||
stoppingInProgress?: boolean;
|
||||
};
|
||||
|
||||
const useLiveBeacons = (roomId: Room['roomId']): LiveBeaconsState => {
|
||||
const [stoppingInProgress, setStoppingInProgress] = useState(false);
|
||||
const liveBeaconIds = useEventEmitterState(
|
||||
OwnBeaconStore.instance,
|
||||
OwnBeaconStoreEvent.LivenessChange,
|
||||
() => OwnBeaconStore.instance.getLiveBeaconIds(roomId),
|
||||
);
|
||||
|
||||
// reset stopping in progress on change in live ids
|
||||
useEffect(() => {
|
||||
setStoppingInProgress(false);
|
||||
}, [liveBeaconIds]);
|
||||
|
||||
if (!liveBeaconIds?.length) {
|
||||
return { liveBeaconIds };
|
||||
}
|
||||
|
||||
// select the beacon with latest expiry to display expiry time
|
||||
const beacon = liveBeaconIds.map(beaconId => OwnBeaconStore.instance.getBeaconById(beaconId))
|
||||
.sort(sortBeaconsByLatestExpiry)
|
||||
.shift();
|
||||
|
||||
const onStopSharing = async () => {
|
||||
setStoppingInProgress(true);
|
||||
try {
|
||||
await Promise.all(liveBeaconIds.map(beaconId => OwnBeaconStore.instance.stopBeacon(beaconId)));
|
||||
} catch (error) {
|
||||
// only clear loading in case of error
|
||||
// to avoid flash of not-loading state
|
||||
// after beacons have been stopped but we wait for sync
|
||||
setStoppingInProgress(false);
|
||||
}
|
||||
};
|
||||
|
||||
const msRemaining = getBeaconMsUntilExpiry(beacon);
|
||||
|
||||
return { liveBeaconIds, onStopSharing, msRemaining, stoppingInProgress };
|
||||
};
|
||||
|
||||
const RoomLiveShareWarning: React.FC<Props> = ({ roomId }) => {
|
||||
const {
|
||||
liveBeaconIds,
|
||||
onStopSharing,
|
||||
msRemaining,
|
||||
stoppingInProgress,
|
||||
} = useLiveBeacons(roomId);
|
||||
|
||||
if (!liveBeaconIds?.length) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const timeRemaining = formatDuration(msRemaining);
|
||||
const liveTimeRemaining = _t(`%(timeRemaining)s left`, { timeRemaining });
|
||||
|
||||
return <div
|
||||
className={classNames('mx_RoomLiveShareWarning')}
|
||||
>
|
||||
<StyledLiveBeaconIcon className="mx_RoomLiveShareWarning_icon" />
|
||||
<span className="mx_RoomLiveShareWarning_label">
|
||||
{ _t('You are sharing %(count)s live locations', { count: liveBeaconIds.length }) }
|
||||
</span>
|
||||
|
||||
{ stoppingInProgress ?
|
||||
<span className='mx_RoomLiveShareWarning_spinner'><Spinner h={16} w={16} /></span> :
|
||||
<span
|
||||
data-test-id='room-live-share-expiry'
|
||||
className="mx_RoomLiveShareWarning_expiry"
|
||||
>{ liveTimeRemaining }</span>
|
||||
}
|
||||
<AccessibleButton
|
||||
data-test-id='room-live-share-stop-sharing'
|
||||
onClick={onStopSharing}
|
||||
kind='danger'
|
||||
element='button'
|
||||
disabled={stoppingInProgress}
|
||||
>
|
||||
{ _t('Stop sharing') }
|
||||
</AccessibleButton>
|
||||
</div>;
|
||||
};
|
||||
|
||||
export default RoomLiveShareWarning;
|
||||
|
|
@ -41,6 +41,7 @@ import { RoomNotificationStateStore } from '../../../stores/notifications/RoomNo
|
|||
import { RightPanelPhases } from '../../../stores/right-panel/RightPanelStorePhases';
|
||||
import { NotificationStateEvents } from '../../../stores/notifications/NotificationState';
|
||||
import RoomContext from "../../../contexts/RoomContext";
|
||||
import RoomLiveShareWarning from '../beacon/RoomLiveShareWarning';
|
||||
|
||||
export interface ISearchInfo {
|
||||
searchTerm: string;
|
||||
|
|
@ -273,6 +274,7 @@ export default class RoomHeader extends React.Component<IProps, IState> {
|
|||
{ rightRow }
|
||||
<RoomHeaderButtons room={this.props.room} excludedRightPanelPhaseButtons={this.props.excludedRightPanelPhaseButtons} />
|
||||
</div>
|
||||
<RoomLiveShareWarning roomId={this.props.room.roomId} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2965,6 +2965,10 @@
|
|||
"Leave the beta": "Leave the beta",
|
||||
"Join the beta": "Join the beta",
|
||||
"You are sharing your live location": "You are sharing your live location",
|
||||
"%(timeRemaining)s left": "%(timeRemaining)s left",
|
||||
"You are sharing %(count)s live locations|other": "You are sharing %(count)s live locations",
|
||||
"You are sharing %(count)s live locations|one": "You are sharing your live location",
|
||||
"Stop sharing": "Stop sharing",
|
||||
"Avatar": "Avatar",
|
||||
"This room is public": "This room is public",
|
||||
"Away": "Away",
|
||||
|
|
|
|||
|
|
@ -27,11 +27,12 @@ import {
|
|||
import defaultDispatcher from "../dispatcher/dispatcher";
|
||||
import { ActionPayload } from "../dispatcher/payloads";
|
||||
import { AsyncStoreWithClient } from "./AsyncStoreWithClient";
|
||||
import { arrayHasDiff } from "../utils/arrays";
|
||||
|
||||
const isOwnBeacon = (beacon: Beacon, userId: string): boolean => beacon.beaconInfoOwner === userId;
|
||||
|
||||
export enum OwnBeaconStoreEvent {
|
||||
LivenessChange = 'OwnBeaconStore.LivenessChange'
|
||||
LivenessChange = 'OwnBeaconStore.LivenessChange',
|
||||
}
|
||||
|
||||
type OwnBeaconStoreState = {
|
||||
|
|
@ -41,6 +42,7 @@ type OwnBeaconStoreState = {
|
|||
};
|
||||
export class OwnBeaconStore extends AsyncStoreWithClient<OwnBeaconStoreState> {
|
||||
private static internalInstance = new OwnBeaconStore();
|
||||
// users beacons, keyed by event type
|
||||
public readonly beacons = new Map<string, Beacon>();
|
||||
public readonly beaconsByRoomId = new Map<Room['roomId'], Set<string>>();
|
||||
private liveBeaconIds = [];
|
||||
|
|
@ -86,8 +88,12 @@ export class OwnBeaconStore extends AsyncStoreWithClient<OwnBeaconStoreState> {
|
|||
return this.liveBeaconIds.filter(beaconId => this.beaconsByRoomId.get(roomId)?.has(beaconId));
|
||||
}
|
||||
|
||||
public stopBeacon = async (beaconInfoId: string): Promise<void> => {
|
||||
const beacon = this.beacons.get(beaconInfoId);
|
||||
public getBeaconById(beaconId: string): Beacon | undefined {
|
||||
return this.beacons.get(beaconId);
|
||||
}
|
||||
|
||||
public stopBeacon = async (beaconInfoType: string): Promise<void> => {
|
||||
const beacon = this.beacons.get(beaconInfoType);
|
||||
// if no beacon, or beacon is already explicitly set isLive: false
|
||||
// do nothing
|
||||
if (!beacon?.beaconInfo?.live) {
|
||||
|
|
@ -107,27 +113,27 @@ export class OwnBeaconStore extends AsyncStoreWithClient<OwnBeaconStoreState> {
|
|||
|
||||
private onBeaconLiveness = (isLive: boolean, beacon: Beacon): void => {
|
||||
// check if we care about this beacon
|
||||
if (!this.beacons.has(beacon.beaconInfoId)) {
|
||||
if (!this.beacons.has(beacon.identifier)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!isLive && this.liveBeaconIds.includes(beacon.beaconInfoId)) {
|
||||
if (!isLive && this.liveBeaconIds.includes(beacon.identifier)) {
|
||||
this.liveBeaconIds =
|
||||
this.liveBeaconIds.filter(beaconId => beaconId !== beacon.beaconInfoId);
|
||||
this.liveBeaconIds.filter(beaconId => beaconId !== beacon.identifier);
|
||||
}
|
||||
|
||||
if (isLive && !this.liveBeaconIds.includes(beacon.beaconInfoId)) {
|
||||
this.liveBeaconIds.push(beacon.beaconInfoId);
|
||||
if (isLive && !this.liveBeaconIds.includes(beacon.identifier)) {
|
||||
this.liveBeaconIds.push(beacon.identifier);
|
||||
}
|
||||
|
||||
// beacon expired, update beacon to un-alive state
|
||||
if (!isLive) {
|
||||
this.stopBeacon(beacon.beaconInfoId);
|
||||
this.stopBeacon(beacon.identifier);
|
||||
}
|
||||
|
||||
// TODO start location polling here
|
||||
|
||||
this.emit(OwnBeaconStoreEvent.LivenessChange, this.hasLiveBeacons());
|
||||
this.emit(OwnBeaconStoreEvent.LivenessChange, this.getLiveBeaconIds());
|
||||
};
|
||||
|
||||
private initialiseBeaconState = () => {
|
||||
|
|
@ -146,27 +152,25 @@ export class OwnBeaconStore extends AsyncStoreWithClient<OwnBeaconStoreState> {
|
|||
};
|
||||
|
||||
private addBeacon = (beacon: Beacon): void => {
|
||||
this.beacons.set(beacon.beaconInfoId, beacon);
|
||||
this.beacons.set(beacon.identifier, beacon);
|
||||
|
||||
if (!this.beaconsByRoomId.has(beacon.roomId)) {
|
||||
this.beaconsByRoomId.set(beacon.roomId, new Set<string>());
|
||||
}
|
||||
|
||||
this.beaconsByRoomId.get(beacon.roomId).add(beacon.beaconInfoId);
|
||||
this.beaconsByRoomId.get(beacon.roomId).add(beacon.identifier);
|
||||
|
||||
beacon.monitorLiveness();
|
||||
};
|
||||
|
||||
private checkLiveness = (): void => {
|
||||
const prevLiveness = this.hasLiveBeacons();
|
||||
const prevLiveBeaconIds = this.getLiveBeaconIds();
|
||||
this.liveBeaconIds = [...this.beacons.values()]
|
||||
.filter(beacon => beacon.isLive)
|
||||
.map(beacon => beacon.beaconInfoId);
|
||||
.map(beacon => beacon.identifier);
|
||||
|
||||
const newLiveness = this.hasLiveBeacons();
|
||||
|
||||
if (prevLiveness !== newLiveness) {
|
||||
this.emit(OwnBeaconStoreEvent.LivenessChange, newLiveness);
|
||||
if (arrayHasDiff(prevLiveBeaconIds, this.liveBeaconIds)) {
|
||||
this.emit(OwnBeaconStoreEvent.LivenessChange, this.liveBeaconIds);
|
||||
}
|
||||
};
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue