monitor: replaced basic RPC with gRPC

Author: mvisonneau

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [0ver](https://0ver.org) (more or less).
 - Upgraded most dependencies to their lastest versions
 - Fixed child pipeline jobs not found whilst looking up through bridges (#345)
 - `gitlab_ci_pipeline_job_queued_duration_seconds` & `gitlab_ci_pipeline_queued_duration_seconds` will now be leveraging the value returned through the GitLab API instead of computing it with (startedAt - createdAt)
+- Refactored the RPC layer used for CLI monitoring with gRPC
 
 ## [v0.5.3] - 2022-02-11
 

Makefile

@@ -7,8 +7,6 @@ REPOSITORY    := mvisonneau/$(NAME)
 setup: ## Install required libraries/tools for build tasks
 	@command -v gofumpt 2>&1 >/dev/null       || go install mvdan.cc/[email protected]
 	@command -v golangci-lint 2>&1 >/dev/null || go install github.com/golangci/golangci-lint/cmd/[email protected]
-	@command -v protoc 2>&1 >/dev/null        || (echo "protoc needs to be available in PATH: https://github.com/protocolbuffers/protobuf/releases"; false)
-	@command -v protoc-gen-go 2>&1 >/dev/null || go install google.golang.org/grpc/cmd/[email protected]
 
 .PHONY: fmt
 fmt: setup ## Format source code
@@ -38,7 +36,9 @@ release: ## Build & release the binaries (stable)
 
 .PHONY: protoc
 protoc: setup ## Generate golang from .proto files
-	@protoc \
+	@command -v protoc 2>&1 >/dev/null        || (echo "protoc needs to be available in PATH: https://github.com/protocolbuffers/protobuf/releases"; false)
+	@command -v protoc-gen-go 2>&1 >/dev/null || go install google.golang.org/grpc/cmd/[email protected]
+	protoc \
 		--go_out=. --go_opt=paths=source_relative \
 		--go-grpc_out=. --go-grpc_opt=paths=source_relative \
 		pkg/monitor/protobuf/monitor.proto

internal/cmd/monitor.go

@@ -1,8 +1,6 @@
 package cmd
 
 import (
-	"context"
-
 	monitorUI "github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/monitor/ui"
 	"github.com/urfave/cli/v2"
 )
@@ -15,7 +13,6 @@ func Monitor(ctx *cli.Context) (int, error) {
 	}
 
 	monitorUI.Start(
-		context.Background(),
 		ctx.App.Version,
 		cfg.InternalMonitoringListenerAddress,
 	)

pkg/monitor/client/client.go

@@ -18,6 +18,7 @@ type Client struct {
 // NewClient ..
 func NewClient(ctx context.Context, endpoint *url.URL) *Client {
 	log.WithField("endpoint", endpoint.String()).Debug("establishing gRPC connection to the server..")
+
 	conn, err := grpc.DialContext(
 		ctx,
 		endpoint.String(),

pkg/monitor/server/server.go

@@ -9,13 +9,12 @@ import (
 	"github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/config"
 	"github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/gitlab"
 	"github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/monitor"
+	pb "github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/monitor/protobuf"
 	"github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/schemas"
 	"github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/store"
+	log "github.com/sirupsen/logrus"
 	"google.golang.org/grpc"
 	"google.golang.org/protobuf/types/known/timestamppb"
-
-	pb "github.com/mvisonneau/gitlab-ci-pipelines-exporter/pkg/monitor/protobuf"
-	log "github.com/sirupsen/logrus"
 )
 
 // Server ..

pkg/monitor/ui/ui.go

@@ -120,7 +120,6 @@ func max(a, b int) int {
 }
 
 type model struct {
-	ctx             context.Context
 	version         string
 	client          *client.Client
 	vp              viewport.Model
@@ -131,7 +130,7 @@ type model struct {
 }
 
 func (m *model) renderConfigViewport() string {
-	config, err := m.client.GetConfig(m.ctx, &pb.Empty{})
+	config, err := m.client.GetConfig(context.TODO(), &pb.Empty{})
 	if err != nil || config == nil {
 		log.WithError(err).Fatal()
 	}
@@ -225,24 +224,23 @@ func prettyTimeago(t time.Time) string {
 	return timeago.English.Format(t)
 }
 
-func newModel(ctx context.Context, version string, endpoint *url.URL) (m *model) {
+func newModel(version string, endpoint *url.URL) (m *model) {
 	p := progress.NewModel(progress.WithScaledGradient("#80c904", "#ff9d5c"))
 
 	m = &model{
-		ctx:             ctx,
 		version:         version,
 		vp:              viewport.Model{},
 		telemetryStream: make(chan *pb.Telemetry),
 		progress:        &p,
-		client:          client.NewClient(ctx, endpoint),
+		client:          client.NewClient(context.TODO(), endpoint),
 	}
 
 	return
 }
 
 func (m *model) Init() tea.Cmd {
 	return tea.Batch(
-		m.streamTelemetry(m.ctx),
+		m.streamTelemetry(context.TODO()),
 		waitForTelemetryUpdate(m.telemetryStream),
 	)
 }
@@ -279,11 +277,11 @@ func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			m.vp = vp
 
 			return m, cmd
-
 		}
 	case *pb.Telemetry:
 		m.telemetry = msg
 		m.setPaneContent()
+
 		return m, waitForTelemetryUpdate(m.telemetryStream)
 	}
 
@@ -359,9 +357,9 @@ func waitForTelemetryUpdate(t chan *pb.Telemetry) tea.Cmd {
 }
 
 // Start ..
-func Start(ctx context.Context, version string, listenerAddress *url.URL) {
+func Start(version string, listenerAddress *url.URL) {
 	if err := tea.NewProgram(
-		newModel(ctx, version, listenerAddress),
+		newModel(version, listenerAddress),
 		tea.WithAltScreen(),
 	).Start(); err != nil {
 		fmt.Println("Error running program:", err)