signal-desktop/ts/state/ducks/calling.ts

2012 lines
52 KiB
TypeScript
Raw Normal View History

2021-01-08 22:57:54 +00:00
// Copyright 2020-2021 Signal Messenger, LLC
2020-10-30 20:34:04 +00:00
// SPDX-License-Identifier: AGPL-3.0-only
import { ipcRenderer } from 'electron';
2020-11-04 17:47:50 +00:00
import { ThunkAction } from 'redux-thunk';
2020-10-01 19:09:15 +00:00
import { CallEndedReason } from 'ringrtc';
import {
hasScreenCapturePermission,
openSystemPreferences,
} from 'mac-screen-capture-permissions';
import { has, omit } from 'lodash';
import { getOwn } from '../../util/getOwn';
import { getPlatform } from '../selectors/user';
2021-09-02 22:34:38 +00:00
import { isConversationTooBigToRing } from '../../conversations/isConversationTooBigToRing';
2020-11-13 19:57:55 +00:00
import { missingCaseError } from '../../util/missingCaseError';
2020-08-27 00:03:42 +00:00
import { calling } from '../../services/calling';
2020-11-04 17:47:50 +00:00
import { StateType as RootStateType } from '../reducer';
2020-08-27 00:03:42 +00:00
import {
2020-12-02 18:14:03 +00:00
CallingDeviceType,
2020-11-13 19:57:55 +00:00
CallMode,
2020-08-27 00:03:42 +00:00
CallState,
ChangeIODevicePayloadType,
2020-11-13 19:57:55 +00:00
GroupCallConnectionState,
GroupCallJoinState,
GroupCallVideoRequest,
2020-08-27 00:03:42 +00:00
MediaDeviceSettings,
PresentedSource,
PresentableSource,
2020-08-27 00:03:42 +00:00
} from '../../types/Calling';
2020-06-04 18:16:19 +00:00
import { callingTones } from '../../util/callingTones';
import { requestCameraPermissions } from '../../util/callingPermissions';
import { isGroupCallOutboundRingEnabled } from '../../util/isGroupCallOutboundRingEnabled';
2020-11-20 17:19:28 +00:00
import { sleep } from '../../util/sleep';
import { LatestQueue } from '../../util/LatestQueue';
2021-09-02 22:34:38 +00:00
import type { ConversationChangedActionType } from './conversations';
import * as log from '../../logging/log';
2020-06-04 18:16:19 +00:00
// State
export type GroupCallPeekInfoType = {
2020-12-02 18:14:03 +00:00
uuids: Array<string>;
creatorUuid?: string;
2020-11-20 17:19:28 +00:00
eraId?: string;
maxDevices: number;
deviceCount: number;
};
2020-11-20 17:19:28 +00:00
export type GroupCallParticipantInfoType = {
2020-12-02 18:14:03 +00:00
uuid: string;
2020-11-17 15:07:53 +00:00
demuxId: number;
hasRemoteAudio: boolean;
hasRemoteVideo: boolean;
presenting: boolean;
sharingScreen: boolean;
speakerTime?: number;
2020-11-17 15:07:53 +00:00
videoAspectRatio: number;
};
2020-11-17 15:07:53 +00:00
export type DirectCallStateType = {
2020-11-13 19:57:55 +00:00
callMode: CallMode.Direct;
conversationId: string;
callState?: CallState;
callEndedReason?: CallEndedReason;
2020-06-04 18:16:19 +00:00
isIncoming: boolean;
isSharingScreen?: boolean;
2020-06-04 18:16:19 +00:00
isVideoCall: boolean;
hasRemoteVideo?: boolean;
};
2020-07-24 01:35:32 +00:00
2021-08-20 16:06:15 +00:00
type GroupCallRingStateType =
| {
ringId?: undefined;
ringerUuid?: undefined;
}
| {
ringId: bigint;
ringerUuid: string;
};
export type GroupCallStateType = {
2020-11-13 19:57:55 +00:00
callMode: CallMode.Group;
conversationId: string;
connectionState: GroupCallConnectionState;
joinState: GroupCallJoinState;
2020-11-20 17:19:28 +00:00
peekInfo: GroupCallPeekInfoType;
2020-11-17 15:07:53 +00:00
remoteParticipants: Array<GroupCallParticipantInfoType>;
2021-08-20 16:06:15 +00:00
} & GroupCallRingStateType;
2020-11-13 19:57:55 +00:00
export type ActiveCallStateType = {
conversationId: string;
2020-06-04 18:16:19 +00:00
hasLocalAudio: boolean;
hasLocalVideo: boolean;
2021-01-08 22:57:54 +00:00
isInSpeakerView: boolean;
joinedAt?: number;
outgoingRing: boolean;
2020-10-01 00:43:05 +00:00
pip: boolean;
presentingSource?: PresentedSource;
presentingSourcesAvailable?: Array<PresentableSource>;
safetyNumberChangedUuids: Array<string>;
2021-01-08 22:57:54 +00:00
settingsDialogOpen: boolean;
showNeedsScreenRecordingPermissionsWarning?: boolean;
showParticipantsList: boolean;
};
export type CallsByConversationType = {
[conversationId: string]: DirectCallStateType | GroupCallStateType;
};
export type CallingStateType = MediaDeviceSettings & {
callsByConversation: CallsByConversationType;
activeCallState?: ActiveCallStateType;
2020-06-04 18:16:19 +00:00
};
export type AcceptCallType = {
conversationId: string;
2020-06-04 18:16:19 +00:00
asVideoCall: boolean;
};
export type CallStateChangeType = {
conversationId: string;
acceptedTime?: number;
2020-06-04 18:16:19 +00:00
callState: CallState;
2020-10-01 19:09:15 +00:00
callEndedReason?: CallEndedReason;
isIncoming: boolean;
isVideoCall: boolean;
title: string;
2020-06-04 18:16:19 +00:00
};
2020-11-13 19:57:55 +00:00
export type CancelCallType = {
conversationId: string;
};
2021-08-20 16:06:15 +00:00
type CancelIncomingGroupCallRingType = {
conversationId: string;
ringId: bigint;
};
2020-06-04 18:16:19 +00:00
export type DeclineCallType = {
conversationId: string;
2020-06-04 18:16:19 +00:00
};
2020-11-20 17:19:28 +00:00
type GroupCallStateChangeArgumentType = {
2020-11-13 19:57:55 +00:00
connectionState: GroupCallConnectionState;
2020-11-20 17:19:28 +00:00
conversationId: string;
2020-11-13 19:57:55 +00:00
hasLocalAudio: boolean;
hasLocalVideo: boolean;
2020-11-20 17:19:28 +00:00
joinState: GroupCallJoinState;
2020-12-02 18:14:03 +00:00
peekInfo?: GroupCallPeekInfoType;
2020-11-17 15:07:53 +00:00
remoteParticipants: Array<GroupCallParticipantInfoType>;
2020-11-13 19:57:55 +00:00
};
2020-11-20 17:19:28 +00:00
type GroupCallStateChangeActionPayloadType = GroupCallStateChangeArgumentType & {
2020-12-02 18:14:03 +00:00
ourUuid: string;
2020-11-20 17:19:28 +00:00
};
2020-06-04 18:16:19 +00:00
export type HangUpType = {
conversationId: string;
2020-06-04 18:16:19 +00:00
};
type KeyChangedType = {
uuid: string;
};
export type KeyChangeOkType = {
conversationId: string;
};
2021-08-20 16:06:15 +00:00
export type IncomingDirectCallType = {
conversationId: string;
isVideoCall: boolean;
2020-06-04 18:16:19 +00:00
};
2021-08-20 16:06:15 +00:00
type IncomingGroupCallType = {
conversationId: string;
ringId: bigint;
ringerUuid: string;
};
2020-11-20 17:19:28 +00:00
type PeekNotConnectedGroupCallType = {
conversationId: string;
};
type StartDirectCallType = {
conversationId: string;
hasLocalAudio: boolean;
hasLocalVideo: boolean;
};
2020-11-13 19:57:55 +00:00
export type StartCallType = StartDirectCallType & {
2020-11-13 19:57:55 +00:00
callMode: CallMode.Direct | CallMode.Group;
};
2020-06-04 18:16:19 +00:00
export type RemoteVideoChangeType = {
conversationId: string;
hasVideo: boolean;
2020-06-04 18:16:19 +00:00
};
type RemoteSharingScreenChangeType = {
conversationId: string;
isSharingScreen: boolean;
};
2020-06-04 18:16:19 +00:00
export type SetLocalAudioType = {
enabled: boolean;
};
export type SetLocalVideoType = {
enabled: boolean;
};
export type SetGroupCallVideoRequestType = {
conversationId: string;
resolutions: Array<GroupCallVideoRequest>;
};
export type StartCallingLobbyType = {
conversationId: string;
isVideoCall: boolean;
};
2020-11-13 19:57:55 +00:00
export type ShowCallLobbyType =
| {
callMode: CallMode.Direct;
conversationId: string;
hasLocalAudio: boolean;
hasLocalVideo: boolean;
}
| {
callMode: CallMode.Group;
conversationId: string;
connectionState: GroupCallConnectionState;
joinState: GroupCallJoinState;
hasLocalAudio: boolean;
hasLocalVideo: boolean;
2021-09-02 22:34:38 +00:00
isConversationTooBigToRing: boolean;
2020-12-02 18:14:03 +00:00
peekInfo?: GroupCallPeekInfoType;
2020-11-17 15:07:53 +00:00
remoteParticipants: Array<GroupCallParticipantInfoType>;
2020-11-13 19:57:55 +00:00
};
2020-08-27 00:03:42 +00:00
export type SetLocalPreviewType = {
element: React.RefObject<HTMLVideoElement> | undefined;
2020-06-04 18:16:19 +00:00
};
2020-08-27 00:03:42 +00:00
export type SetRendererCanvasType = {
element: React.RefObject<HTMLCanvasElement> | undefined;
2020-06-04 18:16:19 +00:00
};
2020-10-30 17:52:21 +00:00
// Helpers
2020-11-13 19:57:55 +00:00
export const getActiveCall = ({
activeCallState,
callsByConversation,
}: CallingStateType): undefined | DirectCallStateType | GroupCallStateType =>
activeCallState &&
getOwn(callsByConversation, activeCallState.conversationId);
// In theory, there could be multiple incoming calls, or an incoming call while there's
// an active call. In practice, the UI is not ready for this, and RingRTC doesn't
// support it for direct calls.
export const getIncomingCall = (
callsByConversation: Readonly<CallsByConversationType>,
ourUuid: string
): undefined | DirectCallStateType | GroupCallStateType =>
Object.values(callsByConversation).find(call => {
switch (call.callMode) {
case CallMode.Direct:
return call.isIncoming && call.callState === CallState.Ringing;
case CallMode.Group:
return (
call.ringerUuid &&
call.connectionState === GroupCallConnectionState.NotConnected &&
isAnybodyElseInGroupCall(call.peekInfo, ourUuid)
);
default:
throw missingCaseError(call);
}
});
2020-11-20 17:19:28 +00:00
export const isAnybodyElseInGroupCall = (
2020-12-02 18:14:03 +00:00
{ uuids }: Readonly<GroupCallPeekInfoType>,
ourUuid: string
): boolean => uuids.some(id => id !== ourUuid);
2020-11-20 17:19:28 +00:00
2021-08-20 16:06:15 +00:00
const getGroupCallRingState = (
call: Readonly<undefined | GroupCallStateType>
): GroupCallRingStateType =>
call?.ringId === undefined
? {}
: { ringId: call.ringId, ringerUuid: call.ringerUuid };
2020-06-04 18:16:19 +00:00
// Actions
2020-11-04 17:47:50 +00:00
const ACCEPT_CALL_PENDING = 'calling/ACCEPT_CALL_PENDING';
2020-10-08 01:25:33 +00:00
const CANCEL_CALL = 'calling/CANCEL_CALL';
2021-08-20 16:06:15 +00:00
const CANCEL_INCOMING_GROUP_CALL_RING =
'calling/CANCEL_INCOMING_GROUP_CALL_RING';
2020-10-08 01:25:33 +00:00
const SHOW_CALL_LOBBY = 'calling/SHOW_CALL_LOBBY';
const CALL_STATE_CHANGE_FULFILLED = 'calling/CALL_STATE_CHANGE_FULFILLED';
2020-08-27 00:03:42 +00:00
const CHANGE_IO_DEVICE_FULFILLED = 'calling/CHANGE_IO_DEVICE_FULFILLED';
2020-10-01 19:09:15 +00:00
const CLOSE_NEED_PERMISSION_SCREEN = 'calling/CLOSE_NEED_PERMISSION_SCREEN';
2021-08-20 16:06:15 +00:00
const DECLINE_DIRECT_CALL = 'calling/DECLINE_DIRECT_CALL';
2020-11-13 19:57:55 +00:00
const GROUP_CALL_STATE_CHANGE = 'calling/GROUP_CALL_STATE_CHANGE';
2020-06-04 18:16:19 +00:00
const HANG_UP = 'calling/HANG_UP';
2021-08-20 16:06:15 +00:00
const INCOMING_DIRECT_CALL = 'calling/INCOMING_DIRECT_CALL';
const INCOMING_GROUP_CALL = 'calling/INCOMING_GROUP_CALL';
const MARK_CALL_TRUSTED = 'calling/MARK_CALL_TRUSTED';
const MARK_CALL_UNTRUSTED = 'calling/MARK_CALL_UNTRUSTED';
2020-06-04 18:16:19 +00:00
const OUTGOING_CALL = 'calling/OUTGOING_CALL';
2020-11-20 17:19:28 +00:00
const PEEK_NOT_CONNECTED_GROUP_CALL_FULFILLED =
'calling/PEEK_NOT_CONNECTED_GROUP_CALL_FULFILLED';
2020-08-27 00:03:42 +00:00
const REFRESH_IO_DEVICES = 'calling/REFRESH_IO_DEVICES';
const REMOTE_SHARING_SCREEN_CHANGE = 'calling/REMOTE_SHARING_SCREEN_CHANGE';
2020-06-04 18:16:19 +00:00
const REMOTE_VIDEO_CHANGE = 'calling/REMOTE_VIDEO_CHANGE';
const RETURN_TO_ACTIVE_CALL = 'calling/RETURN_TO_ACTIVE_CALL';
const SET_LOCAL_AUDIO_FULFILLED = 'calling/SET_LOCAL_AUDIO_FULFILLED';
2020-06-04 18:16:19 +00:00
const SET_LOCAL_VIDEO_FULFILLED = 'calling/SET_LOCAL_VIDEO_FULFILLED';
const SET_OUTGOING_RING = 'calling/SET_OUTGOING_RING';
const SET_PRESENTING = 'calling/SET_PRESENTING';
const SET_PRESENTING_SOURCES = 'calling/SET_PRESENTING_SOURCES';
const TOGGLE_NEEDS_SCREEN_RECORDING_PERMISSIONS =
'calling/TOGGLE_NEEDS_SCREEN_RECORDING_PERMISSIONS';
2020-11-13 19:57:55 +00:00
const START_DIRECT_CALL = 'calling/START_DIRECT_CALL';
2020-10-08 01:25:33 +00:00
const TOGGLE_PARTICIPANTS = 'calling/TOGGLE_PARTICIPANTS';
2020-10-01 00:43:05 +00:00
const TOGGLE_PIP = 'calling/TOGGLE_PIP';
2020-08-27 00:03:42 +00:00
const TOGGLE_SETTINGS = 'calling/TOGGLE_SETTINGS';
2021-01-08 22:57:54 +00:00
const TOGGLE_SPEAKER_VIEW = 'calling/TOGGLE_SPEAKER_VIEW';
2020-06-04 18:16:19 +00:00
2020-11-04 17:47:50 +00:00
type AcceptCallPendingActionType = {
type: 'calling/ACCEPT_CALL_PENDING';
2020-06-04 18:16:19 +00:00
payload: AcceptCallType;
};
2020-10-08 01:25:33 +00:00
type CancelCallActionType = {
type: 'calling/CANCEL_CALL';
};
2021-08-20 16:06:15 +00:00
type CancelIncomingGroupCallRingActionType = {
type: 'calling/CANCEL_INCOMING_GROUP_CALL_RING';
payload: CancelIncomingGroupCallRingType;
};
2020-10-08 01:25:33 +00:00
type CallLobbyActionType = {
type: 'calling/SHOW_CALL_LOBBY';
payload: ShowCallLobbyType;
2020-10-08 01:25:33 +00:00
};
type CallStateChangeFulfilledActionType = {
type: 'calling/CALL_STATE_CHANGE_FULFILLED';
2020-06-04 18:16:19 +00:00
payload: CallStateChangeType;
};
2020-08-27 00:03:42 +00:00
type ChangeIODeviceFulfilledActionType = {
type: 'calling/CHANGE_IO_DEVICE_FULFILLED';
payload: ChangeIODevicePayloadType;
};
2020-10-01 19:09:15 +00:00
type CloseNeedPermissionScreenActionType = {
type: 'calling/CLOSE_NEED_PERMISSION_SCREEN';
payload: null;
};
2020-06-04 18:16:19 +00:00
type DeclineCallActionType = {
2021-08-20 16:06:15 +00:00
type: 'calling/DECLINE_DIRECT_CALL';
2020-06-04 18:16:19 +00:00
payload: DeclineCallType;
};
2020-11-20 17:19:28 +00:00
export type GroupCallStateChangeActionType = {
2020-11-13 19:57:55 +00:00
type: 'calling/GROUP_CALL_STATE_CHANGE';
2020-11-20 17:19:28 +00:00
payload: GroupCallStateChangeActionPayloadType;
2020-11-13 19:57:55 +00:00
};
2020-06-04 18:16:19 +00:00
type HangUpActionType = {
type: 'calling/HANG_UP';
payload: HangUpType;
};
2021-08-20 16:06:15 +00:00
type IncomingDirectCallActionType = {
type: 'calling/INCOMING_DIRECT_CALL';
payload: IncomingDirectCallType;
};
type IncomingGroupCallActionType = {
type: 'calling/INCOMING_GROUP_CALL';
payload: IncomingGroupCallType;
2020-06-04 18:16:19 +00:00
};
type KeyChangedActionType = {
type: 'calling/MARK_CALL_UNTRUSTED';
payload: {
safetyNumberChangedUuids: Array<string>;
};
};
type KeyChangeOkActionType = {
type: 'calling/MARK_CALL_TRUSTED';
payload: null;
};
2020-06-04 18:16:19 +00:00
type OutgoingCallActionType = {
type: 'calling/OUTGOING_CALL';
2020-11-13 19:57:55 +00:00
payload: StartDirectCallType;
2020-06-04 18:16:19 +00:00
};
export type PeekNotConnectedGroupCallFulfilledActionType = {
2020-11-20 17:19:28 +00:00
type: 'calling/PEEK_NOT_CONNECTED_GROUP_CALL_FULFILLED';
payload: {
conversationId: string;
peekInfo: GroupCallPeekInfoType;
ourConversationId: string;
};
};
2020-08-27 00:03:42 +00:00
type RefreshIODevicesActionType = {
type: 'calling/REFRESH_IO_DEVICES';
payload: MediaDeviceSettings;
};
type RemoteSharingScreenChangeActionType = {
type: 'calling/REMOTE_SHARING_SCREEN_CHANGE';
payload: RemoteSharingScreenChangeType;
};
2020-06-04 18:16:19 +00:00
type RemoteVideoChangeActionType = {
type: 'calling/REMOTE_VIDEO_CHANGE';
payload: RemoteVideoChangeType;
};
type ReturnToActiveCallActionType = {
type: 'calling/RETURN_TO_ACTIVE_CALL';
};
2020-06-04 18:16:19 +00:00
type SetLocalAudioActionType = {
type: 'calling/SET_LOCAL_AUDIO_FULFILLED';
2020-06-04 18:16:19 +00:00
payload: SetLocalAudioType;
};
type SetLocalVideoFulfilledActionType = {
type: 'calling/SET_LOCAL_VIDEO_FULFILLED';
payload: SetLocalVideoType;
};
type SetPresentingFulfilledActionType = {
type: 'calling/SET_PRESENTING';
payload?: PresentedSource;
};
type SetPresentingSourcesActionType = {
type: 'calling/SET_PRESENTING_SOURCES';
payload: Array<PresentableSource>;
};
type SetOutgoingRingActionType = {
type: 'calling/SET_OUTGOING_RING';
payload: boolean;
};
type ShowCallLobbyActionType = {
type: 'calling/SHOW_CALL_LOBBY';
payload: ShowCallLobbyType;
};
2020-11-13 19:57:55 +00:00
type StartDirectCallActionType = {
type: 'calling/START_DIRECT_CALL';
payload: StartDirectCallType;
2020-10-08 01:25:33 +00:00
};
type ToggleNeedsScreenRecordingPermissionsActionType = {
type: 'calling/TOGGLE_NEEDS_SCREEN_RECORDING_PERMISSIONS';
};
2020-10-08 01:25:33 +00:00
type ToggleParticipantsActionType = {
type: 'calling/TOGGLE_PARTICIPANTS';
};
2020-10-01 00:43:05 +00:00
type TogglePipActionType = {
type: 'calling/TOGGLE_PIP';
};
2020-08-27 00:03:42 +00:00
type ToggleSettingsActionType = {
type: 'calling/TOGGLE_SETTINGS';
};
2021-01-08 22:57:54 +00:00
type ToggleSpeakerViewActionType = {
type: 'calling/TOGGLE_SPEAKER_VIEW';
};
2020-06-04 18:16:19 +00:00
export type CallingActionType =
2020-11-04 17:47:50 +00:00
| AcceptCallPendingActionType
2020-10-08 01:25:33 +00:00
| CancelCallActionType
2021-08-20 16:06:15 +00:00
| CancelIncomingGroupCallRingActionType
2020-10-08 01:25:33 +00:00
| CallLobbyActionType
| CallStateChangeFulfilledActionType
2020-08-27 00:03:42 +00:00
| ChangeIODeviceFulfilledActionType
2020-10-01 19:09:15 +00:00
| CloseNeedPermissionScreenActionType
2021-09-02 22:34:38 +00:00
| ConversationChangedActionType
2020-06-04 18:16:19 +00:00
| DeclineCallActionType
2020-11-13 19:57:55 +00:00
| GroupCallStateChangeActionType
2020-06-04 18:16:19 +00:00
| HangUpActionType
2021-08-20 16:06:15 +00:00
| IncomingDirectCallActionType
| IncomingGroupCallActionType
| KeyChangedActionType
| KeyChangeOkActionType
2020-06-04 18:16:19 +00:00
| OutgoingCallActionType
2020-11-20 17:19:28 +00:00
| PeekNotConnectedGroupCallFulfilledActionType
2020-08-27 00:03:42 +00:00
| RefreshIODevicesActionType
| RemoteSharingScreenChangeActionType
2020-06-04 18:16:19 +00:00
| RemoteVideoChangeActionType
| ReturnToActiveCallActionType
2020-06-04 18:16:19 +00:00
| SetLocalAudioActionType
2020-08-27 00:03:42 +00:00
| SetLocalVideoFulfilledActionType
| SetPresentingSourcesActionType
| SetOutgoingRingActionType
| ShowCallLobbyActionType
2020-11-13 19:57:55 +00:00
| StartDirectCallActionType
| ToggleNeedsScreenRecordingPermissionsActionType
2020-10-08 01:25:33 +00:00
| ToggleParticipantsActionType
2020-10-01 00:43:05 +00:00
| TogglePipActionType
| SetPresentingFulfilledActionType
2021-01-08 22:57:54 +00:00
| ToggleSettingsActionType
| ToggleSpeakerViewActionType;
2020-06-04 18:16:19 +00:00
// Action Creators
function acceptCall(
payload: AcceptCallType
2020-11-04 17:47:50 +00:00
): ThunkAction<void, RootStateType, unknown, AcceptCallPendingActionType> {
2021-08-20 16:06:15 +00:00
return async (dispatch, getState) => {
const { conversationId, asVideoCall } = payload;
const call = getOwn(getState().calling.callsByConversation, conversationId);
if (!call) {
log.error('Trying to accept a non-existent call');
2021-08-20 16:06:15 +00:00
return;
}
switch (call.callMode) {
case CallMode.Direct:
await calling.acceptDirectCall(conversationId, asVideoCall);
break;
case CallMode.Group:
calling.joinGroupCall(conversationId, true, asVideoCall, false);
2021-08-20 16:06:15 +00:00
break;
default:
throw missingCaseError(call);
}
2020-11-04 17:47:50 +00:00
dispatch({
type: ACCEPT_CALL_PENDING,
payload,
});
2020-06-04 18:16:19 +00:00
};
}
function callStateChange(
payload: CallStateChangeType
2020-11-04 17:47:50 +00:00
): ThunkAction<
void,
RootStateType,
unknown,
CallStateChangeFulfilledActionType
> {
return async dispatch => {
2021-08-20 16:06:15 +00:00
const { callState } = payload;
2020-11-04 17:47:50 +00:00
if (callState === CallState.Ended) {
await callingTones.playEndCall();
ipcRenderer.send('close-screen-share-controller');
2020-11-04 17:47:50 +00:00
}
dispatch({
type: CALL_STATE_CHANGE_FULFILLED,
payload,
});
};
}
2020-08-27 00:03:42 +00:00
function changeIODevice(
payload: ChangeIODevicePayloadType
2020-11-04 17:47:50 +00:00
): ThunkAction<
void,
RootStateType,
unknown,
ChangeIODeviceFulfilledActionType
> {
return async dispatch => {
// Only `setPreferredCamera` returns a Promise.
if (payload.type === CallingDeviceType.CAMERA) {
await calling.setPreferredCamera(payload.selectedDevice);
} else if (payload.type === CallingDeviceType.MICROPHONE) {
calling.setPreferredMicrophone(payload.selectedDevice);
} else if (payload.type === CallingDeviceType.SPEAKER) {
calling.setPreferredSpeaker(payload.selectedDevice);
}
dispatch({
type: CHANGE_IO_DEVICE_FULFILLED,
payload,
});
2020-08-27 00:03:42 +00:00
};
}
2020-10-01 19:09:15 +00:00
function closeNeedPermissionScreen(): CloseNeedPermissionScreenActionType {
return {
type: CLOSE_NEED_PERMISSION_SCREEN,
payload: null,
};
}
2020-11-13 19:57:55 +00:00
function cancelCall(payload: CancelCallType): CancelCallActionType {
calling.stopCallingLobby(payload.conversationId);
2020-10-08 01:25:33 +00:00
return {
type: CANCEL_CALL,
};
}
2021-08-20 16:06:15 +00:00
function cancelIncomingGroupCallRing(
payload: CancelIncomingGroupCallRingType
): CancelIncomingGroupCallRingActionType {
2020-06-04 18:16:19 +00:00
return {
2021-08-20 16:06:15 +00:00
type: CANCEL_INCOMING_GROUP_CALL_RING,
2020-06-04 18:16:19 +00:00
payload,
};
}
2021-08-20 16:06:15 +00:00
function declineCall(
payload: DeclineCallType
): ThunkAction<
void,
RootStateType,
unknown,
CancelIncomingGroupCallRingActionType | DeclineCallActionType
> {
return (dispatch, getState) => {
const { conversationId } = payload;
const call = getOwn(getState().calling.callsByConversation, conversationId);
if (!call) {
log.error('Trying to decline a non-existent call');
2021-08-20 16:06:15 +00:00
return;
}
switch (call.callMode) {
case CallMode.Direct:
calling.declineDirectCall(conversationId);
dispatch({
type: DECLINE_DIRECT_CALL,
payload,
});
break;
case CallMode.Group: {
const { ringId } = call;
if (ringId === undefined) {
log.error('Trying to decline a group call without a ring ID');
2021-08-20 16:06:15 +00:00
} else {
calling.declineGroupCall(conversationId, ringId);
dispatch({
type: CANCEL_INCOMING_GROUP_CALL_RING,
payload: { conversationId, ringId },
});
}
break;
}
default:
throw missingCaseError(call);
}
};
}
function getPresentingSources(): ThunkAction<
void,
RootStateType,
unknown,
| SetPresentingSourcesActionType
| ToggleNeedsScreenRecordingPermissionsActionType
> {
return async (dispatch, getState) => {
// We check if the user has permissions first before calling desktopCapturer
// Next we call getPresentingSources so that one gets the prompt for permissions,
// if necessary.
// Finally, we have the if statement which shows the modal, if needed.
// It is in this exact order so that during first-time-use one will be
// prompted for permissions and if they so happen to deny we can still
// capture that state correctly.
const platform = getPlatform(getState());
const needsPermission =
platform === 'darwin' && !hasScreenCapturePermission();
const sources = await calling.getPresentingSources();
if (needsPermission) {
dispatch({
type: TOGGLE_NEEDS_SCREEN_RECORDING_PERMISSIONS,
});
return;
}
dispatch({
type: SET_PRESENTING_SOURCES,
payload: sources,
});
};
}
2020-11-13 19:57:55 +00:00
function groupCallStateChange(
2020-11-20 17:19:28 +00:00
payload: GroupCallStateChangeArgumentType
): ThunkAction<void, RootStateType, unknown, GroupCallStateChangeActionType> {
return async (dispatch, getState) => {
let didSomeoneStartPresenting: boolean;
const activeCall = getActiveCall(getState().calling);
if (activeCall?.callMode === CallMode.Group) {
const wasSomeonePresenting = activeCall.remoteParticipants.some(
participant => participant.presenting
);
const isSomeonePresenting = payload.remoteParticipants.some(
participant => participant.presenting
);
didSomeoneStartPresenting = !wasSomeonePresenting && isSomeonePresenting;
} else {
didSomeoneStartPresenting = false;
}
2020-11-20 17:19:28 +00:00
dispatch({
type: GROUP_CALL_STATE_CHANGE,
payload: {
...payload,
2020-12-02 18:14:03 +00:00
ourUuid: getState().user.ourUuid,
2020-11-20 17:19:28 +00:00
},
});
if (didSomeoneStartPresenting) {
callingTones.someonePresenting();
}
2021-06-01 19:47:55 +00:00
if (payload.connectionState === GroupCallConnectionState.NotConnected) {
ipcRenderer.send('close-screen-share-controller');
}
2020-11-13 19:57:55 +00:00
};
}
2020-06-04 18:16:19 +00:00
function hangUp(payload: HangUpType): HangUpActionType {
calling.hangup(payload.conversationId);
2020-06-04 18:16:19 +00:00
return {
type: HANG_UP,
payload,
};
}
function keyChanged(
payload: KeyChangedType
): ThunkAction<void, RootStateType, unknown, KeyChangedActionType> {
return (dispatch, getState) => {
const state = getState();
const { activeCallState } = state.calling;
const activeCall = getActiveCall(state.calling);
if (!activeCall || !activeCallState) {
return;
}
if (activeCall.callMode === CallMode.Group) {
const uuidsChanged = new Set(activeCallState.safetyNumberChangedUuids);
// Iterate over each participant to ensure that the uuid passed in
// matches one of the participants in the group call.
activeCall.remoteParticipants.forEach(participant => {
if (participant.uuid === payload.uuid) {
uuidsChanged.add(participant.uuid);
}
});
const safetyNumberChangedUuids = Array.from(uuidsChanged);
if (safetyNumberChangedUuids.length) {
dispatch({
type: MARK_CALL_UNTRUSTED,
payload: {
safetyNumberChangedUuids,
},
});
}
}
};
}
function keyChangeOk(
payload: KeyChangeOkType
): ThunkAction<void, RootStateType, unknown, KeyChangeOkActionType> {
return dispatch => {
calling.resendGroupCallMediaKeys(payload.conversationId);
dispatch({
type: MARK_CALL_TRUSTED,
payload: null,
});
};
}
2021-08-20 16:06:15 +00:00
function receiveIncomingDirectCall(
payload: IncomingDirectCallType
): IncomingDirectCallActionType {
return {
type: INCOMING_DIRECT_CALL,
payload,
};
}
function receiveIncomingGroupCall(
payload: IncomingGroupCallType
): IncomingGroupCallActionType {
2020-06-04 18:16:19 +00:00
return {
2021-08-20 16:06:15 +00:00
type: INCOMING_GROUP_CALL,
2020-06-04 18:16:19 +00:00
payload,
};
}
function openSystemPreferencesAction(): ThunkAction<
void,
RootStateType,
unknown,
never
> {
return () => {
openSystemPreferences();
};
}
2020-11-13 19:57:55 +00:00
function outgoingCall(payload: StartDirectCallType): OutgoingCallActionType {
2020-06-04 18:16:19 +00:00
return {
type: OUTGOING_CALL,
payload,
};
}
2020-11-20 17:19:28 +00:00
// We might call this function many times in rapid succession (for example, if lots of
// people are joining and leaving at once). We want to make sure to update eventually
// (if people join and leave for an hour, we don't want you to have to wait an hour to
// get an update), and we also don't want to update too often. That's why we use a
// "latest queue".
const peekQueueByConversation = new Map<string, LatestQueue>();
function peekNotConnectedGroupCall(
payload: PeekNotConnectedGroupCallType
): ThunkAction<
void,
RootStateType,
unknown,
PeekNotConnectedGroupCallFulfilledActionType
> {
return (dispatch, getState) => {
const { conversationId } = payload;
let queue = peekQueueByConversation.get(conversationId);
if (!queue) {
queue = new LatestQueue();
queue.onceEmpty(() => {
peekQueueByConversation.delete(conversationId);
});
peekQueueByConversation.set(conversationId, queue);
}
queue.add(async () => {
const state = getState();
const { ourUuid } = state.user;
2020-11-20 17:19:28 +00:00
// We make sure we're not trying to peek at a connected (or connecting, or
// reconnecting) call. Because this is asynchronous, it's possible that the call
// will connect by the time we dispatch, so we also need to do a similar check in
// the reducer.
const existingCall = getOwn(
state.calling.callsByConversation,
conversationId
);
if (
existingCall?.callMode === CallMode.Group &&
existingCall.connectionState !== GroupCallConnectionState.NotConnected
) {
return;
}
// If we peek right after receiving the message, we may get outdated information.
// This is most noticeable when someone leaves. We add a delay and then make sure
// to only be peeking once.
await sleep(1000);
let peekInfo;
try {
peekInfo = await calling.peekGroupCall(conversationId);
} catch (err) {
log.error('Group call peeking failed', err);
2020-11-20 17:19:28 +00:00
return;
}
if (!peekInfo) {
return;
}
calling.updateCallHistoryForGroupCall(conversationId, peekInfo);
const formattedPeekInfo = calling.formatGroupCallPeekInfoForRedux(
peekInfo
);
2020-11-20 17:19:28 +00:00
dispatch({
type: PEEK_NOT_CONNECTED_GROUP_CALL_FULFILLED,
payload: {
conversationId,
peekInfo: formattedPeekInfo,
2020-11-20 17:19:28 +00:00
ourConversationId: state.user.ourConversationId,
},
});
// We want to show "Alice started a group call" only if a call isn't ringing or
// active. We wait a moment to make sure that we don't accidentally show a ring
// notification followed swiftly by a less urgent notification.
if (!isAnybodyElseInGroupCall(formattedPeekInfo, ourUuid)) {
return;
}
await sleep(1000);
const newCallingState = getState().calling;
if (
getActiveCall(newCallingState)?.conversationId === conversationId ||
getIncomingCall(newCallingState.callsByConversation, ourUuid)
) {
return;
}
calling.notifyForGroupCall(conversationId, peekInfo.creator);
2020-11-20 17:19:28 +00:00
});
};
}
2020-08-27 00:03:42 +00:00
function refreshIODevices(
payload: MediaDeviceSettings
): RefreshIODevicesActionType {
return {
type: REFRESH_IO_DEVICES,
payload,
};
}
function remoteSharingScreenChange(
payload: RemoteSharingScreenChangeType
): RemoteSharingScreenChangeActionType {
return {
type: REMOTE_SHARING_SCREEN_CHANGE,
payload,
};
}
2020-06-04 18:16:19 +00:00
function remoteVideoChange(
payload: RemoteVideoChangeType
): RemoteVideoChangeActionType {
return {
type: REMOTE_VIDEO_CHANGE,
payload,
};
}
function returnToActiveCall(): ReturnToActiveCallActionType {
return {
type: RETURN_TO_ACTIVE_CALL,
};
}
2020-11-04 17:47:50 +00:00
function setLocalPreview(
payload: SetLocalPreviewType
): ThunkAction<void, RootStateType, unknown, never> {
return () => {
calling.videoCapturer.setLocalPreview(payload.element);
2020-06-04 18:16:19 +00:00
};
}
2020-11-04 17:47:50 +00:00
function setRendererCanvas(
payload: SetRendererCanvasType
): ThunkAction<void, RootStateType, unknown, never> {
return () => {
calling.videoRenderer.setCanvas(payload.element);
2020-06-04 18:16:19 +00:00
};
}
function setLocalAudio(
payload: SetLocalAudioType
): ThunkAction<void, RootStateType, unknown, SetLocalAudioActionType> {
return (dispatch, getState) => {
2020-11-13 19:57:55 +00:00
const activeCall = getActiveCall(getState().calling);
if (!activeCall) {
log.warn('Trying to set local audio when no call is active');
2020-11-13 19:57:55 +00:00
return;
}
2020-06-04 18:16:19 +00:00
2020-11-13 19:57:55 +00:00
calling.setOutgoingAudio(activeCall.conversationId, payload.enabled);
dispatch({
type: SET_LOCAL_AUDIO_FULFILLED,
payload,
});
2020-06-04 18:16:19 +00:00
};
}
2020-11-04 17:47:50 +00:00
function setLocalVideo(
payload: SetLocalVideoType
): ThunkAction<void, RootStateType, unknown, SetLocalVideoFulfilledActionType> {
return async (dispatch, getState) => {
2020-11-13 19:57:55 +00:00
const activeCall = getActiveCall(getState().calling);
if (!activeCall) {
log.warn('Trying to set local video when no call is active');
2020-11-13 19:57:55 +00:00
return;
}
2020-11-04 17:47:50 +00:00
let enabled: boolean;
if (await requestCameraPermissions()) {
2020-11-13 19:57:55 +00:00
if (
activeCall.callMode === CallMode.Group ||
(activeCall.callMode === CallMode.Direct && activeCall.callState)
) {
calling.setOutgoingVideo(activeCall.conversationId, payload.enabled);
2020-11-04 17:47:50 +00:00
} else if (payload.enabled) {
calling.enableLocalCamera();
} else {
calling.disableLocalVideo();
2020-11-04 17:47:50 +00:00
}
({ enabled } = payload);
} else {
enabled = false;
}
dispatch({
type: SET_LOCAL_VIDEO_FULFILLED,
payload: {
...payload,
enabled,
},
});
2020-06-04 18:16:19 +00:00
};
}
function setGroupCallVideoRequest(
payload: SetGroupCallVideoRequestType
): ThunkAction<void, RootStateType, unknown, never> {
return () => {
calling.setGroupCallVideoRequest(
payload.conversationId,
payload.resolutions.map(resolution => ({
...resolution,
// The `framerate` property in RingRTC has to be set, even if it's set to
// `undefined`.
framerate: undefined,
}))
);
};
}
function setPresenting(
sourceToPresent?: PresentedSource
): ThunkAction<void, RootStateType, unknown, SetPresentingFulfilledActionType> {
return async (dispatch, getState) => {
const callingState = getState().calling;
const { activeCallState } = callingState;
const activeCall = getActiveCall(callingState);
if (!activeCall || !activeCallState) {
log.warn('Trying to present when no call is active');
return;
}
calling.setPresenting(
activeCall.conversationId,
activeCallState.hasLocalVideo,
sourceToPresent
);
dispatch({
type: SET_PRESENTING,
payload: sourceToPresent,
});
if (sourceToPresent) {
await callingTones.someonePresenting();
}
};
}
function setOutgoingRing(payload: boolean): SetOutgoingRingActionType {
return {
type: SET_OUTGOING_RING,
payload,
};
}
function startCallingLobby(
payload: StartCallingLobbyType
): ThunkAction<void, RootStateType, unknown, never> {
return () => {
calling.startCallingLobby(payload.conversationId, payload.isVideoCall);
};
}
// TODO: This action should be replaced with an action dispatched in the
// `startCallingLobby` thunk.
function showCallLobby(payload: ShowCallLobbyType): CallLobbyActionType {
2020-10-08 01:25:33 +00:00
return {
type: SHOW_CALL_LOBBY,
payload,
};
}
2020-11-13 19:57:55 +00:00
function startCall(
payload: StartCallType
): ThunkAction<void, RootStateType, unknown, StartDirectCallActionType> {
return (dispatch, getState) => {
2020-11-13 19:57:55 +00:00
switch (payload.callMode) {
case CallMode.Direct:
calling.startOutgoingDirectCall(
payload.conversationId,
payload.hasLocalAudio,
payload.hasLocalVideo
);
dispatch({
type: START_DIRECT_CALL,
payload,
});
break;
case CallMode.Group: {
2021-09-02 22:34:38 +00:00
let outgoingRing: boolean;
const state = getState();
const { activeCallState } = state.calling;
if (isGroupCallOutboundRingEnabled() && activeCallState?.outgoingRing) {
2021-09-02 22:34:38 +00:00
const conversation = getOwn(
state.conversations.conversationLookup,
activeCallState.conversationId
);
outgoingRing = Boolean(
conversation && !isConversationTooBigToRing(conversation)
);
} else {
outgoingRing = false;
}
2020-11-13 19:57:55 +00:00
calling.joinGroupCall(
payload.conversationId,
payload.hasLocalAudio,
payload.hasLocalVideo,
outgoingRing
2020-11-13 19:57:55 +00:00
);
// The calling service should already be wired up to Redux so we don't need to
// dispatch anything here.
break;
}
2020-11-13 19:57:55 +00:00
default:
throw missingCaseError(payload.callMode);
}
2020-10-08 01:25:33 +00:00
};
}
function toggleParticipants(): ToggleParticipantsActionType {
return {
type: TOGGLE_PARTICIPANTS,
};
}
2020-10-01 00:43:05 +00:00
function togglePip(): TogglePipActionType {
return {
type: TOGGLE_PIP,
};
}
function toggleScreenRecordingPermissionsDialog(): ToggleNeedsScreenRecordingPermissionsActionType {
return {
type: TOGGLE_NEEDS_SCREEN_RECORDING_PERMISSIONS,
};
}
2020-08-27 00:03:42 +00:00
function toggleSettings(): ToggleSettingsActionType {
return {
type: TOGGLE_SETTINGS,
};
}
2021-01-08 22:57:54 +00:00
function toggleSpeakerView(): ToggleSpeakerViewActionType {
return {
type: TOGGLE_SPEAKER_VIEW,
};
}
2020-06-04 18:16:19 +00:00
export const actions = {
acceptCall,
callStateChange,
cancelCall,
2021-08-20 16:06:15 +00:00
cancelIncomingGroupCallRing,
2020-08-27 00:03:42 +00:00
changeIODevice,
2020-10-01 19:09:15 +00:00
closeNeedPermissionScreen,
2020-06-04 18:16:19 +00:00
declineCall,
getPresentingSources,
2020-11-13 19:57:55 +00:00
groupCallStateChange,
2020-06-04 18:16:19 +00:00
hangUp,
keyChangeOk,
keyChanged,
openSystemPreferencesAction,
2020-06-04 18:16:19 +00:00
outgoingCall,
2020-11-20 17:19:28 +00:00
peekNotConnectedGroupCall,
2021-08-20 16:06:15 +00:00
receiveIncomingDirectCall,
receiveIncomingGroupCall,
2020-08-27 00:03:42 +00:00
refreshIODevices,
remoteSharingScreenChange,
2020-06-04 18:16:19 +00:00
remoteVideoChange,
returnToActiveCall,
setGroupCallVideoRequest,
2020-06-04 18:16:19 +00:00
setLocalAudio,
setLocalPreview,
2020-06-04 18:16:19 +00:00
setLocalVideo,
setPresenting,
setRendererCanvas,
setOutgoingRing,
2020-10-08 01:25:33 +00:00
showCallLobby,
startCall,
startCallingLobby,
2020-10-08 01:25:33 +00:00
toggleParticipants,
2020-10-01 00:43:05 +00:00
togglePip,
toggleScreenRecordingPermissionsDialog,
2020-08-27 00:03:42 +00:00
toggleSettings,
2021-01-08 22:57:54 +00:00
toggleSpeakerView,
2020-06-04 18:16:19 +00:00
};
export type ActionsType = typeof actions;
// Reducer
2020-10-30 17:52:21 +00:00
export function getEmptyState(): CallingStateType {
2020-06-04 18:16:19 +00:00
return {
2020-08-27 00:03:42 +00:00
availableCameras: [],
availableMicrophones: [],
availableSpeakers: [],
selectedCamera: undefined,
selectedMicrophone: undefined,
selectedSpeaker: undefined,
callsByConversation: {},
activeCallState: undefined,
};
}
2021-08-20 16:06:15 +00:00
function getGroupCall(
2020-12-02 18:14:03 +00:00
conversationId: string,
2021-08-20 16:06:15 +00:00
state: Readonly<CallingStateType>
): undefined | GroupCallStateType {
const call = getOwn(state.callsByConversation, conversationId);
return call?.callMode === CallMode.Group ? call : undefined;
2020-12-02 18:14:03 +00:00
}
function removeConversationFromState(
state: Readonly<CallingStateType>,
conversationId: string
): CallingStateType {
return {
...(conversationId === state.activeCallState?.conversationId
? omit(state, 'activeCallState')
: state),
callsByConversation: omit(state.callsByConversation, conversationId),
2020-06-04 18:16:19 +00:00
};
}
export function reducer(
state: Readonly<CallingStateType> = getEmptyState(),
action: Readonly<CallingActionType>
2020-06-04 18:16:19 +00:00
): CallingStateType {
const { callsByConversation } = state;
2020-10-08 01:25:33 +00:00
if (action.type === SHOW_CALL_LOBBY) {
2021-08-20 16:06:15 +00:00
const { conversationId } = action.payload;
2020-11-13 19:57:55 +00:00
let call: DirectCallStateType | GroupCallStateType;
let outgoingRing: boolean;
2020-11-13 19:57:55 +00:00
switch (action.payload.callMode) {
case CallMode.Direct:
call = {
callMode: CallMode.Direct,
2021-08-20 16:06:15 +00:00
conversationId,
2020-11-13 19:57:55 +00:00
isIncoming: false,
isVideoCall: action.payload.hasLocalVideo,
};
outgoingRing = true;
2020-11-13 19:57:55 +00:00
break;
2021-08-20 16:06:15 +00:00
case CallMode.Group: {
2020-11-13 19:57:55 +00:00
// We expect to be in this state briefly. The Calling service should update the
// call state shortly.
2021-08-20 16:06:15 +00:00
const existingCall = getGroupCall(conversationId, state);
2021-09-02 22:34:38 +00:00
const ringState = getGroupCallRingState(existingCall);
2020-11-13 19:57:55 +00:00
call = {
callMode: CallMode.Group,
2021-08-20 16:06:15 +00:00
conversationId,
2020-11-13 19:57:55 +00:00
connectionState: action.payload.connectionState,
joinState: action.payload.joinState,
2020-12-02 18:14:03 +00:00
peekInfo: action.payload.peekInfo ||
2021-08-20 16:06:15 +00:00
existingCall?.peekInfo || {
2020-12-02 18:14:03 +00:00
uuids: action.payload.remoteParticipants.map(({ uuid }) => uuid),
maxDevices: Infinity,
deviceCount: action.payload.remoteParticipants.length,
},
2020-11-13 19:57:55 +00:00
remoteParticipants: action.payload.remoteParticipants,
2021-09-02 22:34:38 +00:00
...ringState,
2020-11-13 19:57:55 +00:00
};
outgoingRing =
isGroupCallOutboundRingEnabled() &&
2021-09-02 22:34:38 +00:00
!ringState.ringId &&
!call.peekInfo.uuids.length &&
!call.remoteParticipants.length &&
!action.payload.isConversationTooBigToRing;
2020-11-13 19:57:55 +00:00
break;
2021-08-20 16:06:15 +00:00
}
2020-11-13 19:57:55 +00:00
default:
throw missingCaseError(action.payload);
}
2020-10-08 01:25:33 +00:00
return {
...state,
callsByConversation: {
...callsByConversation,
2020-11-13 19:57:55 +00:00
[action.payload.conversationId]: call,
},
activeCallState: {
conversationId: action.payload.conversationId,
2020-11-13 19:57:55 +00:00
hasLocalAudio: action.payload.hasLocalAudio,
hasLocalVideo: action.payload.hasLocalVideo,
2021-01-08 22:57:54 +00:00
isInSpeakerView: false,
pip: false,
safetyNumberChangedUuids: [],
settingsDialogOpen: false,
showParticipantsList: false,
outgoingRing,
},
2020-10-08 01:25:33 +00:00
};
}
2020-11-13 19:57:55 +00:00
if (action.type === START_DIRECT_CALL) {
2020-10-08 01:25:33 +00:00
return {
...state,
callsByConversation: {
...callsByConversation,
[action.payload.conversationId]: {
2020-11-13 19:57:55 +00:00
callMode: CallMode.Direct,
conversationId: action.payload.conversationId,
callState: CallState.Prering,
isIncoming: false,
isVideoCall: action.payload.hasLocalVideo,
},
},
activeCallState: {
conversationId: action.payload.conversationId,
hasLocalAudio: action.payload.hasLocalAudio,
hasLocalVideo: action.payload.hasLocalVideo,
2021-01-08 22:57:54 +00:00
isInSpeakerView: false,
pip: false,
safetyNumberChangedUuids: [],
settingsDialogOpen: false,
showParticipantsList: false,
outgoingRing: true,
},
2020-10-08 01:25:33 +00:00
};
}
2020-11-04 17:47:50 +00:00
if (action.type === ACCEPT_CALL_PENDING) {
if (!has(state.callsByConversation, action.payload.conversationId)) {
log.warn('Unable to accept a non-existent call');
return state;
}
2020-06-04 18:16:19 +00:00
return {
...state,
activeCallState: {
conversationId: action.payload.conversationId,
hasLocalAudio: true,
hasLocalVideo: action.payload.asVideoCall,
2021-01-08 22:57:54 +00:00
isInSpeakerView: false,
pip: false,
safetyNumberChangedUuids: [],
settingsDialogOpen: false,
showParticipantsList: false,
outgoingRing: false,
},
2020-06-04 18:16:19 +00:00
};
}
2020-10-01 19:09:15 +00:00
if (
2020-10-08 01:25:33 +00:00
action.type === CANCEL_CALL ||
2020-10-01 19:09:15 +00:00
action.type === HANG_UP ||
action.type === CLOSE_NEED_PERMISSION_SCREEN
) {
2020-11-13 19:57:55 +00:00
const activeCall = getActiveCall(state);
if (!activeCall) {
log.warn('No active call to remove');
return state;
}
2020-11-13 19:57:55 +00:00
switch (activeCall.callMode) {
case CallMode.Direct:
return removeConversationFromState(state, activeCall.conversationId);
case CallMode.Group:
return omit(state, 'activeCallState');
default:
throw missingCaseError(activeCall);
}
}
2021-08-20 16:06:15 +00:00
if (action.type === CANCEL_INCOMING_GROUP_CALL_RING) {
const { conversationId, ringId } = action.payload;
const groupCall = getGroupCall(conversationId, state);
if (!groupCall || groupCall.ringId !== ringId) {
return state;
}
if (groupCall.connectionState === GroupCallConnectionState.NotConnected) {
return removeConversationFromState(state, conversationId);
}
return {
...state,
callsByConversation: {
...callsByConversation,
[conversationId]: omit(groupCall, ['ringId', 'ringerUuid']),
},
};
}
2021-09-02 22:34:38 +00:00
if (action.type === 'CONVERSATION_CHANGED') {
const activeCall = getActiveCall(state);
const { activeCallState } = state;
if (
!activeCallState?.outgoingRing ||
activeCallState.conversationId !== action.payload.id ||
activeCall?.callMode !== CallMode.Group ||
activeCall.joinState !== GroupCallJoinState.NotJoined ||
!isConversationTooBigToRing(action.payload.data)
) {
return state;
}
return {
...state,
activeCallState: { ...activeCallState, outgoingRing: false },
};
}
2021-08-20 16:06:15 +00:00
if (action.type === DECLINE_DIRECT_CALL) {
return removeConversationFromState(state, action.payload.conversationId);
2020-06-04 18:16:19 +00:00
}
2021-08-20 16:06:15 +00:00
if (action.type === INCOMING_DIRECT_CALL) {
2020-06-04 18:16:19 +00:00
return {
...state,
callsByConversation: {
...callsByConversation,
[action.payload.conversationId]: {
2020-11-13 19:57:55 +00:00
callMode: CallMode.Direct,
conversationId: action.payload.conversationId,
callState: CallState.Prering,
isIncoming: true,
isVideoCall: action.payload.isVideoCall,
},
},
2020-06-04 18:16:19 +00:00
};
}
2021-08-20 16:06:15 +00:00
if (action.type === INCOMING_GROUP_CALL) {
const { conversationId, ringId, ringerUuid } = action.payload;
let groupCall: GroupCallStateType;
const existingGroupCall = getGroupCall(conversationId, state);
if (existingGroupCall) {
if (existingGroupCall.ringerUuid) {
log.info('Group call was already ringing');
2021-08-20 16:06:15 +00:00
return state;
}
if (existingGroupCall.joinState !== GroupCallJoinState.NotJoined) {
log.info("Got a ring for a call we're already in");
2021-08-20 16:06:15 +00:00
return state;
}
groupCall = {
...existingGroupCall,
ringId,
ringerUuid,
};
} else {
groupCall = {
callMode: CallMode.Group,
conversationId,
connectionState: GroupCallConnectionState.NotConnected,
joinState: GroupCallJoinState.NotJoined,
peekInfo: {
uuids: [],
maxDevices: Infinity,
deviceCount: 0,
},
remoteParticipants: [],
ringId,
ringerUuid,
};
}
return {
...state,
callsByConversation: {
...callsByConversation,
[conversationId]: groupCall,
},
};
}
2020-06-04 18:16:19 +00:00
if (action.type === OUTGOING_CALL) {
return {
...state,
callsByConversation: {
...callsByConversation,
[action.payload.conversationId]: {
2020-11-13 19:57:55 +00:00
callMode: CallMode.Direct,
conversationId: action.payload.conversationId,
callState: CallState.Prering,
isIncoming: false,
isVideoCall: action.payload.hasLocalVideo,
},
},
activeCallState: {
conversationId: action.payload.conversationId,
hasLocalAudio: action.payload.hasLocalAudio,
hasLocalVideo: action.payload.hasLocalVideo,
2021-01-08 22:57:54 +00:00
isInSpeakerView: false,
pip: false,
safetyNumberChangedUuids: [],
settingsDialogOpen: false,
showParticipantsList: false,
outgoingRing: true,
},
2020-06-04 18:16:19 +00:00
};
}
if (action.type === CALL_STATE_CHANGE_FULFILLED) {
2020-10-01 19:09:15 +00:00
// We want to keep the state around for ended calls if they resulted in a message
// request so we can show the "needs permission" screen.
if (
action.payload.callState === CallState.Ended &&
action.payload.callEndedReason !==
CallEndedReason.RemoteHangupNeedPermission
) {
return removeConversationFromState(state, action.payload.conversationId);
2020-06-04 18:16:19 +00:00
}
const call = getOwn(
state.callsByConversation,
action.payload.conversationId
);
2020-11-13 19:57:55 +00:00
if (call?.callMode !== CallMode.Direct) {
log.warn('Cannot update state for a non-direct call');
return state;
}
let activeCallState: undefined | ActiveCallStateType;
if (
state.activeCallState?.conversationId === action.payload.conversationId
) {
activeCallState = {
...state.activeCallState,
joinedAt: action.payload.acceptedTime,
};
} else {
({ activeCallState } = state);
}
2020-06-04 18:16:19 +00:00
return {
...state,
callsByConversation: {
...callsByConversation,
[action.payload.conversationId]: {
...call,
callState: action.payload.callState,
callEndedReason: action.payload.callEndedReason,
},
},
activeCallState,
2020-06-04 18:16:19 +00:00
};
}
2020-11-13 19:57:55 +00:00
if (action.type === GROUP_CALL_STATE_CHANGE) {
const {
connectionState,
2020-11-20 17:19:28 +00:00
conversationId,
2020-11-13 19:57:55 +00:00
hasLocalAudio,
hasLocalVideo,
2020-11-20 17:19:28 +00:00
joinState,
2020-12-02 18:14:03 +00:00
ourUuid,
2020-11-20 17:19:28 +00:00
peekInfo,
2020-11-13 19:57:55 +00:00
remoteParticipants,
} = action.payload;
2021-08-20 16:06:15 +00:00
const existingCall = getGroupCall(conversationId, state);
const existingRingState = getGroupCallRingState(existingCall);
2020-12-02 18:14:03 +00:00
const newPeekInfo = peekInfo ||
2021-08-20 16:06:15 +00:00
existingCall?.peekInfo || {
2020-12-02 18:14:03 +00:00
uuids: remoteParticipants.map(({ uuid }) => uuid),
maxDevices: Infinity,
deviceCount: remoteParticipants.length,
};
2020-11-20 17:19:28 +00:00
let newActiveCallState: ActiveCallStateType | undefined;
2020-11-13 19:57:55 +00:00
if (connectionState === GroupCallConnectionState.NotConnected) {
2020-11-20 17:19:28 +00:00
newActiveCallState =
state.activeCallState?.conversationId === conversationId
? undefined
: state.activeCallState;
2021-08-20 16:06:15 +00:00
if (
!isAnybodyElseInGroupCall(newPeekInfo, ourUuid) &&
(!existingCall || !existingCall.ringerUuid)
) {
2020-11-20 17:19:28 +00:00
return {
...state,
callsByConversation: omit(callsByConversation, conversationId),
activeCallState: newActiveCallState,
};
}
} else {
newActiveCallState =
state.activeCallState?.conversationId === conversationId
? {
...state.activeCallState,
hasLocalAudio,
hasLocalVideo,
}
: state.activeCallState;
2020-11-13 19:57:55 +00:00
}
if (
newActiveCallState &&
newActiveCallState.outgoingRing &&
newActiveCallState.conversationId === conversationId &&
isAnybodyElseInGroupCall(newPeekInfo, ourUuid)
) {
newActiveCallState = {
...newActiveCallState,
outgoingRing: false,
};
}
2021-08-20 16:06:15 +00:00
let newRingState: GroupCallRingStateType;
if (joinState === GroupCallJoinState.NotJoined) {
newRingState = existingRingState;
} else {
newRingState = {};
}
2020-11-13 19:57:55 +00:00
return {
...state,
callsByConversation: {
...callsByConversation,
[conversationId]: {
callMode: CallMode.Group,
conversationId,
connectionState,
joinState,
2020-12-02 18:14:03 +00:00
peekInfo: newPeekInfo,
2020-11-13 19:57:55 +00:00
remoteParticipants,
2021-08-20 16:06:15 +00:00
...newRingState,
2020-11-13 19:57:55 +00:00
},
},
2020-11-20 17:19:28 +00:00
activeCallState: newActiveCallState,
};
}
if (action.type === PEEK_NOT_CONNECTED_GROUP_CALL_FULFILLED) {
const { conversationId, peekInfo, ourConversationId } = action.payload;
2021-08-20 16:06:15 +00:00
const existingCall: GroupCallStateType = getGroupCall(
conversationId,
state
) || {
2020-11-20 17:19:28 +00:00
callMode: CallMode.Group,
conversationId,
connectionState: GroupCallConnectionState.NotConnected,
joinState: GroupCallJoinState.NotJoined,
peekInfo: {
2021-08-20 16:06:15 +00:00
uuids: [],
2020-11-20 17:19:28 +00:00
maxDevices: Infinity,
deviceCount: 0,
},
remoteParticipants: [],
};
// This action should only update non-connected group calls. It's not necessarily a
// mistake if this action is dispatched "over" a connected call. Here's a valid
// sequence of events:
//
// 1. We ask RingRTC to peek, kicking off an asynchronous operation.
// 2. The associated group call is joined.
// 3. The peek promise from step 1 resolves.
if (
existingCall.connectionState !== GroupCallConnectionState.NotConnected
) {
return state;
}
2021-08-20 16:06:15 +00:00
if (
!isAnybodyElseInGroupCall(peekInfo, ourConversationId) &&
2021-08-20 16:06:15 +00:00
!existingCall.ringerUuid
) {
2020-11-20 17:19:28 +00:00
return removeConversationFromState(state, conversationId);
}
return {
...state,
callsByConversation: {
...callsByConversation,
[conversationId]: {
...existingCall,
peekInfo,
},
},
2020-11-13 19:57:55 +00:00
};
}
if (action.type === REMOTE_SHARING_SCREEN_CHANGE) {
const { conversationId, isSharingScreen } = action.payload;
const call = getOwn(state.callsByConversation, conversationId);
if (call?.callMode !== CallMode.Direct) {
log.warn('Cannot update remote video for a non-direct call');
return state;
}
return {
...state,
callsByConversation: {
...callsByConversation,
[conversationId]: {
...call,
isSharingScreen,
},
},
};
}
2020-06-04 18:16:19 +00:00
if (action.type === REMOTE_VIDEO_CHANGE) {
const { conversationId, hasVideo } = action.payload;
const call = getOwn(state.callsByConversation, conversationId);
2020-11-13 19:57:55 +00:00
if (call?.callMode !== CallMode.Direct) {
log.warn('Cannot update remote video for a non-direct call');
return state;
}
2020-06-04 18:16:19 +00:00
return {
...state,
callsByConversation: {
...callsByConversation,
[conversationId]: {
...call,
hasRemoteVideo: hasVideo,
},
},
2020-06-04 18:16:19 +00:00
};
}
if (action.type === RETURN_TO_ACTIVE_CALL) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot return to active call if there is no active call');
return state;
}
return {
...state,
activeCallState: {
...activeCallState,
pip: false,
},
};
}
if (action.type === SET_LOCAL_AUDIO_FULFILLED) {
if (!state.activeCallState) {
log.warn('Cannot set local audio with no active call');
return state;
}
2020-06-04 18:16:19 +00:00
return {
...state,
activeCallState: {
...state.activeCallState,
hasLocalAudio: action.payload.enabled,
},
2020-06-04 18:16:19 +00:00
};
}
if (action.type === SET_LOCAL_VIDEO_FULFILLED) {
if (!state.activeCallState) {
log.warn('Cannot set local video with no active call');
return state;
}
2020-06-04 18:16:19 +00:00
return {
...state,
activeCallState: {
...state.activeCallState,
hasLocalVideo: action.payload.enabled,
},
2020-06-04 18:16:19 +00:00
};
}
2020-08-27 00:03:42 +00:00
if (action.type === CHANGE_IO_DEVICE_FULFILLED) {
const { selectedDevice } = action.payload;
const nextState = Object.create(null);
if (action.payload.type === CallingDeviceType.CAMERA) {
nextState.selectedCamera = selectedDevice;
} else if (action.payload.type === CallingDeviceType.MICROPHONE) {
nextState.selectedMicrophone = selectedDevice;
} else if (action.payload.type === CallingDeviceType.SPEAKER) {
nextState.selectedSpeaker = selectedDevice;
}
return {
...state,
...nextState,
};
}
if (action.type === REFRESH_IO_DEVICES) {
const {
availableMicrophones,
selectedMicrophone,
availableSpeakers,
selectedSpeaker,
availableCameras,
selectedCamera,
} = action.payload;
return {
...state,
availableMicrophones,
selectedMicrophone,
availableSpeakers,
selectedSpeaker,
availableCameras,
selectedCamera,
};
}
if (action.type === TOGGLE_SETTINGS) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot toggle settings when there is no active call');
return state;
}
2020-08-27 00:03:42 +00:00
return {
...state,
activeCallState: {
...activeCallState,
settingsDialogOpen: !activeCallState.settingsDialogOpen,
},
2020-08-27 00:03:42 +00:00
};
}
2020-10-08 01:25:33 +00:00
if (action.type === TOGGLE_PARTICIPANTS) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot toggle participants list when there is no active call');
return state;
}
2020-10-08 01:25:33 +00:00
return {
...state,
activeCallState: {
...activeCallState,
2020-11-17 15:07:53 +00:00
showParticipantsList: !activeCallState.showParticipantsList,
},
2020-10-08 01:25:33 +00:00
};
}
2020-10-01 00:43:05 +00:00
if (action.type === TOGGLE_PIP) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot toggle PiP when there is no active call');
return state;
}
2020-10-01 00:43:05 +00:00
return {
...state,
activeCallState: {
...activeCallState,
pip: !activeCallState.pip,
},
2020-10-01 00:43:05 +00:00
};
}
if (action.type === SET_PRESENTING) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot toggle presenting when there is no active call');
return state;
}
return {
...state,
activeCallState: {
...activeCallState,
presentingSource: action.payload,
presentingSourcesAvailable: undefined,
},
};
}
if (action.type === SET_PRESENTING_SOURCES) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot set presenting sources when there is no active call');
return state;
}
return {
...state,
activeCallState: {
...activeCallState,
presentingSourcesAvailable: action.payload,
},
};
}
if (action.type === SET_OUTGOING_RING) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot set outgoing ring when there is no active call');
return state;
}
return {
...state,
activeCallState: {
...activeCallState,
outgoingRing: action.payload,
},
};
}
if (action.type === TOGGLE_NEEDS_SCREEN_RECORDING_PERMISSIONS) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot set presenting sources when there is no active call');
return state;
}
return {
...state,
activeCallState: {
...activeCallState,
showNeedsScreenRecordingPermissionsWarning: !activeCallState.showNeedsScreenRecordingPermissionsWarning,
},
};
}
2021-01-08 22:57:54 +00:00
if (action.type === TOGGLE_SPEAKER_VIEW) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot toggle speaker view when there is no active call');
2021-01-08 22:57:54 +00:00
return state;
}
return {
...state,
activeCallState: {
...activeCallState,
isInSpeakerView: !activeCallState.isInSpeakerView,
},
};
}
if (action.type === MARK_CALL_UNTRUSTED) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot mark call as untrusted when there is no active call');
return state;
}
const { safetyNumberChangedUuids } = action.payload;
return {
...state,
activeCallState: {
...activeCallState,
pip: false,
safetyNumberChangedUuids,
settingsDialogOpen: false,
showParticipantsList: false,
},
};
}
if (action.type === MARK_CALL_TRUSTED) {
const { activeCallState } = state;
if (!activeCallState) {
log.warn('Cannot mark call as trusted when there is no active call');
return state;
}
return {
...state,
activeCallState: {
...activeCallState,
safetyNumberChangedUuids: [],
},
};
}
2020-06-04 18:16:19 +00:00
return state;
}