installation-telemetry: switch to custom customerID license field

Author: adrienthebo

components/gitpod-protocol/src/installation-admin-protocol.ts

@@ -28,7 +28,7 @@ export interface TelemetryData {
     totalUsers: number;
     totalWorkspaces: number;
     totalInstances: number;
-    licenseId?: string;
+    customerID?: string;
 }
 
 export namespace InstallationAdmin {

components/installation-telemetry/cmd/send.go

@@ -58,7 +58,7 @@ var sendCmd = &cobra.Command{
 				Set("totalUsers", data.TotalUsers).
 				Set("totalWorkspaces", data.TotalWorkspaces).
 				Set("totalInstances", data.TotalInstances).
-				Set("licenseId", data.LicenseID),
+				Set("customerID", data.CustomerID),
 		}
 
 		client.Enqueue(telemetry)

components/installation-telemetry/pkg/server/installationAdmin.go

@@ -22,7 +22,7 @@ type Data struct {
 	TotalUsers        int64             `json:"totalUsers"`
 	TotalWorkspaces   int64             `json:"totalWorkspaces"`
 	TotalInstances    int64             `json:"totalInstances"`
-	LicenseID         string            `json:"licenseId,omitempty`
+	CustomerID        string            `json:"customerID,omitempty"`
 }
 
 type InstallationAdmin struct {

components/licensor/ee/cmd/sign.go

@@ -41,11 +41,12 @@ var signCmd = &cobra.Command{
 		}
 
 		var (
-			domain, _   = cmd.Flags().GetString("domain")
-			id, _       = cmd.Flags().GetString("id")
-			level, _    = cmd.Flags().GetString("level")
-			seats, _    = cmd.Flags().GetInt("seats")
-			validFor, _ = cmd.Flags().GetDuration("valid-for")
+			domain, _     = cmd.Flags().GetString("domain")
+			id, _         = cmd.Flags().GetString("id")
+			level, _      = cmd.Flags().GetString("level")
+			seats, _      = cmd.Flags().GetInt("seats")
+			validFor, _   = cmd.Flags().GetDuration("valid-for")
+			customerID, _ = cmd.Flags().GetString("customer-id")
 		)
 		if domain == "" {
 			return xerrors.Errorf("--domain is mandatory")
@@ -74,6 +75,7 @@ var signCmd = &cobra.Command{
 			Seats:      seats,
 			Level:      lvl,
 			ValidUntil: time.Now().Add(validFor),
+			CustomerID: customerID,
 		}
 
 		res, err := licensor.Sign(l, priv)
@@ -90,6 +92,7 @@ func init() {
 	rootCmd.AddCommand(signCmd)
 
 	signCmd.Flags().String("domain", "", "domain for which the license is valid")
+	signCmd.Flags().String("customer-id", "", "analytics customer ID")
 	signCmd.Flags().String("id", "", "ID of the license")
 	signCmd.Flags().String("level", "enterprise", "license level, must be one of team, enterprise")
 	signCmd.Flags().Int("seats", 5, "number of seats the license is valid for")

components/licensor/ee/pkg/licensor/licensor.go

@@ -53,6 +53,9 @@ type LicensePayload struct {
 
 	// Seats == 0 means there's no seat limit
 	Seats int `json:"seats"`
+
+	// CustomerID is used to identify installations in installation analytics
+	CustomerID string `json:"customerID"`
 }
 
 type licensePayload struct {

components/licensor/ee/pkg/licensor/replicated.go

@@ -118,6 +118,9 @@ func newReplicatedEvaluator(client *http.Client) (res *Evaluator) {
 
 		case "seats":
 			lic.Seats = int(i.Value.(float64))
+
+		case "customerID":
+			lic.CustomerID = i.Value.(string)
 		}
 	}
 

components/licensor/typescript/ee/src/api.ts

@@ -29,6 +29,7 @@ export interface LicensePayload {
     level: LicenseLevel
     validUntil: string
     seats: number
+    customerID: string
 }
 
 export enum LicenseSubscriptionLevel {

components/server/src/installation-admin/telemetry-data-provider.ts

@@ -26,7 +26,7 @@ export class InstallationAdminTelemetryDataProvider {
                 totalUsers: await this.userDb.getUserCount(true),
                 totalWorkspaces: await this.workspaceDb.getWorkspaceCount(),
                 totalInstances: await this.workspaceDb.getInstanceCount(),
-                licenseId: this.licenseEvaluator.getLicenseData().payload.id,
+                customerID: this.licenseEvaluator.getLicenseData().payload.customerID,
             } as TelemetryData;
             return data;
         } finally {