upstream-ory-keto/internal/relationtuple/uuid_mapping.go

// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0

package relationtuple

import (
	"context"

	"github.com/ory/x/otelx"
	"go.opentelemetry.io/otel/trace"

	"github.com/ory/keto/internal/driver/config"
	"github.com/ory/keto/ketoapi"

	"github.com/gofrs/uuid"
)

type (
	mapperDependencies interface {
		MappingManagerProvider
		config.Provider
	}
	MappingManagerProvider interface {
		MappingManager() MappingManager
	}
	MappingManager interface {
		MapStringsToUUIDs(ctx context.Context, s ...string) ([]uuid.UUID, error)
		MapStringsToUUIDsReadOnly(ctx context.Context, s ...string) ([]uuid.UUID, error)
		MapUUIDsToStrings(ctx context.Context, u ...uuid.UUID) ([]string, error)
	}
	MapperProvider interface {
		Mapper() *Mapper
		ReadOnlyMapper() *Mapper
	}
	Mapper struct {
		D        mapperDependencies
		ReadOnly bool
	}
)

type success struct {
	fs  []func()
	err *error
}

func newSuccess(err *error) *success {
	return &success{
		err: err,
	}
}

func (c *success) do(f func()) {
	c.fs = append(c.fs, f)
}

func (c *success) apply() {
	if *c.err != nil {
		return
	}
	for _, f := range c.fs {
		f()
	}
}

func (m *Mapper) FromQuery(ctx context.Context, apiQuery *ketoapi.RelationQuery) (res *RelationQuery, err error) {
	ctx, span := trace.SpanFromContext(ctx).TracerProvider().Tracer("keto/internal/relationtuple").Start(ctx, "Mapper.FromQuery")
	defer otelx.End(span, &err)

	onSuccess := newSuccess(&err)
	defer onSuccess.apply()

	var s []string
	var u []uuid.UUID
	res = &RelationQuery{
		Relation: apiQuery.Relation,
	}

	nm, err := m.D.Config(ctx).NamespaceManager()
	if err != nil {
		return nil, err
	}

	if apiQuery.Namespace != nil {
		n, err := nm.GetNamespaceByName(ctx, *apiQuery.Namespace)
		if err != nil {
			return nil, err
		}
		res.Namespace = new(n.Name)
	}
	if apiQuery.Object != nil {
		s = append(s, *apiQuery.Object)
		onSuccess.do(func(i int) func() {
			return func() {
				res.Object = new(u[i])
			}
		}(len(s) - 1))
	}
	if apiQuery.SubjectID != nil {
		s = append(s, *apiQuery.SubjectID)
		onSuccess.do(func(i int) func() {
			return func() {
				res.Subject = &SubjectID{u[i]}
			}
		}(len(s) - 1))
	}
	if apiQuery.SubjectSet != nil {
		s = append(s, apiQuery.SubjectSet.Object)
		n, err := nm.GetNamespaceByName(ctx, apiQuery.SubjectSet.Namespace)
		if err != nil {
			return nil, err
		}
		onSuccess.do(func(i int) func() {
			return func() {
				res.Subject = &SubjectSet{
					Namespace: n.Name,
					Object:    u[i],
					Relation:  apiQuery.SubjectSet.Relation,
				}
			}
		}(len(s) - 1))
	}

	if m.ReadOnly {
		u, err = m.D.MappingManager().MapStringsToUUIDsReadOnly(ctx, s...)
	} else {
		u, err = m.D.MappingManager().MapStringsToUUIDs(ctx, s...)
	}
	if err != nil {
		return nil, err
	}
	return res, nil
}

func (m *Mapper) ToQuery(ctx context.Context, q *RelationQuery) (res *ketoapi.RelationQuery, err error) {
	ctx, span := trace.SpanFromContext(ctx).TracerProvider().Tracer("keto/internal/relationtuple").Start(ctx, "Mapper.ToQuery")
	defer otelx.End(span, &err)

	onSuccess := newSuccess(&err)
	defer onSuccess.apply()

	var s []string
	var u []uuid.UUID
	res = &ketoapi.RelationQuery{
		Relation: q.Relation,
	}

	nm, err := m.D.Config(ctx).NamespaceManager()
	if err != nil {
		return nil, err
	}

	if q.Namespace != nil {
		n, err := nm.GetNamespaceByName(ctx, *q.Namespace)
		if err != nil {
			return nil, err
		}
		res.Namespace = new(n.Name)
	}
	if q.Object != nil {
		u = append(u, *q.Object)
		onSuccess.do(func() {
			res.Object = new(s[0])
		})
	}
	if q.Subject != nil {
		switch sub := q.Subject.(type) {
		case *SubjectID:
			u = append(u, sub.ID)
			onSuccess.do(func() {
				res.SubjectID = new(s[len(s)-1])
			})
		case *SubjectSet:
			u = append(u, sub.Object)
			n, err := nm.GetNamespaceByName(ctx, sub.Namespace)
			if err != nil {
				return nil, err
			}
			onSuccess.do(func() {
				res.SubjectSet = &ketoapi.SubjectSet{
					Namespace: n.Name,
					Object:    s[len(s)-1],
					Relation:  sub.Relation,
				}
			})
		}
	}

	s, err = m.D.MappingManager().MapUUIDsToStrings(ctx, u...)
	if err != nil {
		return nil, err
	}
	return res, nil
}

func (m *Mapper) FromTuple(ctx context.Context, ts ...*ketoapi.RelationTuple) (res []*RelationTuple, err error) {
	ctx, span := trace.SpanFromContext(ctx).TracerProvider().Tracer("keto/internal/relationtuple").Start(ctx, "Mapper.FromTuple")
	defer otelx.End(span, &err)

	onSuccess := newSuccess(&err)
	defer onSuccess.apply()

	res = make([]*RelationTuple, 0, len(ts))
	s := make([]string, 0, len(ts)*2)
	var u []uuid.UUID

	nm, err := m.D.Config(ctx).NamespaceManager()
	if err != nil {
		return nil, err
	}

	for _, t := range ts {
		t := t
		n, err := nm.GetNamespaceByName(ctx, t.Namespace)
		if err != nil {
			return nil, err
		}
		mt := RelationTuple{
			Namespace: n.Name,
			Relation:  t.Relation,
		}
		i := len(res)

		if err := t.Validate(); err != nil {
			return nil, err
		}
		if t.SubjectID != nil {
			s = append(s, *t.SubjectID)
			onSuccess.do(func() {
				mt.Subject = &SubjectID{u[i*2]}
			})
		} else if t.SubjectSet != nil {
			n, err := nm.GetNamespaceByName(ctx, t.SubjectSet.Namespace)
			if err != nil {
				return nil, err
			}
			s = append(s, t.SubjectSet.Object)
			onSuccess.do(func() {
				mt.Subject = &SubjectSet{
					Namespace: n.Name,
					Object:    u[i*2],
					Relation:  t.SubjectSet.Relation,
				}
			})
		}

		s = append(s, t.Object)
		onSuccess.do(func() {
			mt.Object = u[i*2+1]
		})

		res = append(res, &mt)
	}

	if m.ReadOnly {
		u, err = m.D.MappingManager().MapStringsToUUIDsReadOnly(ctx, s...)
	} else {
		u, err = m.D.MappingManager().MapStringsToUUIDs(ctx, s...)
	}
	if err != nil {
		return nil, err
	}
	return res, nil
}

func (m *Mapper) ToTuple(ctx context.Context, ts ...*RelationTuple) (res []*ketoapi.RelationTuple, err error) {
	ctx, span := trace.SpanFromContext(ctx).TracerProvider().Tracer("keto/internal/relationtuple").Start(ctx, "Mapper.ToTuple")
	defer otelx.End(span, &err)

	onSuccess := newSuccess(&err)
	defer onSuccess.apply()

	res = make([]*ketoapi.RelationTuple, 0, len(ts))
	u := make([]uuid.UUID, 0, len(ts)*2)
	var s []string

	for _, t := range ts {
		mt := ketoapi.RelationTuple{
			Namespace: t.Namespace,
			Relation:  t.Relation,
		}
		i := len(res)

		switch sub := t.Subject.(type) {
		case *SubjectID:
			u = append(u, sub.ID)
			onSuccess.do(func() {
				mt.SubjectID = new(s[2*i])
			})
		case *SubjectSet:
			u = append(u, sub.Object)
			onSuccess.do(func() {
				mt.SubjectSet = &ketoapi.SubjectSet{
					Namespace: sub.Namespace,
					Object:    s[2*i],
					Relation:  sub.Relation,
				}
			})
		}

		u = append(u, t.Object)
		onSuccess.do(func() {
			mt.Object = s[2*i+1]
		})

		res = append(res, &mt)
	}

	s, err = m.D.MappingManager().MapUUIDsToStrings(ctx, u...)
	if err != nil {
		return nil, err
	}
	return res, nil
}

func (m *Mapper) FromSubjectSet(ctx context.Context, set *ketoapi.SubjectSet) (_ *SubjectSet, err error) {
	ctx, span := trace.SpanFromContext(ctx).TracerProvider().Tracer("keto/internal/relationtuple").Start(ctx, "Mapper.FromSubjectSet")
	defer otelx.End(span, &err)

	nm, err := m.D.Config(ctx).NamespaceManager()
	if err != nil {
		return nil, err
	}
	n, err := nm.GetNamespaceByName(ctx, set.Namespace)
	if err != nil {
		return nil, err
	}
	var u []uuid.UUID
	if m.ReadOnly {
		u, err = m.D.MappingManager().MapStringsToUUIDsReadOnly(ctx, set.Object)
	} else {
		u, err = m.D.MappingManager().MapStringsToUUIDs(ctx, set.Object)
	}
	if err != nil {
		return nil, err
	}
	return &SubjectSet{
		Namespace: n.Name,
		Object:    u[0],
		Relation:  set.Relation,
	}, nil
}

func (m *Mapper) ToTree(ctx context.Context, tree *Tree) (_ *ketoapi.Tree[*ketoapi.RelationTuple], err error) {
	ctx, span := trace.SpanFromContext(ctx).TracerProvider().Tracer("keto/internal/relationtuple").Start(ctx, "Mapper.ToTree")
	defer otelx.End(span, &err)

	var u []uuid.UUID
	var targets []*string

	// collect walks the tree, and collects the UUIDs and target pointers
	var collect func(*Tree) *ketoapi.Tree[*ketoapi.RelationTuple]
	collect = func(tree *Tree) *ketoapi.Tree[*ketoapi.RelationTuple] {
		res := &ketoapi.Tree[*ketoapi.RelationTuple]{
			Type:     tree.Type,
			Tuple:    &ketoapi.RelationTuple{},
			Children: make([]*ketoapi.Tree[*ketoapi.RelationTuple], len(tree.Children)),
		}

		switch sub := tree.Subject.(type) {
		case *SubjectSet:
			ss := &ketoapi.SubjectSet{
				Namespace: sub.Namespace,
				Relation:  sub.Relation,
			}
			res.Tuple.SubjectSet = ss
			targets = append(targets, &ss.Object)
			u = append(u, sub.Object)
		case *SubjectID:
			res.Tuple.SubjectID = new(string)
			targets = append(targets, res.Tuple.SubjectID)
			u = append(u, sub.ID)
		}

		for i, c := range tree.Children {
			res.Children[i] = collect(c)
		}

		// to support backward compatibility: Nodes without children were always treated as Leaf,
		// even if the type is Union or Intersection. Keep the backward compatibility on api level.
		if len(res.Children) == 0 {
			res.Type = ketoapi.TreeNodeLeaf
		}
		return res
	}

	res := collect(tree)

	s, err := m.D.MappingManager().MapUUIDsToStrings(ctx, u...)
	if err != nil {
		return nil, err
	}

	for i, ptr := range targets {
		*ptr = s[i]
	}
	return res, nil
}