mattermost-mobile/app/store/middlewares/helpers.js

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

import {Posts} from '@mm-redux/constants';
import {isCollapsedThreadsEnabled} from '@mm-redux/selectors/entities/preferences';

export function getLastChannelForTeam(payload) {
    if (payload?.views?.team?.lastChannelForTeam) {
        const lastChannelForTeam = {...payload.views.team.lastChannelForTeam};
        const convertLastChannelForTeam = Object.values(lastChannelForTeam).some((value) => !Array.isArray(value));

        if (convertLastChannelForTeam) {
            Object.keys(lastChannelForTeam).forEach((id) => {
                lastChannelForTeam[id] = [lastChannelForTeam[id]];
            });
        }

        return lastChannelForTeam;
    }

    return {};
}

export function cleanUpState(payload, keepCurrent = false) {
    const nextState = Object.assign({}, payload);

    const lastTeamId = payload.views?.team?.lastTeamId;
    const lastChannelForTeam = getLastChannelForTeam(payload);
    const currentChannelId = lastChannelForTeam[lastTeamId] && lastChannelForTeam[lastTeamId].length ? lastChannelForTeam[lastTeamId][0] : '';

    const nextEntities = {
        posts: {
            posts: {},
            postsInChannel: {},
            postsInThread: {},
            reactions: {},
            openGraph: payload.entities?.posts?.openGraph,
            selectedPostId: payload.entities?.posts?.selectedPostId,
            currentFocusedPostId: payload.entities?.posts?.currentFocusedPostId,
        },
        files: {
            files: {},
            fileIdsByPostId: {},
        },
        threads: {
            threads: {},
            threadsInTeam: {},
            counts: payload.entities?.threads?.counts,
        },
        general: {
            ...payload.entities?.general,
            dataRetention: {
                ...payload.entities?.general?.dataRetention,
            },
        },
    };

    // Migrate old data retention policy value to the granular structure
    if (nextEntities.general.dataRetentionPolicy) {
        nextEntities.general.dataRetention = {
            ...nextEntities.general.dataRetention,
            policies: {
                ...nextEntities.general.dataRetention?.policies?.global,
                global: nextEntities.general.dataRetentionPolicy,
            },
        };
        delete nextEntities.general.dataRetentionPolicy;
    }

    let globalRetentionCutoff = 0;
    const channelsRetentionCutoff = {};

    const {policies, lastCleanUpAt} = nextEntities.general.dataRetention || {};

    const lastCleanedToday = new Date(lastCleanUpAt).toDateString() === new Date().toDateString();
    if (policies && (!lastCleanUpAt || !lastCleanedToday)) {
        if (policies.global?.message_deletion_enabled) {
            globalRetentionCutoff = policies.global.message_retention_cutoff;
        }

        // Channels from team policies
        policies?.teams?.forEach((policy) => {
            const channels = payload.entities?.channels?.channelsInTeam?.[policy.team_id];
            if (channels) {
                const cutoff = getRetentionCutoffFromPolicy(policy);
                channels.forEach((channel_id) => {
                    channelsRetentionCutoff[channel_id] = cutoff;
                });
            }
        });

        // Add/Override from channels only policies
        policies?.channels?.forEach((policy) => {
            channelsRetentionCutoff[policy.channel_id] = getRetentionCutoffFromPolicy(policy);
        });

        // Update the last cleanup date only when we have atleast one policy
        if (globalRetentionCutoff || Object.keys(channelsRetentionCutoff).length) {
            nextEntities.general.dataRetention.lastCleanUpAt = new Date();
        }
    }

    const postIdsToKeep = [];

    // Keep the last 60 threads in each team
    nextEntities.threads = {
        ...nextEntities.threads,
        ...cleanUpThreadsInTeam(payload.entities.posts?.posts, payload.entities.threads?.threads, payload.entities.threads?.threadsInTeam, keepCurrent ? lastTeamId : ''),
    };
    postIdsToKeep.push(...getAllFromThreadsInTeam(nextEntities.threads?.threadsInTeam));

    // Keep the last 60 posts in each recently viewed channel
    nextEntities.posts.postsInChannel = cleanUpPostsInChannel(payload.entities.posts?.postsInChannel, lastChannelForTeam, keepCurrent ? currentChannelId : '');

    postIdsToKeep.push(...getAllFromPostsInChannel(nextEntities.posts.postsInChannel));

    // Keep any posts that appear in search results
    let searchResults = [];
    let flaggedPosts = [];
    if (payload.entities?.search) {
        if (payload.entities.search.results?.length) {
            const {results} = payload.entities.search;
            searchResults = results;
            postIdsToKeep.push(...results);
        }

        if (payload.entities.search.flagged?.length) {
            const {flagged} = payload.entities.search;
            flaggedPosts = flagged;
            postIdsToKeep.push(...flagged);
        }
    }

    const nextSearch = {
        ...(payload.entities.search || {}),
        results: searchResults,
        flagged: flaggedPosts,
    };

    const collapsedThreadsEnabled = isCollapsedThreadsEnabled(payload);
    if (payload.entities.posts?.posts) {
        const reactions = payload.entities.posts.reactions || {};
        const fileIdsByPostId = payload.entities.files?.fileIdsByPostId || {};
        const files = payload.entities.files?.files || {};
        const postsInThread = payload.entities.posts.postsInThread || {};

        postIdsToKeep.forEach((postId) => {
            const post = payload.entities.posts.posts[postId];

            if (post) {
                // Remove non-root posts if CRT is enabled
                const crtCleanup = collapsedThreadsEnabled && post.root_id;
                if (shouldRemovePost(globalRetentionCutoff, channelsRetentionCutoff, post) || crtCleanup) {
                    // This post has been removed by data retention, so don't keep it
                    removeFromPostsInChannel(nextEntities.posts.postsInChannel, post.channel_id, postId);
                    removeFromThreadsInTeam(nextEntities.threads, postId);
                    return;
                }

                // Keep the post
                nextEntities.posts.posts[postId] = post;

                // And its reactions
                const reaction = reactions[postId];
                if (reaction) {
                    nextEntities.posts.reactions[postId] = reaction;
                }

                // And its files
                const fileIds = fileIdsByPostId[postId];
                if (fileIds) {
                    nextEntities.files.fileIdsByPostId[postId] = fileIds;
                    fileIds.forEach((fileId) => {
                        nextEntities.files.files[fileId] = files[fileId];
                    });
                }

                // And its comments
                const threadPosts = postsInThread[postId];
                if (threadPosts) {
                    nextEntities.posts.postsInThread[postId] = threadPosts;
                }
            }
        });
    }

    // Remove any pending posts that haven't failed
    if (payload.entities.posts?.pendingPostIds?.length) {
        const nextPendingPostIds = [...payload.entities.posts.pendingPostIds];
        payload.entities.posts.pendingPostIds.forEach((id) => {
            const posts = nextEntities.posts.posts;
            const post = posts[id];

            if (post && !post.failed) {
                Reflect.deleteProperty(posts, id);

                removeFromPostsInChannel(nextEntities.posts.postsInChannel, post.channel_id, id);

                removePendingPost(nextPendingPostIds, id);
            } else if (!post) {
                removePendingPost(nextPendingPostIds, id);
            }
        });

        nextEntities.posts.pendingPostIds = nextPendingPostIds;
    }

    nextState.views = {
        ...(nextState.views || {}),
        root: {
            ...(nextState.views?.root || {}),
            // eslint-disable-next-line no-underscore-dangle
            hydrationComplete: nextState.views?.root?.hydrationComplete || !nextState._persist,
        },
    };

    // eslint-disable-next-line no-underscore-dangle
    nextState._persist = {
        rehydrated: true,
    };

    nextState.entities = {
        ...nextState.entities,
        ...nextEntities,
        search: nextSearch,
    };

    return nextState;
}

// cleanUpPostsInChannel returns a copy of postsInChannel where only the most recent posts in each channel are kept
export function cleanUpPostsInChannel(postsInChannel, lastChannelForTeam, currentChannelId, recentPostCount = 60) {
    const nextPostsInChannel = {};

    if (postsInChannel && lastChannelForTeam) {
        for (const channelIds of Object.values(lastChannelForTeam)) {
            for (const channelId of channelIds) {
                if (nextPostsInChannel[channelId]) {
                    // This is a DM or GM channel that we've already seen on another team
                    continue;
                }

                const postsForChannel = postsInChannel[channelId];

                if (!postsForChannel) {
                    // We don't have anything to keep for this channel
                    continue;
                }

                let nextPostsForChannel;

                if (channelId === currentChannelId) {
                    // Keep all of the posts for this channel
                    nextPostsForChannel = postsForChannel;
                } else {
                    // Only keep the most recent posts for this channel
                    const recentBlock = postsForChannel.find((block) => block.recent);

                    if (!recentBlock) {
                        // We don't have recent posts for this channel
                        continue;
                    }

                    nextPostsForChannel = [{
                        ...recentBlock,
                        order: recentBlock.order.slice(0, recentPostCount),
                    }];
                }

                nextPostsInChannel[channelId] = nextPostsForChannel;
            }
        }
    }

    return nextPostsInChannel;
}

export function cleanUpThreadsInTeam(posts, threads, threadsInTeam, currentTeamId, threadsCountPerTeam = 60) {
    const newThreads = {};
    const newThreadsInTeam = {};
    if (threads && threadsInTeam) {
        for (const teamId of Object.keys(threadsInTeam)) {
            // Convert array of thread IDS to THREADS
            // Sort them based on last reply time
            const mappedThreads = (
                threadsInTeam[teamId]?.map((threadId) => {
                    return threads[threadId];
                }) || []
            ).sort((threadA, threadB) => {
                return threadB?.last_reply_at - threadA?.last_reply_at;
            });

            newThreadsInTeam[teamId] = [];
            const retainedThreads = currentTeamId === teamId ? mappedThreads : mappedThreads.slice(0, threadsCountPerTeam);
            retainedThreads.forEach((thread) => {
                const post = posts?.[thread.id];
                if (post && post.state !== Posts.POST_DELETED) {
                    newThreadsInTeam[teamId].push(thread.id);
                    newThreads[thread.id] = thread;
                }
            });
        }
    }
    return {threads: newThreads, threadsInTeam: newThreadsInTeam};
}

// getAllFromPostsInChannel returns an array of all post IDs found in postsInChannel
export function getAllFromPostsInChannel(postsInChannel) {
    const postIds = [];

    if (postsInChannel) {
        for (const postsForChannel of Object.values(postsInChannel)) {
            for (const block of postsForChannel) {
                postIds.push(...block.order);
            }
        }
    }

    return postIds;
}

export function getAllFromThreadsInTeam(threadsInTeam) {
    const postIds = [];
    if (threadsInTeam) {
        for (const teamId of Object.keys(threadsInTeam)) {
            postIds.push(...threadsInTeam[teamId]);
        }
    }
    return postIds;
}

// Returns cutoff time for the policy
function getRetentionCutoffFromPolicy(policy) {
    const periodDate = new Date();
    periodDate.setDate(periodDate.getDate() - policy.post_duration);
    return periodDate.getTime();
}

function shouldRemovePost(globalRetentionCutoff, channelsRetentionCutoff, post) {
    // If cutoff is found for the channel
    if (channelsRetentionCutoff[post.channel_id]) {
        return post.create_at < channelsRetentionCutoff[post.channel_id];
    } else if (globalRetentionCutoff) {
        return post.create_at < globalRetentionCutoff;
    }
    return false;
}

function removeFromPostsInChannel(postsInChannel, channelId, postId) {
    const postsForChannel = postsInChannel[channelId];

    if (!postsForChannel) {
        return;
    }

    // Since this has already gone through cleanUpPostsInChannel, we know that there can only be one block to look at
    const index = postsForChannel[0].order.indexOf(postId);
    if (index !== -1) {
        postsForChannel[0].order.splice(index, 1);
    }
}

function removeFromThreadsInTeam({threads, threadsInTeam}, postId) {
    if (threads[postId]) {
        Reflect.deleteProperty(threads, postId);
        for (const teamId of Object.keys(threadsInTeam)) {
            threadsInTeam[teamId].filter((threadId) => threadId !== postId);
        }
    }
}

function removePendingPost(pendingPostIds, id) {
    const pendingIndex = pendingPostIds.indexOf(id);
    if (pendingIndex !== -1) {
        pendingPostIds.splice(pendingIndex, 1);
    }
}