mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-09-17 08:10:38 -04:00
Introducing gowrap as a build-time tool to generate interface delegate structs from templates: * added as a 'make go-generate' target in services/graph, * added as a build-time dependency in .bingo/ Introduce an LDAP client abstraction interface to be able to wrap the go-ldap client API with metrics transparently (and possibly hooks and such in the future), in order to use delegation patterns to measure the time LDAP (client) operations take to finish, as well as to track their results (success, failure, not-found). Has two implementations that are generated using gowrap: * a go-ldap adapter implementation that directly delegates to a go-ldap connection * a time measuring and metrics collecting implementation that delegates to another LdapClient The metrics collecting one is disabled by default, can be enabled with GRAPH_LDAP_METRICS_DISABLE=false It collects durations of outbound LDAP client operations into a histogram, as well as the number of concurrent outbound LDAP operations in a gauge (via an atomic int and a gauge function, as that performs best). Add an HTTP middleware that measures how long Graph HTTP API requests take, storing taken time into a histogram along with labels for * method, * path pattern (from the chi routes), * Graph API version prefix, * Graph API resource name, * and the resulting status code. It also tracks the number of concurrent inbound Graph API HTTP requests using a gauge (also using an atomic int and a gauge function). Disabled by default, can be enabled with GRAPH_HTTP_METRICS_DISABLE=false Add Backend and EducationBackend delegate implementations that measure execution time on the level of the higher API call operations there (CreateUser, DeleteUser, ..., CreateSchool, ...), generated using gowrap. Disabled by default, can be enabled with GRAPH_IDENTITY_BACKEND_METRICS_DISABLE=false Also added a small k6 script to produce some read-only load on the Graph API, for a casual test of the metrics, as well as k6 in mise.toml. Make an internal changes to how singular LDAP entry searches work in the LDAP identity backends: * check whether searches for a singular entry returns more than one result, in which case a new error TooManyResults is returned, instead of leaving that undetected, blindly taking the first result, and potentially risking data inconsistencies Improve the loggers in identity backends by adding attributes for their request targets (Reva gateway address or LDAP URI, respectively). Also add a "backend" attribute for all Graph API logs (set to "ldap" or "cs3"), to help debug potential issues, and remove them from all the logger debug calls at the beginning of each LDAP-related function as those should really be part of the logger and set beforehand. The LDAP identity backend logger also has two new attributes to help debugging with logs: * write (bool): whether write operations are enabled * refint (bool): whether refint is enabled or not Also adds a dedicated counter metric for user password change operations. Minor campfire improvements: * add a constructor func for the CS3 backend * add a constructor func for the LDAP backend * in the LDAP identity backend, in searchLDAPEntryByFilter (used by all search/get public functions), errors that occur when performing LDAP SEARCH operations were blindly mapped to a ItemNotFound error, instead of being analyzed as it could be caused by a technical error * in the requireadmin middleware, add debug logging to explain why a request is denied * when an LDAP password change fails because the user entry was not found in LDAP, we now have a log message that tracks that
201 lines
5.8 KiB
Go
201 lines
5.8 KiB
Go
package svc
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
|
|
gateway "github.com/cs3org/go-cs3apis/cs3/gateway/v1beta1"
|
|
"github.com/nats-io/nats.go/jetstream"
|
|
"github.com/opencloud-eu/reva/v2/pkg/events"
|
|
"github.com/opencloud-eu/reva/v2/pkg/rgrpc/todo/pool"
|
|
"go.opentelemetry.io/otel/trace"
|
|
|
|
"github.com/opencloud-eu/opencloud/pkg/keycloak"
|
|
"github.com/opencloud-eu/opencloud/pkg/log"
|
|
"github.com/opencloud-eu/opencloud/pkg/roles"
|
|
ehsvc "github.com/opencloud-eu/opencloud/protogen/gen/opencloud/services/eventhistory/v0"
|
|
searchsvc "github.com/opencloud-eu/opencloud/protogen/gen/opencloud/services/search/v0"
|
|
settingssvc "github.com/opencloud-eu/opencloud/protogen/gen/opencloud/services/settings/v0"
|
|
"github.com/opencloud-eu/opencloud/services/graph/pkg/config"
|
|
"github.com/opencloud-eu/opencloud/services/graph/pkg/identity"
|
|
"github.com/opencloud-eu/opencloud/services/graph/pkg/metrics"
|
|
)
|
|
|
|
// Option defines a single option function.
|
|
type Option func(o *Options)
|
|
|
|
// Options defines the available options for this package.
|
|
type Options struct {
|
|
Context context.Context
|
|
Logger log.Logger
|
|
Config *config.Config
|
|
Metrics *metrics.Metrics
|
|
Middleware []func(http.Handler) http.Handler
|
|
RequireAdminMiddleware func(http.Handler) http.Handler
|
|
GatewaySelector pool.Selectable[gateway.GatewayAPIClient]
|
|
IdentityBackend identity.Backend
|
|
IdentityEducationBackend identity.EducationBackend
|
|
RoleService RoleService
|
|
UserProfilePhotoService UsersUserProfilePhotoProvider
|
|
PermissionService Permissions
|
|
ValueService settingssvc.ValueService
|
|
RoleManager *roles.Manager
|
|
EventsPublisher events.Publisher
|
|
SearchService searchsvc.SearchProviderService
|
|
KeycloakClient keycloak.Client
|
|
EventHistoryClient ehsvc.EventHistoryService
|
|
TraceProvider trace.TracerProvider
|
|
NatsKeyValue jetstream.KeyValue
|
|
}
|
|
|
|
// newOptions initializes the available default options.
|
|
func newOptions(opts ...Option) Options {
|
|
opt := Options{}
|
|
|
|
for _, o := range opts {
|
|
o(&opt)
|
|
}
|
|
|
|
return opt
|
|
}
|
|
|
|
// Context provides a function to set the context option.
|
|
func Context(ctx context.Context) Option {
|
|
return func(o *Options) {
|
|
o.Context = ctx
|
|
}
|
|
}
|
|
|
|
// 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
|
|
}
|
|
}
|
|
|
|
// Context provides a function to set the context option.
|
|
func Metrics(m *metrics.Metrics) Option {
|
|
return func(o *Options) {
|
|
o.Metrics = m
|
|
}
|
|
}
|
|
|
|
// Middleware provides a function to set the middleware option.
|
|
func Middleware(val ...func(http.Handler) http.Handler) Option {
|
|
return func(o *Options) {
|
|
o.Middleware = val
|
|
}
|
|
}
|
|
|
|
// WithRequireAdminMiddleware provides a function to set the RequireAdminMiddleware option.
|
|
func WithRequireAdminMiddleware(val func(http.Handler) http.Handler) Option {
|
|
return func(o *Options) {
|
|
o.RequireAdminMiddleware = val
|
|
}
|
|
}
|
|
|
|
// WithGatewaySelector provides a function to set the gateway client option.
|
|
func WithGatewaySelector(val pool.Selectable[gateway.GatewayAPIClient]) Option {
|
|
return func(o *Options) {
|
|
o.GatewaySelector = val
|
|
}
|
|
}
|
|
|
|
// WithIdentityBackend provides a function to set the IdentityBackend option.
|
|
func WithIdentityBackend(val identity.Backend) Option {
|
|
return func(o *Options) {
|
|
o.IdentityBackend = val
|
|
}
|
|
}
|
|
|
|
// WithIdentityEducationBackend provides a function to set the IdentityEducationBackend option.
|
|
func WithIdentityEducationBackend(val identity.EducationBackend) Option {
|
|
return func(o *Options) {
|
|
o.IdentityEducationBackend = val
|
|
}
|
|
}
|
|
|
|
// WithNatsKeyValue provides a function to set the NatsKeyValue option.
|
|
func WithNatsKeyValue(val jetstream.KeyValue) Option {
|
|
return func(o *Options) {
|
|
o.NatsKeyValue = val
|
|
}
|
|
}
|
|
|
|
// WithRoleService provides a function to set the RoleService option.
|
|
func WithRoleService(val RoleService) Option {
|
|
return func(o *Options) {
|
|
o.RoleService = val
|
|
}
|
|
}
|
|
|
|
// WithValueService provides a function to set the ValueService option.
|
|
func WithValueService(val settingssvc.ValueService) Option {
|
|
return func(o *Options) {
|
|
o.ValueService = val
|
|
}
|
|
}
|
|
|
|
// WithSearchService provides a function to set the SearchService option.
|
|
func WithSearchService(val searchsvc.SearchProviderService) Option {
|
|
return func(o *Options) {
|
|
o.SearchService = val
|
|
}
|
|
}
|
|
|
|
// PermissionService provides a function to set the PermissionService option.
|
|
func PermissionService(val settingssvc.PermissionService) Option {
|
|
return func(o *Options) {
|
|
o.PermissionService = val
|
|
}
|
|
}
|
|
|
|
// RoleManager provides a function to set the RoleManager option.
|
|
func RoleManager(val *roles.Manager) Option {
|
|
return func(o *Options) {
|
|
o.RoleManager = val
|
|
}
|
|
}
|
|
|
|
// EventsPublisher provides a function to set the EventsPublisher option.
|
|
func EventsPublisher(val events.Publisher) Option {
|
|
return func(o *Options) {
|
|
o.EventsPublisher = val
|
|
}
|
|
}
|
|
|
|
// KeycloakClient provides a function to set the KeycloakCient option.
|
|
func KeycloakClient(val keycloak.Client) Option {
|
|
return func(o *Options) {
|
|
o.KeycloakClient = val
|
|
}
|
|
}
|
|
|
|
// EventHistoryClient provides a function to set the EventHistoryClient option.
|
|
func EventHistoryClient(val ehsvc.EventHistoryService) Option {
|
|
return func(o *Options) {
|
|
o.EventHistoryClient = val
|
|
}
|
|
}
|
|
|
|
// TraceProvider provides a function to set the TraceProvider option.
|
|
func TraceProvider(val trace.TracerProvider) Option {
|
|
return func(o *Options) {
|
|
o.TraceProvider = val
|
|
}
|
|
}
|
|
|
|
// UserProfilePhotoService provides a function to set the UserProfilePhotoService option.
|
|
func UserProfilePhotoService(p UsersUserProfilePhotoProvider) Option {
|
|
return func(o *Options) {
|
|
o.UserProfilePhotoService = p
|
|
}
|
|
}
|