Fix Go linter issues, add Latte linter to the CI

.gitlab-ci.yml

@@ -16,7 +16,7 @@ syntax:7.4:
 
 sniffer:
   stage: test
-  image: remp/php-ci:7.4.15
+  image: remp/php-ci:7.4.29
   tags:
     - docker
   script:
@@ -25,26 +25,35 @@ sniffer:
 
 phpstan:
   stage: test
-  image: remp/php-ci:7.4.15
+  image: remp/php-ci:7.4.29
   tags:
     - docker
   script:
     - make composer-install
     - make phpstan
 
+latte_lint:
+  stage: test
+  image: remp/php-ci:7.4.29
+  tags:
+    - docker
+  script:
+    - make composer-install
+    - make latte-lint
+
 tests:
   stage: test
-  image: remp/php-ci:7.4.15
+  image: remp/php-ci:7.4.29
   tags:
     - docker
   script:
     - make composer-install
     - make copy-env    
     - make phpunit
   services:
-    - name: mysql:5.7.21
+    - name: mysql:8.0.29
       alias: mysql
-    - name: redis:3.2
+    - name: redis:6.2
       alias: redis
   variables:
       MYSQL_DATABASE: remp_test

Beam/Makefile

@@ -20,7 +20,7 @@ lint: lint-lib
 	@cd $(SUB_SEGMENTS) && make lint
 
 vet-lib:
-	@go vet $$(go list ./... | grep -vE '(/vendor|/cmd)')
+	@go vet $$(go list go/... | grep -vE '(/vendor|/cmd)')
 
 vet: vet-lib
 	@cd $(SUB_TRACKER) && make vet

Beam/go/cmd/tracker/Makefile

@@ -48,8 +48,8 @@ install: gen
 
 lint:
 	set -e; \
-	for package in $$(go list ./... | grep -vE '(/app|/design|/swagger|/client|/tool|/test)'); \
+	for package in $$(go list ./... | grep -vE '(/app|/design|/swagger|/client|/tool|/test|/data)'); \
 	do golint -set_exit_status=true $$package; done
 
 vet:
-	go vet $$(go list ./... | grep -vE '(/app|/design|/swagger|/client|/tool|/test)')
+	go vet $$(go list ./... | grep -vE '(/app|/design|/swagger|/client|/tool|/test|/data)')

Beam/go/cmd/tracker/config.go

@@ -17,10 +17,10 @@ type Config struct {
 
 	InternalHosts string `envconfig:"internal_hosts" required:"false"`
 
-	TimespentLimit int `envconfig:"timespent_limit" required:"false" default:0`
+	TimespentLimit int `envconfig:"timespent_limit" required:"false" default:"0"`
 
 	BrokerImpl string `envconfig:"broker_impl" required:"false" default:"kafka"`
 
-	PubSubProjectId string `envconfig:"pubsub_project_id" required:"false"`
-	PubSubTopicId   string `envconfig:"pubsub_topic_id" required:"false"`
+	PubSubProjectID string `envconfig:"pubsub_project_id" required:"false"`
+	PubSubTopicID   string `envconfig:"pubsub_topic_id" required:"false"`
 }

Beam/go/cmd/tracker/controller/event_producer.go

@@ -5,8 +5,13 @@ import (
 	"time"
 )
 
+// EventProducer provides a method to produce and publish the tracked events as messages.
+//
+// The messages are published to the configured message queue implementation.
 type EventProducer interface {
+	// Produce generates a message and passes it to the message queue broker.
 	Produce(ctx context.Context, table string, time time.Time, data map[string]any) error
 
+	// Close closes any channels or connections that are opened by the producer.
 	Close() error
 }

Beam/go/cmd/tracker/controller/kafka_event_producer.go

@@ -52,6 +52,7 @@ func NewKafkaEventProducer(brokerAddrs []string, saslConfig *SaslConfig) (*Kafka
 	}, nil
 }
 
+// Produce generates a message in the influx-data format and passes it to the configured Kafka instance.
 func (kep KafkaEventProducer) Produce(ctx context.Context, table string, time time.Time, data map[string]any) error {
 	p, err := influxClient.NewPoint(table, nil, data, time)
 	if err != nil {
@@ -64,6 +65,7 @@ func (kep KafkaEventProducer) Produce(ctx context.Context, table string, time ti
 	return nil
 }
 
+// Close closes the connection to the Kafka event producer.
 func (kep KafkaEventProducer) Close() error {
 	return kep.EventProducer.Close()
 }

Beam/go/cmd/tracker/controller/pubsub_event_producer.go

@@ -10,26 +10,26 @@ import (
 	"github.com/pkg/errors"
 )
 
-// Implementation of EventProducer
+// PubSubEventProducer is a Cloud PubSub implementation of EventProducer interface.
 type PubSubEventProducer struct {
 	client pubsub.Client
 	topic  pubsub.Topic
 }
 
 // NewPubSubEventProducer creates new PubSubEventProducer
-func NewPubSubEventProducer(ctx context.Context, projectId string, topicId string) (*PubSubEventProducer, error) {
-	client, err := pubsub.NewClient(ctx, projectId)
+func NewPubSubEventProducer(ctx context.Context, projectID string, topicID string) (*PubSubEventProducer, error) {
+	client, err := pubsub.NewClient(ctx, projectID)
 	if err != nil {
 		return nil, err
 	}
 
-	topic := client.Topic(topicId)
+	topic := client.Topic(topicID)
 	ok, err := topic.Exists(ctx)
 	if err != nil {
 		return nil, err
 	}
 	if !ok {
-		return nil, errors.Errorf("PubSub: topic %q doesn't exist.", topicId)
+		return nil, errors.Errorf("PubSub: topic %q doesn't exist.", topicID)
 	}
 
 	return &PubSubEventProducer{
@@ -38,6 +38,7 @@ func NewPubSubEventProducer(ctx context.Context, projectId string, topicId strin
 	}, nil
 }
 
+// Produce generates a message and passes it to the configured Cloud Pub/Sub interface.
 func (psep PubSubEventProducer) Produce(ctx context.Context, table string, time time.Time, data map[string]any) error {
 	p, err := influxClient.NewPoint(table, nil, data, time)
 	if err != nil {
@@ -58,6 +59,7 @@ func (psep PubSubEventProducer) Produce(ctx context.Context, table string, time
 	return nil
 }
 
+// Close closes the connection with the Cloud Pub/Sub client.
 func (psep PubSubEventProducer) Close() error {
 	return psep.client.Close()
 }

Beam/go/cmd/tracker/main.go

@@ -192,8 +192,8 @@ func newProducer(ctx context.Context, config *Config, service *goa.Service) (con
 		return producer, nil
 
 	case "pubsub":
-		service.LogInfo("connecting to pubsub", "projectID", config.PubSubProjectId, "topicID", config.PubSubTopicId)
-		producer, err := controller.NewPubSubEventProducer(ctx, config.PubSubProjectId, config.PubSubTopicId)
+		service.LogInfo("connecting to pubsub", "projectID", config.PubSubProjectID, "topicID", config.PubSubTopicID)
+		producer, err := controller.NewPubSubEventProducer(ctx, config.PubSubProjectID, config.PubSubTopicID)
 		if err != nil {
 			return nil, err
 		}

Mailer/Makefile

@@ -31,4 +31,7 @@ syntax:
 	find ${PHP_FOLDERS} -name "*.php" -print0 | xargs -0 -n1 -P8 php -l
 
 phpstan:
-	php vendor/bin/phpstan analyse --configuration=.phpstan.neon --level=1 --memory-limit=1G app tests extensions
+	php vendor/bin/phpstan analyse --level=1 --memory-limit=1G app tests extensions
+
+latte-lint:
+	php vendor/bin/latte-lint app extensions

Makefile

@@ -46,6 +46,9 @@ phpstan:
 lint:
 	cd $(SUB_BEAM) && make lint
 
+latte-lint:
+	cd $(SUB_MAILER) && make latte-lint
+
 vet:
 	cd $(SUB_BEAM) && make vet