github.com/m3db/m3@v1.5.0/src/query/api/v1/handler/prometheus/handleroptions/fetch_options.go

// Copyright (c) 2019 Uber Technologies, Inc.
//
// 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.

package handleroptions

import (
	"context"
	"encoding/json"
	"fmt"
	"math"
	"net/http"
	"strconv"
	"strings"
	"time"

	"github.com/m3db/m3/src/dbnode/encoding"
	"github.com/m3db/m3/src/dbnode/topology"
	"github.com/m3db/m3/src/metrics/policy"
	"github.com/m3db/m3/src/query/errors"
	"github.com/m3db/m3/src/query/storage"
	"github.com/m3db/m3/src/query/storage/m3/storagemetadata"
	"github.com/m3db/m3/src/query/util"
	xerrors "github.com/m3db/m3/src/x/errors"
	"github.com/m3db/m3/src/x/headers"
	xtime "github.com/m3db/m3/src/x/time"
)

type headerKey string

const (
	// RequestHeaderKey is the key which headers will be added to in the
	// request context.
	RequestHeaderKey headerKey = "RequestHeaderKey"
	// StepParam is the step parameter.
	StepParam = "step"
	// LookbackParam is the lookback parameter.
	LookbackParam = "lookback"
	// TimeoutParam is the timeout parameter.
	TimeoutParam = "timeout"

	requireExhaustiveParam = "requireExhaustive"
	requireNoWaitParam     = "requireNoWait"
	maxInt64               = float64(math.MaxInt64)
	minInt64               = float64(math.MinInt64)
	maxTimeout             = 10 * time.Minute
)

// FetchOptionsBuilder builds fetch options based on a request and default
// config.
type FetchOptionsBuilder interface {
	// NewFetchOptions parses an http request into fetch options.
	NewFetchOptions(
		ctx context.Context,
		req *http.Request,
	) (context.Context, *storage.FetchOptions, error)
}

// FetchOptionsBuilderOptions provides options to use when creating a
// fetch options builder.
type FetchOptionsBuilderOptions struct {
	Limits        FetchOptionsBuilderLimitsOptions
	RestrictByTag *storage.RestrictByTag
	Timeout       time.Duration
}

// Validate validates the fetch options builder options.
func (o FetchOptionsBuilderOptions) Validate() error {
	if o.Limits.InstanceMultiple < 0 || (o.Limits.InstanceMultiple > 0 && o.Limits.InstanceMultiple < 1) {
		return fmt.Errorf("InstanceMultiple must be 0 or >= 1: %v", o.Limits.InstanceMultiple)
	}
	return validateTimeout(o.Timeout)
}

// FetchOptionsBuilderLimitsOptions provides limits options to use when
// creating a fetch options builder.
type FetchOptionsBuilderLimitsOptions struct {
	SeriesLimit                 int
	InstanceMultiple            float32
	DocsLimit                   int
	RangeLimit                  time.Duration
	ReturnedSeriesLimit         int
	ReturnedDatapointsLimit     int
	ReturnedSeriesMetadataLimit int
	RequireExhaustive           bool
	MaxMetricMetadataStats      int
}

type fetchOptionsBuilder struct {
	opts FetchOptionsBuilderOptions
}

// NewFetchOptionsBuilder returns a new fetch options builder.
func NewFetchOptionsBuilder(
	opts FetchOptionsBuilderOptions,
) (FetchOptionsBuilder, error) {
	if err := opts.Validate(); err != nil {
		return nil, err
	}
	return fetchOptionsBuilder{opts: opts}, nil
}

// ParseLimit parses request limit from either header or query string.
func ParseValue(req *http.Request, header, formValue string, defaultValue int) (int, error) {
	if str := req.Header.Get(header); str != "" {
		n, err := strconv.Atoi(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse value: input=%s, err=%w", str, err)
			return 0, err
		}
		return n, nil
	}

	if str := req.FormValue(formValue); str != "" {
		n, err := strconv.Atoi(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse value: input=%s, err=%w", str, err)
			return 0, err
		}
		return n, nil
	}

	return defaultValue, nil
}

// ParseReadConsistencyLevel parses the ReadConsistencyLevel from either header or query string.
func ParseReadConsistencyLevel(
	req *http.Request, header, formValue string,
) (*topology.ReadConsistencyLevel, error) {
	if str := req.Header.Get(header); str != "" {
		v, err := topology.ParseReadConsistencyLevel(str)
		if err != nil {
			return nil, err
		}
		return &v, nil
	}

	if str := req.FormValue(formValue); str != "" {
		v, err := topology.ParseReadConsistencyLevel(str)
		if err != nil {
			return nil, err
		}
		return &v, nil
	}

	return nil, nil
}

// ParseIterateEqualTimestampStrategy parses the IterateEqualTimestampStrategy from either header or query string.
func ParseIterateEqualTimestampStrategy(
	req *http.Request, header, formValue string,
) (*encoding.IterateEqualTimestampStrategy, error) {
	if str := req.Header.Get(header); str != "" {
		v, err := encoding.ParseIterateEqualTimestampStrategy(str)
		if err != nil {
			return nil, err
		}
		return &v, nil
	}

	if str := req.FormValue(formValue); str != "" {
		v, err := encoding.ParseIterateEqualTimestampStrategy(str)
		if err != nil {
			return nil, err
		}
		return &v, nil
	}

	return nil, nil
}

// ParseDurationLimit parses request limit from either header or query string.
func ParseDurationLimit(
	req *http.Request,
	header,
	formValue string,
	defaultLimit time.Duration,
) (time.Duration, error) {
	if str := req.Header.Get(header); str != "" {
		n, err := time.ParseDuration(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse duration limit: input=%s, err=%w", str, err)
			return 0, err
		}
		return n, nil
	}

	if str := req.FormValue(formValue); str != "" {
		n, err := time.ParseDuration(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse duration limit: input=%s, err=%w", str, err)
			return 0, err
		}
		return n, nil
	}

	return defaultLimit, nil
}

// ParseInstanceMultiple parses request instance multiple from header.
func ParseInstanceMultiple(req *http.Request, defaultValue float32) (float32, error) {
	if str := req.Header.Get(headers.LimitInstanceMultipleHeader); str != "" {
		v, err := strconv.ParseFloat(str, 32)
		if err != nil {
			err = fmt.Errorf(
				"could not parse instance multiple: input=%s, err=%w", str, err)
			return 0, err
		}
		return float32(v), nil
	}
	return defaultValue, nil
}

// ParseRequireExhaustive parses request limit require exhaustive from header or
// query string.
func ParseRequireExhaustive(req *http.Request, defaultValue bool) (bool, error) {
	if str := req.Header.Get(headers.LimitRequireExhaustiveHeader); str != "" {
		v, err := strconv.ParseBool(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse limit: input=%s, err=%v", str, err)
			return false, err
		}
		return v, nil
	}

	if str := req.FormValue(requireExhaustiveParam); str != "" {
		v, err := strconv.ParseBool(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse limit: input=%s, err=%v", str, err)
			return false, err
		}
		return v, nil
	}

	return defaultValue, nil
}

// ParseRequireNoWait parses the no-wait behavior from header or
// query string.
func ParseRequireNoWait(req *http.Request) (bool, error) {
	if str := req.Header.Get(headers.LimitRequireNoWaitHeader); str != "" {
		v, err := strconv.ParseBool(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse no-wait: input=%s, err=%w", str, err)
			return false, err
		}
		return v, nil
	}

	if str := req.FormValue(requireNoWaitParam); str != "" {
		v, err := strconv.ParseBool(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse no-wait: input=%s, err=%w", str, err)
			return false, err
		}
		return v, nil
	}

	return false, nil
}

// NewFetchOptions parses an http request into fetch options.
func (b fetchOptionsBuilder) NewFetchOptions(
	ctx context.Context,
	req *http.Request,
) (context.Context, *storage.FetchOptions, error) {
	ctx, fetchOpts, err := b.newFetchOptions(ctx, req)
	if err != nil {
		// Always invalid request if parsing fails params.
		return nil, nil, xerrors.NewInvalidParamsError(err)
	}
	return ctx, fetchOpts, nil
}

func (b fetchOptionsBuilder) newFetchOptions(
	ctx context.Context,
	req *http.Request,
) (context.Context, *storage.FetchOptions, error) {
	fetchOpts := storage.NewFetchOptions()

	if source := req.Header.Get(headers.SourceHeader); len(source) > 0 {
		fetchOpts.Source = []byte(source)
	}

	seriesLimit, err := ParseValue(req, headers.LimitMaxSeriesHeader,
		"limit", b.opts.Limits.SeriesLimit)
	if err != nil {
		return nil, nil, err
	}
	fetchOpts.SeriesLimit = seriesLimit

	instanceMultiple, err := ParseInstanceMultiple(req, b.opts.Limits.InstanceMultiple)
	if err != nil {
		return nil, nil, err
	}
	fetchOpts.InstanceMultiple = instanceMultiple

	docsLimit, err := ParseValue(req, headers.LimitMaxDocsHeader,
		"docsLimit", b.opts.Limits.DocsLimit)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.DocsLimit = docsLimit

	rangeLimit, err := ParseDurationLimit(req, headers.LimitMaxRangeHeader,
		"rangeLimit", b.opts.Limits.RangeLimit)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.RangeLimit = rangeLimit

	returnedSeriesLimit, err := ParseValue(req, headers.LimitMaxReturnedSeriesHeader,
		"returnedSeriesLimit", b.opts.Limits.ReturnedSeriesLimit)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.ReturnedSeriesLimit = returnedSeriesLimit

	returnedDatapointsLimit, err := ParseValue(req, headers.LimitMaxReturnedDatapointsHeader,
		"returnedDatapointsLimit", b.opts.Limits.ReturnedDatapointsLimit)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.ReturnedDatapointsLimit = returnedDatapointsLimit

	returnedSeriesMetadataLimit, err := ParseValue(req, headers.LimitMaxReturnedSeriesMetadataHeader,
		"returnedSeriesMetadataLimit", b.opts.Limits.ReturnedSeriesMetadataLimit)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.ReturnedSeriesMetadataLimit = returnedSeriesMetadataLimit

	returnedMaxMetricMetadataStats, err := ParseValue(req, headers.LimitMaxMetricMetadataStatsHeader,
		"returnedMaxMetricMetadataStats", b.opts.Limits.MaxMetricMetadataStats)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.MaxMetricMetadataStats = returnedMaxMetricMetadataStats

	requireExhaustive, err := ParseRequireExhaustive(req, b.opts.Limits.RequireExhaustive)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.RequireExhaustive = requireExhaustive

	requireNoWait, err := ParseRequireNoWait(req)
	if err != nil {
		return nil, nil, err
	}

	fetchOpts.RequireNoWait = requireNoWait

	readConsistencyLevel, err := ParseReadConsistencyLevel(req, headers.ReadConsistencyLevelHeader,
		"readConsistencyLevel")
	if err != nil {
		return nil, nil, err
	}
	if readConsistencyLevel != nil {
		fetchOpts.ReadConsistencyLevel = readConsistencyLevel
	}

	iterateStrategy, err := ParseIterateEqualTimestampStrategy(req, headers.IterateEqualTimestampStrategyHeader,
		"iterateEqualTimestampStrategyHeader")
	if err != nil {
		return nil, nil, err
	}
	if iterateStrategy != nil {
		fetchOpts.IterateEqualTimestampStrategy = iterateStrategy
	}

	var (
		metricsTypeHeaderFound          bool
		metricsStoragePolicyHeaderFound bool
	)
	if str := req.Header.Get(headers.MetricsTypeHeader); str != "" {
		metricsTypeHeaderFound = true
		mt, err := storagemetadata.ParseMetricsType(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse metrics type: input=%s, err=%v", str, err)
			return nil, nil, err
		}

		fetchOpts.RestrictQueryOptions = newOrExistingRestrictQueryOptions(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByType =
			newOrExistingRestrictQueryOptionsRestrictByType(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByType.MetricsType = mt
	}

	if str := req.Header.Get(headers.MetricsStoragePolicyHeader); str != "" {
		metricsStoragePolicyHeaderFound = true
		sp, err := policy.ParseStoragePolicy(str)
		if err != nil {
			err = fmt.Errorf(
				"could not parse storage policy: input=%s, err=%v", str, err)
			return nil, nil, err
		}

		fetchOpts.RestrictQueryOptions = newOrExistingRestrictQueryOptions(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByType =
			newOrExistingRestrictQueryOptionsRestrictByType(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByType.StoragePolicy = sp
	}

	metricsRestrictByStoragePoliciesHeaderFound := false
	if str := req.Header.Get(headers.MetricsRestrictByStoragePoliciesHeader); str != "" {
		if metricsTypeHeaderFound || metricsStoragePolicyHeaderFound {
			err = fmt.Errorf(
				"restrict by policies is incompatible with M3-Metrics-Type and M3-Storage-Policy headers")
			return nil, nil, err
		}
		metricsRestrictByStoragePoliciesHeaderFound = true
		policyStrs := strings.Split(str, ";")
		if len(policyStrs) == 0 {
			err = fmt.Errorf(
				"no policies specified with restrict by storage policies header")
			return nil, nil, err
		}
		restrictByTypes := make([]*storage.RestrictByType, 0, len(policyStrs))
		for _, policyStr := range policyStrs {
			sp, err := policy.ParseStoragePolicy(policyStr)
			if err != nil {
				err = fmt.Errorf(
					"could not parse storage policy: input=%s, err=%w", str, err)
				return nil, nil, err
			}
			restrictByTypes = append(
				restrictByTypes,
				&storage.RestrictByType{
					MetricsType:   storagemetadata.AggregatedMetricsType,
					StoragePolicy: sp,
				})
		}

		fetchOpts.RestrictQueryOptions = newOrExistingRestrictQueryOptions(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByTypes =
			newOrExistingRestrictQueryOptionsRestrictByTypes(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByTypes = append(
			fetchOpts.RestrictQueryOptions.RestrictByTypes, restrictByTypes...,
		)
	}

	if str := req.Header.Get(headers.RestrictByTagsJSONHeader); str != "" {
		// Allow header to override any default restrict by tags config.
		var opts StringTagOptions
		if err := json.Unmarshal([]byte(str), &opts); err != nil {
			return nil, nil, err
		}

		tagOpts, err := opts.StorageOptions()
		if err != nil {
			return nil, nil, err
		}

		fetchOpts.RestrictQueryOptions = newOrExistingRestrictQueryOptions(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByTag = tagOpts
	} else if defaultTagOpts := b.opts.RestrictByTag; defaultTagOpts != nil {
		// Apply defaults if not overridden by header.
		fetchOpts.RestrictQueryOptions = newOrExistingRestrictQueryOptions(fetchOpts)
		fetchOpts.RestrictQueryOptions.RestrictByTag = defaultTagOpts
	}

	if restrict := fetchOpts.RestrictQueryOptions; restrict != nil {
		if err := restrict.Validate(); err != nil {
			err = fmt.Errorf(
				"could not validate restrict options: err=%v", err)
			return nil, nil, err
		}
	}

	// NB(r): Eventually all query parameters that are common across the
	// implementations should be parsed here so they can be fed to the engine.
	if step, ok, err := ParseStep(req); err != nil {
		err = fmt.Errorf(
			"could not parse step: err=%v", err)
		return nil, nil, err
	} else if ok {
		fetchOpts.Step = step
	}
	if lookback, ok, err := ParseLookbackDuration(req); err != nil {
		err = fmt.Errorf(
			"could not parse lookback: err=%v", err)
		return nil, nil, err
	} else if ok {
		fetchOpts.LookbackDuration = &lookback
	}

	if relatedQueryOpts, ok, err := ParseRelatedQueryOptions(req); err != nil {
		err = fmt.Errorf(
			"could not parse related query options: err=%w", err)
		return nil, nil, err
	} else if ok {
		if metricsStoragePolicyHeaderFound || metricsTypeHeaderFound || metricsRestrictByStoragePoliciesHeaderFound {
			err = fmt.Errorf(
				"related queries are incompatible with M3-Metrics-Type, " +
					"Restrict-By-Storage-Policies, and M3-Storage-Policy headers")
			return nil, nil, err
		}
		fetchOpts.RelatedQueryOptions = relatedQueryOpts
	}

	fetchOpts.Timeout, err = ParseRequestTimeout(req, b.opts.Timeout)
	if err != nil {
		return nil, nil, fmt.Errorf("could not parse timeout: err=%w", err)
	}

	// Set timeout on the returned context.
	ctx, _ = contextWithRequestAndTimeout(ctx, req, fetchOpts)
	return ctx, fetchOpts, nil
}

func newOrExistingRestrictQueryOptions(
	fetchOpts *storage.FetchOptions,
) *storage.RestrictQueryOptions {
	if v := fetchOpts.RestrictQueryOptions; v != nil {
		return v
	}
	return &storage.RestrictQueryOptions{}
}

func newOrExistingRestrictQueryOptionsRestrictByType(
	fetchOpts *storage.FetchOptions,
) *storage.RestrictByType {
	if v := fetchOpts.RestrictQueryOptions.RestrictByType; v != nil {
		return v
	}
	return &storage.RestrictByType{}
}

func newOrExistingRestrictQueryOptionsRestrictByTypes(
	fetchOpts *storage.FetchOptions,
) []*storage.RestrictByType {
	if v := fetchOpts.RestrictQueryOptions.RestrictByTypes; v != nil {
		return v
	}
	return make([]*storage.RestrictByType, 0)
}

// contextWithRequestAndTimeout sets up a context with the request's context
// and the configured timeout.
func contextWithRequestAndTimeout(
	ctx context.Context,
	r *http.Request,
	opts *storage.FetchOptions,
) (context.Context, context.CancelFunc) {
	ctx = context.WithValue(ctx, RequestHeaderKey, r.Header)
	return context.WithTimeout(ctx, opts.Timeout)
}

// ParseStep parses the step duration for an HTTP request.
func ParseStep(r *http.Request) (time.Duration, bool, error) {
	step := r.FormValue(StepParam)
	if step == "" {
		return 0, false, nil
	}
	value, err := parseStep(r, StepParam)
	if err != nil {
		return 0, false, err
	}
	return value, true, err
}

func parseStep(r *http.Request, key string) (time.Duration, error) {
	step, err := ParseDuration(r, key)
	if err != nil {
		return 0, err
	}
	if step <= 0 {
		return 0, fmt.Errorf("expected postive step size, instead got: %d", step)
	}
	return step, nil
}

// ParseLookbackDuration parses a lookback duration for an HTTP request.
func ParseLookbackDuration(r *http.Request) (time.Duration, bool, error) {
	lookback := r.FormValue(LookbackParam)
	if lookback == "" {
		return 0, false, nil
	}

	if lookback == StepParam {
		// Use the step size as lookback.
		step, err := parseStep(r, StepParam)
		if err != nil {
			return 0, false, err
		}
		return step, true, nil
	}

	// Otherwise it is specified as duration value.
	value, err := parseStep(r, LookbackParam)
	if err != nil {
		return 0, false, err
	}

	return value, true, nil
}

// ParseDuration parses a duration HTTP parameter.
// nolint: unparam
func ParseDuration(r *http.Request, key string) (time.Duration, error) {
	str := strings.TrimSpace(r.FormValue(key))
	if str == "" {
		return 0, errors.ErrNotFound
	}

	value, durationErr := time.ParseDuration(str)
	if durationErr == nil {
		return value, nil
	}

	// Try parsing as a float value specifying seconds, the Prometheus default.
	seconds, floatErr := strconv.ParseFloat(str, 64)
	if floatErr == nil {
		ts := seconds * float64(time.Second)
		if ts > maxInt64 || ts < minInt64 {
			return 0, fmt.Errorf("cannot parse duration='%s': as_float_err="+
				"int64 overflow after float conversion", str)
		}

		return time.Duration(ts), nil
	}

	return 0, fmt.Errorf("cannot parse duration='%s': as_duration_err=%s, as_float_err=%s",
		str, durationErr, floatErr)
}

// ParseRequestTimeout parses the input request timeout with a default.
func ParseRequestTimeout(
	r *http.Request,
	configFetchTimeout time.Duration,
) (time.Duration, error) {
	var timeout string
	if v := r.FormValue(TimeoutParam); v != "" {
		timeout = v
	}
	// Note: Header should take precedence.
	if v := r.Header.Get(TimeoutParam); v != "" {
		timeout = v
	}
	// Prefer the M3-Timeout header to the incorrect header using the param name. The param name should have never been
	// allowed as a header, but we continue to support it for backwards compatibility.
	if v := r.Header.Get(headers.TimeoutHeader); v != "" {
		timeout = v
	}

	if timeout == "" {
		return configFetchTimeout, nil
	}

	duration, err := time.ParseDuration(timeout)
	if err != nil {
		return 0, xerrors.NewInvalidParamsError(
			fmt.Errorf("invalid 'timeout': %v", err))
	}

	if err := validateTimeout(duration); err != nil {
		return 0, err
	}

	return duration, nil
}

// ParseRelatedQueryOptions parses the RelatedQueryOptions struct out of the request
// it returns ok==false if no such options exist
func ParseRelatedQueryOptions(r *http.Request) (*storage.RelatedQueryOptions, bool, error) {
	str := r.Header.Get(headers.RelatedQueriesHeader)
	if str == "" {
		return nil, false, nil
	}

	vals := strings.Split(str, ";")
	queryRanges := make([]storage.QueryTimespan, 0, len(vals))
	for _, headerVal := range vals {
		parts := strings.Split(headerVal, ":")
		if len(parts) != 2 {
			return nil, false, xerrors.NewInvalidParamsError(
				fmt.Errorf("invalid '%s': expected colon-separated pair of start/end timestamps, but got %v",
					headers.RelatedQueriesHeader,
					headerVal))
		}

		startTS, endTS := parts[0], parts[1]
		startTime, err := util.ParseTimeString(startTS)
		if err != nil {
			return nil, false, xerrors.NewInvalidParamsError(
				fmt.Errorf("invalid '%s': Cannot parse %v to time in pair %v",
					headers.RelatedQueriesHeader,
					startTS,
					headerVal))
		}
		endTime, err := util.ParseTimeString(endTS)
		if err != nil {
			return nil, false, xerrors.NewInvalidParamsError(
				fmt.Errorf("invalid '%s': Cannot parse %v to time in pair %v", headers.RelatedQueriesHeader,
					endTS, headerVal))
		}
		if startTime.After(endTime) {
			return nil, false, xerrors.NewInvalidParamsError(
				fmt.Errorf("invalid '%s': startTime after endTime in pair %v", headers.RelatedQueriesHeader,
					headerVal))
		}
		val := storage.QueryTimespan{Start: xtime.ToUnixNano(startTime), End: xtime.ToUnixNano(endTime)}
		queryRanges = append(queryRanges, val)
	}

	return &storage.RelatedQueryOptions{
		Timespans: queryRanges,
	}, true, nil
}

func validateTimeout(v time.Duration) error {
	if v <= 0 {
		return xerrors.NewInvalidParamsError(
			fmt.Errorf("invalid 'timeout': less than or equal to zero %v", v))
	}
	if v > maxTimeout {
		return xerrors.NewInvalidParamsError(
			fmt.Errorf("invalid 'timeout': %v greater than max %v", v, maxTimeout))
	}
	return nil
}