tenant.go

package users

import (
	"context"
	"errors"
	"fmt"
	"sort"
	"strings"

	"github.com/weaveworks/common/user"
)

const (
	GlobalMarkersDir = "__markers__"

	// QuerierMetaCacheDirName is the reserved name of the directory, inside the bucket store
	// sync directory (-blocks-storage.bucket-store.sync-dir), where the querier's bucket-scan
	// blocks finder keeps its own on-disk block-meta caches
	// (<sync-dir>/__querier__/<tenant>/). The querier and the store-gateway can share the sync
	// directory when running in the same process, and each reconciles its own on-disk state
	// against a different view of which tenants are live, so their per-tenant caches must not
	// overlap. Like GlobalMarkersDir, the name is rejected as a tenant ID and skipped by the
	// users scanner, so nothing can treat it as a tenant.
	QuerierMetaCacheDirName = "__querier__"
)

var (
	errTenantIDTooLong        = errors.New("tenant ID is too long: max 150 characters")
	errTenantIDUnsafe         = errors.New("tenant ID is '.' or '..'")
	errTenantIDMarkers        = errors.New("tenant ID '__markers__' is not allowed")
	errTenantIDUserIndex      = errors.New("tenant ID 'user-index.json.gz' is not allowed")
	errTenantIDQuerierMetaDir = errors.New("tenant ID '__querier__' is not allowed")
)

type errTenantIDUnsupportedCharacter struct {
	pos      int
	tenantID string
}

func (e *errTenantIDUnsupportedCharacter) Error() string {
	return fmt.Sprintf(
		"tenant ID '%s' contains unsupported character '%c'",
		e.tenantID,
		e.tenantID[e.pos],
	)
}

const tenantIDsLabelSeparator = "|"

// NormalizeTenantIDs is creating a normalized form by sorting and de-duplicating the list of tenantIDs
func NormalizeTenantIDs(tenantIDs []string) []string {
	sort.Strings(tenantIDs)

	count := len(tenantIDs)
	if count <= 1 {
		return tenantIDs
	}

	posOut := 1
	for posIn := 1; posIn < count; posIn++ {
		if tenantIDs[posIn] != tenantIDs[posIn-1] {
			tenantIDs[posOut] = tenantIDs[posIn]
			posOut++
		}
	}

	return tenantIDs[0:posOut]
}

// ValidTenantID validate tenantID
func ValidTenantID(s string) error {
	// check if it contains invalid runes
	for pos, r := range s {
		if !isSupported(r) {
			return &errTenantIDUnsupportedCharacter{
				tenantID: s,
				pos:      pos,
			}
		}
	}

	if err := CheckTenantIDLength(s); err != nil {
		return err
	}

	if err := CheckTenantIDIsSupported(s); err != nil {
		return err
	}

	return nil
}

func CheckTenantIDLength(s string) error {
	if len(s) > 150 {
		return errTenantIDTooLong
	}

	return nil
}

func CheckTenantIDIsSupported(s string) error {
	// check tenantID is "__markers__"
	if s == GlobalMarkersDir {
		return errTenantIDMarkers
	}

	if s == "user-index.json.gz" {
		return errTenantIDUserIndex
	}

	// check tenantID is the querier's reserved meta cache directory
	if s == QuerierMetaCacheDirName {
		return errTenantIDQuerierMetaDir
	}

	// check tenantID is "." or ".."
	if containsUnsafePathSegments(s) {
		return errTenantIDUnsafe
	}

	return nil
}

func JoinTenantIDs(tenantIDs []string) string {
	return strings.Join(tenantIDs, tenantIDsLabelSeparator)
}

// this checks if a rune is supported in tenant IDs (according to
// https://cortexmetrics.io/docs/guides/limitations/#tenant-id-naming)
func isSupported(c rune) bool {
	// characters
	if ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') {
		return true
	}

	// digits
	if '0' <= c && c <= '9' {
		return true
	}

	// special
	return c == '!' ||
		c == '-' ||
		c == '_' ||
		c == '.' ||
		c == '*' ||
		c == '\'' ||
		c == '(' ||
		c == ')'
}

// TenantIDsFromOrgID extracts different tenants from an orgID string value
//
// ignore stutter warning
//
//nolint:revive
func TenantIDsFromOrgID(orgID string) ([]string, error) {
	return TenantIDs(user.InjectOrgID(context.TODO(), orgID))
}