feedback

Author: emosbaugh

cmd/installer/cli/install.go

@@ -396,7 +396,7 @@ func preRunInstallCommon(cmd *cobra.Command, flags *InstallCmdFlags, rc runtimec
 		}
 		flags.licenseBytes = b
 
-		// validate the the license is indeed a license file
+		// validate the license is indeed a license file
 		l, err := helpers.ParseLicenseFromBytes(b)
 		if err != nil {
 			var notALicenseFileErr helpers.ErrNotALicenseFile

cmd/installer/cli/replicatedapi.go

@@ -33,7 +33,7 @@ func newReplicatedAPIClient(license *kotsv1beta1.License, clusterID string) (rep
 func syncLicense(ctx context.Context, client replicatedapi.Client, license *kotsv1beta1.License) (*kotsv1beta1.License, []byte, error) {
 	logrus.Debug("Syncing license")
 
-	updatedLicense, licenseBytes, err := client.SyncLicense(ctx, nil)
+	updatedLicense, licenseBytes, err := client.SyncLicense(ctx)
 	if err != nil {
 		return nil, nil, fmt.Errorf("get latest license: %w", err)
 	}

cmd/installer/cli/upgrade.go

@@ -242,7 +242,7 @@ func preRunUpgrade(ctx context.Context, flags UpgradeCmdFlags, upgradeConfig *up
 	}
 	upgradeConfig.licenseBytes = data
 
-	// validate the the license is indeed a license file
+	// validate the license is indeed a license file
 	l, err := helpers.ParseLicenseFromBytes(data)
 	if err != nil {
 		var notALicenseFileErr helpers.ErrNotALicenseFile

pkg-new/replicatedapi/client.go

@@ -18,7 +18,7 @@ import (
 var defaultHTTPClient = newRetryableHTTPClient()
 
 type Client interface {
-	SyncLicense(ctx context.Context, reportingInfo *ReportingInfo) (*kotsv1beta1.License, []byte, error)
+	SyncLicense(ctx context.Context) (*kotsv1beta1.License, []byte, error)
 }
 
 type client struct {
@@ -60,7 +60,7 @@ func NewClient(replicatedAppURL string, license *kotsv1beta1.License, releaseDat
 }
 
 // SyncLicense fetches the latest license from the Replicated API
-func (c *client) SyncLicense(ctx context.Context, reportingInfo *ReportingInfo) (*kotsv1beta1.License, []byte, error) {
+func (c *client) SyncLicense(ctx context.Context) (*kotsv1beta1.License, []byte, error) {
 	u := fmt.Sprintf("%s/license/%s", c.replicatedAppURL, c.license.Spec.AppSlug)
 
 	params := url.Values{}
@@ -70,7 +70,7 @@ func (c *client) SyncLicense(ctx context.Context, reportingInfo *ReportingInfo)
 	}
 	u = fmt.Sprintf("%s?%s", u, params.Encode())
 
-	req, err := c.newRetryableRequest(ctx, http.MethodGet, u, nil, reportingInfo)
+	req, err := c.newRetryableRequest(ctx, http.MethodGet, u, nil)
 	if err != nil {
 		return nil, nil, fmt.Errorf("create request: %w", err)
 	}
@@ -112,23 +112,23 @@ func (c *client) SyncLicense(ctx context.Context, reportingInfo *ReportingInfo)
 }
 
 // newRetryableRequest returns a retryablehttp.Request object with kots defaults set, including a User-Agent header.
-func (c *client) newRetryableRequest(ctx context.Context, method string, url string, body io.Reader, reportingInfo *ReportingInfo) (*retryablehttp.Request, error) {
+func (c *client) newRetryableRequest(ctx context.Context, method string, url string, body io.Reader) (*retryablehttp.Request, error) {
 	req, err := retryablehttp.NewRequestWithContext(ctx, method, url, body)
 	if err != nil {
 		return nil, err
 	}
 
-	c.injectHeaders(req.Header, reportingInfo)
+	c.injectHeaders(req.Header)
 
 	return req, nil
 }
 
 // injectHeaders injects the basic auth header, user agent header, and reporting info headers into the http.Header.
-func (c *client) injectHeaders(header http.Header, reportingInfo *ReportingInfo) {
+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))
 
-	c.injectReportingInfoHeaders(header, reportingInfo)
+	c.injectReportingInfoHeaders(header)
 }
 
 func (c *client) getChannelFromLicense() (*kotsv1beta1.Channel, error) {

pkg-new/replicatedapi/client_test.go

@@ -236,7 +236,7 @@ func TestSyncLicense(t *testing.T) {
 			req.NoError(err)
 
 			// Execute test
-			license, rawLicense, err := c.SyncLicense(context.Background(), nil)
+			license, rawLicense, err := c.SyncLicense(context.Background())
 
 			// Validate results
 			if tt.wantErr != "" {
@@ -301,7 +301,7 @@ func TestSyncLicense_ContextCancellation(t *testing.T) {
 	cancel()
 
 	// Execute test
-	result, rawLicense, err := c.SyncLicense(ctx, nil)
+	result, rawLicense, err := c.SyncLicense(ctx)
 
 	// Should return error due to cancelled context
 	req.Error(err)
@@ -313,14 +313,12 @@ func TestGetReportingInfoHeaders(t *testing.T) {
 	tests := []struct {
 		name          string
 		clusterID     string
-		reportingInfo *ReportingInfo
 		expectedCount int
 		checkHeaders  map[string]string
 	}{
 		{
-			name:          "with cluster ID and nil reporting info",
+			name:          "with cluster ID",
 			clusterID:     "cluster-123",
-			reportingInfo: nil,
 			expectedCount: 7, // EmbeddedClusterID, ChannelID, ChannelName, K8sVersion, K8sDistribution, EmbeddedClusterVersion, IsKurl
 			checkHeaders: map[string]string{
 				"X-Replicated-EmbeddedClusterID":      "cluster-123",
@@ -332,24 +330,9 @@ func TestGetReportingInfoHeaders(t *testing.T) {
 				"X-Replicated-IsKurl":                 "false",
 			},
 		},
-		{
-			name:      "with reporting info fields",
-			clusterID: "cluster-abc",
-			reportingInfo: &ReportingInfo{
-				EmbeddedClusterNodes: stringPtr("5"),
-				AppStatus:            stringPtr("ready"),
-			},
-			expectedCount: 9, // 7 from above + 2 from reportingInfo
-			checkHeaders: map[string]string{
-				"X-Replicated-EmbeddedClusterNodes": "5",
-				"X-Replicated-AppStatus":            "ready",
-				"X-Replicated-IsKurl":               "false",
-			},
-		},
 		{
 			name:          "zero values should be skipped",
 			clusterID:     "",
-			reportingInfo: &ReportingInfo{},
 			expectedCount: 6, // ChannelID, ChannelName, K8sVersion, K8sDistribution, EmbeddedClusterVersion, IsKurl
 			checkHeaders: map[string]string{
 				"X-Replicated-IsKurl": "false",
@@ -389,7 +372,7 @@ func TestGetReportingInfoHeaders(t *testing.T) {
 				clusterID:   tt.clusterID,
 			}
 
-			headers := c.getReportingInfoHeaders(tt.reportingInfo)
+			headers := c.getReportingInfoHeaders()
 
 			req.Len(headers, tt.expectedCount)
 
@@ -434,14 +417,9 @@ func TestInjectHeaders(t *testing.T) {
 		clusterID:   "test-cluster-id",
 	}
 
-	reportingInfo := &ReportingInfo{
-		EmbeddedClusterNodes: stringPtr("3"),
-		AppStatus:            stringPtr("ready"),
-	}
-
 	// Test the internal method directly
 	header := http.Header{}
-	c.injectHeaders(header, reportingInfo)
+	c.injectHeaders(header)
 
 	// Validate User-Agent header was injected
 	userAgent := header.Get("User-Agent")
@@ -461,7 +439,5 @@ func TestInjectHeaders(t *testing.T) {
 	req.Equal(versions.K0sVersion, header.Get("X-Replicated-K8sVersion"))
 	req.Equal(DistributionEmbeddedCluster, header.Get("X-Replicated-K8sDistribution"))
 	req.Equal(versions.Version, header.Get("X-Replicated-EmbeddedClusterVersion"))
-	req.Equal("3", header.Get("X-Replicated-EmbeddedClusterNodes"))
-	req.Equal("ready", header.Get("X-Replicated-AppStatus"))
 	req.Equal("false", header.Get("X-Replicated-IsKurl"))
 }

pkg-new/replicatedapi/reporting.go

@@ -1,9 +1,7 @@
 package replicatedapi
 
 import (
-	"fmt"
 	"net/http"
-	"reflect"
 
 	"github.com/replicatedhq/embedded-cluster/pkg/versions"
 )
@@ -12,40 +10,13 @@ const (
 	DistributionEmbeddedCluster string = "embedded-cluster"
 )
 
-type ReportingInfo struct {
-	EmbeddedClusterNodes      *string `header:"X-Replicated-EmbeddedClusterNodes"`
-	ReplHelmInstalls          *string `header:"X-Replicated-ReplHelmInstalls"`
-	NativeHelmInstalls        *string `header:"X-Replicated-NativeHelmInstalls"`
-	AppStatus                 *string `header:"X-Replicated-AppStatus"`
-	InstallStatus             *string `header:"X-Replicated-InstallStatus"`
-	PreflightStatus           *string `header:"X-Replicated-PreflightStatus"`
-	DownstreamChannelSequence *string `header:"X-Replicated-DownstreamChannelSequence"`
-	DownstreamSequence        *string `header:"X-Replicated-DownstreamSequence"`
-	DownstreamSource          *string `header:"X-Replicated-DownstreamSource"`
-	SkipPreflights            *string `header:"X-Replicated-SkipPreflights"`
-
-	// unsupported headers
-	// X-Replicated-KotsInstallID
-	// X-Replicated-KurlInstallID
-	// X-Replicated-KurlNodeCountTotal
-	// X-Replicated-KurlNodeCountReady
-	// X-Replicated-IsGitOpsEnabled
-	// X-Replicated-GitOpsProvider
-	// X-Replicated-SnapshotProvider
-	// X-Replicated-SnapshotFullSchedule
-	// X-Replicated-SnapshotFullTTL
-	// X-Replicated-SnapshotPartialSchedule
-	// X-Replicated-SnapshotPartialTTL
-
-}
-
-func (c *client) injectReportingInfoHeaders(header http.Header, reportingInfo *ReportingInfo) {
-	for key, value := range c.getReportingInfoHeaders(reportingInfo) {
+func (c *client) injectReportingInfoHeaders(header http.Header) {
+	for key, value := range c.getReportingInfoHeaders() {
 		header.Set(key, value)
 	}
 }
 
-func (c *client) getReportingInfoHeaders(reportingInfo *ReportingInfo) map[string]string {
+func (c *client) getReportingInfoHeaders() map[string]string {
 	headers := make(map[string]string)
 
 	// add headers from client
@@ -67,45 +38,6 @@ func (c *client) getReportingInfoHeaders(reportingInfo *ReportingInfo) map[strin
 	// Add static headers
 	headers["X-Replicated-IsKurl"] = "false"
 
-	if reportingInfo != nil {
-		// Use reflection to read struct tags and map fields to headers
-		v := reflect.ValueOf(reportingInfo).Elem()
-		t := v.Type()
-
-		for i := 0; i < t.NumField(); i++ {
-			field := t.Field(i)
-			headerName := field.Tag.Get("header")
-			if headerName == "" {
-				continue
-			}
-
-			fieldValue := v.Field(i)
-
-			// Check if the pointer field is nil (not set)
-			if fieldValue.IsNil() {
-				continue
-			}
-
-			// Dereference the pointer to get the actual value
-			actualValue := fieldValue.Elem()
-			var strValue string
-
-			switch actualValue.Kind() {
-			case reflect.String:
-				strValue = actualValue.String()
-			case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
-				strValue = fmt.Sprintf("%d", actualValue.Int())
-			case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
-				strValue = fmt.Sprintf("%d", actualValue.Uint())
-			case reflect.Bool:
-				strValue = fmt.Sprintf("%t", actualValue.Bool())
-			default:
-				panic(fmt.Sprintf("reporting info field %s has unsupported type: %s", field.Name, actualValue.Kind()))
-			}
-			headers[headerName] = strValue
-		}
-	}
-
 	// remove empty headers
 	for key, value := range headers {
 		if value == "" {
@@ -115,3 +47,26 @@ func (c *client) getReportingInfoHeaders(reportingInfo *ReportingInfo) map[strin
 
 	return headers
 }
+
+// TODO: the following headers are injected by KOTS and are not yet supported by Embedded Cluster
+// X-Replicated-EmbeddedClusterNodes
+// X-Replicated-ReplHelmInstalls
+// X-Replicated-NativeHelmInstalls
+// X-Replicated-AppStatus
+// X-Replicated-InstallStatus
+// X-Replicated-PreflightStatus
+// X-Replicated-DownstreamChannelSequence
+// X-Replicated-DownstreamSequence
+// X-Replicated-DownstreamSource
+// X-Replicated-SkipPreflights
+// X-Replicated-KotsInstallID
+// X-Replicated-KurlInstallID
+// X-Replicated-KurlNodeCountTotal
+// X-Replicated-KurlNodeCountReady
+// X-Replicated-IsGitOpsEnabled
+// X-Replicated-GitOpsProvider
+// X-Replicated-SnapshotProvider
+// X-Replicated-SnapshotFullSchedule
+// X-Replicated-SnapshotFullTTL
+// X-Replicated-SnapshotPartialSchedule
+// X-Replicated-SnapshotPartialTTL

pkg/helpers/parse.go

@@ -49,7 +49,7 @@ func ParseLicenseFromBytes(data []byte) (*kotsv1beta1.License, error) {
 		return nil, ErrNotALicenseFile{Err: err}
 	}
 	if license.Spec.LicenseID == "" {
-		return nil, ErrNotALicenseFile{Err: fmt.Errorf("license id empty")}
+		return nil, ErrNotALicenseFile{Err: fmt.Errorf("license id is empty")}
 	}
 	return &license, nil
 }