Expanded linting + fix warnings (#1396)
* 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:
+18
-16
@@ -5,7 +5,6 @@ import (
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
_ "github.com/mattn/go-sqlite3"
|
||||
"github.com/owncast/owncast/core/chat/events"
|
||||
"github.com/owncast/owncast/core/data"
|
||||
"github.com/owncast/owncast/core/user"
|
||||
@@ -33,11 +32,12 @@ func setupPersistence() {
|
||||
}()
|
||||
}
|
||||
|
||||
// SaveUserMessage will save a single chat event to the messages database.
|
||||
func SaveUserMessage(event events.UserMessageEvent) {
|
||||
saveEvent(event.Id, event.User.Id, event.Body, event.Type, event.HiddenAt, event.Timestamp)
|
||||
saveEvent(event.ID, event.User.ID, event.Body, event.Type, event.HiddenAt, event.Timestamp)
|
||||
}
|
||||
|
||||
func saveEvent(id string, userId string, body string, eventType string, hidden *time.Time, timestamp time.Time) {
|
||||
func saveEvent(id string, userID string, body string, eventType string, hidden *time.Time, timestamp time.Time) {
|
||||
defer func() {
|
||||
_historyCache = nil
|
||||
}()
|
||||
@@ -61,7 +61,7 @@ func saveEvent(id string, userId string, body string, eventType string, hidden *
|
||||
|
||||
defer stmt.Close()
|
||||
|
||||
if _, err = stmt.Exec(id, userId, body, eventType, hidden, timestamp); err != nil {
|
||||
if _, err = stmt.Exec(id, userID, body, eventType, hidden, timestamp); err != nil {
|
||||
log.Errorln("error saving", eventType, err)
|
||||
return
|
||||
}
|
||||
@@ -82,7 +82,7 @@ func getChat(query string) []events.UserMessageEvent {
|
||||
|
||||
for rows.Next() {
|
||||
var id string
|
||||
var userId string
|
||||
var userID string
|
||||
var body string
|
||||
var messageType models.EventType
|
||||
var hiddenAt *time.Time
|
||||
@@ -96,7 +96,7 @@ func getChat(query string) []events.UserMessageEvent {
|
||||
var userNameChangedAt *time.Time
|
||||
|
||||
// Convert a database row into a chat event
|
||||
err = rows.Scan(&id, &userId, &body, &messageType, &hiddenAt, ×tamp, &userDisplayName, &userDisplayColor, &userCreatedAt, &userDisabledAt, &previousUsernames, &userNameChangedAt)
|
||||
err = rows.Scan(&id, &userID, &body, &messageType, &hiddenAt, ×tamp, &userDisplayName, &userDisplayColor, &userCreatedAt, &userDisabledAt, &previousUsernames, &userNameChangedAt)
|
||||
if err != nil {
|
||||
log.Errorln("There is a problem converting query to chat objects. Please report this:", query)
|
||||
break
|
||||
@@ -120,7 +120,7 @@ func getChat(query string) []events.UserMessageEvent {
|
||||
}
|
||||
|
||||
user := user.User{
|
||||
Id: userId,
|
||||
ID: userID,
|
||||
AccessToken: "",
|
||||
DisplayName: *userDisplayName,
|
||||
DisplayColor: *userDisplayColor,
|
||||
@@ -133,7 +133,7 @@ func getChat(query string) []events.UserMessageEvent {
|
||||
message := events.UserMessageEvent{
|
||||
Event: events.Event{
|
||||
Type: messageType,
|
||||
Id: id,
|
||||
ID: id,
|
||||
Timestamp: timestamp,
|
||||
},
|
||||
UserEvent: events.UserEvent{
|
||||
@@ -154,6 +154,7 @@ func getChat(query string) []events.UserMessageEvent {
|
||||
|
||||
var _historyCache *[]events.UserMessageEvent
|
||||
|
||||
// GetChatModerationHistory will return all the chat messages suitable for moderation purposes.
|
||||
func GetChatModerationHistory() []events.UserMessageEvent {
|
||||
if _historyCache != nil {
|
||||
return *_historyCache
|
||||
@@ -168,6 +169,7 @@ func GetChatModerationHistory() []events.UserMessageEvent {
|
||||
return result
|
||||
}
|
||||
|
||||
// GetChatHistory will return all the chat messages suitable for returning as user-facing chat history.
|
||||
func GetChatHistory() []events.UserMessageEvent {
|
||||
// Get all visible messages
|
||||
var query = fmt.Sprintf("SELECT messages.id, user_id, body, eventType, hidden_at, timestamp, display_name, display_color, created_at, disabled_at, previous_names, namechanged_at FROM messages, users WHERE messages.user_id = users.id AND hidden_at IS NULL AND disabled_at IS NULL ORDER BY timestamp DESC LIMIT %d", maxBacklogNumber)
|
||||
@@ -181,9 +183,9 @@ func GetChatHistory() []events.UserMessageEvent {
|
||||
return m
|
||||
}
|
||||
|
||||
// SetMessageVisibilityForUserId will bulk change the visibility of messages for a user
|
||||
// SetMessageVisibilityForUserID will bulk change the visibility of messages for a user
|
||||
// and then send out visibility changed events to chat clients.
|
||||
func SetMessageVisibilityForUserId(userID string, visible bool) error {
|
||||
func SetMessageVisibilityForUserID(userID string, visible bool) error {
|
||||
defer func() {
|
||||
_historyCache = nil
|
||||
}()
|
||||
@@ -198,7 +200,7 @@ func SetMessageVisibilityForUserId(userID string, visible bool) error {
|
||||
}
|
||||
|
||||
for _, message := range messages {
|
||||
ids = append(ids, message.Id)
|
||||
ids = append(ids, message.ID)
|
||||
}
|
||||
|
||||
// Tell the clients to hide/show these messages.
|
||||
@@ -250,29 +252,29 @@ func saveMessageVisibility(messageIDs []string, visible bool) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func getMessageById(messageID string) (*events.UserMessageEvent, error) {
|
||||
func getMessageByID(messageID string) (*events.UserMessageEvent, error) {
|
||||
var query = "SELECT * FROM messages WHERE id = ?"
|
||||
row := _datastore.DB.QueryRow(query, messageID)
|
||||
|
||||
var id string
|
||||
var userId string
|
||||
var userID string
|
||||
var body string
|
||||
var eventType models.EventType
|
||||
var hiddenAt *time.Time
|
||||
var timestamp time.Time
|
||||
|
||||
err := row.Scan(&id, &userId, &body, &eventType, &hiddenAt, ×tamp)
|
||||
err := row.Scan(&id, &userID, &body, &eventType, &hiddenAt, ×tamp)
|
||||
if err != nil {
|
||||
log.Errorln(err)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
user := user.GetUserById(userId)
|
||||
user := user.GetUserByID(userID)
|
||||
|
||||
return &events.UserMessageEvent{
|
||||
events.Event{
|
||||
Type: eventType,
|
||||
Id: id,
|
||||
ID: id,
|
||||
Timestamp: timestamp,
|
||||
},
|
||||
events.UserEvent{
|
||||
|
||||
Reference in New Issue
Block a user