com.yahoo.bard.webservice.web.MetricParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fili-core Show documentation
Fili web service library provides core capabilities for RESTful aggregation navigation, query planning and metadata
There is a newer version: 1.1.13
// Copyright 2016 Yahoo Inc.
// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms.
package com.yahoo.bard.webservice.web;

import com.yahoo.bard.webservice.config.BardFeatureFlag;

import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.node.ObjectNode;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.HashMap;
import java.util.Map;
import java.util.Stack;

/**
 * This class will separate the metrics and associated filters from metricString.
 * It will then create an array of JSON objects which contains metric name and metric filter as attributes
 */
public class MetricParser {
    private static final Logger LOG = LoggerFactory.getLogger(MetricParser.class);

    /**
     * This function converts the string of metrics extracted from the url into ArrayNode.
     *
     * @param metricString  An Api metric string eg:
     * {@code metricString = metric1(AND(dim1|id-in[a,b],dim2|id-in[c,d])),metric2 }
     *
     * @return A JSONArray constructed from a given metricString. Eg:
     * {@code {[{"filter":{"AND":{"dim2|id-in":["abc","xyz"],"dim3|id-in":["mobile","tablet"]}}, "name":"metric1"},
     * {"filter":{},"name":"metric2"}]}}

     * @throws IllegalArgumentException if metricString is empty or the metricString has unbalanced brackets
     */
    public static ArrayNode generateMetricFilterJsonArray(String metricString) {

        if (
                (BardFeatureFlag.REQUIRE_METRICS_QUERY.isOn() && metricString.isEmpty())
                || !isBracketsBalanced(metricString)
        ) {
            LOG.error("Metrics parameter values are invalid. The string is: " + metricString);
            throw new IllegalArgumentException("Metrics parameter values are invalid. The string is: " + metricString);
        }
        Map mapper = new HashMap<>();

        //modifiedString contains only metric name and '-' separated filter encoded key. Since there is no brackets
        //and filter details, it easy to split by comma. ex: modifiedString=metric1-123,metric2-234
        String[] metrics = encodeMetricFilters(metricString, mapper).split(",");
        if (metrics.length == 1 && metrics[0].isEmpty()) {
            metrics = new String[0];
        }

        //looping each metric in a metrics array
        ArrayNode arrayNode = JsonNodeFactory.instance.arrayNode();
        for (String metric : metrics) {
            //Separating metric and '-' separated filter encode metricFilterArray[0] will be metric name
            //and metricFilterArray[1] will be key of the mapper contains respective filter string of the metric
            String[] metricFilterArray = metric.split("-");
            //Retrieving the filter string from the mapper and creating a metric set with metric as key
            //and filter as value
            String metricFilter = metricFilterArray.length > 1 ? mapper.get("-" + metricFilterArray[1]) : "";

            ObjectNode objectNode = arrayNode.objectNode();
            addJsonFilter(objectNode, metricFilterArray[0], metricFilter);
            arrayNode.add(objectNode);
        }

        return arrayNode;
    }

    /**
     * Add the name and filter of a metric to an ObjectNode.
     * For eg: {"filter":{"AND":"property|id-in:[14,125],country|id-in:[US,IN]},"name":"foo"}
     *
     * @param metricNode  the object node to fill with the name and filter on a metric
     * @param metricName  the name of the metric
     * @param metricFilter  the filter associated with the metric. Could be empty or have a value
     */
    private static void addJsonFilter(ObjectNode metricNode, String metricName, String metricFilter) {
        metricNode.put("name", metricName);
        ObjectNode filterNode = metricNode.putObject("filter");
        if (!metricFilter.isEmpty()) {
            metricFilter = metricFilter.replace("AND", "")
                    .replace("(", "")
                    .replace(")", "");
            filterNode.put("AND", metricFilter);
        }
    }

    /**
     * Returns modified metrics string. Aggregated metric filter details are stripped and stored in mapper.
     * Metric filter is replaced by hashkey which can be used to retrieve the filter from the mapper
     *
     * @param metricString  The metricString from the API request
     * @param mapper  An empty HashMap.  It will have a randomNumber as key and filter for a metric as value
     *
     * @return filter and metric separated string For eg: metric1-1234,metric2-2341
     */
    private static String encodeMetricFilters(String metricString, Map mapper) {
        String finalString = metricString;
        int counter = 0;
        int startIndex = 0;
        int endIndex = 0;
        for (int i = 0; i < metricString.length(); i++) {
            char currentChar = metricString.charAt(i);
            startIndex = (currentChar == '(' && counter == 0) ? i : startIndex;
            counter = (currentChar == '(') ? counter + 1 : counter;
            if (currentChar == ')') {
                endIndex = i;
                counter = counter - 1;
            }
            if (counter == 0 && startIndex != 0) {
                String filterString = metricString.substring(startIndex, endIndex + 1);
                finalString = finalString.replace(filterString, "-" + startIndex);
                mapper.put("-" + startIndex, filterString);
                startIndex = 0;
            }
        }
        return finalString;
    }

    /**
     * Check if the brackets are balanced.
     *
     * @param metricString  The metricString from the API request
     *
     * @return True if the given metricString has balanced brackets and false if the brackets are not balanced
     */
    private static boolean isBracketsBalanced(String metricString) {
        // TODO: Move this to a constant map
        Map brackets = new HashMap<>();
        brackets.put('[', ']');
        brackets.put('(', ')');

        // Use a stack to push in opening brackets and pop closing brackets as we find them
        Stack stack = new Stack<>();
        for (int i = 0; i < metricString.length(); i++) {
            char currentChar = metricString.charAt(i);
            if (brackets.containsKey(currentChar)) {
                // Push new opening bracket
                stack.push(currentChar);
            } else if (brackets.values().contains(currentChar) && (currentChar != brackets.get(stack.pop()))) {
                // Didn't find a matching opening bracket on the top of the stack for the closing bracket
                return false;
            }
        }

        // All matched if there's no un-matched opening brackets
        return stack.empty();
    }
}