feat: add useragent for requests (#75)

* feature(httpclient): add useragent

* build: set buildinfo vars

* feat: print build date with build info

* fix: imports

* feat(lists): set user agent for http queries

* fix: imports

Author: zze0s

Dockerfile

@@ -19,7 +19,7 @@ COPY . ./
 #ENV GOOS=linux
 ENV CGO_ENABLED=0
 
-RUN go build -ldflags "-s -w -X main.version=${VERSION} -X main.commit=${REVISION} -X main.date=${BUILDTIME}" -o bin/omegabrr cmd/omegabrr/main.go
+RUN go build -ldflags "-s -w -X buildinfo.Version=${VERSION} -X buildinfo.Commit=${REVISION} -X buildinfo.Date=${BUILDTIME}" -o bin/omegabrr cmd/omegabrr/main.go
 
 # build runner
 FROM alpine:latest

Makefile

@@ -5,7 +5,7 @@ GIT_TAG := $(shell git tag --points-at HEAD 2> /dev/null | head -n 1)
 
 GO ?= go
 RM ?= rm
-GOFLAGS ?= "-X main.commit=$(GIT_COMMIT) -X main.version=$(GIT_TAG)"
+GOFLAGS ?= "-X buildinfo.Commit=$(GIT_COMMIT) -X buildinfo.Version=$(GIT_TAG)"
 PREFIX ?= /usr/local
 BINDIR ?= bin
 

cmd/omegabrr/main.go

@@ -14,6 +14,7 @@ import (
 	"time"
 
 	"github.com/autobrr/omegabrr/internal/apitoken"
+	"github.com/autobrr/omegabrr/internal/buildinfo"
 	"github.com/autobrr/omegabrr/internal/domain"
 	"github.com/autobrr/omegabrr/internal/http"
 	"github.com/autobrr/omegabrr/internal/processor"
@@ -27,11 +28,6 @@ import (
 	"github.com/spf13/pflag"
 )
 
-var (
-	version = "dev"
-	commit  = ""
-)
-
 const usage = `omegabrr - Automagically turn your monitored titles from your arrs and lists into autobrr filters.
 
 Usage:
@@ -98,7 +94,7 @@ func main() {
 
 	switch cmd := pflag.Arg(0); cmd {
 	case "version":
-		fmt.Printf("Version: %v\nCommit: %v\n", version, commit)
+		fmt.Printf("Version: %v\nCommit: %v\nBuild date: %v\n", buildinfo.Version, buildinfo.Commit, buildinfo.Date)
 
 		// get the latest release tag from brr-api
 		client := &netHTTP.Client{
@@ -132,7 +128,7 @@ func main() {
 		fmt.Printf("Latest release: %v\n", rel.TagName)
 
 	case "update":
-		v, err := semver.ParseTolerant(version)
+		v, err := semver.ParseTolerant(buildinfo.Version)
 		if err != nil {
 			log.Error().Err(err).Msg("could not parse version")
 			return
@@ -146,7 +142,7 @@ func main() {
 
 		if latest.Version.Equals(v) {
 			// latest version is the same as current version. It means current binary is up-to-date.
-			log.Info().Msgf("Current binary is the latest version: %s", version)
+			log.Info().Msgf("Current binary is the latest version: %s", buildinfo.Version)
 		} else {
 			log.Info().Msgf("Successfully updated to version: %s", latest.Version)
 		}
@@ -196,7 +192,7 @@ func main() {
 	case "run":
 		cfg := domain.NewConfig(configPath)
 
-		log.Info().Msgf("starting omegabrr: %s", version)
+		log.Info().Msgf("starting omegabrr: %s", buildinfo.Version)
 		log.Info().Msgf("running on schedule: %v", cfg.Schedule)
 
 		p := processor.NewService(cfg)

internal/buildinfo/buildinfo.go

@@ -0,0 +1,7 @@
+package buildinfo
+
+var (
+	Version = "dev"
+	Commit  = ""
+	Date    = ""
+)

internal/processor/client.go

@@ -0,0 +1,15 @@
+package processor
+
+import (
+	"fmt"
+	"net/http"
+	"runtime"
+
+	"github.com/autobrr/omegabrr/internal/buildinfo"
+)
+
+func setUserAgent(req *http.Request) {
+	agent := fmt.Sprintf("omegabrr/%s (%s %s)", buildinfo.Version, runtime.GOOS, runtime.GOARCH)
+
+	req.Header.Set("User-Agent", agent)
+}

internal/processor/mdblist.go

@@ -38,6 +38,8 @@ func (s Service) mdblist(ctx context.Context, cfg *domain.ListConfig, dryRun boo
 		req.Header.Set(k, v)
 	}
 
+	setUserAgent(req)
+
 	resp, err := s.httpClient.Do(req)
 	if err != nil {
 		l.Error().Err(err).Msgf("failed to fetch titles from URL: %s", cfg.URL)

internal/processor/metacritic.go

@@ -36,6 +36,8 @@ func (s Service) metacritic(ctx context.Context, cfg *domain.ListConfig, dryRun
 		req.Header.Set(k, v)
 	}
 
+	setUserAgent(req)
+
 	resp, err := s.httpClient.Do(req)
 	if err != nil {
 		l.Error().Err(err).Msgf("failed to fetch titles from URL: %s", cfg.URL)

internal/processor/plaintext.go

@@ -39,6 +39,8 @@ func (s Service) plaintext(ctx context.Context, cfg *domain.ListConfig, dryRun b
 		req.Header.Set(k, v)
 	}
 
+	setUserAgent(req)
+
 	resp, err := s.httpClient.Do(req)
 	if err != nil {
 		l.Error().Err(err).Msgf("failed to fetch titles from URL: %s", cfg.URL)

internal/processor/trakt.go

@@ -41,6 +41,8 @@ func (s Service) trakt(ctx context.Context, cfg *domain.ListConfig, dryRun bool,
 		req.Header.Set(k, v)
 	}
 
+	setUserAgent(req)
+
 	resp, err := s.httpClient.Do(req)
 	if err != nil {
 		l.Error().Err(err).Msgf("failed to fetch titles from URL: %s", cfg.URL)

pkg/autobrr/client.go

@@ -5,15 +5,18 @@ import (
 	"context"
 	"crypto/tls"
 	"encoding/json"
+	"fmt"
 	"io"
 	"net/http"
 	"net/http/httputil"
+	"runtime"
 	"strconv"
 	"time"
 
-	"github.com/rs/zerolog/log"
+	"github.com/autobrr/omegabrr/internal/buildinfo"
 
 	"github.com/pkg/errors"
+	"github.com/rs/zerolog/log"
 )
 
 type Client struct {
@@ -76,6 +79,7 @@ func (c *Client) GetFilters(ctx context.Context) ([]Filter, error) {
 
 	req.SetBasicAuth(c.BasicUser, c.BasicPass)
 	req.Header.Add("X-API-Token", c.APIKey)
+	c.buildUserAgent(req)
 
 	res, err := c.client.Do(req)
 	if err != nil {
@@ -115,6 +119,7 @@ func (c *Client) UpdateFilterByID(ctx context.Context, filterID int, filter Upda
 
 	req.SetBasicAuth(c.BasicUser, c.BasicPass)
 	req.Header.Add("X-API-Token", c.APIKey)
+	c.buildUserAgent(req)
 
 	res, err := c.client.Do(req)
 	if err != nil {
@@ -136,6 +141,12 @@ func (c *Client) UpdateFilterByID(ctx context.Context, filterID int, filter Upda
 	return nil
 }
 
+func (c *Client) buildUserAgent(req *http.Request) {
+	agent := fmt.Sprintf("omegabrr/%s (%s %s)", buildinfo.Version, runtime.GOOS, runtime.GOARCH)
+
+	req.Header.Set("User-Agent", agent)
+}
+
 type Filter struct {
 	ID        string    `json:"id"`
 	Name      string    `json:"name"`