mattermost-mobile/app/actions/local/systems.test.ts

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

import Database from '@nozbe/watermelondb/Database';

import {getPosts} from '@actions/local/post';
import {ActionType} from '@constants';
import {SYSTEM_IDENTIFIERS} from '@constants/database';
import {PostTypes} from '@constants/post';
import DatabaseManager from '@database/manager';
import TestHelper from '@test/test_helper';
import {logError} from '@utils/log';

import {
    storeConfig,
    storeConfigAndLicense,
    storeDataRetentionPolicies,
    updateLastDataRetentionRun,
    dataRetentionCleanup,
    setLastServerVersionCheck,
    setGlobalThreadsTab,
    dismissAnnouncement,
    expiredBoRPostCleanup,
} from './systems';

import type {DataRetentionPoliciesRequest} from '@actions/remote/systems';
import type ServerDataOperator from '@database/operator/server_data_operator';
import type SystemModel from '@typings/database/models/servers/system';

const serverUrl = 'baseHandler.test.com';
let operator: ServerDataOperator;

jest.mock('@init/credentials', () => {
    const original = jest.requireActual('@init/credentials');
    return {
        ...original,
        getServerCredentials: jest.fn(async (url: string) => ({serverUrl: url})),
    };
});

beforeEach(async () => {
    await DatabaseManager.init([serverUrl]);
    operator = DatabaseManager.serverDatabases[serverUrl]!.operator;
});

afterEach(async () => {
    await DatabaseManager.destroyServerDatabase(serverUrl);
});

describe('storeConfigAndLicense', () => {
    it('handle not found database - storeConfig', async () => {
        const models = await storeConfig('foo', {} as ClientConfig);
        expect(models).toBeDefined();
        expect(models.length).toBe(0);
    });

    it('handle undefined config - storeConfig', async () => {
        const models = await storeConfig(serverUrl, undefined);
        expect(models).toBeDefined();
        expect(models.length).toBe(0);
    });

    it('base case - storeConfig', async () => {
        await operator.handleConfigs({
            configs: [
                {id: 'DataRetentionEnableMessageDeletion', value: 'true'},
                {id: 'AboutLink', value: 'link'},
            ],
            configsToDelete: [],
            prepareRecordsOnly: false,
        });

        const models = await storeConfig(serverUrl, {AboutLink: 'link'} as ClientConfig);
        expect(models).toBeDefined();
        expect(models.length).toBe(1); // data retention removed
    });

    it('nothing to update - storeConfig', async () => {
        await operator.handleConfigs({
            configs: [
                {id: 'AboutLink', value: 'link'},
            ],
            configsToDelete: [],
            prepareRecordsOnly: false,
        });

        const models = await storeConfig(serverUrl, {AboutLink: 'link'} as ClientConfig);
        expect(models).toBeDefined();
        expect(models.length).toBe(0);
    });

    it('handle not found database', async () => {
        const models = await storeConfigAndLicense('foo', {} as ClientConfig, {} as ClientLicense);
        expect(models).toBeDefined();
        expect(models.length).toBe(0);
    });

    it('base case', async () => {
        const models = await storeConfigAndLicense(serverUrl, {AboutLink: 'link'} as ClientConfig, {Announcement: 'test'} as ClientLicense);
        expect(models).toBeDefined();
        expect(models.length).toBe(1); // config
    });
});

describe('dataRetention', () => {
    it('handle not found database - storeDataRetentionPolicies', async () => {
        const models = await storeDataRetentionPolicies('foo', {} as DataRetentionPoliciesRequest);
        expect(models).toBeDefined();
        expect(models.length).toBe(0);
    });

    it('base case - storeDataRetentionPolicies', async () => {
        const models = await storeDataRetentionPolicies(serverUrl, {globalPolicy: {} as GlobalDataRetentionPolicy, teamPolicies: [], channelPolicies: []} as DataRetentionPoliciesRequest);
        expect(models).toBeDefined();
        expect(models.length).toBe(2); // data retention and granular data retention policies
    });

    it('empty case - storeDataRetentionPolicies', async () => {
        const models = await storeDataRetentionPolicies(serverUrl, {} as DataRetentionPoliciesRequest);
        expect(models).toBeDefined();
        expect(models.length).toBe(2); // data retention and granular data retention policies
    });

    it('handle not found database - updateLastDataRetentionRun', async () => {
        const {error} = await updateLastDataRetentionRun('foo', 0) as {error: unknown};
        expect(error).toBeDefined();
    });

    it('base case - updateLastDataRetentionRun', async () => {
        const models = await updateLastDataRetentionRun(serverUrl, 10) as SystemModel[];
        expect(models).toBeDefined();
        expect(models.length).toBe(1); // data retention
    });

    it('no time provided - updateLastDataRetentionRun', async () => {
        const models = await updateLastDataRetentionRun(serverUrl) as SystemModel[];
        expect(models).toBeDefined();
        expect(models.length).toBe(1); // data retention
    });

    it('handle not found database - dataRetentionCleanup', async () => {
        const {error} = await dataRetentionCleanup('foo');
        expect(error).toBeDefined();
    });

    it('rentention off - dataRetentionCleanup', async () => {
        const post = TestHelper.fakePost({channel_id: 'channelid1', id: 'postid', create_at: 1});
        await operator.handlePosts({
            actionType: ActionType.POSTS.RECEIVED_IN_CHANNEL,
            order: [post.id],
            posts: [post],
            prepareRecordsOnly: false,
        });

        const spy = jest.spyOn(Database.prototype, 'unsafeVacuum').mockImplementation(jest.fn());
        const {error} = await dataRetentionCleanup(serverUrl);
        expect(error).toBeDefined(); // unsafeExecute loki error
        spy.mockRestore();
    });

    it('retention on - dataRetentionCleanup', async () => {
        const channel: Channel = {
            id: 'channelid1',
            team_id: 'teamid1',
            total_msg_count: 0,
        } as Channel;

        await operator.handleConfigs({
            configs: [
                {id: 'DataRetentionEnableMessageDeletion', value: 'true'},
            ],
            configsToDelete: [],
            prepareRecordsOnly: false,
        });
        await operator.handleSystem({systems:
            [
                {id: SYSTEM_IDENTIFIERS.LICENSE, value: {IsLicensed: 'true', DataRetention: 'true'}},
                {id: SYSTEM_IDENTIFIERS.GRANULAR_DATA_RETENTION_POLICIES, value: {team: [{team_id: 'teamid1', post_duration: 100}], channel: [{channel_id: 'channelid1', post_duration: 100}]}},
            ],
        prepareRecordsOnly: false});
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});

        const spy = jest.spyOn(Database.prototype, 'unsafeVacuum').mockImplementation(jest.fn());
        const {error} = await dataRetentionCleanup(serverUrl);
        expect(error).toBeDefined(); // LokiJSAdapter doesn't support unsafeSqlQuery
        spy.mockRestore();
    });

    it('already cleaned today - dataRetentionCleanup', async () => {
        const channel: Channel = {
            id: 'channelid1',
            team_id: 'teamid1',
            total_msg_count: 0,
        } as Channel;

        await operator.handleConfigs({
            configs: [
                {id: 'DataRetentionEnableMessageDeletion', value: 'true'},
            ],
            configsToDelete: [],
            prepareRecordsOnly: false,
        });
        await operator.handleSystem({systems:
            [
                {id: SYSTEM_IDENTIFIERS.LAST_DATA_RETENTION_RUN, value: Date.now()},
                {id: SYSTEM_IDENTIFIERS.LICENSE, value: {IsLicensed: 'true', DataRetention: 'true'}},
                {id: SYSTEM_IDENTIFIERS.GRANULAR_DATA_RETENTION_POLICIES, value: {team: [{team_id: 'teamid1', post_duration: 100}], channel: [{channel_id: 'channelid1', post_duration: 100}]}},
            ],
        prepareRecordsOnly: false});
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});

        const {error} = await dataRetentionCleanup(serverUrl);
        expect(error).toBeUndefined();
    });
});

describe('setLastServerVersionCheck', () => {
    it('handle not found database', async () => {
        const {error} = await setLastServerVersionCheck('foo');
        expect(error).toBeDefined();
    });

    it('base case', async () => {
        const {error} = await setLastServerVersionCheck(serverUrl);
        expect(error).toBeUndefined();
    });

    it('base case - reset', async () => {
        const {error} = await setLastServerVersionCheck(serverUrl, true);
        expect(error).toBeUndefined();
    });
});

describe('setGlobalThreadsTab', () => {
    it('handle not found database', async () => {
        const {error} = await setGlobalThreadsTab('foo', 'all');
        expect(error).toBeDefined();
    });

    it('base case', async () => {
        const {error} = await setGlobalThreadsTab(serverUrl, 'all');
        expect(error).toBeUndefined();
    });
});

describe('dismissAnnouncement', () => {
    it('handle not found database', async () => {
        const {error} = await dismissAnnouncement('foo', 'text');
        expect(error).toBeDefined();
    });

    it('base case', async () => {
        const {error} = await dismissAnnouncement(serverUrl, 'text');
        expect(error).toBeUndefined();
    });
});

describe('expiredBoRPostCleanup', () => {
    it('should delete expired BoR posts', async () => {
        const database = operator.database;
        jest.spyOn(database.adapter, 'unsafeExecute').mockImplementation(() => Promise.resolve());

        const channel: Channel = TestHelper.fakeChannel({
            id: 'channelid1',
            team_id: 'teamid1',
        });
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});

        const now = Date.now();

        const borPostExpiredForAll = TestHelper.fakePost({
            id: 'postid1',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now - 10000},
        });

        const borPostExpiredForMe = TestHelper.fakePost({
            id: 'postid2',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now + 100000},
            metadata: {expire_at: now - 10000},
        });

        await operator.handlePosts({
            actionType: ActionType.POSTS.RECEIVED_IN_CHANNEL,
            order: [borPostExpiredForAll.id, borPostExpiredForMe.id],
            posts: [borPostExpiredForAll, borPostExpiredForMe],
            prepareRecordsOnly: false,
        });

        // verify channel posts
        const fetchedPosts = await getPosts(serverUrl, [borPostExpiredForAll.id, borPostExpiredForMe.id]);
        expect(fetchedPosts.length).toBe(2);

        await expiredBoRPostCleanup(serverUrl);

        expect(database.adapter.unsafeExecute).toHaveBeenCalledWith({
            sqls: [
                [`DELETE FROM Post where id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
                [`DELETE FROM Reaction where post_id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
                [`DELETE FROM File where post_id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
                [`DELETE FROM Draft where root_id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
                [`DELETE FROM PostsInThread where root_id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
                [`DELETE FROM Thread where id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
                [`DELETE FROM ThreadParticipant where thread_id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
                [`DELETE FROM ThreadsInTeam where thread_id IN ('${borPostExpiredForMe.id}','${borPostExpiredForAll.id}')`, []],
            ],
        });
    });

    it('should not run cleanup when called again within 15 minutes', async () => {
        const database = operator.database;
        const unsafeExecuteSpy = jest.spyOn(database.adapter, 'unsafeExecute').mockImplementation(() => Promise.resolve());

        // Set up a recent last run time (within 15 minutes)
        const recentRunTime = Date.now() - (10 * 60 * 1000); // 10 minutes ago
        await operator.handleSystem({
            systems: [{
                id: SYSTEM_IDENTIFIERS.LAST_BOR_POST_CLEANUP_RUN,
                value: recentRunTime,
            }],
            prepareRecordsOnly: false,
        });

        const channel: Channel = TestHelper.fakeChannel({
            id: 'channelid1',
            team_id: 'teamid1',
        });
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});

        const now = Date.now();
        const borPostExpired = TestHelper.fakePost({
            id: 'postid1',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now - 10000},
        });

        await operator.handlePosts({
            actionType: ActionType.POSTS.RECEIVED_IN_CHANNEL,
            order: [borPostExpired.id],
            posts: [borPostExpired],
            prepareRecordsOnly: false,
        });

        // Call cleanup - should not run because last run was within 15 minutes
        await expiredBoRPostCleanup(serverUrl);

        // Verify that unsafeExecute was not called (no cleanup performed)
        expect(unsafeExecuteSpy).not.toHaveBeenCalled();
    });

    it('should handle no server database gracefully', async () => {
        // Try to run cleanup on a non-existent server
        await expect(expiredBoRPostCleanup('nonexistent.server.com')).resolves.not.toThrow();
    });

    it('should handle no BoR posts gracefully', async () => {
        const database = operator.database;
        const unsafeExecuteSpy = jest.spyOn(database.adapter, 'unsafeExecute').mockImplementation(() => Promise.resolve());

        const channel: Channel = TestHelper.fakeChannel({
            id: 'channelid1',
            team_id: 'teamid1',
        });
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});
        await expiredBoRPostCleanup(serverUrl);

        // Verify that unsafeExecute was not called (no BoR posts to clean)
        expect(unsafeExecuteSpy).not.toHaveBeenCalled();
    });

    it('should handle BoR posts that are not expired', async () => {
        const database = operator.database;
        const unsafeExecuteSpy = jest.spyOn(database.adapter, 'unsafeExecute').mockImplementation(() => Promise.resolve());

        const channel: Channel = TestHelper.fakeChannel({
            id: 'channelid1',
            team_id: 'teamid1',
        });
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});

        const now = Date.now();

        // Create BoR posts that are not expired
        const borPostNotExpired = TestHelper.fakePost({
            id: 'postid1',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now + 100000}, // Future expiry
        });

        const borPostNotExpiredForMe = TestHelper.fakePost({
            id: 'postid2',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now + 10000},
            metadata: {expire_at: now + 100000},
        });

        await operator.handlePosts({
            actionType: ActionType.POSTS.RECEIVED_IN_CHANNEL,
            order: [borPostNotExpired.id, borPostNotExpiredForMe.id],
            posts: [borPostNotExpired, borPostNotExpiredForMe],
            prepareRecordsOnly: false,
        });

        await expiredBoRPostCleanup(serverUrl);

        // Verify that unsafeExecute was not called (no expired BoR posts)
        expect(unsafeExecuteSpy).not.toHaveBeenCalled();
    });

    it('should handle mixed expired and non-expired BoR posts', async () => {
        const database = operator.database;
        jest.spyOn(database.adapter, 'unsafeExecute').mockImplementation(() => Promise.resolve());

        const channel: Channel = TestHelper.fakeChannel({
            id: 'channelid1',
            team_id: 'teamid1',
        });
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});

        const now = Date.now();

        const borPostExpired = TestHelper.fakePost({
            id: 'postid1',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now - 10000}, // Expired
        });

        const borPostNotExpired = TestHelper.fakePost({
            id: 'postid2',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now + 100000}, // Not expired
        });

        await operator.handlePosts({
            actionType: ActionType.POSTS.RECEIVED_IN_CHANNEL,
            order: [borPostExpired.id, borPostNotExpired.id],
            posts: [borPostExpired, borPostNotExpired],
            prepareRecordsOnly: false,
        });

        await expiredBoRPostCleanup(serverUrl);

        // Should only delete the expired post
        expect(database.adapter.unsafeExecute).toHaveBeenCalledWith({
            sqls: [
                [`DELETE FROM Post where id IN ('${borPostExpired.id}')`, []],
                [`DELETE FROM Reaction where post_id IN ('${borPostExpired.id}')`, []],
                [`DELETE FROM File where post_id IN ('${borPostExpired.id}')`, []],
                [`DELETE FROM Draft where root_id IN ('${borPostExpired.id}')`, []],
                [`DELETE FROM PostsInThread where root_id IN ('${borPostExpired.id}')`, []],
                [`DELETE FROM Thread where id IN ('${borPostExpired.id}')`, []],
                [`DELETE FROM ThreadParticipant where thread_id IN ('${borPostExpired.id}')`, []],
                [`DELETE FROM ThreadsInTeam where thread_id IN ('${borPostExpired.id}')`, []],
            ],
        });
    });

    it('should handle database errors gracefully', async () => {
        const database = operator.database;

        // Mock database query to throw an error
        jest.spyOn(database, 'get').mockImplementation(() => {
            throw new Error('Database error');
        });

        // Should not throw an error, just log it
        await expect(expiredBoRPostCleanup(serverUrl)).resolves.not.toThrow();
        expect(logError).toHaveBeenCalledWith('An error occurred while performing BoR post cleanup', expect.any(Error));
    });

    it('should handle updateLastBoRCleanupRun error gracefully', async () => {
        const database = operator.database;
        jest.spyOn(database.adapter, 'unsafeExecute').mockImplementation(() => Promise.resolve());

        // Mock handleSystem to throw an error when updating last cleanup run
        const handleSystemSpy = jest.spyOn(operator, 'handleSystem').mockImplementation(() => {
            throw new Error('System update error');
        });

        const channel: Channel = TestHelper.fakeChannel({
            id: 'channelid1',
            team_id: 'teamid1',
        });
        await operator.handleChannel({channels: [channel], prepareRecordsOnly: false});

        // Restore handleSystem for channel creation, then mock it again for the cleanup run update
        handleSystemSpy.mockRestore();
        jest.spyOn(operator, 'handleSystem').mockImplementation((args) => {
            if (args.systems?.[0]?.id === SYSTEM_IDENTIFIERS.LAST_BOR_POST_CLEANUP_RUN) {
                throw new Error('System update error');
            }
            return Promise.resolve([]);
        });

        const now = Date.now();
        const borPostExpired = TestHelper.fakePost({
            id: 'postid1',
            channel_id: channel.id,
            type: PostTypes.BURN_ON_READ,
            props: {expire_at: now - 10000},
        });

        await operator.handlePosts({
            actionType: ActionType.POSTS.RECEIVED_IN_CHANNEL,
            order: [borPostExpired.id],
            posts: [borPostExpired],
            prepareRecordsOnly: false,
        });

        // Should not throw an error, just log it
        await expect(expiredBoRPostCleanup(serverUrl)).resolves.not.toThrow();
        expect(logError).toHaveBeenCalledWith('Failed updateLastBoRCleanupRun', expect.any(Error));
    });

});