Ensure all API calls to replicated saas have user-agent header (#3748)

* chore: ensure all API calls to replicated saas have user-agent header

Signed-off-by: Evans Mungai <evans@replicated.com>

* Additional header call site

Signed-off-by: Evans Mungai <evans@replicated.com>

* Remove header

Signed-off-by: Evans Mungai <evans@replicated.com>

* DRY user agent string

Signed-off-by: Evans Mungai <evans@replicated.com>

---------

Signed-off-by: Evans Mungai <evans@replicated.com>

Author: banjoh

cmd/installer/cli/release.go

@@ -10,6 +10,7 @@ import (
 	"net/url"
 	"time"
 
+	"github.com/replicatedhq/embedded-cluster/pkg/versions"
 	kotsv1beta1 "github.com/replicatedhq/kotskinds/apis/kots/v1beta1"
 )
 
@@ -41,6 +42,7 @@ func getCurrentAppChannelRelease(ctx context.Context, license *kotsv1beta1.Licen
 
 	auth := fmt.Sprintf("Basic %s", base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", license.Spec.LicenseID, license.Spec.LicenseID))))
 	req.Header.Set("Authorization", auth)
+	req.Header.Set("User-Agent", versions.UserAgent())
 
 	// This will use the proxy from the environment if set by the cli command.
 	client := &http.Client{

operator/pkg/metadata/metadata.go

@@ -12,6 +12,7 @@ import (
 	"github.com/replicatedhq/embedded-cluster/kinds/apis/v1beta1"
 	"github.com/replicatedhq/embedded-cluster/operator/pkg/release"
 	"github.com/replicatedhq/embedded-cluster/pkg/artifacts"
+	"github.com/replicatedhq/embedded-cluster/pkg/versions"
 	corev1 "k8s.io/api/core/v1"
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	ctrl "sigs.k8s.io/controller-runtime"
@@ -121,6 +122,7 @@ func getRemoteMetadataOnline(ctx context.Context, in *v1beta1.Installation) ([]b
 	if err != nil {
 		return nil, fmt.Errorf("new request: %w", err)
 	}
+	req.Header.Set("User-Agent", versions.UserAgent())
 
 	resp, err := http.DefaultClient.Do(req)
 	if err != nil {

operator/pkg/metrics/metrics.go

@@ -9,6 +9,7 @@ import (
 	"net/http"
 	"time"
 
+	"github.com/replicatedhq/embedded-cluster/pkg/versions"
 	corev1 "k8s.io/api/core/v1"
 )
 
@@ -70,6 +71,7 @@ func sendEvent(ctx context.Context, evname, baseURL string, ev interface{}) erro
 		return err
 	}
 	req.Header.Set("Content-Type", "application/json")
+	req.Header.Set("User-Agent", versions.UserAgent())
 	resp, err := http.DefaultClient.Do(req)
 	if err != nil {
 		return fmt.Errorf("failed to send event: %w", err)

operator/pkg/release/release.go

@@ -14,6 +14,7 @@ import (
 	"github.com/gosimple/slug"
 	"github.com/replicatedhq/embedded-cluster/kinds/apis/v1beta1"
 	ectypes "github.com/replicatedhq/embedded-cluster/kinds/types"
+	"github.com/replicatedhq/embedded-cluster/pkg/versions"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -103,6 +104,7 @@ func remoteMetadataFor(ctx context.Context, in *v1beta1.Installation) (*ectypes.
 	if err != nil {
 		return nil, fmt.Errorf("failed to create request: %w", err)
 	}
+	req.Header.Set("User-Agent", versions.UserAgent())
 
 	resp, err := http.DefaultClient.Do(req)
 	if err != nil {

pkg-new/replicatedapi/client.go

@@ -139,7 +139,7 @@ func (c *client) newRetryableRequest(ctx context.Context, method string, url str
 // injectHeaders injects the basic auth header, user agent header, and reporting info headers into the http.Header.
 func (c *client) injectHeaders(header http.Header) {
 	header.Set("Authorization", "Basic "+basicAuth(c.license.Spec.LicenseID, c.license.Spec.LicenseID))
-	header.Set("User-Agent", fmt.Sprintf("Embedded-Cluster/%s", versions.Version))
+	header.Set("User-Agent", versions.UserAgent())
 
 	c.injectReportingInfoHeaders(header)
 }

pkg/lint/api_client.go

@@ -8,6 +8,8 @@ import (
 	"os"
 	"strings"
 	"time"
+
+	"github.com/replicatedhq/embedded-cluster/pkg/versions"
 )
 
 // APIClient handles communication with the Replicated API
@@ -119,6 +121,7 @@ func (c *APIClient) GetCustomDomains() ([]string, error) {
 
 	req.Header.Set("Authorization", c.apiToken)
 	req.Header.Set("Accept", "application/json")
+	req.Header.Set("User-Agent", versions.UserAgent())
 
 	resp, err := c.client.Do(req)
 	if err != nil {
@@ -205,6 +208,7 @@ func (c *APIClient) getDomainsFromChannelReleases() ([]string, error) {
 
 	req.Header.Set("Authorization", c.apiToken)
 	req.Header.Set("Accept", "application/json")
+	req.Header.Set("User-Agent", versions.UserAgent())
 
 	resp, err := c.client.Do(req)
 	if err != nil {
@@ -246,6 +250,7 @@ func (c *APIClient) getDomainsFromChannelReleases() ([]string, error) {
 
 		req.Header.Set("Authorization", c.apiToken)
 		req.Header.Set("Accept", "application/json")
+		req.Header.Set("User-Agent", versions.UserAgent())
 
 		resp, err := c.client.Do(req)
 		if err != nil {
@@ -310,6 +315,7 @@ func (c *APIClient) getDomainsFromApp() ([]string, error) {
 
 	req.Header.Set("Authorization", c.apiToken)
 	req.Header.Set("Accept", "application/json")
+	req.Header.Set("User-Agent", versions.UserAgent())
 
 	resp, err := c.client.Do(req)
 	if err != nil {

pkg/metrics/sender.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/replicatedhq/embedded-cluster/pkg/metrics/types"
+	"github.com/replicatedhq/embedded-cluster/pkg/versions"
 	"github.com/sirupsen/logrus"
 )
 
@@ -25,6 +26,7 @@ func (s *Sender) Send(ctx context.Context, baseURL string, ev types.Event) {
 		return
 	}
 	request.Header.Set("Content-Type", "application/json")
+	request.Header.Set("User-Agent", versions.UserAgent())
 
 	client := &http.Client{
 		Timeout: 5 * time.Second,

pkg/versions/versions.go

@@ -1,6 +1,10 @@
 // Package versions
 package versions
 
+import (
+	"fmt"
+)
+
 var (
 	// Version holds the EmbeddedCluster version.
 	Version = "v0.0.0"
@@ -24,3 +28,7 @@ var (
 	// time using LD_FLAGS in the Makefile
 	OperatorBinaryURLOverride string
 )
+
+func UserAgent() string {
+	return fmt.Sprintf("Embedded-Cluster/%s", Version)
+}