From f896c1a9ac5efd45a859667fd98f25a1684b234b Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Mon, 10 Oct 2022 14:54:35 +0200 Subject: [PATCH 01/22] Fix datarhei/restreamer#425 --- app/api/api.go | 155 +++++++++++++++++++++++++------------------------ 1 file changed, 80 insertions(+), 75 deletions(-) diff --git a/app/api/api.go b/app/api/api.go index 647da500..6daff68f 100644 --- a/app/api/api.go +++ b/app/api/api.go @@ -649,98 +649,102 @@ func (a *api) start() error { var autocertManager *certmagic.Config - if cfg.TLS.Enable && cfg.TLS.Auto { - if len(cfg.Host.Name) == 0 { - return fmt.Errorf("at least one host must be provided in host.name or RS_HOST_NAME") - } + if cfg.TLS.Enable { + if cfg.TLS.Auto { + if len(cfg.Host.Name) == 0 { + return fmt.Errorf("at least one host must be provided in host.name or RS_HOST_NAME") + } - certmagic.DefaultACME.Agreed = true - certmagic.DefaultACME.Email = cfg.TLS.Email - certmagic.DefaultACME.CA = certmagic.LetsEncryptProductionCA - certmagic.DefaultACME.DisableHTTPChallenge = false - certmagic.DefaultACME.DisableTLSALPNChallenge = true - certmagic.DefaultACME.Logger = nil + certmagic.DefaultACME.Agreed = true + certmagic.DefaultACME.Email = cfg.TLS.Email + certmagic.DefaultACME.CA = certmagic.LetsEncryptProductionCA + certmagic.DefaultACME.DisableHTTPChallenge = false + certmagic.DefaultACME.DisableTLSALPNChallenge = true + certmagic.DefaultACME.Logger = nil - certmagic.Default.Storage = &certmagic.FileStorage{ - Path: cfg.DB.Dir + "/cert", - } - certmagic.Default.DefaultServerName = cfg.Host.Name[0] - certmagic.Default.Logger = nil - certmagic.Default.OnEvent = func(event string, data interface{}) { - message := "" - - switch data := data.(type) { - case string: - message = data - case fmt.Stringer: - message = data.String() + certmagic.Default.Storage = &certmagic.FileStorage{ + Path: cfg.DB.Dir + "/cert", } + certmagic.Default.DefaultServerName = cfg.Host.Name[0] + certmagic.Default.Logger = nil + certmagic.Default.OnEvent = func(event string, data interface{}) { + message := "" + + switch data := data.(type) { + case string: + message = data + case fmt.Stringer: + message = data.String() + } - if len(message) != 0 { - a.log.logger.core.WithComponent("certmagic").Info().WithField("event", event).Log(message) + if len(message) != 0 { + a.log.logger.core.WithComponent("certmagic").Info().WithField("event", event).Log(message) + } } - } - magic := certmagic.NewDefault() - acme := certmagic.NewACMEIssuer(magic, certmagic.DefaultACME) + magic := certmagic.NewDefault() + acme := certmagic.NewACMEIssuer(magic, certmagic.DefaultACME) - magic.Issuers = []certmagic.Issuer{acme} + magic.Issuers = []certmagic.Issuer{acme} - autocertManager = magic + autocertManager = magic - // Start temporary http server on configured port - tempserver := &gohttp.Server{ - Addr: cfg.Address, - Handler: acme.HTTPChallengeHandler(gohttp.HandlerFunc(func(w gohttp.ResponseWriter, r *gohttp.Request) { - w.WriteHeader(gohttp.StatusNotFound) - })), - ReadTimeout: 10 * time.Second, - WriteTimeout: 10 * time.Second, - MaxHeaderBytes: 1 << 20, - } + // Start temporary http server on configured port + tempserver := &gohttp.Server{ + Addr: cfg.Address, + Handler: acme.HTTPChallengeHandler(gohttp.HandlerFunc(func(w gohttp.ResponseWriter, r *gohttp.Request) { + w.WriteHeader(gohttp.StatusNotFound) + })), + ReadTimeout: 10 * time.Second, + WriteTimeout: 10 * time.Second, + MaxHeaderBytes: 1 << 20, + } - wg := sync.WaitGroup{} - wg.Add(1) + wg := sync.WaitGroup{} + wg.Add(1) - go func() { - tempserver.ListenAndServe() - wg.Done() - }() + go func() { + tempserver.ListenAndServe() + wg.Done() + }() - var certerror bool + var certerror bool - // For each domain, get the certificate - for _, host := range cfg.Host.Name { - logger := a.log.logger.core.WithComponent("Let's Encrypt").WithField("host", host) - logger.Info().Log("Acquiring certificate ...") + // For each domain, get the certificate + for _, host := range cfg.Host.Name { + logger := a.log.logger.core.WithComponent("Let's Encrypt").WithField("host", host) + logger.Info().Log("Acquiring certificate ...") - ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(5*time.Minute)) + ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(5*time.Minute)) - err := autocertManager.ManageSync(ctx, []string{host}) + err := autocertManager.ManageSync(ctx, []string{host}) - cancel() + cancel() - if err != nil { - logger.Error().WithField("error", err).Log("Failed to acquire certificate") - certerror = true - break - } + if err != nil { + logger.Error().WithField("error", err).Log("Failed to acquire certificate") + certerror = true + break + } - logger.Info().Log("Successfully acquired certificate") - } + logger.Info().Log("Successfully acquired certificate") + } - // Shut down the temporary http server - tempserver.Close() + // Shut down the temporary http server + tempserver.Close() - wg.Wait() + wg.Wait() - if certerror { - a.log.logger.core.Warn().Log("Continuing with disabled TLS") - autocertManager = nil - cfg.TLS.Enable = false + if certerror { + a.log.logger.core.Warn().Log("Continuing with disabled TLS") + autocertManager = nil + cfg.TLS.Enable = false + } else { + cfg.TLS.CertFile = "" + cfg.TLS.KeyFile = "" + } } else { - cfg.TLS.CertFile = "" - cfg.TLS.KeyFile = "" + a.log.logger.core.Info().Log("Enabling TLS with cert and key files") } } @@ -756,14 +760,15 @@ func (a *api) start() error { Collector: a.sessions.Collector("rtmp"), } - if autocertManager != nil && cfg.RTMP.EnableTLS { - config.TLSConfig = &tls.Config{ - GetCertificate: autocertManager.GetCertificate, - } - + if cfg.RTMP.EnableTLS { config.Logger = config.Logger.WithComponent("RTMP/S") a.log.logger.rtmps = a.log.logger.core.WithComponent("RTMPS").WithField("address", cfg.RTMP.AddressTLS) + if autocertManager != nil { + config.TLSConfig = &tls.Config{ + GetCertificate: autocertManager.GetCertificate, + } + } } rtmpserver, err := rtmp.New(config) From 4d4e70571e86dd0a90bdefe96216637f8a93a13f Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Mon, 10 Oct 2022 16:19:45 +0200 Subject: [PATCH 02/22] Fix proper version handling for uploading a new config --- app/api/api.go | 10 +- app/import/main.go | 9 +- app/import/main_test.go | 4 +- config/config.go | 484 ++++------ config/config_test.go | 51 +- config/copy/copy.go | 30 + config/data.go | 138 ++- config/ip.go | 71 -- config/{ => store}/dummy.go | 48 +- config/{ => store}/json.go | 53 +- config/{ => store}/store.go | 16 +- config/types.go | 844 ------------------ config/v1/config.go | 397 ++++++++ config/{data_v1.go => v1/data.go} | 14 +- config/v2/config.go | 398 +++++++++ config/{data_v2.go => v2/data.go} | 120 ++- config/value/auth0.go | 86 ++ config/value/network.go | 269 ++++++ config/value/os.go | 197 ++++ config/value/primitives.go | 264 ++++++ config/value/time.go | 35 + config/value/value.go | 21 + config/{types_test.go => value/value_test.go} | 12 +- config/vars/vars.go | 216 +++++ config/vars/vars_test.go | 40 + http/api/config.go | 78 +- http/handler/api/config.go | 78 +- http/handler/api/config_test.go | 85 +- http/server.go | 4 +- net/ip.go | 70 ++ 30 files changed, 2726 insertions(+), 1416 deletions(-) create mode 100644 config/copy/copy.go delete mode 100644 config/ip.go rename config/{ => store}/dummy.go (53%) rename config/{ => store}/json.go (74%) rename config/{ => store}/store.go (69%) delete mode 100644 config/types.go create mode 100644 config/v1/config.go rename config/{data_v1.go => v1/data.go} (95%) create mode 100644 config/v2/config.go rename config/{data_v2.go => v2/data.go} (64%) create mode 100644 config/value/auth0.go create mode 100644 config/value/network.go create mode 100644 config/value/os.go create mode 100644 config/value/primitives.go create mode 100644 config/value/time.go create mode 100644 config/value/value.go rename config/{types_test.go => value/value_test.go} (82%) create mode 100644 config/vars/vars.go create mode 100644 config/vars/vars_test.go diff --git a/app/api/api.go b/app/api/api.go index 6daff68f..873d7ec5 100644 --- a/app/api/api.go +++ b/app/api/api.go @@ -16,6 +16,8 @@ import ( "github.com/datarhei/core/v16/app" "github.com/datarhei/core/v16/config" + configstore "github.com/datarhei/core/v16/config/store" + configvars "github.com/datarhei/core/v16/config/vars" "github.com/datarhei/core/v16/ffmpeg" "github.com/datarhei/core/v16/http" "github.com/datarhei/core/v16/http/cache" @@ -96,7 +98,7 @@ type api struct { config struct { path string - store config.Store + store configstore.Store config *config.Config } @@ -145,7 +147,7 @@ func (a *api) Reload() error { logger := log.New("Core").WithOutput(log.NewConsoleWriter(a.log.writer, log.Lwarn, true)) - store, err := config.NewJSONStore(a.config.path, func() { + store, err := configstore.NewJSON(a.config.path, func() { a.errorChan <- ErrConfigReload }) if err != nil { @@ -157,7 +159,7 @@ func (a *api) Reload() error { cfg.Merge() if len(cfg.Host.Name) == 0 && cfg.Host.Auto { - cfg.SetPublicIPs() + cfg.Host.Name = net.GetPublicIPs(5 * time.Second) } cfg.Validate(false) @@ -226,7 +228,7 @@ func (a *api) Reload() error { logger.Info().WithFields(logfields).Log("") configlogger := logger.WithComponent("Config") - cfg.Messages(func(level string, v config.Variable, message string) { + cfg.Messages(func(level string, v configvars.Variable, message string) { configlogger = configlogger.WithFields(log.Fields{ "variable": v.Name, "value": v.Value, diff --git a/app/import/main.go b/app/import/main.go index b5b89b24..e70bea5c 100644 --- a/app/import/main.go +++ b/app/import/main.go @@ -4,7 +4,8 @@ import ( "fmt" "os" - "github.com/datarhei/core/v16/config" + cfgstore "github.com/datarhei/core/v16/config/store" + cfgvars "github.com/datarhei/core/v16/config/vars" "github.com/datarhei/core/v16/log" "github.com/datarhei/core/v16/restream/store" @@ -14,7 +15,7 @@ import ( func main() { logger := log.New("Import").WithOutput(log.NewConsoleWriter(os.Stderr, log.Linfo, true)).WithField("version", "v1") - configstore, err := config.NewJSONStore(os.Getenv("CORE_CONFIGFILE"), nil) + configstore, err := cfgstore.NewJSON(os.Getenv("CORE_CONFIGFILE"), nil) if err != nil { logger.Error().WithError(err).Log("Loading configuration failed") os.Exit(1) @@ -25,7 +26,7 @@ func main() { } } -func doImport(logger log.Logger, configstore config.Store) error { +func doImport(logger log.Logger, configstore cfgstore.Store) error { if logger == nil { logger = log.New("") } @@ -41,7 +42,7 @@ func doImport(logger log.Logger, configstore config.Store) error { if cfg.HasErrors() { logger.Error().Log("The configuration contains errors") messages := []string{} - cfg.Messages(func(level string, v config.Variable, message string) { + cfg.Messages(func(level string, v cfgvars.Variable, message string) { if level == "error" { logger.Error().WithFields(log.Fields{ "variable": v.Name, diff --git a/app/import/main_test.go b/app/import/main_test.go index b85bfafe..d389c20e 100644 --- a/app/import/main_test.go +++ b/app/import/main_test.go @@ -3,12 +3,12 @@ package main import ( "testing" - "github.com/datarhei/core/v16/config" + "github.com/datarhei/core/v16/config/store" "github.com/stretchr/testify/require" ) func TestImport(t *testing.T) { - configstore := config.NewDummyStore() + configstore := store.NewDummy() cfg := configstore.Get() diff --git a/config/config.go b/config/config.go index 9086d876..1d1d6732 100644 --- a/config/config.go +++ b/config/config.go @@ -3,60 +3,49 @@ package config import ( "context" - "fmt" "net" - "os" "time" - "github.com/datarhei/core/v16/math/rand" - haikunator "github.com/atrox/haikunatorgo/v2" + "github.com/datarhei/core/v16/config/copy" + "github.com/datarhei/core/v16/config/value" + "github.com/datarhei/core/v16/config/vars" + "github.com/datarhei/core/v16/math/rand" "github.com/google/uuid" ) -const version int64 = 3 +/* +type Config interface { + // Merge merges the values of the known environment variables into the configuration + Merge() -type variable struct { - value value // The actual value - defVal string // The default value in string representation - name string // A name for this value - envName string // The environment variable that corresponds to this value - envAltNames []string // Alternative environment variable names - description string // A desriptions for this value - required bool // Whether a non-empty value is required - disguise bool // Whether the value should be disguised if printed - merged bool // Whether this value has been replaced by its corresponding environment variable -} + // Validate validates the current state of the Config for completeness and sanity. Errors are + // written to the log. Use resetLogs to indicate to reset the logs prior validation. + Validate(resetLogs bool) -type Variable struct { - Value string - Name string - EnvName string - Description string - Merged bool -} + // Messages calls for each log entry the provided callback. The level has the values 'error', 'warn', or 'info'. + // The name is the name of the configuration value, e.g. 'api.auth.enable'. The message is the log message. + Messages(logger func(level string, v vars.Variable, message string)) -type message struct { - message string // The log message - variable Variable // The config field this message refers to - level string // The loglevel for this message -} + // HasErrors returns whether there are some error messages in the log. + HasErrors() bool -type Auth0Tenant struct { - Domain string `json:"domain"` - Audience string `json:"audience"` - ClientID string `json:"clientid"` - Users []string `json:"users"` -} + // Overrides returns a list of configuration value names that have been overriden by an environment variable. + Overrides() []string -type DataVersion struct { - Version int64 `json:"version"` + Get(name string) (string, error) + Set(name, val string) error } +*/ + +const version int64 = 3 + +// Make sure that the config.Config interface is satisfied +//var _ config.Config = &Config{} // Config is a wrapper for Data type Config struct { - vars []*variable - logs []message + vars vars.Variables Data } @@ -70,8 +59,16 @@ func New() *Config { return config } +func (d *Config) Get(name string) (string, error) { + return d.vars.Get(name) +} + +func (d *Config) Set(name, val string) error { + return d.vars.Set(name, val) +} + // NewConfigFrom returns a clone of a Config -func NewConfigFrom(d *Config) *Config { +func (d *Config) Clone() *Config { data := New() data.CreatedAt = d.CreatedAt @@ -100,286 +97,201 @@ func NewConfigFrom(d *Config) *Config { data.Service = d.Service data.Router = d.Router - data.Log.Topics = copyStringSlice(d.Log.Topics) + data.Log.Topics = copy.Slice(d.Log.Topics) - data.Host.Name = copyStringSlice(d.Host.Name) + data.Host.Name = copy.Slice(d.Host.Name) - data.API.Access.HTTP.Allow = copyStringSlice(d.API.Access.HTTP.Allow) - data.API.Access.HTTP.Block = copyStringSlice(d.API.Access.HTTP.Block) - data.API.Access.HTTPS.Allow = copyStringSlice(d.API.Access.HTTPS.Allow) - data.API.Access.HTTPS.Block = copyStringSlice(d.API.Access.HTTPS.Block) + data.API.Access.HTTP.Allow = copy.Slice(d.API.Access.HTTP.Allow) + data.API.Access.HTTP.Block = copy.Slice(d.API.Access.HTTP.Block) + data.API.Access.HTTPS.Allow = copy.Slice(d.API.Access.HTTPS.Allow) + data.API.Access.HTTPS.Block = copy.Slice(d.API.Access.HTTPS.Block) - data.API.Auth.Auth0.Tenants = copyTenantSlice(d.API.Auth.Auth0.Tenants) + data.API.Auth.Auth0.Tenants = copy.TenantSlice(d.API.Auth.Auth0.Tenants) - data.Storage.CORS.Origins = copyStringSlice(d.Storage.CORS.Origins) - data.Storage.Disk.Cache.Types.Allow = copyStringSlice(d.Storage.Disk.Cache.Types.Allow) - data.Storage.Disk.Cache.Types.Block = copyStringSlice(d.Storage.Disk.Cache.Types.Block) + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) + data.Storage.Disk.Cache.Types.Allow = copy.Slice(d.Storage.Disk.Cache.Types.Allow) + data.Storage.Disk.Cache.Types.Block = copy.Slice(d.Storage.Disk.Cache.Types.Block) - data.FFmpeg.Access.Input.Allow = copyStringSlice(d.FFmpeg.Access.Input.Allow) - data.FFmpeg.Access.Input.Block = copyStringSlice(d.FFmpeg.Access.Input.Block) - data.FFmpeg.Access.Output.Allow = copyStringSlice(d.FFmpeg.Access.Output.Allow) - data.FFmpeg.Access.Output.Block = copyStringSlice(d.FFmpeg.Access.Output.Block) + data.FFmpeg.Access.Input.Allow = copy.Slice(d.FFmpeg.Access.Input.Allow) + data.FFmpeg.Access.Input.Block = copy.Slice(d.FFmpeg.Access.Input.Block) + data.FFmpeg.Access.Output.Allow = copy.Slice(d.FFmpeg.Access.Output.Allow) + data.FFmpeg.Access.Output.Block = copy.Slice(d.FFmpeg.Access.Output.Block) - data.Sessions.IPIgnoreList = copyStringSlice(d.Sessions.IPIgnoreList) + data.Sessions.IPIgnoreList = copy.Slice(d.Sessions.IPIgnoreList) - data.SRT.Log.Topics = copyStringSlice(d.SRT.Log.Topics) + data.SRT.Log.Topics = copy.Slice(d.SRT.Log.Topics) - data.Router.BlockedPrefixes = copyStringSlice(d.Router.BlockedPrefixes) - data.Router.Routes = copyStringMap(d.Router.Routes) + data.Router.BlockedPrefixes = copy.Slice(d.Router.BlockedPrefixes) + data.Router.Routes = copy.StringMap(d.Router.Routes) - for i, v := range d.vars { - data.vars[i].merged = v.merged - } + data.vars.Transfer(&d.vars) return data } func (d *Config) init() { - d.val(newInt64Value(&d.Version, version), "version", "", nil, "Configuration file layout version", true, false) - d.val(newTimeValue(&d.CreatedAt, time.Now()), "created_at", "", nil, "Configuration file creation time", false, false) - d.val(newStringValue(&d.ID, uuid.New().String()), "id", "CORE_ID", nil, "ID for this instance", true, false) - d.val(newStringValue(&d.Name, haikunator.New().Haikunate()), "name", "CORE_NAME", nil, "A human readable name for this instance", false, false) - d.val(newAddressValue(&d.Address, ":8080"), "address", "CORE_ADDRESS", nil, "HTTP listening address", false, false) - d.val(newBoolValue(&d.CheckForUpdates, true), "update_check", "CORE_UPDATE_CHECK", nil, "Check for updates and send anonymized data", false, false) + d.vars.Register(value.NewInt64(&d.Version, version), "version", "", nil, "Configuration file layout version", true, false) + d.vars.Register(value.NewTime(&d.CreatedAt, time.Now()), "created_at", "", nil, "Configuration file creation time", false, false) + d.vars.Register(value.NewString(&d.ID, uuid.New().String()), "id", "CORE_ID", nil, "ID for this instance", true, false) + d.vars.Register(value.NewString(&d.Name, haikunator.New().Haikunate()), "name", "CORE_NAME", nil, "A human readable name for this instance", false, false) + d.vars.Register(value.NewAddress(&d.Address, ":8080"), "address", "CORE_ADDRESS", nil, "HTTP listening address", false, false) + d.vars.Register(value.NewBool(&d.CheckForUpdates, true), "update_check", "CORE_UPDATE_CHECK", nil, "Check for updates and send anonymized data", false, false) // Log - d.val(newStringValue(&d.Log.Level, "info"), "log.level", "CORE_LOG_LEVEL", nil, "Loglevel: silent, error, warn, info, debug", false, false) - d.val(newStringListValue(&d.Log.Topics, []string{}, ","), "log.topics", "CORE_LOG_TOPICS", nil, "Show only selected log topics", false, false) - d.val(newIntValue(&d.Log.MaxLines, 1000), "log.max_lines", "CORE_LOG_MAXLINES", nil, "Number of latest log lines to keep in memory", false, false) + d.vars.Register(value.NewString(&d.Log.Level, "info"), "log.level", "CORE_LOG_LEVEL", nil, "Loglevel: silent, error, warn, info, debug", false, false) + d.vars.Register(value.NewStringList(&d.Log.Topics, []string{}, ","), "log.topics", "CORE_LOG_TOPICS", nil, "Show only selected log topics", false, false) + d.vars.Register(value.NewInt(&d.Log.MaxLines, 1000), "log.max_lines", "CORE_LOG_MAXLINES", nil, "Number of latest log lines to keep in memory", false, false) // DB - d.val(newMustDirValue(&d.DB.Dir, "./config"), "db.dir", "CORE_DB_DIR", nil, "Directory for holding the operational data", false, false) + d.vars.Register(value.NewMustDir(&d.DB.Dir, "./config"), "db.dir", "CORE_DB_DIR", nil, "Directory for holding the operational data", false, false) // Host - d.val(newStringListValue(&d.Host.Name, []string{}, ","), "host.name", "CORE_HOST_NAME", nil, "Comma separated list of public host/domain names or IPs", false, false) - d.val(newBoolValue(&d.Host.Auto, true), "host.auto", "CORE_HOST_AUTO", nil, "Enable detection of public IP addresses", false, false) + d.vars.Register(value.NewStringList(&d.Host.Name, []string{}, ","), "host.name", "CORE_HOST_NAME", nil, "Comma separated list of public host/domain names or IPs", false, false) + d.vars.Register(value.NewBool(&d.Host.Auto, true), "host.auto", "CORE_HOST_AUTO", nil, "Enable detection of public IP addresses", false, false) // API - d.val(newBoolValue(&d.API.ReadOnly, false), "api.read_only", "CORE_API_READ_ONLY", nil, "Allow only ready only access to the API", false, false) - d.val(newCIDRListValue(&d.API.Access.HTTP.Allow, []string{}, ","), "api.access.http.allow", "CORE_API_ACCESS_HTTP_ALLOW", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) - d.val(newCIDRListValue(&d.API.Access.HTTP.Block, []string{}, ","), "api.access.http.block", "CORE_API_ACCESS_HTTP_BLOCK", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) - d.val(newCIDRListValue(&d.API.Access.HTTPS.Allow, []string{}, ","), "api.access.https.allow", "CORE_API_ACCESS_HTTPS_ALLOW", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) - d.val(newCIDRListValue(&d.API.Access.HTTPS.Block, []string{}, ","), "api.access.https.block", "CORE_API_ACCESS_HTTPS_BLOCK", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) - d.val(newBoolValue(&d.API.Auth.Enable, false), "api.auth.enable", "CORE_API_AUTH_ENABLE", nil, "Enable authentication for all clients", false, false) - d.val(newBoolValue(&d.API.Auth.DisableLocalhost, false), "api.auth.disable_localhost", "CORE_API_AUTH_DISABLE_LOCALHOST", nil, "Disable authentication for clients from localhost", false, false) - d.val(newStringValue(&d.API.Auth.Username, ""), "api.auth.username", "CORE_API_AUTH_USERNAME", []string{"RS_USERNAME"}, "Username", false, false) - d.val(newStringValue(&d.API.Auth.Password, ""), "api.auth.password", "CORE_API_AUTH_PASSWORD", []string{"RS_PASSWORD"}, "Password", false, true) + d.vars.Register(value.NewBool(&d.API.ReadOnly, false), "api.read_only", "CORE_API_READ_ONLY", nil, "Allow only ready only access to the API", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTP.Allow, []string{}, ","), "api.access.http.allow", "CORE_API_ACCESS_HTTP_ALLOW", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTP.Block, []string{}, ","), "api.access.http.block", "CORE_API_ACCESS_HTTP_BLOCK", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTPS.Allow, []string{}, ","), "api.access.https.allow", "CORE_API_ACCESS_HTTPS_ALLOW", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTPS.Block, []string{}, ","), "api.access.https.block", "CORE_API_ACCESS_HTTPS_BLOCK", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) + d.vars.Register(value.NewBool(&d.API.Auth.Enable, false), "api.auth.enable", "CORE_API_AUTH_ENABLE", nil, "Enable authentication for all clients", false, false) + d.vars.Register(value.NewBool(&d.API.Auth.DisableLocalhost, false), "api.auth.disable_localhost", "CORE_API_AUTH_DISABLE_LOCALHOST", nil, "Disable authentication for clients from localhost", false, false) + d.vars.Register(value.NewString(&d.API.Auth.Username, ""), "api.auth.username", "CORE_API_AUTH_USERNAME", []string{"RS_USERNAME"}, "Username", false, false) + d.vars.Register(value.NewString(&d.API.Auth.Password, ""), "api.auth.password", "CORE_API_AUTH_PASSWORD", []string{"RS_PASSWORD"}, "Password", false, true) // Auth JWT - d.val(newStringValue(&d.API.Auth.JWT.Secret, rand.String(32)), "api.auth.jwt.secret", "CORE_API_AUTH_JWT_SECRET", nil, "JWT secret, leave empty for generating a random value", false, true) + d.vars.Register(value.NewString(&d.API.Auth.JWT.Secret, rand.String(32)), "api.auth.jwt.secret", "CORE_API_AUTH_JWT_SECRET", nil, "JWT secret, leave empty for generating a random value", false, true) // Auth Auth0 - d.val(newBoolValue(&d.API.Auth.Auth0.Enable, false), "api.auth.auth0.enable", "CORE_API_AUTH_AUTH0_ENABLE", nil, "Enable Auth0", false, false) - d.val(newTenantListValue(&d.API.Auth.Auth0.Tenants, []Auth0Tenant{}, ","), "api.auth.auth0.tenants", "CORE_API_AUTH_AUTH0_TENANTS", nil, "List of Auth0 tenants", false, false) + d.vars.Register(value.NewBool(&d.API.Auth.Auth0.Enable, false), "api.auth.auth0.enable", "CORE_API_AUTH_AUTH0_ENABLE", nil, "Enable Auth0", false, false) + d.vars.Register(value.NewTenantList(&d.API.Auth.Auth0.Tenants, []value.Auth0Tenant{}, ","), "api.auth.auth0.tenants", "CORE_API_AUTH_AUTH0_TENANTS", nil, "List of Auth0 tenants", false, false) // TLS - d.val(newAddressValue(&d.TLS.Address, ":8181"), "tls.address", "CORE_TLS_ADDRESS", nil, "HTTPS listening address", false, false) - d.val(newBoolValue(&d.TLS.Enable, false), "tls.enable", "CORE_TLS_ENABLE", nil, "Enable HTTPS", false, false) - d.val(newBoolValue(&d.TLS.Auto, false), "tls.auto", "CORE_TLS_AUTO", nil, "Enable Let's Encrypt certificate", false, false) - d.val(newEmailValue(&d.TLS.Email, "cert@datarhei.com"), "tls.email", "CORE_TLS_EMAIL", nil, "Email for Let's Encrypt registration", false, false) - d.val(newFileValue(&d.TLS.CertFile, ""), "tls.cert_file", "CORE_TLS_CERTFILE", nil, "Path to certificate file in PEM format", false, false) - d.val(newFileValue(&d.TLS.KeyFile, ""), "tls.key_file", "CORE_TLS_KEYFILE", nil, "Path to key file in PEM format", false, false) + d.vars.Register(value.NewAddress(&d.TLS.Address, ":8181"), "tls.address", "CORE_TLS_ADDRESS", nil, "HTTPS listening address", false, false) + d.vars.Register(value.NewBool(&d.TLS.Enable, false), "tls.enable", "CORE_TLS_ENABLE", nil, "Enable HTTPS", false, false) + d.vars.Register(value.NewBool(&d.TLS.Auto, false), "tls.auto", "CORE_TLS_AUTO", nil, "Enable Let's Encrypt certificate", false, false) + d.vars.Register(value.NewEmail(&d.TLS.Email, "cert@datarhei.com"), "tls.email", "CORE_TLS_EMAIL", nil, "Email for Let's Encrypt registration", false, false) + d.vars.Register(value.NewFile(&d.TLS.CertFile, ""), "tls.cert_file", "CORE_TLS_CERTFILE", nil, "Path to certificate file in PEM format", false, false) + d.vars.Register(value.NewFile(&d.TLS.KeyFile, ""), "tls.key_file", "CORE_TLS_KEYFILE", nil, "Path to key file in PEM format", false, false) // Storage - d.val(newFileValue(&d.Storage.MimeTypes, "./mime.types"), "storage.mimetypes_file", "CORE_STORAGE_MIMETYPES_FILE", []string{"CORE_MIMETYPES_FILE"}, "Path to file with mime-types", false, false) + d.vars.Register(value.NewFile(&d.Storage.MimeTypes, "./mime.types"), "storage.mimetypes_file", "CORE_STORAGE_MIMETYPES_FILE", []string{"CORE_MIMETYPES_FILE"}, "Path to file with mime-types", false, false) // Storage (Disk) - d.val(newMustDirValue(&d.Storage.Disk.Dir, "./data"), "storage.disk.dir", "CORE_STORAGE_DISK_DIR", nil, "Directory on disk, exposed on /", false, false) - d.val(newInt64Value(&d.Storage.Disk.Size, 0), "storage.disk.max_size_mbytes", "CORE_STORAGE_DISK_MAXSIZEMBYTES", nil, "Max. allowed megabytes for storage.disk.dir, 0 for unlimited", false, false) - d.val(newBoolValue(&d.Storage.Disk.Cache.Enable, true), "storage.disk.cache.enable", "CORE_STORAGE_DISK_CACHE_ENABLE", nil, "Enable cache for /", false, false) - d.val(newUint64Value(&d.Storage.Disk.Cache.Size, 0), "storage.disk.cache.max_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXSIZEMBYTES", nil, "Max. allowed cache size, 0 for unlimited", false, false) - d.val(newInt64Value(&d.Storage.Disk.Cache.TTL, 300), "storage.disk.cache.ttl_seconds", "CORE_STORAGE_DISK_CACHE_TTLSECONDS", nil, "Seconds to keep files in cache", false, false) - d.val(newUint64Value(&d.Storage.Disk.Cache.FileSize, 1), "storage.disk.cache.max_file_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXFILESIZEMBYTES", nil, "Max. file size to put in cache", false, false) - d.val(newStringListValue(&d.Storage.Disk.Cache.Types.Allow, []string{}, " "), "storage.disk.cache.type.allow", "CORE_STORAGE_DISK_CACHE_TYPES_ALLOW", []string{"CORE_STORAGE_DISK_CACHE_TYPES"}, "File extensions to cache, empty for all", false, false) - d.val(newStringListValue(&d.Storage.Disk.Cache.Types.Block, []string{".m3u8", ".mpd"}, " "), "storage.disk.cache.type.block", "CORE_STORAGE_DISK_CACHE_TYPES_BLOCK", nil, "File extensions not to cache, empty for none", false, false) + d.vars.Register(value.NewMustDir(&d.Storage.Disk.Dir, "./data"), "storage.disk.dir", "CORE_STORAGE_DISK_DIR", nil, "Directory on disk, exposed on /", false, false) + d.vars.Register(value.NewInt64(&d.Storage.Disk.Size, 0), "storage.disk.max_size_mbytes", "CORE_STORAGE_DISK_MAXSIZEMBYTES", nil, "Max. allowed megabytes for storage.disk.dir, 0 for unlimited", false, false) + d.vars.Register(value.NewBool(&d.Storage.Disk.Cache.Enable, true), "storage.disk.cache.enable", "CORE_STORAGE_DISK_CACHE_ENABLE", nil, "Enable cache for /", false, false) + d.vars.Register(value.NewUint64(&d.Storage.Disk.Cache.Size, 0), "storage.disk.cache.max_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXSIZEMBYTES", nil, "Max. allowed cache size, 0 for unlimited", false, false) + d.vars.Register(value.NewInt64(&d.Storage.Disk.Cache.TTL, 300), "storage.disk.cache.ttl_seconds", "CORE_STORAGE_DISK_CACHE_TTLSECONDS", nil, "Seconds to keep files in cache", false, false) + d.vars.Register(value.NewUint64(&d.Storage.Disk.Cache.FileSize, 1), "storage.disk.cache.max_file_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXFILESIZEMBYTES", nil, "Max. file size to put in cache", false, false) + d.vars.Register(value.NewStringList(&d.Storage.Disk.Cache.Types.Allow, []string{}, " "), "storage.disk.cache.type.allow", "CORE_STORAGE_DISK_CACHE_TYPES_ALLOW", []string{"CORE_STORAGE_DISK_CACHE_TYPES"}, "File extensions to cache, empty for all", false, false) + d.vars.Register(value.NewStringList(&d.Storage.Disk.Cache.Types.Block, []string{".m3u8", ".mpd"}, " "), "storage.disk.cache.type.block", "CORE_STORAGE_DISK_CACHE_TYPES_BLOCK", nil, "File extensions not to cache, empty for none", false, false) // Storage (Memory) - d.val(newBoolValue(&d.Storage.Memory.Auth.Enable, true), "storage.memory.auth.enable", "CORE_STORAGE_MEMORY_AUTH_ENABLE", nil, "Enable basic auth for PUT,POST, and DELETE on /memfs", false, false) - d.val(newStringValue(&d.Storage.Memory.Auth.Username, "admin"), "storage.memory.auth.username", "CORE_STORAGE_MEMORY_AUTH_USERNAME", nil, "Username for Basic-Auth of /memfs", false, false) - d.val(newStringValue(&d.Storage.Memory.Auth.Password, rand.StringAlphanumeric(18)), "storage.memory.auth.password", "CORE_STORAGE_MEMORY_AUTH_PASSWORD", nil, "Password for Basic-Auth of /memfs", false, true) - d.val(newInt64Value(&d.Storage.Memory.Size, 0), "storage.memory.max_size_mbytes", "CORE_STORAGE_MEMORY_MAXSIZEMBYTES", nil, "Max. allowed megabytes for /memfs, 0 for unlimited", false, false) - d.val(newBoolValue(&d.Storage.Memory.Purge, false), "storage.memory.purge", "CORE_STORAGE_MEMORY_PURGE", nil, "Automatically remove the oldest files if /memfs is full", false, false) + d.vars.Register(value.NewBool(&d.Storage.Memory.Auth.Enable, true), "storage.memory.auth.enable", "CORE_STORAGE_MEMORY_AUTH_ENABLE", nil, "Enable basic auth for PUT,POST, and DELETE on /memfs", false, false) + d.vars.Register(value.NewString(&d.Storage.Memory.Auth.Username, "admin"), "storage.memory.auth.username", "CORE_STORAGE_MEMORY_AUTH_USERNAME", nil, "Username for Basic-Auth of /memfs", false, false) + d.vars.Register(value.NewString(&d.Storage.Memory.Auth.Password, rand.StringAlphanumeric(18)), "storage.memory.auth.password", "CORE_STORAGE_MEMORY_AUTH_PASSWORD", nil, "Password for Basic-Auth of /memfs", false, true) + d.vars.Register(value.NewInt64(&d.Storage.Memory.Size, 0), "storage.memory.max_size_mbytes", "CORE_STORAGE_MEMORY_MAXSIZEMBYTES", nil, "Max. allowed megabytes for /memfs, 0 for unlimited", false, false) + d.vars.Register(value.NewBool(&d.Storage.Memory.Purge, false), "storage.memory.purge", "CORE_STORAGE_MEMORY_PURGE", nil, "Automatically remove the oldest files if /memfs is full", false, false) // Storage (CORS) - d.val(newCORSOriginsValue(&d.Storage.CORS.Origins, []string{"*"}, ","), "storage.cors.origins", "CORE_STORAGE_CORS_ORIGINS", nil, "Allowed CORS origins for /memfs and /data", false, false) + d.vars.Register(value.NewCORSOrigins(&d.Storage.CORS.Origins, []string{"*"}, ","), "storage.cors.origins", "CORE_STORAGE_CORS_ORIGINS", nil, "Allowed CORS origins for /memfs and /data", false, false) // RTMP - d.val(newBoolValue(&d.RTMP.Enable, false), "rtmp.enable", "CORE_RTMP_ENABLE", nil, "Enable RTMP server", false, false) - d.val(newBoolValue(&d.RTMP.EnableTLS, false), "rtmp.enable_tls", "CORE_RTMP_ENABLE_TLS", nil, "Enable RTMPS server instead of RTMP", false, false) - d.val(newAddressValue(&d.RTMP.Address, ":1935"), "rtmp.address", "CORE_RTMP_ADDRESS", nil, "RTMP server listen address", false, false) - d.val(newAddressValue(&d.RTMP.AddressTLS, ":1936"), "rtmp.address_tls", "CORE_RTMP_ADDRESS_TLS", nil, "RTMPS server listen address", false, false) - d.val(newAbsolutePathValue(&d.RTMP.App, "/"), "rtmp.app", "CORE_RTMP_APP", nil, "RTMP app for publishing", false, false) - d.val(newStringValue(&d.RTMP.Token, ""), "rtmp.token", "CORE_RTMP_TOKEN", nil, "RTMP token for publishing and playing", false, true) + d.vars.Register(value.NewBool(&d.RTMP.Enable, false), "rtmp.enable", "CORE_RTMP_ENABLE", nil, "Enable RTMP server", false, false) + d.vars.Register(value.NewBool(&d.RTMP.EnableTLS, false), "rtmp.enable_tls", "CORE_RTMP_ENABLE_TLS", nil, "Enable RTMPS server instead of RTMP", false, false) + d.vars.Register(value.NewAddress(&d.RTMP.Address, ":1935"), "rtmp.address", "CORE_RTMP_ADDRESS", nil, "RTMP server listen address", false, false) + d.vars.Register(value.NewAddress(&d.RTMP.AddressTLS, ":1936"), "rtmp.address_tls", "CORE_RTMP_ADDRESS_TLS", nil, "RTMPS server listen address", false, false) + d.vars.Register(value.NewAbsolutePath(&d.RTMP.App, "/"), "rtmp.app", "CORE_RTMP_APP", nil, "RTMP app for publishing", false, false) + d.vars.Register(value.NewString(&d.RTMP.Token, ""), "rtmp.token", "CORE_RTMP_TOKEN", nil, "RTMP token for publishing and playing", false, true) // SRT - d.val(newBoolValue(&d.SRT.Enable, false), "srt.enable", "CORE_SRT_ENABLE", nil, "Enable SRT server", false, false) - d.val(newAddressValue(&d.SRT.Address, ":6000"), "srt.address", "CORE_SRT_ADDRESS", nil, "SRT server listen address", false, false) - d.val(newStringValue(&d.SRT.Passphrase, ""), "srt.passphrase", "CORE_SRT_PASSPHRASE", nil, "SRT encryption passphrase", false, true) - d.val(newStringValue(&d.SRT.Token, ""), "srt.token", "CORE_SRT_TOKEN", nil, "SRT token for publishing and playing", false, true) - d.val(newBoolValue(&d.SRT.Log.Enable, false), "srt.log.enable", "CORE_SRT_LOG_ENABLE", nil, "Enable SRT server logging", false, false) - d.val(newStringListValue(&d.SRT.Log.Topics, []string{}, ","), "srt.log.topics", "CORE_SRT_LOG_TOPICS", nil, "List of topics to log", false, false) + d.vars.Register(value.NewBool(&d.SRT.Enable, false), "srt.enable", "CORE_SRT_ENABLE", nil, "Enable SRT server", false, false) + d.vars.Register(value.NewAddress(&d.SRT.Address, ":6000"), "srt.address", "CORE_SRT_ADDRESS", nil, "SRT server listen address", false, false) + d.vars.Register(value.NewString(&d.SRT.Passphrase, ""), "srt.passphrase", "CORE_SRT_PASSPHRASE", nil, "SRT encryption passphrase", false, true) + d.vars.Register(value.NewString(&d.SRT.Token, ""), "srt.token", "CORE_SRT_TOKEN", nil, "SRT token for publishing and playing", false, true) + d.vars.Register(value.NewBool(&d.SRT.Log.Enable, false), "srt.log.enable", "CORE_SRT_LOG_ENABLE", nil, "Enable SRT server logging", false, false) + d.vars.Register(value.NewStringList(&d.SRT.Log.Topics, []string{}, ","), "srt.log.topics", "CORE_SRT_LOG_TOPICS", nil, "List of topics to log", false, false) // FFmpeg - d.val(newExecValue(&d.FFmpeg.Binary, "ffmpeg"), "ffmpeg.binary", "CORE_FFMPEG_BINARY", nil, "Path to ffmpeg binary", true, false) - d.val(newInt64Value(&d.FFmpeg.MaxProcesses, 0), "ffmpeg.max_processes", "CORE_FFMPEG_MAXPROCESSES", nil, "Max. allowed simultaneously running ffmpeg instances, 0 for unlimited", false, false) - d.val(newStringListValue(&d.FFmpeg.Access.Input.Allow, []string{}, " "), "ffmpeg.access.input.allow", "CORE_FFMPEG_ACCESS_INPUT_ALLOW", nil, "List of allowed expression to match against the input addresses", false, false) - d.val(newStringListValue(&d.FFmpeg.Access.Input.Block, []string{}, " "), "ffmpeg.access.input.block", "CORE_FFMPEG_ACCESS_INPUT_BLOCK", nil, "List of blocked expression to match against the input addresses", false, false) - d.val(newStringListValue(&d.FFmpeg.Access.Output.Allow, []string{}, " "), "ffmpeg.access.output.allow", "CORE_FFMPEG_ACCESS_OUTPUT_ALLOW", nil, "List of allowed expression to match against the output addresses", false, false) - d.val(newStringListValue(&d.FFmpeg.Access.Output.Block, []string{}, " "), "ffmpeg.access.output.block", "CORE_FFMPEG_ACCESS_OUTPUT_BLOCK", nil, "List of blocked expression to match against the output addresses", false, false) - d.val(newIntValue(&d.FFmpeg.Log.MaxLines, 50), "ffmpeg.log.max_lines", "CORE_FFMPEG_LOG_MAXLINES", nil, "Number of latest log lines to keep for each process", false, false) - d.val(newIntValue(&d.FFmpeg.Log.MaxHistory, 3), "ffmpeg.log.max_history", "CORE_FFMPEG_LOG_MAXHISTORY", nil, "Number of latest logs to keep for each process", false, false) + d.vars.Register(value.NewExec(&d.FFmpeg.Binary, "ffmpeg"), "ffmpeg.binary", "CORE_FFMPEG_BINARY", nil, "Path to ffmpeg binary", true, false) + d.vars.Register(value.NewInt64(&d.FFmpeg.MaxProcesses, 0), "ffmpeg.max_processes", "CORE_FFMPEG_MAXPROCESSES", nil, "Max. allowed simultaneously running ffmpeg instances, 0 for unlimited", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Input.Allow, []string{}, " "), "ffmpeg.access.input.allow", "CORE_FFMPEG_ACCESS_INPUT_ALLOW", nil, "List of allowed expression to match against the input addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Input.Block, []string{}, " "), "ffmpeg.access.input.block", "CORE_FFMPEG_ACCESS_INPUT_BLOCK", nil, "List of blocked expression to match against the input addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Output.Allow, []string{}, " "), "ffmpeg.access.output.allow", "CORE_FFMPEG_ACCESS_OUTPUT_ALLOW", nil, "List of allowed expression to match against the output addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Output.Block, []string{}, " "), "ffmpeg.access.output.block", "CORE_FFMPEG_ACCESS_OUTPUT_BLOCK", nil, "List of blocked expression to match against the output addresses", false, false) + d.vars.Register(value.NewInt(&d.FFmpeg.Log.MaxLines, 50), "ffmpeg.log.max_lines", "CORE_FFMPEG_LOG_MAXLINES", nil, "Number of latest log lines to keep for each process", false, false) + d.vars.Register(value.NewInt(&d.FFmpeg.Log.MaxHistory, 3), "ffmpeg.log.max_history", "CORE_FFMPEG_LOG_MAXHISTORY", nil, "Number of latest logs to keep for each process", false, false) // Playout - d.val(newBoolValue(&d.Playout.Enable, false), "playout.enable", "CORE_PLAYOUT_ENABLE", nil, "Enable playout proxy where available", false, false) - d.val(newPortValue(&d.Playout.MinPort, 0), "playout.min_port", "CORE_PLAYOUT_MINPORT", nil, "Min. playout server port", false, false) - d.val(newPortValue(&d.Playout.MaxPort, 0), "playout.max_port", "CORE_PLAYOUT_MAXPORT", nil, "Max. playout server port", false, false) + d.vars.Register(value.NewBool(&d.Playout.Enable, false), "playout.enable", "CORE_PLAYOUT_ENABLE", nil, "Enable playout proxy where available", false, false) + d.vars.Register(value.NewPort(&d.Playout.MinPort, 0), "playout.min_port", "CORE_PLAYOUT_MINPORT", nil, "Min. playout server port", false, false) + d.vars.Register(value.NewPort(&d.Playout.MaxPort, 0), "playout.max_port", "CORE_PLAYOUT_MAXPORT", nil, "Max. playout server port", false, false) // Debug - d.val(newBoolValue(&d.Debug.Profiling, false), "debug.profiling", "CORE_DEBUG_PROFILING", nil, "Enable profiling endpoint on /profiling", false, false) - d.val(newIntValue(&d.Debug.ForceGC, 0), "debug.force_gc", "CORE_DEBUG_FORCEGC", nil, "Number of seconds between forcing GC to return memory to the OS", false, false) + d.vars.Register(value.NewBool(&d.Debug.Profiling, false), "debug.profiling", "CORE_DEBUG_PROFILING", nil, "Enable profiling endpoint on /profiling", false, false) + d.vars.Register(value.NewInt(&d.Debug.ForceGC, 0), "debug.force_gc", "CORE_DEBUG_FORCEGC", nil, "Number of seconds between forcing GC to return memory to the OS", false, false) // Metrics - d.val(newBoolValue(&d.Metrics.Enable, false), "metrics.enable", "CORE_METRICS_ENABLE", nil, "Enable collecting historic metrics data", false, false) - d.val(newBoolValue(&d.Metrics.EnablePrometheus, false), "metrics.enable_prometheus", "CORE_METRICS_ENABLE_PROMETHEUS", nil, "Enable prometheus endpoint /metrics", false, false) - d.val(newInt64Value(&d.Metrics.Range, 300), "metrics.range_seconds", "CORE_METRICS_RANGE_SECONDS", nil, "Seconds to keep history data", false, false) - d.val(newInt64Value(&d.Metrics.Interval, 2), "metrics.interval_seconds", "CORE_METRICS_INTERVAL_SECONDS", nil, "Interval for collecting metrics", false, false) + d.vars.Register(value.NewBool(&d.Metrics.Enable, false), "metrics.enable", "CORE_METRICS_ENABLE", nil, "Enable collecting historic metrics data", false, false) + d.vars.Register(value.NewBool(&d.Metrics.EnablePrometheus, false), "metrics.enable_prometheus", "CORE_METRICS_ENABLE_PROMETHEUS", nil, "Enable prometheus endpoint /metrics", false, false) + d.vars.Register(value.NewInt64(&d.Metrics.Range, 300), "metrics.range_seconds", "CORE_METRICS_RANGE_SECONDS", nil, "Seconds to keep history data", false, false) + d.vars.Register(value.NewInt64(&d.Metrics.Interval, 2), "metrics.interval_seconds", "CORE_METRICS_INTERVAL_SECONDS", nil, "Interval for collecting metrics", false, false) // Sessions - d.val(newBoolValue(&d.Sessions.Enable, true), "sessions.enable", "CORE_SESSIONS_ENABLE", nil, "Enable collecting HLS session stats for /memfs", false, false) - d.val(newCIDRListValue(&d.Sessions.IPIgnoreList, []string{"127.0.0.1/32", "::1/128"}, ","), "sessions.ip_ignorelist", "CORE_SESSIONS_IP_IGNORELIST", nil, "List of IP ranges in CIDR notation to ignore", false, false) - d.val(newIntValue(&d.Sessions.SessionTimeout, 30), "sessions.session_timeout_sec", "CORE_SESSIONS_SESSION_TIMEOUT_SEC", nil, "Timeout for an idle session", false, false) - d.val(newBoolValue(&d.Sessions.Persist, false), "sessions.persist", "CORE_SESSIONS_PERSIST", nil, "Whether to persist session history. Will be stored as sessions.json in db.dir", false, false) - d.val(newIntValue(&d.Sessions.PersistInterval, 300), "sessions.persist_interval_sec", "CORE_SESSIONS_PERSIST_INTERVAL_SEC", nil, "Interval in seconds in which to persist the current session history", false, false) - d.val(newUint64Value(&d.Sessions.MaxBitrate, 0), "sessions.max_bitrate_mbit", "CORE_SESSIONS_MAXBITRATE_MBIT", nil, "Max. allowed outgoing bitrate in mbit/s, 0 for unlimited", false, false) - d.val(newUint64Value(&d.Sessions.MaxSessions, 0), "sessions.max_sessions", "CORE_SESSIONS_MAXSESSIONS", nil, "Max. allowed number of simultaneous sessions, 0 for unlimited", false, false) + d.vars.Register(value.NewBool(&d.Sessions.Enable, true), "sessions.enable", "CORE_SESSIONS_ENABLE", nil, "Enable collecting HLS session stats for /memfs", false, false) + d.vars.Register(value.NewCIDRList(&d.Sessions.IPIgnoreList, []string{"127.0.0.1/32", "::1/128"}, ","), "sessions.ip_ignorelist", "CORE_SESSIONS_IP_IGNORELIST", nil, "List of IP ranges in CIDR notation to ignore", false, false) + d.vars.Register(value.NewInt(&d.Sessions.SessionTimeout, 30), "sessions.session_timeout_sec", "CORE_SESSIONS_SESSION_TIMEOUT_SEC", nil, "Timeout for an idle session", false, false) + d.vars.Register(value.NewBool(&d.Sessions.Persist, false), "sessions.persist", "CORE_SESSIONS_PERSIST", nil, "Whether to persist session history. Will be stored as sessions.json in db.dir", false, false) + d.vars.Register(value.NewInt(&d.Sessions.PersistInterval, 300), "sessions.persist_interval_sec", "CORE_SESSIONS_PERSIST_INTERVAL_SEC", nil, "Interval in seconds in which to persist the current session history", false, false) + d.vars.Register(value.NewUint64(&d.Sessions.MaxBitrate, 0), "sessions.max_bitrate_mbit", "CORE_SESSIONS_MAXBITRATE_MBIT", nil, "Max. allowed outgoing bitrate in mbit/s, 0 for unlimited", false, false) + d.vars.Register(value.NewUint64(&d.Sessions.MaxSessions, 0), "sessions.max_sessions", "CORE_SESSIONS_MAXSESSIONS", nil, "Max. allowed number of simultaneous sessions, 0 for unlimited", false, false) // Service - d.val(newBoolValue(&d.Service.Enable, false), "service.enable", "CORE_SERVICE_ENABLE", nil, "Enable connecting to the Restreamer Service", false, false) - d.val(newStringValue(&d.Service.Token, ""), "service.token", "CORE_SERVICE_TOKEN", nil, "Restreamer Service account token", false, true) - d.val(newURLValue(&d.Service.URL, "https://service.datarhei.com"), "service.url", "CORE_SERVICE_URL", nil, "URL of the Restreamer Service", false, false) + d.vars.Register(value.NewBool(&d.Service.Enable, false), "service.enable", "CORE_SERVICE_ENABLE", nil, "Enable connecting to the Restreamer Service", false, false) + d.vars.Register(value.NewString(&d.Service.Token, ""), "service.token", "CORE_SERVICE_TOKEN", nil, "Restreamer Service account token", false, true) + d.vars.Register(value.NewURL(&d.Service.URL, "https://service.datarhei.com"), "service.url", "CORE_SERVICE_URL", nil, "URL of the Restreamer Service", false, false) // Router - d.val(newStringListValue(&d.Router.BlockedPrefixes, []string{"/api"}, ","), "router.blocked_prefixes", "CORE_ROUTER_BLOCKED_PREFIXES", nil, "List of path prefixes that can't be routed", false, false) - d.val(newStringMapStringValue(&d.Router.Routes, nil), "router.routes", "CORE_ROUTER_ROUTES", nil, "List of route mappings", false, false) - d.val(newDirValue(&d.Router.UIPath, ""), "router.ui_path", "CORE_ROUTER_UI_PATH", nil, "Path to a directory holding UI files mounted as /ui", false, false) -} - -func (d *Config) val(val value, name, envName string, envAltNames []string, description string, required, disguise bool) { - d.vars = append(d.vars, &variable{ - value: val, - defVal: val.String(), - name: name, - envName: envName, - envAltNames: envAltNames, - description: description, - required: required, - disguise: disguise, - }) -} - -func (d *Config) log(level string, v *variable, format string, args ...interface{}) { - variable := Variable{ - Value: v.value.String(), - Name: v.name, - EnvName: v.envName, - Description: v.description, - Merged: v.merged, - } - - if v.disguise { - variable.Value = "***" - } - - l := message{ - message: fmt.Sprintf(format, args...), - variable: variable, - level: level, - } - - d.logs = append(d.logs, l) -} - -// Merge merges the values of the known environment variables into the configuration -func (d *Config) Merge() { - for _, v := range d.vars { - if len(v.envName) == 0 { - continue - } - - var envval string - var ok bool - - envval, ok = os.LookupEnv(v.envName) - if !ok { - foundAltName := false - - for _, envName := range v.envAltNames { - envval, ok = os.LookupEnv(envName) - if ok { - foundAltName = true - d.log("warn", v, "deprecated name, please use %s", v.envName) - break - } - } - - if !foundAltName { - continue - } - } - - err := v.value.Set(envval) - if err != nil { - d.log("error", v, "%s", err.Error()) - } - - v.merged = true - } + d.vars.Register(value.NewStringList(&d.Router.BlockedPrefixes, []string{"/api"}, ","), "router.blocked_prefixes", "CORE_ROUTER_BLOCKED_PREFIXES", nil, "List of path prefixes that can't be routed", false, false) + d.vars.Register(value.NewStringMapString(&d.Router.Routes, nil), "router.routes", "CORE_ROUTER_ROUTES", nil, "List of route mappings", false, false) + d.vars.Register(value.NewDir(&d.Router.UIPath, ""), "router.ui_path", "CORE_ROUTER_UI_PATH", nil, "Path to a directory holding UI files mounted as /ui", false, false) } // Validate validates the current state of the Config for completeness and sanity. Errors are // written to the log. Use resetLogs to indicate to reset the logs prior validation. func (d *Config) Validate(resetLogs bool) { if resetLogs { - d.logs = nil + d.vars.ResetLogs() } if d.Version != version { - d.log("error", d.findVariable("version"), "unknown configuration layout version (found version %d, expecting version %d)", d.Version, version) + d.vars.Log("error", "version", "unknown configuration layout version (found version %d, expecting version %d)", d.Version, version) return } - for _, v := range d.vars { - d.log("info", v, "%s", "") - - err := v.value.Validate() - if err != nil { - d.log("error", v, "%s", err.Error()) - } - - if v.required && v.value.IsEmpty() { - d.log("error", v, "a value is required") - } - } + d.vars.Validate() // Individual sanity checks // If HTTP Auth is enabled, check that the username and password are set if d.API.Auth.Enable { if len(d.API.Auth.Username) == 0 || len(d.API.Auth.Password) == 0 { - d.log("error", d.findVariable("api.auth.enable"), "api.auth.username and api.auth.password must be set") + d.vars.Log("error", "api.auth.enable", "api.auth.username and api.auth.password must be set") } } // If Auth0 is enabled, check that domain, audience, and clientid are set if d.API.Auth.Auth0.Enable { if len(d.API.Auth.Auth0.Tenants) == 0 { - d.log("error", d.findVariable("api.auth.auth0.enable"), "at least one tenants must be set") + d.vars.Log("error", "api.auth.auth0.enable", "at least one tenants must be set") } for i, t := range d.API.Auth.Auth0.Tenants { if len(t.Domain) == 0 || len(t.Audience) == 0 || len(t.ClientID) == 0 { - d.log("error", d.findVariable("api.auth.auth0.tenants"), "domain, audience, and clientid must be set (tenant %d)", i) + d.vars.Log("error", "api.auth.auth0.tenants", "domain, audience, and clientid must be set (tenant %d)", i) } } } @@ -387,14 +299,14 @@ func (d *Config) Validate(resetLogs bool) { // If TLS is enabled and Let's Encrypt is disabled, require certfile and keyfile if d.TLS.Enable && !d.TLS.Auto { if len(d.TLS.CertFile) == 0 || len(d.TLS.KeyFile) == 0 { - d.log("error", d.findVariable("tls.enable"), "tls.certfile and tls.keyfile must be set") + d.vars.Log("error", "tls.enable", "tls.certfile and tls.keyfile must be set") } } // If TLS and Let's Encrypt certificate is enabled, we require a public hostname if d.TLS.Enable && d.TLS.Auto { if len(d.Host.Name) == 0 { - d.log("error", d.findVariable("host.name"), "a hostname must be set in order to get an automatic TLS certificate") + d.vars.Log("error", "host.name", "a hostname must be set in order to get an automatic TLS certificate") } else { r := &net.Resolver{ PreferGo: true, @@ -404,7 +316,7 @@ func (d *Config) Validate(resetLogs bool) { for _, host := range d.Host.Name { // Don't lookup IP addresses if ip := net.ParseIP(host); ip != nil { - d.log("error", d.findVariable("host.name"), "only host names are allowed if automatic TLS is enabled, but found IP address: %s", host) + d.vars.Log("error", "host.name", "only host names are allowed if automatic TLS is enabled, but found IP address: %s", host) } // Lookup host name with a timeout @@ -412,7 +324,7 @@ func (d *Config) Validate(resetLogs bool) { _, err := r.LookupHost(ctx, host) if err != nil { - d.log("error", d.findVariable("host.name"), "the host '%s' can't be resolved and will not work with automatic TLS", host) + d.vars.Log("error", "host.name", "the host '%s' can't be resolved and will not work with automatic TLS", host) } cancel() @@ -423,32 +335,31 @@ func (d *Config) Validate(resetLogs bool) { // If TLS and Let's Encrypt certificate is enabled, we require a non-empty email address if d.TLS.Enable && d.TLS.Auto { if len(d.TLS.Email) == 0 { - v := d.findVariable("tls.email") - v.value.Set(v.defVal) + d.vars.SetDefault("tls.email") } } // If TLS for RTMP is enabled, TLS must be enabled if d.RTMP.EnableTLS { if !d.RTMP.Enable { - d.log("error", d.findVariable("rtmp.enable"), "RTMP server must be enabled if RTMPS server is enabled") + d.vars.Log("error", "rtmp.enable", "RTMP server must be enabled if RTMPS server is enabled") } if !d.TLS.Enable { - d.log("error", d.findVariable("rtmp.enable_tls"), "RTMPS server can only be enabled if TLS is enabled") + d.vars.Log("error", "rtmp.enable_tls", "RTMPS server can only be enabled if TLS is enabled") } if len(d.RTMP.AddressTLS) == 0 { - d.log("error", d.findVariable("rtmp.address_tls"), "RTMPS server address must be set") + d.vars.Log("error", "rtmp.address_tls", "RTMPS server address must be set") } if d.RTMP.Enable && d.RTMP.Address == d.RTMP.AddressTLS { - d.log("error", d.findVariable("rtmp.address"), "The RTMP and RTMPS server can't listen on the same address") + d.vars.Log("error", "rtmp.address", "The RTMP and RTMPS server can't listen on the same address") } } // If CORE_MEMFS_USERNAME and CORE_MEMFS_PASSWORD are set, automatically active/deactivate Basic-Auth for memfs - if d.findVariable("storage.memory.auth.username").merged && d.findVariable("storage.memory.auth.password").merged { + if d.vars.IsMerged("storage.memory.auth.username") && d.vars.IsMerged("storage.memory.auth.password") { d.Storage.Memory.Auth.Enable = true if len(d.Storage.Memory.Auth.Username) == 0 && len(d.Storage.Memory.Auth.Password) == 0 { @@ -459,121 +370,76 @@ func (d *Config) Validate(resetLogs bool) { // If Basic-Auth for memfs is enable, check that the username and password are set if d.Storage.Memory.Auth.Enable { if len(d.Storage.Memory.Auth.Username) == 0 || len(d.Storage.Memory.Auth.Password) == 0 { - d.log("error", d.findVariable("storage.memory.auth.enable"), "storage.memory.auth.username and storage.memory.auth.password must be set") + d.vars.Log("error", "storage.memory.auth.enable", "storage.memory.auth.username and storage.memory.auth.password must be set") } } // If playout is enabled, check that the port range is sane if d.Playout.Enable { if d.Playout.MinPort >= d.Playout.MaxPort { - d.log("error", d.findVariable("playout.min_port"), "must be bigger than playout.max_port") + d.vars.Log("error", "playout.min_port", "must be bigger than playout.max_port") } } // If cache is enabled, a valid TTL has to be set to a useful value if d.Storage.Disk.Cache.Enable && d.Storage.Disk.Cache.TTL < 0 { - d.log("error", d.findVariable("storage.disk.cache.ttl_seconds"), "must be equal or greater than 0") + d.vars.Log("error", "storage.disk.cache.ttl_seconds", "must be equal or greater than 0") } // If the stats are enabled, the session timeout has to be set to a useful value if d.Sessions.Enable && d.Sessions.SessionTimeout < 1 { - d.log("error", d.findVariable("stats.session_timeout_sec"), "must be equal or greater than 1") + d.vars.Log("error", "stats.session_timeout_sec", "must be equal or greater than 1") } // If the stats and their persistence are enabled, the persist interval has to be set to a useful value if d.Sessions.Enable && d.Sessions.PersistInterval < 0 { - d.log("error", d.findVariable("stats.persist_interval_sec"), "must be at equal or greater than 0") + d.vars.Log("error", "stats.persist_interval_sec", "must be at equal or greater than 0") } // If the service is enabled, the token and enpoint have to be defined if d.Service.Enable { if len(d.Service.Token) == 0 { - d.log("error", d.findVariable("service.token"), "must be non-empty") + d.vars.Log("error", "service.token", "must be non-empty") } if len(d.Service.URL) == 0 { - d.log("error", d.findVariable("service.url"), "must be non-empty") + d.vars.Log("error", "service.url", "must be non-empty") } } // If historic metrics are enabled, the timerange and interval have to be valid if d.Metrics.Enable { if d.Metrics.Range <= 0 { - d.log("error", d.findVariable("metrics.range"), "must be greater 0") + d.vars.Log("error", "metrics.range", "must be greater 0") } if d.Metrics.Interval <= 0 { - d.log("error", d.findVariable("metrics.interval"), "must be greater 0") + d.vars.Log("error", "metrics.interval", "must be greater 0") } if d.Metrics.Interval > d.Metrics.Range { - d.log("error", d.findVariable("metrics.interval"), "must be smaller than the range") + d.vars.Log("error", "metrics.interval", "must be smaller than the range") } } } -func (d *Config) findVariable(name string) *variable { - for _, v := range d.vars { - if v.name == name { - return v - } - } - - return nil +// Merge merges the values of the known environment variables into the configuration +func (d *Config) Merge() { + d.vars.Merge() } // Messages calls for each log entry the provided callback. The level has the values 'error', 'warn', or 'info'. // The name is the name of the configuration value, e.g. 'api.auth.enable'. The message is the log message. -func (d *Config) Messages(logger func(level string, v Variable, message string)) { - for _, l := range d.logs { - logger(l.level, l.variable, l.message) - } +func (d *Config) Messages(logger func(level string, v vars.Variable, message string)) { + d.vars.Messages(logger) } // HasErrors returns whether there are some error messages in the log. func (d *Config) HasErrors() bool { - for _, l := range d.logs { - if l.level == "error" { - return true - } - } - - return false + return d.vars.HasErrors() } // Overrides returns a list of configuration value names that have been overriden by an environment variable. func (d *Config) Overrides() []string { - overrides := []string{} - - for _, v := range d.vars { - if v.merged { - overrides = append(overrides, v.name) - } - } - - return overrides -} - -func copyStringSlice(src []string) []string { - dst := make([]string, len(src)) - copy(dst, src) - - return dst -} - -func copyStringMap(src map[string]string) map[string]string { - dst := make(map[string]string) - - for k, v := range src { - dst[k] = v - } - - return dst -} - -func copyTenantSlice(src []Auth0Tenant) []Auth0Tenant { - dst := make([]Auth0Tenant, len(src)) - copy(dst, src) - - return dst + return d.vars.Overrides() } diff --git a/config/config_test.go b/config/config_test.go index 38f54aa5..0ffe2790 100644 --- a/config/config_test.go +++ b/config/config_test.go @@ -3,7 +3,7 @@ package config import ( "testing" - "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestConfigCopy(t *testing.T) { @@ -12,44 +12,41 @@ func TestConfigCopy(t *testing.T) { config1.Version = 42 config1.DB.Dir = "foo" - val1 := config1.findVariable("version") - val2 := config1.findVariable("db.dir") - val3 := config1.findVariable("host.name") + val1, _ := config1.Get("version") + val2, _ := config1.Get("db.dir") + val3, _ := config1.Get("host.name") - assert.Equal(t, "42", val1.value.String()) - assert.Equal(t, nil, val1.value.Validate()) - assert.Equal(t, false, val1.value.IsEmpty()) + require.Equal(t, "42", val1) + require.Equal(t, "foo", val2) + require.Equal(t, "(empty)", val3) - assert.Equal(t, "foo", val2.value.String()) - assert.Equal(t, "(empty)", val3.value.String()) + config1.Set("host.name", "foo.com") + val3, _ = config1.Get("host.name") + require.Equal(t, "foo.com", val3) - val3.value.Set("foo.com") + config2 := config1.Clone() - assert.Equal(t, "foo.com", val3.value.String()) + require.Equal(t, int64(42), config2.Version) + require.Equal(t, "foo", config2.DB.Dir) + require.Equal(t, []string{"foo.com"}, config2.Host.Name) - config2 := NewConfigFrom(config1) + config1.Set("version", "77") - assert.Equal(t, int64(42), config2.Version) - assert.Equal(t, "foo", config2.DB.Dir) - assert.Equal(t, []string{"foo.com"}, config2.Host.Name) + require.Equal(t, int64(77), config1.Version) + require.Equal(t, int64(42), config2.Version) - val1.value.Set("77") + config1.Set("db.dir", "bar") - assert.Equal(t, int64(77), config1.Version) - assert.Equal(t, int64(42), config2.Version) - - val2.value.Set("bar") - - assert.Equal(t, "bar", config1.DB.Dir) - assert.Equal(t, "foo", config2.DB.Dir) + require.Equal(t, "bar", config1.DB.Dir) + require.Equal(t, "foo", config2.DB.Dir) config2.DB.Dir = "baz" - assert.Equal(t, "bar", config1.DB.Dir) - assert.Equal(t, "baz", config2.DB.Dir) + require.Equal(t, "bar", config1.DB.Dir) + require.Equal(t, "baz", config2.DB.Dir) config1.Host.Name[0] = "bar.com" - assert.Equal(t, []string{"bar.com"}, config1.Host.Name) - assert.Equal(t, []string{"foo.com"}, config2.Host.Name) + require.Equal(t, []string{"bar.com"}, config1.Host.Name) + require.Equal(t, []string{"foo.com"}, config2.Host.Name) } diff --git a/config/copy/copy.go b/config/copy/copy.go new file mode 100644 index 00000000..2541bf48 --- /dev/null +++ b/config/copy/copy.go @@ -0,0 +1,30 @@ +package copy + +import "github.com/datarhei/core/v16/config/value" + +func StringMap(src map[string]string) map[string]string { + dst := make(map[string]string) + + for k, v := range src { + dst[k] = v + } + + return dst +} + +func TenantSlice(src []value.Auth0Tenant) []value.Auth0Tenant { + dst := Slice(src) + + for i, t := range src { + dst[i].Users = Slice(t.Users) + } + + return dst +} + +func Slice[T any](src []T) []T { + dst := make([]T, len(src)) + copy(dst, src) + + return dst +} diff --git a/config/data.go b/config/data.go index d273368d..012c964b 100644 --- a/config/data.go +++ b/config/data.go @@ -1,6 +1,12 @@ package config -import "time" +import ( + "time" + + "github.com/datarhei/core/v16/config/copy" + v2 "github.com/datarhei/core/v16/config/v2" + "github.com/datarhei/core/v16/config/value" +) // Data is the actual configuration data for the app type Data struct { @@ -45,8 +51,8 @@ type Data struct { Secret string `json:"secret"` } `json:"jwt"` Auth0 struct { - Enable bool `json:"enable"` - Tenants []Auth0Tenant `json:"tenants"` + Enable bool `json:"enable"` + Tenants []value.Auth0Tenant `json:"tenants"` } `json:"auth0"` } `json:"auth"` } `json:"api"` @@ -159,8 +165,90 @@ type Data struct { } `json:"router"` } -func NewV3FromV2(d *dataV2) (*Data, error) { - data := &Data{} +func UpgradeV2ToV3(d *v2.Data) (*Data, error) { + cfg := New() + + return MergeV2toV3(&cfg.Data, d) +} + +func MergeV2toV3(data *Data, d *v2.Data) (*Data, error) { + data.CreatedAt = d.CreatedAt + data.LoadedAt = d.LoadedAt + data.UpdatedAt = d.UpdatedAt + + data.ID = d.ID + data.Name = d.Name + data.Address = d.Address + data.CheckForUpdates = d.CheckForUpdates + + data.Log = d.Log + data.DB = d.DB + data.Host = d.Host + data.API = d.API + data.RTMP = d.RTMP + data.SRT = d.SRT + data.FFmpeg = d.FFmpeg + data.Playout = d.Playout + data.Debug = d.Debug + data.Metrics = d.Metrics + data.Sessions = d.Sessions + data.Service = d.Service + data.Router = d.Router + + data.Log.Topics = copy.Slice(d.Log.Topics) + + data.Host.Name = copy.Slice(d.Host.Name) + + data.API.Access.HTTP.Allow = copy.Slice(d.API.Access.HTTP.Allow) + data.API.Access.HTTP.Block = copy.Slice(d.API.Access.HTTP.Block) + data.API.Access.HTTPS.Allow = copy.Slice(d.API.Access.HTTPS.Allow) + data.API.Access.HTTPS.Block = copy.Slice(d.API.Access.HTTPS.Block) + + data.API.Auth.Auth0.Tenants = copy.TenantSlice(d.API.Auth.Auth0.Tenants) + + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) + + data.FFmpeg.Access.Input.Allow = copy.Slice(d.FFmpeg.Access.Input.Allow) + data.FFmpeg.Access.Input.Block = copy.Slice(d.FFmpeg.Access.Input.Block) + data.FFmpeg.Access.Output.Allow = copy.Slice(d.FFmpeg.Access.Output.Allow) + data.FFmpeg.Access.Output.Block = copy.Slice(d.FFmpeg.Access.Output.Block) + + data.Sessions.IPIgnoreList = copy.Slice(d.Sessions.IPIgnoreList) + + data.SRT.Log.Topics = copy.Slice(d.SRT.Log.Topics) + + data.Router.BlockedPrefixes = copy.Slice(d.Router.BlockedPrefixes) + data.Router.Routes = copy.StringMap(d.Router.Routes) + + data.Storage.MimeTypes = d.Storage.MimeTypes + + data.Storage.CORS = d.Storage.CORS + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) + + data.Storage.Memory = d.Storage.Memory + + // Actual changes + data.TLS.Enable = d.TLS.Enable + data.TLS.Address = d.TLS.Address + data.TLS.Auto = d.TLS.Auto + data.TLS.CertFile = d.TLS.CertFile + data.TLS.KeyFile = d.TLS.KeyFile + + data.Storage.Disk.Dir = d.Storage.Disk.Dir + data.Storage.Disk.Size = d.Storage.Disk.Size + data.Storage.Disk.Cache.Enable = d.Storage.Disk.Cache.Enable + data.Storage.Disk.Cache.Size = d.Storage.Disk.Cache.Size + data.Storage.Disk.Cache.FileSize = d.Storage.Disk.Cache.FileSize + data.Storage.Disk.Cache.TTL = d.Storage.Disk.Cache.TTL + data.Storage.Disk.Cache.Types.Allow = copy.Slice(d.Storage.Disk.Cache.Types) + + data.Version = 3 + + return data, nil +} + +func DowngradeV3toV2(d *Data) (*v2.Data, error) { + data := &v2.Data{} data.CreatedAt = d.CreatedAt data.LoadedAt = d.LoadedAt @@ -185,30 +273,30 @@ func NewV3FromV2(d *dataV2) (*Data, error) { data.Service = d.Service data.Router = d.Router - data.Log.Topics = copyStringSlice(d.Log.Topics) + data.Log.Topics = copy.Slice(d.Log.Topics) - data.Host.Name = copyStringSlice(d.Host.Name) + data.Host.Name = copy.Slice(d.Host.Name) - data.API.Access.HTTP.Allow = copyStringSlice(d.API.Access.HTTP.Allow) - data.API.Access.HTTP.Block = copyStringSlice(d.API.Access.HTTP.Block) - data.API.Access.HTTPS.Allow = copyStringSlice(d.API.Access.HTTPS.Allow) - data.API.Access.HTTPS.Block = copyStringSlice(d.API.Access.HTTPS.Block) + data.API.Access.HTTP.Allow = copy.Slice(d.API.Access.HTTP.Allow) + data.API.Access.HTTP.Block = copy.Slice(d.API.Access.HTTP.Block) + data.API.Access.HTTPS.Allow = copy.Slice(d.API.Access.HTTPS.Allow) + data.API.Access.HTTPS.Block = copy.Slice(d.API.Access.HTTPS.Block) - data.API.Auth.Auth0.Tenants = copyTenantSlice(d.API.Auth.Auth0.Tenants) + data.API.Auth.Auth0.Tenants = copy.TenantSlice(d.API.Auth.Auth0.Tenants) - data.Storage.CORS.Origins = copyStringSlice(d.Storage.CORS.Origins) + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) - data.FFmpeg.Access.Input.Allow = copyStringSlice(d.FFmpeg.Access.Input.Allow) - data.FFmpeg.Access.Input.Block = copyStringSlice(d.FFmpeg.Access.Input.Block) - data.FFmpeg.Access.Output.Allow = copyStringSlice(d.FFmpeg.Access.Output.Allow) - data.FFmpeg.Access.Output.Block = copyStringSlice(d.FFmpeg.Access.Output.Block) + data.FFmpeg.Access.Input.Allow = copy.Slice(d.FFmpeg.Access.Input.Allow) + data.FFmpeg.Access.Input.Block = copy.Slice(d.FFmpeg.Access.Input.Block) + data.FFmpeg.Access.Output.Allow = copy.Slice(d.FFmpeg.Access.Output.Allow) + data.FFmpeg.Access.Output.Block = copy.Slice(d.FFmpeg.Access.Output.Block) - data.Sessions.IPIgnoreList = copyStringSlice(d.Sessions.IPIgnoreList) + data.Sessions.IPIgnoreList = copy.Slice(d.Sessions.IPIgnoreList) - data.SRT.Log.Topics = copyStringSlice(d.SRT.Log.Topics) + data.SRT.Log.Topics = copy.Slice(d.SRT.Log.Topics) - data.Router.BlockedPrefixes = copyStringSlice(d.Router.BlockedPrefixes) - data.Router.Routes = copyStringMap(d.Router.Routes) + data.Router.BlockedPrefixes = copy.Slice(d.Router.BlockedPrefixes) + data.Router.Routes = copy.StringMap(d.Router.Routes) // Actual changes data.TLS.Enable = d.TLS.Enable @@ -216,12 +304,11 @@ func NewV3FromV2(d *dataV2) (*Data, error) { data.TLS.Auto = d.TLS.Auto data.TLS.CertFile = d.TLS.CertFile data.TLS.KeyFile = d.TLS.KeyFile - data.TLS.Email = "cert@datarhei.com" data.Storage.MimeTypes = d.Storage.MimeTypes data.Storage.CORS = d.Storage.CORS - data.Storage.CORS.Origins = copyStringSlice(d.Storage.CORS.Origins) + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) data.Storage.Memory = d.Storage.Memory @@ -231,10 +318,9 @@ func NewV3FromV2(d *dataV2) (*Data, error) { data.Storage.Disk.Cache.Size = d.Storage.Disk.Cache.Size data.Storage.Disk.Cache.FileSize = d.Storage.Disk.Cache.FileSize data.Storage.Disk.Cache.TTL = d.Storage.Disk.Cache.TTL - data.Storage.Disk.Cache.Types.Allow = copyStringSlice(d.Storage.Disk.Cache.Types) - data.Storage.Disk.Cache.Types.Block = []string{} + data.Storage.Disk.Cache.Types = copy.Slice(d.Storage.Disk.Cache.Types.Allow) - data.Version = 3 + data.Version = 2 return data, nil } diff --git a/config/ip.go b/config/ip.go deleted file mode 100644 index 1ac57d51..00000000 --- a/config/ip.go +++ /dev/null @@ -1,71 +0,0 @@ -package config - -import ( - "io" - "net/http" - "sync" - "time" -) - -// SetPublicIPs will try to figure out the public IPs (v4 and v6) -// we're running on. There's a timeout of max. 5 seconds to do it. -// If it fails, the IPs will simply not be set. -func (d *Config) SetPublicIPs() { - var wg sync.WaitGroup - - ipv4 := "" - ipv6 := "" - - wg.Add(2) - - go func() { - defer wg.Done() - - ipv4 = doRequest("https://api.ipify.org") - }() - - go func() { - defer wg.Done() - - ipv6 = doRequest("https://api6.ipify.org") - }() - - wg.Wait() - - if len(ipv4) != 0 { - d.Host.Name = append(d.Host.Name, ipv4) - } - - if len(ipv6) != 0 && ipv4 != ipv6 { - d.Host.Name = append(d.Host.Name, ipv6) - } -} - -func doRequest(url string) string { - client := &http.Client{ - Timeout: 5 * time.Second, - } - - req, err := http.NewRequest("GET", url, nil) - if err != nil { - return "" - } - - resp, err := client.Do(req) - if err != nil { - return "" - } - - defer resp.Body.Close() - - body, err := io.ReadAll(resp.Body) - if err != nil { - return "" - } - - if resp.StatusCode != 200 { - return "" - } - - return string(body) -} diff --git a/config/dummy.go b/config/store/dummy.go similarity index 53% rename from config/dummy.go rename to config/store/dummy.go index 87daf282..c1a96aae 100644 --- a/config/dummy.go +++ b/config/store/dummy.go @@ -1,17 +1,21 @@ -package config +package store -import "fmt" +import ( + "fmt" + + "github.com/datarhei/core/v16/config" +) type dummyStore struct { - current *Config - active *Config + current *config.Config + active *config.Config } // NewDummyStore returns a store that returns the default config -func NewDummyStore() Store { +func NewDummy() Store { s := &dummyStore{} - cfg := New() + cfg := config.New() cfg.DB.Dir = "." cfg.FFmpeg.Binary = "true" @@ -20,7 +24,7 @@ func NewDummyStore() Store { s.current = cfg - cfg = New() + cfg = config.New() cfg.DB.Dir = "." cfg.FFmpeg.Binary = "true" @@ -32,48 +36,34 @@ func NewDummyStore() Store { return s } -func (c *dummyStore) Get() *Config { - cfg := New() - - cfg.DB.Dir = "." - cfg.FFmpeg.Binary = "true" - cfg.Storage.Disk.Dir = "." - cfg.Storage.MimeTypes = "" - - return cfg +func (c *dummyStore) Get() *config.Config { + return c.current.Clone() } -func (c *dummyStore) Set(d *Config) error { +func (c *dummyStore) Set(d *config.Config) error { d.Validate(true) if d.HasErrors() { return fmt.Errorf("configuration data has errors after validation") } - c.current = NewConfigFrom(d) + c.current = d.Clone() return nil } -func (c *dummyStore) GetActive() *Config { - cfg := New() - - cfg.DB.Dir = "." - cfg.FFmpeg.Binary = "true" - cfg.Storage.Disk.Dir = "." - cfg.Storage.MimeTypes = "" - - return cfg +func (c *dummyStore) GetActive() *config.Config { + return c.active.Clone() } -func (c *dummyStore) SetActive(d *Config) error { +func (c *dummyStore) SetActive(d *config.Config) error { d.Validate(true) if d.HasErrors() { return fmt.Errorf("configuration data has errors after validation") } - c.active = NewConfigFrom(d) + c.active = d.Clone() return nil } diff --git a/config/json.go b/config/store/json.go similarity index 74% rename from config/json.go rename to config/store/json.go index 3b185d0e..b4456635 100644 --- a/config/json.go +++ b/config/store/json.go @@ -1,4 +1,4 @@ -package config +package store import ( gojson "encoding/json" @@ -7,6 +7,9 @@ import ( "path/filepath" "time" + "github.com/datarhei/core/v16/config" + v1 "github.com/datarhei/core/v16/config/v1" + v2 "github.com/datarhei/core/v16/config/v2" "github.com/datarhei/core/v16/encoding/json" "github.com/datarhei/core/v16/io/file" ) @@ -14,7 +17,7 @@ import ( type jsonStore struct { path string - data map[string]*Config + data map[string]*config.Config reloadFn func() } @@ -23,14 +26,14 @@ type jsonStore struct { // back to the path. The returned error will be nil if everything went fine. // If the path doesn't exist, a default JSON config file will be written to that path. // The returned ConfigStore can be used to retrieve or write the config. -func NewJSONStore(path string, reloadFn func()) (Store, error) { +func NewJSON(path string, reloadFn func()) (Store, error) { c := &jsonStore{ path: path, - data: make(map[string]*Config), + data: make(map[string]*config.Config), reloadFn: reloadFn, } - c.data["base"] = New() + c.data["base"] = config.New() if err := c.load(c.data["base"]); err != nil { return nil, fmt.Errorf("failed to read JSON from '%s': %w", path, err) @@ -43,16 +46,16 @@ func NewJSONStore(path string, reloadFn func()) (Store, error) { return c, nil } -func (c *jsonStore) Get() *Config { - return NewConfigFrom(c.data["base"]) +func (c *jsonStore) Get() *config.Config { + return c.data["base"].Clone() } -func (c *jsonStore) Set(d *Config) error { +func (c *jsonStore) Set(d *config.Config) error { if d.HasErrors() { return fmt.Errorf("configuration data has errors after validation") } - data := NewConfigFrom(d) + data := d.Clone() data.CreatedAt = time.Now() @@ -67,26 +70,26 @@ func (c *jsonStore) Set(d *Config) error { return nil } -func (c *jsonStore) GetActive() *Config { +func (c *jsonStore) GetActive() *config.Config { if x, ok := c.data["merged"]; ok { - return NewConfigFrom(x) + return x.Clone() } if x, ok := c.data["base"]; ok { - return NewConfigFrom(x) + return x.Clone() } return nil } -func (c *jsonStore) SetActive(d *Config) error { +func (c *jsonStore) SetActive(d *config.Config) error { d.Validate(true) if d.HasErrors() { return fmt.Errorf("configuration data has errors after validation") } - c.data["merged"] = NewConfigFrom(d) + c.data["merged"] = d.Clone() return nil } @@ -101,7 +104,7 @@ func (c *jsonStore) Reload() error { return nil } -func (c *jsonStore) load(config *Config) error { +func (c *jsonStore) load(cfg *config.Config) error { if len(c.path) == 0 { return nil } @@ -115,7 +118,7 @@ func (c *jsonStore) load(config *Config) error { return err } - dataV3 := &Data{} + dataV3 := &config.Data{} version := DataVersion{} @@ -124,29 +127,29 @@ func (c *jsonStore) load(config *Config) error { } if version.Version == 1 { - dataV1 := &dataV1{} + dataV1 := &v1.Data{} if err = gojson.Unmarshal(jsondata, dataV1); err != nil { return json.FormatError(jsondata, err) } - dataV2, err := NewV2FromV1(dataV1) + dataV2, err := v2.UpgradeV1ToV2(dataV1) if err != nil { return err } - dataV3, err = NewV3FromV2(dataV2) + dataV3, err = config.UpgradeV2ToV3(dataV2) if err != nil { return err } } else if version.Version == 2 { - dataV2 := &dataV2{} + dataV2 := &v2.Data{} if err = gojson.Unmarshal(jsondata, dataV2); err != nil { return json.FormatError(jsondata, err) } - dataV3, err = NewV3FromV2(dataV2) + dataV3, err = config.UpgradeV2ToV3(dataV2) if err != nil { return err } @@ -156,15 +159,15 @@ func (c *jsonStore) load(config *Config) error { } } - config.Data = *dataV3 + cfg.Data = *dataV3 - config.LoadedAt = time.Now() - config.UpdatedAt = config.LoadedAt + cfg.LoadedAt = time.Now() + cfg.UpdatedAt = cfg.LoadedAt return nil } -func (c *jsonStore) store(data *Config) error { +func (c *jsonStore) store(data *config.Config) error { data.CreatedAt = time.Now() if len(c.path) == 0 { diff --git a/config/store.go b/config/store/store.go similarity index 69% rename from config/store.go rename to config/store/store.go index 6aa2895b..a4c46150 100644 --- a/config/store.go +++ b/config/store/store.go @@ -1,23 +1,29 @@ -package config +package store + +import "github.com/datarhei/core/v16/config" // Store is a store for the configuration data. type Store interface { // Get the current configuration. - Get() *Config + Get() *config.Config // Set a new configuration for persistence. - Set(data *Config) error + Set(data *config.Config) error // GetActive returns the configuration that has been set as // active before, otherwise it return nil. - GetActive() *Config + GetActive() *config.Config // SetActive will keep the given configuration // as active in memory. It can be retrieved later with GetActive() - SetActive(data *Config) error + SetActive(data *config.Config) error // Reload will reload the stored configuration. It has to make sure // that all affected components will receiver their potentially // changed configuration. Reload() error } + +type DataVersion struct { + Version int64 `json:"version"` +} diff --git a/config/types.go b/config/types.go deleted file mode 100644 index f5a27e82..00000000 --- a/config/types.go +++ /dev/null @@ -1,844 +0,0 @@ -package config - -import ( - "encoding/base64" - "encoding/json" - "fmt" - "net" - "net/mail" - "net/url" - "os" - "os/exec" - "path/filepath" - "regexp" - "strconv" - "strings" - "time" - - "github.com/datarhei/core/v16/http/cors" -) - -type value interface { - // String returns a string representation of the value. - String() string - - // Set a new value for the value. Returns an - // error if the given string representation can't - // be transformed to the value. Returns nil - // if the new value has been set. - Set(string) error - - // Validate the value. The returned error will - // indicate what is wrong with the current value. - // Returns nil if the value is OK. - Validate() error - - // IsEmpty returns whether the value represents an empty - // representation for that value. - IsEmpty() bool -} - -// string - -type stringValue string - -func newStringValue(p *string, val string) *stringValue { - *p = val - return (*stringValue)(p) -} - -func (s *stringValue) Set(val string) error { - *s = stringValue(val) - return nil -} - -func (s *stringValue) String() string { - return string(*s) -} - -func (s *stringValue) Validate() error { - return nil -} - -func (s *stringValue) IsEmpty() bool { - return len(string(*s)) == 0 -} - -// address (host?:port) - -type addressValue string - -func newAddressValue(p *string, val string) *addressValue { - *p = val - return (*addressValue)(p) -} - -func (s *addressValue) Set(val string) error { - // Check if the new value is only a port number - re := regexp.MustCompile("^[0-9]+$") - if re.MatchString(val) { - val = ":" + val - } - - *s = addressValue(val) - return nil -} - -func (s *addressValue) String() string { - return string(*s) -} - -func (s *addressValue) Validate() error { - _, port, err := net.SplitHostPort(string(*s)) - if err != nil { - return err - } - - re := regexp.MustCompile("^[0-9]+$") - if !re.MatchString(port) { - return fmt.Errorf("the port must be numerical") - } - - return nil -} - -func (s *addressValue) IsEmpty() bool { - return s.Validate() != nil -} - -// array of strings - -type stringListValue struct { - p *[]string - separator string -} - -func newStringListValue(p *[]string, val []string, separator string) *stringListValue { - v := &stringListValue{ - p: p, - separator: separator, - } - *p = val - return v -} - -func (s *stringListValue) Set(val string) error { - list := []string{} - - for _, elm := range strings.Split(val, s.separator) { - elm = strings.TrimSpace(elm) - if len(elm) != 0 { - list = append(list, elm) - } - } - - *s.p = list - - return nil -} - -func (s *stringListValue) String() string { - if s.IsEmpty() { - return "(empty)" - } - - return strings.Join(*s.p, s.separator) -} - -func (s *stringListValue) Validate() error { - return nil -} - -func (s *stringListValue) IsEmpty() bool { - return len(*s.p) == 0 -} - -// array of auth0 tenants - -type tenantListValue struct { - p *[]Auth0Tenant - separator string -} - -func newTenantListValue(p *[]Auth0Tenant, val []Auth0Tenant, separator string) *tenantListValue { - v := &tenantListValue{ - p: p, - separator: separator, - } - - *p = val - return v -} - -func (s *tenantListValue) Set(val string) error { - list := []Auth0Tenant{} - - for i, elm := range strings.Split(val, s.separator) { - data, err := base64.StdEncoding.DecodeString(elm) - if err != nil { - return fmt.Errorf("invalid base64 encoding of tenant %d: %w", i, err) - } - - t := Auth0Tenant{} - if err := json.Unmarshal(data, &t); err != nil { - return fmt.Errorf("invalid JSON in tenant %d: %w", i, err) - } - - list = append(list, t) - } - - *s.p = list - - return nil -} - -func (s *tenantListValue) String() string { - if s.IsEmpty() { - return "(empty)" - } - - list := []string{} - - for _, t := range *s.p { - list = append(list, fmt.Sprintf("%s (%d users)", t.Domain, len(t.Users))) - } - - return strings.Join(list, ",") -} - -func (s *tenantListValue) Validate() error { - for i, t := range *s.p { - if len(t.Domain) == 0 { - return fmt.Errorf("the domain for tenant %d is missing", i) - } - - if len(t.Audience) == 0 { - return fmt.Errorf("the audience for tenant %d is missing", i) - } - } - - return nil -} - -func (s *tenantListValue) IsEmpty() bool { - return len(*s.p) == 0 -} - -// map of strings to strings - -type stringMapStringValue struct { - p *map[string]string -} - -func newStringMapStringValue(p *map[string]string, val map[string]string) *stringMapStringValue { - v := &stringMapStringValue{ - p: p, - } - - if *p == nil { - *p = make(map[string]string) - } - - if val != nil { - *p = val - } - - return v -} - -func (s *stringMapStringValue) Set(val string) error { - mappings := make(map[string]string) - - for _, elm := range strings.Split(val, " ") { - elm = strings.TrimSpace(elm) - if len(elm) == 0 { - continue - } - - mapping := strings.SplitN(elm, ":", 2) - - mappings[mapping[0]] = mapping[1] - } - - *s.p = mappings - - return nil -} - -func (s *stringMapStringValue) String() string { - if s.IsEmpty() { - return "(empty)" - } - - mappings := make([]string, len(*s.p)) - - i := 0 - for k, v := range *s.p { - mappings[i] = k + ":" + v - i++ - } - - return strings.Join(mappings, " ") -} - -func (s *stringMapStringValue) Validate() error { - return nil -} - -func (s *stringMapStringValue) IsEmpty() bool { - return len(*s.p) == 0 -} - -// array of CIDR notation IP adresses - -type cidrListValue struct { - p *[]string - separator string -} - -func newCIDRListValue(p *[]string, val []string, separator string) *cidrListValue { - v := &cidrListValue{ - p: p, - separator: separator, - } - *p = val - return v -} - -func (s *cidrListValue) Set(val string) error { - list := []string{} - - for _, elm := range strings.Split(val, s.separator) { - elm = strings.TrimSpace(elm) - if len(elm) != 0 { - list = append(list, elm) - } - } - - *s.p = list - - return nil -} - -func (s *cidrListValue) String() string { - if s.IsEmpty() { - return "(empty)" - } - - return strings.Join(*s.p, s.separator) -} - -func (s *cidrListValue) Validate() error { - for _, cidr := range *s.p { - _, _, err := net.ParseCIDR(cidr) - if err != nil { - return err - } - } - - return nil -} - -func (s *cidrListValue) IsEmpty() bool { - return len(*s.p) == 0 -} - -// array of origins for CORS - -type corsOriginsValue struct { - p *[]string - separator string -} - -func newCORSOriginsValue(p *[]string, val []string, separator string) *corsOriginsValue { - v := &corsOriginsValue{ - p: p, - separator: separator, - } - *p = val - return v -} - -func (s *corsOriginsValue) Set(val string) error { - list := []string{} - - for _, elm := range strings.Split(val, s.separator) { - elm = strings.TrimSpace(elm) - if len(elm) != 0 { - list = append(list, elm) - } - } - - *s.p = list - - return nil -} - -func (s *corsOriginsValue) String() string { - if s.IsEmpty() { - return "(empty)" - } - - return strings.Join(*s.p, s.separator) -} - -func (s *corsOriginsValue) Validate() error { - return cors.Validate(*s.p) -} - -func (s *corsOriginsValue) IsEmpty() bool { - return len(*s.p) == 0 -} - -// boolean - -type boolValue bool - -func newBoolValue(p *bool, val bool) *boolValue { - *p = val - return (*boolValue)(p) -} - -func (b *boolValue) Set(val string) error { - v, err := strconv.ParseBool(val) - if err != nil { - return err - } - *b = boolValue(v) - return nil -} - -func (b *boolValue) String() string { - return strconv.FormatBool(bool(*b)) -} - -func (b *boolValue) Validate() error { - return nil -} - -func (b *boolValue) IsEmpty() bool { - return !bool(*b) -} - -// int - -type intValue int - -func newIntValue(p *int, val int) *intValue { - *p = val - return (*intValue)(p) -} - -func (i *intValue) Set(val string) error { - v, err := strconv.Atoi(val) - if err != nil { - return err - } - *i = intValue(v) - return nil -} - -func (i *intValue) String() string { - return strconv.Itoa(int(*i)) -} - -func (i *intValue) Validate() error { - return nil -} - -func (i *intValue) IsEmpty() bool { - return int(*i) == 0 -} - -// int64 - -type int64Value int64 - -func newInt64Value(p *int64, val int64) *int64Value { - *p = val - return (*int64Value)(p) -} - -func (u *int64Value) Set(val string) error { - v, err := strconv.ParseInt(val, 0, 64) - if err != nil { - return err - } - *u = int64Value(v) - return nil -} - -func (u *int64Value) String() string { - return strconv.FormatInt(int64(*u), 10) -} - -func (u *int64Value) Validate() error { - return nil -} - -func (u *int64Value) IsEmpty() bool { - return int64(*u) == 0 -} - -// uint64 - -type uint64Value uint64 - -func newUint64Value(p *uint64, val uint64) *uint64Value { - *p = val - return (*uint64Value)(p) -} - -func (u *uint64Value) Set(val string) error { - v, err := strconv.ParseUint(val, 0, 64) - if err != nil { - return err - } - *u = uint64Value(v) - return nil -} - -func (u *uint64Value) String() string { - return strconv.FormatUint(uint64(*u), 10) -} - -func (u *uint64Value) Validate() error { - return nil -} - -func (u *uint64Value) IsEmpty() bool { - return uint64(*u) == 0 -} - -// network port - -type portValue int - -func newPortValue(p *int, val int) *portValue { - *p = val - return (*portValue)(p) -} - -func (i *portValue) Set(val string) error { - v, err := strconv.Atoi(val) - if err != nil { - return err - } - *i = portValue(v) - return nil -} - -func (i *portValue) String() string { - return strconv.Itoa(int(*i)) -} - -func (i *portValue) Validate() error { - val := int(*i) - - if val < 0 || val >= (1<<16) { - return fmt.Errorf("%d is not in the range of [0, %d]", val, 1<<16-1) - } - - return nil -} - -func (i *portValue) IsEmpty() bool { - return int(*i) == 0 -} - -// must directory - -type mustDirValue string - -func newMustDirValue(p *string, val string) *mustDirValue { - *p = val - return (*mustDirValue)(p) -} - -func (u *mustDirValue) Set(val string) error { - *u = mustDirValue(val) - return nil -} - -func (u *mustDirValue) String() string { - return string(*u) -} - -func (u *mustDirValue) Validate() error { - val := string(*u) - - if len(strings.TrimSpace(val)) == 0 { - return fmt.Errorf("path name must not be empty") - } - - finfo, err := os.Stat(val) - if err != nil { - return fmt.Errorf("%s does not exist", val) - } - - if !finfo.IsDir() { - return fmt.Errorf("%s is not a directory", val) - } - - return nil -} - -func (u *mustDirValue) IsEmpty() bool { - return len(string(*u)) == 0 -} - -// directory - -type dirValue string - -func newDirValue(p *string, val string) *dirValue { - *p = val - return (*dirValue)(p) -} - -func (u *dirValue) Set(val string) error { - *u = dirValue(val) - return nil -} - -func (u *dirValue) String() string { - return string(*u) -} - -func (u *dirValue) Validate() error { - val := string(*u) - - if len(strings.TrimSpace(val)) == 0 { - return nil - } - - finfo, err := os.Stat(val) - if err != nil { - return fmt.Errorf("%s does not exist", val) - } - - if !finfo.IsDir() { - return fmt.Errorf("%s is not a directory", val) - } - - return nil -} - -func (u *dirValue) IsEmpty() bool { - return len(string(*u)) == 0 -} - -// executable - -type execValue string - -func newExecValue(p *string, val string) *execValue { - *p = val - return (*execValue)(p) -} - -func (u *execValue) Set(val string) error { - *u = execValue(val) - return nil -} - -func (u *execValue) String() string { - return string(*u) -} - -func (u *execValue) Validate() error { - val := string(*u) - - _, err := exec.LookPath(val) - if err != nil { - return fmt.Errorf("%s not found or is not executable", val) - } - - return nil -} - -func (u *execValue) IsEmpty() bool { - return len(string(*u)) == 0 -} - -// regular file - -type fileValue string - -func newFileValue(p *string, val string) *fileValue { - *p = val - return (*fileValue)(p) -} - -func (u *fileValue) Set(val string) error { - *u = fileValue(val) - return nil -} - -func (u *fileValue) String() string { - return string(*u) -} - -func (u *fileValue) Validate() error { - val := string(*u) - - if len(val) == 0 { - return nil - } - - finfo, err := os.Stat(val) - if err != nil { - return fmt.Errorf("%s does not exist", val) - } - - if !finfo.Mode().IsRegular() { - return fmt.Errorf("%s is not a regular file", val) - } - - return nil -} - -func (u *fileValue) IsEmpty() bool { - return len(string(*u)) == 0 -} - -// time - -type timeValue time.Time - -func newTimeValue(p *time.Time, val time.Time) *timeValue { - *p = val - return (*timeValue)(p) -} - -func (u *timeValue) Set(val string) error { - v, err := time.Parse(time.RFC3339, val) - if err != nil { - return err - } - *u = timeValue(v) - return nil -} - -func (u *timeValue) String() string { - v := time.Time(*u) - return v.Format(time.RFC3339) -} - -func (u *timeValue) Validate() error { - return nil -} - -func (u *timeValue) IsEmpty() bool { - v := time.Time(*u) - return v.IsZero() -} - -// url - -type urlValue string - -func newURLValue(p *string, val string) *urlValue { - *p = val - return (*urlValue)(p) -} - -func (u *urlValue) Set(val string) error { - *u = urlValue(val) - return nil -} - -func (u *urlValue) String() string { - return string(*u) -} - -func (u *urlValue) Validate() error { - val := string(*u) - - if len(val) == 0 { - return nil - } - - URL, err := url.Parse(val) - if err != nil { - return fmt.Errorf("%s is not a valid URL", val) - } - - if len(URL.Scheme) == 0 || len(URL.Host) == 0 { - return fmt.Errorf("%s is not a valid URL", val) - } - - return nil -} - -func (u *urlValue) IsEmpty() bool { - return len(string(*u)) == 0 -} - -// absolute path - -type absolutePathValue string - -func newAbsolutePathValue(p *string, val string) *absolutePathValue { - *p = filepath.Clean(val) - return (*absolutePathValue)(p) -} - -func (s *absolutePathValue) Set(val string) error { - *s = absolutePathValue(filepath.Clean(val)) - return nil -} - -func (s *absolutePathValue) String() string { - return string(*s) -} - -func (s *absolutePathValue) Validate() error { - path := string(*s) - - if !filepath.IsAbs(path) { - return fmt.Errorf("%s is not an absolute path", path) - } - - return nil -} - -func (s *absolutePathValue) IsEmpty() bool { - return len(string(*s)) == 0 -} - -// email address - -type emailValue string - -func newEmailValue(p *string, val string) *emailValue { - *p = val - return (*emailValue)(p) -} - -func (s *emailValue) Set(val string) error { - addr, err := mail.ParseAddress(val) - if err != nil { - return err - } - - *s = emailValue(addr.Address) - return nil -} - -func (s *emailValue) String() string { - return string(*s) -} - -func (s *emailValue) Validate() error { - if len(s.String()) == 0 { - return nil - } - - _, err := mail.ParseAddress(s.String()) - return err -} - -func (s *emailValue) IsEmpty() bool { - return len(string(*s)) == 0 -} diff --git a/config/v1/config.go b/config/v1/config.go new file mode 100644 index 00000000..b6f00f2d --- /dev/null +++ b/config/v1/config.go @@ -0,0 +1,397 @@ +package v1 + +import ( + "context" + "net" + "time" + + "github.com/datarhei/core/v16/config/copy" + "github.com/datarhei/core/v16/config/value" + "github.com/datarhei/core/v16/config/vars" + "github.com/datarhei/core/v16/math/rand" + + haikunator "github.com/atrox/haikunatorgo/v2" + "github.com/google/uuid" +) + +const version int64 = 1 + +// Make sure that the config.Config interface is satisfied +//var _ config.Config = &Config{} + +// Config is a wrapper for Data +type Config struct { + vars vars.Variables + + Data +} + +// New returns a Config which is initialized with its default values +func New() *Config { + cfg := &Config{} + + cfg.init() + + return cfg +} + +func (d *Config) Get(name string) (string, error) { + return d.vars.Get(name) +} + +func (d *Config) Set(name, val string) error { + return d.vars.Set(name, val) +} + +// NewConfigFrom returns a clone of a Config +func (d *Config) Clone() *Config { + data := New() + + data.CreatedAt = d.CreatedAt + data.LoadedAt = d.LoadedAt + data.UpdatedAt = d.UpdatedAt + + data.Version = d.Version + data.ID = d.ID + data.Name = d.Name + data.Address = d.Address + data.CheckForUpdates = d.CheckForUpdates + + data.Log = d.Log + data.DB = d.DB + data.Host = d.Host + data.API = d.API + data.TLS = d.TLS + data.Storage = d.Storage + data.RTMP = d.RTMP + data.SRT = d.SRT + data.FFmpeg = d.FFmpeg + data.Playout = d.Playout + data.Debug = d.Debug + data.Metrics = d.Metrics + data.Sessions = d.Sessions + data.Service = d.Service + data.Router = d.Router + + data.Log.Topics = copy.Slice(d.Log.Topics) + + data.Host.Name = copy.Slice(d.Host.Name) + + data.API.Access.HTTP.Allow = copy.Slice(d.API.Access.HTTP.Allow) + data.API.Access.HTTP.Block = copy.Slice(d.API.Access.HTTP.Block) + data.API.Access.HTTPS.Allow = copy.Slice(d.API.Access.HTTPS.Allow) + data.API.Access.HTTPS.Block = copy.Slice(d.API.Access.HTTPS.Block) + + data.API.Auth.Auth0.Tenants = copy.TenantSlice(d.API.Auth.Auth0.Tenants) + + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) + data.Storage.Disk.Cache.Types = copy.Slice(d.Storage.Disk.Cache.Types) + + data.FFmpeg.Access.Input.Allow = copy.Slice(d.FFmpeg.Access.Input.Allow) + data.FFmpeg.Access.Input.Block = copy.Slice(d.FFmpeg.Access.Input.Block) + data.FFmpeg.Access.Output.Allow = copy.Slice(d.FFmpeg.Access.Output.Allow) + data.FFmpeg.Access.Output.Block = copy.Slice(d.FFmpeg.Access.Output.Block) + + data.Sessions.IPIgnoreList = copy.Slice(d.Sessions.IPIgnoreList) + + data.SRT.Log.Topics = copy.Slice(d.SRT.Log.Topics) + + data.Router.BlockedPrefixes = copy.Slice(d.Router.BlockedPrefixes) + data.Router.Routes = copy.StringMap(d.Router.Routes) + + data.vars.Transfer(&d.vars) + + return data +} + +func (d *Config) init() { + d.vars.Register(value.NewInt64(&d.Version, version), "version", "", nil, "Configuration file layout version", true, false) + d.vars.Register(value.NewTime(&d.CreatedAt, time.Now()), "created_at", "", nil, "Configuration file creation time", false, false) + d.vars.Register(value.NewString(&d.ID, uuid.New().String()), "id", "CORE_ID", nil, "ID for this instance", true, false) + d.vars.Register(value.NewString(&d.Name, haikunator.New().Haikunate()), "name", "CORE_NAME", nil, "A human readable name for this instance", false, false) + d.vars.Register(value.NewAddress(&d.Address, ":8080"), "address", "CORE_ADDRESS", nil, "HTTP listening address", false, false) + d.vars.Register(value.NewBool(&d.CheckForUpdates, true), "update_check", "CORE_UPDATE_CHECK", nil, "Check for updates and send anonymized data", false, false) + + // Log + d.vars.Register(value.NewString(&d.Log.Level, "info"), "log.level", "CORE_LOG_LEVEL", nil, "Loglevel: silent, error, warn, info, debug", false, false) + d.vars.Register(value.NewStringList(&d.Log.Topics, []string{}, ","), "log.topics", "CORE_LOG_TOPICS", nil, "Show only selected log topics", false, false) + d.vars.Register(value.NewInt(&d.Log.MaxLines, 1000), "log.max_lines", "CORE_LOG_MAXLINES", nil, "Number of latest log lines to keep in memory", false, false) + + // DB + d.vars.Register(value.NewMustDir(&d.DB.Dir, "./config"), "db.dir", "CORE_DB_DIR", nil, "Directory for holding the operational data", false, false) + + // Host + d.vars.Register(value.NewStringList(&d.Host.Name, []string{}, ","), "host.name", "CORE_HOST_NAME", nil, "Comma separated list of public host/domain names or IPs", false, false) + d.vars.Register(value.NewBool(&d.Host.Auto, true), "host.auto", "CORE_HOST_AUTO", nil, "Enable detection of public IP addresses", false, false) + + // API + d.vars.Register(value.NewBool(&d.API.ReadOnly, false), "api.read_only", "CORE_API_READ_ONLY", nil, "Allow only ready only access to the API", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTP.Allow, []string{}, ","), "api.access.http.allow", "CORE_API_ACCESS_HTTP_ALLOW", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTP.Block, []string{}, ","), "api.access.http.block", "CORE_API_ACCESS_HTTP_BLOCK", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTPS.Allow, []string{}, ","), "api.access.https.allow", "CORE_API_ACCESS_HTTPS_ALLOW", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTPS.Block, []string{}, ","), "api.access.https.block", "CORE_API_ACCESS_HTTPS_BLOCK", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) + d.vars.Register(value.NewBool(&d.API.Auth.Enable, false), "api.auth.enable", "CORE_API_AUTH_ENABLE", nil, "Enable authentication for all clients", false, false) + d.vars.Register(value.NewBool(&d.API.Auth.DisableLocalhost, false), "api.auth.disable_localhost", "CORE_API_AUTH_DISABLE_LOCALHOST", nil, "Disable authentication for clients from localhost", false, false) + d.vars.Register(value.NewString(&d.API.Auth.Username, ""), "api.auth.username", "CORE_API_AUTH_USERNAME", []string{"RS_USERNAME"}, "Username", false, false) + d.vars.Register(value.NewString(&d.API.Auth.Password, ""), "api.auth.password", "CORE_API_AUTH_PASSWORD", []string{"RS_PASSWORD"}, "Password", false, true) + + // Auth JWT + d.vars.Register(value.NewString(&d.API.Auth.JWT.Secret, rand.String(32)), "api.auth.jwt.secret", "CORE_API_AUTH_JWT_SECRET", nil, "JWT secret, leave empty for generating a random value", false, true) + + // Auth Auth0 + d.vars.Register(value.NewBool(&d.API.Auth.Auth0.Enable, false), "api.auth.auth0.enable", "CORE_API_AUTH_AUTH0_ENABLE", nil, "Enable Auth0", false, false) + d.vars.Register(value.NewTenantList(&d.API.Auth.Auth0.Tenants, []value.Auth0Tenant{}, ","), "api.auth.auth0.tenants", "CORE_API_AUTH_AUTH0_TENANTS", nil, "List of Auth0 tenants", false, false) + + // TLS + d.vars.Register(value.NewAddress(&d.TLS.Address, ":8181"), "tls.address", "CORE_TLS_ADDRESS", nil, "HTTPS listening address", false, false) + d.vars.Register(value.NewBool(&d.TLS.Enable, false), "tls.enable", "CORE_TLS_ENABLE", nil, "Enable HTTPS", false, false) + d.vars.Register(value.NewBool(&d.TLS.Auto, false), "tls.auto", "CORE_TLS_AUTO", nil, "Enable Let's Encrypt certificate", false, false) + d.vars.Register(value.NewFile(&d.TLS.CertFile, ""), "tls.cert_file", "CORE_TLS_CERTFILE", nil, "Path to certificate file in PEM format", false, false) + d.vars.Register(value.NewFile(&d.TLS.KeyFile, ""), "tls.key_file", "CORE_TLS_KEYFILE", nil, "Path to key file in PEM format", false, false) + + // Storage + d.vars.Register(value.NewFile(&d.Storage.MimeTypes, "./mime.types"), "storage.mimetypes_file", "CORE_STORAGE_MIMETYPES_FILE", []string{"CORE_MIMETYPES_FILE"}, "Path to file with mime-types", false, false) + + // Storage (Disk) + d.vars.Register(value.NewMustDir(&d.Storage.Disk.Dir, "./data"), "storage.disk.dir", "CORE_STORAGE_DISK_DIR", nil, "Directory on disk, exposed on /", false, false) + d.vars.Register(value.NewInt64(&d.Storage.Disk.Size, 0), "storage.disk.max_size_mbytes", "CORE_STORAGE_DISK_MAXSIZEMBYTES", nil, "Max. allowed megabytes for storage.disk.dir, 0 for unlimited", false, false) + d.vars.Register(value.NewBool(&d.Storage.Disk.Cache.Enable, true), "storage.disk.cache.enable", "CORE_STORAGE_DISK_CACHE_ENABLE", nil, "Enable cache for /", false, false) + d.vars.Register(value.NewUint64(&d.Storage.Disk.Cache.Size, 0), "storage.disk.cache.max_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXSIZEMBYTES", nil, "Max. allowed cache size, 0 for unlimited", false, false) + d.vars.Register(value.NewInt64(&d.Storage.Disk.Cache.TTL, 300), "storage.disk.cache.ttl_seconds", "CORE_STORAGE_DISK_CACHE_TTLSECONDS", nil, "Seconds to keep files in cache", false, false) + d.vars.Register(value.NewUint64(&d.Storage.Disk.Cache.FileSize, 1), "storage.disk.cache.max_file_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXFILESIZEMBYTES", nil, "Max. file size to put in cache", false, false) + d.vars.Register(value.NewStringList(&d.Storage.Disk.Cache.Types, []string{}, " "), "storage.disk.cache.types", "CORE_STORAGE_DISK_CACHE_TYPES_ALLOW", []string{"CORE_STORAGE_DISK_CACHE_TYPES"}, "File extensions to cache, empty for all", false, false) + + // Storage (Memory) + d.vars.Register(value.NewBool(&d.Storage.Memory.Auth.Enable, true), "storage.memory.auth.enable", "CORE_STORAGE_MEMORY_AUTH_ENABLE", nil, "Enable basic auth for PUT,POST, and DELETE on /memfs", false, false) + d.vars.Register(value.NewString(&d.Storage.Memory.Auth.Username, "admin"), "storage.memory.auth.username", "CORE_STORAGE_MEMORY_AUTH_USERNAME", nil, "Username for Basic-Auth of /memfs", false, false) + d.vars.Register(value.NewString(&d.Storage.Memory.Auth.Password, rand.StringAlphanumeric(18)), "storage.memory.auth.password", "CORE_STORAGE_MEMORY_AUTH_PASSWORD", nil, "Password for Basic-Auth of /memfs", false, true) + d.vars.Register(value.NewInt64(&d.Storage.Memory.Size, 0), "storage.memory.max_size_mbytes", "CORE_STORAGE_MEMORY_MAXSIZEMBYTES", nil, "Max. allowed megabytes for /memfs, 0 for unlimited", false, false) + d.vars.Register(value.NewBool(&d.Storage.Memory.Purge, false), "storage.memory.purge", "CORE_STORAGE_MEMORY_PURGE", nil, "Automatically remove the oldest files if /memfs is full", false, false) + + // Storage (CORS) + d.vars.Register(value.NewCORSOrigins(&d.Storage.CORS.Origins, []string{"*"}, ","), "storage.cors.origins", "CORE_STORAGE_CORS_ORIGINS", nil, "Allowed CORS origins for /memfs and /data", false, false) + + // RTMP + d.vars.Register(value.NewBool(&d.RTMP.Enable, false), "rtmp.enable", "CORE_RTMP_ENABLE", nil, "Enable RTMP server", false, false) + d.vars.Register(value.NewBool(&d.RTMP.EnableTLS, false), "rtmp.enable_tls", "CORE_RTMP_ENABLE_TLS", nil, "Enable RTMPS server instead of RTMP", false, false) + d.vars.Register(value.NewAddress(&d.RTMP.Address, ":1935"), "rtmp.address", "CORE_RTMP_ADDRESS", nil, "RTMP server listen address", false, false) + d.vars.Register(value.NewAbsolutePath(&d.RTMP.App, "/"), "rtmp.app", "CORE_RTMP_APP", nil, "RTMP app for publishing", false, false) + d.vars.Register(value.NewString(&d.RTMP.Token, ""), "rtmp.token", "CORE_RTMP_TOKEN", nil, "RTMP token for publishing and playing", false, true) + + // SRT + d.vars.Register(value.NewBool(&d.SRT.Enable, false), "srt.enable", "CORE_SRT_ENABLE", nil, "Enable SRT server", false, false) + d.vars.Register(value.NewAddress(&d.SRT.Address, ":6000"), "srt.address", "CORE_SRT_ADDRESS", nil, "SRT server listen address", false, false) + d.vars.Register(value.NewString(&d.SRT.Passphrase, ""), "srt.passphrase", "CORE_SRT_PASSPHRASE", nil, "SRT encryption passphrase", false, true) + d.vars.Register(value.NewString(&d.SRT.Token, ""), "srt.token", "CORE_SRT_TOKEN", nil, "SRT token for publishing and playing", false, true) + d.vars.Register(value.NewBool(&d.SRT.Log.Enable, false), "srt.log.enable", "CORE_SRT_LOG_ENABLE", nil, "Enable SRT server logging", false, false) + d.vars.Register(value.NewStringList(&d.SRT.Log.Topics, []string{}, ","), "srt.log.topics", "CORE_SRT_LOG_TOPICS", nil, "List of topics to log", false, false) + + // FFmpeg + d.vars.Register(value.NewExec(&d.FFmpeg.Binary, "ffmpeg"), "ffmpeg.binary", "CORE_FFMPEG_BINARY", nil, "Path to ffmpeg binary", true, false) + d.vars.Register(value.NewInt64(&d.FFmpeg.MaxProcesses, 0), "ffmpeg.max_processes", "CORE_FFMPEG_MAXPROCESSES", nil, "Max. allowed simultaneously running ffmpeg instances, 0 for unlimited", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Input.Allow, []string{}, " "), "ffmpeg.access.input.allow", "CORE_FFMPEG_ACCESS_INPUT_ALLOW", nil, "List of allowed expression to match against the input addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Input.Block, []string{}, " "), "ffmpeg.access.input.block", "CORE_FFMPEG_ACCESS_INPUT_BLOCK", nil, "List of blocked expression to match against the input addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Output.Allow, []string{}, " "), "ffmpeg.access.output.allow", "CORE_FFMPEG_ACCESS_OUTPUT_ALLOW", nil, "List of allowed expression to match against the output addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Output.Block, []string{}, " "), "ffmpeg.access.output.block", "CORE_FFMPEG_ACCESS_OUTPUT_BLOCK", nil, "List of blocked expression to match against the output addresses", false, false) + d.vars.Register(value.NewInt(&d.FFmpeg.Log.MaxLines, 50), "ffmpeg.log.max_lines", "CORE_FFMPEG_LOG_MAXLINES", nil, "Number of latest log lines to keep for each process", false, false) + d.vars.Register(value.NewInt(&d.FFmpeg.Log.MaxHistory, 3), "ffmpeg.log.max_history", "CORE_FFMPEG_LOG_MAXHISTORY", nil, "Number of latest logs to keep for each process", false, false) + + // Playout + d.vars.Register(value.NewBool(&d.Playout.Enable, false), "playout.enable", "CORE_PLAYOUT_ENABLE", nil, "Enable playout proxy where available", false, false) + d.vars.Register(value.NewPort(&d.Playout.MinPort, 0), "playout.min_port", "CORE_PLAYOUT_MINPORT", nil, "Min. playout server port", false, false) + d.vars.Register(value.NewPort(&d.Playout.MaxPort, 0), "playout.max_port", "CORE_PLAYOUT_MAXPORT", nil, "Max. playout server port", false, false) + + // Debug + d.vars.Register(value.NewBool(&d.Debug.Profiling, false), "debug.profiling", "CORE_DEBUG_PROFILING", nil, "Enable profiling endpoint on /profiling", false, false) + d.vars.Register(value.NewInt(&d.Debug.ForceGC, 0), "debug.force_gc", "CORE_DEBUG_FORCEGC", nil, "Number of seconds between forcing GC to return memory to the OS", false, false) + + // Metrics + d.vars.Register(value.NewBool(&d.Metrics.Enable, false), "metrics.enable", "CORE_METRICS_ENABLE", nil, "Enable collecting historic metrics data", false, false) + d.vars.Register(value.NewBool(&d.Metrics.EnablePrometheus, false), "metrics.enable_prometheus", "CORE_METRICS_ENABLE_PROMETHEUS", nil, "Enable prometheus endpoint /metrics", false, false) + d.vars.Register(value.NewInt64(&d.Metrics.Range, 300), "metrics.range_seconds", "CORE_METRICS_RANGE_SECONDS", nil, "Seconds to keep history data", false, false) + d.vars.Register(value.NewInt64(&d.Metrics.Interval, 2), "metrics.interval_seconds", "CORE_METRICS_INTERVAL_SECONDS", nil, "Interval for collecting metrics", false, false) + + // Sessions + d.vars.Register(value.NewBool(&d.Sessions.Enable, true), "sessions.enable", "CORE_SESSIONS_ENABLE", nil, "Enable collecting HLS session stats for /memfs", false, false) + d.vars.Register(value.NewCIDRList(&d.Sessions.IPIgnoreList, []string{"127.0.0.1/32", "::1/128"}, ","), "sessions.ip_ignorelist", "CORE_SESSIONS_IP_IGNORELIST", nil, "List of IP ranges in CIDR notation to ignore", false, false) + d.vars.Register(value.NewInt(&d.Sessions.SessionTimeout, 30), "sessions.session_timeout_sec", "CORE_SESSIONS_SESSION_TIMEOUT_SEC", nil, "Timeout for an idle session", false, false) + d.vars.Register(value.NewBool(&d.Sessions.Persist, false), "sessions.persist", "CORE_SESSIONS_PERSIST", nil, "Whether to persist session history. Will be stored as sessions.json in db.dir", false, false) + d.vars.Register(value.NewInt(&d.Sessions.PersistInterval, 300), "sessions.persist_interval_sec", "CORE_SESSIONS_PERSIST_INTERVAL_SEC", nil, "Interval in seconds in which to persist the current session history", false, false) + d.vars.Register(value.NewUint64(&d.Sessions.MaxBitrate, 0), "sessions.max_bitrate_mbit", "CORE_SESSIONS_MAXBITRATE_MBIT", nil, "Max. allowed outgoing bitrate in mbit/s, 0 for unlimited", false, false) + d.vars.Register(value.NewUint64(&d.Sessions.MaxSessions, 0), "sessions.max_sessions", "CORE_SESSIONS_MAXSESSIONS", nil, "Max. allowed number of simultaneous sessions, 0 for unlimited", false, false) + + // Service + d.vars.Register(value.NewBool(&d.Service.Enable, false), "service.enable", "CORE_SERVICE_ENABLE", nil, "Enable connecting to the Restreamer Service", false, false) + d.vars.Register(value.NewString(&d.Service.Token, ""), "service.token", "CORE_SERVICE_TOKEN", nil, "Restreamer Service account token", false, true) + d.vars.Register(value.NewURL(&d.Service.URL, "https://service.datarhei.com"), "service.url", "CORE_SERVICE_URL", nil, "URL of the Restreamer Service", false, false) + + // Router + d.vars.Register(value.NewStringList(&d.Router.BlockedPrefixes, []string{"/api"}, ","), "router.blocked_prefixes", "CORE_ROUTER_BLOCKED_PREFIXES", nil, "List of path prefixes that can't be routed", false, false) + d.vars.Register(value.NewStringMapString(&d.Router.Routes, nil), "router.routes", "CORE_ROUTER_ROUTES", nil, "List of route mappings", false, false) + d.vars.Register(value.NewDir(&d.Router.UIPath, ""), "router.ui_path", "CORE_ROUTER_UI_PATH", nil, "Path to a directory holding UI files mounted as /ui", false, false) +} + +// Validate validates the current state of the Config for completeness and sanity. Errors are +// written to the log. Use resetLogs to indicate to reset the logs prior validation. +func (d *Config) Validate(resetLogs bool) { + if resetLogs { + d.vars.ResetLogs() + } + + if d.Version != version { + d.vars.Log("error", "version", "unknown configuration layout version (found version %d, expecting version %d)", d.Version, version) + + return + } + + d.vars.Validate() + + // Individual sanity checks + + // If HTTP Auth is enabled, check that the username and password are set + if d.API.Auth.Enable { + if len(d.API.Auth.Username) == 0 || len(d.API.Auth.Password) == 0 { + d.vars.Log("error", "api.auth.enable", "api.auth.username and api.auth.password must be set") + } + } + + // If Auth0 is enabled, check that domain, audience, and clientid are set + if d.API.Auth.Auth0.Enable { + if len(d.API.Auth.Auth0.Tenants) == 0 { + d.vars.Log("error", "api.auth.auth0.enable", "at least one tenants must be set") + } + + for i, t := range d.API.Auth.Auth0.Tenants { + if len(t.Domain) == 0 || len(t.Audience) == 0 || len(t.ClientID) == 0 { + d.vars.Log("error", "api.auth.auth0.tenants", "domain, audience, and clientid must be set (tenant %d)", i) + } + } + } + + // If TLS is enabled and Let's Encrypt is disabled, require certfile and keyfile + if d.TLS.Enable && !d.TLS.Auto { + if len(d.TLS.CertFile) == 0 || len(d.TLS.KeyFile) == 0 { + d.vars.Log("error", "tls.enable", "tls.certfile and tls.keyfile must be set") + } + } + + // If TLS and Let's Encrypt certificate is enabled, we require a public hostname + if d.TLS.Enable && d.TLS.Auto { + if len(d.Host.Name) == 0 { + d.vars.Log("error", "host.name", "a hostname must be set in order to get an automatic TLS certificate") + } else { + r := &net.Resolver{ + PreferGo: true, + StrictErrors: true, + } + + for _, host := range d.Host.Name { + // Don't lookup IP addresses + if ip := net.ParseIP(host); ip != nil { + d.vars.Log("error", "host.name", "only host names are allowed if automatic TLS is enabled, but found IP address: %s", host) + } + + // Lookup host name with a timeout + ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) + + _, err := r.LookupHost(ctx, host) + if err != nil { + d.vars.Log("error", "host.name", "the host '%s' can't be resolved and will not work with automatic TLS", host) + } + + cancel() + } + } + } + + // If TLS for RTMP is enabled, TLS must be enabled + if d.RTMP.EnableTLS { + if !d.RTMP.Enable { + d.vars.Log("error", "rtmp.enable", "RTMP server must be enabled if RTMPS server is enabled") + } + + if !d.TLS.Enable { + d.vars.Log("error", "rtmp.enable_tls", "RTMPS server can only be enabled if TLS is enabled") + } + } + + // If CORE_MEMFS_USERNAME and CORE_MEMFS_PASSWORD are set, automatically active/deactivate Basic-Auth for memfs + if d.vars.IsMerged("storage.memory.auth.username") && d.vars.IsMerged("storage.memory.auth.password") { + d.Storage.Memory.Auth.Enable = true + + if len(d.Storage.Memory.Auth.Username) == 0 && len(d.Storage.Memory.Auth.Password) == 0 { + d.Storage.Memory.Auth.Enable = false + } + } + + // If Basic-Auth for memfs is enable, check that the username and password are set + if d.Storage.Memory.Auth.Enable { + if len(d.Storage.Memory.Auth.Username) == 0 || len(d.Storage.Memory.Auth.Password) == 0 { + d.vars.Log("error", "storage.memory.auth.enable", "storage.memory.auth.username and storage.memory.auth.password must be set") + } + } + + // If playout is enabled, check that the port range is sane + if d.Playout.Enable { + if d.Playout.MinPort >= d.Playout.MaxPort { + d.vars.Log("error", "playout.min_port", "must be bigger than playout.max_port") + } + } + + // If cache is enabled, a valid TTL has to be set to a useful value + if d.Storage.Disk.Cache.Enable && d.Storage.Disk.Cache.TTL < 0 { + d.vars.Log("error", "storage.disk.cache.ttl_seconds", "must be equal or greater than 0") + } + + // If the stats are enabled, the session timeout has to be set to a useful value + if d.Sessions.Enable && d.Sessions.SessionTimeout < 1 { + d.vars.Log("error", "stats.session_timeout_sec", "must be equal or greater than 1") + } + + // If the stats and their persistence are enabled, the persist interval has to be set to a useful value + if d.Sessions.Enable && d.Sessions.PersistInterval < 0 { + d.vars.Log("error", "stats.persist_interval_sec", "must be at equal or greater than 0") + } + + // If the service is enabled, the token and enpoint have to be defined + if d.Service.Enable { + if len(d.Service.Token) == 0 { + d.vars.Log("error", "service.token", "must be non-empty") + } + + if len(d.Service.URL) == 0 { + d.vars.Log("error", "service.url", "must be non-empty") + } + } + + // If historic metrics are enabled, the timerange and interval have to be valid + if d.Metrics.Enable { + if d.Metrics.Range <= 0 { + d.vars.Log("error", "metrics.range", "must be greater 0") + } + + if d.Metrics.Interval <= 0 { + d.vars.Log("error", "metrics.interval", "must be greater 0") + } + + if d.Metrics.Interval > d.Metrics.Range { + d.vars.Log("error", "metrics.interval", "must be smaller than the range") + } + } +} + +func (d *Config) Merge() { + d.vars.Merge() +} + +func (d *Config) Messages(logger func(level string, v vars.Variable, message string)) { + d.vars.Messages(logger) +} + +func (d *Config) HasErrors() bool { + return d.vars.HasErrors() +} + +func (d *Config) Overrides() []string { + return d.vars.Overrides() +} diff --git a/config/data_v1.go b/config/v1/data.go similarity index 95% rename from config/data_v1.go rename to config/v1/data.go index bfd77a64..e398adbb 100644 --- a/config/data_v1.go +++ b/config/v1/data.go @@ -1,8 +1,12 @@ -package config +package v1 -import "time" +import ( + "time" -type dataV1 struct { + "github.com/datarhei/core/v16/config/value" +) + +type Data struct { CreatedAt time.Time `json:"created_at"` LoadedAt time.Time `json:"-"` UpdatedAt time.Time `json:"-"` @@ -44,8 +48,8 @@ type dataV1 struct { Secret string `json:"secret"` } `json:"jwt"` Auth0 struct { - Enable bool `json:"enable"` - Tenants []Auth0Tenant `json:"tenants"` + Enable bool `json:"enable"` + Tenants []value.Auth0Tenant `json:"tenants"` } `json:"auth0"` } `json:"auth"` } `json:"api"` diff --git a/config/v2/config.go b/config/v2/config.go new file mode 100644 index 00000000..c3992da7 --- /dev/null +++ b/config/v2/config.go @@ -0,0 +1,398 @@ +package v2 + +import ( + "context" + "net" + "time" + + "github.com/datarhei/core/v16/config/copy" + "github.com/datarhei/core/v16/config/value" + "github.com/datarhei/core/v16/config/vars" + "github.com/datarhei/core/v16/math/rand" + + haikunator "github.com/atrox/haikunatorgo/v2" + "github.com/google/uuid" +) + +const version int64 = 2 + +// Make sure that the config.Config interface is satisfied +//var _ config.Config = &Config{} + +// Config is a wrapper for Data +type Config struct { + vars vars.Variables + + Data +} + +// New returns a Config which is initialized with its default values +func New() *Config { + cfg := &Config{} + + cfg.init() + + return cfg +} + +func (d *Config) Get(name string) (string, error) { + return d.vars.Get(name) +} + +func (d *Config) Set(name, val string) error { + return d.vars.Set(name, val) +} + +// NewConfigFrom returns a clone of a Config +func (d *Config) Clone() *Config { + data := New() + + data.CreatedAt = d.CreatedAt + data.LoadedAt = d.LoadedAt + data.UpdatedAt = d.UpdatedAt + + data.Version = d.Version + data.ID = d.ID + data.Name = d.Name + data.Address = d.Address + data.CheckForUpdates = d.CheckForUpdates + + data.Log = d.Log + data.DB = d.DB + data.Host = d.Host + data.API = d.API + data.TLS = d.TLS + data.Storage = d.Storage + data.RTMP = d.RTMP + data.SRT = d.SRT + data.FFmpeg = d.FFmpeg + data.Playout = d.Playout + data.Debug = d.Debug + data.Metrics = d.Metrics + data.Sessions = d.Sessions + data.Service = d.Service + data.Router = d.Router + + data.Log.Topics = copy.Slice(d.Log.Topics) + + data.Host.Name = copy.Slice(d.Host.Name) + + data.API.Access.HTTP.Allow = copy.Slice(d.API.Access.HTTP.Allow) + data.API.Access.HTTP.Block = copy.Slice(d.API.Access.HTTP.Block) + data.API.Access.HTTPS.Allow = copy.Slice(d.API.Access.HTTPS.Allow) + data.API.Access.HTTPS.Block = copy.Slice(d.API.Access.HTTPS.Block) + + data.API.Auth.Auth0.Tenants = copy.TenantSlice(d.API.Auth.Auth0.Tenants) + + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) + data.Storage.Disk.Cache.Types = copy.Slice(d.Storage.Disk.Cache.Types) + + data.FFmpeg.Access.Input.Allow = copy.Slice(d.FFmpeg.Access.Input.Allow) + data.FFmpeg.Access.Input.Block = copy.Slice(d.FFmpeg.Access.Input.Block) + data.FFmpeg.Access.Output.Allow = copy.Slice(d.FFmpeg.Access.Output.Allow) + data.FFmpeg.Access.Output.Block = copy.Slice(d.FFmpeg.Access.Output.Block) + + data.Sessions.IPIgnoreList = copy.Slice(d.Sessions.IPIgnoreList) + + data.SRT.Log.Topics = copy.Slice(d.SRT.Log.Topics) + + data.Router.BlockedPrefixes = copy.Slice(d.Router.BlockedPrefixes) + data.Router.Routes = copy.StringMap(d.Router.Routes) + + data.vars.Transfer(&d.vars) + + return data +} + +func (d *Config) init() { + d.vars.Register(value.NewInt64(&d.Version, version), "version", "", nil, "Configuration file layout version", true, false) + d.vars.Register(value.NewTime(&d.CreatedAt, time.Now()), "created_at", "", nil, "Configuration file creation time", false, false) + d.vars.Register(value.NewString(&d.ID, uuid.New().String()), "id", "CORE_ID", nil, "ID for this instance", true, false) + d.vars.Register(value.NewString(&d.Name, haikunator.New().Haikunate()), "name", "CORE_NAME", nil, "A human readable name for this instance", false, false) + d.vars.Register(value.NewAddress(&d.Address, ":8080"), "address", "CORE_ADDRESS", nil, "HTTP listening address", false, false) + d.vars.Register(value.NewBool(&d.CheckForUpdates, true), "update_check", "CORE_UPDATE_CHECK", nil, "Check for updates and send anonymized data", false, false) + + // Log + d.vars.Register(value.NewString(&d.Log.Level, "info"), "log.level", "CORE_LOG_LEVEL", nil, "Loglevel: silent, error, warn, info, debug", false, false) + d.vars.Register(value.NewStringList(&d.Log.Topics, []string{}, ","), "log.topics", "CORE_LOG_TOPICS", nil, "Show only selected log topics", false, false) + d.vars.Register(value.NewInt(&d.Log.MaxLines, 1000), "log.max_lines", "CORE_LOG_MAXLINES", nil, "Number of latest log lines to keep in memory", false, false) + + // DB + d.vars.Register(value.NewMustDir(&d.DB.Dir, "./config"), "db.dir", "CORE_DB_DIR", nil, "Directory for holding the operational data", false, false) + + // Host + d.vars.Register(value.NewStringList(&d.Host.Name, []string{}, ","), "host.name", "CORE_HOST_NAME", nil, "Comma separated list of public host/domain names or IPs", false, false) + d.vars.Register(value.NewBool(&d.Host.Auto, true), "host.auto", "CORE_HOST_AUTO", nil, "Enable detection of public IP addresses", false, false) + + // API + d.vars.Register(value.NewBool(&d.API.ReadOnly, false), "api.read_only", "CORE_API_READ_ONLY", nil, "Allow only ready only access to the API", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTP.Allow, []string{}, ","), "api.access.http.allow", "CORE_API_ACCESS_HTTP_ALLOW", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTP.Block, []string{}, ","), "api.access.http.block", "CORE_API_ACCESS_HTTP_BLOCK", nil, "List of IPs in CIDR notation (HTTP traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTPS.Allow, []string{}, ","), "api.access.https.allow", "CORE_API_ACCESS_HTTPS_ALLOW", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) + d.vars.Register(value.NewCIDRList(&d.API.Access.HTTPS.Block, []string{}, ","), "api.access.https.block", "CORE_API_ACCESS_HTTPS_BLOCK", nil, "List of IPs in CIDR notation (HTTPS traffic)", false, false) + d.vars.Register(value.NewBool(&d.API.Auth.Enable, false), "api.auth.enable", "CORE_API_AUTH_ENABLE", nil, "Enable authentication for all clients", false, false) + d.vars.Register(value.NewBool(&d.API.Auth.DisableLocalhost, false), "api.auth.disable_localhost", "CORE_API_AUTH_DISABLE_LOCALHOST", nil, "Disable authentication for clients from localhost", false, false) + d.vars.Register(value.NewString(&d.API.Auth.Username, ""), "api.auth.username", "CORE_API_AUTH_USERNAME", []string{"RS_USERNAME"}, "Username", false, false) + d.vars.Register(value.NewString(&d.API.Auth.Password, ""), "api.auth.password", "CORE_API_AUTH_PASSWORD", []string{"RS_PASSWORD"}, "Password", false, true) + + // Auth JWT + d.vars.Register(value.NewString(&d.API.Auth.JWT.Secret, rand.String(32)), "api.auth.jwt.secret", "CORE_API_AUTH_JWT_SECRET", nil, "JWT secret, leave empty for generating a random value", false, true) + + // Auth Auth0 + d.vars.Register(value.NewBool(&d.API.Auth.Auth0.Enable, false), "api.auth.auth0.enable", "CORE_API_AUTH_AUTH0_ENABLE", nil, "Enable Auth0", false, false) + d.vars.Register(value.NewTenantList(&d.API.Auth.Auth0.Tenants, []value.Auth0Tenant{}, ","), "api.auth.auth0.tenants", "CORE_API_AUTH_AUTH0_TENANTS", nil, "List of Auth0 tenants", false, false) + + // TLS + d.vars.Register(value.NewAddress(&d.TLS.Address, ":8181"), "tls.address", "CORE_TLS_ADDRESS", nil, "HTTPS listening address", false, false) + d.vars.Register(value.NewBool(&d.TLS.Enable, false), "tls.enable", "CORE_TLS_ENABLE", nil, "Enable HTTPS", false, false) + d.vars.Register(value.NewBool(&d.TLS.Auto, false), "tls.auto", "CORE_TLS_AUTO", nil, "Enable Let's Encrypt certificate", false, false) + d.vars.Register(value.NewFile(&d.TLS.CertFile, ""), "tls.cert_file", "CORE_TLS_CERTFILE", nil, "Path to certificate file in PEM format", false, false) + d.vars.Register(value.NewFile(&d.TLS.KeyFile, ""), "tls.key_file", "CORE_TLS_KEYFILE", nil, "Path to key file in PEM format", false, false) + + // Storage + d.vars.Register(value.NewFile(&d.Storage.MimeTypes, "./mime.types"), "storage.mimetypes_file", "CORE_STORAGE_MIMETYPES_FILE", []string{"CORE_MIMETYPES_FILE"}, "Path to file with mime-types", false, false) + + // Storage (Disk) + d.vars.Register(value.NewMustDir(&d.Storage.Disk.Dir, "./data"), "storage.disk.dir", "CORE_STORAGE_DISK_DIR", nil, "Directory on disk, exposed on /", false, false) + d.vars.Register(value.NewInt64(&d.Storage.Disk.Size, 0), "storage.disk.max_size_mbytes", "CORE_STORAGE_DISK_MAXSIZEMBYTES", nil, "Max. allowed megabytes for storage.disk.dir, 0 for unlimited", false, false) + d.vars.Register(value.NewBool(&d.Storage.Disk.Cache.Enable, true), "storage.disk.cache.enable", "CORE_STORAGE_DISK_CACHE_ENABLE", nil, "Enable cache for /", false, false) + d.vars.Register(value.NewUint64(&d.Storage.Disk.Cache.Size, 0), "storage.disk.cache.max_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXSIZEMBYTES", nil, "Max. allowed cache size, 0 for unlimited", false, false) + d.vars.Register(value.NewInt64(&d.Storage.Disk.Cache.TTL, 300), "storage.disk.cache.ttl_seconds", "CORE_STORAGE_DISK_CACHE_TTLSECONDS", nil, "Seconds to keep files in cache", false, false) + d.vars.Register(value.NewUint64(&d.Storage.Disk.Cache.FileSize, 1), "storage.disk.cache.max_file_size_mbytes", "CORE_STORAGE_DISK_CACHE_MAXFILESIZEMBYTES", nil, "Max. file size to put in cache", false, false) + d.vars.Register(value.NewStringList(&d.Storage.Disk.Cache.Types, []string{}, " "), "storage.disk.cache.types", "CORE_STORAGE_DISK_CACHE_TYPES_ALLOW", []string{"CORE_STORAGE_DISK_CACHE_TYPES"}, "File extensions to cache, empty for all", false, false) + + // Storage (Memory) + d.vars.Register(value.NewBool(&d.Storage.Memory.Auth.Enable, true), "storage.memory.auth.enable", "CORE_STORAGE_MEMORY_AUTH_ENABLE", nil, "Enable basic auth for PUT,POST, and DELETE on /memfs", false, false) + d.vars.Register(value.NewString(&d.Storage.Memory.Auth.Username, "admin"), "storage.memory.auth.username", "CORE_STORAGE_MEMORY_AUTH_USERNAME", nil, "Username for Basic-Auth of /memfs", false, false) + d.vars.Register(value.NewString(&d.Storage.Memory.Auth.Password, rand.StringAlphanumeric(18)), "storage.memory.auth.password", "CORE_STORAGE_MEMORY_AUTH_PASSWORD", nil, "Password for Basic-Auth of /memfs", false, true) + d.vars.Register(value.NewInt64(&d.Storage.Memory.Size, 0), "storage.memory.max_size_mbytes", "CORE_STORAGE_MEMORY_MAXSIZEMBYTES", nil, "Max. allowed megabytes for /memfs, 0 for unlimited", false, false) + d.vars.Register(value.NewBool(&d.Storage.Memory.Purge, false), "storage.memory.purge", "CORE_STORAGE_MEMORY_PURGE", nil, "Automatically remove the oldest files if /memfs is full", false, false) + + // Storage (CORS) + d.vars.Register(value.NewCORSOrigins(&d.Storage.CORS.Origins, []string{"*"}, ","), "storage.cors.origins", "CORE_STORAGE_CORS_ORIGINS", nil, "Allowed CORS origins for /memfs and /data", false, false) + + // RTMP + d.vars.Register(value.NewBool(&d.RTMP.Enable, false), "rtmp.enable", "CORE_RTMP_ENABLE", nil, "Enable RTMP server", false, false) + d.vars.Register(value.NewBool(&d.RTMP.EnableTLS, false), "rtmp.enable_tls", "CORE_RTMP_ENABLE_TLS", nil, "Enable RTMPS server instead of RTMP", false, false) + d.vars.Register(value.NewAddress(&d.RTMP.Address, ":1935"), "rtmp.address", "CORE_RTMP_ADDRESS", nil, "RTMP server listen address", false, false) + d.vars.Register(value.NewAddress(&d.RTMP.AddressTLS, ":1936"), "rtmp.address_tls", "CORE_RTMP_ADDRESS_TLS", nil, "RTMPS server listen address", false, false) + d.vars.Register(value.NewAbsolutePath(&d.RTMP.App, "/"), "rtmp.app", "CORE_RTMP_APP", nil, "RTMP app for publishing", false, false) + d.vars.Register(value.NewString(&d.RTMP.Token, ""), "rtmp.token", "CORE_RTMP_TOKEN", nil, "RTMP token for publishing and playing", false, true) + + // SRT + d.vars.Register(value.NewBool(&d.SRT.Enable, false), "srt.enable", "CORE_SRT_ENABLE", nil, "Enable SRT server", false, false) + d.vars.Register(value.NewAddress(&d.SRT.Address, ":6000"), "srt.address", "CORE_SRT_ADDRESS", nil, "SRT server listen address", false, false) + d.vars.Register(value.NewString(&d.SRT.Passphrase, ""), "srt.passphrase", "CORE_SRT_PASSPHRASE", nil, "SRT encryption passphrase", false, true) + d.vars.Register(value.NewString(&d.SRT.Token, ""), "srt.token", "CORE_SRT_TOKEN", nil, "SRT token for publishing and playing", false, true) + d.vars.Register(value.NewBool(&d.SRT.Log.Enable, false), "srt.log.enable", "CORE_SRT_LOG_ENABLE", nil, "Enable SRT server logging", false, false) + d.vars.Register(value.NewStringList(&d.SRT.Log.Topics, []string{}, ","), "srt.log.topics", "CORE_SRT_LOG_TOPICS", nil, "List of topics to log", false, false) + + // FFmpeg + d.vars.Register(value.NewExec(&d.FFmpeg.Binary, "ffmpeg"), "ffmpeg.binary", "CORE_FFMPEG_BINARY", nil, "Path to ffmpeg binary", true, false) + d.vars.Register(value.NewInt64(&d.FFmpeg.MaxProcesses, 0), "ffmpeg.max_processes", "CORE_FFMPEG_MAXPROCESSES", nil, "Max. allowed simultaneously running ffmpeg instances, 0 for unlimited", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Input.Allow, []string{}, " "), "ffmpeg.access.input.allow", "CORE_FFMPEG_ACCESS_INPUT_ALLOW", nil, "List of allowed expression to match against the input addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Input.Block, []string{}, " "), "ffmpeg.access.input.block", "CORE_FFMPEG_ACCESS_INPUT_BLOCK", nil, "List of blocked expression to match against the input addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Output.Allow, []string{}, " "), "ffmpeg.access.output.allow", "CORE_FFMPEG_ACCESS_OUTPUT_ALLOW", nil, "List of allowed expression to match against the output addresses", false, false) + d.vars.Register(value.NewStringList(&d.FFmpeg.Access.Output.Block, []string{}, " "), "ffmpeg.access.output.block", "CORE_FFMPEG_ACCESS_OUTPUT_BLOCK", nil, "List of blocked expression to match against the output addresses", false, false) + d.vars.Register(value.NewInt(&d.FFmpeg.Log.MaxLines, 50), "ffmpeg.log.max_lines", "CORE_FFMPEG_LOG_MAXLINES", nil, "Number of latest log lines to keep for each process", false, false) + d.vars.Register(value.NewInt(&d.FFmpeg.Log.MaxHistory, 3), "ffmpeg.log.max_history", "CORE_FFMPEG_LOG_MAXHISTORY", nil, "Number of latest logs to keep for each process", false, false) + + // Playout + d.vars.Register(value.NewBool(&d.Playout.Enable, false), "playout.enable", "CORE_PLAYOUT_ENABLE", nil, "Enable playout proxy where available", false, false) + d.vars.Register(value.NewPort(&d.Playout.MinPort, 0), "playout.min_port", "CORE_PLAYOUT_MINPORT", nil, "Min. playout server port", false, false) + d.vars.Register(value.NewPort(&d.Playout.MaxPort, 0), "playout.max_port", "CORE_PLAYOUT_MAXPORT", nil, "Max. playout server port", false, false) + + // Debug + d.vars.Register(value.NewBool(&d.Debug.Profiling, false), "debug.profiling", "CORE_DEBUG_PROFILING", nil, "Enable profiling endpoint on /profiling", false, false) + d.vars.Register(value.NewInt(&d.Debug.ForceGC, 0), "debug.force_gc", "CORE_DEBUG_FORCEGC", nil, "Number of seconds between forcing GC to return memory to the OS", false, false) + + // Metrics + d.vars.Register(value.NewBool(&d.Metrics.Enable, false), "metrics.enable", "CORE_METRICS_ENABLE", nil, "Enable collecting historic metrics data", false, false) + d.vars.Register(value.NewBool(&d.Metrics.EnablePrometheus, false), "metrics.enable_prometheus", "CORE_METRICS_ENABLE_PROMETHEUS", nil, "Enable prometheus endpoint /metrics", false, false) + d.vars.Register(value.NewInt64(&d.Metrics.Range, 300), "metrics.range_seconds", "CORE_METRICS_RANGE_SECONDS", nil, "Seconds to keep history data", false, false) + d.vars.Register(value.NewInt64(&d.Metrics.Interval, 2), "metrics.interval_seconds", "CORE_METRICS_INTERVAL_SECONDS", nil, "Interval for collecting metrics", false, false) + + // Sessions + d.vars.Register(value.NewBool(&d.Sessions.Enable, true), "sessions.enable", "CORE_SESSIONS_ENABLE", nil, "Enable collecting HLS session stats for /memfs", false, false) + d.vars.Register(value.NewCIDRList(&d.Sessions.IPIgnoreList, []string{"127.0.0.1/32", "::1/128"}, ","), "sessions.ip_ignorelist", "CORE_SESSIONS_IP_IGNORELIST", nil, "List of IP ranges in CIDR notation to ignore", false, false) + d.vars.Register(value.NewInt(&d.Sessions.SessionTimeout, 30), "sessions.session_timeout_sec", "CORE_SESSIONS_SESSION_TIMEOUT_SEC", nil, "Timeout for an idle session", false, false) + d.vars.Register(value.NewBool(&d.Sessions.Persist, false), "sessions.persist", "CORE_SESSIONS_PERSIST", nil, "Whether to persist session history. Will be stored as sessions.json in db.dir", false, false) + d.vars.Register(value.NewInt(&d.Sessions.PersistInterval, 300), "sessions.persist_interval_sec", "CORE_SESSIONS_PERSIST_INTERVAL_SEC", nil, "Interval in seconds in which to persist the current session history", false, false) + d.vars.Register(value.NewUint64(&d.Sessions.MaxBitrate, 0), "sessions.max_bitrate_mbit", "CORE_SESSIONS_MAXBITRATE_MBIT", nil, "Max. allowed outgoing bitrate in mbit/s, 0 for unlimited", false, false) + d.vars.Register(value.NewUint64(&d.Sessions.MaxSessions, 0), "sessions.max_sessions", "CORE_SESSIONS_MAXSESSIONS", nil, "Max. allowed number of simultaneous sessions, 0 for unlimited", false, false) + + // Service + d.vars.Register(value.NewBool(&d.Service.Enable, false), "service.enable", "CORE_SERVICE_ENABLE", nil, "Enable connecting to the Restreamer Service", false, false) + d.vars.Register(value.NewString(&d.Service.Token, ""), "service.token", "CORE_SERVICE_TOKEN", nil, "Restreamer Service account token", false, true) + d.vars.Register(value.NewURL(&d.Service.URL, "https://service.datarhei.com"), "service.url", "CORE_SERVICE_URL", nil, "URL of the Restreamer Service", false, false) + + // Router + d.vars.Register(value.NewStringList(&d.Router.BlockedPrefixes, []string{"/api"}, ","), "router.blocked_prefixes", "CORE_ROUTER_BLOCKED_PREFIXES", nil, "List of path prefixes that can't be routed", false, false) + d.vars.Register(value.NewStringMapString(&d.Router.Routes, nil), "router.routes", "CORE_ROUTER_ROUTES", nil, "List of route mappings", false, false) + d.vars.Register(value.NewDir(&d.Router.UIPath, ""), "router.ui_path", "CORE_ROUTER_UI_PATH", nil, "Path to a directory holding UI files mounted as /ui", false, false) +} + +// Validate validates the current state of the Config for completeness and sanity. Errors are +// written to the log. Use resetLogs to indicate to reset the logs prior validation. +func (d *Config) Validate(resetLogs bool) { + if resetLogs { + d.vars.ResetLogs() + } + + if d.Version != version { + d.vars.Log("error", "version", "unknown configuration layout version (found version %d, expecting version %d)", d.Version, version) + + return + } + + d.vars.Validate() + + // Individual sanity checks + + // If HTTP Auth is enabled, check that the username and password are set + if d.API.Auth.Enable { + if len(d.API.Auth.Username) == 0 || len(d.API.Auth.Password) == 0 { + d.vars.Log("error", "api.auth.enable", "api.auth.username and api.auth.password must be set") + } + } + + // If Auth0 is enabled, check that domain, audience, and clientid are set + if d.API.Auth.Auth0.Enable { + if len(d.API.Auth.Auth0.Tenants) == 0 { + d.vars.Log("error", "api.auth.auth0.enable", "at least one tenants must be set") + } + + for i, t := range d.API.Auth.Auth0.Tenants { + if len(t.Domain) == 0 || len(t.Audience) == 0 || len(t.ClientID) == 0 { + d.vars.Log("error", "api.auth.auth0.tenants", "domain, audience, and clientid must be set (tenant %d)", i) + } + } + } + + // If TLS is enabled and Let's Encrypt is disabled, require certfile and keyfile + if d.TLS.Enable && !d.TLS.Auto { + if len(d.TLS.CertFile) == 0 || len(d.TLS.KeyFile) == 0 { + d.vars.Log("error", "tls.enable", "tls.certfile and tls.keyfile must be set") + } + } + + // If TLS and Let's Encrypt certificate is enabled, we require a public hostname + if d.TLS.Enable && d.TLS.Auto { + if len(d.Host.Name) == 0 { + d.vars.Log("error", "host.name", "a hostname must be set in order to get an automatic TLS certificate") + } else { + r := &net.Resolver{ + PreferGo: true, + StrictErrors: true, + } + + for _, host := range d.Host.Name { + // Don't lookup IP addresses + if ip := net.ParseIP(host); ip != nil { + d.vars.Log("error", "host.name", "only host names are allowed if automatic TLS is enabled, but found IP address: %s", host) + } + + // Lookup host name with a timeout + ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) + + _, err := r.LookupHost(ctx, host) + if err != nil { + d.vars.Log("error", "host.name", "the host '%s' can't be resolved and will not work with automatic TLS", host) + } + + cancel() + } + } + } + + // If TLS for RTMP is enabled, TLS must be enabled + if d.RTMP.EnableTLS { + if !d.RTMP.Enable { + d.vars.Log("error", "rtmp.enable", "RTMP server must be enabled if RTMPS server is enabled") + } + + if !d.TLS.Enable { + d.vars.Log("error", "rtmp.enable_tls", "RTMPS server can only be enabled if TLS is enabled") + } + } + + // If CORE_MEMFS_USERNAME and CORE_MEMFS_PASSWORD are set, automatically active/deactivate Basic-Auth for memfs + if d.vars.IsMerged("storage.memory.auth.username") && d.vars.IsMerged("storage.memory.auth.password") { + d.Storage.Memory.Auth.Enable = true + + if len(d.Storage.Memory.Auth.Username) == 0 && len(d.Storage.Memory.Auth.Password) == 0 { + d.Storage.Memory.Auth.Enable = false + } + } + + // If Basic-Auth for memfs is enable, check that the username and password are set + if d.Storage.Memory.Auth.Enable { + if len(d.Storage.Memory.Auth.Username) == 0 || len(d.Storage.Memory.Auth.Password) == 0 { + d.vars.Log("error", "storage.memory.auth.enable", "storage.memory.auth.username and storage.memory.auth.password must be set") + } + } + + // If playout is enabled, check that the port range is sane + if d.Playout.Enable { + if d.Playout.MinPort >= d.Playout.MaxPort { + d.vars.Log("error", "playout.min_port", "must be bigger than playout.max_port") + } + } + + // If cache is enabled, a valid TTL has to be set to a useful value + if d.Storage.Disk.Cache.Enable && d.Storage.Disk.Cache.TTL < 0 { + d.vars.Log("error", "storage.disk.cache.ttl_seconds", "must be equal or greater than 0") + } + + // If the stats are enabled, the session timeout has to be set to a useful value + if d.Sessions.Enable && d.Sessions.SessionTimeout < 1 { + d.vars.Log("error", "stats.session_timeout_sec", "must be equal or greater than 1") + } + + // If the stats and their persistence are enabled, the persist interval has to be set to a useful value + if d.Sessions.Enable && d.Sessions.PersistInterval < 0 { + d.vars.Log("error", "stats.persist_interval_sec", "must be at equal or greater than 0") + } + + // If the service is enabled, the token and enpoint have to be defined + if d.Service.Enable { + if len(d.Service.Token) == 0 { + d.vars.Log("error", "service.token", "must be non-empty") + } + + if len(d.Service.URL) == 0 { + d.vars.Log("error", "service.url", "must be non-empty") + } + } + + // If historic metrics are enabled, the timerange and interval have to be valid + if d.Metrics.Enable { + if d.Metrics.Range <= 0 { + d.vars.Log("error", "metrics.range", "must be greater 0") + } + + if d.Metrics.Interval <= 0 { + d.vars.Log("error", "metrics.interval", "must be greater 0") + } + + if d.Metrics.Interval > d.Metrics.Range { + d.vars.Log("error", "metrics.interval", "must be smaller than the range") + } + } +} + +func (d *Config) Merge() { + d.vars.Merge() +} + +func (d *Config) Messages(logger func(level string, v vars.Variable, message string)) { + d.vars.Messages(logger) +} + +func (d *Config) HasErrors() bool { + return d.vars.HasErrors() +} + +func (d *Config) Overrides() []string { + return d.vars.Overrides() +} diff --git a/config/data_v2.go b/config/v2/data.go similarity index 64% rename from config/data_v2.go rename to config/v2/data.go index 0249429d..1a549497 100644 --- a/config/data_v2.go +++ b/config/v2/data.go @@ -1,4 +1,4 @@ -package config +package v2 import ( "fmt" @@ -6,9 +6,13 @@ import ( "strconv" "strings" "time" + + "github.com/datarhei/core/v16/config/copy" + v1 "github.com/datarhei/core/v16/config/v1" + "github.com/datarhei/core/v16/config/value" ) -type dataV2 struct { +type Data struct { CreatedAt time.Time `json:"created_at"` LoadedAt time.Time `json:"-"` UpdatedAt time.Time `json:"-"` @@ -50,8 +54,8 @@ type dataV2 struct { Secret string `json:"secret"` } `json:"jwt"` Auth0 struct { - Enable bool `json:"enable"` - Tenants []Auth0Tenant `json:"tenants"` + Enable bool `json:"enable"` + Tenants []value.Auth0Tenant `json:"tenants"` } `json:"auth0"` } `json:"auth"` } `json:"api"` @@ -160,11 +164,15 @@ type dataV2 struct { } `json:"router"` } -// Migrate will migrate some settings, depending on the version it finds. Migrations -// are only going upwards,i.e. from a lower version to a higher version. -func NewV2FromV1(d *dataV1) (*dataV2, error) { - data := &dataV2{} +func UpgradeV1ToV2(d *v1.Data) (*Data, error) { + cfg := New() + + return MergeV1ToV2(&cfg.Data, d) +} +// Migrate will migrate some settings, depending on the version it finds. Migrations +// are only going upwards, i.e. from a lower version to a higher version. +func MergeV1ToV2(data *Data, d *v1.Data) (*Data, error) { data.CreatedAt = d.CreatedAt data.LoadedAt = d.LoadedAt data.UpdatedAt = d.UpdatedAt @@ -189,30 +197,30 @@ func NewV2FromV1(d *dataV1) (*dataV2, error) { data.Service = d.Service data.Router = d.Router - data.Log.Topics = copyStringSlice(d.Log.Topics) + data.Log.Topics = copy.Slice(d.Log.Topics) - data.Host.Name = copyStringSlice(d.Host.Name) + data.Host.Name = copy.Slice(d.Host.Name) - data.API.Access.HTTP.Allow = copyStringSlice(d.API.Access.HTTP.Allow) - data.API.Access.HTTP.Block = copyStringSlice(d.API.Access.HTTP.Block) - data.API.Access.HTTPS.Allow = copyStringSlice(d.API.Access.HTTPS.Allow) - data.API.Access.HTTPS.Block = copyStringSlice(d.API.Access.HTTPS.Block) + data.API.Access.HTTP.Allow = copy.Slice(d.API.Access.HTTP.Allow) + data.API.Access.HTTP.Block = copy.Slice(d.API.Access.HTTP.Block) + data.API.Access.HTTPS.Allow = copy.Slice(d.API.Access.HTTPS.Allow) + data.API.Access.HTTPS.Block = copy.Slice(d.API.Access.HTTPS.Block) - data.API.Auth.Auth0.Tenants = copyTenantSlice(d.API.Auth.Auth0.Tenants) + data.API.Auth.Auth0.Tenants = copy.TenantSlice(d.API.Auth.Auth0.Tenants) - data.Storage.CORS.Origins = copyStringSlice(d.Storage.CORS.Origins) + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) - data.FFmpeg.Access.Input.Allow = copyStringSlice(d.FFmpeg.Access.Input.Allow) - data.FFmpeg.Access.Input.Block = copyStringSlice(d.FFmpeg.Access.Input.Block) - data.FFmpeg.Access.Output.Allow = copyStringSlice(d.FFmpeg.Access.Output.Allow) - data.FFmpeg.Access.Output.Block = copyStringSlice(d.FFmpeg.Access.Output.Block) + data.FFmpeg.Access.Input.Allow = copy.Slice(d.FFmpeg.Access.Input.Allow) + data.FFmpeg.Access.Input.Block = copy.Slice(d.FFmpeg.Access.Input.Block) + data.FFmpeg.Access.Output.Allow = copy.Slice(d.FFmpeg.Access.Output.Allow) + data.FFmpeg.Access.Output.Block = copy.Slice(d.FFmpeg.Access.Output.Block) - data.Sessions.IPIgnoreList = copyStringSlice(d.Sessions.IPIgnoreList) + data.Sessions.IPIgnoreList = copy.Slice(d.Sessions.IPIgnoreList) - data.SRT.Log.Topics = copyStringSlice(d.SRT.Log.Topics) + data.SRT.Log.Topics = copy.Slice(d.SRT.Log.Topics) - data.Router.BlockedPrefixes = copyStringSlice(d.Router.BlockedPrefixes) - data.Router.Routes = copyStringMap(d.Router.Routes) + data.Router.BlockedPrefixes = copy.Slice(d.Router.BlockedPrefixes) + data.Router.Routes = copy.StringMap(d.Router.Routes) // Actual changes data.RTMP.Enable = d.RTMP.Enable @@ -245,3 +253,67 @@ func NewV2FromV1(d *dataV1) (*dataV2, error) { return data, nil } + +func DowngradeV2toV1(d *Data) (*v1.Data, error) { + data := &v1.Data{} + + data.CreatedAt = d.CreatedAt + data.LoadedAt = d.LoadedAt + data.UpdatedAt = d.UpdatedAt + + data.ID = d.ID + data.Name = d.Name + data.Address = d.Address + data.CheckForUpdates = d.CheckForUpdates + + data.Log = d.Log + data.DB = d.DB + data.Host = d.Host + data.API = d.API + data.TLS = d.TLS + data.Storage = d.Storage + data.SRT = d.SRT + data.FFmpeg = d.FFmpeg + data.Playout = d.Playout + data.Debug = d.Debug + data.Metrics = d.Metrics + data.Sessions = d.Sessions + data.Service = d.Service + data.Router = d.Router + + data.Log.Topics = copy.Slice(d.Log.Topics) + + data.Host.Name = copy.Slice(d.Host.Name) + + data.API.Access.HTTP.Allow = copy.Slice(d.API.Access.HTTP.Allow) + data.API.Access.HTTP.Block = copy.Slice(d.API.Access.HTTP.Block) + data.API.Access.HTTPS.Allow = copy.Slice(d.API.Access.HTTPS.Allow) + data.API.Access.HTTPS.Block = copy.Slice(d.API.Access.HTTPS.Block) + + data.API.Auth.Auth0.Tenants = copy.TenantSlice(d.API.Auth.Auth0.Tenants) + + data.Storage.CORS.Origins = copy.Slice(d.Storage.CORS.Origins) + + data.FFmpeg.Access.Input.Allow = copy.Slice(d.FFmpeg.Access.Input.Allow) + data.FFmpeg.Access.Input.Block = copy.Slice(d.FFmpeg.Access.Input.Block) + data.FFmpeg.Access.Output.Allow = copy.Slice(d.FFmpeg.Access.Output.Allow) + data.FFmpeg.Access.Output.Block = copy.Slice(d.FFmpeg.Access.Output.Block) + + data.Sessions.IPIgnoreList = copy.Slice(d.Sessions.IPIgnoreList) + + data.SRT.Log.Topics = copy.Slice(d.SRT.Log.Topics) + + data.Router.BlockedPrefixes = copy.Slice(d.Router.BlockedPrefixes) + data.Router.Routes = copy.StringMap(d.Router.Routes) + + // Actual changes + data.RTMP.Enable = d.RTMP.Enable + data.RTMP.EnableTLS = d.RTMP.EnableTLS + data.RTMP.Address = d.RTMP.Address + data.RTMP.App = d.RTMP.App + data.RTMP.Token = d.RTMP.Token + + data.Version = 1 + + return data, nil +} diff --git a/config/value/auth0.go b/config/value/auth0.go new file mode 100644 index 00000000..a746fcf7 --- /dev/null +++ b/config/value/auth0.go @@ -0,0 +1,86 @@ +package value + +import ( + "encoding/base64" + "encoding/json" + "fmt" + "strings" +) + +// array of auth0 tenants + +type Auth0Tenant struct { + Domain string `json:"domain"` + Audience string `json:"audience"` + ClientID string `json:"clientid"` + Users []string `json:"users"` +} + +type TenantList struct { + p *[]Auth0Tenant + separator string +} + +func NewTenantList(p *[]Auth0Tenant, val []Auth0Tenant, separator string) *TenantList { + v := &TenantList{ + p: p, + separator: separator, + } + + *p = val + return v +} + +func (s *TenantList) Set(val string) error { + list := []Auth0Tenant{} + + for i, elm := range strings.Split(val, s.separator) { + data, err := base64.StdEncoding.DecodeString(elm) + if err != nil { + return fmt.Errorf("invalid base64 encoding of tenant %d: %w", i, err) + } + + t := Auth0Tenant{} + if err := json.Unmarshal(data, &t); err != nil { + return fmt.Errorf("invalid JSON in tenant %d: %w", i, err) + } + + list = append(list, t) + } + + *s.p = list + + return nil +} + +func (s *TenantList) String() string { + if s.IsEmpty() { + return "(empty)" + } + + list := []string{} + + for _, t := range *s.p { + list = append(list, fmt.Sprintf("%s (%d users)", t.Domain, len(t.Users))) + } + + return strings.Join(list, ",") +} + +func (s *TenantList) Validate() error { + for i, t := range *s.p { + if len(t.Domain) == 0 { + return fmt.Errorf("the domain for tenant %d is missing", i) + } + + if len(t.Audience) == 0 { + return fmt.Errorf("the audience for tenant %d is missing", i) + } + } + + return nil +} + +func (s *TenantList) IsEmpty() bool { + return len(*s.p) == 0 +} diff --git a/config/value/network.go b/config/value/network.go new file mode 100644 index 00000000..7cf78e49 --- /dev/null +++ b/config/value/network.go @@ -0,0 +1,269 @@ +package value + +import ( + "fmt" + "net" + "net/mail" + "net/url" + "regexp" + "strconv" + "strings" + + "github.com/datarhei/core/v16/http/cors" +) + +// address (host?:port) + +type Address string + +func NewAddress(p *string, val string) *Address { + *p = val + return (*Address)(p) +} + +func (s *Address) Set(val string) error { + // Check if the new value is only a port number + re := regexp.MustCompile("^[0-9]+$") + if re.MatchString(val) { + val = ":" + val + } + + *s = Address(val) + return nil +} + +func (s *Address) String() string { + return string(*s) +} + +func (s *Address) Validate() error { + _, port, err := net.SplitHostPort(string(*s)) + if err != nil { + return err + } + + re := regexp.MustCompile("^[0-9]+$") + if !re.MatchString(port) { + return fmt.Errorf("the port must be numerical") + } + + return nil +} + +func (s *Address) IsEmpty() bool { + return s.Validate() != nil +} + +// array of CIDR notation IP adresses + +type CIDRList struct { + p *[]string + separator string +} + +func NewCIDRList(p *[]string, val []string, separator string) *CIDRList { + v := &CIDRList{ + p: p, + separator: separator, + } + *p = val + return v +} + +func (s *CIDRList) Set(val string) error { + list := []string{} + + for _, elm := range strings.Split(val, s.separator) { + elm = strings.TrimSpace(elm) + if len(elm) != 0 { + list = append(list, elm) + } + } + + *s.p = list + + return nil +} + +func (s *CIDRList) String() string { + if s.IsEmpty() { + return "(empty)" + } + + return strings.Join(*s.p, s.separator) +} + +func (s *CIDRList) Validate() error { + for _, cidr := range *s.p { + _, _, err := net.ParseCIDR(cidr) + if err != nil { + return err + } + } + + return nil +} + +func (s *CIDRList) IsEmpty() bool { + return len(*s.p) == 0 +} + +// array of origins for CORS + +type CORSOrigins struct { + p *[]string + separator string +} + +func NewCORSOrigins(p *[]string, val []string, separator string) *CORSOrigins { + v := &CORSOrigins{ + p: p, + separator: separator, + } + *p = val + return v +} + +func (s *CORSOrigins) Set(val string) error { + list := []string{} + + for _, elm := range strings.Split(val, s.separator) { + elm = strings.TrimSpace(elm) + if len(elm) != 0 { + list = append(list, elm) + } + } + + *s.p = list + + return nil +} + +func (s *CORSOrigins) String() string { + if s.IsEmpty() { + return "(empty)" + } + + return strings.Join(*s.p, s.separator) +} + +func (s *CORSOrigins) Validate() error { + return cors.Validate(*s.p) +} + +func (s *CORSOrigins) IsEmpty() bool { + return len(*s.p) == 0 +} + +// network port + +type Port int + +func NewPort(p *int, val int) *Port { + *p = val + return (*Port)(p) +} + +func (i *Port) Set(val string) error { + v, err := strconv.Atoi(val) + if err != nil { + return err + } + *i = Port(v) + return nil +} + +func (i *Port) String() string { + return strconv.Itoa(int(*i)) +} + +func (i *Port) Validate() error { + val := int(*i) + + if val < 0 || val >= (1<<16) { + return fmt.Errorf("%d is not in the range of [0, %d]", val, 1<<16-1) + } + + return nil +} + +func (i *Port) IsEmpty() bool { + return int(*i) == 0 +} + +// url + +type URL string + +func NewURL(p *string, val string) *URL { + *p = val + return (*URL)(p) +} + +func (u *URL) Set(val string) error { + *u = URL(val) + return nil +} + +func (u *URL) String() string { + return string(*u) +} + +func (u *URL) Validate() error { + val := string(*u) + + if len(val) == 0 { + return nil + } + + URL, err := url.Parse(val) + if err != nil { + return fmt.Errorf("%s is not a valid URL", val) + } + + if len(URL.Scheme) == 0 || len(URL.Host) == 0 { + return fmt.Errorf("%s is not a valid URL", val) + } + + return nil +} + +func (u *URL) IsEmpty() bool { + return len(string(*u)) == 0 +} + +// email address + +type Email string + +func NewEmail(p *string, val string) *Email { + *p = val + return (*Email)(p) +} + +func (s *Email) Set(val string) error { + addr, err := mail.ParseAddress(val) + if err != nil { + return err + } + + *s = Email(addr.Address) + return nil +} + +func (s *Email) String() string { + return string(*s) +} + +func (s *Email) Validate() error { + if len(s.String()) == 0 { + return nil + } + + _, err := mail.ParseAddress(s.String()) + return err +} + +func (s *Email) IsEmpty() bool { + return len(string(*s)) == 0 +} diff --git a/config/value/os.go b/config/value/os.go new file mode 100644 index 00000000..3139a2ab --- /dev/null +++ b/config/value/os.go @@ -0,0 +1,197 @@ +package value + +import ( + "fmt" + "os" + "os/exec" + "path/filepath" + "strings" +) + +// must directory + +type MustDir string + +func NewMustDir(p *string, val string) *MustDir { + *p = val + return (*MustDir)(p) +} + +func (u *MustDir) Set(val string) error { + *u = MustDir(val) + return nil +} + +func (u *MustDir) String() string { + return string(*u) +} + +func (u *MustDir) Validate() error { + val := string(*u) + + if len(strings.TrimSpace(val)) == 0 { + return fmt.Errorf("path name must not be empty") + } + + finfo, err := os.Stat(val) + if err != nil { + return fmt.Errorf("%s does not exist", val) + } + + if !finfo.IsDir() { + return fmt.Errorf("%s is not a directory", val) + } + + return nil +} + +func (u *MustDir) IsEmpty() bool { + return len(string(*u)) == 0 +} + +// directory + +type Dir string + +func NewDir(p *string, val string) *Dir { + *p = val + return (*Dir)(p) +} + +func (u *Dir) Set(val string) error { + *u = Dir(val) + return nil +} + +func (u *Dir) String() string { + return string(*u) +} + +func (u *Dir) Validate() error { + val := string(*u) + + if len(strings.TrimSpace(val)) == 0 { + return nil + } + + finfo, err := os.Stat(val) + if err != nil { + return fmt.Errorf("%s does not exist", val) + } + + if !finfo.IsDir() { + return fmt.Errorf("%s is not a directory", val) + } + + return nil +} + +func (u *Dir) IsEmpty() bool { + return len(string(*u)) == 0 +} + +// executable + +type Exec string + +func NewExec(p *string, val string) *Exec { + *p = val + return (*Exec)(p) +} + +func (u *Exec) Set(val string) error { + *u = Exec(val) + return nil +} + +func (u *Exec) String() string { + return string(*u) +} + +func (u *Exec) Validate() error { + val := string(*u) + + _, err := exec.LookPath(val) + if err != nil { + return fmt.Errorf("%s not found or is not executable", val) + } + + return nil +} + +func (u *Exec) IsEmpty() bool { + return len(string(*u)) == 0 +} + +// regular file + +type File string + +func NewFile(p *string, val string) *File { + *p = val + return (*File)(p) +} + +func (u *File) Set(val string) error { + *u = File(val) + return nil +} + +func (u *File) String() string { + return string(*u) +} + +func (u *File) Validate() error { + val := string(*u) + + if len(val) == 0 { + return nil + } + + finfo, err := os.Stat(val) + if err != nil { + return fmt.Errorf("%s does not exist", val) + } + + if !finfo.Mode().IsRegular() { + return fmt.Errorf("%s is not a regular file", val) + } + + return nil +} + +func (u *File) IsEmpty() bool { + return len(string(*u)) == 0 +} + +// absolute path + +type AbsolutePath string + +func NewAbsolutePath(p *string, val string) *AbsolutePath { + *p = filepath.Clean(val) + return (*AbsolutePath)(p) +} + +func (s *AbsolutePath) Set(val string) error { + *s = AbsolutePath(filepath.Clean(val)) + return nil +} + +func (s *AbsolutePath) String() string { + return string(*s) +} + +func (s *AbsolutePath) Validate() error { + path := string(*s) + + if !filepath.IsAbs(path) { + return fmt.Errorf("%s is not an absolute path", path) + } + + return nil +} + +func (s *AbsolutePath) IsEmpty() bool { + return len(string(*s)) == 0 +} diff --git a/config/value/primitives.go b/config/value/primitives.go new file mode 100644 index 00000000..34057008 --- /dev/null +++ b/config/value/primitives.go @@ -0,0 +1,264 @@ +package value + +import ( + "strconv" + "strings" +) + +// string + +type String string + +func NewString(p *string, val string) *String { + *p = val + return (*String)(p) +} + +func (s *String) Set(val string) error { + *s = String(val) + return nil +} + +func (s *String) String() string { + return string(*s) +} + +func (s *String) Validate() error { + return nil +} + +func (s *String) IsEmpty() bool { + return len(string(*s)) == 0 +} + +// array of strings + +type StringList struct { + p *[]string + separator string +} + +func NewStringList(p *[]string, val []string, separator string) *StringList { + v := &StringList{ + p: p, + separator: separator, + } + *p = val + return v +} + +func (s *StringList) Set(val string) error { + list := []string{} + + for _, elm := range strings.Split(val, s.separator) { + elm = strings.TrimSpace(elm) + if len(elm) != 0 { + list = append(list, elm) + } + } + + *s.p = list + + return nil +} + +func (s *StringList) String() string { + if s.IsEmpty() { + return "(empty)" + } + + return strings.Join(*s.p, s.separator) +} + +func (s *StringList) Validate() error { + return nil +} + +func (s *StringList) IsEmpty() bool { + return len(*s.p) == 0 +} + +// map of strings to strings + +type StringMapString struct { + p *map[string]string +} + +func NewStringMapString(p *map[string]string, val map[string]string) *StringMapString { + v := &StringMapString{ + p: p, + } + + if *p == nil { + *p = make(map[string]string) + } + + if val != nil { + *p = val + } + + return v +} + +func (s *StringMapString) Set(val string) error { + mappings := make(map[string]string) + + for _, elm := range strings.Split(val, " ") { + elm = strings.TrimSpace(elm) + if len(elm) == 0 { + continue + } + + mapping := strings.SplitN(elm, ":", 2) + + mappings[mapping[0]] = mapping[1] + } + + *s.p = mappings + + return nil +} + +func (s *StringMapString) String() string { + if s.IsEmpty() { + return "(empty)" + } + + mappings := make([]string, len(*s.p)) + + i := 0 + for k, v := range *s.p { + mappings[i] = k + ":" + v + i++ + } + + return strings.Join(mappings, " ") +} + +func (s *StringMapString) Validate() error { + return nil +} + +func (s *StringMapString) IsEmpty() bool { + return len(*s.p) == 0 +} + +// boolean + +type Bool bool + +func NewBool(p *bool, val bool) *Bool { + *p = val + return (*Bool)(p) +} + +func (b *Bool) Set(val string) error { + v, err := strconv.ParseBool(val) + if err != nil { + return err + } + *b = Bool(v) + return nil +} + +func (b *Bool) String() string { + return strconv.FormatBool(bool(*b)) +} + +func (b *Bool) Validate() error { + return nil +} + +func (b *Bool) IsEmpty() bool { + return !bool(*b) +} + +// int + +type Int int + +func NewInt(p *int, val int) *Int { + *p = val + return (*Int)(p) +} + +func (i *Int) Set(val string) error { + v, err := strconv.Atoi(val) + if err != nil { + return err + } + *i = Int(v) + return nil +} + +func (i *Int) String() string { + return strconv.Itoa(int(*i)) +} + +func (i *Int) Validate() error { + return nil +} + +func (i *Int) IsEmpty() bool { + return int(*i) == 0 +} + +// int64 + +type Int64 int64 + +func NewInt64(p *int64, val int64) *Int64 { + *p = val + return (*Int64)(p) +} + +func (u *Int64) Set(val string) error { + v, err := strconv.ParseInt(val, 0, 64) + if err != nil { + return err + } + *u = Int64(v) + return nil +} + +func (u *Int64) String() string { + return strconv.FormatInt(int64(*u), 10) +} + +func (u *Int64) Validate() error { + return nil +} + +func (u *Int64) IsEmpty() bool { + return int64(*u) == 0 +} + +// uint64 + +type Uint64 uint64 + +func NewUint64(p *uint64, val uint64) *Uint64 { + *p = val + return (*Uint64)(p) +} + +func (u *Uint64) Set(val string) error { + v, err := strconv.ParseUint(val, 0, 64) + if err != nil { + return err + } + *u = Uint64(v) + return nil +} + +func (u *Uint64) String() string { + return strconv.FormatUint(uint64(*u), 10) +} + +func (u *Uint64) Validate() error { + return nil +} + +func (u *Uint64) IsEmpty() bool { + return uint64(*u) == 0 +} diff --git a/config/value/time.go b/config/value/time.go new file mode 100644 index 00000000..c0be6e98 --- /dev/null +++ b/config/value/time.go @@ -0,0 +1,35 @@ +package value + +import "time" + +// time + +type Time time.Time + +func NewTime(p *time.Time, val time.Time) *Time { + *p = val + return (*Time)(p) +} + +func (u *Time) Set(val string) error { + v, err := time.Parse(time.RFC3339, val) + if err != nil { + return err + } + *u = Time(v) + return nil +} + +func (u *Time) String() string { + v := time.Time(*u) + return v.Format(time.RFC3339) +} + +func (u *Time) Validate() error { + return nil +} + +func (u *Time) IsEmpty() bool { + v := time.Time(*u) + return v.IsZero() +} diff --git a/config/value/value.go b/config/value/value.go new file mode 100644 index 00000000..ded8051d --- /dev/null +++ b/config/value/value.go @@ -0,0 +1,21 @@ +package value + +type Value interface { + // String returns a string representation of the value. + String() string + + // Set a new value for the value. Returns an + // error if the given string representation can't + // be transformed to the value. Returns nil + // if the new value has been set. + Set(string) error + + // Validate the value. The returned error will + // indicate what is wrong with the current value. + // Returns nil if the value is OK. + Validate() error + + // IsEmpty returns whether the value represents an empty + // representation for that value. + IsEmpty() bool +} diff --git a/config/types_test.go b/config/value/value_test.go similarity index 82% rename from config/types_test.go rename to config/value/value_test.go index f38c3160..49c024e9 100644 --- a/config/types_test.go +++ b/config/value/value_test.go @@ -1,4 +1,4 @@ -package config +package value import ( "testing" @@ -9,7 +9,7 @@ import ( func TestIntValue(t *testing.T) { var i int - ivar := newIntValue(&i, 11) + ivar := NewInt(&i, 11) assert.Equal(t, "11", ivar.String()) assert.Equal(t, nil, ivar.Validate()) @@ -34,16 +34,16 @@ type testdata struct { func TestCopyStruct(t *testing.T) { data1 := testdata{} - newIntValue(&data1.value1, 1) - newIntValue(&data1.value2, 2) + NewInt(&data1.value1, 1) + NewInt(&data1.value2, 2) assert.Equal(t, int(1), data1.value1) assert.Equal(t, int(2), data1.value2) data2 := testdata{} - val21 := newIntValue(&data2.value1, 3) - val22 := newIntValue(&data2.value2, 4) + val21 := NewInt(&data2.value1, 3) + val22 := NewInt(&data2.value2, 4) assert.Equal(t, int(3), data2.value1) assert.Equal(t, int(4), data2.value2) diff --git a/config/vars/vars.go b/config/vars/vars.go new file mode 100644 index 00000000..35df8941 --- /dev/null +++ b/config/vars/vars.go @@ -0,0 +1,216 @@ +package vars + +import ( + "fmt" + "os" + + "github.com/datarhei/core/v16/config/value" +) + +type variable struct { + value value.Value // The actual value + defVal string // The default value in string representation + name string // A name for this value + envName string // The environment variable that corresponds to this value + envAltNames []string // Alternative environment variable names + description string // A desriptions for this value + required bool // Whether a non-empty value is required + disguise bool // Whether the value should be disguised if printed + merged bool // Whether this value has been replaced by its corresponding environment variable +} + +type Variable struct { + Value string + Name string + EnvName string + Description string + Merged bool +} + +type message struct { + message string // The log message + variable Variable // The config field this message refers to + level string // The loglevel for this message +} + +type Variables struct { + vars []*variable + logs []message +} + +func (vs *Variables) Register(val value.Value, name, envName string, envAltNames []string, description string, required, disguise bool) { + vs.vars = append(vs.vars, &variable{ + value: val, + defVal: val.String(), + name: name, + envName: envName, + envAltNames: envAltNames, + description: description, + required: required, + disguise: disguise, + }) +} + +func (vs *Variables) Transfer(vss *Variables) { + for _, v := range vs.vars { + if vss.IsMerged(v.name) { + v.merged = true + } + } +} + +func (vs *Variables) SetDefault(name string) { + v := vs.findVariable(name) + if v == nil { + return + } + + v.value.Set(v.defVal) +} + +func (vs *Variables) Get(name string) (string, error) { + v := vs.findVariable(name) + if v == nil { + return "", fmt.Errorf("variable not found") + } + + return v.value.String(), nil +} + +func (vs *Variables) Set(name, val string) error { + v := vs.findVariable(name) + if v == nil { + return fmt.Errorf("variable not found") + } + + return v.value.Set(val) +} + +func (vs *Variables) Log(level, name string, format string, args ...interface{}) { + v := vs.findVariable(name) + if v == nil { + return + } + + variable := Variable{ + Value: v.value.String(), + Name: v.name, + EnvName: v.envName, + Description: v.description, + Merged: v.merged, + } + + if v.disguise { + variable.Value = "***" + } + + l := message{ + message: fmt.Sprintf(format, args...), + variable: variable, + level: level, + } + + vs.logs = append(vs.logs, l) +} + +func (vs *Variables) Merge() { + for _, v := range vs.vars { + if len(v.envName) == 0 { + continue + } + + var envval string + var ok bool + + envval, ok = os.LookupEnv(v.envName) + if !ok { + foundAltName := false + + for _, envName := range v.envAltNames { + envval, ok = os.LookupEnv(envName) + if ok { + foundAltName = true + vs.Log("warn", v.name, "deprecated name, please use %s", v.envName) + break + } + } + + if !foundAltName { + continue + } + } + + err := v.value.Set(envval) + if err != nil { + vs.Log("error", v.name, "%s", err.Error()) + } + + v.merged = true + } +} + +func (vs *Variables) IsMerged(name string) bool { + v := vs.findVariable(name) + if v == nil { + return false + } + + return v.merged +} + +func (vs *Variables) Validate() { + for _, v := range vs.vars { + vs.Log("info", v.name, "%s", "") + + err := v.value.Validate() + if err != nil { + vs.Log("error", v.name, "%s", err.Error()) + } + + if v.required && v.value.IsEmpty() { + vs.Log("error", v.name, "a value is required") + } + } +} + +func (vs *Variables) ResetLogs() { + vs.logs = nil +} + +func (vs *Variables) Messages(logger func(level string, v Variable, message string)) { + for _, l := range vs.logs { + logger(l.level, l.variable, l.message) + } +} + +func (vs *Variables) HasErrors() bool { + for _, l := range vs.logs { + if l.level == "error" { + return true + } + } + + return false +} + +func (vs *Variables) Overrides() []string { + overrides := []string{} + + for _, v := range vs.vars { + if v.merged { + overrides = append(overrides, v.name) + } + } + + return overrides +} + +func (vs *Variables) findVariable(name string) *variable { + for _, v := range vs.vars { + if v.name == name { + return v + } + } + + return nil +} diff --git a/config/vars/vars_test.go b/config/vars/vars_test.go new file mode 100644 index 00000000..38e51fb4 --- /dev/null +++ b/config/vars/vars_test.go @@ -0,0 +1,40 @@ +package vars + +import ( + "testing" + + "github.com/datarhei/core/v16/config/value" + + "github.com/stretchr/testify/require" +) + +func TestVars(t *testing.T) { + v1 := Variables{} + + s := "" + + v1.Register(value.NewString(&s, "foobar"), "string", "", nil, "a string", false, false) + + require.Equal(t, "foobar", s) + x, _ := v1.Get("string") + require.Equal(t, "foobar", x) + + v := v1.findVariable("string") + v.value.Set("barfoo") + + require.Equal(t, "barfoo", s) + x, _ = v1.Get("string") + require.Equal(t, "barfoo", x) + + v1.Set("string", "foobaz") + + require.Equal(t, "foobaz", s) + x, _ = v1.Get("string") + require.Equal(t, "foobaz", x) + + v1.SetDefault("string") + + require.Equal(t, "foobar", s) + x, _ = v1.Get("string") + require.Equal(t, "foobar", x) +} diff --git a/http/api/config.go b/http/api/config.go index a02e0407..47040cc2 100644 --- a/http/api/config.go +++ b/http/api/config.go @@ -4,8 +4,16 @@ import ( "time" "github.com/datarhei/core/v16/config" + v1config "github.com/datarhei/core/v16/config/v1" + v2config "github.com/datarhei/core/v16/config/v2" ) +// ConfigVersion is used to only unmarshal the version field in order +// find out which SetConfig should be used. +type ConfigVersion struct { + Version int64 `json:"version"` +} + // ConfigData embeds config.Data type ConfigData struct { config.Data @@ -22,11 +30,68 @@ type Config struct { Overrides []string `json:"overrides"` } +type SetConfigV1 struct { + v1config.Data +} + +// NewSetConfigV1 creates a new SetConfigV1 based on the current +// config with downgrading. +func NewSetConfigV1(cfg *config.Config) SetConfigV1 { + v2data, _ := config.DowngradeV3toV2(&cfg.Data) + v1data, _ := v2config.DowngradeV2toV1(v2data) + + data := SetConfigV1{ + Data: *v1data, + } + + return data +} + +// MergeTo merges the v1 config into the current config. +func (s *SetConfigV1) MergeTo(cfg *config.Config) { + v2data, _ := config.DowngradeV3toV2(&cfg.Data) + + v2config.MergeV1ToV2(v2data, &s.Data) + config.MergeV2toV3(&cfg.Data, v2data) +} + +type SetConfigV2 struct { + v2config.Data +} + +// NewSetConfigV2 creates a new SetConfigV2 based on the current +// config with downgrading. +func NewSetConfigV2(cfg *config.Config) SetConfigV2 { + v2data, _ := config.DowngradeV3toV2(&cfg.Data) + + data := SetConfigV2{ + Data: *v2data, + } + + return data +} + +// MergeTo merges the v2 config into the current config. +func (s *SetConfigV2) MergeTo(cfg *config.Config) { + config.MergeV2toV3(&cfg.Data, &s.Data) +} + // SetConfig embeds config.Data. It is used to send a new config to the server. type SetConfig struct { config.Data } +// NewSetConfig converts a config.Config into a SetConfig in order to prepopulate +// a SetConfig with the current values. The uploaded config can have missing fields that +// will be filled with the current values after unmarshalling the JSON. +func NewSetConfig(cfg *config.Config) SetConfig { + data := SetConfig{ + cfg.Data, + } + + return data +} + // MergeTo merges a sent config into a config.Config func (rscfg *SetConfig) MergeTo(cfg *config.Config) { cfg.ID = rscfg.ID @@ -51,18 +116,7 @@ func (rscfg *SetConfig) MergeTo(cfg *config.Config) { cfg.Router = rscfg.Router } -// NewSetConfig converts a config.Config into a RestreamerSetConfig in order to prepopulate -// a RestreamerSetConfig with the current values. The uploaded config can have missing fields that -// will be filled with the current values after unmarshalling the JSON. -func NewSetConfig(cfg *config.Config) SetConfig { - data := SetConfig{ - cfg.Data, - } - - return data -} - -// Unmarshal converts a config.Config to a RestreamerConfig. +// Unmarshal converts a config.Config to a Config. func (c *Config) Unmarshal(cfg *config.Config) { if cfg == nil { return diff --git a/http/handler/api/config.go b/http/handler/api/config.go index 8d137358..60f8b520 100644 --- a/http/handler/api/config.go +++ b/http/handler/api/config.go @@ -1,11 +1,13 @@ package api import ( + "io" "net/http" - "github.com/datarhei/core/v16/config" + cfgstore "github.com/datarhei/core/v16/config/store" + cfgvars "github.com/datarhei/core/v16/config/vars" + "github.com/datarhei/core/v16/encoding/json" "github.com/datarhei/core/v16/http/api" - "github.com/datarhei/core/v16/http/handler/util" "github.com/labstack/echo/v4" ) @@ -13,11 +15,11 @@ import ( // The ConfigHandler type provides handler functions for reading and manipulating // the current config. type ConfigHandler struct { - store config.Store + store cfgstore.Store } // NewConfig return a new Config type. You have to provide a valid config store. -func NewConfig(store config.Store) *ConfigHandler { +func NewConfig(store cfgstore.Store) *ConfigHandler { return &ConfigHandler{ store: store, } @@ -53,25 +55,73 @@ func (p *ConfigHandler) Get(c echo.Context) error { // @Security ApiKeyAuth // @Router /api/v3/config [put] func (p *ConfigHandler) Set(c echo.Context) error { - cfg := p.store.Get() + version := api.ConfigVersion{} - // Set the current config as default config value. This will - // allow to set a partial config without destroying the other - // values. - setConfig := api.NewSetConfig(cfg) + req := c.Request() - if err := util.ShouldBindJSON(c, &setConfig); err != nil { + body, err := io.ReadAll(req.Body) + if err != nil { return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", err) } - // Merge it into the current config - setConfig.MergeTo(cfg) + if err := json.Unmarshal(body, &version); err != nil { + return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", json.FormatError(body, err)) + } + + cfg := p.store.Get() + + // For each version, set the current config as default config value. This will + // allow to set a partial config without destroying the other values. + if version.Version == 1 { + // Downgrade to v1 in order to have a populated v1 config + v1SetConfig := api.NewSetConfigV1(cfg) + + if err := json.Unmarshal(body, &v1SetConfig); err != nil { + return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", json.FormatError(body, err)) + } + + if err := c.Validate(v1SetConfig); err != nil { + return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", err) + } + + // Merge it into the current config + v1SetConfig.MergeTo(cfg) + } else if version.Version == 2 { + // Downgrade to v2 in order to have a populated v2 config + v2SetConfig := api.NewSetConfigV2(cfg) + + if err := json.Unmarshal(body, &v2SetConfig); err != nil { + return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", json.FormatError(body, err)) + } + + if err := c.Validate(v2SetConfig); err != nil { + return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", err) + } + + // Merge it into the current config + v2SetConfig.MergeTo(cfg) + } else if version.Version == 3 { + v3SetConfig := api.NewSetConfig(cfg) + + if err := json.Unmarshal(body, &v3SetConfig); err != nil { + return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", json.FormatError(body, err)) + } + + if err := c.Validate(v3SetConfig); err != nil { + return api.Err(http.StatusBadRequest, "Invalid JSON", "%s", err) + } + + // Merge it into the current config + v3SetConfig.MergeTo(cfg) + } else { + return api.Err(http.StatusBadRequest, "Invalid config version", "version %d", version.Version) + } // Now we make a copy from the config and merge it with the environment // variables. If this configuration is valid, we will store the un-merged // one to disk. - mergedConfig := config.NewConfigFrom(cfg) + mergedConfig := cfg.Clone() mergedConfig.Merge() // Validate the new merged config @@ -79,7 +129,7 @@ func (p *ConfigHandler) Set(c echo.Context) error { if mergedConfig.HasErrors() { errors := make(map[string][]string) - mergedConfig.Messages(func(level string, v config.Variable, message string) { + mergedConfig.Messages(func(level string, v cfgvars.Variable, message string) { if level != "error" { return } diff --git a/http/handler/api/config_test.go b/http/handler/api/config_test.go index bf6d211f..77e985c4 100644 --- a/http/handler/api/config_test.go +++ b/http/handler/api/config_test.go @@ -7,25 +7,28 @@ import ( "testing" "github.com/datarhei/core/v16/config" + "github.com/datarhei/core/v16/config/store" + v1 "github.com/datarhei/core/v16/config/v1" "github.com/datarhei/core/v16/http/mock" "github.com/labstack/echo/v4" + "github.com/stretchr/testify/require" ) -func getDummyConfigRouter() *echo.Echo { +func getDummyConfigRouter() (*echo.Echo, store.Store) { router := mock.DummyEcho() - config := config.NewDummyStore() + config := store.NewDummy() handler := NewConfig(config) router.Add("GET", "/", handler.Get) router.Add("PUT", "/", handler.Set) - return router + return router, config } func TestConfigGet(t *testing.T) { - router := getDummyConfigRouter() + router, _ := getDummyConfigRouter() mock.Request(t, http.StatusOK, router, "GET", "/", nil) @@ -33,7 +36,7 @@ func TestConfigGet(t *testing.T) { } func TestConfigSetConflict(t *testing.T) { - router := getDummyConfigRouter() + router, _ := getDummyConfigRouter() var data bytes.Buffer @@ -44,18 +47,86 @@ func TestConfigSetConflict(t *testing.T) { } func TestConfigSet(t *testing.T) { - router := getDummyConfigRouter() + router, store := getDummyConfigRouter() + + storedcfg := store.Get() + + require.Equal(t, []string{}, storedcfg.Host.Name) var data bytes.Buffer + encoder := json.NewEncoder(&data) + // Setting a new v3 config cfg := config.New() cfg.FFmpeg.Binary = "true" cfg.DB.Dir = "." cfg.Storage.Disk.Dir = "." cfg.Storage.MimeTypes = "" + cfg.Storage.Disk.Cache.Types.Allow = []string{".aaa"} + cfg.Storage.Disk.Cache.Types.Block = []string{".zzz"} + cfg.Host.Name = []string{"foobar.com"} - encoder := json.NewEncoder(&data) encoder.Encode(cfg) mock.Request(t, http.StatusOK, router, "PUT", "/", &data) + + storedcfg = store.Get() + + require.Equal(t, []string{"foobar.com"}, storedcfg.Host.Name) + require.Equal(t, []string{".aaa"}, cfg.Storage.Disk.Cache.Types.Allow) + require.Equal(t, []string{".zzz"}, cfg.Storage.Disk.Cache.Types.Block) + require.Equal(t, "cert@datarhei.com", cfg.TLS.Email) + + // Setting a complete v1 config + cfgv1 := v1.New() + cfgv1.FFmpeg.Binary = "true" + cfgv1.DB.Dir = "." + cfgv1.Storage.Disk.Dir = "." + cfgv1.Storage.MimeTypes = "" + cfgv1.Storage.Disk.Cache.Types = []string{".bbb"} + cfgv1.Host.Name = []string{"foobar.com"} + + data.Reset() + + encoder.Encode(cfgv1) + + mock.Request(t, http.StatusOK, router, "PUT", "/", &data) + + storedcfg = store.Get() + + require.Equal(t, []string{"foobar.com"}, storedcfg.Host.Name) + require.Equal(t, []string{".bbb"}, storedcfg.Storage.Disk.Cache.Types.Allow) + require.Equal(t, []string{".zzz"}, storedcfg.Storage.Disk.Cache.Types.Block) + require.Equal(t, "cert@datarhei.com", cfg.TLS.Email) + + // Setting a partial v1 config + type customconfig struct { + Version int `json:"version"` + Storage struct { + Disk struct { + Cache struct { + Types []string `json:"types"` + } `json:"cache"` + } `json:"disk"` + } `json:"storage"` + } + + customcfg := customconfig{ + Version: 1, + } + + customcfg.Storage.Disk.Cache.Types = []string{".ccc"} + + data.Reset() + + encoder.Encode(customcfg) + + mock.Request(t, http.StatusOK, router, "PUT", "/", &data) + + storedcfg = store.Get() + + require.Equal(t, []string{"foobar.com"}, storedcfg.Host.Name) + require.Equal(t, []string{".ccc"}, storedcfg.Storage.Disk.Cache.Types.Allow) + require.Equal(t, []string{".zzz"}, storedcfg.Storage.Disk.Cache.Types.Block) + require.Equal(t, "cert@datarhei.com", cfg.TLS.Email) } diff --git a/http/server.go b/http/server.go index 0c84a404..34d51579 100644 --- a/http/server.go +++ b/http/server.go @@ -32,7 +32,7 @@ import ( "net/http" "strings" - "github.com/datarhei/core/v16/config" + cfgstore "github.com/datarhei/core/v16/config/store" "github.com/datarhei/core/v16/http/cache" "github.com/datarhei/core/v16/http/errorhandler" "github.com/datarhei/core/v16/http/graph/resolver" @@ -87,7 +87,7 @@ type Config struct { RTMP rtmp.Server SRT srt.Server JWT jwt.JWT - Config config.Store + Config cfgstore.Store Cache cache.Cacher Sessions session.RegistryReader Router router.Router diff --git a/net/ip.go b/net/ip.go index e3cec22f..4c0b14f3 100644 --- a/net/ip.go +++ b/net/ip.go @@ -4,7 +4,11 @@ package net import ( "fmt" + "io" "net" + "net/http" + "sync" + "time" ) var ( @@ -58,3 +62,69 @@ func ipVersion(ipAddress string) int { return 0 } + +// GetPublicIPs will try to figure out the public IPs (v4 and v6) +// we're running on. If it fails, an empty list will be returned. +func GetPublicIPs(timeout time.Duration) []string { + var wg sync.WaitGroup + + ipv4 := "" + ipv6 := "" + + wg.Add(2) + + go func() { + defer wg.Done() + + ipv4 = doRequest("https://api.ipify.org", timeout) + }() + + go func() { + defer wg.Done() + + ipv6 = doRequest("https://api6.ipify.org", timeout) + }() + + wg.Wait() + + ips := []string{} + + if len(ipv4) != 0 { + ips = append(ips, ipv4) + } + + if len(ipv6) != 0 && ipv4 != ipv6 { + ips = append(ips, ipv6) + } + + return ips +} + +func doRequest(url string, timeout time.Duration) string { + client := &http.Client{ + Timeout: timeout, + } + + req, err := http.NewRequest("GET", url, nil) + if err != nil { + return "" + } + + resp, err := client.Do(req) + if err != nil { + return "" + } + + defer resp.Body.Close() + + body, err := io.ReadAll(resp.Body) + if err != nil { + return "" + } + + if resp.StatusCode != 200 { + return "" + } + + return string(body) +} From 8314f714029c6eb925c601a9591909fc707c968e Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Mon, 10 Oct 2022 16:55:43 +0200 Subject: [PATCH 03/22] Fix widget session data --- http/handler/api/widget.go | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/http/handler/api/widget.go b/http/handler/api/widget.go index 7bd22602..5672ba5d 100644 --- a/http/handler/api/widget.go +++ b/http/handler/api/widget.go @@ -2,6 +2,7 @@ package api import ( "net/http" + "strings" "github.com/datarhei/core/v16/http/api" "github.com/datarhei/core/v16/http/handler/util" @@ -73,12 +74,18 @@ func (w *WidgetHandler) Get(c echo.Context) error { summary := collector.Summary() for _, session := range summary.Active { - if session.Reference == process.Reference { - data.CurrentSessions++ + if !strings.HasPrefix(session.Reference, process.Reference) { + continue } + + data.CurrentSessions++ } - if s, ok := summary.Summary.References[process.Reference]; ok { + for reference, s := range summary.Summary.References { + if !strings.HasPrefix(reference, process.Reference) { + continue + } + data.TotalSessions = s.TotalSessions } From 6ef334331b55362fd16578fb51e7e03950ab1ed7 Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Mon, 10 Oct 2022 18:40:45 +0200 Subject: [PATCH 04/22] Fix accumulating total sessions --- http/handler/api/widget.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/http/handler/api/widget.go b/http/handler/api/widget.go index 5672ba5d..41916444 100644 --- a/http/handler/api/widget.go +++ b/http/handler/api/widget.go @@ -86,7 +86,7 @@ func (w *WidgetHandler) Get(c echo.Context) error { continue } - data.TotalSessions = s.TotalSessions + data.TotalSessions += s.TotalSessions } return c.JSON(http.StatusOK, data) From 05a2268662f683b992244cc952125040e80a45ff Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Thu, 13 Oct 2022 10:57:17 +0200 Subject: [PATCH 05/22] Reset process stats when stopped --- process/limits.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/process/limits.go b/process/limits.go index 71ea7c0b..0c43b3ba 100644 --- a/process/limits.go +++ b/process/limits.go @@ -104,6 +104,8 @@ func (l *limiter) Stop() { l.proc.Stop() l.proc = nil + + l.reset() } func (l *limiter) ticker(ctx context.Context) { From 3da25c0d91a521c1c295a047c5442d54dc195238 Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Thu, 13 Oct 2022 12:20:26 +0200 Subject: [PATCH 06/22] Fix stale detection with progress patch --- ffmpeg/parse/parser.go | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/ffmpeg/parse/parser.go b/ffmpeg/parse/parser.go index 5f54d68a..0adb53d2 100644 --- a/ffmpeg/parse/parser.go +++ b/ffmpeg/parse/parser.go @@ -379,13 +379,12 @@ func (p *parser) Parse(line string) uint64 { } // Calculate if any of the processed frames staled. - // If one number of frames in an output is the same as - // before, then pFrames becomes 0. - var pFrames uint64 = 0 - - pFrames = p.stats.main.diff.frame + // If one number of frames in an output is the same as before, then pFrames becomes 0. + pFrames := p.stats.main.diff.frame if isFFmpegProgress { + // Only consider the outputs + pFrames = 1 for i := range p.stats.output { pFrames *= p.stats.output[i].diff.frame } From f746e581ae6cc907b33b3a414b1563a0041dc7c4 Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Thu, 13 Oct 2022 20:54:52 +0200 Subject: [PATCH 07/22] Add version annotation to API methods --- docs/docs.go | 158 ++++++++++++++++++++++++++++++++--- docs/swagger.json | 158 ++++++++++++++++++++++++++++++++--- docs/swagger.yaml | 114 ++++++++++++++++++++++--- http/handler/api/config.go | 3 + http/handler/api/diskfs.go | 4 + http/handler/api/log.go | 1 + http/handler/api/memfs.go | 5 ++ http/handler/api/metrics.go | 2 + http/handler/api/playout.go | 6 ++ http/handler/api/restream.go | 28 +++++-- http/handler/api/rtmp.go | 3 +- http/handler/api/session.go | 6 +- http/handler/api/srt.go | 1 + http/handler/api/widget.go | 1 + 14 files changed, 442 insertions(+), 48 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index 06030b97..21d3bae5 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -62,7 +62,7 @@ const docTemplate = `{ "operationId": "graph-playground", "responses": { "200": { - "description": "" + "description": "OK" } } } @@ -220,6 +220,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Retrieve the currently active Restreamer configuration", "operationId": "config-3-get", "responses": { @@ -244,6 +247,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Update the current Restreamer configuration", "operationId": "config-3-set", "parameters": [ @@ -290,6 +296,9 @@ const docTemplate = `{ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Reload the currently active configuration", "operationId": "config-3-reload", "responses": { @@ -313,6 +322,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all files on the filesystem", "operationId": "diskfs-3-list-files", "parameters": [ @@ -360,6 +372,9 @@ const docTemplate = `{ "application/data", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Fetch a file from the filesystem", "operationId": "diskfs-3-get-file", "parameters": [ @@ -406,6 +421,9 @@ const docTemplate = `{ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add a file to the filesystem", "operationId": "diskfs-3-put-file", "parameters": [ @@ -460,6 +478,9 @@ const docTemplate = `{ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Remove a file from the filesystem", "operationId": "diskfs-3-delete-file", "parameters": [ @@ -498,6 +519,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all files on the memory filesystem", "operationId": "memfs-3-list-files", "parameters": [ @@ -545,6 +569,9 @@ const docTemplate = `{ "application/data", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Fetch a file from the memory filesystem", "operationId": "memfs-3-get-file", "parameters": [ @@ -591,6 +618,9 @@ const docTemplate = `{ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add a file to the memory filesystem", "operationId": "memfs-3-put-file", "parameters": [ @@ -645,6 +675,9 @@ const docTemplate = `{ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Remove a file from the memory filesystem", "operationId": "memfs-3-delete-file", "parameters": [ @@ -685,6 +718,9 @@ const docTemplate = `{ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Create a link to a file in the memory filesystem", "operationId": "memfs-3-patch", "parameters": [ @@ -732,6 +768,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Application log", "operationId": "log-3", "parameters": [ @@ -766,6 +805,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Retrieve JSON metadata from a key", "operationId": "metadata-3-get", "parameters": [ @@ -806,6 +848,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add JSON metadata under the given key", "operationId": "metadata-3-set", "parameters": [ @@ -849,6 +894,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.10.0" + ], "summary": "List all known metrics with their description and labels", "operationId": "metrics-3-describe", "responses": { @@ -876,6 +924,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Query the collected metrics", "operationId": "metrics-3-metrics", "parameters": [ @@ -916,6 +967,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all known processes", "operationId": "process-3-get-all", "parameters": [ @@ -975,6 +1029,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add a new process", "operationId": "process-3-add", "parameters": [ @@ -1015,6 +1072,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List a process by its ID", "operationId": "process-3-get", "parameters": [ @@ -1053,13 +1113,16 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Replace an existing process. This is a shortcut for DELETE+POST.", + "description": "Replace an existing process.", "consumes": [ "application/json" ], "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Replace an existing process", "operationId": "process-3-update", "parameters": [ @@ -1111,6 +1174,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Delete a process by its ID", "operationId": "process-3-delete", "parameters": [ @@ -1152,6 +1218,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Issue a command to a process", "operationId": "process-3-command", "parameters": [ @@ -1205,6 +1274,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the configuration of a process", "operationId": "process-3-get-config", "parameters": [ @@ -1249,6 +1321,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Retrieve JSON metadata stored with a process under a key", "operationId": "process-3-get-process-metadata", "parameters": [ @@ -1296,6 +1371,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add JSON metadata with a process under the given key", "operationId": "process-3-set-process-metadata", "parameters": [ @@ -1353,6 +1431,9 @@ const docTemplate = `{ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Encode the errorframe", "operationId": "process-3-playout-errorframencode", "parameters": [ @@ -1408,6 +1489,9 @@ const docTemplate = `{ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Upload an error frame", "operationId": "process-3-playout-errorframe", "parameters": [ @@ -1480,6 +1564,9 @@ const docTemplate = `{ "image/png", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the last keyframe", "operationId": "process-3-playout-keyframe", "parameters": [ @@ -1538,6 +1625,9 @@ const docTemplate = `{ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Close the current input stream", "operationId": "process-3-playout-reopen-input", "parameters": [ @@ -1589,6 +1679,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the current playout status", "operationId": "process-3-playout-status", "parameters": [ @@ -1644,6 +1737,9 @@ const docTemplate = `{ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Switch to a new stream", "operationId": "process-3-playout-stream", "parameters": [ @@ -1700,10 +1796,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Probe an existing process to get a detailed stream information on the inputs", + "description": "Probe an existing process to get a detailed stream information on the inputs.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Probe a process", "operationId": "process-3-probe", "parameters": [ @@ -1732,10 +1831,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Get the logs and the log history of a process", + "description": "Get the logs and the log history of a process.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the logs of a process", "operationId": "process-3-get-report", "parameters": [ @@ -1776,10 +1878,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Get the state and progress data of a process", + "description": "Get the state and progress data of a process.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the state of a process", "operationId": "process-3-get-state", "parameters": [ @@ -1820,10 +1925,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "List all currently publishing RTMP streams", + "description": "List all currently publishing RTMP streams.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all publishing RTMP streams", "operationId": "rtmp-3-list-channels", "responses": { @@ -1846,10 +1954,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Get a summary of all active and past sessions of the given collector", + "description": "Get a summary of all active and past sessions of the given collector.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get a summary of all active and past sessions", "operationId": "session-3-summary", "parameters": [ @@ -1877,10 +1988,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)", + "description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get a minimal summary of all active sessions", "operationId": "session-3-current", "parameters": [ @@ -1908,10 +2022,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "List all detected FFmpeg capabilities", + "description": "List all detected FFmpeg capabilities.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "FFmpeg capabilities", "operationId": "skills-3", "responses": { @@ -1931,10 +2048,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Refresh the available FFmpeg capabilities", + "description": "Refresh the available FFmpeg capabilities.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Refresh FFmpeg capabilities", "operationId": "skills-3-reload", "responses": { @@ -1958,6 +2078,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.9.0" + ], "summary": "List all publishing SRT treams", "operationId": "srt-3-list-channels", "responses": { @@ -1979,6 +2102,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Fetch minimal statistics about a process", "operationId": "widget-3-get", "parameters": [ @@ -2427,7 +2553,7 @@ const docTemplate = `{ "tenants": { "type": "array", "items": { - "$ref": "#/definitions/config.Auth0Tenant" + "$ref": "#/definitions/value.Auth0Tenant" } } } @@ -2837,6 +2963,9 @@ const docTemplate = `{ "cert_file": { "type": "string" }, + "email": { + "type": "string" + }, "enable": { "type": "boolean" }, @@ -4052,7 +4181,7 @@ const docTemplate = `{ "tenants": { "type": "array", "items": { - "$ref": "#/definitions/config.Auth0Tenant" + "$ref": "#/definitions/value.Auth0Tenant" } } } @@ -4462,6 +4591,9 @@ const docTemplate = `{ "cert_file": { "type": "string" }, + "email": { + "type": "string" + }, "enable": { "type": "boolean" }, @@ -4741,7 +4873,7 @@ const docTemplate = `{ } } }, - "config.Auth0Tenant": { + "value.Auth0Tenant": { "type": "object", "properties": { "audience": { diff --git a/docs/swagger.json b/docs/swagger.json index 9d81a348..4c5a2c2b 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -54,7 +54,7 @@ "operationId": "graph-playground", "responses": { "200": { - "description": "" + "description": "OK" } } } @@ -212,6 +212,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Retrieve the currently active Restreamer configuration", "operationId": "config-3-get", "responses": { @@ -236,6 +239,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Update the current Restreamer configuration", "operationId": "config-3-set", "parameters": [ @@ -282,6 +288,9 @@ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Reload the currently active configuration", "operationId": "config-3-reload", "responses": { @@ -305,6 +314,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all files on the filesystem", "operationId": "diskfs-3-list-files", "parameters": [ @@ -352,6 +364,9 @@ "application/data", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Fetch a file from the filesystem", "operationId": "diskfs-3-get-file", "parameters": [ @@ -398,6 +413,9 @@ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add a file to the filesystem", "operationId": "diskfs-3-put-file", "parameters": [ @@ -452,6 +470,9 @@ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Remove a file from the filesystem", "operationId": "diskfs-3-delete-file", "parameters": [ @@ -490,6 +511,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all files on the memory filesystem", "operationId": "memfs-3-list-files", "parameters": [ @@ -537,6 +561,9 @@ "application/data", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Fetch a file from the memory filesystem", "operationId": "memfs-3-get-file", "parameters": [ @@ -583,6 +610,9 @@ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add a file to the memory filesystem", "operationId": "memfs-3-put-file", "parameters": [ @@ -637,6 +667,9 @@ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Remove a file from the memory filesystem", "operationId": "memfs-3-delete-file", "parameters": [ @@ -677,6 +710,9 @@ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Create a link to a file in the memory filesystem", "operationId": "memfs-3-patch", "parameters": [ @@ -724,6 +760,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Application log", "operationId": "log-3", "parameters": [ @@ -758,6 +797,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Retrieve JSON metadata from a key", "operationId": "metadata-3-get", "parameters": [ @@ -798,6 +840,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add JSON metadata under the given key", "operationId": "metadata-3-set", "parameters": [ @@ -841,6 +886,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.10.0" + ], "summary": "List all known metrics with their description and labels", "operationId": "metrics-3-describe", "responses": { @@ -868,6 +916,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Query the collected metrics", "operationId": "metrics-3-metrics", "parameters": [ @@ -908,6 +959,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all known processes", "operationId": "process-3-get-all", "parameters": [ @@ -967,6 +1021,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add a new process", "operationId": "process-3-add", "parameters": [ @@ -1007,6 +1064,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List a process by its ID", "operationId": "process-3-get", "parameters": [ @@ -1045,13 +1105,16 @@ "ApiKeyAuth": [] } ], - "description": "Replace an existing process. This is a shortcut for DELETE+POST.", + "description": "Replace an existing process.", "consumes": [ "application/json" ], "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Replace an existing process", "operationId": "process-3-update", "parameters": [ @@ -1103,6 +1166,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Delete a process by its ID", "operationId": "process-3-delete", "parameters": [ @@ -1144,6 +1210,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Issue a command to a process", "operationId": "process-3-command", "parameters": [ @@ -1197,6 +1266,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the configuration of a process", "operationId": "process-3-get-config", "parameters": [ @@ -1241,6 +1313,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Retrieve JSON metadata stored with a process under a key", "operationId": "process-3-get-process-metadata", "parameters": [ @@ -1288,6 +1363,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Add JSON metadata with a process under the given key", "operationId": "process-3-set-process-metadata", "parameters": [ @@ -1345,6 +1423,9 @@ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Encode the errorframe", "operationId": "process-3-playout-errorframencode", "parameters": [ @@ -1400,6 +1481,9 @@ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Upload an error frame", "operationId": "process-3-playout-errorframe", "parameters": [ @@ -1472,6 +1556,9 @@ "image/png", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the last keyframe", "operationId": "process-3-playout-keyframe", "parameters": [ @@ -1530,6 +1617,9 @@ "produces": [ "text/plain" ], + "tags": [ + "v16.7.2" + ], "summary": "Close the current input stream", "operationId": "process-3-playout-reopen-input", "parameters": [ @@ -1581,6 +1671,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the current playout status", "operationId": "process-3-playout-status", "parameters": [ @@ -1636,6 +1729,9 @@ "text/plain", "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Switch to a new stream", "operationId": "process-3-playout-stream", "parameters": [ @@ -1692,10 +1788,13 @@ "ApiKeyAuth": [] } ], - "description": "Probe an existing process to get a detailed stream information on the inputs", + "description": "Probe an existing process to get a detailed stream information on the inputs.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Probe a process", "operationId": "process-3-probe", "parameters": [ @@ -1724,10 +1823,13 @@ "ApiKeyAuth": [] } ], - "description": "Get the logs and the log history of a process", + "description": "Get the logs and the log history of a process.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the logs of a process", "operationId": "process-3-get-report", "parameters": [ @@ -1768,10 +1870,13 @@ "ApiKeyAuth": [] } ], - "description": "Get the state and progress data of a process", + "description": "Get the state and progress data of a process.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get the state of a process", "operationId": "process-3-get-state", "parameters": [ @@ -1812,10 +1917,13 @@ "ApiKeyAuth": [] } ], - "description": "List all currently publishing RTMP streams", + "description": "List all currently publishing RTMP streams.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "List all publishing RTMP streams", "operationId": "rtmp-3-list-channels", "responses": { @@ -1838,10 +1946,13 @@ "ApiKeyAuth": [] } ], - "description": "Get a summary of all active and past sessions of the given collector", + "description": "Get a summary of all active and past sessions of the given collector.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get a summary of all active and past sessions", "operationId": "session-3-summary", "parameters": [ @@ -1869,10 +1980,13 @@ "ApiKeyAuth": [] } ], - "description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)", + "description": "Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Get a minimal summary of all active sessions", "operationId": "session-3-current", "parameters": [ @@ -1900,10 +2014,13 @@ "ApiKeyAuth": [] } ], - "description": "List all detected FFmpeg capabilities", + "description": "List all detected FFmpeg capabilities.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "FFmpeg capabilities", "operationId": "skills-3", "responses": { @@ -1923,10 +2040,13 @@ "ApiKeyAuth": [] } ], - "description": "Refresh the available FFmpeg capabilities", + "description": "Refresh the available FFmpeg capabilities.", "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Refresh FFmpeg capabilities", "operationId": "skills-3-reload", "responses": { @@ -1950,6 +2070,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.9.0" + ], "summary": "List all publishing SRT treams", "operationId": "srt-3-list-channels", "responses": { @@ -1971,6 +2094,9 @@ "produces": [ "application/json" ], + "tags": [ + "v16.7.2" + ], "summary": "Fetch minimal statistics about a process", "operationId": "widget-3-get", "parameters": [ @@ -2419,7 +2545,7 @@ "tenants": { "type": "array", "items": { - "$ref": "#/definitions/config.Auth0Tenant" + "$ref": "#/definitions/value.Auth0Tenant" } } } @@ -2829,6 +2955,9 @@ "cert_file": { "type": "string" }, + "email": { + "type": "string" + }, "enable": { "type": "boolean" }, @@ -4044,7 +4173,7 @@ "tenants": { "type": "array", "items": { - "$ref": "#/definitions/config.Auth0Tenant" + "$ref": "#/definitions/value.Auth0Tenant" } } } @@ -4454,6 +4583,9 @@ "cert_file": { "type": "string" }, + "email": { + "type": "string" + }, "enable": { "type": "boolean" }, @@ -4733,7 +4865,7 @@ } } }, - "config.Auth0Tenant": { + "value.Auth0Tenant": { "type": "object", "properties": { "audience": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 4bfe0b0d..7e30e514 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -122,7 +122,7 @@ definitions: type: boolean tenants: items: - $ref: '#/definitions/config.Auth0Tenant' + $ref: '#/definitions/value.Auth0Tenant' type: array type: object disable_localhost: @@ -388,6 +388,8 @@ definitions: type: boolean cert_file: type: string + email: + type: string enable: type: boolean key_file: @@ -1245,7 +1247,7 @@ definitions: type: boolean tenants: items: - $ref: '#/definitions/config.Auth0Tenant' + $ref: '#/definitions/value.Auth0Tenant' type: array type: object disable_localhost: @@ -1511,6 +1513,8 @@ definitions: type: boolean cert_file: type: string + email: + type: string enable: type: boolean key_file: @@ -1691,7 +1695,7 @@ definitions: uptime: type: integer type: object - config.Auth0Tenant: + value.Auth0Tenant: properties: audience: type: string @@ -1767,7 +1771,7 @@ paths: - text/html responses: "200": - description: "" + description: OK security: - ApiKeyAuth: [] summary: Load GraphQL playground @@ -1876,6 +1880,8 @@ paths: security: - ApiKeyAuth: [] summary: Retrieve the currently active Restreamer configuration + tags: + - v16.7.2 put: consumes: - application/json @@ -1907,6 +1913,8 @@ paths: security: - ApiKeyAuth: [] summary: Update the current Restreamer configuration + tags: + - v16.7.2 /api/v3/config/reload: get: description: Reload the currently active configuration. This will trigger a @@ -1922,6 +1930,8 @@ paths: security: - ApiKeyAuth: [] summary: Reload the currently active configuration + tags: + - v16.7.2 /api/v3/fs/disk: get: description: List all files on the filesystem. The listing can be ordered by @@ -1952,6 +1962,8 @@ paths: security: - ApiKeyAuth: [] summary: List all files on the filesystem + tags: + - v16.7.2 /api/v3/fs/disk/{path}: delete: description: Remove a file from the filesystem @@ -1976,6 +1988,8 @@ paths: security: - ApiKeyAuth: [] summary: Remove a file from the filesystem + tags: + - v16.7.2 get: description: Fetch a file from the filesystem. The contents of that file are returned. @@ -2005,6 +2019,8 @@ paths: security: - ApiKeyAuth: [] summary: Fetch a file from the filesystem + tags: + - v16.7.2 put: consumes: - application/data @@ -2043,6 +2059,8 @@ paths: security: - ApiKeyAuth: [] summary: Add a file to the filesystem + tags: + - v16.7.2 /api/v3/fs/mem: get: description: List all files on the memory filesystem. The listing can be ordered @@ -2073,6 +2091,8 @@ paths: security: - ApiKeyAuth: [] summary: List all files on the memory filesystem + tags: + - v16.7.2 /api/v3/fs/mem/{path}: delete: description: Remove a file from the memory filesystem @@ -2097,6 +2117,8 @@ paths: security: - ApiKeyAuth: [] summary: Remove a file from the memory filesystem + tags: + - v16.7.2 get: description: Fetch a file from the memory filesystem operationId: memfs-3-get-file @@ -2125,6 +2147,8 @@ paths: security: - ApiKeyAuth: [] summary: Fetch a file from the memory filesystem + tags: + - v16.7.2 patch: consumes: - application/data @@ -2158,6 +2182,8 @@ paths: security: - ApiKeyAuth: [] summary: Create a link to a file in the memory filesystem + tags: + - v16.7.2 put: consumes: - application/data @@ -2196,6 +2222,8 @@ paths: security: - ApiKeyAuth: [] summary: Add a file to the memory filesystem + tags: + - v16.7.2 /api/v3/log: get: description: Get the last log lines of the Restreamer application @@ -2217,6 +2245,8 @@ paths: security: - ApiKeyAuth: [] summary: Application log + tags: + - v16.7.2 /api/v3/metadata/{key}: get: description: Retrieve the previously stored JSON metadata under the given key. @@ -2245,6 +2275,8 @@ paths: security: - ApiKeyAuth: [] summary: Retrieve JSON metadata from a key + tags: + - v16.7.2 put: description: Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key @@ -2274,6 +2306,8 @@ paths: security: - ApiKeyAuth: [] summary: Add JSON metadata under the given key + tags: + - v16.7.2 /api/v3/metrics: get: description: List all known metrics with their description and labels @@ -2290,6 +2324,8 @@ paths: security: - ApiKeyAuth: [] summary: List all known metrics with their description and labels + tags: + - v16.10.0 post: consumes: - application/json @@ -2316,6 +2352,8 @@ paths: security: - ApiKeyAuth: [] summary: Query the collected metrics + tags: + - v16.7.2 /api/v3/process: get: description: List all known processes. Use the query parameter to filter the @@ -2360,6 +2398,8 @@ paths: security: - ApiKeyAuth: [] summary: List all known processes + tags: + - v16.7.2 post: consumes: - application/json @@ -2386,6 +2426,8 @@ paths: security: - ApiKeyAuth: [] summary: Add a new process + tags: + - v16.7.2 /api/v3/process/{id}: delete: description: Delete a process by its ID @@ -2410,6 +2452,8 @@ paths: security: - ApiKeyAuth: [] summary: Delete a process by its ID + tags: + - v16.7.2 get: description: List a process by its ID. Use the filter parameter to specifiy the level of detail of the output. @@ -2439,10 +2483,12 @@ paths: security: - ApiKeyAuth: [] summary: List a process by its ID + tags: + - v16.7.2 put: consumes: - application/json - description: Replace an existing process. This is a shortcut for DELETE+POST. + description: Replace an existing process. operationId: process-3-update parameters: - description: Process ID @@ -2474,6 +2520,8 @@ paths: security: - ApiKeyAuth: [] summary: Replace an existing process + tags: + - v16.7.2 /api/v3/process/{id}/command: put: consumes: @@ -2510,6 +2558,8 @@ paths: security: - ApiKeyAuth: [] summary: Issue a command to a process + tags: + - v16.7.2 /api/v3/process/{id}/config: get: description: Get the configuration of a process. This is the configuration as @@ -2539,6 +2589,8 @@ paths: security: - ApiKeyAuth: [] summary: Get the configuration of a process + tags: + - v16.7.2 /api/v3/process/{id}/metadata/{key}: get: description: Retrieve the previously stored JSON metadata under the given key. @@ -2572,6 +2624,8 @@ paths: security: - ApiKeyAuth: [] summary: Retrieve JSON metadata stored with a process under a key + tags: + - v16.7.2 put: description: Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key @@ -2611,6 +2665,8 @@ paths: security: - ApiKeyAuth: [] summary: Add JSON metadata with a process under the given key + tags: + - v16.7.2 /api/v3/process/{id}/playout/{inputid}/errorframe/{name}: post: consumes: @@ -2660,6 +2716,8 @@ paths: security: - ApiKeyAuth: [] summary: Upload an error frame + tags: + - v16.7.2 /api/v3/process/{id}/playout/{inputid}/errorframe/encode: get: description: Immediately encode the errorframe (if available and looping) @@ -2694,6 +2752,8 @@ paths: security: - ApiKeyAuth: [] summary: Encode the errorframe + tags: + - v16.7.2 /api/v3/process/{id}/playout/{inputid}/keyframe/{name}: get: description: Get the last keyframe of an input of a process. The extension of @@ -2735,6 +2795,8 @@ paths: security: - ApiKeyAuth: [] summary: Get the last keyframe + tags: + - v16.7.2 /api/v3/process/{id}/playout/{inputid}/reopen: get: description: Close the current input stream such that it will be automatically @@ -2769,6 +2831,8 @@ paths: security: - ApiKeyAuth: [] summary: Close the current input stream + tags: + - v16.7.2 /api/v3/process/{id}/playout/{inputid}/status: get: description: Get the current playout status of an input of a process @@ -2802,6 +2866,8 @@ paths: security: - ApiKeyAuth: [] summary: Get the current playout status + tags: + - v16.7.2 /api/v3/process/{id}/playout/{inputid}/stream: put: consumes: @@ -2845,10 +2911,12 @@ paths: security: - ApiKeyAuth: [] summary: Switch to a new stream + tags: + - v16.7.2 /api/v3/process/{id}/probe: get: description: Probe an existing process to get a detailed stream information - on the inputs + on the inputs. operationId: process-3-probe parameters: - description: Process ID @@ -2866,9 +2934,11 @@ paths: security: - ApiKeyAuth: [] summary: Probe a process + tags: + - v16.7.2 /api/v3/process/{id}/report: get: - description: Get the logs and the log history of a process + description: Get the logs and the log history of a process. operationId: process-3-get-report parameters: - description: Process ID @@ -2894,9 +2964,11 @@ paths: security: - ApiKeyAuth: [] summary: Get the logs of a process + tags: + - v16.7.2 /api/v3/process/{id}/state: get: - description: Get the state and progress data of a process + description: Get the state and progress data of a process. operationId: process-3-get-state parameters: - description: Process ID @@ -2922,9 +2994,11 @@ paths: security: - ApiKeyAuth: [] summary: Get the state of a process + tags: + - v16.7.2 /api/v3/rtmp: get: - description: List all currently publishing RTMP streams + description: List all currently publishing RTMP streams. operationId: rtmp-3-list-channels produces: - application/json @@ -2938,9 +3012,11 @@ paths: security: - ApiKeyAuth: [] summary: List all publishing RTMP streams + tags: + - v16.7.2 /api/v3/session: get: - description: Get a summary of all active and past sessions of the given collector + description: Get a summary of all active and past sessions of the given collector. operationId: session-3-summary parameters: - description: Comma separated list of collectors @@ -2957,10 +3033,12 @@ paths: security: - ApiKeyAuth: [] summary: Get a summary of all active and past sessions + tags: + - v16.7.2 /api/v3/session/active: get: description: Get a minimal summary of all active sessions (i.e. number of sessions, - bandwidth) + bandwidth). operationId: session-3-current parameters: - description: Comma separated list of collectors @@ -2977,9 +3055,11 @@ paths: security: - ApiKeyAuth: [] summary: Get a minimal summary of all active sessions + tags: + - v16.7.2 /api/v3/skills: get: - description: List all detected FFmpeg capabilities + description: List all detected FFmpeg capabilities. operationId: skills-3 produces: - application/json @@ -2991,9 +3071,11 @@ paths: security: - ApiKeyAuth: [] summary: FFmpeg capabilities + tags: + - v16.7.2 /api/v3/skills/reload: get: - description: Refresh the available FFmpeg capabilities + description: Refresh the available FFmpeg capabilities. operationId: skills-3-reload produces: - application/json @@ -3005,6 +3087,8 @@ paths: security: - ApiKeyAuth: [] summary: Refresh FFmpeg capabilities + tags: + - v16.7.2 /api/v3/srt: get: description: List all currently publishing SRT streams. This endpoint is EXPERIMENTAL @@ -3022,6 +3106,8 @@ paths: security: - ApiKeyAuth: [] summary: List all publishing SRT treams + tags: + - v16.9.0 /api/v3/widget/process/{id}: get: description: Fetch minimal statistics about a process, which is not protected @@ -3045,6 +3131,8 @@ paths: schema: $ref: '#/definitions/api.Error' summary: Fetch minimal statistics about a process + tags: + - v16.7.2 /memfs/{path}: delete: description: Remove a file from the memory filesystem diff --git a/http/handler/api/config.go b/http/handler/api/config.go index 60f8b520..5e084e0b 100644 --- a/http/handler/api/config.go +++ b/http/handler/api/config.go @@ -28,6 +28,7 @@ func NewConfig(store cfgstore.Store) *ConfigHandler { // Get returns the currently active Restreamer configuration // @Summary Retrieve the currently active Restreamer configuration // @Description Retrieve the currently active Restreamer configuration +// @Tags v16.7.2 // @ID config-3-get // @Produce json // @Success 200 {object} api.Config @@ -45,6 +46,7 @@ func (p *ConfigHandler) Get(c echo.Context) error { // Set will set the given configuration as new active configuration // @Summary Update the current Restreamer configuration // @Description Update the current Restreamer configuration by providing a complete or partial configuration. Fields that are not provided will not be changed. +// @Tags v16.7.2 // @ID config-3-set // @Accept json // @Produce json @@ -156,6 +158,7 @@ func (p *ConfigHandler) Set(c echo.Context) error { // Reload will reload the currently active configuration // @Summary Reload the currently active configuration // @Description Reload the currently active configuration. This will trigger a restart of the Restreamer. +// @Tags v16.7.2 // @ID config-3-reload // @Produce plain // @Success 200 {string} string "OK" diff --git a/http/handler/api/diskfs.go b/http/handler/api/diskfs.go index b4bc7fb7..98156ac9 100644 --- a/http/handler/api/diskfs.go +++ b/http/handler/api/diskfs.go @@ -34,6 +34,7 @@ func NewDiskFS(fs fs.Filesystem, cache cache.Cacher) *DiskFSHandler { // GetFile returns the file at the given path // @Summary Fetch a file from the filesystem // @Description Fetch a file from the filesystem. The contents of that file are returned. +// @Tags v16.7.2 // @ID diskfs-3-get-file // @Produce application/data // @Produce json @@ -86,6 +87,7 @@ func (h *DiskFSHandler) GetFile(c echo.Context) error { // PutFile adds or overwrites a file at the given path // @Summary Add a file to the filesystem // @Description Writes or overwrites a file on the filesystem +// @Tags v16.7.2 // @ID diskfs-3-put-file // @Accept application/data // @Produce text/plain @@ -125,6 +127,7 @@ func (h *DiskFSHandler) PutFile(c echo.Context) error { // DeleteFile removes a file from the filesystem // @Summary Remove a file from the filesystem // @Description Remove a file from the filesystem +// @Tags v16.7.2 // @ID diskfs-3-delete-file // @Produce text/plain // @Param path path string true "Path to file" @@ -153,6 +156,7 @@ func (h *DiskFSHandler) DeleteFile(c echo.Context) error { // ListFiles lists all files on the filesystem // @Summary List all files on the filesystem // @Description List all files on the filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order. +// @Tags v16.7.2 // @ID diskfs-3-list-files // @Produce json // @Param glob query string false "glob pattern for file names" diff --git a/http/handler/api/log.go b/http/handler/api/log.go index 22c33864..8ef4dbed 100644 --- a/http/handler/api/log.go +++ b/http/handler/api/log.go @@ -31,6 +31,7 @@ func NewLog(buffer log.BufferWriter) *LogHandler { // Log returns the last log lines of the Restreamer application // @Summary Application log // @Description Get the last log lines of the Restreamer application +// @Tags v16.7.2 // @ID log-3 // @Param format query string false "Format of the list of log events (*console, raw)" // @Produce json diff --git a/http/handler/api/memfs.go b/http/handler/api/memfs.go index 2c6bd101..2b64c4d0 100644 --- a/http/handler/api/memfs.go +++ b/http/handler/api/memfs.go @@ -31,6 +31,7 @@ func NewMemFS(fs fs.Filesystem) *MemFSHandler { // GetFileAPI returns the file at the given path // @Summary Fetch a file from the memory filesystem // @Description Fetch a file from the memory filesystem +// @Tags v16.7.2 // @ID memfs-3-get-file // @Produce application/data // @Produce json @@ -47,6 +48,7 @@ func (h *MemFSHandler) GetFile(c echo.Context) error { // PutFileAPI adds or overwrites a file at the given path // @Summary Add a file to the memory filesystem // @Description Writes or overwrites a file on the memory filesystem +// @Tags v16.7.2 // @ID memfs-3-put-file // @Accept application/data // @Produce text/plain @@ -65,6 +67,7 @@ func (h *MemFSHandler) PutFile(c echo.Context) error { // DeleteFileAPI removes a file from the filesystem // @Summary Remove a file from the memory filesystem // @Description Remove a file from the memory filesystem +// @Tags v16.7.2 // @ID memfs-3-delete-file // @Produce text/plain // @Param path path string true "Path to file" @@ -79,6 +82,7 @@ func (h *MemFSHandler) DeleteFile(c echo.Context) error { // PatchFile creates a symbolic link to a file in the filesystem // @Summary Create a link to a file in the memory filesystem // @Description Create a link to a file in the memory filesystem. The file linked to has to exist. +// @Tags v16.7.2 // @ID memfs-3-patch // @Accept application/data // @Produce text/plain @@ -118,6 +122,7 @@ func (h *MemFSHandler) PatchFile(c echo.Context) error { // ListFiles lists all files on the filesystem // @Summary List all files on the memory filesystem // @Description List all files on the memory filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order. +// @Tags v16.7.2 // @ID memfs-3-list-files // @Produce json // @Param glob query string false "glob pattern for file names" diff --git a/http/handler/api/metrics.go b/http/handler/api/metrics.go index d1356686..06bd80f7 100644 --- a/http/handler/api/metrics.go +++ b/http/handler/api/metrics.go @@ -32,6 +32,7 @@ func NewMetrics(config MetricsConfig) *MetricsHandler { // Describe the known metrics // @Summary List all known metrics with their description and labels // @Description List all known metrics with their description and labels +// @Tags v16.10.0 // @ID metrics-3-describe // @Produce json // @Success 200 {array} api.MetricsDescription @@ -60,6 +61,7 @@ func (r *MetricsHandler) Describe(c echo.Context) error { // Query the collected metrics // @Summary Query the collected metrics // @Description Query the collected metrics +// @Tags v16.7.2 // @ID metrics-3-metrics // @Accept json // @Produce json diff --git a/http/handler/api/playout.go b/http/handler/api/playout.go index 9387172f..cc073001 100644 --- a/http/handler/api/playout.go +++ b/http/handler/api/playout.go @@ -31,6 +31,7 @@ func NewPlayout(restream restream.Restreamer) *PlayoutHandler { // Status return the current playout status // @Summary Get the current playout status // @Description Get the current playout status of an input of a process +// @Tags v16.7.2 // @ID process-3-playout-status // @Produce json // @Param id path string true "Process ID" @@ -84,6 +85,7 @@ func (h *PlayoutHandler) Status(c echo.Context) error { // Keyframe returns the last keyframe // @Summary Get the last keyframe // @Description Get the last keyframe of an input of a process. The extension of the name determines the return type. +// @Tags v16.7.2 // @ID process-3-playout-keyframe // @Produce image/jpeg // @Produce image/png @@ -133,6 +135,7 @@ func (h *PlayoutHandler) Keyframe(c echo.Context) error { // EncodeErrorframe encodes the errorframe // @Summary Encode the errorframe // @Description Immediately encode the errorframe (if available and looping) +// @Tags v16.7.2 // @ID process-3-playout-errorframencode // @Produce text/plain // @Produce json @@ -173,6 +176,7 @@ func (h *PlayoutHandler) EncodeErrorframe(c echo.Context) error { // SetErrorframe sets an errorframe // @Summary Upload an error frame // @Description Upload an error frame which will be encoded immediately +// @Tags v16.7.2 // @ID process-3-playout-errorframe // @Produce text/plain // @Produce json @@ -221,6 +225,7 @@ func (h *PlayoutHandler) SetErrorframe(c echo.Context) error { // ReopenInput closes the current input stream // @Summary Close the current input stream // @Description Close the current input stream such that it will be automatically re-opened +// @Tags v16.7.2 // @ID process-3-playout-reopen-input // @Produce plain // @Param id path string true "Process ID" @@ -260,6 +265,7 @@ func (h *PlayoutHandler) ReopenInput(c echo.Context) error { // SetStream replaces the current stream // @Summary Switch to a new stream // @Description Replace the current stream with the one from the given URL. The switch will only happen if the stream parameters match. +// @Tags v16.7.2 // @ID process-3-playout-stream // @Produce text/plain // @Produce json diff --git a/http/handler/api/restream.go b/http/handler/api/restream.go index f076bd2b..2e6f0c2a 100644 --- a/http/handler/api/restream.go +++ b/http/handler/api/restream.go @@ -27,6 +27,7 @@ func NewRestream(restream restream.Restreamer) *RestreamHandler { // Add adds a new process // @Summary Add a new process // @Description Add a new FFmpeg process +// @Tags v16.7.2 // @ID process-3-add // @Accept json // @Produce json @@ -68,6 +69,7 @@ func (h *RestreamHandler) Add(c echo.Context) error { // GetAll returns all known processes // @Summary List all known processes // @Description List all known processes. Use the query parameter to filter the listed processes. +// @Tags v16.7.2 // @ID process-3-get-all // @Produce json // @Param filter query string false "Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output." @@ -118,6 +120,7 @@ func (h *RestreamHandler) GetAll(c echo.Context) error { // Get returns the process with the given ID // @Summary List a process by its ID // @Description List a process by its ID. Use the filter parameter to specifiy the level of detail of the output. +// @Tags v16.7.2 // @ID process-3-get // @Produce json // @Param id path string true "Process ID" @@ -141,6 +144,7 @@ func (h *RestreamHandler) Get(c echo.Context) error { // Delete deletes the process with the given ID // @Summary Delete a process by its ID // @Description Delete a process by its ID +// @Tags v16.7.2 // @ID process-3-delete // @Produce json // @Param id path string true "Process ID" @@ -164,7 +168,8 @@ func (h *RestreamHandler) Delete(c echo.Context) error { // Update replaces an existing process // @Summary Replace an existing process -// @Description Replace an existing process. This is a shortcut for DELETE+POST. +// @Description Replace an existing process. +// @Tags v16.7.2 // @ID process-3-update // @Accept json // @Produce json @@ -206,6 +211,7 @@ func (h *RestreamHandler) Update(c echo.Context) error { // Command issues a command to a process // @Summary Issue a command to a process // @Description Issue a command to a process: start, stop, reload, restart +// @Tags v16.7.2 // @ID process-3-command // @Accept json // @Produce json @@ -248,6 +254,7 @@ func (h *RestreamHandler) Command(c echo.Context) error { // GetConfig returns the configuration of a process // @Summary Get the configuration of a process // @Description Get the configuration of a process. This is the configuration as provided by Add or Update. +// @Tags v16.7.2 // @ID process-3-get-config // @Produce json // @Param id path string true "Process ID" @@ -272,7 +279,8 @@ func (h *RestreamHandler) GetConfig(c echo.Context) error { // GetState returns the current state of a process // @Summary Get the state of a process -// @Description Get the state and progress data of a process +// @Description Get the state and progress data of a process. +// @Tags v16.7.2 // @ID process-3-get-state // @Produce json // @Param id path string true "Process ID" @@ -297,7 +305,8 @@ func (h *RestreamHandler) GetState(c echo.Context) error { // GetReport return the current log and the log history of a process // @Summary Get the logs of a process -// @Description Get the logs and the log history of a process +// @Description Get the logs and the log history of a process. +// @Tags v16.7.2 // @ID process-3-get-report // @Produce json // @Param id path string true "Process ID" @@ -322,7 +331,8 @@ func (h *RestreamHandler) GetReport(c echo.Context) error { // Probe probes a process // @Summary Probe a process -// @Description Probe an existing process to get a detailed stream information on the inputs +// @Description Probe an existing process to get a detailed stream information on the inputs. +// @Tags v16.7.2 // @ID process-3-probe // @Produce json // @Param id path string true "Process ID" @@ -342,7 +352,8 @@ func (h *RestreamHandler) Probe(c echo.Context) error { // Skills returns the detected FFmpeg capabilities // @Summary FFmpeg capabilities -// @Description List all detected FFmpeg capabilities +// @Description List all detected FFmpeg capabilities. +// @Tags v16.7.2 // @ID skills-3 // @Produce json // @Success 200 {object} api.Skills @@ -359,7 +370,8 @@ func (h *RestreamHandler) Skills(c echo.Context) error { // ReloadSkills will refresh the FFmpeg capabilities // @Summary Refresh FFmpeg capabilities -// @Description Refresh the available FFmpeg capabilities +// @Description Refresh the available FFmpeg capabilities. +// @Tags v16.7.2 // @ID skills-3-reload // @Produce json // @Success 200 {object} api.Skills @@ -378,6 +390,7 @@ func (h *RestreamHandler) ReloadSkills(c echo.Context) error { // GetProcessMetadata returns the metadata stored with a process // @Summary Retrieve JSON metadata stored with a process under a key // @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned. +// @Tags v16.7.2 // @ID process-3-get-process-metadata // @Produce json // @Param id path string true "Process ID" @@ -402,6 +415,7 @@ func (h *RestreamHandler) GetProcessMetadata(c echo.Context) error { // SetProcessMetadata stores metadata with a process // @Summary Add JSON metadata with a process under the given key // @Description Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key doesn't exist, it will be created. +// @Tags v16.7.2 // @ID process-3-set-process-metadata // @Produce json // @Param id path string true "Process ID" @@ -436,6 +450,7 @@ func (h *RestreamHandler) SetProcessMetadata(c echo.Context) error { // GetMetadata returns the metadata stored with the Restreamer // @Summary Retrieve JSON metadata from a key // @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned. +// @Tags v16.7.2 // @ID metadata-3-get // @Produce json // @Param key path string true "Key for data store" @@ -458,6 +473,7 @@ func (h *RestreamHandler) GetMetadata(c echo.Context) error { // SetMetadata stores metadata with the Restreamer // @Summary Add JSON metadata under the given key // @Description Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key doesn't exist, it will be created. +// @Tags v16.7.2 // @ID metadata-3-set // @Produce json // @Param key path string true "Key for data store" diff --git a/http/handler/api/rtmp.go b/http/handler/api/rtmp.go index 1adde4a9..3f2dbbb5 100644 --- a/http/handler/api/rtmp.go +++ b/http/handler/api/rtmp.go @@ -23,7 +23,8 @@ func NewRTMP(rtmp rtmp.Server) *RTMPHandler { // ListChannels lists all currently publishing RTMP streams // @Summary List all publishing RTMP streams -// @Description List all currently publishing RTMP streams +// @Description List all currently publishing RTMP streams. +// @Tags v16.7.2 // @ID rtmp-3-list-channels // @Produce json // @Success 200 {array} api.RTMPChannel diff --git a/http/handler/api/session.go b/http/handler/api/session.go index de297cd9..bc45f5cd 100644 --- a/http/handler/api/session.go +++ b/http/handler/api/session.go @@ -25,7 +25,8 @@ func NewSession(registry session.RegistryReader) *SessionHandler { // Summary returns a summary of all active and past sessions // @Summary Get a summary of all active and past sessions -// @Description Get a summary of all active and past sessions of the given collector +// @Description Get a summary of all active and past sessions of the given collector. +// @Tags v16.7.2 // @ID session-3-summary // @Produce json // @Security ApiKeyAuth @@ -49,7 +50,8 @@ func (s *SessionHandler) Summary(c echo.Context) error { // Active returns a list of active sessions // @Summary Get a minimal summary of all active sessions -// @Description Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth) +// @Description Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth). +// @Tags v16.7.2 // @ID session-3-current // @Produce json // @Security ApiKeyAuth diff --git a/http/handler/api/srt.go b/http/handler/api/srt.go index 1d98cc18..de9acb7d 100644 --- a/http/handler/api/srt.go +++ b/http/handler/api/srt.go @@ -24,6 +24,7 @@ func NewSRT(srt srt.Server) *SRTHandler { // ListChannels lists all currently publishing SRT streams // @Summary List all publishing SRT treams // @Description List all currently publishing SRT streams. This endpoint is EXPERIMENTAL and may change in future. +// @Tags v16.9.0 // @ID srt-3-list-channels // @Produce json // @Success 200 {array} api.SRTChannels diff --git a/http/handler/api/widget.go b/http/handler/api/widget.go index 41916444..bb4688f2 100644 --- a/http/handler/api/widget.go +++ b/http/handler/api/widget.go @@ -34,6 +34,7 @@ func NewWidget(config WidgetConfig) *WidgetHandler { // Get returns minimal public statistics about a process // @Summary Fetch minimal statistics about a process // @Description Fetch minimal statistics about a process, which is not protected by any auth. +// @Tags v16.7.2 // @ID widget-3-get // @Produce json // @Param id path string true "ID of a process" From 07e28988576f87377607a6b9d1167eecb69d6275 Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Mon, 24 Oct 2022 15:25:14 +0200 Subject: [PATCH 08/22] Expose more SRT connection statistics --- http/api/srt.go | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/http/api/srt.go b/http/api/srt.go index 76194d52..2882a430 100644 --- a/http/api/srt.go +++ b/http/api/srt.go @@ -96,6 +96,26 @@ func (s *SRTStatistics) Unmarshal(ss *gosrt.Statistics) { s.ByteSndDrop = ss.ByteSndDrop s.ByteRcvDrop = ss.ByteRcvDrop s.ByteRcvUndecrypt = ss.ByteRcvUndecrypt + + s.UsPktSndPeriod = ss.UsPktSndPeriod + s.PktFlowWindow = ss.PktFlowWindow + s.PktFlightSize = ss.PktFlightSize + s.MsRTT = ss.MsRTT + s.MbpsBandwidth = ss.MbpsBandwidth + s.ByteAvailSndBuf = ss.ByteAvailSndBuf + s.ByteAvailRcvBuf = ss.ByteAvailRcvBuf + s.MbpsMaxBW = ss.MbpsMaxBW + s.ByteMSS = ss.ByteMSS + s.PktSndBuf = ss.PktSndBuf + s.ByteSndBuf = ss.ByteSndBuf + s.MsSndBuf = ss.MsSndBuf + s.MsSndTsbPdDelay = ss.MsSndTsbPdDelay + s.PktRcvBuf = ss.PktRcvBuf + s.ByteRcvBuf = ss.ByteRcvBuf + s.MsRcvBuf = ss.MsRcvBuf + s.MsRcvTsbPdDelay = ss.MsRcvTsbPdDelay + s.PktReorderTolerance = ss.PktReorderTolerance + s.PktRcvAvgBelatedTime = ss.PktRcvAvgBelatedTime } type SRTLog struct { From 35c5c9f077219c7a6b4cf50ede719e785051e839 Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Tue, 25 Oct 2022 14:00:27 +0200 Subject: [PATCH 09/22] Add alternative streamid format for SRT The streamid format that starts with #!: is recommended in the SRT specs but it usually causes trouble where you're limited in the use of such characters. Some hardware devices will not accept such streamids. The alternative format is simpler and has the form [resource](,token:[token])?(,mode:[mode])? token and mode are optional. mode can have the values "publish" or "request". If mode is not provided, a value of "request" is assumed. --- srt/srt.go | 58 +++++++++++++++++++++++++++++++++++++++++++++++-- srt/srt_test.go | 22 +++++++++++++++++-- 2 files changed, 76 insertions(+), 4 deletions(-) diff --git a/srt/srt.go b/srt/srt.go index 78c5bbca..73a8ba10 100644 --- a/srt/srt.go +++ b/srt/srt.go @@ -5,6 +5,7 @@ import ( "context" "fmt" "net" + "regexp" "strings" "sync" "time" @@ -365,6 +366,59 @@ type streamInfo struct { func parseStreamId(streamid string) (streamInfo, error) { si := streamInfo{} + if strings.HasPrefix(streamid, "#!:") { + return parseOldStreamId(streamid) + } + + re := regexp.MustCompile(`,(token|mode):(.+)`) + + results := map[string]string{} + + idEnd := -1 + value := streamid + key := "" + + for { + matches := re.FindStringSubmatchIndex(value) + if matches == nil { + break + } + + if idEnd < 0 { + idEnd = matches[2] - 1 + } + + if len(key) != 0 { + results[key] = value[:matches[2]-1] + } + + key = value[matches[2]:matches[3]] + value = value[matches[4]:matches[5]] + + results[key] = value + } + + if idEnd < 0 { + idEnd = len(streamid) + } + + si.resource = streamid[:idEnd] + if token, ok := results["token"]; ok { + si.token = token + } + + if mode, ok := results["mode"]; ok { + si.mode = mode + } else { + si.mode = "request" + } + + return si, nil +} + +func parseOldStreamId(streamid string) (streamInfo, error) { + si := streamInfo{} + if !strings.HasPrefix(streamid, "#!:") { return si, fmt.Errorf("unknown streamid format") } @@ -373,7 +427,7 @@ func parseStreamId(streamid string) (streamInfo, error) { kvs := strings.Split(streamid, ",") - split := func(s, sep string) (string, string, error) { + splitFn := func(s, sep string) (string, string, error) { splitted := strings.SplitN(s, sep, 2) if len(splitted) != 2 { @@ -384,7 +438,7 @@ func parseStreamId(streamid string) (streamInfo, error) { } for _, kv := range kvs { - key, value, err := split(kv, "=") + key, value, err := splitFn(kv, "=") if err != nil { continue } diff --git a/srt/srt_test.go b/srt/srt_test.go index b4b2d843..91ae7ed1 100644 --- a/srt/srt_test.go +++ b/srt/srt_test.go @@ -8,7 +8,25 @@ import ( func TestParseStreamId(t *testing.T) { streamids := map[string]streamInfo{ - "bla": {}, + "bla": {resource: "bla", mode: "request"}, + "bla,mode:publish": {resource: "bla", mode: "publish"}, + "123456789": {resource: "123456789", mode: "request"}, + "bla,token:foobar": {resource: "bla", token: "foobar", mode: "request"}, + "bla,token:foo,bar": {resource: "bla", token: "foo,bar", mode: "request"}, + "123456789,mode:publish,token:foobar": {resource: "123456789", token: "foobar", mode: "publish"}, + "mode:publish": {resource: "mode:publish", mode: "request"}, + } + + for streamid, wantsi := range streamids { + si, err := parseStreamId(streamid) + + require.NoError(t, err) + require.Equal(t, wantsi, si) + } +} + +func TestParseOldStreamId(t *testing.T) { + streamids := map[string]streamInfo{ "#!:": {}, "#!:key=value": {}, "#!:m=publish": {mode: "publish"}, @@ -19,7 +37,7 @@ func TestParseStreamId(t *testing.T) { } for streamid, wantsi := range streamids { - si, _ := parseStreamId(streamid) + si, _ := parseOldStreamId(streamid) require.Equal(t, wantsi, si) } From 4334105f95bae365c06348bf5c3389a8bac32155 Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Fri, 28 Oct 2022 11:10:16 +0200 Subject: [PATCH 10/22] Fix wrong status code (#6) --- http/middleware/cache/cache.go | 25 ++----- http/middleware/cache/cache_test.go | 100 ++++++++++++++++++++++++++++ 2 files changed, 107 insertions(+), 18 deletions(-) create mode 100644 http/middleware/cache/cache_test.go diff --git a/http/middleware/cache/cache.go b/http/middleware/cache/cache.go index 25344e19..a32e35e7 100644 --- a/http/middleware/cache/cache.go +++ b/http/middleware/cache/cache.go @@ -57,31 +57,18 @@ func NewWithConfig(config Config) echo.MiddlewareFunc { if req.Method != "GET" { res.Header().Set("X-Cache", "SKIP ONLYGET") - - if err := next(c); err != nil { - c.Error(err) - } - - return nil + return next(c) } - res.Header().Set("Cache-Control", fmt.Sprintf("max-age=%.0f", config.Cache.TTL().Seconds())) - key := strings.TrimPrefix(req.URL.Path, config.Prefix) if !config.Cache.IsExtensionCacheable(path.Ext(req.URL.Path)) { res.Header().Set("X-Cache", "SKIP EXT") - - if err := next(c); err != nil { - c.Error(err) - } - - return nil + return next(c) } if obj, expireIn, _ := config.Cache.Get(key); obj == nil { // cache miss - writer := res.Writer w := &cacheWriter{ @@ -105,6 +92,7 @@ func NewWithConfig(config Config) echo.MiddlewareFunc { if res.Status != 200 { res.Header().Set("X-Cache", "SKIP NOTOK") + res.Writer.WriteHeader(res.Status) return nil } @@ -112,6 +100,7 @@ func NewWithConfig(config Config) echo.MiddlewareFunc { if !config.Cache.IsSizeCacheable(size) { res.Header().Set("X-Cache", "SKIP TOOBIG") + res.Writer.WriteHeader(res.Status) return nil } @@ -123,11 +112,13 @@ func NewWithConfig(config Config) echo.MiddlewareFunc { if err := config.Cache.Put(key, o, size); err != nil { res.Header().Set("X-Cache", "SKIP TOOBIG") + res.Writer.WriteHeader(res.Status) return nil } res.Header().Set("Cache-Control", fmt.Sprintf("max-age=%.0f", expireIn.Seconds())) res.Header().Set("X-Cache", "MISS") + res.Writer.WriteHeader(res.Status) } else { // cache hit o := obj.(*cacheObject) @@ -190,7 +181,5 @@ func (w *cacheWriter) WriteHeader(code int) { } func (w *cacheWriter) Write(body []byte) (int, error) { - n, err := w.body.Write(body) - - return n, err + return w.body.Write(body) } diff --git a/http/middleware/cache/cache_test.go b/http/middleware/cache/cache_test.go new file mode 100644 index 00000000..7748a970 --- /dev/null +++ b/http/middleware/cache/cache_test.go @@ -0,0 +1,100 @@ +package cache + +import ( + "net/http" + "net/http/httptest" + "testing" + "time" + + "github.com/datarhei/core/v16/http/cache" + + "github.com/labstack/echo/v4" + "github.com/stretchr/testify/require" +) + +func TestCache(t *testing.T) { + c, err := cache.NewLRUCache(cache.LRUConfig{ + TTL: 300 * time.Second, + MaxSize: 0, + MaxFileSize: 16, + AllowExtensions: []string{".js"}, + BlockExtensions: []string{".ts"}, + Logger: nil, + }) + + require.NoError(t, err) + + e := echo.New() + req := httptest.NewRequest(http.MethodGet, "/found.js", nil) + rec := httptest.NewRecorder() + ctx := e.NewContext(req, rec) + + handler := NewWithConfig(Config{ + Cache: c, + })(func(c echo.Context) error { + if c.Request().URL.Path == "/found.js" { + c.Response().Write([]byte("test")) + } else if c.Request().URL.Path == "/toobig.js" { + c.Response().Write([]byte("testtesttesttesttest")) + } else if c.Request().URL.Path == "/blocked.ts" { + c.Response().Write([]byte("blocked")) + } + + c.Response().WriteHeader(http.StatusNotFound) + return nil + }) + + handler(ctx) + + require.Equal(t, "test", rec.Body.String()) + require.Equal(t, 200, rec.Result().StatusCode) + require.Equal(t, "MISS", rec.Result().Header.Get("x-cache")) + + rec = httptest.NewRecorder() + ctx = e.NewContext(req, rec) + + handler(ctx) + + require.Equal(t, "test", rec.Body.String()) + require.Equal(t, 200, rec.Result().StatusCode) + require.Equal(t, "HIT", rec.Result().Header.Get("x-cache")[:3]) + + req = httptest.NewRequest(http.MethodGet, "/notfound.js", nil) + rec = httptest.NewRecorder() + ctx = e.NewContext(req, rec) + + handler(ctx) + + require.Equal(t, 404, rec.Result().StatusCode) + require.Equal(t, "SKIP NOTOK", rec.Result().Header.Get("x-cache")) + + req = httptest.NewRequest(http.MethodGet, "/toobig.js", nil) + rec = httptest.NewRecorder() + ctx = e.NewContext(req, rec) + + handler(ctx) + + require.Equal(t, "testtesttesttesttest", rec.Body.String()) + require.Equal(t, 200, rec.Result().StatusCode) + require.Equal(t, "SKIP TOOBIG", rec.Result().Header.Get("x-cache")) + + req = httptest.NewRequest(http.MethodGet, "/blocked.ts", nil) + rec = httptest.NewRecorder() + ctx = e.NewContext(req, rec) + + handler(ctx) + + require.Equal(t, "blocked", rec.Body.String()) + require.Equal(t, 200, rec.Result().StatusCode) + require.Equal(t, "SKIP EXT", rec.Result().Header.Get("x-cache")) + + req = httptest.NewRequest(http.MethodPost, "/found.js", nil) + rec = httptest.NewRecorder() + ctx = e.NewContext(req, rec) + + handler(ctx) + + require.Equal(t, "test", rec.Body.String()) + require.Equal(t, 200, rec.Result().StatusCode) + require.Equal(t, "SKIP ONLYGET", rec.Result().Header.Get("x-cache")) +} From 4cc82dd333ad5dbd8f07c0574ef8f596b98e19bd Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Fri, 28 Oct 2022 17:24:57 +0200 Subject: [PATCH 11/22] Update dependencies --- app/api/api.go | 14 - docs/docs.go | 4 +- docs/swagger.json | 4 +- docs/swagger.yaml | 4 +- go.mod | 54 +- go.sum | 111 +- http/api/srt.go | 100 +- srt/srt.go | 18 +- .../github.com/99designs/gqlgen/CHANGELOG.md | 130 +- vendor/github.com/99designs/gqlgen/README.md | 10 + .../99designs/gqlgen/codegen/config/config.go | 1 + .../gqlgen/graphql/context_operation.go | 2 + .../99designs/gqlgen/graphql/errcode/codes.go | 12 +- .../gqlgen/graphql/executable_schema.go | 5 + .../gqlgen/graphql/executor/executor.go | 41 +- .../99designs/gqlgen/graphql/handler.go | 16 +- .../gqlgen/graphql/playground/playground.go | 9 +- .../99designs/gqlgen/graphql/version.go | 2 +- .../gqlgen/plugin/federation/federation.go | 4 +- .../gqlgen/plugin/modelgen/models.go | 10 +- .../caddyserver/certmagic/README.md | 36 + .../caddyserver/certmagic/acmeclient.go | 28 +- .../caddyserver/certmagic/acmeissuer.go | 40 +- .../github.com/caddyserver/certmagic/async.go | 31 +- .../github.com/caddyserver/certmagic/cache.go | 75 +- .../caddyserver/certmagic/certificates.go | 27 +- .../caddyserver/certmagic/certmagic.go | 16 +- .../caddyserver/certmagic/config.go | 254 +- .../caddyserver/certmagic/crypto.go | 14 +- .../caddyserver/certmagic/dnsutil.go | 2 +- .../caddyserver/certmagic/filestorage.go | 26 +- .../caddyserver/certmagic/handshake.go | 335 ++- .../caddyserver/certmagic/httphandler.go | 20 +- .../caddyserver/certmagic/maintain.go | 169 +- .../github.com/caddyserver/certmagic/ocsp.go | 4 +- .../caddyserver/certmagic/solvers.go | 30 +- .../caddyserver/certmagic/storage.go | 65 +- vendor/github.com/datarhei/gosrt/Makefile | 2 +- .../github.com/datarhei/gosrt/connection.go | 197 +- vendor/github.com/datarhei/gosrt/dial.go | 20 +- .../gosrt/internal/congestion/congestion.go | 66 +- .../gosrt/internal/congestion/live.go | 305 ++- .../datarhei/gosrt/internal/packet/packet.go | 3 +- vendor/github.com/datarhei/gosrt/listen.go | 20 +- .../github.com/datarhei/gosrt/statistics.go | 150 +- .../go-playground/validator/v10/README.md | 2 +- .../go-playground/validator/v10/baked_in.go | 11 +- .../github.com/klauspost/cpuid/v2/README.md | 121 + vendor/github.com/klauspost/cpuid/v2/cpuid.go | 251 +- .../klauspost/cpuid/v2/detect_x86.go | 2 +- .../klauspost/cpuid/v2/featureid_string.go | 260 +- .../klauspost/cpuid/v2/os_darwin_arm64.go | 112 +- .../github.com/labstack/echo/v4/CHANGELOG.md | 14 + vendor/github.com/labstack/echo/v4/README.md | 5 +- vendor/github.com/labstack/echo/v4/context.go | 2 +- .../labstack/echo/v4/middleware/cors.go | 88 +- .../github.com/labstack/gommon/bytes/bytes.go | 173 +- vendor/github.com/labstack/gommon/log/log.go | 6 +- vendor/github.com/miekg/dns/client.go | 6 +- vendor/github.com/miekg/dns/defaults.go | 5 + vendor/github.com/miekg/dns/dnssec.go | 48 +- vendor/github.com/miekg/dns/edns.go | 16 +- vendor/github.com/miekg/dns/hash.go | 31 + vendor/github.com/miekg/dns/msg.go | 5 + vendor/github.com/miekg/dns/msg_helpers.go | 20 +- vendor/github.com/miekg/dns/server.go | 4 +- vendor/github.com/miekg/dns/sig0.go | 53 +- vendor/github.com/miekg/dns/svcb.go | 330 ++- vendor/github.com/miekg/dns/tsig.go | 26 +- vendor/github.com/miekg/dns/version.go | 2 +- vendor/github.com/miekg/dns/xfr.go | 4 +- .../prometheus/client_model/go/metrics.pb.go | 333 ++- .../shirou/gopsutil/v3/disk/disk_aix_nocgo.go | 70 +- .../shirou/gopsutil/v3/disk/disk_unix.go | 23 +- .../gopsutil/v3/internal/common/common.go | 4 +- .../v3/internal/common/common_linux.go | 3 + .../shirou/gopsutil/v3/net/net_linux.go | 2 +- .../gopsutil/v3/process/process_windows.go | 2 +- .../github.com/swaggo/echo-swagger/swagger.go | 10 + vendor/github.com/swaggo/swag/README.md | 5 +- vendor/github.com/swaggo/swag/README_zh-CN.md | 5 +- vendor/github.com/swaggo/swag/formatter.go | 98 +- vendor/github.com/swaggo/swag/generics.go | 259 +- .../github.com/swaggo/swag/generics_other.go | 29 +- vendor/github.com/swaggo/swag/operation.go | 37 +- vendor/github.com/swaggo/swag/packages.go | 42 +- vendor/github.com/swaggo/swag/parser.go | 23 +- vendor/github.com/swaggo/swag/version.go | 2 +- .../valyala/fasttemplate/template.go | 3 +- .../vektah/gqlparser/v2/parser/query.go | 1 - vendor/go.uber.org/atomic/.gitignore | 3 + vendor/go.uber.org/atomic/.travis.yml | 27 - vendor/go.uber.org/atomic/CHANGELOG.md | 61 +- vendor/go.uber.org/atomic/Makefile | 1 + vendor/go.uber.org/atomic/README.md | 4 +- vendor/go.uber.org/atomic/bool.go | 27 +- vendor/go.uber.org/atomic/bool_ext.go | 2 +- vendor/go.uber.org/atomic/duration.go | 27 +- vendor/go.uber.org/atomic/duration_ext.go | 8 +- vendor/go.uber.org/atomic/error.go | 23 +- vendor/go.uber.org/atomic/error_ext.go | 4 +- vendor/go.uber.org/atomic/float32.go | 77 + vendor/go.uber.org/atomic/float32_ext.go | 76 + vendor/go.uber.org/atomic/float64.go | 19 +- vendor/go.uber.org/atomic/float64_ext.go | 43 +- vendor/go.uber.org/atomic/gen.go | 1 + vendor/go.uber.org/atomic/int32.go | 31 +- vendor/go.uber.org/atomic/int64.go | 31 +- vendor/go.uber.org/atomic/nocmp.go | 12 +- vendor/go.uber.org/atomic/pointer_go118.go | 60 + vendor/go.uber.org/atomic/pointer_go119.go | 61 + vendor/go.uber.org/atomic/string.go | 23 +- vendor/go.uber.org/atomic/string_ext.go | 4 +- vendor/go.uber.org/atomic/time.go | 55 + vendor/go.uber.org/atomic/time_ext.go | 36 + vendor/go.uber.org/atomic/uint32.go | 31 +- vendor/go.uber.org/atomic/uint64.go | 31 +- vendor/go.uber.org/atomic/uintptr.go | 109 + vendor/go.uber.org/atomic/unsafe_pointer.go | 65 + vendor/go.uber.org/atomic/value.go | 4 +- vendor/go.uber.org/multierr/.travis.yml | 23 - vendor/go.uber.org/multierr/CHANGELOG.md | 12 + vendor/go.uber.org/multierr/LICENSE.txt | 2 +- vendor/go.uber.org/multierr/Makefile | 6 +- vendor/go.uber.org/multierr/README.md | 8 +- vendor/go.uber.org/multierr/error.go | 225 +- vendor/go.uber.org/zap/CHANGELOG.md | 40 + vendor/go.uber.org/zap/CONTRIBUTING.md | 21 +- vendor/go.uber.org/zap/README.md | 59 +- vendor/go.uber.org/zap/array_go118.go | 156 ++ vendor/go.uber.org/zap/config.go | 4 +- vendor/go.uber.org/zap/doc.go | 60 +- vendor/go.uber.org/zap/encoder.go | 2 +- vendor/go.uber.org/zap/http_handler.go | 25 +- vendor/go.uber.org/zap/internal/exit/exit.go | 22 +- .../internal/level_enabler.go} | 39 +- vendor/go.uber.org/zap/level.go | 3 + vendor/go.uber.org/zap/logger.go | 48 +- vendor/go.uber.org/zap/options.go | 20 +- vendor/go.uber.org/zap/sugar.go | 116 +- vendor/go.uber.org/zap/writer.go | 9 +- .../zap/zapcore/buffered_write_syncer.go | 31 + vendor/go.uber.org/zap/zapcore/core.go | 9 + vendor/go.uber.org/zap/zapcore/encoder.go | 9 +- vendor/go.uber.org/zap/zapcore/entry.go | 71 +- vendor/go.uber.org/zap/zapcore/error.go | 14 +- vendor/go.uber.org/zap/zapcore/hook.go | 9 + .../go.uber.org/zap/zapcore/increase_level.go | 9 + .../go.uber.org/zap/zapcore/json_encoder.go | 4 +- vendor/go.uber.org/zap/zapcore/level.go | 42 + vendor/go.uber.org/zap/zapcore/sampler.go | 25 +- vendor/go.uber.org/zap/zapcore/tee.go | 17 +- vendor/golang.org/x/crypto/acme/acme.go | 2 +- .../x/crypto/acme/autocert/autocert.go | 4 +- .../x/crypto/acme/autocert/cache.go | 5 +- vendor/golang.org/x/crypto/acme/http.go | 6 +- vendor/golang.org/x/crypto/acme/rfc8555.go | 5 +- vendor/golang.org/x/crypto/acme/types.go | 4 +- vendor/golang.org/x/mod/module/module.go | 4 +- .../golang.org/x/net/bpf/vm_instructions.go | 4 +- vendor/golang.org/x/net/http2/h2c/h2c.go | 11 + vendor/golang.org/x/net/http2/server.go | 50 +- vendor/golang.org/x/net/http2/transport.go | 69 +- .../x/net/internal/socket/mmsghdr_unix.go | 18 +- .../x/net/internal/socket/msghdr_linux.go | 3 - .../net/internal/socket/zsys_openbsd_ppc64.go | 30 + .../internal/socket/zsys_openbsd_riscv64.go | 30 + vendor/golang.org/x/net/webdav/file.go | 6 +- vendor/golang.org/x/net/webdav/prop.go | 10 +- vendor/golang.org/x/net/webdav/webdav.go | 35 +- vendor/golang.org/x/net/webdav/xml.go | 2 +- .../golang.org/x/sys/cpu/cpu_other_ppc64x.go | 15 + vendor/golang.org/x/sys/unix/asm_bsd_ppc64.s | 31 + vendor/golang.org/x/sys/unix/dirent.go | 4 +- vendor/golang.org/x/sys/unix/mkall.sh | 23 +- vendor/golang.org/x/sys/unix/mkerrors.sh | 4 +- vendor/golang.org/x/sys/unix/syscall.go | 10 +- .../x/sys/unix/syscall_darwin.1_12.go | 32 - .../x/sys/unix/syscall_darwin.1_13.go | 108 - .../golang.org/x/sys/unix/syscall_darwin.go | 90 + .../golang.org/x/sys/unix/syscall_illumos.go | 106 - vendor/golang.org/x/sys/unix/syscall_linux.go | 13 +- .../x/sys/unix/syscall_openbsd_libc.go | 4 +- .../x/sys/unix/syscall_openbsd_ppc64.go | 42 + .../x/sys/unix/syscall_openbsd_riscv64.go | 42 + .../golang.org/x/sys/unix/syscall_solaris.go | 217 +- vendor/golang.org/x/sys/unix/syscall_unix.go | 20 +- .../golang.org/x/sys/unix/syscall_unix_gc.go | 6 +- .../x/sys/unix/syscall_zos_s390x.go | 173 +- vendor/golang.org/x/sys/unix/sysvshm_unix.go | 13 +- vendor/golang.org/x/sys/unix/xattr_bsd.go | 95 +- .../x/sys/unix/zerrors_openbsd_ppc64.go | 1905 ++++++++++++++ .../x/sys/unix/zerrors_openbsd_riscv64.go | 1904 ++++++++++++++ .../x/sys/unix/zsyscall_darwin_amd64.1_13.go | 40 - .../x/sys/unix/zsyscall_darwin_amd64.1_13.s | 25 - .../x/sys/unix/zsyscall_darwin_amd64.go | 32 +- .../x/sys/unix/zsyscall_darwin_amd64.s | 21 +- .../x/sys/unix/zsyscall_darwin_arm64.1_13.go | 40 - .../x/sys/unix/zsyscall_darwin_arm64.1_13.s | 25 - .../x/sys/unix/zsyscall_darwin_arm64.go | 32 +- .../x/sys/unix/zsyscall_darwin_arm64.s | 21 +- .../x/sys/unix/zsyscall_illumos_amd64.go | 28 +- .../golang.org/x/sys/unix/zsyscall_linux.go | 10 + .../x/sys/unix/zsyscall_openbsd_ppc64.go | 2221 +++++++++++++++++ .../x/sys/unix/zsyscall_openbsd_ppc64.s | 796 ++++++ .../x/sys/unix/zsyscall_openbsd_riscv64.go | 2221 +++++++++++++++++ .../x/sys/unix/zsyscall_openbsd_riscv64.s | 796 ++++++ .../x/sys/unix/zsyscall_solaris_amd64.go | 28 +- .../x/sys/unix/zsysctl_openbsd_ppc64.go | 281 +++ .../x/sys/unix/zsysctl_openbsd_riscv64.go | 282 +++ .../x/sys/unix/zsysnum_openbsd_ppc64.go | 218 ++ .../x/sys/unix/zsysnum_openbsd_riscv64.go | 219 ++ .../x/sys/unix/ztypes_illumos_amd64.go | 42 - .../golang.org/x/sys/unix/ztypes_linux_386.go | 6 + .../x/sys/unix/ztypes_linux_amd64.go | 6 + .../golang.org/x/sys/unix/ztypes_linux_arm.go | 6 + .../x/sys/unix/ztypes_linux_arm64.go | 6 + .../x/sys/unix/ztypes_linux_loong64.go | 6 + .../x/sys/unix/ztypes_linux_mips.go | 6 + .../x/sys/unix/ztypes_linux_mips64.go | 6 + .../x/sys/unix/ztypes_linux_mips64le.go | 6 + .../x/sys/unix/ztypes_linux_mipsle.go | 6 + .../golang.org/x/sys/unix/ztypes_linux_ppc.go | 6 + .../x/sys/unix/ztypes_linux_ppc64.go | 6 + .../x/sys/unix/ztypes_linux_ppc64le.go | 6 + .../x/sys/unix/ztypes_linux_riscv64.go | 6 + .../x/sys/unix/ztypes_linux_s390x.go | 6 + .../x/sys/unix/ztypes_linux_sparc64.go | 6 + .../x/sys/unix/ztypes_openbsd_ppc64.go | 571 +++++ .../x/sys/unix/ztypes_openbsd_riscv64.go | 571 +++++ .../x/sys/unix/ztypes_solaris_amd64.go | 35 + .../golang.org/x/sys/unix/ztypes_zos_s390x.go | 11 +- vendor/golang.org/x/sys/windows/syscall.go | 10 +- .../x/sys/windows/syscall_windows.go | 35 +- .../golang.org/x/sys/windows/types_windows.go | 45 + .../x/sys/windows/zsyscall_windows.go | 88 + vendor/golang.org/x/text/AUTHORS | 3 - vendor/golang.org/x/text/CONTRIBUTORS | 3 - vendor/golang.org/x/text/cases/trieval.go | 73 +- .../text/internal/language/compact/tables.go | 6 +- .../x/text/internal/language/lookup.go | 4 +- .../x/text/internal/language/parse.go | 24 +- .../x/text/internal/language/tables.go | 868 +++---- vendor/golang.org/x/text/language/doc.go | 44 +- vendor/golang.org/x/text/language/go1_1.go | 39 - vendor/golang.org/x/text/language/go1_2.go | 12 - vendor/golang.org/x/text/language/match.go | 2 +- vendor/golang.org/x/text/language/parse.go | 8 +- vendor/golang.org/x/text/language/tables.go | 18 +- vendor/golang.org/x/text/unicode/bidi/core.go | 26 +- .../x/text/unicode/norm/forminfo.go | 9 +- .../x/text/unicode/norm/normalize.go | 11 +- .../x/text/unicode/norm/tables13.0.0.go | 4 +- vendor/golang.org/x/time/rate/rate.go | 83 +- .../golang.org/x/tools/go/buildutil/util.go | 2 +- .../x/tools/go/gcexportdata/gcexportdata.go | 6 +- .../x/tools/go/internal/gcimporter/iimport.go | 4 +- .../go/internal/gcimporter/ureader_yes.go | 93 +- .../x/tools/go/internal/pkgbits/decoder.go | 5 +- .../x/tools/go/internal/pkgbits/encoder.go | 18 +- .../x/tools/go/internal/pkgbits/reloc.go | 4 +- .../golang.org/x/tools/go/packages/golist.go | 9 +- .../x/tools/go/packages/packages.go | 42 +- .../internal/fastwalk/fastwalk_darwin.go | 119 + .../internal/fastwalk/fastwalk_dirent_ino.go | 6 +- .../fastwalk/fastwalk_dirent_namlen_bsd.go | 4 +- .../tools/internal/fastwalk/fastwalk_unix.go | 4 +- .../x/tools/internal/gocommand/invoke.go | 83 +- .../x/tools/internal/gocommand/version.go | 13 +- .../x/tools/internal/imports/fix.go | 9 +- .../x/tools/internal/imports/mod.go | 22 +- .../x/tools/internal/imports/zstdlib.go | 418 ++-- vendor/modules.txt | 65 +- 273 files changed, 19678 insertions(+), 3604 deletions(-) create mode 100644 vendor/github.com/miekg/dns/hash.go delete mode 100644 vendor/go.uber.org/atomic/.travis.yml create mode 100644 vendor/go.uber.org/atomic/float32.go create mode 100644 vendor/go.uber.org/atomic/float32_ext.go create mode 100644 vendor/go.uber.org/atomic/pointer_go118.go create mode 100644 vendor/go.uber.org/atomic/pointer_go119.go create mode 100644 vendor/go.uber.org/atomic/time.go create mode 100644 vendor/go.uber.org/atomic/time_ext.go create mode 100644 vendor/go.uber.org/atomic/uintptr.go create mode 100644 vendor/go.uber.org/atomic/unsafe_pointer.go delete mode 100644 vendor/go.uber.org/multierr/.travis.yml create mode 100644 vendor/go.uber.org/zap/array_go118.go rename vendor/go.uber.org/{multierr/go113.go => zap/internal/level_enabler.go} (58%) create mode 100644 vendor/golang.org/x/net/internal/socket/zsys_openbsd_ppc64.go create mode 100644 vendor/golang.org/x/net/internal/socket/zsys_openbsd_riscv64.go create mode 100644 vendor/golang.org/x/sys/cpu/cpu_other_ppc64x.go create mode 100644 vendor/golang.org/x/sys/unix/asm_bsd_ppc64.s delete mode 100644 vendor/golang.org/x/sys/unix/syscall_darwin.1_12.go delete mode 100644 vendor/golang.org/x/sys/unix/syscall_darwin.1_13.go create mode 100644 vendor/golang.org/x/sys/unix/syscall_openbsd_ppc64.go create mode 100644 vendor/golang.org/x/sys/unix/syscall_openbsd_riscv64.go create mode 100644 vendor/golang.org/x/sys/unix/zerrors_openbsd_ppc64.go create mode 100644 vendor/golang.org/x/sys/unix/zerrors_openbsd_riscv64.go delete mode 100644 vendor/golang.org/x/sys/unix/zsyscall_darwin_amd64.1_13.go delete mode 100644 vendor/golang.org/x/sys/unix/zsyscall_darwin_amd64.1_13.s delete mode 100644 vendor/golang.org/x/sys/unix/zsyscall_darwin_arm64.1_13.go delete mode 100644 vendor/golang.org/x/sys/unix/zsyscall_darwin_arm64.1_13.s create mode 100644 vendor/golang.org/x/sys/unix/zsyscall_openbsd_ppc64.go create mode 100644 vendor/golang.org/x/sys/unix/zsyscall_openbsd_ppc64.s create mode 100644 vendor/golang.org/x/sys/unix/zsyscall_openbsd_riscv64.go create mode 100644 vendor/golang.org/x/sys/unix/zsyscall_openbsd_riscv64.s create mode 100644 vendor/golang.org/x/sys/unix/zsysctl_openbsd_ppc64.go create mode 100644 vendor/golang.org/x/sys/unix/zsysctl_openbsd_riscv64.go create mode 100644 vendor/golang.org/x/sys/unix/zsysnum_openbsd_ppc64.go create mode 100644 vendor/golang.org/x/sys/unix/zsysnum_openbsd_riscv64.go delete mode 100644 vendor/golang.org/x/sys/unix/ztypes_illumos_amd64.go create mode 100644 vendor/golang.org/x/sys/unix/ztypes_openbsd_ppc64.go create mode 100644 vendor/golang.org/x/sys/unix/ztypes_openbsd_riscv64.go delete mode 100644 vendor/golang.org/x/text/AUTHORS delete mode 100644 vendor/golang.org/x/text/CONTRIBUTORS delete mode 100644 vendor/golang.org/x/text/language/go1_1.go delete mode 100644 vendor/golang.org/x/text/language/go1_2.go create mode 100644 vendor/golang.org/x/tools/internal/fastwalk/fastwalk_darwin.go diff --git a/app/api/api.go b/app/api/api.go index 873d7ec5..389ec375 100644 --- a/app/api/api.go +++ b/app/api/api.go @@ -669,20 +669,6 @@ func (a *api) start() error { } certmagic.Default.DefaultServerName = cfg.Host.Name[0] certmagic.Default.Logger = nil - certmagic.Default.OnEvent = func(event string, data interface{}) { - message := "" - - switch data := data.(type) { - case string: - message = data - case fmt.Stringer: - message = data.String() - } - - if len(message) != 0 { - a.log.logger.core.WithComponent("certmagic").Info().WithField("event", event).Log(message) - } - } magic := certmagic.NewDefault() acme := certmagic.NewACMEIssuer(magic, certmagic.DefaultACME) diff --git a/docs/docs.go b/docs/docs.go index 21d3bae5..0d0740fd 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -3837,7 +3837,7 @@ const docTemplate = `{ "description": "The total number of received KM (Key Material) control packets", "type": "integer" }, - "recv_loss__bytes": { + "recv_loss_bytes": { "description": "Same as pktRcvLoss, but expressed in bytes, including payload and all the headers (IP, TCP, SRT), bytes for the presently missing (either reordered or lost) packets' payloads are estimated based on the average packet size", "type": "integer" }, @@ -3945,7 +3945,7 @@ const docTemplate = `{ "description": "The total number of retransmitted packets sent by the SRT sender", "type": "integer" }, - "sent_unique__bytes": { + "sent_unique_bytes": { "description": "Same as pktSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)", "type": "integer" }, diff --git a/docs/swagger.json b/docs/swagger.json index 4c5a2c2b..ae470126 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -3829,7 +3829,7 @@ "description": "The total number of received KM (Key Material) control packets", "type": "integer" }, - "recv_loss__bytes": { + "recv_loss_bytes": { "description": "Same as pktRcvLoss, but expressed in bytes, including payload and all the headers (IP, TCP, SRT), bytes for the presently missing (either reordered or lost) packets' payloads are estimated based on the average packet size", "type": "integer" }, @@ -3937,7 +3937,7 @@ "description": "The total number of retransmitted packets sent by the SRT sender", "type": "integer" }, - "sent_unique__bytes": { + "sent_unique_bytes": { "description": "Same as pktSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)", "type": "integer" }, diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 7e30e514..a11c50c6 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -979,7 +979,7 @@ definitions: recv_km_pkt: description: The total number of received KM (Key Material) control packets type: integer - recv_loss__bytes: + recv_loss_bytes: description: Same as pktRcvLoss, but expressed in bytes, including payload and all the headers (IP, TCP, SRT), bytes for the presently missing (either reordered or lost) packets' payloads are estimated based on the average @@ -1088,7 +1088,7 @@ definitions: sent_retrans_pkt: description: The total number of retransmitted packets sent by the SRT sender type: integer - sent_unique__bytes: + sent_unique_bytes: description: Same as pktSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) type: integer diff --git a/go.mod b/go.mod index 8cf951bf..622af0e1 100644 --- a/go.mod +++ b/go.mod @@ -3,29 +3,29 @@ module github.com/datarhei/core/v16 go 1.18 require ( - github.com/99designs/gqlgen v0.17.16 + github.com/99designs/gqlgen v0.17.20 github.com/atrox/haikunatorgo/v2 v2.0.1 - github.com/caddyserver/certmagic v0.16.2 - github.com/datarhei/gosrt v0.2.1-0.20220817080252-d44df04a3845 + github.com/caddyserver/certmagic v0.17.2 + github.com/datarhei/gosrt v0.3.1 github.com/datarhei/joy4 v0.0.0-20220914170649-23c70d207759 - github.com/go-playground/validator/v10 v10.11.0 + github.com/go-playground/validator/v10 v10.11.1 github.com/gobwas/glob v0.2.3 github.com/golang-jwt/jwt/v4 v4.4.2 github.com/google/uuid v1.3.0 github.com/invopop/jsonschema v0.4.0 github.com/joho/godotenv v1.4.0 - github.com/labstack/echo/v4 v4.9.0 + github.com/labstack/echo/v4 v4.9.1 github.com/lithammer/shortuuid/v4 v4.0.0 github.com/mattn/go-isatty v0.0.16 github.com/prep/average v0.0.0-20200506183628-d26c465f48c3 github.com/prometheus/client_golang v1.13.0 - github.com/shirou/gopsutil/v3 v3.22.8 - github.com/stretchr/testify v1.8.0 - github.com/swaggo/echo-swagger v1.3.4 - github.com/swaggo/swag v1.8.5 - github.com/vektah/gqlparser/v2 v2.5.0 + github.com/shirou/gopsutil/v3 v3.22.9 + github.com/stretchr/testify v1.8.1 + github.com/swaggo/echo-swagger v1.3.5 + github.com/swaggo/swag v1.8.7 + github.com/vektah/gqlparser/v2 v2.5.1 github.com/xeipuuv/gojsonschema v1.2.0 - golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 + golang.org/x/mod v0.6.0 ) require ( @@ -49,20 +49,20 @@ require ( github.com/hashicorp/golang-lru v0.5.4 // indirect github.com/iancoleman/orderedmap v0.2.0 // indirect github.com/josharian/intern v1.0.0 // indirect - github.com/klauspost/cpuid/v2 v2.0.11 // indirect - github.com/labstack/gommon v0.3.1 // indirect + github.com/klauspost/cpuid/v2 v2.1.2 // indirect + github.com/labstack/gommon v0.4.0 // indirect github.com/leodido/go-urn v1.2.1 // indirect github.com/libdns/libdns v0.2.1 // indirect - github.com/lufia/plan9stats v0.0.0-20220517141722-cf486979b281 // indirect + github.com/lufia/plan9stats v0.0.0-20220913051719-115f729f3c8c // indirect github.com/mailru/easyjson v0.7.7 // indirect github.com/mattn/go-colorable v0.1.13 // indirect - github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect + github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect github.com/mholt/acmez v1.0.4 // indirect - github.com/miekg/dns v1.1.46 // indirect + github.com/miekg/dns v1.1.50 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/power-devops/perfstat v0.0.0-20220216144756-c35f1ee13d7c // indirect - github.com/prometheus/client_model v0.2.0 // indirect + github.com/prometheus/client_model v0.3.0 // indirect github.com/prometheus/common v0.37.0 // indirect github.com/prometheus/procfs v0.8.0 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect @@ -71,20 +71,20 @@ require ( github.com/tklauser/numcpus v0.5.0 // indirect github.com/urfave/cli/v2 v2.8.1 // indirect github.com/valyala/bytebufferpool v1.0.0 // indirect - github.com/valyala/fasttemplate v1.2.1 // indirect + github.com/valyala/fasttemplate v1.2.2 // indirect github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect github.com/yusufpapurcu/wmi v1.2.2 // indirect - go.uber.org/atomic v1.7.0 // indirect - go.uber.org/multierr v1.6.0 // indirect - go.uber.org/zap v1.21.0 // indirect - golang.org/x/crypto v0.0.0-20220829220503-c86fa9a7ed90 // indirect - golang.org/x/net v0.0.0-20220907135653-1e95f45603a7 // indirect - golang.org/x/sys v0.0.0-20220907062415-87db552b00fd // indirect - golang.org/x/text v0.3.7 // indirect - golang.org/x/time v0.0.0-20220722155302-e5dcc9cfc0b9 // indirect - golang.org/x/tools v0.1.12 // indirect + go.uber.org/atomic v1.10.0 // indirect + go.uber.org/multierr v1.8.0 // indirect + go.uber.org/zap v1.23.0 // indirect + golang.org/x/crypto v0.1.0 // indirect + golang.org/x/net v0.1.0 // indirect + golang.org/x/sys v0.1.0 // indirect + golang.org/x/text v0.4.0 // indirect + golang.org/x/time v0.1.0 // indirect + golang.org/x/tools v0.2.0 // indirect google.golang.org/protobuf v1.28.1 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index 3d3e6da4..fd6a88e6 100644 --- a/go.sum +++ b/go.sum @@ -31,8 +31,8 @@ cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohl cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs= cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0= dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= -github.com/99designs/gqlgen v0.17.16 h1:tTIw/cQ/uvf3iXIb2I6YSkdaDkmHmH2W2eZkVe0IVLA= -github.com/99designs/gqlgen v0.17.16/go.mod h1:dnJdUkgfh8iw8CEx2hhTdgTQO/GvVWKLcm/kult5gwI= +github.com/99designs/gqlgen v0.17.20 h1:O7WzccIhKB1dm+7g6dhQcULINftfiLSBg2l/mwbpJMw= +github.com/99designs/gqlgen v0.17.20/go.mod h1:Mja2HI23kWT1VRH09hvWshFgOzKswpO20o4ScpJIES4= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/BurntSushi/toml v1.1.0/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= @@ -63,8 +63,8 @@ github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= -github.com/caddyserver/certmagic v0.16.2 h1:k2n3LkkUG3aMUK/kckMuF9/0VFo+0FtMX3drPYESbmQ= -github.com/caddyserver/certmagic v0.16.2/go.mod h1:PgLIr/dSJa+WA7t7z6Je5xuS/e5A/GFCPHRuZ1QP+MQ= +github.com/caddyserver/certmagic v0.17.2 h1:o30seC1T/dBqBCNNGNHWwj2i5/I/FMjBbTAhjADP3nE= +github.com/caddyserver/certmagic v0.17.2/go.mod h1:ouWUuC490GOLJzkyN35eXfV8bSbwMwSf4bdhkIxtdQE= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= github.com/cespare/xxhash/v2 v2.1.2 h1:YRXhKfTDauu4ajMg1TPgFO5jnlC2HCbmLXMcTG5cbYE= @@ -78,8 +78,8 @@ github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:ma github.com/cpuguy83/go-md2man/v2 v2.0.1 h1:r/myEWzV9lfsM1tFLgDyu0atFtJ1fXn261LKYj/3DxU= github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= -github.com/datarhei/gosrt v0.2.1-0.20220817080252-d44df04a3845 h1:nlVb4EVMwdVUwH6e10WZrx4lW0n2utnlE+4ILMPyD5o= -github.com/datarhei/gosrt v0.2.1-0.20220817080252-d44df04a3845/go.mod h1:wyoTu+DG45XRuCgEq/y+R8nhZCrJbOyQKn+SwNrNVZ8= +github.com/datarhei/gosrt v0.3.1 h1:9A75hIvnY74IUFyeguqYXh1lsGF8Qt8fjxJS2Ewr12Q= +github.com/datarhei/gosrt v0.3.1/go.mod h1:M2nl2WPrawncUc1FtUBK6gZX4tpZRC7FqL8NjOdBZV0= github.com/datarhei/joy4 v0.0.0-20220914170649-23c70d207759 h1:h8NyekuQSDvLIsZVTV172m5/RVArXkEM/cnHaUzszQU= github.com/datarhei/joy4 v0.0.0-20220914170649-23c70d207759/go.mod h1:Jcw/6jZDQQmPx8A7INEkXmuEF7E9jjBbSTfVSLwmiQw= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= @@ -124,8 +124,8 @@ github.com/go-playground/locales v0.14.0 h1:u50s323jtVGugKlcYeyzC0etD1HifMjqmJqb github.com/go-playground/locales v0.14.0/go.mod h1:sawfccIbzZTqEDETgFXqTho0QybSa7l++s0DH+LDiLs= github.com/go-playground/universal-translator v0.18.0 h1:82dyy6p4OuJq4/CByFNOn/jYrnRPArHwAcmLoJZxyho= github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA= -github.com/go-playground/validator/v10 v10.11.0 h1:0W+xRM511GY47Yy3bZUbJVitCNg2BOGlCyvTqsp/xIw= -github.com/go-playground/validator/v10 v10.11.0/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4dMGDBiPU55YFDl0WbKdWU= +github.com/go-playground/validator/v10 v10.11.1 h1:prmOlTVv+YjZjmRmNSF3VmspqJIxJWXmqUsHwfTRRkQ= +github.com/go-playground/validator/v10 v10.11.1/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4dMGDBiPU55YFDl0WbKdWU= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y= github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8= @@ -174,8 +174,8 @@ github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg= -github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38= +github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0= @@ -220,8 +220,8 @@ github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7V github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM= github.com/kevinmbeaulieu/eq-go v1.0.0/go.mod h1:G3S8ajA56gKBZm4UB9AOyoOS37JO3roToPzKNM8dtdM= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= -github.com/klauspost/cpuid/v2 v2.0.11 h1:i2lw1Pm7Yi/4O6XCSyJWqEHI2MDw2FzUK6o/D21xn2A= -github.com/klauspost/cpuid/v2 v2.0.11/go.mod h1:g2LTdtYhdyuGPqyWyv7qRAmj1WBqxuObKfj5c0PQa7c= +github.com/klauspost/cpuid/v2 v2.1.2 h1:XhdX4fqAJUA0yj+kUwMavO0hHrSPAecYdYf1ZmxHvak= +github.com/klauspost/cpuid/v2 v2.1.2/go.mod h1:RVVoqg1df56z8g3pUjL/3lE5UfnlrJX8tyFgg4nqhuY= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= @@ -233,11 +233,12 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= -github.com/labstack/echo/v4 v4.7.2/go.mod h1:xkCDAdFCIf8jsFQ5NnbK7oqaF/yU1A1X20Ltm0OvSks= -github.com/labstack/echo/v4 v4.9.0 h1:wPOF1CE6gvt/kmbMR4dGzWvHMPT+sAEUJOwOTtvITVY= github.com/labstack/echo/v4 v4.9.0/go.mod h1:xkCDAdFCIf8jsFQ5NnbK7oqaF/yU1A1X20Ltm0OvSks= -github.com/labstack/gommon v0.3.1 h1:OomWaJXm7xR6L1HmEtGyQf26TEn7V6X88mktX9kee9o= +github.com/labstack/echo/v4 v4.9.1 h1:GliPYSpzGKlyOhqIbG8nmHBo3i1saKWFOgh41AN3b+Y= +github.com/labstack/echo/v4 v4.9.1/go.mod h1:Pop5HLc+xoc4qhTZ1ip6C0RtP7Z+4VzRLWZZFKqbbjo= github.com/labstack/gommon v0.3.1/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM= +github.com/labstack/gommon v0.4.0 h1:y7cvthEAEbU0yHOf4axH8ZG2NH8knB9iNSoTO8dyIk8= +github.com/labstack/gommon v0.4.0/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM= github.com/leodido/go-urn v1.2.1 h1:BqpAaACuzVSgi/VLzGZIobT2z4v53pjosyNd9Yv6n/w= github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ictyFfxY= github.com/libdns/libdns v0.2.1 h1:Wu59T7wSHRgtA0cfxC+n1c/e+O3upJGWytknkmFEDis= @@ -246,8 +247,8 @@ github.com/lithammer/shortuuid/v4 v4.0.0 h1:QRbbVkfgNippHOS8PXDkti4NaWeyYfcBTHtw github.com/lithammer/shortuuid/v4 v4.0.0/go.mod h1:Zs8puNcrvf2rV9rTH51ZLLcj7ZXqQI3lv67aw4KiB1Y= github.com/logrusorgru/aurora/v3 v3.0.0/go.mod h1:vsR12bk5grlLvLXAYrBsb5Oc/N+LxAlxggSjiwMnCUc= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0/go.mod h1:zJYVVT2jmtg6P3p1VtQj7WsuWi/y4VnjVBn7F8KPB3I= -github.com/lufia/plan9stats v0.0.0-20220517141722-cf486979b281 h1:aczX6NMOtt6L4YT0fQvKkDK6LZEtdOso9sUH89V1+P0= -github.com/lufia/plan9stats v0.0.0-20220517141722-cf486979b281/go.mod h1:lc+czkgO/8F7puNki5jk8QyujbfK1LOT7Wl0ON2hxyk= +github.com/lufia/plan9stats v0.0.0-20220913051719-115f729f3c8c h1:VtwQ41oftZwlMnOEbMWQtSEUgU64U4s+GHk7hZK+jtY= +github.com/lufia/plan9stats v0.0.0-20220913051719-115f729f3c8c/go.mod h1:JKx41uQRwqlTZabZc+kILPrO/3jlKnQ2Z8b7YiVw5cE= github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= @@ -255,18 +256,18 @@ github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0 github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= github.com/matryer/moq v0.2.7/go.mod h1:kITsx543GOENm48TUAQyJ9+SAvFSr7iGQXPoth/VUBk= github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= -github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= -github.com/matttproud/golang_protobuf_extensions v1.0.1 h1:4hp9jkHxhMHkqkrB3Ix0jegS5sx/RkqARlsWZ6pIwiU= github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= +github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zkfA9PSy5pEvNWRP0ET0TIVo= +github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4= github.com/mholt/acmez v1.0.4 h1:N3cE4Pek+dSolbsofIkAYz6H1d3pE+2G0os7QHslf80= github.com/mholt/acmez v1.0.4/go.mod h1:qFGLZ4u+ehWINeJZjzPlsnjJBCPAADWTcIqE/7DAYQY= -github.com/miekg/dns v1.1.46 h1:uzwpxRtSVxtcIZmz/4Uz6/Rn7G11DvsaslXoy5LxQio= -github.com/miekg/dns v1.1.46/go.mod h1:e3IlAVfNqAllflbibAZEWOXOQ+Ynzk/dDozDxY7XnME= +github.com/miekg/dns v1.1.50 h1:DQUfb9uc6smULcREF09Uc+/Gd46YWqJd5DbpPE9xkcA= +github.com/miekg/dns v1.1.50/go.mod h1:e3IlAVfNqAllflbibAZEWOXOQ+Ynzk/dDozDxY7XnME= github.com/mitchellh/mapstructure v1.3.1/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= @@ -306,8 +307,9 @@ github.com/prometheus/client_golang v1.13.0/go.mod h1:vTeo+zgvILHsnnj/39Ou/1fPN5 github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= -github.com/prometheus/client_model v0.2.0 h1:uq5h0d+GuxiXLJLNABMgp2qUWDPiLvgCzz2dUR+/W/M= github.com/prometheus/client_model v0.2.0/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/client_model v0.3.0 h1:UBgGFHqYdG/TPFD1B1ogZywDqEkwp3fBMvqdiQ7Xew4= +github.com/prometheus/client_model v0.3.0/go.mod h1:LDGWKZIo7rky3hgvBe+caln+Dr3dPggB5dvjtD7w9+w= github.com/prometheus/common v0.4.1/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= github.com/prometheus/common v0.10.0/go.mod h1:Tlit/dnDKsSWFlCLTWaA1cyBgKHSMdTB80sz/V91rCo= github.com/prometheus/common v0.26.0/go.mod h1:M7rCNAaPfAosfx8veZJCuw84e35h3Cfd9VFqTh1DIvc= @@ -330,8 +332,8 @@ github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sergi/go-diff v1.1.0 h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0= github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= -github.com/shirou/gopsutil/v3 v3.22.8 h1:a4s3hXogo5mE2PfdfJIonDbstO/P+9JszdfhAHSzD9Y= -github.com/shirou/gopsutil/v3 v3.22.8/go.mod h1:s648gW4IywYzUfE/KjXxUsqrqx/T2xO5VqOXxONeRfI= +github.com/shirou/gopsutil/v3 v3.22.9 h1:yibtJhIVEMcdw+tCTbOPiF1VcsuDeTE4utJ8Dm4c5eA= +github.com/shirou/gopsutil/v3 v3.22.9/go.mod h1:bBYl1kjgEJpWpxeHmLI+dVHWtyAwfcmSBLDsp2TNT8A= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= @@ -341,6 +343,7 @@ github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.3.1-0.20190311161405-34c6fa2dc709/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= @@ -348,16 +351,16 @@ github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81P github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals= -github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/swaggo/echo-swagger v1.3.4 h1:8B+yVqjVm7cMy4QBLRUuRaOzrTVAqZahcrgrOSdpC5I= -github.com/swaggo/echo-swagger v1.3.4/go.mod h1:vh8QAdbHtTXwTSaWzc1Nby7zMYJd/g0FwQyArmrFHA8= +github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/swaggo/echo-swagger v1.3.5 h1:kCx1wvX5AKhjI6Ykt48l3PTsfL9UD40ZROOx/tYzWyY= +github.com/swaggo/echo-swagger v1.3.5/go.mod h1:3IMHd2Z8KftdWFEEjGmv6QpWj370LwMCOfovuh7vF34= github.com/swaggo/files v0.0.0-20220728132757-551d4a08d97a h1:kAe4YSu0O0UFn1DowNo2MY5p6xzqtJ/wQ7LZynSvGaY= github.com/swaggo/files v0.0.0-20220728132757-551d4a08d97a/go.mod h1:lKJPbtWzJ9JhsTN1k1gZgleJWY/cqq0psdoMmaThG3w= github.com/swaggo/swag v1.8.1/go.mod h1:ugemnJsPZm/kRwFUnzBlbHRd0JY9zE1M4F+uy2pAaPQ= -github.com/swaggo/swag v1.8.5 h1:7NgtfXsXE+jrcOwRyiftGKW7Ppydj7tZiVenuRf1fE4= -github.com/swaggo/swag v1.8.5/go.mod h1:jMLeXOOmYyjk8PvHTsXBdrubsNd9gUJTTCzL5iBnseg= +github.com/swaggo/swag v1.8.7 h1:2K9ivTD3teEO+2fXV6zrZKDqk5IuU2aJtBDo8U7omWU= +github.com/swaggo/swag v1.8.7/go.mod h1:ezQVUUhly8dludpVk+/PuwJWvLLanB13ygV5Pr9enSk= github.com/tklauser/go-sysconf v0.3.10 h1:IJ1AZGZRWbY8T5Vfk04D9WOA5WSejdflXxP03OUqALw= github.com/tklauser/go-sysconf v0.3.10/go.mod h1:C8XykCvCb+Gn0oNCWPIlcb0RuglQTYaQ2hGm7jmxEFk= github.com/tklauser/numcpus v0.4.0/go.mod h1:1+UI3pD8NW14VMwdgJNJ1ESk2UnwhAnz5hMwiKKqXCQ= @@ -368,10 +371,11 @@ github.com/urfave/cli/v2 v2.8.1 h1:CGuYNZF9IKZY/rfBe3lJpccSoIY1ytfvmgQT90cNOl4= github.com/urfave/cli/v2 v2.8.1/go.mod h1:Z41J9TPoffeoqP0Iza0YbAhGvymRdZAd2uPmZ5JxRdY= github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= -github.com/valyala/fasttemplate v1.2.1 h1:TVEnxayobAdVkhQfrfes2IzOB6o+z4roRkPF52WA1u4= github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= -github.com/vektah/gqlparser/v2 v2.5.0 h1:GwEwy7AJsqPWrey0bHnn+3JLaHLZVT66wY/+O+Tf9SU= -github.com/vektah/gqlparser/v2 v2.5.0/go.mod h1:mPgqFBu/woKTVYWyNk8cO3kh4S/f4aRFZrvOnp3hmCs= +github.com/valyala/fasttemplate v1.2.2 h1:lxLXG0uE3Qnshl9QyaK6XJxMXlQZELvChBOCmQD0Loo= +github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= +github.com/vektah/gqlparser/v2 v2.5.1 h1:ZGu+bquAY23jsxDRcYpWjttRZrUz07LbiY77gUOHcr4= +github.com/vektah/gqlparser/v2 v2.5.1/go.mod h1:mPgqFBu/woKTVYWyNk8cO3kh4S/f4aRFZrvOnp3hmCs= github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU= github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb h1:zGWFAtiMcyryUHoUjUJX0/lt1H2+i2Ka2n+D3DImSNo= github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU= @@ -387,6 +391,7 @@ github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9de github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/yusufpapurcu/wmi v1.2.2 h1:KBNDSne4vP5mbSWnJbO+51IMOXJB67QiYCSBrubbPRg= github.com/yusufpapurcu/wmi v1.2.2/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0= go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU= @@ -394,14 +399,17 @@ go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8= go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= -go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw= go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= +go.uber.org/atomic v1.10.0 h1:9qC72Qh0+3MqyJbAn8YU5xVq1frD8bn3JtD2oXtafVQ= +go.uber.org/atomic v1.10.0/go.mod h1:LUxbIzbOniOlMKjJjyPfpl4v+PKK2cNJn91OQbhoJI0= go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI= go.uber.org/goleak v1.1.11/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ= -go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4= go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU= -go.uber.org/zap v1.21.0 h1:WefMeulhovoZ2sYXz7st6K0sLj7bBhpiFaud4r4zST8= +go.uber.org/multierr v1.8.0 h1:dg6GjLku4EH+249NNmoIciG9N/jURbDG+pFlTkhzIC8= +go.uber.org/multierr v1.8.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak= go.uber.org/zap v1.21.0/go.mod h1:wjWOCqI0f2ZZrJF/UufIOkiC8ii6tm1iqIsLo76RfJw= +go.uber.org/zap v1.23.0 h1:OjGQ5KQDEUawVHxNwQgPpiypGHOxo2mNZsOqTak4fFY= +go.uber.org/zap v1.23.0/go.mod h1:D+nX8jyLsMHMYrln8A0rJjFt/T/9/bGgIhAqxv5URuY= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= @@ -412,9 +420,8 @@ golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5y golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= -golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= -golang.org/x/crypto v0.0.0-20220829220503-c86fa9a7ed90 h1:Y/gsMcFOcR+6S6f3YeMKl5g+dZMEWqcz5Czj/GWYbkM= -golang.org/x/crypto v0.0.0-20220829220503-c86fa9a7ed90/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.1.0 h1:MDRAIl0xIo9Io2xV565hzXHw3zVseKrJKodhohM5CjU= +golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= @@ -447,8 +454,9 @@ golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY= -golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 h1:6zppjxzCulZykYSLyVDYbneBfbaBIQPYMevg0bEwv2s= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.6.0 h1:b9gGHsz9/HhJ3HF5DHQytPpuwocVTChQJK3AvoLRD5I= +golang.org/x/mod v0.6.0/go.mod h1:4mET923SAdbXp2ki8ey+zGs1SLqsuM2Y0uvdZR/fUNI= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -489,8 +497,9 @@ golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= golang.org/x/net v0.0.0-20220630215102-69896b714898/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.0.0-20220907135653-1e95f45603a7 h1:1WGATo9HAhkWMbfyuVU0tEFP88OIkUvwaHFveQPvzCQ= -golang.org/x/net v0.0.0-20220907135653-1e95f45603a7/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.1.0 h1:hZ/3BUoy5aId7sCpA/Tc5lt8DkFgdVS2onTpJsZ/fl0= +golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -509,6 +518,7 @@ golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4 h1:uVc8UZUe6tr40fFVnUP5Oj+veunVezqYl9z7DYw9xzw= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -562,25 +572,29 @@ golang.org/x/sys v0.0.0-20220128215802-99c3d69c2c27/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220422013727-9388b58f7150/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220704084225-05e143d24a9e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220907062415-87db552b00fd h1:AZeIEzg+8RCELJYq8w+ODLVxFgLMMigSwO/ffKPEd9U= -golang.org/x/sys v0.0.0-20220907062415-87db552b00fd/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0 h1:BrVqGRd7+k1DiOgtnFvAkoQEWQvBc25ouMJM6429SFg= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= -golang.org/x/time v0.0.0-20220722155302-e5dcc9cfc0b9 h1:ftMN5LMiBFjbzleLqtoBZk7KdJwhuybIU+FckUHgoyQ= -golang.org/x/time v0.0.0-20220722155302-e5dcc9cfc0b9/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.1.0 h1:xYY+Bajn2a7VBmTM5GikTmnK8ZuX8YgnQCqZpbBNtmA= +golang.org/x/time v0.1.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= @@ -626,8 +640,9 @@ golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.6-0.20210726203631-07bc1bf47fb2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo= golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E= -golang.org/x/tools v0.1.12 h1:VveCTK38A2rkS8ZqFY25HIDFscX5X9OoEhJd3quQmXU= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.2.0 h1:G6AHpWxTMGY1KyEYoAQ5WTtIekUUvDNjan3ugu60JvE= +golang.org/x/tools v0.2.0/go.mod h1:y4OqIKeOV/fWJetJ8bXPU1sEVniLMIyDAZWeHdV+NTA= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/http/api/srt.go b/http/api/srt.go index 2882a430..bb31498e 100644 --- a/http/api/srt.go +++ b/http/api/srt.go @@ -33,9 +33,9 @@ type SRTStatistics struct { ByteSent uint64 `json:"sent_bytes"` // Same as pktSent, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) ByteRecv uint64 `json:"recv_bytes"` // Same as pktRecv, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) - ByteSentUnique uint64 `json:"sent_unique__bytes"` // Same as pktSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) + ByteSentUnique uint64 `json:"sent_unique_bytes"` // Same as pktSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) ByteRecvUnique uint64 `json:"recv_unique_bytes"` // Same as pktRecvUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) - ByteRcvLoss uint64 `json:"recv_loss__bytes"` // Same as pktRcvLoss, but expressed in bytes, including payload and all the headers (IP, TCP, SRT), bytes for the presently missing (either reordered or lost) packets' payloads are estimated based on the average packet size + ByteRcvLoss uint64 `json:"recv_loss_bytes"` // Same as pktRcvLoss, but expressed in bytes, including payload and all the headers (IP, TCP, SRT), bytes for the presently missing (either reordered or lost) packets' payloads are estimated based on the average packet size ByteRetrans uint64 `json:"sent_retrans_bytes"` // Same as pktRetrans, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) ByteSndDrop uint64 `json:"send_drop_bytes"` // Same as pktSndDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) ByteRcvDrop uint64 `json:"recv_drop_bytes"` // Same as pktRcvDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT) @@ -68,54 +68,54 @@ type SRTStatistics struct { func (s *SRTStatistics) Unmarshal(ss *gosrt.Statistics) { s.MsTimeStamp = ss.MsTimeStamp - s.PktSent = ss.PktSent - s.PktRecv = ss.PktRecv - s.PktSentUnique = ss.PktSentUnique - s.PktRecvUnique = ss.PktRecvUnique - s.PktSndLoss = ss.PktSndLoss - s.PktRcvLoss = ss.PktRcvLoss - s.PktRetrans = ss.PktRetrans - s.PktRcvRetrans = ss.PktRcvRetrans - s.PktSentACK = ss.PktSentACK - s.PktRecvACK = ss.PktRecvACK - s.PktSentNAK = ss.PktSentNAK - s.PktRecvNAK = ss.PktRecvNAK - s.PktSentKM = ss.PktSentKM - s.PktRecvKM = ss.PktRecvKM - s.UsSndDuration = ss.UsSndDuration - s.PktSndDrop = ss.PktSndDrop - s.PktRcvDrop = ss.PktRcvDrop - s.PktRcvUndecrypt = ss.PktRcvUndecrypt - - s.ByteSent = ss.ByteSent - s.ByteRecv = ss.ByteRecv - s.ByteSentUnique = ss.ByteSentUnique - s.ByteRecvUnique = ss.ByteRecvUnique - s.ByteRcvLoss = ss.ByteRcvLoss - s.ByteRetrans = ss.ByteRetrans - s.ByteSndDrop = ss.ByteSndDrop - s.ByteRcvDrop = ss.ByteRcvDrop - s.ByteRcvUndecrypt = ss.ByteRcvUndecrypt - - s.UsPktSndPeriod = ss.UsPktSndPeriod - s.PktFlowWindow = ss.PktFlowWindow - s.PktFlightSize = ss.PktFlightSize - s.MsRTT = ss.MsRTT - s.MbpsBandwidth = ss.MbpsBandwidth - s.ByteAvailSndBuf = ss.ByteAvailSndBuf - s.ByteAvailRcvBuf = ss.ByteAvailRcvBuf - s.MbpsMaxBW = ss.MbpsMaxBW - s.ByteMSS = ss.ByteMSS - s.PktSndBuf = ss.PktSndBuf - s.ByteSndBuf = ss.ByteSndBuf - s.MsSndBuf = ss.MsSndBuf - s.MsSndTsbPdDelay = ss.MsSndTsbPdDelay - s.PktRcvBuf = ss.PktRcvBuf - s.ByteRcvBuf = ss.ByteRcvBuf - s.MsRcvBuf = ss.MsRcvBuf - s.MsRcvTsbPdDelay = ss.MsRcvTsbPdDelay - s.PktReorderTolerance = ss.PktReorderTolerance - s.PktRcvAvgBelatedTime = ss.PktRcvAvgBelatedTime + s.PktSent = ss.Accumulated.PktSent + s.PktRecv = ss.Accumulated.PktRecv + s.PktSentUnique = ss.Accumulated.PktSentUnique + s.PktRecvUnique = ss.Accumulated.PktRecvUnique + s.PktSndLoss = ss.Accumulated.PktSendLoss + s.PktRcvLoss = ss.Accumulated.PktRecvLoss + s.PktRetrans = ss.Accumulated.PktRetrans + s.PktRcvRetrans = ss.Accumulated.PktRecvRetrans + s.PktSentACK = ss.Accumulated.PktSentACK + s.PktRecvACK = ss.Accumulated.PktRecvACK + s.PktSentNAK = ss.Accumulated.PktSentNAK + s.PktRecvNAK = ss.Accumulated.PktRecvNAK + s.PktSentKM = ss.Accumulated.PktSentKM + s.PktRecvKM = ss.Accumulated.PktRecvKM + s.UsSndDuration = ss.Accumulated.UsSndDuration + s.PktSndDrop = ss.Accumulated.PktSendDrop + s.PktRcvDrop = ss.Accumulated.PktRecvDrop + s.PktRcvUndecrypt = ss.Accumulated.PktRecvUndecrypt + + s.ByteSent = ss.Accumulated.ByteSent + s.ByteRecv = ss.Accumulated.ByteRecv + s.ByteSentUnique = ss.Accumulated.ByteSentUnique + s.ByteRecvUnique = ss.Accumulated.ByteRecvUnique + s.ByteRcvLoss = ss.Accumulated.ByteRecvLoss + s.ByteRetrans = ss.Accumulated.ByteRetrans + s.ByteSndDrop = ss.Accumulated.ByteSendDrop + s.ByteRcvDrop = ss.Accumulated.ByteRecvDrop + s.ByteRcvUndecrypt = ss.Accumulated.ByteRecvUndecrypt + + s.UsPktSndPeriod = ss.Instantaneous.UsPktSendPeriod + s.PktFlowWindow = ss.Instantaneous.PktFlowWindow + s.PktFlightSize = ss.Instantaneous.PktFlightSize + s.MsRTT = ss.Instantaneous.MsRTT + s.MbpsBandwidth = ss.Instantaneous.MbpsLinkCapacity + s.ByteAvailSndBuf = ss.Instantaneous.ByteAvailSendBuf + s.ByteAvailRcvBuf = ss.Instantaneous.ByteAvailRecvBuf + s.MbpsMaxBW = ss.Instantaneous.MbpsMaxBW + s.ByteMSS = ss.Instantaneous.ByteMSS + s.PktSndBuf = ss.Instantaneous.PktSendBuf + s.ByteSndBuf = ss.Instantaneous.ByteSendBuf + s.MsSndBuf = ss.Instantaneous.MsSendBuf + s.MsSndTsbPdDelay = ss.Instantaneous.MsSendTsbPdDelay + s.PktRcvBuf = ss.Instantaneous.PktRecvBuf + s.ByteRcvBuf = ss.Instantaneous.ByteRecvBuf + s.MsRcvBuf = ss.Instantaneous.MsRecvBuf + s.MsRcvTsbPdDelay = ss.Instantaneous.MsRecvTsbPdDelay + s.PktReorderTolerance = ss.Instantaneous.PktReorderTolerance + s.PktRcvAvgBelatedTime = ss.Instantaneous.PktRecvAvgBelatedTime } type SRTLog struct { diff --git a/srt/srt.go b/srt/srt.go index 73a8ba10..c807c477 100644 --- a/srt/srt.go +++ b/srt/srt.go @@ -53,15 +53,17 @@ func (c *client) ticker(ctx context.Context) { ticker := time.NewTicker(1 * time.Second) defer ticker.Stop() + stats := &srt.Statistics{} + for { select { case <-ctx.Done(): return case <-ticker.C: - stats := c.conn.Stats() + c.conn.Stats(stats) - rxbytes := stats.ByteRecv - txbytes := stats.ByteSent + rxbytes := stats.Accumulated.ByteRecv + txbytes := stats.Accumulated.ByteSent c.collector.Ingress(c.id, int64(rxbytes-c.rxbytes)) c.collector.Egress(c.id, int64(txbytes-c.txbytes)) @@ -285,8 +287,11 @@ func (s *server) Channels() Channels { socketId := ch.publisher.conn.SocketId() st.Publisher[id] = socketId + stats := &srt.Statistics{} + ch.publisher.conn.Stats(stats) + st.Connections[socketId] = Connection{ - Stats: ch.publisher.conn.Stats(), + Stats: *stats, Log: map[string][]Log{}, } @@ -294,8 +299,11 @@ func (s *server) Channels() Channels { socketId := c.conn.SocketId() st.Subscriber[id] = append(st.Subscriber[id], socketId) + stats := &srt.Statistics{} + c.conn.Stats(stats) + st.Connections[socketId] = Connection{ - Stats: c.conn.Stats(), + Stats: *stats, Log: map[string][]Log{}, } } diff --git a/vendor/github.com/99designs/gqlgen/CHANGELOG.md b/vendor/github.com/99designs/gqlgen/CHANGELOG.md index a50f8012..93c0f3f5 100644 --- a/vendor/github.com/99designs/gqlgen/CHANGELOG.md +++ b/vendor/github.com/99designs/gqlgen/CHANGELOG.md @@ -5,10 +5,138 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased](https://github.com/99designs/gqlgen/compare/v0.17.14...HEAD) +## [Unreleased](https://github.com/99designs/gqlgen/compare/v0.17.19...HEAD) + +## [v0.17.19](https://github.com/99designs/gqlgen/compare/v0.17.18...v0.17.19) - 2022-09-15 +- 588c6ac1 release v0.17.19 + +- c6713170 v0.17.18 postrelease bump + + + + + + +## [v0.17.18](https://github.com/99designs/gqlgen/compare/v0.17.17...v0.17.18) - 2022-09-15 +- 1d41c808 release v0.17.18 + +- 4dbe2e47 update graphiql to 2.0.7 (#2375) + +
b7cc094a testfix: make apollo federated tracer test more consistent (#2374) + +* Update tracing_test.go + +* add missing imports + +
+ +- d096fb9b Update directives (#2371) + +- 1acfea2f Add v0.17.17 changelog + +- c273adc8 v0.17.17 postrelease bump + + + + + + +## [v0.17.17](https://github.com/99designs/gqlgen/compare/v0.17.16...v0.17.17) - 2022-09-13 +- d50bc5ac release v0.17.17 + +
462025b4 nil check error before type assertion follow-up from #2341 (#2368) + +* Improve errcode.Set safety + +
+ +
59493aff fix: apollo federation tracer was race prone (#2366) + +The tracer was using a global state across different goroutines +Added req headers to operation context to allow it to be fetched in InterceptOperation + +
+ +- fc018556 Update gqlparser to v2.5.1 (#2363) + +- 56574a14 feat: make Playground HTML content compatible with UTF-8 charset (#2355) + +
182b039d Add `subscriptions.md` recipe to docs (#2346) + +* Add `subscriptions.md` recipe to docs + +* Fix wrong request type + +
+ +- b66fff16 Add omit_getters config option (#2348) + +- 2ba8040f Update changelog for v0.17.16 + +- 8bef8c80 v0.17.16 postrelease bump + + + + + + +## [v0.17.16](https://github.com/99designs/gqlgen/compare/v0.17.15...v0.17.16) - 2022-08-26 +- 9593cead release v0.17.16 + +- 2390af2d Update gqlparser to v2.5.0 (#2341) + +- 2a87fe06 feat: update Graphiql to version 2 (#2340) + +
32e2ccd3 Update yaml to v3 (#2339) + +* update yaml to v3 + +* add missing go entry for yaml on _example + +* add missing sum file + +
+ +- 7949117a v0.17.15 postrelease bump + + + + + + +## [v0.17.15](https://github.com/99designs/gqlgen/compare/v0.17.14...v0.17.15) - 2022-08-23 +- 23cc7492 release v0.17.15 + +- 577a570c Markdown formatting fixes (#2335) + +
2b584011 Fix Interface Slice Getter Generation (#2332) + +* Make modelgen test fail if generated doesn't build +Added returning list of interface to modelgen test schema + +* Implement slice copying when returning interface slices + +* Re-generate to satisfy the linter + +
+ +
aee57b4c Correct boolean logic (#2330) + +Correcting boolean logic issue + +
+ +- da0610e1 Update changelog for v0.17.14 + +- ddcb524e v0.17.14 postrelease bump + + + + + ## [v0.17.14](https://github.com/99designs/gqlgen/compare/v0.17.13...v0.17.14) - 2022-08-18 - 581bf6eb release v0.17.14 diff --git a/vendor/github.com/99designs/gqlgen/README.md b/vendor/github.com/99designs/gqlgen/README.md index 6c61c85e..e0b45a56 100644 --- a/vendor/github.com/99designs/gqlgen/README.md +++ b/vendor/github.com/99designs/gqlgen/README.md @@ -142,6 +142,16 @@ first model in this list is used as the default type and it will always be used There isn't any way around this, gqlgen has no way to know what you want in a given context. +### Why do my interfaces have getters? Can I disable these? +These were added in v0.17.14 to allow accessing common interface fields without casting to a concrete type. +However, certain fields, like Relay-style Connections, cannot be implemented with simple getters. + +If you'd prefer to not have getters generated in your interfaces, you can add the following in your `gqlgen.yml`: +```yaml +# gqlgen.yml +omit_getters: true +``` + ## Other Resources - [Christopher Biscardi @ Gophercon UK 2018](https://youtu.be/FdURVezcdcw) diff --git a/vendor/github.com/99designs/gqlgen/codegen/config/config.go b/vendor/github.com/99designs/gqlgen/codegen/config/config.go index 9deba8b1..c6de8625 100644 --- a/vendor/github.com/99designs/gqlgen/codegen/config/config.go +++ b/vendor/github.com/99designs/gqlgen/codegen/config/config.go @@ -26,6 +26,7 @@ type Config struct { StructTag string `yaml:"struct_tag,omitempty"` Directives map[string]DirectiveConfig `yaml:"directives,omitempty"` OmitSliceElementPointers bool `yaml:"omit_slice_element_pointers,omitempty"` + OmitGetters bool `yaml:"omit_getters,omitempty"` StructFieldsAlwaysPointers bool `yaml:"struct_fields_always_pointers,omitempty"` ResolversAlwaysReturnPointers bool `yaml:"resolvers_always_return_pointers,omitempty"` SkipValidation bool `yaml:"skip_validation,omitempty"` diff --git a/vendor/github.com/99designs/gqlgen/graphql/context_operation.go b/vendor/github.com/99designs/gqlgen/graphql/context_operation.go index bfbbc5c0..0518ecc6 100644 --- a/vendor/github.com/99designs/gqlgen/graphql/context_operation.go +++ b/vendor/github.com/99designs/gqlgen/graphql/context_operation.go @@ -3,6 +3,7 @@ package graphql import ( "context" "errors" + "net/http" "github.com/vektah/gqlparser/v2/ast" ) @@ -15,6 +16,7 @@ type OperationContext struct { Variables map[string]interface{} OperationName string Doc *ast.QueryDocument + Headers http.Header Operation *ast.OperationDefinition DisableIntrospection bool diff --git a/vendor/github.com/99designs/gqlgen/graphql/errcode/codes.go b/vendor/github.com/99designs/gqlgen/graphql/errcode/codes.go index 4333d87e..854b206f 100644 --- a/vendor/github.com/99designs/gqlgen/graphql/errcode/codes.go +++ b/vendor/github.com/99designs/gqlgen/graphql/errcode/codes.go @@ -23,14 +23,22 @@ var codeType = map[string]ErrorKind{ ParseFailed: KindProtocol, } -// RegisterErrorType should be called by extensions that want to customize the http status codes for errors they return +// RegisterErrorType should be called by extensions that want to customize the http status codes for +// errors they return func RegisterErrorType(code string, kind ErrorKind) { codeType[code] = kind } // Set the error code on a given graphql error extension func Set(err error, value string) { - gqlErr, _ := err.(*gqlerror.Error) + if err == nil { + return + } + gqlErr, ok := err.(*gqlerror.Error) + if !ok { + return + } + if gqlErr.Extensions == nil { gqlErr.Extensions = map[string]interface{}{} } diff --git a/vendor/github.com/99designs/gqlgen/graphql/executable_schema.go b/vendor/github.com/99designs/gqlgen/graphql/executable_schema.go index 541b65fb..61891622 100644 --- a/vendor/github.com/99designs/gqlgen/graphql/executable_schema.go +++ b/vendor/github.com/99designs/gqlgen/graphql/executable_schema.go @@ -118,6 +118,11 @@ func getOrCreateAndAppendField(c *[]CollectedField, name string, alias string, o return &(*c)[i] } } + for _, ifc := range cf.ObjectDefinition.Interfaces { + if ifc == objectDefinition.Name { + return &(*c)[i] + } + } } } diff --git a/vendor/github.com/99designs/gqlgen/graphql/executor/executor.go b/vendor/github.com/99designs/gqlgen/graphql/executor/executor.go index d036ea6f..c46a007b 100644 --- a/vendor/github.com/99designs/gqlgen/graphql/executor/executor.go +++ b/vendor/github.com/99designs/gqlgen/graphql/executor/executor.go @@ -37,7 +37,10 @@ func New(es graphql.ExecutableSchema) *Executor { return e } -func (e *Executor) CreateOperationContext(ctx context.Context, params *graphql.RawParams) (*graphql.OperationContext, gqlerror.List) { +func (e *Executor) CreateOperationContext( + ctx context.Context, + params *graphql.RawParams, +) (*graphql.OperationContext, gqlerror.List) { rc := &graphql.OperationContext{ DisableIntrospection: true, RecoverFunc: e.recoverFunc, @@ -58,6 +61,7 @@ func (e *Executor) CreateOperationContext(ctx context.Context, params *graphql.R rc.RawQuery = params.Query rc.OperationName = params.OperationName + rc.Headers = params.Headers var listErr gqlerror.List rc.Doc, listErr = e.parseQuery(ctx, &rc.Stats, params.Query) @@ -74,10 +78,13 @@ func (e *Executor) CreateOperationContext(ctx context.Context, params *graphql.R var err error rc.Variables, err = validator.VariableValues(e.es.Schema(), rc.Operation, params.Variables) - gqlErr, _ := err.(*gqlerror.Error) - if gqlErr != nil { - errcode.Set(gqlErr, errcode.ValidationFailed) - return rc, gqlerror.List{gqlErr} + + if err != nil { + gqlErr, ok := err.(*gqlerror.Error) + if ok { + errcode.Set(gqlErr, errcode.ValidationFailed) + return rc, gqlerror.List{gqlErr} + } } rc.Stats.Validation.End = graphql.Now() @@ -90,7 +97,10 @@ func (e *Executor) CreateOperationContext(ctx context.Context, params *graphql.R return rc, nil } -func (e *Executor) DispatchOperation(ctx context.Context, rc *graphql.OperationContext) (graphql.ResponseHandler, context.Context) { +func (e *Executor) DispatchOperation( + ctx context.Context, + rc *graphql.OperationContext, +) (graphql.ResponseHandler, context.Context) { ctx = graphql.WithOperationContext(ctx, rc) var innerCtx context.Context @@ -160,9 +170,14 @@ func (e *Executor) SetRecoverFunc(f graphql.RecoverFunc) { // parseQuery decodes the incoming query and validates it, pulling from cache if present. // -// NOTE: This should NOT look at variables, they will change per request. It should only parse and validate +// NOTE: This should NOT look at variables, they will change per request. It should only parse and +// validate // the raw query string. -func (e *Executor) parseQuery(ctx context.Context, stats *graphql.Stats, query string) (*ast.QueryDocument, gqlerror.List) { +func (e *Executor) parseQuery( + ctx context.Context, + stats *graphql.Stats, + query string, +) (*ast.QueryDocument, gqlerror.List) { stats.Parsing.Start = graphql.Now() if doc, ok := e.queryCache.Get(ctx, query); ok { @@ -174,10 +189,12 @@ func (e *Executor) parseQuery(ctx context.Context, stats *graphql.Stats, query s } doc, err := parser.ParseQuery(&ast.Source{Input: query}) - gqlErr, _ := err.(*gqlerror.Error) - if gqlErr != nil { - errcode.Set(gqlErr, errcode.ParseFailed) - return nil, gqlerror.List{gqlErr} + if err != nil { + gqlErr, ok := err.(*gqlerror.Error) + if ok { + errcode.Set(gqlErr, errcode.ParseFailed) + return nil, gqlerror.List{gqlErr} + } } stats.Parsing.End = graphql.Now() diff --git a/vendor/github.com/99designs/gqlgen/graphql/handler.go b/vendor/github.com/99designs/gqlgen/graphql/handler.go index b76381f4..cd358740 100644 --- a/vendor/github.com/99designs/gqlgen/graphql/handler.go +++ b/vendor/github.com/99designs/gqlgen/graphql/handler.go @@ -42,14 +42,14 @@ type ( // Its important to understand the lifecycle of a graphql request and the terminology we use in gqlgen // before working with these // - // +--- REQUEST POST /graphql --------------------------------------------+ - // | +- OPERATION query OpName { viewer { name } } -----------------------+ | - // | | RESPONSE { "data": { "viewer": { "name": "bob" } } } | | - // | +- OPERATION subscription OpName2 { chat { message } } --------------+ | - // | | RESPONSE { "data": { "chat": { "message": "hello" } } } | | - // | | RESPONSE { "data": { "chat": { "message": "byee" } } } | | - // | +--------------------------------------------------------------------+ | - // +------------------------------------------------------------------------+ + // +--- REQUEST POST /graphql --------------------------------------------+ + // | +- OPERATION query OpName { viewer { name } } -----------------------+ | + // | | RESPONSE { "data": { "viewer": { "name": "bob" } } } | | + // | +- OPERATION subscription OpName2 { chat { message } } --------------+ | + // | | RESPONSE { "data": { "chat": { "message": "hello" } } } | | + // | | RESPONSE { "data": { "chat": { "message": "byee" } } } | | + // | +--------------------------------------------------------------------+ | + // +------------------------------------------------------------------------+ HandlerExtension interface { // ExtensionName should be a CamelCase string version of the extension which may be shown in stats and logging. ExtensionName() string diff --git a/vendor/github.com/99designs/gqlgen/graphql/playground/playground.go b/vendor/github.com/99designs/gqlgen/graphql/playground/playground.go index 720e1a14..08e5e4a8 100644 --- a/vendor/github.com/99designs/gqlgen/graphql/playground/playground.go +++ b/vendor/github.com/99designs/gqlgen/graphql/playground/playground.go @@ -9,6 +9,7 @@ import ( var page = template.Must(template.New("graphiql").Parse(` + {{.title}}