test/packageLogs_spec.js

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import {expect} from 'chai';
import {JSDOM} from 'jsdom';
import 'global-jsdom/register'
import {
    addCallbacks,
    buildPath,
    cbHandlers,
    extractTimeFields,
    filterHandler,
    getLocation,
    getSelector,
    initPackager,
    logs,
    mapHandler,
    packageLog,
    removeCallbacks,
    selectorizePath,
    setLogFilter,
    setLogMapper,
} from '../src/packageLogs';

describe('packageLogs', () => {
    describe('setLogFilter', () => {
        it('assigns the handler to the provided value', () => {
            const func = x => true;
            setLogFilter(func);
            expect(filterHandler).to.equal(func);
        });
        it('allows the handler to be nulled', () => {
            setLogFilter(x => true);
            setLogFilter(null);
            expect(filterHandler).to.equal(null);
        });
    });

    describe('setLogMapper', () => {
        it('assigns the handler to the provided value', () => {
            const func = x => true;
            setLogMapper(func);
            expect(mapHandler).to.equal(func);
        });
        it('allows the handler to be nulled', () => {
            setLogMapper(x => true);
            setLogMapper(null);
            expect(mapHandler).to.equal(null);
        });
    });
    
    describe('addCallbacks', () => {
        it('adds a single callback', () => {
            initPackager([], {on: false});
            const fn = {
                func1() {return true}
            };
            addCallbacks(fn);
            expect(Object.keys(cbHandlers)).to.deep.equal(Object.keys(fn));
        });
        it('adds a list of callbacks', () => {
            initPackager([], {on: false});

            const fns = {
                func1() {return true},
                func2() {return false}
            };

            addCallbacks(fns);
            expect(Object.keys(cbHandlers)).to.deep.equal(Object.keys(fns));
        });
    });
    
    describe('removeCallbacks', () => {
        it('removes a single callback', () => {
            initPackager([], {on: false});
            const fn = {func() {return true}}; 
            addCallbacks(fn);
            removeCallbacks(Object.keys(fn));
            expect(cbHandlers).to.be.empty;
        });
        it('removes a list of callbacks', () => {
            initPackager([], {on: false});
            const fns = {
                func1() {return true},
                func2() {return false}
            };
            addCallbacks(fns);
            removeCallbacks(Object.keys(fns));
            expect(cbHandlers).to.be.empty;
        });
    });

    describe('packageLog', () => {
        it('only executes if on', () => {
            initPackager([], {on: true});
            const evt = {target: {}, type: 'test'};
            expect(packageLog(evt)).to.equal(true);

            initPackager([], {on: false});
            expect(packageLog({})).to.equal(false);
        });
        it('calls detailFcn with the event as an argument if provided', () => {
            initPackager([], {on: true});
            let called = false;
            const evt = {target: {}, type: 'test'};
            const detailFcn = (e) => {
                called = true;
                expect(e).to.equal(evt);
            };
            packageLog(evt, detailFcn);
            expect(called).to.equal(true);
        });
        it('packages logs', () => {
            initPackager([], {on: true});
            const evt = {
                target: {},
                type: 'test'
            };
            expect(packageLog(evt)).to.equal(true);
        });

        it('filters logs when a handler is assigned and returns false', () => {
            let filterCalled = false;
            const filter = {
                filterAll() {
                    filterCalled = true;
                    return false;
                }
            };

            const evt = {
                target: {},
                type: 'test',
            };

            initPackager([], {on: true});
            packageLog(evt);

            expect(logs.length).to.equal(1);

            addCallbacks(filter);
            packageLog(evt);

            expect(filterCalled).to.equal(true);
            expect(logs.length).to.equal(1);
        });

        it('assigns logs to the callback\'s return value if a handler is assigned', () => {
            let mapperCalled = false;

            const mappedLog = {type: 'foo'};
            const mapper = {
                mapper() {
                    mapperCalled = true;
                    return mappedLog;
                }
            };

            const evt = {
                target: {},
                type: 'test',
            };

            initPackager([], {on: true});

            addCallbacks(mapper);
            packageLog(evt);

            expect(mapperCalled).to.equal(true);
            expect(logs.indexOf(mappedLog)).to.equal(0);
        });

        it('does not call a subsequent handler if the log is filtered out', () => {
            let mapperCalled = false;
            const filter = () => false;
            const mapper = (log) => {
                mapperCalled = true;
                return log;
            };

            const evt = {
                target: {},
                type: 'test',
            };

            initPackager([], {on: true});
            addCallbacks(filter);
            addCallbacks(mapper);

            packageLog(evt);

            expect(mapperCalled).to.equal(false);
        });

        it('does not attempt to call a non-function filter/mapper', () => {
            const evt = {
                target: {},
                type: 'test',
            };

            initPackager([], {on: true});
            packageLog(evt);
            addCallbacks('foo');
            packageLog(evt);

            expect(logs.length).to.equal(2);
        });
    });

    describe('extractTimeFields', () => {
        it('returns the millisecond and microsecond portions of a timestamp', () => {
            const timeStamp = 123.456;
            const fields = {milli: 123, micro: 0.456};
            const ret = extractTimeFields(timeStamp);

            expect(ret.milli).to.equal(fields.milli);
            expect(ret.micro).to.equal(fields.micro);
        });
        it('sets micro to 0 when no decimal is present', () => {
            const timeStamp = 123;
            const fields = {milli: 123, micro: 0};
            const ret = extractTimeFields(timeStamp);

            expect(ret.milli).to.equal(fields.milli);
            expect(ret.micro).to.equal(fields.micro);
        });
        it('always returns an object', () => {
            const stampVariants = [
                null,
                'foobar',
                {foo: 'bar'},
                undefined,
                ['foo', 'bar'],
                123,
            ];

            stampVariants.forEach((variant) => {
                const ret = extractTimeFields(variant);
                expect(!!ret).to.equal(true);
                expect(typeof ret).to.equal('object');
            });
        });
    });

    describe('getLocation', () => {
        it('returns event page location', () => {
            new JSDOM(``);
            const document = window.document;
            const ele = document.createElement('div');
            // Create a click in the top left corner of the viewport
            const evt = new window.MouseEvent('click', {
                'view': window,
                'bubbles': true,
                'cancelable': true,
                'clientX': 0,
                'clientY': 0,
            });
            document.body.appendChild(ele);
            ele.addEventListener('click', (e) => {
                // Expect the click location to be the top left corner of the viewport
                let expectedLocation = {'x': window.scrollX, 'y': window.scrollY};
                expect(getLocation(e)).to.deep.equal(expectedLocation);
            });
            ele.dispatchEvent(evt);
        });

        it('calculates page location if unavailable', () => {
            new JSDOM(``)
            const document = window.document;
            const ele = document.createElement('div');
            const evt = new window.MouseEvent('click', {
                'view': window,
                'bubbles': true,
                'cancelable': true
            });
            document.body.appendChild(ele);
            ele.addEventListener('click', (e) => {
                document.documentElement.scrollLeft = 0;
                document.documentElement.scrollTop = 0;
                const originalDocument = global.document;
                global.document = document;
                expect(getLocation(e)).to.deep.equal({x: 0, y: 0});
                global.document = originalDocument;
            });
            ele.dispatchEvent(evt);
        });

        it('fails to null', () => {
            let hadError = false;
            try {
                getLocation(null);
            } catch (e) {
                hadError = true;
            }
            expect(hadError).to.equal(true);
        });
    });

    describe('selectorizePath', () => {
        it('returns a new array of the same length provided', () => {
            const arr = [{}, {}];
            const ret = selectorizePath(arr);
            expect(ret).to.be.instanceof(Array);
            expect(ret).to.not.equal(arr);
            expect(ret.length).to.equal(arr.length);
        });
    });

    describe('getSelector', () => {
        it('builds a selector', () => {
            new JSDOM(``)
            const document = window.document;
            const element = document.createElement('div');
            expect(getSelector(element)).to.equal('div');
            element.id = 'bar';
            expect(getSelector(element)).to.equal('div#bar');
            element.removeAttribute('id');
            element.classList.add('baz');
            expect(getSelector(element)).to.equal('div.baz');
            element.id = 'bar';
            expect(getSelector(element)).to.equal('div#bar.baz');
        });
        it('identifies window', () => {
            new JSDOM(``)
            expect(getSelector(window)).to.equal('Window');
        });

        it('handles a non-null unknown value', () => {
            expect(getSelector('foo')).to.equal('Unknown');
        });
    });

    describe('buildPath', () => {
        it('builds a path', () => {
            new JSDOM(``)
            let actualPath
            const document = window.document;
            const ele = document.createElement('div');
            const evt = new window.Event('CustomEvent', {bubbles: true, cancelable: true})
            document.body.appendChild(ele);
            ele.addEventListener('CustomEvent', e => actualPath = buildPath(e))
            ele.dispatchEvent(evt);
            const expectedPath = ['div', 'body', 'html', "#document", "Window"]
            expect(actualPath).to.deep.equal(expectedPath);
        });
    });
});