fix: populate default created_by and add not-null constraint in templates (#2290)

AbhineetJain · web-flow · commit a91482cb257b · 2022-06-13T17:25:06.000Z
diff --git a/coderd/audit/diff_test.go b/coderd/audit/diff_test.go
@@ -88,7 +88,7 @@ func TestDiff(t *testing.T) {
 				ActiveVersionID:      uuid.UUID{3},
 				MaxTtl:               int64(time.Hour),
 				MinAutostartInterval: int64(time.Minute),
-				CreatedBy:            uuid.NullUUID{UUID: uuid.UUID{4}, Valid: true},
+				CreatedBy:            uuid.UUID{4},
 			},
 			exp: audit.Map{
 				"id":                     uuid.UUID{1}.String(),
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000023_template_created_by_not_null.down.sql b/coderd/database/migrations/000023_template_created_by_not_null.down.sql
@@ -0,0 +1 @@
+ALTER TABLE ONLY templates ALTER COLUMN created_by DROP NOT NULL;
diff --git a/coderd/database/migrations/000023_template_created_by_not_null.up.sql b/coderd/database/migrations/000023_template_created_by_not_null.up.sql
@@ -0,0 +1,14 @@
+UPDATE
+    templates
+SET
+    created_by = (
+        SELECT user_id FROM organization_members
+        WHERE organization_members.organization_id = templates.organization_id
+        ORDER BY created_at
+        LIMIT 1
+    )
+WHERE
+    created_by IS NULL;
+
+
+ALTER TABLE ONLY templates ALTER COLUMN created_by SET NOT NULL;
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/templates.go b/coderd/templates.go
@@ -186,10 +186,7 @@ func (api *API) postTemplateByOrganization(rw http.ResponseWriter, r *http.Reque
 			Description:          createTemplate.Description,
 			MaxTtl:               int64(maxTTL),
 			MinAutostartInterval: int64(minAutostartInterval),
-			CreatedBy: uuid.NullUUID{
-				UUID:  apiKey.UserID,
-				Valid: true,
-			},
+			CreatedBy:            apiKey.UserID,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert template: %s", err)
@@ -453,15 +450,11 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 func getCreatedByNamesByTemplateIDs(ctx context.Context, db database.Store, templates []database.Template) (map[string]string, error) {
 	creators := make(map[string]string, len(templates))
 	for _, template := range templates {
-		if template.CreatedBy.Valid {
-			creator, err := db.GetUserByID(ctx, template.CreatedBy.UUID)
-			if err != nil {
-				return map[string]string{}, err
-			}
-			creators[template.ID.String()] = creator.Username
-		} else {
-			creators[template.ID.String()] = ""
+		creator, err := db.GetUserByID(ctx, template.CreatedBy)
+		if err != nil {
+			return map[string]string{}, err
 		}
+		creators[template.ID.String()] = creator.Username
 	}
 	return creators, nil
 }
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -25,7 +25,7 @@ type Template struct {
 	Description                string          `json:"description"`
 	MaxTTLMillis               int64           `json:"max_ttl_ms"`
 	MinAutostartIntervalMillis int64           `json:"min_autostart_interval_ms"`
-	CreatedByID                uuid.NullUUID   `json:"created_by_id"`
+	CreatedByID                uuid.UUID       `json:"created_by_id"`
 	CreatedByName              string          `json:"created_by_name"`
 }
 
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -247,7 +247,7 @@ export interface Template {
   readonly description: string
   readonly max_ttl_ms: number
   readonly min_autostart_interval_ms: number
-  readonly created_by_id?: string
+  readonly created_by_id: string
   readonly created_by_name: string
 }
 
diff --git a/site/src/components/TemplateStats/TemplateStats.stories.tsx b/site/src/components/TemplateStats/TemplateStats.stories.tsx
@@ -23,12 +23,3 @@ UsedByMany.args = {
   },
   activeVersion: Mocks.MockTemplateVersion,
 }
-
-export const UnknownCreator = Template.bind({})
-UnknownCreator.args = {
-  template: {
-    ...Mocks.MockTemplate,
-    created_by_name: "",
-  },
-  activeVersion: Mocks.MockTemplateVersion,
-}
diff --git a/site/src/components/TemplateStats/TemplateStats.tsx b/site/src/components/TemplateStats/TemplateStats.tsx
@@ -14,7 +14,6 @@ const Language = {
   userPlural: "users",
   userSingular: "user",
   createdByLabel: "Created by",
-  defaultTemplateCreator: "<unknown>",
 }
 
 export interface TemplateStatsProps {
@@ -50,7 +49,7 @@ export const TemplateStats: FC<TemplateStatsProps> = ({ template, activeVersion
       <div className={styles.statsDivider} />
       <div className={styles.statItem}>
         <span className={styles.statsLabel}>{Language.createdByLabel}</span>
-        <span className={styles.statsValue}>{template.created_by_name || Language.defaultTemplateCreator}</span>
+        <span className={styles.statsValue}>{template.created_by_name}</span>
       </div>
     </div>
   )
diff --git a/site/src/pages/TemplatesPage/TemplatesPageView.tsx b/site/src/pages/TemplatesPage/TemplatesPageView.tsx
@@ -50,7 +50,6 @@ export const Language = {
   templateTooltipText: "With templates you can create a common configuration for your workspaces using Terraform.",
   templateTooltipLink: "Manage templates",
   createdByLabel: "Created by",
-  defaultTemplateCreator: "<unknown>",
 }
 
 const TemplateHelpTooltip: React.FC = () => {
@@ -140,7 +139,7 @@ export const TemplatesPageView: FC<TemplatesPageViewProps> = (props) => {
                 <TableCell>{Language.developerCount(template.workspace_owner_count)}</TableCell>
 
                 <TableCell data-chromatic="ignore">{dayjs().to(dayjs(template.updated_at))}</TableCell>
-                <TableCell>{template.created_by_name || Language.defaultTemplateCreator}</TableCell>
+                <TableCell>{template.created_by_name}</TableCell>
                 <TableCell>
                   <div className={styles.arrowCell}>
                     <KeyboardArrowRight className={styles.arrowRight} />

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE ONLY templates ALTER COLUMN created_by DROP NOT NULL;`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ type Template struct {`
`25`	`25`	Description string `json:"description"`
`26`	`26`	MaxTTLMillis int64 `json:"max_ttl_ms"`
`27`	`27`	MinAutostartIntervalMillis int64 `json:"min_autostart_interval_ms"`
`28`		- CreatedByID uuid.NullUUID `json:"created_by_id"`
	`28`	+ CreatedByID uuid.UUID `json:"created_by_id"`
`29`	`29`	CreatedByName string `json:"created_by_name"`
`30`	`30`	`}`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -247,7 +247,7 @@ export interface Template {`
`247`	`247`	`readonly description: string`
`248`	`248`	`readonly max_ttl_ms: number`
`249`	`249`	`readonly min_autostart_interval_ms: number`
`250`		`- readonly created_by_id?: string`
	`250`	`+ readonly created_by_id: string`
`251`	`251`	`readonly created_by_name: string`
`252`	`252`	`}`
`253`	`253`