login.js

import { call, cancel, delay, fork, put, race, select, spawn, take, takeLatest } from 'redux-saga/effects';
import { sanitizedRaw } from '@nozbe/watermelondb/RawRecord';
import { Q } from '@nozbe/watermelondb';

import dayjs from '../lib/dayjs';
import * as types from '../actions/actionsTypes';
import { appStart } from '../actions/app';
import { selectServerRequest, serverFinishAdd } from '../actions/server';
import { loginFailure, loginSuccess, logout as logoutAction, setUser } from '../actions/login';
import { roomsRequest } from '../actions/rooms';
import log, { events, logEvent } from '../lib/methods/helpers/log';
import I18n, { setLanguage } from '../i18n';
import database from '../lib/database';
import EventEmitter from '../lib/methods/helpers/events';
import { inviteLinksRequest } from '../actions/inviteLinks';
import { showErrorAlert } from '../lib/methods/helpers/info';
import { localAuthenticate } from '../lib/methods/helpers/localAuthentication';
import { encryptionInit, encryptionStop } from '../actions/encryption';
import { initTroubleshootingNotification } from '../actions/troubleshootingNotification';
import UserPreferences from '../lib/methods/userPreferences';
import { inquiryRequest, inquiryReset } from '../ee/omnichannel/actions/inquiry';
import { isOmnichannelStatusAvailable } from '../ee/omnichannel/lib';
import { RootEnum } from '../definitions';
import sdk from '../lib/services/sdk';
import { CURRENT_SERVER, TOKEN_KEY, getUserTokenKey } from '../lib/constants/keys';
import { getCustomEmojis } from '../lib/methods/getCustomEmojis';
import { getIsMasterDetail } from '../lib/hooks/useMasterDetail';
import { getEnterpriseModules, isOmnichannelModuleAvailable, isVoipModuleAvailable } from '../lib/methods/enterpriseModules';
import { getPermissions } from '../lib/methods/getPermissions';
import { getRoles } from '../lib/methods/getRoles';
import { getSlashCommands } from '../lib/methods/getSlashCommands';
import { getUserPresence, refreshDmUsersPresence, subscribeUsersPresence } from '../lib/methods/getUsersPresence';
import { logout, removeServerData, removeServerDatabase } from '../lib/methods/logout';
import { subscribeSettings } from '../lib/methods/getSettings';
import { disconnect, loginWithPassword, login } from '../lib/services/connect';
import { saveUserProfile, registerPushToken, getUsersRoles, setUserPresenceAway } from '../lib/services/restApi';
import { setUsersRoles } from '../actions/usersRoles';
import { getServerById } from '../lib/database/services/Server';
import appNavigation from '../lib/navigation/appNavigation';
import { showActionSheetRef } from '../containers/ActionSheet';
import { SupportedVersionsWarning } from '../containers/SupportedVersions';
import { mediaSessionInstance } from '../lib/services/voip/MediaSessionInstance';
import { hasPermission } from '../lib/methods/helpers/helpers';
import { mediaSessionStore } from '../lib/services/voip/MediaSessionStore';
import { store as reduxStore } from '../lib/store/auxStore';

const getServer = state => state.server.server;
const loginWithPasswordCall = args => loginWithPassword(args);
const loginCall = credentials => login(credentials);
const logoutCall = args => logout(args);

const showSupportedVersionsWarning = function* showSupportedVersionsWarning(server) {
	const { status: supportedVersionsStatus } = yield select(state => state.supportedVersions);
	if (supportedVersionsStatus !== 'warn') {
		return;
	}
	const serverRecord = yield getServerById(server);
	const isMasterDetail = getIsMasterDetail();
	if (!serverRecord || dayjs(new Date()).diff(serverRecord?.supportedVersionsWarningAt, 'hours') <= 12) {
		return;
	}

	const serversDB = database.servers;
	yield serversDB.write(async () => {
		await serverRecord.update(r => {
			r.supportedVersionsWarningAt = new Date();
		});
	});
	if (isMasterDetail) {
		appNavigation.navigate('ModalStackNavigator', { screen: 'SupportedVersionsWarning', params: { showCloseButton: true } });
	} else {
		showActionSheetRef({ children: <SupportedVersionsWarning /> });
	}
};

const handleLoginRequest = function* handleLoginRequest({ credentials, logoutOnError = false, registerCustomFields }) {
	logEvent(events.LOGIN_DEFAULT_LOGIN);
	try {
		let result;
		if (credentials.resume) {
			result = yield loginCall(credentials);
		} else {
			result = yield call(loginWithPasswordCall, credentials);
		}
		if (!result.username) {
			yield put(serverFinishAdd());
			yield put(setUser(result));
			yield put(appStart({ root: RootEnum.ROOT_SET_USERNAME }));
		} else {
			const server = yield select(getServer);
			yield localAuthenticate(server);

			// Saves username on server history
			const serversDB = database.servers;
			const serversHistoryCollection = serversDB.get('servers_history');
			const serversCollection = serversDB.get('servers');
			yield serversDB.write(async () => {
				try {
					const serversHistory = await serversHistoryCollection.query(Q.where('url', server)).fetch();
					if (serversHistory?.length) {
						const serverHistoryRecord = serversHistory[0];
						// Get server iconURL from servers table
						let iconURL = null;
						try {
							const serverRecord = await serversCollection.find(server);
							iconURL = serverRecord.iconURL;
						} catch (e) {
							// Server record might not exist yet
						}
						// this is updating on every login just to save `updated_at`
						// keeping this server as the most recent on autocomplete order
						await serverHistoryRecord.update(s => {
							s.username = result.username;
							if (iconURL) {
								s.iconURL = iconURL;
							}
						});
					}
				} catch (e) {
					log(e);
				}
			});
			yield put(loginSuccess(result));
			if (registerCustomFields) {
				const updatedUser = yield call(saveUserProfile, {}, { ...registerCustomFields });
				yield put(setUser({ ...result, ...updatedUser.user }));
			}
		}
	} catch (e) {
		if (e?.data?.message && /you've been logged out by the server/i.test(e.data.message)) {
			logEvent(events.LOGOUT_BY_SERVER);
			yield put(logoutAction(true, 'Logged_out_by_server'));
		} else if (e?.data?.message && /your session has expired/i.test(e.data.message)) {
			logEvent(events.LOGOUT_TOKEN_EXPIRED);
			yield put(logoutAction(true, 'Token_expired'));
		} else if (e?.status === 401) {
			logEvent(events.LOGIN_DEFAULT_LOGIN_F);
			const userId = yield select(state => state.login.user.id);
			if (!userId) {
				yield put(loginFailure(e));
				return;
			}
			yield put(logoutAction(true));
		} else {
			yield put(loginFailure(e));
		}
	}
};

const subscribeSettingsFork = function* subscribeSettingsFork() {
	try {
		yield subscribeSettings();
	} catch (e) {
		log(e);
	}
};

const fetchPermissions = function* fetchPermissions() {
	try {
		yield getPermissions();
	} catch (e) {
		log(e);
	}
};

const fetchCustomEmojisFork = function* fetchCustomEmojisFork() {
	try {
		yield getCustomEmojis();
	} catch (e) {
		log(e);
	}
};

const fetchRolesFork = function* fetchRolesFork() {
	try {
		sdk.subscribe('stream-roles', 'roles');
		yield getRoles();
	} catch (e) {
		log(e);
	}
};

const fetchSlashCommandsFork = function* fetchSlashCommandsFork() {
	try {
		yield getSlashCommands();
	} catch (e) {
		log(e);
	}
};

const registerPushTokenFork = function* registerPushTokenFork() {
	try {
		yield registerPushToken();
	} catch (e) {
		log(e);
	}
};

const fetchUsersPresenceFork = function* fetchUsersPresenceFork() {
	try {
		yield subscribeUsersPresence();
		yield refreshDmUsersPresence();
	} catch (e) {
		log(e);
	}
};

const fetchEnterpriseModules = function* fetchEnterpriseModules({ user }) {
	try {
		yield getEnterpriseModules();

		if (isOmnichannelStatusAvailable(user.statusLivechat) && isOmnichannelModuleAvailable()) {
			yield put(inquiryRequest());
		}
	} catch (e) {
		log(e);
	}
};

const fetchUsersRoles = function* fetchRoomsFork() {
	try {
		const roles = yield getUsersRoles();
		if (roles.length) {
			yield put(setUsersRoles(roles));
		}
	} catch (e) {
		log(e);
	}
};

const checkBackgroundAndSetAway = function* checkBackgroundAndSetAway() {
	try {
		const { background, root } = yield select(state => state.app);
		if (root !== RootEnum.ROOT_INSIDE || !background) {
			return;
		}
		const isAuthenticated = yield select(state => state.login.isAuthenticated);
		const isConnected = yield select(state => state.meteor.connected);
		if (!isAuthenticated || !isConnected) {
			return;
		}
		yield setUserPresenceAway();
	} catch (e) {
		log(e);
	}
};

const checkVoipPermission = async () => {
	try {
		const state = reduxStore.getState();
		const userId = state.login.user?.id;
		if (!userId) {
			return;
		}

		const hasPermissions = await hasPermission([
			state.permissions['allow-internal-voice-calls'],
			state.permissions['allow-external-voice-calls']
		]);
		const canUseVoip = isVoipModuleAvailable() && (hasPermissions[0] || hasPermissions[1]);

		if (!canUseVoip) {
			mediaSessionInstance.reset();
			return;
		}
		if (!mediaSessionStore.getCurrentInstance()) {
			mediaSessionInstance.init(userId);
		}
	} catch (e) {
		log(e);
	}
};

const startVoipFork = function* startVoipFork() {
	yield call(checkVoipPermission);

	// Re-check on permission/module changes. selectServer's DB-read phase covers warm relaunches;
	// PERMISSIONS.SET / ENTERPRISE_MODULES.SET cover first-login on a fresh server; PERMISSIONS.UPDATE
	// covers runtime changes pushed by the server (handled in connect.ts's stream-notify-logged listener).
	// Stop on LOGOUT, a new LOGIN.SUCCESS, or SERVER.SELECT_REQUEST so we never leak the saga across
	// workspace switches.
	yield race({
		recheck: takeLatest([types.PERMISSIONS.SET, types.PERMISSIONS.UPDATE, types.ENTERPRISE_MODULES.SET], checkVoipPermission),
		stop: take([types.LOGOUT, types.LOGIN.SUCCESS, types.SERVER.SELECT_REQUEST])
	});
};

const handleLoginSuccess = function* handleLoginSuccess({ user }) {
	try {
		yield put(setUser(user));
		setLanguage(user?.language);

		const server = yield select(getServer);
		yield put(roomsRequest());
		yield put(encryptionInit());
		// VoIP must spawn before the awaited fetches so it survives the 2s cancel race in root().
		// On warm relaunch, redux is already populated by selectServer; on cold login, it re-checks
		// when PERMISSIONS.SET / ENTERPRISE_MODULES.SET land.
		yield spawn(startVoipFork);
		yield call(fetchPermissions);
		yield call(fetchEnterpriseModules, { user });
		yield fork(fetchCustomEmojisFork);
		yield fork(fetchRolesFork);
		yield fork(fetchSlashCommandsFork);
		yield fork(registerPushTokenFork);
		yield fork(fetchUsersPresenceFork);
		yield fork(subscribeSettingsFork);
		yield fork(fetchUsersRoles);
		yield fork(checkBackgroundAndSetAway);
		yield getUserPresence(user.id);

		const serversDB = database.servers;
		const usersCollection = serversDB.get('users');
		const u = {
			token: user.token,
			username: user.username,
			name: user.name,
			language: user.language,
			status: user.status,
			statusText: user.statusText,
			roles: user.roles,
			showMessageInMainThread: user.showMessageInMainThread,
			avatarETag: user.avatarETag,
			bio: user.bio,
			nickname: user.nickname,
			requirePasswordChange: user.requirePasswordChange
		};
		yield serversDB.write(async () => {
			try {
				const userRecord = await usersCollection.find(user.id);
				await userRecord.update(record => {
					record._raw = sanitizedRaw({ id: user.id, ...record._raw }, usersCollection.schema);
					Object.assign(record, u);
				});
			} catch (e) {
				await usersCollection.create(record => {
					record._raw = sanitizedRaw({ id: user.id }, usersCollection.schema);
					Object.assign(record, u);
				});
			}
		});

		UserPreferences.setString(`${TOKEN_KEY}-${server}`, user.id);
		UserPreferences.setString(getUserTokenKey(server, user.id), user.token);
		UserPreferences.setString(CURRENT_SERVER, server);
		EventEmitter.emit('connected');
		const currentRoot = yield select(state => state.app.root);
		if (currentRoot !== RootEnum.ROOT_SHARE_EXTENSION && currentRoot !== RootEnum.ROOT_LOADING_SHARE_EXTENSION) {
			yield put(appStart({ root: RootEnum.ROOT_INSIDE }));
		}
		const inviteLinkToken = yield select(state => state.inviteLinks.token);
		if (inviteLinkToken) {
			yield put(inviteLinksRequest(inviteLinkToken));
		}
		yield showSupportedVersionsWarning(server);
		yield put(initTroubleshootingNotification());
	} catch (e) {
		log(e);
	}
};

const handleLogout = function* handleLogout({ forcedByServer, message }) {
	yield put(encryptionStop());
	yield put(appStart({ root: RootEnum.ROOT_LOADING, text: I18n.t('Logging_out') }));
	const server = yield select(getServer);
	if (server) {
		try {
			yield call(logoutCall, { server });

			// if the user was logged out by the server
			if (forcedByServer) {
				yield put(appStart({ root: RootEnum.ROOT_OUTSIDE }));
				if (message) {
					showErrorAlert(I18n.t(message), I18n.t('Oops'));
				}
				yield delay(300);
				EventEmitter.emit('NewServer', { server });
			} else {
				const serversDB = database.servers;
				// all servers
				const serversCollection = serversDB.get('servers');
				const servers = yield serversCollection.query().fetch();

				// see if there're other logged in servers and selects first one
				if (servers.length > 0) {
					for (let i = 0; i < servers.length; i += 1) {
						const newServer = servers[i].id;
						const token = UserPreferences.getString(`${TOKEN_KEY}-${newServer}`);
						if (token) {
							yield put(selectServerRequest(newServer, newServer.version));
							return;
						}
					}
				}
				// if there's no servers, go outside
				yield put(appStart({ root: RootEnum.ROOT_OUTSIDE }));
			}
		} catch (e) {
			yield put(appStart({ root: RootEnum.ROOT_OUTSIDE }));
			log(e);
		}
	}
};

const handleSetUser = function* handleSetUser({ user }) {
	if ('avatarETag' in user || 'requirePasswordChange' in user) {
		const userId = yield select(state => state.login.user.id);
		const serversDB = database.servers;
		const userCollections = serversDB.get('users');
		yield serversDB.write(async () => {
			try {
				const record = await userCollections.find(userId);
				await record.update(userRecord => {
					if ('avatarETag' in user) {
						userRecord.avatarETag = user.avatarETag;
					}
					if ('requirePasswordChange' in user) {
						userRecord.requirePasswordChange = user.requirePasswordChange;
					}
				});
			} catch {
				//
			}
		});
	}

	setLanguage(user?.language);

	if (user?.statusLivechat && isOmnichannelModuleAvailable()) {
		if (isOmnichannelStatusAvailable(user.statusLivechat)) {
			yield put(inquiryRequest());
		} else {
			yield put(inquiryReset());
		}
	}
};

const handleDeleteAccount = function* handleDeleteAccount() {
	yield put(encryptionStop());
	yield put(appStart({ root: RootEnum.ROOT_LOADING, text: I18n.t('Deleting_account') }));
	const server = yield select(getServer);
	if (server) {
		try {
			yield call(removeServerData, { server });
			yield call(removeServerDatabase, { server });
			const serversDB = database.servers;
			// all servers
			const serversCollection = serversDB.get('servers');
			const servers = yield serversCollection.query().fetch();

			// see if there're other logged in servers and selects first one
			if (servers.length > 0) {
				for (let i = 0; i < servers.length; i += 1) {
					const newServer = servers[i].id;
					const token = UserPreferences.getString(`${TOKEN_KEY}-${newServer}`);
					if (token) {
						yield put(selectServerRequest(newServer, newServer.version));
						return;
					}
				}
			}
			// if there's no servers, go outside
			disconnect();
			yield put(appStart({ root: RootEnum.ROOT_OUTSIDE }));
		} catch (e) {
			disconnect();
			yield put(appStart({ root: RootEnum.ROOT_OUTSIDE }));
			log(e);
		}
	}
};

const root = function* root() {
	yield takeLatest(types.LOGIN.REQUEST, handleLoginRequest);
	yield takeLatest(types.LOGOUT, handleLogout);
	yield takeLatest(types.USER.SET, handleSetUser);
	yield takeLatest(types.DELETE_ACCOUNT, handleDeleteAccount);

	while (true) {
		const params = yield take(types.LOGIN.SUCCESS);
		const loginSuccessTask = yield fork(handleLoginSuccess, params);
		// Only cancel handleLoginSuccess if a workspace switch interrupts it.
		// Cancelling on the 2s timeout would rip the saga before it reaches
		// appStart(ROOT_INSIDE), stranding users on the login screen when
		// permissions/enterprise fetches run long (issue #7333).
		const { selectRequest } = yield race({
			selectRequest: take(types.SERVER.SELECT_REQUEST),
			timeout: delay(2000)
		});
		if (selectRequest) {
			yield cancel(loginSuccessTask);
		}
	}
};
export default root;