mattermost-mobile/app/utils/images.test.ts

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

import {
    IMAGE_MAX_HEIGHT,
    IMAGE_MIN_DIMENSION,
} from '@constants/image';
import {calculateDimensions, isGifTooLarge} from '@utils/images';

const PORTRAIT_VIEWPORT = 315;

describe('Images calculateDimensions', () => {
    it('image with falsy height should return 0 for height and width', () => {
        const falsyHeights = [0, null, undefined, NaN, '', false];
        falsyHeights.forEach((falsyHeight) => {
            const {height, width} = calculateDimensions(falsyHeight as number, 20, PORTRAIT_VIEWPORT);
            expect(height).toEqual(0);
            expect(width).toEqual(0);
        });
    });

    it('image with falsy width should return 0 for height and width', () => {
        const falsyWidths = [0, null, undefined, NaN, '', false];
        falsyWidths.forEach((falsyWidth) => {
            const {height, width} = calculateDimensions(20, falsyWidth as number, PORTRAIT_VIEWPORT);
            expect(height).toEqual(0);
            expect(width).toEqual(0);
        });
    });

    it('image smaller than 16x16 should return 16x16', () => {
        const {height, width} = calculateDimensions(15, 15, PORTRAIT_VIEWPORT);
        expect(height).toEqual(IMAGE_MIN_DIMENSION);
        expect(width).toEqual(IMAGE_MIN_DIMENSION);
    });

    it('images with height below 16 should return height of 16', () => {
        const {height} = calculateDimensions(15, 100, PORTRAIT_VIEWPORT);
        expect(height).toEqual(IMAGE_MIN_DIMENSION);
    });

    it('images with width below 16 should return width of 16', () => {
        const {width} = calculateDimensions(100, 15, PORTRAIT_VIEWPORT);
        expect(width).toEqual(IMAGE_MIN_DIMENSION);
    });

    it('images with that are 16x16 should return the same size', () => {
        const {height, width} = calculateDimensions(16, 16, PORTRAIT_VIEWPORT);
        expect(height).toEqual(IMAGE_MIN_DIMENSION);
        expect(width).toEqual(IMAGE_MIN_DIMENSION);
    });

    it('images with smaller sizes than the max allowed should return the same size', () => {
        const {height, width} = calculateDimensions(75, 150, PORTRAIT_VIEWPORT);
        expect(height).toEqual(75);
        expect(width).toEqual(150);
    });

    it('images with that have a width of the same size as the viewPort return the same size', () => {
        const {height, width} = calculateDimensions(75, PORTRAIT_VIEWPORT, PORTRAIT_VIEWPORT);
        expect(height).toEqual(75);
        expect(width).toEqual(PORTRAIT_VIEWPORT);
    });

    it('large images with more height than width should return a MAX height of 350', () => {
        const {height} = calculateDimensions(1920, 1080, PORTRAIT_VIEWPORT);
        expect(height).toEqual(IMAGE_MAX_HEIGHT);
    });

    it('large images with more width than height should return the MAX width equal to the viewPort', () => {
        const {width} = calculateDimensions(1080, 1920, PORTRAIT_VIEWPORT);
        expect(width).toEqual(PORTRAIT_VIEWPORT);
    });

    it('large images with the viewPort height defined should return the MAX height equal to the viewPort Height', () => {
        const {height} = calculateDimensions(1920, 1080, PORTRAIT_VIEWPORT, 340);
        expect(height).toEqual(340);
    });

    it('images with height below 16 but setting to 50 will make the width exceed the view port width should remain as is', () => {
        const {height, width} = calculateDimensions(15, 310, PORTRAIT_VIEWPORT);
        expect(height).toEqual(15);
        expect(width).toEqual(310);
    });

    it('Set the viewPort height defined should return the image capped to the viewport', () => {
        const {height} = calculateDimensions(1334, 750, PORTRAIT_VIEWPORT, 500);
        expect(height).toEqual(500);
    });
});

describe('isGifTooLarge', () => {
    const testCases = [
        {
            name: 'no image metadata',
            expected: false,
        },
        {
            name: 'not a gif',
            imageMetadata: {format: 'png', frame_count: 0, height: 1000, width: 1000},
            expected: false,
        },
        {
            name: 'an image without a format/frame count',
            imageMetadata: {height: 1000, width: 1000},
            expected: false,
        },
        {
            name: 'a static gif',
            imageMetadata: {format: 'gif', frame_count: 1, height: 600, width: 500},
            expected: false,
        },
        {
            name: 'a regular animated gif',
            imageMetadata: {format: 'gif', frame_count: 40, height: 600, width: 500},
            expected: false,
        },
        {
            name: 'a very large animated gif',
            imageMetadata: {format: 'gif', frame_count: 40, height: 100000, width: 100000},
            expected: true,
        },
        {
            name: 'a very long animated gif',
            imageMetadata: {format: 'gif', frame_count: 2000, height: 1000, width: 1000},
            expected: true,
        },
    ];

    for (const testCase of testCases) {
        test(testCase.name, () => {
            expect(isGifTooLarge(testCase.imageMetadata)).toBe(testCase.expected);
        });
    }
});