privatebin-mirror/js/test/Helper.js

'use strict';
var common = require('../common');

describe('Helper', function () {
    describe('secondsToHuman', function () {
        jsc.property('returns an array with a number and a word', 'integer', function (number) {
            var result = PrivateBin.Helper.secondsToHuman(number);
            return Array.isArray(result) &&
                result.length === 2 &&
                result[0] === parseInt(result[0], 10) &&
                typeof result[1] === 'string';
        });
        jsc.property('returns seconds on the first array position', 'integer 59', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[0] === number;
        });
        jsc.property('returns seconds on the second array position', 'integer 59', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[1] === 'second';
        });
        jsc.property('returns minutes on the first array position', 'integer 60 3599', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[0] === Math.floor(number / 60);
        });
        jsc.property('returns minutes on the second array position', 'integer 60 3599', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[1] === 'minute';
        });
        jsc.property('returns hours on the first array position', 'integer 3600 86399', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[0] === Math.floor(number / (60 * 60));
        });
        jsc.property('returns hours on the second array position', 'integer 3600 86399', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[1] === 'hour';
        });
        jsc.property('returns days on the first array position', 'integer 86400 5184000', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[0] === Math.floor(number / (60 * 60 * 24));
        });
        jsc.property('returns days on the second array position', 'integer 86400 5184000', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[1] === 'day';
        });
        // max safe integer as per http://ecma262-5.com/ELS5_HTML.htm#Section_8.5
        jsc.property('returns months on the first array position', 'integer 5184000 9007199254740991', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[0] === Math.floor(number / (60 * 60 * 24 * 30));
        });
        jsc.property('returns months on the second array position', 'integer 5184000 9007199254740991', function (number) {
            return PrivateBin.Helper.secondsToHuman(number)[1] === 'month';
        });
    });

    // this test is not yet meaningful using jsdom, as it does not contain getSelection support.
    // TODO: This needs to be tested using a browser.
    describe('selectText', function () {
        this.timeout(30000);
        jsc.property(
            'selection contains content of given ID',
            jsc.nearray(jsc.nearray(common.jscAlnumString())),
            'nearray string',
            function (ids, contents) {
                var html = '',
                    result = true,
                    clean = globalThis.cleanup(html);
                ids.forEach(function(item, i) {
                    html += '<div id="' + item.join('') + '">' + PrivateBin.Helper.htmlEntities(contents[i] || contents[0]) + '</div>';
                });
                // TODO: As per https://github.com/tmpvar/jsdom/issues/321 there is no getSelection in jsdom, yet.
                // Once there is one, uncomment the block below to actually check the result.
                /*
                ids.forEach(function(item, i) {
                    PrivateBin.Helper.selectText(item.join(''));
                    result *= (contents[i] || contents[0]) === window.getSelection().toString();
                });
                */
                clean();
                return Boolean(result);
            }
        );
    });

    describe('urls2links', function () {
        function getTextAsRenderedHtml(stringContent) {
            const tempDiv = document.createElement('div');
            tempDiv.textContent = stringContent;
            return tempDiv.innerHTML;
        }

        this.timeout(30000);
        before(function () {
            cleanup = globalThis.cleanup();
        });

        jsc.property(
            'ignores non-URL content',
            'string',
            function (content) {
                // eslint-disable-next-line no-control-regex
                content = content.replace(/\r|\f/g, '\n').replace(/\u0000|\u000b/g, '');
                let clean = globalThis.cleanup();
                document.body.innerHTML = '<div id="foo"></div>';
                let e = document.getElementById('foo');
                e.textContent = content;
                PrivateBin.Helper.urls2links(e);
                let result = e.textContent;
                clean();
                return content === result;
            }
        );
        jsc.property(
            'replaces URLs with anchors',
            'string',
            common.jscUrl(),
            jsc.array(common.jscHashString()),
            'string',
            function (prefix, url, fragment, postfix) {
                // eslint-disable-next-line no-control-regex
                prefix = prefix.replace(/\r|\f/g, '\n').replace(/\u0000|\u000b/g, '');
                // eslint-disable-next-line no-control-regex
                postfix  = ' ' + postfix.replace(/\r/g, '\n').replace(/\u0000/g, '');
                url.fragment = fragment.join('');
                let urlString = common.urlToString(url),
                    clean = globalThis.cleanup();
                document.body.innerHTML = '<div id="foo"></div>';
                let e = document.getElementById('foo');

                // special cases: When the query string and fragment imply the beginning of an HTML entity, eg. &#0 or &#x
                if (
                    url.query[-1] === '&' &&
                    (parseInt(url.fragment.charAt(0), 10) >= 0 || url.fragment.charAt(0) === 'x')
                ) {
                    url.query.pop();
                    urlString = common.urlToString(url);
                    postfix = '';
                }
                e.textContent = prefix + urlString + postfix;
                PrivateBin.Helper.urls2links(e);

                let result = e.innerHTML;
                clean();

                urlString = getTextAsRenderedHtml(urlString);
                const expected = getTextAsRenderedHtml(prefix) + '<a href="' + urlString + '" target="_blank" rel="nofollow noopener noreferrer">' + urlString + '</a>' + getTextAsRenderedHtml(postfix);
                return expected === result;
            }
        );
        jsc.property(
            'replaces magnet links with anchors',
            'string',
            jsc.array(common.jscQueryString()),
            'string',
            function (prefix, query, postfix) {
                // eslint-disable-next-line no-control-regex
                prefix = prefix.replace(/\r|\f/g, '\n').replace(/\u0000|\u000b/g, '');
                // eslint-disable-next-line no-control-regex
                postfix = ' ' + postfix.replace(/\r/g, '\n').replace(/\u0000/g, '');
                let url  = 'magnet:?' + query.join('').replace(/^&+|&+$/gm, ''),
                    clean = globalThis.cleanup();
                document.body.innerHTML = '<div id="foo"></div>';
                let e = document.getElementById('foo');
                e.textContent = prefix + url + postfix;
                PrivateBin.Helper.urls2links(e);
                let result = e.innerHTML;
                clean();
                url = getTextAsRenderedHtml(url);
                return getTextAsRenderedHtml(prefix) + '<a href="' + url + '" target="_blank" rel="nofollow noopener noreferrer">' + url + '</a>' + getTextAsRenderedHtml(postfix) === result;
            }
        );
    });

    describe('sprintf', function () {
        jsc.property(
            'replaces %s in strings with first given parameter',
            'string',
            '(small nearray) string',
            'string',
            function (prefix, params, postfix) {
                prefix    =    prefix.replace(/%(s|d)/g, '%%');
                params[0] = params[0].replace(/%(s|d)/g, '%%');
                postfix   =   postfix.replace(/%(s|d)/g, '%%');
                var result = prefix + params[0] + postfix;
                params.unshift(prefix + '%s' + postfix);
                return result === PrivateBin.Helper.sprintf.apply(this, params);
            }
        );
        jsc.property(
            'replaces %d in strings with first given parameter',
            'string',
            '(small nearray) nat',
            'string',
            function (prefix, params, postfix) {
                prefix  =  prefix.replace(/%(s|d)/g, '%%');
                postfix = postfix.replace(/%(s|d)/g, '%%');
                var result = prefix + params[0] + postfix;
                params.unshift(prefix + '%d' + postfix);
                return result === PrivateBin.Helper.sprintf.apply(this, params);
            }
        );
        jsc.property(
            'replaces %d in strings with 0 if first parameter is not a number',
            'string',
            '(small nearray) falsy',
            'string',
            function (prefix, params, postfix) {
                prefix  =  prefix.replace(/%(s|d)/g, '%%');
                postfix = postfix.replace(/%(s|d)/g, '%%');
                var result = prefix + '0' + postfix;
                params.unshift(prefix + '%d' + postfix);
                return result === PrivateBin.Helper.sprintf.apply(this, params);
            }
        );
        jsc.property(
            'replaces %d and %s in strings in order',
            'string',
            'nat',
            'string',
            'string',
            'string',
            function (prefix, uint, middle, string, postfix) {
                prefix  =  prefix.replace(/%(s|d)/g, '');
                middle  =  middle.replace(/%(s|d)/g, '');
                postfix = postfix.replace(/%(s|d)/g, '');
                var params = [prefix + '%d' + middle + '%s' + postfix, uint, string],
                    result = prefix + uint + middle + string + postfix;
                return result === PrivateBin.Helper.sprintf.apply(this, params);
            }
        );
        jsc.property(
            'replaces %d and %s in strings in reverse order',
            'string',
            'nat',
            'string',
            'string',
            'string',
            function (prefix, uint, middle, string, postfix) {
                prefix  =  prefix.replace(/%(s|d)/g, '');
                middle  =  middle.replace(/%(s|d)/g, '');
                postfix = postfix.replace(/%(s|d)/g, '');
                var params = [prefix + '%s' + middle + '%d' + postfix, string, uint],
                    result = prefix + string + middle + uint + postfix;
                return result === PrivateBin.Helper.sprintf.apply(this, params);
            }
        );
    });

    describe('getCookie', function () {
        this.timeout(30000);
        before(function () {
            cleanup();
        });

/* TODO test fails since jsDOM version 17 - document.cookie remains empty
        jsc.property(
            'returns the requested cookie',
            jsc.nearray(jsc.nearray(common.jscAlnumString())),
            jsc.nearray(jsc.nearray(common.jscAlnumString())),
            function (labels, values) {
                let selectedKey = '', selectedValue = '';
                const clean = globalThis.cleanup();
                labels.forEach(function(item, i) {
                    const key = item.join(''),
                        value = (values[i] || values[0]).join('');
                    document.cookie = key + '=' + value;
                    if (Math.random() < 1 / i || selectedKey === key)
                    {
                        selectedKey = key;
                        selectedValue = value;
                    }
                });
                const result = PrivateBin.Helper.getCookie(selectedKey);
                PrivateBin.Helper.reset();
                clean();
                return result === selectedValue;
            }
        ); */
    });

    describe('baseUri', function () {
        this.timeout(30000);
        jsc.property(
            'returns the URL without query & fragment',
            common.jscSchemas(false),
            common.jscUrl(),
            function (schema, url) {
                url.schema = schema;
                const fullUrl = common.urlToString(url);
                delete(url.query);
                delete(url.fragment);
                PrivateBin.Helper.reset();
                const expected = common.urlToString(url),
                    clean = globalThis.cleanup('', {url: fullUrl}),
                    result = PrivateBin.Helper.baseUri();
                clean();
                return expected === result;
            }
        );
    });

    describe('htmlEntities', function () {
        before(function () {
            cleanup = globalThis.cleanup();
        });

        jsc.property(
            'removes all HTML entities from any given string',
            'string',
            function (string) {
                var result = PrivateBin.Helper.htmlEntities(string);
                return !(/[<>]/.test(result)) && !(string.indexOf('&') > -1 && !(/&amp;/.test(result)));
            }
        );
    });

    describe('formatBytes', function () {
        jsc.property('returns 0 B for 0 bytes', function () {
            return PrivateBin.Helper.formatBytes(0) === '0 B';
        });

        jsc.property('formats bytes < 1000 as B', function () {
            return PrivateBin.Helper.formatBytes(500) === '500 B';
        });

        jsc.property('formats kilobytes correctly', function () {
            return PrivateBin.Helper.formatBytes(1500) === '1.5 kB';
        });

        jsc.property('formats megabytes correctly', function () {
            return PrivateBin.Helper.formatBytes(2 * 1000 * 1000) === '2 MB';
        });

        jsc.property('formats gigabytes correctly', function () {
            return PrivateBin.Helper.formatBytes(3.45 * 1000 * 1000 * 1000) === '3.45 GB';
        });

        jsc.property('formats terabytes correctly', function () {
            return PrivateBin.Helper.formatBytes(1.75 * 1000 ** 4) === '1.75 TB';
        });

        jsc.property('formats petabytes correctly', function () {
            return PrivateBin.Helper.formatBytes(1.5 * 1000 ** 5) === '1.5 PB';
        });

        jsc.property('formats exabytes correctly', function () {
            return PrivateBin.Helper.formatBytes(1.2345 * 1000 ** 6).startsWith('1.23 EB');
        });

        jsc.property('formats yottabytes correctly', function () {
            return PrivateBin.Helper.formatBytes(1.23 * 1000 ** 8).startsWith('1.23 YB');
        });

        jsc.property('rounds to two decimal places', function () {
            return PrivateBin.Helper.formatBytes(1234567) === '1.23 MB';
        });
    });


    describe('isBootstrap5', function () {
        jsc.property('Bootstrap 5 has been detected', function () {
            global.bootstrap = {};
            return PrivateBin.Helper.isBootstrap5() === true;
        });

        jsc.property('Bootstrap 5 has not been detected', function () {
            delete global.bootstrap;
            return PrivateBin.Helper.isBootstrap5() === false;
        });
    });
});