mattermost-mobile-upstream/app/products/calls/utils.ts

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

import {makeCallsBaseAndBadgeRGB, rgbToCSS} from '@mattermost/calls';
import {type CallsConfig, isCaption, type Caption, isCallJobMetadata, type CallJobMetadata} from '@mattermost/calls/lib/types';
import {Alert} from 'react-native';
import {SelectedTrackType, TextTrackType, type ISO639_1, type SelectedTrack, type TextTracks} from 'react-native-video';

import {buildFileUrl} from '@actions/remote/file';
import {
    type Call,
    CallCardState,
    CallPostStatus,
    type CallsConfigState,
    type CallSession,
    type CallsPostProps,
    type CallsTheme,
} from '@calls/types/calls';
import {Calls, Post, General} from '@constants';
import {NOTIFICATION_SUB_TYPE} from '@constants/push_notification';
import {isMinimumServerVersion} from '@utils/helpers';
import {ensureNumber, ensureString, isArrayOf, isRecordOf, isStringArray} from '@utils/types';
import {displayUsername, getUserIdFromChannelName} from '@utils/user';

import type ChannelModel from '@typings/database/models/servers/channel';
import type PostModel from '@typings/database/models/servers/post';
import type UserModel from '@typings/database/models/servers/user';
import type {IntlShape} from 'react-intl';
import type {RTCIceServer} from 'react-native-webrtc';

export function sortSessions(locale: string, teammateNameDisplay: string, sessions?: Dictionary<CallSession>, presenterID?: string): CallSession[] {
    if (!sessions) {
        return [];
    }

    const sessns = Object.values(sessions);

    return sessns.sort(sortByName(locale, teammateNameDisplay)).sort(sortByState(presenterID));
}

export function sortDMSessions(
    locale: string,
    teammateNameDisplay: string,
    myUserId: string,
    sessions?: Dictionary<CallSession>,
    presenterID?: string,
): CallSession[] {
    return sortSessions(locale, teammateNameDisplay, sessions, presenterID).sort(sortByCurrentUser(myUserId));
}

const sortByCurrentUser = (myUserId: string) => {
    return (a: CallSession, b: CallSession) => {
        if (a.userId === myUserId && b.userId !== myUserId) {
            return -1;
        }

        if (b.userId === myUserId && a.userId !== myUserId) {
            return 1;
        }

        return 0;
    };
};

const sortByName = (locale: string, teammateNameDisplay: string) => {
    return (a: CallSession, b: CallSession) => {
        const nameA = displayUsername(a.userModel, locale, teammateNameDisplay);
        const nameB = displayUsername(b.userModel, locale, teammateNameDisplay);
        return nameA.localeCompare(nameB);
    };
};

const sortByState = (presenterID?: string) => {
    return (a: CallSession, b: CallSession) => {
        if (a.sessionId === presenterID) {
            return -1;
        } else if (b.sessionId === presenterID) {
            return 1;
        }

        if (a.raisedHand && !b.raisedHand) {
            return -1;
        } else if (b.raisedHand && !a.raisedHand) {
            return 1;
        } else if (a.raisedHand && b.raisedHand) {
            return a.raisedHand - b.raisedHand;
        }

        if (!a.muted && b.muted) {
            return -1;
        } else if (!b.muted && a.muted) {
            return 1;
        }

        return 0;
    };
};

export function getHandsRaised(sessions: Dictionary<CallSession>) {
    return Object.values(sessions).filter((s) => s.raisedHand);
}

export function getHandsRaisedNames(sessions: CallSession[], sessionId: string, locale: string, teammateNameDisplay: string, intl: IntlShape) {
    return sessions.sort((a, b) => a.raisedHand - b.raisedHand).map((p) => {
        if (p.sessionId === sessionId) {
            return intl.formatMessage({id: 'mobile.calls_you_2', defaultMessage: 'You'});
        }
        return displayUsername(p.userModel, locale, teammateNameDisplay);
    });
}

export function isSupportedServerCalls(serverVersion?: string) {
    if (serverVersion) {
        return isMinimumServerVersion(
            serverVersion,
            Calls.RequiredServer.MAJOR_VERSION,
            Calls.RequiredServer.MIN_VERSION,
            Calls.RequiredServer.PATCH_VERSION,
        );
    }

    return false;
}

export function isHostControlsAllowed(config: CallsConfigState) {
    return Boolean(config.HostControlsAllowed);
}

export function areGroupCallsAllowed(config: CallsConfigState) {
    return Boolean(config.GroupCallsAllowed);
}

export function isCallsCustomMessage(post: PostModel | Post): boolean {
    return Boolean(post.type && post.type === Post.POST_TYPES.CUSTOM_CALLS);
}

export function idsAreEqual(a: string[], b: string[]) {
    if (a.length !== b.length) {
        return false;
    }

    // We can assume ids are unique
    // Doing a quick search indicated objects are tuned better than Map or Set
    const obj = a.reduce((prev, cur) => {
        prev[cur] = true;
        return prev;
    }, {} as Record<string, boolean>);

    for (let i = 0; i < b.length; i++) {
        if (!obj.hasOwnProperty(b[i])) {
            return false;
        }
    }
    return true;
}

export function errorAlert(error: string, intl: IntlShape) {
    Alert.alert(
        intl.formatMessage({
            id: 'mobile.calls_error_title',
            defaultMessage: 'Error',
        }),
        intl.formatMessage({
            id: 'mobile.calls_error_message',
            defaultMessage: 'Error: {error}',
        }, {error}),
    );
}

export function getICEServersConfigs(config: CallsConfig): RTCIceServer[] {
    // if ICEServersConfigs is set, we can trust this to be complete and
    // coming from an updated API.
    if (config.ICEServersConfigs && config.ICEServersConfigs.length > 0) {
        return config.ICEServersConfigs;
    }

    // otherwise we revert to using the now deprecated field.
    if (config.ICEServers && config.ICEServers.length > 0) {
        return [
            {
                urls: config.ICEServers,
            },
        ];
    }

    return [];
}

export function makeCallsTheme(theme: Theme): CallsTheme {
    const {baseColorRGB, badgeBgRGB} = makeCallsBaseAndBadgeRGB(theme.sidebarBg);

    const newTheme = {...theme} as CallsTheme;
    newTheme.callsBg = rgbToCSS(baseColorRGB);
    newTheme.callsBgRgb = `${baseColorRGB.r},${baseColorRGB.g},${baseColorRGB.b}`;
    newTheme.callsBadgeBg = rgbToCSS(badgeBgRGB);

    return newTheme;
}

interface HasUserId {
    userId: string;
}

export function userIds<T extends HasUserId>(hasUserId: T[]): string[] {
    const ids: string[] = [];
    const seen: Record<string, boolean> = {};
    for (const p of hasUserId) {
        if (!seen[p.userId]) {
            ids.push(p.userId);
            seen[p.userId] = true;
        }
    }
    return ids;
}

/**
 * Returns true if anyone other than myUserId is in the call.
 * Compares distinct users rather than sessions.
 */
export function hasOtherUserJoined(sessions: Dictionary<CallSession>, myUserId: string): boolean {
    return Object.values(sessions).some((session) => session.userId !== myUserId);
}

/**
 * Returns the id of the other party in a 1:1 DM call, or '' when there is no other
 * party to wait for: the channel isn't a DM, or it's a DM with yourself.
 */
export function getDMCalleeId(myUserId: string, channel?: ChannelModel): string {
    if (channel?.type !== General.DM_CHANNEL) {
        return '';
    }

    const calleeId = getUserIdFromChannelName(myUserId, channel.name);
    return calleeId === myUserId ? '' : calleeId;
}

export function fillUserModels(sessions: Dictionary<CallSession>, models: UserModel[]) {
    const idToModel = models.reduce((accum, cur) => {
        accum[cur.id] = cur;
        return accum;
    }, {} as Dictionary<UserModel>);
    const next = {...sessions};
    for (const participant of Object.values(next)) {
        participant.userModel = idToModel[participant.userId];
    }
    return sessions;
}

export function isCallsStartedMessage(payload?: NotificationData) {
    return payload?.sub_type === NOTIFICATION_SUB_TYPE.CALLS;
}

export const hasCaptions = (postProps?: Record<string, unknown>): boolean => {
    return Boolean(isArrayOf<Caption>(postProps?.captions, isCaption) && postProps.captions[0]);
};

export const getTranscriptionUri = (serverUrl: string, postProps?: Record<string, unknown>): {
    tracks?: TextTracks;
    selected: SelectedTrack;
} => {
    // Note: We're not using hasCaptions above because this tells typescript that the caption exists later.
    // We could use some fancy typescript to do the same, but it's not worth the complexity.
    if (!isArrayOf<Caption>(postProps?.captions, isCaption) || !postProps.captions[0]) {
        return {
            tracks: undefined,
            selected: {type: SelectedTrackType.DISABLED, value: ''},
        };
    }

    const tracks: TextTracks = postProps.captions.map((t) => ({
        title: t.title,
        language: t.language as ISO639_1,
        type: TextTrackType.VTT,
        uri: buildFileUrl(serverUrl, t.file_id),
    }));

    return {
        tracks,
        selected: {type: SelectedTrackType.INDEX, value: 0},
    };
};

const CALL_POST_STATUSES: string[] = Object.values(CallPostStatus);

// Older posts, and calls in non-DM channels that have not ended yet, have no call_status prop.
function ensureCallPostStatus(value: unknown): CallPostStatus | '' {
    const status = ensureString(value);
    return CALL_POST_STATUSES.includes(status) ? status as CallPostStatus : '';
}

export function getCallPropsFromPost(post: PostModel | Post): CallsPostProps {
    return {
        title: ensureString(post.props?.title),
        start_at: ensureNumber(post.props?.start_at),
        end_at: ensureNumber(post.props?.end_at),
        call_status: ensureCallPostStatus(post.props?.call_status),
        recordings: isRecordOf<CallJobMetadata>(post.props?.recordings, isCallJobMetadata) ? post.props.recordings : {},
        transcriptions: isRecordOf<CallJobMetadata>(post.props?.transcriptions, isCallJobMetadata) ? post.props.transcriptions : {},
        participants: isStringArray(post.props?.participants) ? post.props.participants : [],
    };
}

/**
 * Derives which state the call post card should render. Mirrors getCallCardState in the webapp
 * (webapp/src/components/custom_post_types/post_type_event.tsx).
 * The server keeps call_status at 'calling' after the callee answers, so the number of people in
 * the call is what tells a ringing call apart from a connected one.
 */
export function getCallCardState(callProps: CallsPostProps, numUsers: number, callExists: boolean): CallCardState {
    if (callProps.end_at > 0) {
        switch (callProps.call_status) {
            case CallPostStatus.NoAnswer:
                return CallCardState.NoAnswer;
            case CallPostStatus.CanceledByCaller:
                return CallCardState.Canceled;
            case CallPostStatus.Declined:
                return CallCardState.Declined;
            default:
                return CallCardState.Ended;
        }
    }

    // The call_end event lands before the post is updated with end_at, so without this the card
    // would fall back to "Calling..." (with a Cancel button) for the rest of that window.
    if (!callExists) {
        return CallCardState.Ended;
    }

    if (callProps.call_status === CallPostStatus.Calling && numUsers <= 1) {
        return CallCardState.Calling;
    }

    return CallCardState.Active;
}

/**
 * Counts the distinct users in a call rather than their sessions, since one user can be connected
 * from more than one client. Mirrors numUsersInCallInChannel in the webapp (webapp/src/selectors.ts).
 */
export function getNumUsersInCall(call?: Call): number {
    return new Set(Object.values(call?.sessions ?? {}).map((session) => session.userId)).size;
}