chore: Force license uuids to not be null (#6012)

Emyrk · web-flow · commit 733f58c76db4 · 2023-02-13T18:21:58.000-06:00
* chore: Force license uuids to not be null

* All unit tests generate uuids for licenses

* Update migration files to new numbers

* Put migration in transaction
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000097_license_not_null_uuid.down.sql b/coderd/database/migrations/000097_license_not_null_uuid.down.sql
@@ -0,0 +1 @@
+ALTER TABLE ONLY licenses ALTER COLUMN uuid DROP NOT NULL;
diff --git a/coderd/database/migrations/000097_license_not_null_uuid.up.sql b/coderd/database/migrations/000097_license_not_null_uuid.up.sql
@@ -0,0 +1,8 @@
+BEGIN;
+
+-- We need to assign uuids to any existing licenses that don't have them.
+UPDATE licenses SET uuid = gen_random_uuid() WHERE uuid IS NULL;
+-- Assert no licenses have null uuids.
+ALTER TABLE ONLY licenses ALTER COLUMN uuid SET NOT NULL;
+
+COMMIT;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/sqlc.yaml b/coderd/database/sqlc.yaml
@@ -43,6 +43,7 @@ overrides:
       troubleshooting_url: TroubleshootingURL
       default_ttl: DefaultTTL
       motd_file: MOTDFile
+      uuid: UUID
 
 sql:
   - schema: "./dump.sql"
diff --git a/coderd/telemetry/telemetry.go b/coderd/telemetry/telemetry.go
@@ -645,7 +645,7 @@ func ConvertTemplateVersion(version database.TemplateVersion) TemplateVersion {
 func ConvertLicense(license database.License) License {
 	return License{
 		UploadedAt: license.UploadedAt,
-		UUID:       license.Uuid.UUID,
+		UUID:       license.UUID,
 	}
 }
 
diff --git a/coderd/telemetry/telemetry_test.go b/coderd/telemetry/telemetry_test.go
@@ -71,10 +71,7 @@ func TestTelemetry(t *testing.T) {
 			UploadedAt: database.Now(),
 			JWT:        "",
 			Exp:        database.Now().Add(time.Hour),
-			Uuid: uuid.NullUUID{
-				UUID:  uuid.New(),
-				Valid: true,
-			},
+			UUID:       uuid.New(),
 		})
 		assert.NoError(t, err)
 		_, snapshot := collectSnapshot(t, db)
diff --git a/enterprise/coderd/coderdenttest/coderdenttest.go b/enterprise/coderd/coderdenttest/coderdenttest.go
@@ -11,6 +11,7 @@ import (
 	"time"
 
 	"github.com/golang-jwt/jwt/v4"
+	"github.com/google/uuid"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
@@ -128,6 +129,7 @@ func GenerateLicense(t *testing.T, options LicenseOptions) string {
 
 	c := &license.Claims{
 		RegisteredClaims: jwt.RegisteredClaims{
+			ID:        uuid.NewString(),
 			Issuer:    "test@testing.test",
 			ExpiresAt: jwt.NewNumericDate(options.ExpiresAt),
 			NotBefore: jwt.NewNumericDate(time.Now().Add(-time.Minute)),
diff --git a/enterprise/coderd/licenses.go b/enterprise/coderd/licenses.go
@@ -98,14 +98,19 @@ func (api *API) postLicense(rw http.ResponseWriter, r *http.Request) {
 	}
 
 	id, err := uuid.Parse(claims.ID)
+	if err != nil {
+		// If no uuid is in the license, we generate a random uuid.
+		// This is not ideal, and this should be fixed to require a uuid
+		// for all licenses. We require this patch to support older licenses.
+		// TODO: In the future (April 2023?) we should remove this and reissue
+		// old licenses with a uuid.
+		id = uuid.New()
+	}
 	dl, err := api.Database.InsertLicense(ctx, database.InsertLicenseParams{
 		UploadedAt: database.Now(),
 		JWT:        addLicense.License,
 		Exp:        expTime,
-		Uuid: uuid.NullUUID{
-			UUID:  id,
-			Valid: err == nil,
-		},
+		UUID:       id,
 	})
 	if err != nil {
 		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
@@ -229,7 +234,7 @@ func (api *API) deleteLicense(rw http.ResponseWriter, r *http.Request) {
 func convertLicense(dl database.License, c jwt.MapClaims) codersdk.License {
 	return codersdk.License{
 		ID:         dl.ID,
-		UUID:       dl.Uuid.UUID,
+		UUID:       dl.UUID,
 		UploadedAt: dl.UploadedAt,
 		Claims:     c,
 	}
diff --git a/enterprise/trialer/trialer.go b/enterprise/trialer/trialer.go
@@ -64,14 +64,14 @@ func New(db database.Store, url string, keys map[string]ed25519.PublicKey) func(
 			return xerrors.Errorf("parse claims: %w", err)
 		}
 		id, err := uuid.Parse(claims.ID)
+		if err != nil {
+			return xerrors.Errorf("parse uuid: %w", err)
+		}
 		_, err = db.InsertLicense(ctx, database.InsertLicenseParams{
 			UploadedAt: database.Now(),
 			JWT:        string(raw),
 			Exp:        expTime,
-			Uuid: uuid.NullUUID{
-				UUID:  id,
-				Valid: err == nil,
-			},
+			UUID:       id,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert license: %w", err)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE ONLY licenses ALTER COLUMN uuid DROP NOT NULL;`
Original file line number	Diff line number	Diff line change
`@@ -645,7 +645,7 @@ func ConvertTemplateVersion(version database.TemplateVersion) TemplateVersion {`
`645`	`645`	`func ConvertLicense(license database.License) License {`
`646`	`646`	`return License{`
`647`	`647`	`UploadedAt: license.UploadedAt,`
`648`		`- UUID: license.Uuid.UUID,`
	`648`	`+ UUID: license.UUID,`
`649`	`649`	`}`
`650`	`650`	`}`
`651`	`651`