Add more static checks (#4)

* Add more static checks

Author: martin-majlis-s1

.github/workflows/code-quality.yaml

@@ -2,6 +2,8 @@ name: Check code quality
 
 on:
   push:
+    branches:
+      - main
   pull_request:
     branches:
       - main

.github/workflows/secrets-scanner.yaml

@@ -1,5 +1,11 @@
 name: TruffleHog Secrets Scan
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 permissions:
   actions: write  # Needed for skip-duplicate-jobs job

.pre-commit-config.yaml

@@ -26,35 +26,28 @@ repos:
     rev: v0.5.0
     hooks:
       - id: go-fmt
-      # - id: go-vet
       - id: go-imports
       - id: go-cyclo
       - id: validate-toml
       - id: no-go-testing
-      # - id: golangci-lint
+      - id: golangci-lint
       # - id: go-critic
       #  # args: [-disable=sloppyTypeAssert]
       #  args: ["-v", "-enable='yodaStyleExpr'", "-disable=sloppyTypeAssert"]
       - id: go-unit-tests
       - id: go-build
       - id: go-mod-tidy
       - id: go-mod-vendor
-#
-#  - repo: https://github.com/Bahjat/pre-commit-golang
-#    rev: v1.0.2
-#    hooks:
-#      - id: go-fmt-import
-#      - id: go-lint
-#      - id: go-unit-tests
-#      - id: gofumpt
-#      - id: go-err-check
-#      - id: go-static-check # install https://staticcheck.io/docs/
-#      - id: golangci-lint # requires github.com/golangci/golangci-lint
-#        args: [--config=.github/linters/.golangci.yml] # optional
-#      - id: go-ruleguard # requires https://github.com/quasilyte/go-ruleguard
-#        args: [rules/rules.go] # required
 
-#  - repo: https://github.com/pre-commit/mirrors-prettier
-#    rev: "v2.7.1"
-#    hooks:
-#      - id: prettier
+  - repo: https://github.com/Bahjat/pre-commit-golang
+    rev: v1.0.2
+    hooks:
+      - id: go-fmt-import
+      - id: go-lint
+      # - id: go-unit-tests
+      - id: gofumpt
+      - id: go-err-check
+      - id: go-static-check
+      - id: golangci-lint
+      # - id: go-ruleguard # requires https://github.com/quasilyte/go-ruleguard
+      #    args: [rules/rules.go] # required

examples/client/main.go

@@ -27,9 +27,11 @@ import (
 	"go.uber.org/zap"
 )
 
-const BundleCount = 10000
-const BatchSize = 100
-const BatchDelay = time.Second
+const (
+	BundleCount = 10000
+	BatchSize   = 100
+	BatchDelay  = time.Second
+)
 
 func main() {
 	// read configuration from env variables

pkg/api/add_events/add_events.go

@@ -66,7 +66,6 @@ type SessionInfo struct {
 }
 
 type AddEventsRequestParams struct {
-	Token       string       `json:"token,omitempty"`
 	Session     string       `json:"session,omitempty"`
 	SessionInfo *SessionInfo `json:"sessionInfo,omitempty"`
 	Events      []*Event     `json:"events,omitempty"`
@@ -89,7 +88,6 @@ func (response *AddEventsResponse) SetResponseObj(resp *http.Response) {
 }
 
 func TrimAttrs(attrs map[string]interface{}, remaining int) map[string]interface{} {
-
 	keys := make([]string, 0, len(attrs))
 	lengths := make(map[string]int)
 
@@ -161,16 +159,15 @@ func TrimAttrs(attrs map[string]interface{}, remaining int) map[string]interface
 						zap.Int("remaining", remaining),
 					)
 					*/
-				} else {
-					/* TODO: IMP - Log this info
+				} /* else {
+					// TODO: IMP - Log this info
 					add_events.Logger.Error(
 						"Event attribute too long - skipping",
 						zap.String("key", key),
 						zap.Int("originalLen", lengths[key]),
 						zap.Int("remaining", remaining),
 					)
-					*/
-				}
+				} */
 			}
 		}
 	}

pkg/api/add_events/add_events_test.go

@@ -55,6 +55,7 @@ func (s *SuiteAddEvents) TestTrimAttrsTrimLongest(assert, require *td.T) {
 
 	assert.Cmp(TrimAttrs(attrs, 44), expected)
 }
+
 func (s *SuiteAddEvents) TestTrimAttrsSkipLongest(assert, require *td.T) {
 	attrs := map[string]interface{}{
 		"foo": "aaaaaa",
@@ -84,6 +85,7 @@ func (s *SuiteAddEvents) TestTrimAttrsSkipLongestAndTrim(assert, require *td.T)
 
 	assert.Cmp(TrimAttrs(attrs, 26), expected)
 }
+
 func (s *SuiteAddEvents) TestTrimAttrsSkipLongestAndTrimFully(assert, require *td.T) {
 	attrs := map[string]interface{}{
 		"foo": "aaaaaa",
@@ -98,6 +100,7 @@ func (s *SuiteAddEvents) TestTrimAttrsSkipLongestAndTrimFully(assert, require *t
 
 	assert.Cmp(TrimAttrs(attrs, 24), expected)
 }
+
 func (s *SuiteAddEvents) TestTrimAttrsSkipAll(assert, require *td.T) {
 	attrs := map[string]interface{}{
 		"foo": "aaaaaa",

pkg/buffer/buffer.go

@@ -21,15 +21,19 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/scalyr/dataset-go/pkg/api/request"
+
 	"github.com/scalyr/dataset-go/pkg/api/add_events"
 
 	"github.com/google/uuid"
 
 	"go.uber.org/zap"
 )
 
-const ShouldSentBufferSize = 5 * 1024 * 1024
-const LimitBufferSize = 5*1024*1024 + 960*1024
+const (
+	ShouldSentBufferSize = 5 * 1024 * 1024
+	LimitBufferSize      = 5*1024*1024 + 960*1024
+)
 
 const (
 	Ready = /*Status*/ iota
@@ -74,10 +78,7 @@ type Buffer struct {
 }
 
 func NewEmptyBuffer(session string, token string) *Buffer {
-	id, err := uuid.NewRandom()
-	if err != nil {
-		//return nil, fmt.Errorf(err, "buffer: it was not possible to generate UUID")
-	}
+	id, _ := uuid.NewRandom()
 
 	return &Buffer{Id: id, Session: session, Token: token, Status: Ready, Attempt: 0}
 }
@@ -141,7 +142,6 @@ func (buffer *Buffer) Reset() {
 }
 
 func (buffer *Buffer) AddBundle(bundle *add_events.EventBundle) (AddStatus, error) {
-
 	// append thread
 	addT, errT := buffer.addThread(bundle.Thread)
 	if errT != nil {
@@ -316,7 +316,7 @@ func (buffer *Buffer) ShouldSendSize() bool {
 }
 
 func (buffer *Buffer) ShouldSendAge(delay time.Duration) bool {
-	return buffer.countEvents > 0 && time.Now().Sub(buffer.bufferSent) > delay
+	return buffer.countEvents > 0 && time.Since(buffer.bufferSent) > delay
 }
 
 func (buffer *Buffer) BufferLengths() int {
@@ -346,13 +346,17 @@ func (buffer *Buffer) Payload() ([]byte, error) {
 		logs = append(logs, l)
 	}
 
-	reqObject := add_events.AddEventsRequestParams{
-		Token:       buffer.Token,
-		Session:     buffer.Session,
-		SessionInfo: buffer.sessionInfo,
-		Events:      buffer.events,
-		Threads:     threads,
-		Logs:        logs,
+	reqObject := add_events.AddEventsRequest{
+		AuthParams: request.AuthParams{
+			Token: buffer.Token,
+		},
+		AddEventsRequestParams: add_events.AddEventsRequestParams{
+			Session:     buffer.Session,
+			SessionInfo: buffer.sessionInfo,
+			Events:      buffer.events,
+			Threads:     threads,
+			Logs:        logs,
+		},
 	}
 
 	payload, err := json.Marshal(reqObject)
@@ -374,7 +378,7 @@ func (buffer *Buffer) ZapStats(fields ...zap.Field) []zap.Field {
 		zap.Int("events", buffer.countEvents),
 		zap.Int("bufferLength", buffer.BufferLengths()),
 		zap.Float64("bufferRatio", float64(buffer.BufferLengths())/ShouldSentBufferSize),
-		zap.Int64("sinceLastMs", time.Now().Sub(buffer.bufferSent).Milliseconds()),
+		zap.Int64("sinceLastMs", time.Since(buffer.bufferSent).Milliseconds()),
 	}
 	res = append(res, fields...)
 	return res

pkg/buffer/buffer_test.go

@@ -46,28 +46,27 @@ func loadJson(name string) string {
 }
 
 func (s *SuiteBuffer) TestEmptyPayloadShouldFail(assert, require *td.T) {
-
 	buffer, err := NewBuffer("id", nil, "token")
 	assert.Nil(err)
 	_, err = buffer.Payload()
 	assert.CmpError(err, "there is no event")
 }
-func (s *SuiteBuffer) TestEmptyTokenShouldFail(assert, require *td.T) {
 
+func (s *SuiteBuffer) TestEmptyTokenShouldFail(assert, require *td.T) {
 	buffer, err := NewBuffer("id", nil, "")
 	assert.Nil(err)
 	_, err = buffer.Payload()
 	assert.CmpError(err, "token is missing")
 }
-func (s *SuiteBuffer) TestEmptySessionShouldFail(assert, require *td.T) {
 
+func (s *SuiteBuffer) TestEmptySessionShouldFail(assert, require *td.T) {
 	buffer, err := NewBuffer("", nil, "token")
 	assert.Nil(err)
 	_, err = buffer.Payload()
 	assert.CmpError(err, "session is missing")
 }
-func (s *SuiteBuffer) TestPayloadFull(assert, require *td.T) {
 
+func (s *SuiteBuffer) TestPayloadFull(assert, require *td.T) {
 	sessionInfo := &add_events.SessionInfo{
 		ServerId:   "serverId",
 		ServerType: "serverType",
@@ -110,7 +109,7 @@ func (s *SuiteBuffer) TestPayloadFull(assert, require *td.T) {
 	payload, err := buffer.Payload()
 	assert.Nil(err)
 
-	params := add_events.AddEventsRequestParams{}
+	params := add_events.AddEventsRequest{}
 	err = json.Unmarshal(payload, &params)
 	assert.Nil(err)
 	assert.Cmp(params.Session, session)
@@ -129,8 +128,8 @@ func (s *SuiteBuffer) TestPayloadFull(assert, require *td.T) {
 	}
 	assert.Cmp(payload, []byte(expected))
 }
-func (s *SuiteBuffer) TestPayloadInjection(assert, require *td.T) {
 
+func (s *SuiteBuffer) TestPayloadInjection(assert, require *td.T) {
 	sessionInfo := &add_events.SessionInfo{
 		ServerId:   "serverId\",\"sI\":\"I",
 		ServerType: "serverType\",\"sT\":\"T",
@@ -150,7 +149,8 @@ func (s *SuiteBuffer) TestPayloadInjection(assert, require *td.T) {
 			Attrs: map[string]interface{}{
 				"LAttr1\",\"i\":\"i": "LVal1\",\"i\":\"i",
 				"LAttr2\",\"i\":\"i": "LVal2\",\"i\":\"i",
-			}},
+			},
+		},
 		Thread: &add_events.Thread{Id: "TId\",\"i\":\"i", Name: "TName\",\"i\":\"i"},
 		Event: &add_events.Event{
 			Thread: "TId\",\"i\":\"i",
@@ -175,7 +175,7 @@ func (s *SuiteBuffer) TestPayloadInjection(assert, require *td.T) {
 	payload, err := buffer.Payload()
 	assert.Nil(err)
 
-	params := add_events.AddEventsRequestParams{}
+	params := add_events.AddEventsRequest{}
 	err = json.Unmarshal(payload, &params)
 	assert.Nil(err)
 	assert.Cmp(params.Session, session)

pkg/client/add_events.go

@@ -51,7 +51,6 @@ func (client *DataSetClient) DangerousNaiveAddEvents(events []*add_events.Event,
 		"POST",
 		client.Config.Endpoint+"/api/addEvents",
 	).WithWriteLog(client.Config.Tokens).JsonRequest(apiRequest).HttpRequest()
-
 	if err != nil {
 		return nil, fmt.Errorf("cannot create request: %w", err)
 	}
@@ -138,7 +137,6 @@ func (client *DataSetClient) SendAddEventsBuffer(buf *buffer.Buffer) (*add_event
 	httpRequest, err := request.NewRequest(
 		"POST", client.Config.Endpoint+"/api/addEvents",
 	).WithWriteLog(client.Config.Tokens).RawRequest(payload).HttpRequest()
-
 	if err != nil {
 		return nil, fmt.Errorf("cannot create request: %w", err)
 	}
@@ -163,7 +161,12 @@ func (client *DataSetClient) apiCall(req *http.Request, response response.SetRes
 		return fmt.Errorf("unable to send request: %w", err)
 	}
 
-	defer resp.Body.Close()
+	defer func() {
+		if err = resp.Body.Close(); err != nil {
+			client.Logger.Error("Error when closing:", zap.Error(err))
+		}
+	}()
+
 	// foo
 	client.Logger.Debug("Received response",
 		zap.Int("statusCode", resp.StatusCode),