transforms.go

package rollbar

import (
	"context"
	"net/http"
	"net/url"
	"reflect"
	"regexp"
	"runtime"
	"strings"
	"time"
)

// Build the main JSON structure that will be sent to Rollbar with the
// appropriate metadata.
func buildBody(ctx context.Context, configuration configuration, diagnostic diagnostic,
	level, title string, extras map[string]interface{}) map[string]interface{} {

	timestamp := time.Now().Unix()

	data := map[string]interface{}{
		"environment":  configuration.environment,
		"title":        title,
		"level":        level,
		"timestamp":    timestamp,
		"platform":     configuration.platform,
		"language":     "go",
		"code_version": configuration.codeVersion,
		"server": map[string]interface{}{
			"host": configuration.serverHost,
			"root": configuration.serverRoot,
		},
		"notifier": map[string]interface{}{
			"name":    NAME,
			"version": VERSION,
			"diagnostic": map[string]interface{}{
				"languageVersion":   diagnostic.languageVersion,
				"configuredOptions": buildConfiguredOptions(configuration),
			},
		},
	}

	custom := buildCustom(configuration.custom, extras)
	if custom != nil {
		data["custom"] = custom
	}

	person, ok := PersonFromContext(ctx)
	if !ok {
		person = &configuration.person
	}
	if person.Id != "" {
		personData := map[string]string{
			"id":       person.Id,
			"username": person.Username,
			"email":    person.Email,
		}
		for key, value := range person.Extra {
			// If the field on the extra map is already specified then skip it.
			// This will prevent the extra map from overwriting fields like ID, Username or Email.
			if _, ok := personData[key]; !ok {
				personData[key] = value
			}
		}
		data["person"] = personData
	}

	return map[string]interface{}{
		"data": data,
	}
}

func buildCustom(custom map[string]interface{}, extras map[string]interface{}) map[string]interface{} {
	if custom == nil && extras == nil {
		return nil
	}
	m := map[string]interface{}{}
	for k, v := range custom {
		m[k] = v
	}
	for k, v := range extras {
		m[k] = v
	}
	return m
}

func buildConfiguredOptions(configuration configuration) map[string]interface{} {
	return map[string]interface{}{
		"environment":    configuration.environment,
		"endpoint":       configuration.endpoint,
		"platform":       configuration.platform,
		"codeVersion":    configuration.codeVersion,
		"serverHost":     configuration.serverHost,
		"serverRoot":     configuration.serverRoot,
		"fingerprint":    configuration.fingerprint,
		"scrubHeaders":   configuration.scrubHeaders,
		"scrubFields":    configuration.scrubFields,
		"transform":      functionToString(configuration.transform),
		"unwrapper":      functionToString(configuration.unwrapper),
		"stackTracer":    functionToString(configuration.stackTracer),
		"checkIgnore":    functionToString(configuration.checkIgnore),
		"captureIp":      configuration.captureIp,
		"itemsPerMinute": configuration.itemsPerMinute,
		"person": map[string]string{
			"Id":       configuration.person.Id,
			"Username": configuration.person.Username,
			"Email":    configuration.person.Email,
		},
	}
}

func addErrorToBody(configuration configuration, body map[string]interface{}, err error, skip int, telemetry []interface{}) map[string]interface{} {
	data := body["data"].(map[string]interface{})
	errBody, fingerprint := errorBody(configuration, err, skip)
	dataBody := errBody
	dataBody["telemetry"] = telemetry
	data["body"] = dataBody
	if configuration.fingerprint {
		data["fingerprint"] = fingerprint
	}
	return data
}

func requestDetails(configuration configuration, r *http.Request) map[string]interface{} {
	cleanQuery := filterParams(configuration.scrubFields, r.URL.Query())
	specialHeaders := map[string]struct{}{
		"Content-Type": struct{}{},
	}

	return map[string]interface{}{
		"url":     r.URL.String(),
		"method":  r.Method,
		"headers": filterFlatten(configuration.scrubHeaders, r.Header, specialHeaders),

		// GET params
		"query_string": url.Values(cleanQuery).Encode(),
		"GET":          flattenValues(cleanQuery),

		// POST / PUT params
		"POST":    filterFlatten(configuration.scrubFields, r.Form, nil),
		"user_ip": filterIp(remoteIP(r), configuration.captureIp),
	}
}

// remoteIP attempts to extract the real remote IP address by looking first at the headers X-Real-IP
// and X-Forwarded-For, and then falling back to RemoteAddr defined in http.Request
func remoteIP(req *http.Request) string {
	realIP := req.Header.Get("X-Real-IP")
	if realIP != "" {
		return realIP
	}
	forwardedIPs := req.Header.Get("X-Forwarded-For")
	if forwardedIPs != "" {
		ips := strings.Split(forwardedIPs, ", ")
		return ips[0]
	}
	remoteAddr := req.RemoteAddr
	spltRemoteAddr := strings.Split(remoteAddr, ":")
	return spltRemoteAddr[0]
}

// filterFlatten filters sensitive information like passwords from being sent to Rollbar, and
// also lifts any values with length one up to be a standalone string. The optional specialKeys map
// will force strings that exist in that map and also in values to have a single string value in the
// resulting map by taking the first element in the list of strings if there are more than one.
// This is essentially the same as the composition of filterParams and filterValues, plus the bit
// extra about the special keys. The composition would range of the values twice when we really only
// need to do it once, so I decided to combine them as the result is still quite easy to follow.
// We keep the other two so that we can use url.Values.Encode on the filtered query params and not
// run the filtering twice for the query.
func filterFlatten(pattern *regexp.Regexp, values map[string][]string, specialKeys map[string]struct{}) map[string]interface{} {
	result := make(map[string]interface{})

	for k, v := range values {
		switch _, special := specialKeys[k]; {
		case pattern.Match([]byte(k)):
			result[k] = FILTERED
		case special || len(v) == 1:
			result[k] = v[0]
		default:
			result[k] = v
		}
	}

	return result
}

// filterParams filters sensitive information like passwords from being sent to
// Rollbar.
func filterParams(pattern *regexp.Regexp, values map[string][]string) map[string][]string {
	for key := range values {
		if pattern.Match([]byte(key)) {
			values[key] = []string{FILTERED}
		}
	}

	return values
}

// flattenValues takes a map from strings to lists of strings and performs a lift
// on values which have length 1.
func flattenValues(values map[string][]string) map[string]interface{} {
	result := make(map[string]interface{})

	for k, v := range values {
		if len(v) == 1 {
			result[k] = v[0]
		} else {
			result[k] = v
		}
	}

	return result
}

// filterIp takes an ip address string and a capture policy and returns a possibly
// transformed ip address string.
func filterIp(ip string, captureIp captureIp) string {
	switch captureIp {
	case CaptureIpFull:
		return ip
	case CaptureIpAnonymize:
		if strings.Contains(ip, ".") {
			parts := strings.Split(ip, ".")
			parts[len(parts)-1] = "0"
			return strings.Join(parts, ".")
		}
		if strings.Contains(ip, ":") {
			parts := strings.Split(ip, ":")
			if len(parts) > 2 {
				parts = parts[0:3]
				parts = append(parts, "0000:0000:0000:0000:0000")
				return strings.Join(parts, ":")
			}
			return ip
		}
		return ip
	case CaptureIpNone:
		return ""
	default:
		return ""
	}
}

// Build an error inner-body for the given error. If skip is provided, that
// number of stack trace frames will be skipped. If the error has a Cause
// method, the causes will be traversed until nil.
func errorBody(configuration configuration, err error, skip int) (map[string]interface{}, string) {
	var parent error
	// allocate the slice at all times since it will get marshaled into JSON later
	traceChain := []map[string]interface{}{}
	fingerprint := ""
	for {
		stack := buildStack(getOrBuildFrames(err, parent, 1+skip, configuration.stackTracer))
		traceChain = append(traceChain, buildTrace(err, stack))
		if configuration.fingerprint {
			fingerprint = fingerprint + stack.Fingerprint()
		}
		parent = err
		err = configuration.unwrapper(err)
		if err == nil {
			break
		}
	}
	errBody := map[string]interface{}{"trace_chain": traceChain}
	return errBody, fingerprint
}

// builds one trace element in trace_chain
func buildTrace(err error, stack stack) map[string]interface{} {
	message := nilErrTitle
	if err != nil {
		message = err.Error()
	}
	return map[string]interface{}{
		"frames": stack,
		"exception": map[string]interface{}{
			"class":   errorClass(err),
			"message": message,
		},
	}
}

// getOrBuildFrames gets stack frames from errors that provide one of their own
// otherwise, it builds a new stack trace. It returns the stack frames if the error
// is of a compatible type. If the error is not, but the parent error is, it assumes
// the parent error will be processed later and therefore returns nil.
func getOrBuildFrames(err error, parent error, skip int, tracer StackTracerFunc) []runtime.Frame {
	if st, ok := tracer(err); ok && st != nil {
		return st
	}
	if _, ok := tracer(parent); ok {
		return nil
	}

	return getCallersFrames(1 + skip)
}

func getCallersFrames(skip int) []runtime.Frame {
	pc := make([]uintptr, 100)
	runtime.Callers(2+skip, pc)
	fr := runtime.CallersFrames(pc)

	return framesToSlice(fr)
}

// framesToSlice extracts all the runtime.Frame from runtime.Frames.
func framesToSlice(fr *runtime.Frames) []runtime.Frame {
	frames := make([]runtime.Frame, 0)

	for frame, more := fr.Next(); frame != (runtime.Frame{}); frame, more = fr.Next() {
		frames = append(frames, frame)

		if !more {
			break
		}
	}

	return frames
}

// Build a message inner-body for the given message string.
func messageBody(s string) map[string]interface{} {
	return map[string]interface{}{
		"message": map[string]interface{}{
			"body": s,
		},
	}
}

func errorClass(err error) string {
	if err == nil {
		return nilErrTitle
	}

	class := reflect.TypeOf(err).String()
	if class == "" {
		return "panic"
	} else {
		return strings.TrimPrefix(class, "*")
	}
}

func functionToString(function interface{}) string {
	return runtime.FuncForPC(reflect.ValueOf(function).Pointer()).Name()
}