All files / graphql-validity/src validation.ts

100% Statements 37/37
88.89% Branches 32/36
100% Functions 8/8
100% Lines 37/37

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167                                                1x             1x               1x 7x 6x 6x     3x         12x                               15x 2x 2x     13x 3x 3x 3x               10x                 1x 11x   11x 2x 2x     11x                         1x           10x                         10x 10x 10x     10x                       1x         5x   4x 4x   4x 4x 1x 1x       4x  
/*!
 * The MIT License (MIT)
 *
 * Copyright (c) 2017 Vlad Martynenko <vladimir.martynenko.work@gmail.com>
 *
 * 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 { PROFILING_DEBOUNCE_TIME } from "./magic-values";
import {
    ValidityConfig
} from "./helpers";
 
/* An object which stores all validator functions
    required to be executed during graphql request */
export const FieldValidationDefinitions: any = {};
 
/**
 * Builds errors array, using validation results
 *
 * @param validity - an object injected to request at the beginning of the http call
 * @param data - result of graphql call
 */
export function getResponseValidationResults(validity: any, data: any) {
    if (data.errors || (validity && validity.___validationResults && validity.___validationResults.length)) {
        const originalErrors = data.errors || [];
        data.errors =
            (Array.isArray(originalErrors) ? originalErrors : [originalErrors])
                .map((err) => {
                    return processError(err, validity.config);
                })
                .concat(
                    validity.___validationResults.map(
                        (error: Error) => {
                            return {
                                message: processError(error, validity.config).message
                            };
                        })
                );
    }
}
 
/**
 * Masks errors if requests, other way returns original graphql error object
 *
 * @param error - graphql error object
 * @param {ValidityConfig} config - config - setup options for the wrapper function
 * @returns {any} - graphql error object
 */
function processError(error: any, config: ValidityConfig) {
    if (error.name === 'ValidityError' || error.message.indexOf('_Validity_') >= 0) {
        error.message = error.message.slice(10);
        return error;
    }
 
    if (config && config.wrapErrors) {
        Eif (config.unhandledErrorWrapper) {
            const result = config.unhandledErrorWrapper(error);
            return {
                message: result.message,
                path: error.path,
                location: error.location
            };
        }
    }
 
    return error;
}
 
/**
 * Returns lists of graphql validation messages arrays from request object
 *
 * @param request - express request object
 * @returns {validationResults: any[]} - list of validation result messages
 */
export function getValidationResults(validity: any) {
    let validationResults = validity.___validationResults;
 
    if (!validationResults) {
        validity.___validationResults = [];
        validationResults = validity.___validationResults;
    }
 
    return validationResults;
}
 
/**
 * Return list of local and global validators
 *
 * @param field - field which will be validated
 * @param {string} parentTypeName - name of the parent object where field belongs to
 * @param validity - an object injected to request at the beginning of the http call
 *
 * @returns {validators: any[]}
 * - list of local and global validator functions
 */
export function getValidators(
    field: any,
    parentTypeName: string,
    validity: any
) {
    let validators =
        (
            FieldValidationDefinitions['*']
            || []
        ).concat
        (
            FieldValidationDefinitions[field.type]
            || []
        ).concat
        (
            FieldValidationDefinitions[parentTypeName + ':' + field.name]
            || []
        );
 
    Eif (!validity.___globalValidationResultsCaptured) {
        validity.___globalValidationResultsCaptured = true;
        validators = validators.concat(FieldValidationDefinitions['$'] || []);
    }
 
    return validators;
}
 
/**
 * Modifies express response with validation results
 *
 * @param req - express request
 * @param data - response original data
 * @param profilingResultHandler - profiling function
 *
 * @returns {string} - response modified data
 */
export function applyValidation(
    req: any,
    data: any,
    profilingResultHandler: Function
) {
    let result = JSON.parse(data);
 
    const validity = req.__graphQLValidity;
    getResponseValidationResults(validity, result);
 
    setTimeout(() => {
        if (validity && validity.___profilingData) {
            const profilingData = validity.___profilingData;
            profilingResultHandler(profilingData, req.__graphQLValidityRequestId);
        }
    }, PROFILING_DEBOUNCE_TIME);
 
    return JSON.stringify(result);
}