initial invitations skeleton

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>
This commit is contained in:
Jörn Friedrich Dreyer
2023-03-24 11:42:48 +01:00
committed by Daniël Franke
parent 80098161b9
commit f805cca363
39 changed files with 1679 additions and 0 deletions
@@ -0,0 +1,5 @@
package service
import "errors"
var ErrNotFound = errors.New("query target not found")
@@ -0,0 +1,38 @@
package service
import (
"context"
"github.com/owncloud/ocis/v2/services/invitations/pkg/invitations"
"github.com/owncloud/ocis/v2/services/invitations/pkg/metrics"
"github.com/prometheus/client_golang/prometheus"
)
// NewInstrument returns a service that instruments metrics.
func NewInstrument(next Service, metrics *metrics.Metrics) Service {
return instrument{
next: next,
metrics: metrics,
}
}
type instrument struct {
next Service
metrics *metrics.Metrics
}
// Invite implements the Service interface.
func (i instrument) Invite(ctx context.Context, invitation *invitations.Invitation) (*invitations.Invitation, error) {
timer := prometheus.NewTimer(prometheus.ObserverFunc(func(v float64) {
us := v * 1000000
i.metrics.Latency.WithLabelValues().Observe(us)
i.metrics.Duration.WithLabelValues().Observe(v)
}))
defer timer.ObserveDuration()
i.metrics.Counter.WithLabelValues().Inc()
return i.next.Invite(ctx, invitation)
}
@@ -0,0 +1,30 @@
package service
import (
"context"
"github.com/owncloud/ocis/v2/ocis-pkg/log"
"github.com/owncloud/ocis/v2/services/invitations/pkg/invitations"
)
// NewLogging returns a service that logs messages.
func NewLogging(next Service, logger log.Logger) Service {
return logging{
next: next,
logger: logger,
}
}
type logging struct {
next Service
logger log.Logger
}
// Invite implements the Service interface.
func (l logging) Invite(ctx context.Context, invitation *invitations.Invitation) (*invitations.Invitation, error) {
l.logger.Debug().
Interface("invitation", invitation).
Msg("Invite")
return l.next.Invite(ctx, invitation)
}
@@ -0,0 +1,40 @@
package service
import (
"github.com/owncloud/ocis/v2/ocis-pkg/log"
"github.com/owncloud/ocis/v2/services/invitations/pkg/config"
)
// Option defines a single option function.
type Option func(o *Options)
// Options defines the available options for this package.
type Options struct {
Logger log.Logger
Config *config.Config
}
// newOptions initializes the available default options.
func newOptions(opts ...Option) Options {
opt := Options{}
for _, o := range opts {
o(&opt)
}
return opt
}
// Logger provides a function to set the logger option.
func Logger(val log.Logger) Option {
return func(o *Options) {
o.Logger = val
}
}
// Config provides a function to set the config option.
func Config(val *config.Config) Option {
return func(o *Options) {
o.Config = val
}
}
@@ -0,0 +1,55 @@
package service
import (
"context"
"github.com/owncloud/ocis/v2/ocis-pkg/log"
"github.com/owncloud/ocis/v2/services/invitations/pkg/config"
"github.com/owncloud/ocis/v2/services/invitations/pkg/invitations"
)
const (
OwnCloudInstanceRel = "http://invitations.owncloud/rel/server-instance"
OpenIDConnectRel = "http://openid.net/specs/connect/1.0/issuer"
)
// Service defines the extension handlers.
type Service interface {
// Invite creates a new invitation. Invitation adds an external user to the organization.
//
// When creating a new invitation you have several options available:
// 1. On invitation creation, Microsoft Graph can automatically send an
// invitation email directly to the invited user, or your app can use
// the inviteRedeemUrl returned in the creation response to craft your
// own invitation (through your communication mechanism of choice) to
// the invited user. If you decide to have Microsoft Graph send an
// invitation email automatically, you can control the content and
// language of the email using invitedUserMessageInfo.
// 2. When the user is invited, a user entity (of userType Guest) is
// created and can now be used to control access to resources. The
// invited user has to go through the redemption process to access any
// resources they have been invited to.
Invite(ctx context.Context, invitation *invitations.Invitation) (*invitations.Invitation, error)
}
// New returns a new instance of Service
func New(opts ...Option) (Service, error) {
options := newOptions(opts...)
return svc{
log: options.Logger,
config: options.Config,
}, nil
}
type svc struct {
config *config.Config
log log.Logger
}
// Invite implements the service interface
func (s svc) Invite(ctx context.Context, invitation *invitations.Invitation) (*invitations.Invitation, error) {
return &invitations.Invitation{
InvitedUserDisplayName: "Yay",
}, nil
}
@@ -0,0 +1,31 @@
package service
import (
"context"
"github.com/owncloud/ocis/v2/services/invitations/pkg/invitations"
invitationstracing "github.com/owncloud/ocis/v2/services/invitations/pkg/tracing"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
)
// NewTracing returns a service that instruments traces.
func NewTracing(next Service) Service {
return tracing{
next: next,
}
}
type tracing struct {
next Service
}
// Invite implements the Service interface.
func (t tracing) Invite(ctx context.Context, invitation *invitations.Invitation) (*invitations.Invitation, error) {
ctx, span := invitationstracing.TraceProvider.Tracer("invitations").Start(ctx, "Invite", trace.WithAttributes(
attribute.KeyValue{Key: "invitation", Value: attribute.StringValue(invitation.InvitedUserEmailAddress)},
))
defer span.End()
return t.next.Invite(ctx, invitation)
}