metric_rules.go

// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

package internal

import (
	"encoding/json"
	"regexp"
	"sort"
	"strings"
)

type ruleResult int

const (
	ruleMatched ruleResult = iota
	ruleUnmatched
	ruleIgnore
)

type metricRule struct {
	// 'Ignore' indicates if the entire transaction should be discarded if
	// there is a match.  This field is only used by "url_rules" and
	// "transaction_name_rules", not "metric_name_rules".
	Ignore              bool   `json:"ignore"`
	EachSegment         bool   `json:"each_segment"`
	ReplaceAll          bool   `json:"replace_all"`
	Terminate           bool   `json:"terminate_chain"`
	Order               int    `json:"eval_order"`
	OriginalReplacement string `json:"replacement"`
	RawExpr             string `json:"match_expression"`

	// Go's regexp backreferences use '${1}' instead of the Perlish '\1', so
	// we transform the replacement string into the Go syntax and store it
	// here.
	TransformedReplacement string
	re                     *regexp.Regexp
}

// MetricRules is a collection of metric rules.
type MetricRules []*metricRule

// Go's regexp backreferences use `${1}` instead of the Perlish `\1`, so we must
// transform the replacement string.  This is non-trivial: `\1` is a
// backreference but `\\1` is not.  Rather than count the number of back slashes
// preceding the digit, we simply skip rules with tricky replacements.
var (
	transformReplacementAmbiguous   = regexp.MustCompile(`\\\\([0-9]+)`)
	transformReplacementRegex       = regexp.MustCompile(`\\([0-9]+)`)
	transformReplacementReplacement = "$${${1}}"
)

// UnmarshalJSON unmarshals rules from connect reply JSON.
func (rules *MetricRules) UnmarshalJSON(data []byte) (err error) {
	var raw []*metricRule

	if err := json.Unmarshal(data, &raw); nil != err {
		return err
	}

	valid := make(MetricRules, 0, len(raw))

	for _, r := range raw {
		re, err := regexp.Compile("(?i)" + r.RawExpr)
		if err != nil {
			// TODO
			// Warn("unable to compile rule", {
			// 	"match_expression": r.RawExpr,
			// 	"error":            err.Error(),
			// })
			continue
		}

		if transformReplacementAmbiguous.MatchString(r.OriginalReplacement) {
			// TODO
			// Warn("unable to transform replacement", {
			// 	"match_expression": r.RawExpr,
			// 	"replacement":      r.OriginalReplacement,
			// })
			continue
		}

		r.re = re
		r.TransformedReplacement = transformReplacementRegex.ReplaceAllString(r.OriginalReplacement,
			transformReplacementReplacement)
		valid = append(valid, r)
	}

	sort.Sort(valid)

	*rules = valid
	return nil
}

// Len returns the number of rules.
func (rules MetricRules) Len() int {
	return len(rules)
}

// Rules should be applied in increasing order
func (rules MetricRules) Less(i, j int) bool {
	return rules[i].Order < rules[j].Order
}

// Swap is used for sorting.
func (rules MetricRules) Swap(i, j int) {
	rules[i], rules[j] = rules[j], rules[i]
}

func replaceFirst(re *regexp.Regexp, s string, replacement string) (ruleResult, string) {
	// Note that ReplaceAllStringFunc cannot be used here since it does
	// not replace $1 placeholders.
	loc := re.FindStringIndex(s)
	if nil == loc {
		return ruleUnmatched, s
	}
	firstMatch := s[loc[0]:loc[1]]
	firstMatchReplaced := re.ReplaceAllString(firstMatch, replacement)
	return ruleMatched, s[0:loc[0]] + firstMatchReplaced + s[loc[1]:]
}

func (r *metricRule) apply(s string) (ruleResult, string) {
	// Rules are strange, and there is no spec.
	// This code attempts to duplicate the logic of the PHP agent.
	// Ambiguity abounds.

	if r.Ignore {
		if r.re.MatchString(s) {
			return ruleIgnore, ""
		}
		return ruleUnmatched, s
	}

	if r.ReplaceAll {
		if r.re.MatchString(s) {
			return ruleMatched, r.re.ReplaceAllString(s, r.TransformedReplacement)
		}
		return ruleUnmatched, s
	} else if r.EachSegment {
		segments := strings.Split(s, "/")
		applied := make([]string, len(segments))
		result := ruleUnmatched
		for i, segment := range segments {
			var segmentMatched ruleResult
			segmentMatched, applied[i] = replaceFirst(r.re, segment, r.TransformedReplacement)
			if segmentMatched == ruleMatched {
				result = ruleMatched
			}
		}
		return result, strings.Join(applied, "/")
	} else {
		return replaceFirst(r.re, s, r.TransformedReplacement)
	}
}

// Apply applies the rules.
func (rules MetricRules) Apply(input string) string {
	var res ruleResult
	s := input

	for _, rule := range rules {
		res, s = rule.apply(s)

		if ruleIgnore == res {
			return ""
		}
		if (ruleMatched == res) && rule.Terminate {
			break
		}
	}

	return s
}