From 8e79e2acfab4d19aaeb2f72ca5217986ed1ef90b Mon Sep 17 00:00:00 2001 From: Gabe Kangas Date: Sun, 8 Oct 2023 14:22:28 -0700 Subject: [PATCH] chore(go): run betteralign and gofumpt on codebase --- config/verifyInstall.go | 4 ++-- controllers/config.go | 14 ++++++------- core/chat/events/connectedClientInfo.go | 2 +- core/chat/server.go | 8 ++++---- core/data/config.go | 4 ++-- core/data/configEntry.go | 2 +- core/data/data_test.go | 6 ++++-- core/data/emoji.go | 8 +++++--- core/data/types.go | 10 +++++----- core/storageproviders/s3Storage.go | 26 +++++++++++++------------ core/transcoder/utils.go | 10 ++++++---- core/webhooks/workerpool.go | 6 +++--- geoip/geoip.go | 2 +- logging/logging.go | 2 +- metrics/metrics.go | 6 ++++-- models/s3Storage.go | 16 +++++++-------- utils/restendpointhelper.go | 2 +- yp/yp.go | 6 ++++-- 18 files changed, 73 insertions(+), 61 deletions(-) diff --git a/config/verifyInstall.go b/config/verifyInstall.go index b6b5716a3..96b38bf69 100644 --- a/config/verifyInstall.go +++ b/config/verifyInstall.go @@ -29,8 +29,8 @@ func VerifyFFMpegPath(path string) error { } mode := stat.Mode() - //source: https://stackoverflow.com/a/60128480 - if mode&0111 == 0 { + // source: https://stackoverflow.com/a/60128480 + if mode&0o111 == 0 { return errors.New("ffmpeg path is not executable") } diff --git a/controllers/config.go b/controllers/config.go index 41743ae2b..ceec87692 100644 --- a/controllers/config.go +++ b/controllers/config.go @@ -17,25 +17,25 @@ import ( type webConfigResponse struct { AppearanceVariables map[string]string `json:"appearanceVariables"` - Notifications notificationsConfigResponse `json:"notifications"` + Name string `json:"name"` CustomStyles string `json:"customStyles"` - Summary string `json:"summary"` + StreamTitle string `json:"streamTitle,omitempty"` // What's going on with the current stream OfflineMessage string `json:"offlineMessage"` Logo string `json:"logo"` Version string `json:"version"` SocketHostOverride string `json:"socketHostOverride,omitempty"` ExtraPageContent string `json:"extraPageContent"` - StreamTitle string `json:"streamTitle,omitempty"` // What's going on with the current stream - Name string `json:"name"` - Federation federationConfigResponse `json:"federation"` + Summary string `json:"summary"` + Tags []string `json:"tags"` SocialHandles []models.SocialHandle `json:"socialHandles"` ExternalActions []models.ExternalAction `json:"externalActions"` - Tags []string `json:"tags"` + Notifications notificationsConfigResponse `json:"notifications"` + Federation federationConfigResponse `json:"federation"` MaxSocketPayloadSize int `json:"maxSocketPayloadSize"` + HideViewerCount bool `json:"hideViewerCount"` ChatDisabled bool `json:"chatDisabled"` NSFW bool `json:"nsfw"` Authentication authenticationConfigResponse `json:"authentication"` - HideViewerCount bool `json:"hideViewerCount"` } type federationConfigResponse struct { diff --git a/core/chat/events/connectedClientInfo.go b/core/chat/events/connectedClientInfo.go index 3b04a5423..a1da8a42d 100644 --- a/core/chat/events/connectedClientInfo.go +++ b/core/chat/events/connectedClientInfo.go @@ -4,6 +4,6 @@ import "github.com/owncast/owncast/core/user" // ConnectedClientInfo represents the information about a connected client. type ConnectedClientInfo struct { - Event User *user.User `json:"user"` + Event } diff --git a/core/chat/server.go b/core/chat/server.go index 6644be8dc..156df0e19 100644 --- a/core/chat/server.go +++ b/core/chat/server.go @@ -35,14 +35,14 @@ type Server struct { // unregister requests from clients. unregister chan uint // the ChatClient id - geoipClient *geoip.Client + geoipClient *geoip.Client + + // a map of user IDs and timers that fire for chat part messages. + userPartedTimers map[string]*time.Ticker seq uint maxSocketConnectionLimit int64 mu sync.RWMutex - - // a map of user IDs and timers that fire for chat part messages. - userPartedTimers map[string]*time.Ticker } // NewChat will return a new instance of the chat server. diff --git a/core/data/config.go b/core/data/config.go index c8e4e5bad..6923edac9 100644 --- a/core/data/config.go +++ b/core/data/config.go @@ -622,8 +622,8 @@ func VerifySettings() error { // FindHighestVideoQualityIndex will return the highest quality from a slice of variants. func FindHighestVideoQualityIndex(qualities []models.StreamOutputVariant) int { type IndexedQuality struct { - index int quality models.StreamOutputVariant + index int } if len(qualities) < 2 { @@ -632,7 +632,7 @@ func FindHighestVideoQualityIndex(qualities []models.StreamOutputVariant) int { indexedQualities := make([]IndexedQuality, 0) for index, quality := range qualities { - indexedQuality := IndexedQuality{index, quality} + indexedQuality := IndexedQuality{quality, index} indexedQualities = append(indexedQualities, indexedQuality) } diff --git a/core/data/configEntry.go b/core/data/configEntry.go index 938924368..8486c8c0b 100644 --- a/core/data/configEntry.go +++ b/core/data/configEntry.go @@ -8,8 +8,8 @@ import ( // ConfigEntry is the actual object saved to the database. // The Value is encoded using encoding/gob. type ConfigEntry struct { - Key string Value interface{} + Key string } func (c *ConfigEntry) getStringSlice() ([]string, error) { diff --git a/core/data/data_test.go b/core/data/data_test.go index e1a0a86b7..d3e113e5b 100644 --- a/core/data/data_test.go +++ b/core/data/data_test.go @@ -20,6 +20,8 @@ func TestString(t *testing.T) { const testKey = "test string key" const testValue = "test string value" + fmt.Println(testKey, testValue) + if err := _datastore.SetString(testKey, testValue); err != nil { panic(err) } @@ -87,7 +89,7 @@ func TestCustomType(t *testing.T) { } // Save config entry to the database - if err := _datastore.Save(ConfigEntry{testKey, &testStruct}); err != nil { + if err := _datastore.Save(ConfigEntry{&testStruct, testKey}); err != nil { t.Error(err) } @@ -119,7 +121,7 @@ func TestStringMap(t *testing.T) { } // Save config entry to the database - if err := _datastore.Save(ConfigEntry{testKey, &testMap}); err != nil { + if err := _datastore.Save(ConfigEntry{&testMap, testKey}); err != nil { t.Error(err) } diff --git a/core/data/emoji.go b/core/data/emoji.go index fda895a51..6b67cd76f 100644 --- a/core/data/emoji.go +++ b/core/data/emoji.go @@ -17,9 +17,11 @@ import ( log "github.com/sirupsen/logrus" ) -var emojiCacheMu sync.Mutex -var emojiCacheData = make([]models.CustomEmoji, 0) -var emojiCacheModTime time.Time +var ( + emojiCacheMu sync.Mutex + emojiCacheData = make([]models.CustomEmoji, 0) + emojiCacheModTime time.Time +) // UpdateEmojiList will update the cache (if required) and // return the modifiation time. diff --git a/core/data/types.go b/core/data/types.go index 5405e6c12..9d421b7c6 100644 --- a/core/data/types.go +++ b/core/data/types.go @@ -11,7 +11,7 @@ func (ds *Datastore) GetStringSlice(key string) ([]string, error) { // SetStringSlice will set the string slice value for a key. func (ds *Datastore) SetStringSlice(key string, value []string) error { - configEntry := ConfigEntry{key, value} + configEntry := ConfigEntry{value, key} return ds.Save(configEntry) } @@ -26,7 +26,7 @@ func (ds *Datastore) GetString(key string) (string, error) { // SetString will set the string value for a key. func (ds *Datastore) SetString(key string, value string) error { - configEntry := ConfigEntry{key, value} + configEntry := ConfigEntry{value, key} return ds.Save(configEntry) } @@ -41,7 +41,7 @@ func (ds *Datastore) GetNumber(key string) (float64, error) { // SetNumber will set the numeric value for a key. func (ds *Datastore) SetNumber(key string, value float64) error { - configEntry := ConfigEntry{key, value} + configEntry := ConfigEntry{value, key} return ds.Save(configEntry) } @@ -56,7 +56,7 @@ func (ds *Datastore) GetBool(key string) (bool, error) { // SetBool will set the boolean value for a key. func (ds *Datastore) SetBool(key string, value bool) error { - configEntry := ConfigEntry{key, value} + configEntry := ConfigEntry{value, key} return ds.Save(configEntry) } @@ -71,6 +71,6 @@ func (ds *Datastore) GetStringMap(key string) (map[string]string, error) { // SetStringMap will set the string map value for a key. func (ds *Datastore) SetStringMap(key string, value map[string]string) error { - configEntry := ConfigEntry{key, value} + configEntry := ConfigEntry{value, key} return ds.Save(configEntry) } diff --git a/core/storageproviders/s3Storage.go b/core/storageproviders/s3Storage.go index dbe0ce576..d9e7d1604 100644 --- a/core/storageproviders/s3Storage.go +++ b/core/storageproviders/s3Storage.go @@ -28,23 +28,25 @@ import ( type S3Storage struct { sess *session.Session s3Client *s3.S3 - host string - s3Endpoint string - s3ServingEndpoint string - s3Region string - s3Bucket string - s3AccessKey string - s3Secret string - s3ACL string - s3PathPrefix string - s3ForcePathStyle bool + uploader *s3manager.Uploader // If we try to upload a playlist but it is not yet on disk // then keep a reference to it here. queuedPlaylistUpdates map[string]string - uploader *s3manager.Uploader + s3Bucket string + s3Region string + s3ServingEndpoint string + s3AccessKey string + s3Secret string + s3ACL string + s3PathPrefix string + + s3Endpoint string + host string + + s3ForcePathStyle bool } // NewS3Storage returns a new S3Storage instance. @@ -330,6 +332,6 @@ func (s *S3Storage) retrieveAllVideoSegments() ([]s3object, error) { } type s3object struct { - key string lastModified time.Time + key string } diff --git a/core/transcoder/utils.go b/core/transcoder/utils.go index d89cbfe9d..18c9c8a2d 100644 --- a/core/transcoder/utils.go +++ b/core/transcoder/utils.go @@ -13,8 +13,10 @@ import ( log "github.com/sirupsen/logrus" ) -var _lastTranscoderLogMessage = "" -var l = &sync.RWMutex{} +var ( + _lastTranscoderLogMessage = "" + l = &sync.RWMutex{} +) var errorMap = map[string]string{ "Unrecognized option 'vaapi_device'": "you are likely trying to utilize a vaapi codec, but your version of ffmpeg or your hardware doesn't support it. change your codec to libx264 and restart your stream", @@ -100,14 +102,14 @@ func createVariantDirectories() { if len(data.GetStreamOutputVariants()) != 0 { for index := range data.GetStreamOutputVariants() { - if err := os.MkdirAll(path.Join(config.HLSStoragePath, strconv.Itoa(index)), 0750); err != nil { + if err := os.MkdirAll(path.Join(config.HLSStoragePath, strconv.Itoa(index)), 0o750); err != nil { log.Fatalln(err) } } } else { dir := path.Join(config.HLSStoragePath, strconv.Itoa(0)) log.Traceln("Creating", dir) - if err := os.MkdirAll(dir, 0750); err != nil { + if err := os.MkdirAll(dir, 0o750); err != nil { log.Fatalln(err) } } diff --git a/core/webhooks/workerpool.go b/core/webhooks/workerpool.go index df808866b..2134ef1d2 100644 --- a/core/webhooks/workerpool.go +++ b/core/webhooks/workerpool.go @@ -18,9 +18,9 @@ var webhookWorkerPoolSize = runtime.GOMAXPROCS(0) // Job struct bundling the webhook and the payload in one struct. type Job struct { - webhook models.Webhook - payload WebhookEvent wg *sync.WaitGroup + payload WebhookEvent + webhook models.Webhook } var ( @@ -46,7 +46,7 @@ func initWorkerPool() { func addToQueue(webhook models.Webhook, payload WebhookEvent, wg *sync.WaitGroup) { log.Tracef("Queued Event %s for Webhook %s", payload.Type, webhook.URL) - queue <- Job{webhook, payload, wg} + queue <- Job{wg, payload, webhook} } func worker(workerID int, queue <-chan Job) { diff --git a/geoip/geoip.go b/geoip/geoip.go index 575af7b39..8ccaaba06 100644 --- a/geoip/geoip.go +++ b/geoip/geoip.go @@ -76,7 +76,7 @@ func (c *Client) fetchGeoForIP(ip string) *GeoDetails { // If no country is available then exit // If we believe this IP to be anonymous then no reason to report it if record.Country.IsoCode != "" && !record.Traits.IsAnonymousProxy { - var regionName = "Unknown" + regionName := "Unknown" if len(record.Subdivisions) > 0 { if region, ok := record.Subdivisions[0].Names["en"]; ok { regionName = region diff --git a/logging/logging.go b/logging/logging.go index 2d5b7d39c..aa9867be5 100644 --- a/logging/logging.go +++ b/logging/logging.go @@ -34,7 +34,7 @@ func Setup(enableDebugOptions bool, enableVerboseLogging bool) { // Create the logging directory if needed loggingDirectory := filepath.Dir(getLogFilePath()) if !utils.DoesFileExists(loggingDirectory) { - if err := os.Mkdir(loggingDirectory, 0700); err != nil { + if err := os.Mkdir(loggingDirectory, 0o700); err != nil { logger.Errorln("unable to create logs directory", loggingDirectory, err) } } diff --git a/metrics/metrics.go b/metrics/metrics.go index f0bb28e7e..2453e2300 100644 --- a/metrics/metrics.go +++ b/metrics/metrics.go @@ -10,8 +10,10 @@ import ( ) // How often we poll for updates. -const hardwareMetricsPollingInterval = 2 * time.Minute -const playbackMetricsPollingInterval = 2 * time.Minute +const ( + hardwareMetricsPollingInterval = 2 * time.Minute + playbackMetricsPollingInterval = 2 * time.Minute +) const ( // How often we poll for updates. diff --git a/models/s3Storage.go b/models/s3Storage.go index 522d1b8e5..b10dcc462 100644 --- a/models/s3Storage.go +++ b/models/s3Storage.go @@ -2,14 +2,12 @@ package models // S3 is the storage configuration. type S3 struct { - Enabled bool `json:"enabled"` - Endpoint string `json:"endpoint,omitempty"` - AccessKey string `json:"accessKey,omitempty"` - Secret string `json:"secret,omitempty"` - Bucket string `json:"bucket,omitempty"` - Region string `json:"region,omitempty"` - ACL string `json:"acl,omitempty"` - ForcePathStyle bool `json:"forcePathStyle"` + Endpoint string `json:"endpoint,omitempty"` + AccessKey string `json:"accessKey,omitempty"` + Secret string `json:"secret,omitempty"` + Bucket string `json:"bucket,omitempty"` + Region string `json:"region,omitempty"` + ACL string `json:"acl,omitempty"` // PathPrefix is an optional prefix for object storage. PathPrefix string `json:"pathPrefix,omitempty"` @@ -18,4 +16,6 @@ type S3 struct { // property that was pulled out of here instead. It's only left here // to allow the migration to take place without data loss. ServingEndpoint string `json:"-"` + Enabled bool `json:"enabled"` + ForcePathStyle bool `json:"forcePathStyle"` } diff --git a/utils/restendpointhelper.go b/utils/restendpointhelper.go index 7d4061a15..93dc8118a 100644 --- a/utils/restendpointhelper.go +++ b/utils/restendpointhelper.go @@ -20,7 +20,7 @@ func getPatternForRestEndpoint(pattern string) string { } func zip2D(iterable1 *[]string, iterable2 *[]string) map[string]string { - var dict = make(map[string]string) + dict := make(map[string]string) for index, key := range *iterable1 { dict[key] = (*iterable2)[index] } diff --git a/yp/yp.go b/yp/yp.go index 22897c17f..055dd1ec8 100644 --- a/yp/yp.go +++ b/yp/yp.go @@ -17,8 +17,10 @@ import ( const pingInterval = 4 * time.Minute -var getStatus func() models.Status -var _inErrorState = false +var ( + getStatus func() models.Status + _inErrorState = false +) // YP is a service for handling listing in the Owncast directory. type YP struct {