LogalDeveloper/owncast
0
Fork 0
Code Activity

Expanded linting + fix warnings (#1396)

Browse Source 
* Expand the linters and types of warnings to improve consistency and safety

* Fail lint workflow if there are errors

* golint has been replaced by revive

* Hand-pick some of the default exclude list

* Ignore error when trying to delete preview gif

* Ignore linter warning opening playlist path

* Rename user field Id -> ID

* A bunch of renames to address linter warnings

* Rename ChatClient -> Client per linter suggestion best practice

* Rename ChatServer -> Server per linter suggestion best practice

* More linter warning fixes

* Add missing comments to all exported functions and properties
This commit is contained in:
Gabe Kangas
2021-09-12 00:18:15 -07:00
committed by GitHub
parent 70e9f4945f
commit c6c6f0233d
57 changed files with 331 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/user/externalAPIUser.go
View File

@@ -14,7 +14,7 @@ import (
// ExternalAPIUser represents a single 3rd party integration that uses an access token.
// This struct mostly matches the User struct so they can be used interchangeably.
type ExternalAPIUser struct {
Id string `json:"id"`
ID string `json:"id"`
AccessToken string `json:"accessToken"`
DisplayName string `json:"displayName"`
DisplayColor int `json:"displayColor"`
@@ -40,7 +40,7 @@ var validAccessTokenScopes = []string{
ScopeHasAdminAccess,
}
// InsertToken will add a new token to the database.
// InsertExternalAPIUser will add a new API user to the database.
func InsertExternalAPIUser(token string, name string, color int, scopes []string) error {
log.Traceln("Adding new API user:", name)
@@ -206,7 +206,7 @@ func makeExternalAPIUserFromRow(row *sql.Row) (*ExternalAPIUser, error) {
}
integration := ExternalAPIUser{
Id: id,
ID: id,
AccessToken: accessToken,
DisplayName: displayName,
DisplayColor: displayColor,
@@ -237,7 +237,7 @@ func makeExternalAPIUsersFromRows(rows *sql.Rows) ([]ExternalAPIUser, error) {
}
integration := ExternalAPIUser{
Id: id,
ID: id,
AccessToken: accessToken,
DisplayName: displayName,
DisplayColor: displayColor,

26
core/user/user.go
View File

@@ -16,8 +16,9 @@ import (
var _datastore *data.Datastore
// User represents a single chat user.
type User struct {
Id string `json:"id"`
ID string `json:"id"`
AccessToken string `json:"-"`
DisplayName string `json:"displayName"`
DisplayColor int `json:"displayColor"`
@@ -27,14 +28,17 @@ type User struct {
NameChangedAt *time.Time `json:"nameChangedAt,omitempty"`
}
// IsEnabled will return if this single user is enabled.
func (u *User) IsEnabled() bool {
return u.DisabledAt == nil
}
// SetupUsers will perform the initial initialization of the user package.
func SetupUsers() {
_datastore = data.GetDatastore()
}
// CreateAnonymousUser will create a new anonymous user with the provided display name.
func CreateAnonymousUser(username string) (*User, error) {
id := shortid.MustGenerate()
accessToken, err := utils.GenerateAccessToken()
@@ -51,7 +55,7 @@ func CreateAnonymousUser(username string) (*User, error) {
displayColor := utils.GenerateRandomDisplayColor()
user := &User{
Id: id,
ID: id,
AccessToken: accessToken,
DisplayName: displayName,
DisplayColor: displayColor,
@@ -65,7 +69,8 @@ func CreateAnonymousUser(username string) (*User, error) {
return user, nil
}
func ChangeUsername(userId string, username string) {
// ChangeUsername will change the user associated to userID from one display name to another.
func ChangeUsername(userID string, username string) {
_datastore.DbLock.Lock()
defer _datastore.DbLock.Unlock()
@@ -87,13 +92,13 @@ func ChangeUsername(userId string, username string) {
}
defer stmt.Close()
_, err = stmt.Exec(username, fmt.Sprintf(",%s", username), time.Now(), userId)
_, err = stmt.Exec(username, fmt.Sprintf(",%s", username), time.Now(), userID)
if err != nil {
log.Errorln(err)
}
if err := tx.Commit(); err != nil {
log.Errorln("error changing display name of user", userId, err)
log.Errorln("error changing display name of user", userID, err)
}
}
@@ -116,7 +121,7 @@ func create(user *User) error {
}
defer stmt.Close()
_, err = stmt.Exec(user.Id, user.AccessToken, user.DisplayName, user.DisplayColor, user.DisplayName, user.CreatedAt)
_, err = stmt.Exec(user.ID, user.AccessToken, user.DisplayName, user.DisplayColor, user.DisplayName, user.CreatedAt)
if err != nil {
log.Errorln("error creating new user", err)
}
@@ -124,6 +129,7 @@ func create(user *User) error {
return tx.Commit()
}
// SetEnabled will will set the enabled flag on a single user assigned to userID.
func SetEnabled(userID string, enabled bool) error {
_datastore.DbLock.Lock()
defer _datastore.DbLock.Unlock()
@@ -166,8 +172,8 @@ func GetUserByToken(token string) *User {
return getUserFromRow(row)
}
// GetUserById will return a user by a user ID.
func GetUserById(id string) *User {
// GetUserByID will return a user by a user ID.
func GetUserByID(id string) *User {
_datastore.DbLock.Lock()
defer _datastore.DbLock.Unlock()
@@ -218,7 +224,7 @@ func getUsersFromRows(rows *sql.Rows) []*User {
}
user := &User{
Id: id,
ID: id,
DisplayName: displayName,
DisplayColor: displayColor,
CreatedAt: createdAt,
@@ -250,7 +256,7 @@ func getUserFromRow(row *sql.Row) *User {
}
return &User{
Id: id,
ID: id,
DisplayName: displayName,
DisplayColor: displayColor,
CreatedAt: createdAt,