This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 830
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Live location sharing: live share warning in room (#8100)
* add duration dropdown to live location picker Signed-off-by: Kerry Archibald <[email protected]> * tidy comments Signed-off-by: Kerry Archibald <[email protected]> * setup component Signed-off-by: Kerry Archibald <[email protected]> * replace references to beaconInfoId with beacon.identifier Signed-off-by: Kerry Archibald <[email protected]> * icon Signed-off-by: Kerry Archibald <[email protected]> * component for styled live beacon icon Signed-off-by: Kerry Archibald <[email protected]> * emit liveness change whenever livebeaconIds changes Signed-off-by: Kerry Archibald <[email protected]> * Handle multiple live beacons in room share warning, test Signed-off-by: Kerry Archibald <[email protected]> * un xdescribe beaconstore tests Signed-off-by: Kerry Archibald <[email protected]> * missed copyrights Signed-off-by: Kerry Archibald <[email protected]> * i18n Signed-off-by: Kerry Archibald <[email protected]> * tidy Signed-off-by: Kerry Archibald <[email protected]>
- Loading branch information
Kerry
authored
Mar 22, 2022
1 parent
c8d3b51
commit b04d31b
Showing
11 changed files
with
600 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
res/css/components/views/beacon/_RoomLiveShareWarning.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| 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. | ||
| */ | ||
|
|
||
| .mx_RoomLiveShareWarning { | ||
| width: 100%; | ||
|
|
||
| display: flex; | ||
| flex-direction: row; | ||
| align-items: center; | ||
|
|
||
| box-sizing: border-box; | ||
| padding: $spacing-12 $spacing-16; | ||
|
|
||
| color: $primary-content; | ||
| background-color: $system; | ||
| } | ||
|
|
||
| .mx_RoomLiveShareWarning_icon { | ||
| height: 32px; | ||
| width: 32px; | ||
| margin-right: $spacing-8; | ||
| } | ||
|
|
||
| .mx_RoomLiveShareWarning_label { | ||
| flex: 1; | ||
| font-size: $font-15px; | ||
| } | ||
|
|
||
| .mx_RoomLiveShareWarning_expiry { | ||
| color: $secondary-content; | ||
| font-size: $font-12px; | ||
| margin-right: $spacing-16; | ||
| } | ||
|
|
||
| .mx_RoomLiveShareWarning_spinner { | ||
| margin-right: $spacing-16; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.