mattermost-mobile/app/screens/report_a_problem/app_logs.test.tsx

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

import TurboLogger from '@mattermost/react-native-turbo-log';
import RNUtils from '@mattermost/rnutils';
import {fireEvent, waitFor, waitForElementToBeRemoved} from '@testing-library/react-native';
import React from 'react';
import {Platform} from 'react-native';
import Share from 'react-native-share';

import {renderWithIntl} from '@test/intl-test-helper';
import {deleteFile} from '@utils/file';
import {logDebug} from '@utils/log';

import AppLogs from './app_logs';
jest.mock('react-native-share', () => ({
    open: jest.fn(),
}));

jest.mock('@utils/file', () => ({
    ...jest.requireActual('@utils/file'),
    deleteFile: jest.fn(),
}));

describe('screens/report_a_problem/app_logs', () => {
    const file1 = 'log1.txt';
    const file2 = 'log2.txt';
    const logPaths = [`/path/to/${file1}`, `/path/to/${file2}`];
    const zipPath = '/path/to/logs.zip';

    beforeEach(() => {
        jest.clearAllMocks();
        jest.mocked(TurboLogger.getLogPaths).mockResolvedValue(logPaths);
        jest.mocked(RNUtils.createZipFile).mockResolvedValue(zipPath);

        // React TouchableOpacity seems to be causing warnings about state
        // changes outside of an act. This is a workaround to silence the warnings.
        // We keep nextTick as it is needed for the tests to work.
        jest.useFakeTimers({
            doNotFake: [
                'nextTick',
            ],
        });
    });

    afterEach(() => {
        Platform.OS = 'ios';
        jest.useRealTimers();
    });

    it('renders loading state initially', async () => {
        const {getByTestId, getByText} = renderWithIntl(
            <AppLogs/>,
        );

        expect(getByTestId('logs-loading')).toBeTruthy();
        expect(getByText('Download App Logs')).toBeDisabled();

        // This removes a jest warning
        await waitForElementToBeRemoved(() => getByTestId('logs-loading'));
    });

    it('renders log files after loading', async () => {
        const {getByTestId, getByText} = renderWithIntl(
            <AppLogs/>,
        );

        await waitForElementToBeRemoved(() => getByTestId('logs-loading'));

        expect(getByText(/Logs_/)).toBeTruthy();
        expect(getByText('Download App Logs')).toBeEnabled();
    });

    it('handles download on iOS', async () => {
        Platform.OS = 'ios';
        const {getByText} = renderWithIntl(
            <AppLogs/>,
        );

        await waitFor(() => {
            expect(TurboLogger.getLogPaths).toHaveBeenCalled();
        });

        const downloadButton = getByText('Download App Logs');
        fireEvent.press(downloadButton);

        await waitFor(() => {
            expect(RNUtils.createZipFile).toHaveBeenCalledWith(logPaths);
            expect(Share.open).toHaveBeenCalledWith({
                url: 'file://' + zipPath,
                saveToFiles: true,
            });
            expect(deleteFile).toHaveBeenCalledWith(zipPath);
        });
    });

    it('handles download on Android', async () => {
        Platform.OS = 'android';
        const {getByText} = renderWithIntl(
            <AppLogs/>,
        );

        await waitFor(() => {
            expect(TurboLogger.getLogPaths).toHaveBeenCalled();
        });

        const downloadButton = getByText('Download App Logs');
        fireEvent.press(downloadButton);

        await waitFor(() => {
            expect(RNUtils.createZipFile).toHaveBeenCalledWith(logPaths);
            expect(RNUtils.saveFile).toHaveBeenCalledWith(zipPath);
            expect(deleteFile).toHaveBeenCalledWith(zipPath);
        });
    });

    it('handles errors during zip creation', async () => {
        jest.mocked(RNUtils.createZipFile).mockRejectedValue(new Error('Zip failed'));
        const {getByText} = renderWithIntl(
            <AppLogs/>,
        );

        await waitFor(() => {
            expect(TurboLogger.getLogPaths).toHaveBeenCalled();
        });

        const downloadButton = getByText('Download App Logs');
        fireEvent.press(downloadButton);

        await waitFor(() => {
            expect(RNUtils.createZipFile).toHaveBeenCalled();
            expect(logDebug).toHaveBeenCalledWith('Failed to create save file', new Error('Zip failed'));
            expect(deleteFile).not.toHaveBeenCalled();
        });
    });

    it('handles errors during file deletion', async () => {
        jest.mocked(deleteFile).mockRejectedValue(new Error('Delete failed'));
        const {getByText} = renderWithIntl(
            <AppLogs/>,
        );

        await waitFor(() => {
            expect(TurboLogger.getLogPaths).toHaveBeenCalled();
        });

        const downloadButton = getByText('Download App Logs');
        fireEvent.press(downloadButton);

        await waitFor(() => {
            expect(RNUtils.createZipFile).toHaveBeenCalled();
            expect(deleteFile).toHaveBeenCalled();
            expect(logDebug).toHaveBeenCalledWith('Failed to delete zip file', new Error('Delete failed'));
        });
    });

    it('handles empty log paths', async () => {
        jest.mocked(TurboLogger.getLogPaths).mockResolvedValue([]);
        const {getByText, getByTestId} = renderWithIntl(
            <AppLogs/>,
        );
        await waitForElementToBeRemoved(() => getByTestId('logs-loading'));
        expect(getByText('Download App Logs')).toBeDisabled();
    });
});