From d9a28c12449b117c6b6fd737309aefa25f689dcd Mon Sep 17 00:00:00 2001 From: Agniva De Sarker Date: Fri, 30 Jun 2023 20:12:56 +0530 Subject: [PATCH] MM-52532: Fix golangci warnings for public module (#23918) https://mattermost.atlassian.net/browse/MM-52532 ```release-note NONE ``` --- server/.golangci.yml | 4 -- server/public/model/bot.go | 4 +- server/public/model/channel.go | 8 ++-- server/public/model/cluster_discovery.go | 6 +-- server/public/model/compliance.go | 4 +- server/public/model/file_info_list.go | 2 +- server/public/model/post.go | 30 ++++++------- server/public/model/post_list.go | 24 +++++----- server/public/model/post_search_results.go | 12 ++--- server/public/model/push_notification.go | 4 +- server/public/model/utils_test.go | 2 +- server/public/model/websocket_message.go | 44 +++++++++---------- server/public/model/websocket_message_test.go | 6 +-- 13 files changed, 73 insertions(+), 77 deletions(-) diff --git a/server/.golangci.yml b/server/.golangci.yml index c7134dcf21..72910b0ff3 100644 --- a/server/.golangci.yml +++ b/server/.golangci.yml @@ -44,10 +44,6 @@ issues: text: "var-naming|error-naming|exported|increment-decrement|error-strings|if-return|unused-parameter|blank-imports|context-as-argument|empty-block" # We need to fix the unused parameter issues and remove the exception. - - linters: - - revive - path: "public/*" # TODO: fix this - - linters: - revive path: "enterprise" # TODO: fix this diff --git a/server/public/model/bot.go b/server/public/model/bot.go index 4b1c47932b..4b8f84fca3 100644 --- a/server/public/model/bot.go +++ b/server/public/model/bot.go @@ -81,8 +81,8 @@ func (b *Bot) Trace() map[string]any { // Clone returns a shallow copy of the bot. func (b *Bot) Clone() *Bot { - copy := *b - return © + bCopy := *b + return &bCopy } // IsValidCreate validates bot for Create call. This skips validations of fields that are auto-filled on Create diff --git a/server/public/model/channel.go b/server/public/model/channel.go index 40dcb834fa..7c8e979bec 100644 --- a/server/public/model/channel.go +++ b/server/public/model/channel.go @@ -243,11 +243,11 @@ func (o *Channel) Props_() StringInterface { } func (o *Channel) DeepCopy() *Channel { - copy := *o - if copy.SchemeId != nil { - copy.SchemeId = NewString(*o.SchemeId) + cCopy := *o + if cCopy.SchemeId != nil { + cCopy.SchemeId = NewString(*o.SchemeId) } - return © + return &cCopy } func (o *Channel) Etag() string { diff --git a/server/public/model/cluster_discovery.go b/server/public/model/cluster_discovery.go index 160a59170a..0a60dd6be3 100644 --- a/server/public/model/cluster_discovery.go +++ b/server/public/model/cluster_discovery.go @@ -76,14 +76,14 @@ func (o *ClusterDiscovery) IsEqual(in *ClusterDiscovery) bool { } func FilterClusterDiscovery(vs []*ClusterDiscovery, f func(*ClusterDiscovery) bool) []*ClusterDiscovery { - copy := make([]*ClusterDiscovery, 0) + cdCopy := make([]*ClusterDiscovery, 0) for _, v := range vs { if f(v) { - copy = append(copy, v) + cdCopy = append(cdCopy, v) } } - return copy + return cdCopy } func (o *ClusterDiscovery) IsValid() *AppError { diff --git a/server/public/model/compliance.go b/server/public/model/compliance.go index 7129701e2e..0385707c25 100644 --- a/server/public/model/compliance.go +++ b/server/public/model/compliance.go @@ -81,8 +81,8 @@ func (c *Compliance) PreSave() { } func (c *Compliance) DeepCopy() *Compliance { - copy := *c - return © + cCopy := *c + return &cCopy } func (c *Compliance) JobName() string { diff --git a/server/public/model/file_info_list.go b/server/public/model/file_info_list.go index e5de2d076b..3e7cb4fca5 100644 --- a/server/public/model/file_info_list.go +++ b/server/public/model/file_info_list.go @@ -92,7 +92,7 @@ func (o *FileInfoList) SortByCreateAt() { func (o *FileInfoList) Etag() string { id := "0" - var t int64 = 0 + var t int64 for _, v := range o.FileInfos { if v.UpdateAt > t { diff --git a/server/public/model/post.go b/server/public/model/post.go index 066148a667..ce5963252d 100644 --- a/server/public/model/post.go +++ b/server/public/model/post.go @@ -207,11 +207,11 @@ type AnalyticsPostCountsOptions struct { } func (o *PostPatch) WithRewrittenImageURLs(f func(string) string) *PostPatch { - copy := *o //nolint:revive - if copy.Message != nil { - *copy.Message = RewriteImageURLs(*o.Message, f) + pCopy := *o //nolint:revive + if pCopy.Message != nil { + *pCopy.Message = RewriteImageURLs(*o.Message, f) } - return © + return &pCopy } func (o *PostPatch) Auditable() map[string]interface{} { @@ -296,15 +296,15 @@ func (o *Post) ShallowCopy(dst *Post) error { // Clone shallowly copies the post and returns the copy. func (o *Post) Clone() *Post { - copy := &Post{} //nolint:revive - o.ShallowCopy(copy) - return copy + pCopy := &Post{} //nolint:revive + o.ShallowCopy(pCopy) + return pCopy } func (o *Post) ToJSON() (string, error) { - copy := o.Clone() //nolint:revive - copy.StripActionIntegrations() - b, err := json.Marshal(copy) + pCopy := o.Clone() //nolint:revive + pCopy.StripActionIntegrations() + b, err := json.Marshal(pCopy) return string(b), err } @@ -707,12 +707,12 @@ var markdownDestinationEscaper = strings.NewReplacer( // WithRewrittenImageURLs returns a new shallow copy of the post where the message has been // rewritten via RewriteImageURLs. func (o *Post) WithRewrittenImageURLs(f func(string) string) *Post { - copy := o.Clone() - copy.Message = RewriteImageURLs(o.Message, f) - if copy.MessageSource == "" && copy.Message != o.Message { - copy.MessageSource = o.Message + pCopy := o.Clone() + pCopy.Message = RewriteImageURLs(o.Message, f) + if pCopy.MessageSource == "" && pCopy.Message != o.Message { + pCopy.MessageSource = o.Message } - return copy + return pCopy } // RewriteImageURLs takes a message and returns a copy that has all of the image URLs replaced diff --git a/server/public/model/post_list.go b/server/public/model/post_list.go index 093ead6d50..18279ec684 100644 --- a/server/public/model/post_list.go +++ b/server/public/model/post_list.go @@ -47,11 +47,11 @@ func (o *PostList) Clone() *PostList { } func (o *PostList) ForPlugin() *PostList { - copy := o.Clone() - for k, p := range copy.Posts { - copy.Posts[k] = p.ForPlugin() + plCopy := o.Clone() + for k, p := range plCopy.Posts { + plCopy.Posts[k] = p.ForPlugin() } - return copy + return plCopy } func (o *PostList) ToSlice() []*Post { @@ -68,12 +68,12 @@ func (o *PostList) ToSlice() []*Post { } func (o *PostList) WithRewrittenImageURLs(f func(string) string) *PostList { - copy := *o - copy.Posts = make(map[string]*Post) + plCopy := *o + plCopy.Posts = make(map[string]*Post) for id, post := range o.Posts { - copy.Posts[id] = post.WithRewrittenImageURLs(f) + plCopy.Posts[id] = post.WithRewrittenImageURLs(f) } - return © + return &plCopy } func (o *PostList) StripActionIntegrations() { @@ -87,9 +87,9 @@ func (o *PostList) StripActionIntegrations() { } func (o *PostList) ToJSON() (string, error) { - copy := *o - copy.StripActionIntegrations() - b, err := json.Marshal(©) + plCopy := *o + plCopy.StripActionIntegrations() + b, err := json.Marshal(&plCopy) return string(b), err } @@ -164,7 +164,7 @@ func (o *PostList) SortByCreateAt() { func (o *PostList) Etag() string { id := "0" - var t int64 = 0 + var t int64 for _, v := range o.Posts { if v.UpdateAt > t { diff --git a/server/public/model/post_search_results.go b/server/public/model/post_search_results.go index 23511039a7..3de3e817b7 100644 --- a/server/public/model/post_search_results.go +++ b/server/public/model/post_search_results.go @@ -23,9 +23,9 @@ func MakePostSearchResults(posts *PostList, matches PostSearchMatches) *PostSear } func (o *PostSearchResults) ToJSON() (string, error) { - copy := *o - copy.PostList.StripActionIntegrations() - b, err := json.Marshal(©) + psCopy := *o + psCopy.PostList.StripActionIntegrations() + b, err := json.Marshal(&psCopy) return string(b), err } @@ -35,7 +35,7 @@ func (o *PostSearchResults) EncodeJSON(w io.Writer) error { } func (o *PostSearchResults) ForPlugin() *PostSearchResults { - copy := *o - copy.PostList = copy.PostList.ForPlugin() - return © + plCopy := *o + plCopy.PostList = plCopy.PostList.ForPlugin() + return &plCopy } diff --git a/server/public/model/push_notification.go b/server/public/model/push_notification.go index 09a645ea38..b2e6f94770 100644 --- a/server/public/model/push_notification.go +++ b/server/public/model/push_notification.go @@ -70,8 +70,8 @@ type PushNotification struct { } func (pn *PushNotification) DeepCopy() *PushNotification { - copy := *pn - return © + pnCopy := *pn + return &pnCopy } func (pn *PushNotification) SetDeviceIdAndPlatform(deviceId string) { diff --git a/server/public/model/utils_test.go b/server/public/model/utils_test.go index 7b5e099e96..406aa95865 100644 --- a/server/public/model/utils_test.go +++ b/server/public/model/utils_test.go @@ -677,7 +677,7 @@ func TestNowhereNil(t *testing.T) { t.Parallel() var nilStringPtr *string - var nonNilStringPtr *string = new(string) + var nonNilStringPtr = new(string) var nilSlice []string var nilStruct *struct{} var nilMap map[bool]bool diff --git a/server/public/model/websocket_message.go b/server/public/model/websocket_message.go index a4ffaf61c5..41cfc51896 100644 --- a/server/public/model/websocket_message.go +++ b/server/public/model/websocket_message.go @@ -177,16 +177,16 @@ type WebSocketEvent struct { // PrecomputeJSON precomputes and stores the serialized JSON for all fields other than Sequence. // This makes ToJSON much more efficient when sending the same event to multiple connections. func (ev *WebSocketEvent) PrecomputeJSON() *WebSocketEvent { - copy := ev.Copy() - event, _ := json.Marshal(copy.event) - data, _ := json.Marshal(copy.data) - broadcast, _ := json.Marshal(copy.broadcast) - copy.precomputedJSON = &precomputedWebSocketEventJSON{ + evCopy := ev.Copy() + event, _ := json.Marshal(evCopy.event) + data, _ := json.Marshal(evCopy.data) + broadcast, _ := json.Marshal(evCopy.broadcast) + evCopy.precomputedJSON = &precomputedWebSocketEventJSON{ Event: json.RawMessage(event), Data: json.RawMessage(data), Broadcast: json.RawMessage(broadcast), } - return copy + return evCopy } func (ev *WebSocketEvent) Add(key string, value any) { @@ -207,14 +207,14 @@ func NewWebSocketEvent(event, teamId, channelId, userId string, omitUsers map[st } func (ev *WebSocketEvent) Copy() *WebSocketEvent { - copy := &WebSocketEvent{ + evCopy := &WebSocketEvent{ event: ev.event, data: ev.data, broadcast: ev.broadcast, sequence: ev.sequence, precomputedJSON: ev.precomputedJSON, } - return copy + return evCopy } func (ev *WebSocketEvent) DeepCopy() *WebSocketEvent { @@ -226,14 +226,14 @@ func (ev *WebSocketEvent) DeepCopy() *WebSocketEvent { } } - copy := &WebSocketEvent{ + evCopy := &WebSocketEvent{ event: ev.event, data: dataCopy, broadcast: ev.broadcast.copy(), sequence: ev.sequence, precomputedJSON: ev.precomputedJSON.copy(), } - return copy + return evCopy } func (ev *WebSocketEvent) GetData() map[string]any { @@ -249,27 +249,27 @@ func (ev *WebSocketEvent) GetSequence() int64 { } func (ev *WebSocketEvent) SetEvent(event string) *WebSocketEvent { - copy := ev.Copy() - copy.event = event - return copy + evCopy := ev.Copy() + evCopy.event = event + return evCopy } func (ev *WebSocketEvent) SetData(data map[string]any) *WebSocketEvent { - copy := ev.Copy() - copy.data = data - return copy + evCopy := ev.Copy() + evCopy.data = data + return evCopy } func (ev *WebSocketEvent) SetBroadcast(broadcast *WebsocketBroadcast) *WebSocketEvent { - copy := ev.Copy() - copy.broadcast = broadcast - return copy + evCopy := ev.Copy() + evCopy.broadcast = broadcast + return evCopy } func (ev *WebSocketEvent) SetSequence(seq int64) *WebSocketEvent { - copy := ev.Copy() - copy.sequence = seq - return copy + evCopy := ev.Copy() + evCopy.sequence = seq + return evCopy } func (ev *WebSocketEvent) IsValid() bool { diff --git a/server/public/model/websocket_message_test.go b/server/public/model/websocket_message_test.go index 118ed85de4..b6092a26eb 100644 --- a/server/public/model/websocket_message_test.go +++ b/server/public/model/websocket_message_test.go @@ -70,11 +70,11 @@ func TestWebSocketEventImmutable(t *testing.T) { require.Equal(t, newM.data, data) require.Equal(t, newM.data, newM.GetData()) - copy := m.Copy() - if copy == m { + mCopy := m.Copy() + if mCopy == m { require.Fail(t, "pointers should not be the same") } - require.Equal(t, m, copy) + require.Equal(t, m, mCopy) } func TestWebSocketEventFromJSON(t *testing.T) {