feat: Add trial property to licenses

kylecarbs · kylecarbs · commit 4df3f356b226 · 2022-10-05T04:01:33.000Z
This allows the frontend to display whether the user is on
a trial license of Coder. This is useful for advertising
Enterprise functionality.
diff --git a/codersdk/features.go b/codersdk/features.go
@@ -42,6 +42,7 @@ type Entitlements struct {
 	Warnings     []string           `json:"warnings"`
 	HasLicense   bool               `json:"has_license"`
 	Experimental bool               `json:"experimental"`
+	Trial        bool               `json:"trial"`
 }
 
 func (c *Client) Entitlements(ctx context.Context) (Entitlements, error) {
diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -122,6 +122,7 @@ type API struct {
 
 type entitlements struct {
 	hasLicense     bool
+	trial          bool
 	activeUsers    codersdk.Feature
 	auditLogs      codersdk.Entitlement
 	browserOnly    codersdk.Entitlement
@@ -154,6 +155,7 @@ func (api *API) updateEntitlements(ctx context.Context) error {
 		scim:           codersdk.EntitlementNotEntitled,
 		browserOnly:    codersdk.EntitlementNotEntitled,
 		workspaceQuota: codersdk.EntitlementNotEntitled,
+		trial:          true,
 	}
 
 	// Here we loop through licenses to detect enabled features.
@@ -195,6 +197,9 @@ func (api *API) updateEntitlements(ctx context.Context) error {
 		if claims.Features.WorkspaceQuota > 0 {
 			entitlements.workspaceQuota = entitlement
 		}
+		if !claims.Trial {
+			entitlements.trial = claims.Trial
+		}
 	}
 
 	if entitlements.auditLogs != api.entitlements.auditLogs {
@@ -240,6 +245,7 @@ func (api *API) serveEntitlements(rw http.ResponseWriter, r *http.Request) {
 		Features:     make(map[string]codersdk.Feature),
 		Warnings:     make([]string, 0),
 		HasLicense:   entitlements.hasLicense,
+		Trial:        entitlements.trial,
 		Experimental: api.Experimental,
 	}
 
diff --git a/enterprise/coderd/coderdenttest/coderdenttest.go b/enterprise/coderd/coderdenttest/coderdenttest.go
@@ -84,6 +84,7 @@ func NewWithAPI(t *testing.T, options *Options) (*codersdk.Client, io.Closer, *c
 type LicenseOptions struct {
 	AccountType    string
 	AccountID      string
+	Trial          bool
 	GraceAt        time.Time
 	ExpiresAt      time.Time
 	UserLimit      int64
@@ -137,6 +138,7 @@ func GenerateLicense(t *testing.T, options LicenseOptions) string {
 		LicenseExpires: jwt.NewNumericDate(options.GraceAt),
 		AccountType:    options.AccountType,
 		AccountID:      options.AccountID,
+		Trial:          options.Trial,
 		Version:        coderd.CurrentVersion,
 		Features: coderd.Features{
 			UserLimit:      options.UserLimit,
diff --git a/enterprise/coderd/licenses.go b/enterprise/coderd/licenses.go
@@ -62,6 +62,7 @@ type Claims struct {
 	LicenseExpires *jwt.NumericDate `json:"license_expires,omitempty"`
 	AccountType    string           `json:"account_type,omitempty"`
 	AccountID      string           `json:"account_id,omitempty"`
+	Trial          bool             `json:"trial"`
 	Version        uint64           `json:"version"`
 	Features       Features         `json:"features"`
 }
diff --git a/enterprise/coderd/licenses_test.go b/enterprise/coderd/licenses_test.go
@@ -89,6 +89,7 @@ func TestGetLicense(t *testing.T) {
 			AuditLog:    true,
 			SCIM:        true,
 			BrowserOnly: true,
+			Trial:       true,
 			UserLimit:   200,
 		})
 
@@ -106,6 +107,7 @@ func TestGetLicense(t *testing.T) {
 		}, licenses[0].Claims["features"])
 		assert.Equal(t, int32(2), licenses[1].ID)
 		assert.Equal(t, "testing2", licenses[1].Claims["account_id"])
+		assert.Equal(t, true, licenses[1].Claims["trial"])
 		assert.Equal(t, map[string]interface{}{
 			codersdk.FeatureUserLimit:      json.Number("200"),
 			codersdk.FeatureAuditLog:       json.Number("1"),

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ type Entitlements struct {`
`42`	`42`	Warnings []string `json:"warnings"`
`43`	`43`	HasLicense bool `json:"has_license"`
`44`	`44`	Experimental bool `json:"experimental"`
	`45`	+ Trial bool `json:"trial"`
`45`	`46`	`}`
`46`	`47`
`47`	`48`	`func (c *Client) Entitlements(ctx context.Context) (Entitlements, error) {`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ type Claims struct {`
`62`	`62`	LicenseExpires *jwt.NumericDate `json:"license_expires,omitempty"`
`63`	`63`	AccountType string `json:"account_type,omitempty"`
`64`	`64`	AccountID string `json:"account_id,omitempty"`
	`65`	+ Trial bool `json:"trial"`
`65`	`66`	Version uint64 `json:"version"`
`66`	`67`	Features Features `json:"features"`
`67`	`68`	`}`