jiti-meet/react/features/prejoin/actions.ts

564 lines
16 KiB
TypeScript
Raw Normal View History

/* eslint-disable lines-around-comment */
import { v4 as uuidv4 } from 'uuid';
import { IStore } from '../app/types';
import { updateConfig } from '../base/config/actions';
// @ts-ignore
import { getDialOutStatusUrl, getDialOutUrl } from '../base/config/functions';
import { browser } from '../base/lib-jitsi-meet';
// @ts-ignore
import { createLocalTrack } from '../base/lib-jitsi-meet/functions';
import { MEDIA_TYPE } from '../base/media/constants';
import { isVideoMutedByUser } from '../base/media/functions';
import { updateSettings } from '../base/settings/actions';
import {
createLocalTracksF,
getLocalAudioTrack,
getLocalTracks,
getLocalVideoTrack,
replaceLocalTrack,
trackAdded
// @ts-ignore
} from '../base/tracks';
// @ts-ignore
2020-05-20 10:57:03 +00:00
import { openURLInBrowser } from '../base/util';
// @ts-ignore
2020-05-20 10:57:03 +00:00
import { executeDialOutRequest, executeDialOutStatusRequest, getDialInfoPageURL } from '../invite/functions';
import { showErrorNotification } from '../notifications/actions';
import { NOTIFICATION_TIMEOUT_TYPE } from '../notifications/constants';
import { INotificationProps } from '../notifications/types';
2020-05-20 10:57:03 +00:00
2020-04-16 10:47:10 +00:00
import {
PREJOIN_INITIALIZED,
PREJOIN_JOINING_IN_PROGRESS,
SET_DEVICE_STATUS,
SET_DIALOUT_COUNTRY,
SET_DIALOUT_NUMBER,
SET_DIALOUT_STATUS,
2020-04-16 10:47:10 +00:00
SET_JOIN_BY_PHONE_DIALOG_VISIBLITY,
SET_PRECALL_TEST_RESULTS,
2020-04-16 10:47:10 +00:00
SET_PREJOIN_DEVICE_ERRORS,
SET_PREJOIN_DISPLAY_NAME_REQUIRED,
SET_PREJOIN_PAGE_VISIBILITY,
SET_SKIP_PREJOIN_RELOAD
2020-04-16 10:47:10 +00:00
} from './actionTypes';
import {
getDialOutConferenceUrl,
getDialOutCountry,
getFullDialOutNumber,
isJoinByPhoneDialogVisible
} from './functions';
2020-05-20 10:57:03 +00:00
import logger from './logger';
const dialOutStatusToKeyMap = {
INITIATED: 'presenceStatus.calling',
RINGING: 'presenceStatus.ringing'
};
const DIAL_OUT_STATUS = {
INITIATED: 'INITIATED',
RINGING: 'RINGING',
CONNECTED: 'CONNECTED',
DISCONNECTED: 'DISCONNECTED',
FAILED: 'FAILED'
};
/**
* The time interval used between requests while polling for dial out status.
*/
const STATUS_REQ_FREQUENCY = 2000;
/**
* The maximum number of retries while polling for dial out status.
*/
const STATUS_REQ_CAP = 45;
2020-04-16 10:47:10 +00:00
/**
* Polls for status change after dial out.
* Changes dialog message based on response, closes the dialog if there is an error,
* joins the meeting when CONNECTED.
*
* @param {string} reqId - The request id used to correlate the dial out request with this one.
* @param {Function} onSuccess - Success handler.
* @param {Function} onFail - Fail handler.
* @param {number} count - The number of retried calls. When it hits STATUS_REQ_CAP it should no longer make requests.
* @returns {Function}
*/
function pollForStatus(
reqId: string,
onSuccess: Function,
onFail: Function,
count = 0) {
return async function(dispatch: IStore['dispatch'], getState: IStore['getState']) {
const state = getState();
try {
if (!isJoinByPhoneDialogVisible(state)) {
return;
}
const res = await executeDialOutStatusRequest(getDialOutStatusUrl(state), reqId);
switch (res) {
case DIAL_OUT_STATUS.INITIATED:
case DIAL_OUT_STATUS.RINGING: {
dispatch(setDialOutStatus(dialOutStatusToKeyMap[res as keyof typeof dialOutStatusToKeyMap]));
if (count < STATUS_REQ_CAP) {
return setTimeout(() => {
dispatch(pollForStatus(reqId, onSuccess, onFail, count + 1));
}, STATUS_REQ_FREQUENCY);
}
return onFail();
}
case DIAL_OUT_STATUS.CONNECTED: {
return onSuccess();
}
case DIAL_OUT_STATUS.DISCONNECTED: {
dispatch(showErrorNotification({
titleKey: 'prejoin.errorDialOutDisconnected'
}, NOTIFICATION_TIMEOUT_TYPE.LONG));
return onFail();
}
case DIAL_OUT_STATUS.FAILED: {
dispatch(showErrorNotification({
titleKey: 'prejoin.errorDialOutFailed'
}, NOTIFICATION_TIMEOUT_TYPE.LONG));
return onFail();
}
}
} catch (err) {
dispatch(showErrorNotification({
titleKey: 'prejoin.errorDialOutStatus'
}, NOTIFICATION_TIMEOUT_TYPE.LONG));
logger.error('Error getting dial out status', err);
onFail();
}
};
}
/**
* Action used for joining the meeting with phone audio.
* A dial out connection is tried and a polling mechanism is used for getting the status.
* If the connection succeeds the `onSuccess` callback is executed.
* If the phone connection fails or the number is invalid the `onFail` callback is executed.
*
* @param {Function} onSuccess - Success handler.
* @param {Function} onFail - Fail handler.
* @returns {Function}
*/
export function dialOut(onSuccess: Function, onFail: Function) {
return async function(dispatch: IStore['dispatch'], getState: IStore['getState']) {
const state = getState();
const reqId = uuidv4();
const url = getDialOutUrl(state);
const conferenceUrl = getDialOutConferenceUrl(state);
const phoneNumber = getFullDialOutNumber(state);
const countryCode = getDialOutCountry(state).code.toUpperCase();
const body = {
conferenceUrl,
countryCode,
name: phoneNumber,
phoneNumber
};
try {
await executeDialOutRequest(url, body, reqId);
dispatch(pollForStatus(reqId, onSuccess, onFail));
} catch (err: any) {
const notification: INotificationProps = {
titleKey: 'prejoin.errorDialOut',
titleArguments: undefined
};
if (err.status) {
if (err.messageKey === 'validation.failed') {
notification.titleKey = 'prejoin.errorValidation';
} else {
notification.titleKey = 'prejoin.errorStatusCode';
notification.titleArguments = { status: err.status };
}
}
dispatch(showErrorNotification(notification, NOTIFICATION_TIMEOUT_TYPE.LONG));
logger.error('Error dialing out', err);
onFail();
}
};
}
2020-04-16 10:47:10 +00:00
/**
* Adds all the newly created tracks to store on init.
*
* @param {Object[]} tracks - The newly created tracks.
* @param {Object} errors - The errors from creating the tracks.
*
* @returns {Function}
*/
export function initPrejoin(tracks: Object[], errors: Object) {
return async function(dispatch: IStore['dispatch']) {
2020-04-16 10:47:10 +00:00
dispatch(setPrejoinDeviceErrors(errors));
dispatch(prejoinInitialized());
2020-04-16 10:47:10 +00:00
tracks.forEach(track => dispatch(trackAdded(track)));
2020-04-16 10:47:10 +00:00
};
}
/**
* Action used to start the conference.
2020-04-16 10:47:10 +00:00
*
2020-08-14 07:45:15 +00:00
* @param {Object} options - The config options that override the default ones (if any).
* @param {boolean} ignoreJoiningInProgress - If true we won't check the joiningInProgress flag.
2020-04-16 10:47:10 +00:00
* @returns {Function}
*/
export function joinConference(options?: Object, ignoreJoiningInProgress = false) {
return async function(dispatch: IStore['dispatch'], getState: IStore['getState']) {
if (!ignoreJoiningInProgress) {
const state = getState();
const { joiningInProgress } = state['features/prejoin'];
if (joiningInProgress) {
return;
}
dispatch(setJoiningInProgress(true));
}
const state = getState();
let localTracks = getLocalTracks(state['features/base/tracks']);
options && dispatch(updateConfig(options));
// Do not signal audio/video tracks if the user joins muted.
for (const track of localTracks) {
// Always add the audio track on Safari because of a known issue where audio playout doesn't happen
// if the user joins audio and video muted.
if (track.muted
&& !(browser.isWebKitBased() && track.jitsiTrack && track.jitsiTrack.getType() === MEDIA_TYPE.AUDIO)) {
try {
await dispatch(replaceLocalTrack(track.jitsiTrack, null));
} catch (error) {
logger.error(`Failed to replace local track (${track.jitsiTrack}) with null: ${error}`);
}
}
}
// Re-fetch the local tracks after muted tracks have been removed above.
// This is needed, because the tracks are effectively disposed by the replaceLocalTrack and should not be used
// anymore.
localTracks = getLocalTracks(getState()['features/base/tracks']);
const jitsiTracks = localTracks.map((t: any) => t.jitsiTrack);
APP.conference.prejoinStart(jitsiTracks);
};
}
/**
* Action used to set the flag for joining operation in progress.
*
* @param {boolean} value - The config options that override the default ones (if any).
* @returns {Function}
*/
export function setJoiningInProgress(value: boolean) {
return {
type: PREJOIN_JOINING_IN_PROGRESS,
value
2020-04-16 10:47:10 +00:00
};
}
2020-04-16 10:47:10 +00:00
/**
* Joins the conference without audio.
*
* @returns {Function}
*/
export function joinConferenceWithoutAudio() {
return async function(dispatch: IStore['dispatch'], getState: IStore['getState']) {
const state = getState();
const { joiningInProgress } = state['features/prejoin'];
if (joiningInProgress) {
return;
}
dispatch(setJoiningInProgress(true));
const tracks = state['features/base/tracks'];
const audioTrack = getLocalAudioTrack(tracks)?.jitsiTrack;
2020-04-16 10:47:10 +00:00
if (audioTrack) {
try {
await dispatch(replaceLocalTrack(audioTrack, null));
} catch (error) {
logger.error(`Failed to replace local audio with null: ${error}`);
}
2020-04-16 10:47:10 +00:00
}
2020-08-14 07:45:15 +00:00
dispatch(joinConference({
startSilent: true
}, true));
2020-04-16 10:47:10 +00:00
};
}
/**
* Initializes the 'precallTest' and executes one test, storing the results.
*
* @param {Object} conferenceOptions - The conference options.
* @returns {Function}
*/
export function makePrecallTest(conferenceOptions: Object) {
return async function(dispatch: Function) {
try {
await JitsiMeetJS.precallTest.init(conferenceOptions);
const results = await JitsiMeetJS.precallTest.execute();
dispatch(setPrecallTestResults(results));
} catch (error) {
logger.debug('Failed to execute pre call test - ', error);
}
};
}
/**
* Opens an external page with all the dial in numbers.
*
* @returns {Function}
*/
export function openDialInPage() {
return function(dispatch: IStore['dispatch'], getState: IStore['getState']) {
const dialInPage = getDialInfoPageURL(getState());
openURLInBrowser(dialInPage, true);
};
}
/**
* Action used to signal that the prejoin page has been initialized.
*
* @returns {Object}
*/
function prejoinInitialized() {
return {
type: PREJOIN_INITIALIZED
};
}
2020-04-16 10:47:10 +00:00
/**
* Creates a new audio track based on a device id and replaces the current one.
*
* @param {string} deviceId - The deviceId of the microphone.
* @returns {Function}
*/
export function replaceAudioTrackById(deviceId: string) {
return async (dispatch: IStore['dispatch'], getState: IStore['getState']) => {
2020-04-16 10:47:10 +00:00
try {
const tracks = getState()['features/base/tracks'];
const newTrack = await createLocalTrack('audio', deviceId);
const oldTrack = getLocalAudioTrack(tracks)?.jitsiTrack;
const micDeviceId = newTrack.getDeviceId();
2020-04-16 10:47:10 +00:00
logger.info(`Switching audio input device to ${micDeviceId}`);
dispatch(replaceLocalTrack(oldTrack, newTrack)).then(() => {
dispatch(updateSettings({
micDeviceId
}));
});
2020-04-16 10:47:10 +00:00
} catch (err) {
dispatch(setDeviceStatusWarning('prejoin.audioTrackError'));
logger.log('Error replacing audio track', err);
}
};
}
/**
* Creates a new video track based on a device id and replaces the current one.
*
* @param {string} deviceId - The deviceId of the camera.
* @returns {Function}
*/
export function replaceVideoTrackById(deviceId: Object) {
return async (dispatch: IStore['dispatch'], getState: IStore['getState']) => {
2020-04-16 10:47:10 +00:00
try {
const tracks = getState()['features/base/tracks'];
const wasVideoMuted = isVideoMutedByUser(getState());
const [ newTrack ] = await createLocalTracksF(
{ cameraDeviceId: deviceId,
devices: [ 'video' ] },
{ dispatch,
getState }
);
const oldTrack = getLocalVideoTrack(tracks)?.jitsiTrack;
const cameraDeviceId = newTrack.getDeviceId();
2020-04-16 10:47:10 +00:00
logger.info(`Switching camera to ${cameraDeviceId}`);
dispatch(replaceLocalTrack(oldTrack, newTrack)).then(() => {
dispatch(updateSettings({
cameraDeviceId
}));
});
wasVideoMuted && newTrack.mute();
2020-04-16 10:47:10 +00:00
} catch (err) {
dispatch(setDeviceStatusWarning('prejoin.videoTrackError'));
logger.log('Error replacing video track', err);
}
};
}
/**
* Sets the device status as OK with the corresponding text.
*
* @param {string} deviceStatusText - The text to be set.
* @returns {Object}
*/
export function setDeviceStatusOk(deviceStatusText: string) {
return {
type: SET_DEVICE_STATUS,
value: {
deviceStatusText,
deviceStatusType: 'ok'
}
};
}
/**
* Sets the device status as 'warning' with the corresponding text.
*
* @param {string} deviceStatusText - The text to be set.
* @returns {Object}
*/
export function setDeviceStatusWarning(deviceStatusText: string) {
return {
type: SET_DEVICE_STATUS,
value: {
deviceStatusText,
deviceStatusType: 'warning'
}
};
}
/**
* Action used to set the dial out status.
*
* @param {string} value - The status.
* @returns {Object}
*/
function setDialOutStatus(value: string) {
return {
type: SET_DIALOUT_STATUS,
value
};
}
/**
* Action used to set the dial out country.
*
* @param {{ name: string, dialCode: string, code: string }} value - The country.
* @returns {Object}
*/
export function setDialOutCountry(value: Object) {
return {
type: SET_DIALOUT_COUNTRY,
value
};
}
/**
* Action used to set the stance of the display name.
*
* @returns {Object}
*/
export function setPrejoinDisplayNameRequired() {
return {
type: SET_PREJOIN_DISPLAY_NAME_REQUIRED
};
}
/**
* Action used to set the dial out number.
*
* @param {string} value - The dial out number.
* @returns {Object}
*/
export function setDialOutNumber(value: string) {
return {
type: SET_DIALOUT_NUMBER,
value
};
}
/**
* Sets the visibility of the prejoin page when a client reload
* is triggered as a result of call migration initiated by Jicofo.
*
* @param {boolean} value - The visibility value.
* @returns {Object}
*/
export function setSkipPrejoinOnReload(value: boolean) {
return {
type: SET_SKIP_PREJOIN_RELOAD,
value
};
}
2020-04-16 10:47:10 +00:00
/**
* Action used to set the visiblitiy of the 'JoinByPhoneDialog'.
2020-04-16 10:47:10 +00:00
*
* @param {boolean} value - The value.
2020-04-16 10:47:10 +00:00
* @returns {Object}
*/
export function setJoinByPhoneDialogVisiblity(value: boolean) {
2020-04-16 10:47:10 +00:00
return {
type: SET_JOIN_BY_PHONE_DIALOG_VISIBLITY,
2020-04-16 10:47:10 +00:00
value
};
}
/**
* Action used to set data from precall test.
*
* @param {Object} value - The precall test results.
* @returns {Object}
*/
export function setPrecallTestResults(value: Object) {
return {
type: SET_PRECALL_TEST_RESULTS,
value
};
}
2020-04-16 10:47:10 +00:00
/**
* Action used to set the initial errors after creating the tracks.
2020-04-16 10:47:10 +00:00
*
* @param {Object} value - The track errors.
2020-04-16 10:47:10 +00:00
* @returns {Object}
*/
export function setPrejoinDeviceErrors(value: Object) {
2020-04-16 10:47:10 +00:00
return {
type: SET_PREJOIN_DEVICE_ERRORS,
2020-04-16 10:47:10 +00:00
value
};
}
/**
* Action used to set the visibility of the prejoin page.
2020-04-16 10:47:10 +00:00
*
* @param {boolean} value - The value.
2020-04-16 10:47:10 +00:00
* @returns {Object}
*/
export function setPrejoinPageVisibility(value: boolean) {
2020-04-16 10:47:10 +00:00
return {
type: SET_PREJOIN_PAGE_VISIBILITY,
value
};
}