graphql-validity/src/profiling.ts

Make business logic validation easy on the graphql side without adding any declarations or modifications to the existing graphql schema.

/*!
 * 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.
 */

// The default profiling result display
export let defaultProfilingResultHandler = (profilingData: any, __graphQLValidityRequestId:any) => {
    if (profilingData.length > 0) {
        console.log(JSON.stringify(profilingData, null, 2), __graphQLValidityRequestId);
    }
};

/**
 * Capture profiling info for later processing
 *
 * @param validity - object which stores profiling info
 * @param path - AST path to the field and its resolver
 * @param profile - profiling info collected
 */
export function storeProfilingInfo(validity: any, path: any, profile: any) {
    validity.___profilingData.push({ path, profile });
}