feat: add support for telemetry-required licenses (#6194)

ammario · web-flow · commit 6e3330a03f8f · 2023-02-14T20:26:47.000Z
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -81,11 +81,12 @@ type Feature struct {
 }
 
 type Entitlements struct {
-	Features   map[FeatureName]Feature `json:"features"`
-	Warnings   []string                `json:"warnings"`
-	Errors     []string                `json:"errors"`
-	HasLicense bool                    `json:"has_license"`
-	Trial      bool                    `json:"trial"`
+	Features         map[FeatureName]Feature `json:"features"`
+	Warnings         []string                `json:"warnings"`
+	Errors           []string                `json:"errors"`
+	HasLicense       bool                    `json:"has_license"`
+	Trial            bool                    `json:"trial"`
+	RequireTelemetry bool                    `json:"require_telemetry"`
 
 	// DEPRECATED: use Experiments instead.
 	Experimental bool `json:"experimental"`
diff --git a/docs/api/enterprise.md b/docs/api/enterprise.md
@@ -128,6 +128,7 @@ curl -X GET http://coder-server:8080/api/v2/entitlements \
     }
   },
   "has_license": true,
+  "require_telemetry": true,
   "trial": true,
   "warnings": ["string"]
 }
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -2806,22 +2806,24 @@ CreateParameterRequest is a structure used to create a new parameter value for a
     }
   },
   "has_license": true,
+  "require_telemetry": true,
   "trial": true,
   "warnings": ["string"]
 }
 ```
 
 ### Properties
 
-| Name               | Type                                 | Required | Restrictions | Description                           |
-| ------------------ | ------------------------------------ | -------- | ------------ | ------------------------------------- |
-| `errors`           | array of string                      | false    |              |                                       |
-| `experimental`     | boolean                              | false    |              | Experimental use Experiments instead. |
-| `features`         | object                               | false    |              |                                       |
-| » `[any property]` | [codersdk.Feature](#codersdkfeature) | false    |              |                                       |
-| `has_license`      | boolean                              | false    |              |                                       |
-| `trial`            | boolean                              | false    |              |                                       |
-| `warnings`         | array of string                      | false    |              |                                       |
+| Name                | Type                                 | Required | Restrictions | Description                           |
+| ------------------- | ------------------------------------ | -------- | ------------ | ------------------------------------- |
+| `errors`            | array of string                      | false    |              |                                       |
+| `experimental`      | boolean                              | false    |              | Experimental use Experiments instead. |
+| `features`          | object                               | false    |              |                                       |
+| » `[any property]`  | [codersdk.Feature](#codersdkfeature) | false    |              |                                       |
+| `has_license`       | boolean                              | false    |              |                                       |
+| `require_telemetry` | boolean                              | false    |              |                                       |
+| `trial`             | boolean                              | false    |              |                                       |
+| `warnings`          | array of string                      | false    |              |                                       |
 
 ## codersdk.Experiment
 
diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -254,6 +254,17 @@ func (api *API) updateEntitlements(ctx context.Context) error {
 	if err != nil {
 		return err
 	}
+
+	if entitlements.RequireTelemetry && !api.DeploymentConfig.Telemetry.Enable.Value {
+		// We can't fail because then the user couldn't remove the offending
+		// license w/o a restart.
+		api.entitlements.Errors = []string{
+			"License requires telemetry but telemetry is disabled",
+		}
+		api.Logger.Error(ctx, "license requires telemetry enabled")
+		return nil
+	}
+
 	entitlements.Experimental = api.DeploymentConfig.Experimental.Value || len(api.AGPL.Experiments) != 0
 
 	featureChanged := func(featureName codersdk.FeatureName) (changed bool, enabled bool) {
diff --git a/enterprise/coderd/license/license.go b/enterprise/coderd/license/license.go
@@ -98,6 +98,7 @@ func Entitlements(
 		if claims.AllFeatures {
 			allFeatures = true
 		}
+		entitlements.RequireTelemetry = entitlements.RequireTelemetry || claims.RequireTelemetry
 	}
 
 	if allFeatures {
@@ -224,13 +225,14 @@ type Claims struct {
 	// the end of the grace period (identical to LicenseExpires if there is no grace period).
 	// The reason we use the standard claim for the end of the grace period is that we want JWT
 	// processing libraries to consider the token "valid" until then.
-	LicenseExpires *jwt.NumericDate `json:"license_expires,omitempty"`
-	AccountType    string           `json:"account_type,omitempty"`
-	AccountID      string           `json:"account_id,omitempty"`
-	Trial          bool             `json:"trial"`
-	AllFeatures    bool             `json:"all_features"`
-	Version        uint64           `json:"version"`
-	Features       Features         `json:"features"`
+	LicenseExpires   *jwt.NumericDate `json:"license_expires,omitempty"`
+	AccountType      string           `json:"account_type,omitempty"`
+	AccountID        string           `json:"account_id,omitempty"`
+	Trial            bool             `json:"trial"`
+	AllFeatures      bool             `json:"all_features"`
+	Version          uint64           `json:"version"`
+	Features         Features         `json:"features"`
+	RequireTelemetry bool             `json:"require_telemetry,omitempty"`
 }
 
 // ParseRaw consumes a license and returns the claims.
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -654,6 +654,7 @@ export const getEntitlements = async (): Promise<TypesGen.Entitlements> => {
         experimental: false,
         features: withDefaultFeatures({}),
         has_license: false,
+        require_telemetry: false,
         trial: false,
         warnings: [],
       }
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -359,6 +359,7 @@ export interface Entitlements {
   readonly errors: string[]
   readonly has_license: boolean
   readonly trial: boolean
+  readonly require_telemetry: boolean
   readonly experimental: boolean
 }
 
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -1119,6 +1119,7 @@ export const MockEntitlements: TypesGen.Entitlements = {
   has_license: false,
   features: withDefaultFeatures({}),
   experimental: false,
+  require_telemetry: false,
   trial: false,
 }
 
@@ -1128,6 +1129,7 @@ export const MockEntitlementsWithWarnings: TypesGen.Entitlements = {
   has_license: true,
   experimental: false,
   trial: false,
+  require_telemetry: false,
   features: withDefaultFeatures({
     user_limit: {
       enabled: true,
@@ -1151,6 +1153,7 @@ export const MockEntitlementsWithAuditLog: TypesGen.Entitlements = {
   warnings: [],
   has_license: true,
   experimental: false,
+  require_telemetry: false,
   trial: false,
   features: withDefaultFeatures({
     audit_log: {

Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,7 @@ curl -X GET http://coder-server:8080/api/v2/entitlements \`
`128`	`128`	`}`
`129`	`129`	`},`
`130`	`130`	`"has_license": true,`
	`131`	`+ "require_telemetry": true,`
`131`	`132`	`"trial": true,`
`132`	`133`	`"warnings": ["string"]`
`133`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -654,6 +654,7 @@ export const getEntitlements = async (): Promise<TypesGen.Entitlements> => {`
`654`	`654`	`experimental: false,`
`655`	`655`	`features: withDefaultFeatures({}),`
`656`	`656`	`has_license: false,`
	`657`	`+ require_telemetry: false,`
`657`	`658`	`trial: false,`
`658`	`659`	`warnings: [],`
`659`	`660`	`}`
Original file line number	Diff line number	Diff line change
`@@ -359,6 +359,7 @@ export interface Entitlements {`
`359`	`359`	`readonly errors: string[]`
`360`	`360`	`readonly has_license: boolean`
`361`	`361`	`readonly trial: boolean`
	`362`	`+ readonly require_telemetry: boolean`
`362`	`363`	`readonly experimental: boolean`
`363`	`364`	`}`
`364`	`365`