Home Reference Source

src/Pipeline/Utils.js

/* ############################################################################
The MIT License (MIT)

Copyright (c) 2019 Van Schroeder
Copyright (c) 2019 Webfreshener, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

############################################################################ */
import {Iterator} from "./Iterator";
import {Pipeline} from "./Pipeline";
import {Validator} from "./Validator";
import {default as DefaultVOSchema} from "../schemas/default-pipe-vo.schema"

/**
 * provides default schema and pass through execution
 * @type {{schema: {$schema: string, $id: string}, exec: (function(*): *)}}
 */
const DefaultPipeTx = {
    schema: DefaultVOSchema,
    exec: (d) => d,
};

/**
 * Fills array to enforce 2 callback minimum
 * @param arr
 * @param value
 * @param min
 * @returns {any[]}
 */
export const fill = (arr, value = ((d) => d), min = 2) => {
    arr = [...arr];
    if (arr.length >= min) {
        return arr;
    }
    return [
        ...(arr = arr || []),
        ...(Array(min - arr.length).fill(value, 0))
    ];
};

/**
 *
 * @param obj
 * @returns {{exec: function}|Iterator|Pipeline|Validator}
 */
export const castToExec = (obj) => {
    if (!obj) {
        return DefaultPipeTx;
    }

    if ((!(obj instanceof Iterator) && !Array.isArray(obj)) && obj["loop"]) {
        obj = new Iterator(...obj);
    }

    if (Array.isArray(obj)) {
        let _k = 0;
        obj.forEach((o) => {
            if (Validator.validateSchemas(o)) {
                obj[_k] = new Validator(o);
            }
            _k++;
        });
        obj = new Iterator(...obj);

    }

    if (obj instanceof Iterator) {
        return new Pipeline({
            exec: (d) => obj.loop(d),
        });
    }

    // -- if is pipeline config item, we normalize for intake
    if ((typeof obj) === "function") {
        return Object.assign({}, DefaultPipeTx, {exec: obj});
    }

    // -- if is pipeline norm,normalized config item, we pass in for intake
    if ((typeof obj.exec) === "function") {
        return Object.assign({}, DefaultPipeTx, obj);
    }

    // -- if Pipeline, our work here is already done
    if (obj instanceof Pipeline) {
        return obj;
    }

    // -- if is JSON-Schema, cast as TxValidator instance
    if (Validator.validateSchemas(obj)) {
        obj = new Validator(obj);
    }

    // -- wraps Validators as executable
    if ((typeof obj["validate"]) === "function") {
        return Object.defineProperties({}, {
            exec: {
                value: (d) => {
                    obj["validate"](d);
                    if (obj.errors) {
                        throw obj.errors;
                    }

                    return d;
                },
                enumerable: true,
                configurable: false,
            },
            schema: {
                get: () => obj.schema,
                enumerable: true,
                configurable: false,
            },
            errors: {
                get: () => obj.errors,
                enumerable: true,
                configurable: false,
            },
        });
    }

    // attempts to map to Tx-able object
    return Object.assign({}, DefaultPipeTx, obj);
};

/**
 *
 * @param cb
 * @returns {function}
 */
export const handleAsync = (cb) => (
    async (d) => await new Promise(
        (resolve) => d.then((_) => resolve(cb(_)))
            .catch((e) => {
                throw e;
            })
    ).catch((e) => { throw e; })
);

/**
 *
 * @param cb
 * @returns {Function}
 */
export const wrapCallback = (cb) => ((dataOrPromise) => {
    if (dataOrPromise instanceof Promise) {
        // delegates Promise
        return handleAsync(dataOrPromise);
    }

    return cb(dataOrPromise)
});

/**
 *
 * @param args
 * @returns {*[]|{schema: {schema, anyOf, $id}, exec: (function(*): *)}[]}
 */
export const mapArgs = (...args) => {
    if (!args.length) {
        return [DefaultPipeTx, DefaultPipeTx];
    }

    // normalizes args list and wraps in pipeline Protocol
    return [...args].map(castToExec);
};