YellowLabTools/lib/rulesChecker.js

var extend = require('util')._extend;

var debug = require('debug')('ylt:ruleschecker');

var RulesChecker = function() {
    'use strict';

    this.check = function(data, policies) {
        /*jshint loopfunc:true */

        var results = {};

        debug('Starting checking rules');

        for (var metricName in policies) {
            var policy = policies[metricName];
            var rule;

            if (policy.tool &&
                data.toolsResults[policy.tool] &&
                data.toolsResults[policy.tool].metrics &&
                (data.toolsResults[policy.tool].metrics[metricName] || data.toolsResults[policy.tool].metrics[metricName] === 0)) {

                    rule = {
                        value: data.toolsResults[policy.tool].metrics[metricName],
                        policy: extend({}, policy) // Clone object policy instead of reference
                    };


                    // Deal with offenders
                    if (policy.hasOffenders) {

                        var offenders = [];

                        // Take DOMqueriesAvoidable's offenders from DOMqueriesDuplicated, for example.
                        if (policy.takeOffendersFrom) {
                            
                            var fromList = policy.takeOffendersFrom;
                            
                            // takeOffendersFrom option can be a string or an array of strings.
                            if (typeof fromList === 'string') {
                                fromList = [fromList];
                            }
                            
                            fromList.forEach(function(from) {
                                if (data.toolsResults[policy.tool] &&
                                        data.toolsResults[policy.tool].offenders &&
                                        data.toolsResults[policy.tool].offenders[from]) {
                                    offenders = offenders.concat(data.toolsResults[policy.tool].offenders[from]);
                                }
                            });

                            data.toolsResults[policy.tool].offenders[metricName] = offenders;

                        } else if (data.toolsResults[policy.tool] &&
                                data.toolsResults[policy.tool].offenders &&
                                data.toolsResults[policy.tool].offenders[metricName]) {
                            offenders = data.toolsResults[policy.tool].offenders[metricName];
                        }

                        var offendersObj = {};
                        
                        // It is possible to declare a transformation function for the offenders.
                        // The function should take an array of strings as single parameter and return a string.
                        if (policy.offendersTransformFn) {

                            try {
                                offendersObj = policy.offendersTransformFn(offenders, rule);
                            } catch(err) {
                                debug('Error while transforming offenders for %s', metricName);
                                debug(err);
                            }
                            
                            delete rule.policy.offendersTransformFn;

                        } else {

                            offendersObj = {
                                count: offenders.length,
                                list: offenders
                            };
                        }

                        rule.offendersObj = offendersObj;
                    }


                    rule.bad = rule.value > policy.isOkThreshold;
                    rule.abnormal = policy.isAbnormalThreshold && rule.value >= policy.isAbnormalThreshold;

                    // A value between 0 (bad) and 100 (very good).
                    var score = (policy.isBadThreshold - rule.value) * 100 / (policy.isBadThreshold - policy.isOkThreshold);
                    rule.score = Math.min(Math.max(Math.round(score), 0), 100);

                    // A value between 0 (abnormal) and negative-infinity (your website is a blackhole)
                    var abnormalityScore = (policy.isAbnormalThreshold - rule.value) * 100 / (policy.isAbnormalThreshold - policy.isOkThreshold);
                    rule.abnormalityScore = Math.min(Math.round(abnormalityScore), 0);

                    results[metricName] = rule;
                    debug('Metric %s calculated. Score: %d', metricName, rule.score);

            
            } else if (policy.scoreFn) {

                debug('Custom score function for %s', metricName);
                
                // Custom score function
                rule = policy.scoreFn(data);

                // Check returned values (if the result is null, just don't save)
                if (rule) {
                    rule.policy = {
                        label: policy.label,
                        message: policy.message,
                        hasOffenders: policy.hasOffenders || false
                    };

                    results[metricName] = rule;
                    debug('Metric %s calculated. Score: %d', metricName, rule.score);
                } else {
                    debug('Metric %s is null. Ignored.', metricName);
                }

            } else {

                debug('Metric %s not found for tool %s', metricName, policy.tool);

            }
        }

        debug('Rules checking finished');

        return results;
    };
};

module.exports = new RulesChecker();