Skip to content

refactor: Show template versions as timeline #4800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Oct 31, 2022
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/templateversions.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ func displayTemplateVersions(activeVersionID uuid.UUID, templateVersions ...code
rows[i] = templateVersionRow{
Name: templateVersion.Name,
CreatedAt: templateVersion.CreatedAt,
CreatedBy: templateVersion.CreatedByName,
CreatedBy: templateVersion.CreatedBy.Username,
Status: strings.Title(string(templateVersion.Job.Status)),
Active: activeStatus,
}
Expand Down
2 changes: 1 addition & 1 deletion cli/templateversions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func TestTemplateVersions(t *testing.T) {
require.NoError(t, <-errC)

pty.ExpectMatch(version.Name)
pty.ExpectMatch(version.CreatedByName)
pty.ExpectMatch(version.CreatedBy.Username)
pty.ExpectMatch("Active")
})
}
2 changes: 1 addition & 1 deletion coderd/database/dump.sql

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ALTER TABLE template_versions ALTER COLUMN created_by SET NULL
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ALTER TABLE template_versions ALTER COLUMN created_by SET NOT NULL
2 changes: 1 addition & 1 deletion coderd/database/models.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion coderd/database/queries.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 1 addition & 4 deletions coderd/templates.go
Original file line number Diff line number Diff line change
Expand Up @@ -658,10 +658,7 @@ func (api *API) autoImportTemplate(ctx context.Context, opts autoImportTemplateO
Name: namesgenerator.GetRandomName(1),
Readme: "",
JobID: job.ID,
CreatedBy: uuid.NullUUID{
UUID: opts.userID,
Valid: true,
},
CreatedBy: opts.userID,
})
if err != nil {
return xerrors.Errorf("insert template version: %w", err)
Expand Down
52 changes: 23 additions & 29 deletions coderd/templateversions.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package coderd

import (
"context"
"database/sql"
"encoding/json"
"errors"
Expand Down Expand Up @@ -43,16 +42,16 @@ func (api *API) templateVersion(rw http.ResponseWriter, r *http.Request) {
return
}

createdByName, err := getUsernameByUserID(ctx, api.Database, templateVersion.CreatedBy)
user, err := api.Database.GetUserByID(ctx, templateVersion.CreatedBy)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching creator name.",
Message: "Internal error on fetching user.",
Detail: err.Error(),
})
return
}

httpapi.Write(ctx, rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job), createdByName))
httpapi.Write(ctx, rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job), user))
}

func (api *API) patchCancelTemplateVersion(rw http.ResponseWriter, r *http.Request) {
Expand Down Expand Up @@ -523,15 +522,15 @@ func (api *API) templateVersionsByTemplate(rw http.ResponseWriter, r *http.Reque
})
return err
}
createdByName, err := getUsernameByUserID(ctx, store, version.CreatedBy)
user, err := api.Database.GetUserByID(ctx, version.CreatedBy)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching creator name.",
Message: "Internal error on fetching user.",
Detail: err.Error(),
})
return err
}
apiVersions = append(apiVersions, convertTemplateVersion(version, convertProvisionerJob(job), createdByName))
apiVersions = append(apiVersions, convertTemplateVersion(version, convertProvisionerJob(job), user))
}

return nil
Expand Down Expand Up @@ -581,16 +580,16 @@ func (api *API) templateVersionByName(rw http.ResponseWriter, r *http.Request) {
return
}

createdByName, err := getUsernameByUserID(ctx, api.Database, templateVersion.CreatedBy)
user, err := api.Database.GetUserByID(ctx, templateVersion.CreatedBy)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching creator name.",
Message: "Internal error on fetching user.",
Detail: err.Error(),
})
return
}

httpapi.Write(ctx, rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job), createdByName))
httpapi.Write(ctx, rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job), user))
}

func (api *API) patchActiveTemplateVersion(rw http.ResponseWriter, r *http.Request) {
Expand Down Expand Up @@ -841,10 +840,7 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
Name: req.Name,
Readme: "",
JobID: provisionerJob.ID,
CreatedBy: uuid.NullUUID{
UUID: apiKey.UserID,
Valid: true,
},
CreatedBy: apiKey.UserID,
})
if err != nil {
return xerrors.Errorf("insert template version: %w", err)
Expand All @@ -859,16 +855,16 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
}
aReq.New = templateVersion

createdByName, err := getUsernameByUserID(ctx, api.Database, templateVersion.CreatedBy)
user, err := api.Database.GetUserByID(ctx, templateVersion.CreatedBy)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching creator name.",
Message: "Internal error on fetching user.",
Detail: err.Error(),
})
return
}

httpapi.Write(ctx, rw, http.StatusCreated, convertTemplateVersion(templateVersion, convertProvisionerJob(provisionerJob), createdByName))
httpapi.Write(ctx, rw, http.StatusCreated, convertTemplateVersion(templateVersion, convertProvisionerJob(provisionerJob), user))
}

// templateVersionResources returns the workspace agent resources associated
Expand Down Expand Up @@ -926,18 +922,17 @@ func (api *API) templateVersionLogs(rw http.ResponseWriter, r *http.Request) {
api.provisionerJobLogs(rw, r, job)
}

func getUsernameByUserID(ctx context.Context, db database.Store, userID uuid.NullUUID) (string, error) {
if !userID.Valid {
return "", nil
}
user, err := db.GetUserByID(ctx, userID.UUID)
if err != nil {
return "", err
func convertTemplateVersion(version database.TemplateVersion, job codersdk.ProvisionerJob, user database.User) codersdk.TemplateVersion {
createdBy := codersdk.User{
ID: user.ID,
Username: user.Username,
Email: user.Email,
CreatedAt: user.CreatedAt,
Status: codersdk.UserStatus(user.Status),
Roles: []codersdk.Role{},
AvatarURL: user.AvatarURL.String,
}
return user.Username, nil
}

func convertTemplateVersion(version database.TemplateVersion, job codersdk.ProvisionerJob, createdByName string) codersdk.TemplateVersion {
return codersdk.TemplateVersion{
ID: version.ID,
TemplateID: &version.TemplateID.UUID,
Expand All @@ -947,7 +942,6 @@ func convertTemplateVersion(version database.TemplateVersion, job codersdk.Provi
Name: version.Name,
Job: job,
Readme: version.Readme,
CreatedByID: version.CreatedBy.UUID,
CreatedByName: createdByName,
CreatedBy: createdBy,
}
}
3 changes: 1 addition & 2 deletions codersdk/templateversions.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ type TemplateVersion struct {
Name string `json:"name"`
Job ProvisionerJob `json:"job"`
Readme string `json:"readme"`
CreatedByID uuid.UUID `json:"created_by_id"`
CreatedByName string `json:"created_by_name"`
CreatedBy User `json:"created_by"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd make this Creator instead

Copy link
Collaborator Author

@BrunoQuaresma BrunoQuaresma Oct 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have a strong opinion about that? I like the CreatedBy tho and it keeps consistent with the database so makes it easier, at least for me, to find and associate with the DB data.

}

// TemplateVersion returns a template version by ID.
Expand Down
3 changes: 1 addition & 2 deletions site/src/api/typesGenerated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -656,8 +656,7 @@ export interface TemplateVersion {
readonly name: string
readonly job: ProvisionerJob
readonly readme: string
readonly created_by_id: string
readonly created_by_name: string
readonly created_by: User
}

// From codersdk/templates.go
Expand Down
46 changes: 0 additions & 46 deletions site/src/components/BuildsTable/BuildDateRow.tsx

This file was deleted.

52 changes: 11 additions & 41 deletions site/src/components/BuildsTable/BuildsTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import TableBody from "@material-ui/core/TableBody"
import TableCell from "@material-ui/core/TableCell"
import TableContainer from "@material-ui/core/TableContainer"
import TableRow from "@material-ui/core/TableRow"
import { FC, Fragment } from "react"
import { Timeline } from "components/Timeline/Timeline"
import { FC } from "react"
import * as TypesGen from "../../api/typesGenerated"
import { EmptyState } from "../EmptyState/EmptyState"
import { TableLoader } from "../TableLoader/TableLoader"
import { BuildDateRow } from "./BuildDateRow"
import { BuildRow } from "./BuildRow"

export const Language = {
Expand All @@ -24,52 +24,22 @@ export interface BuildsTableProps {
builds?: TypesGen.WorkspaceBuild[]
}

const groupBuildsByDate = (builds?: TypesGen.WorkspaceBuild[]) => {
const buildsByDate: Record<string, TypesGen.WorkspaceBuild[]> = {}

if (!builds) {
return
}

builds.forEach((build) => {
const dateKey = new Date(build.created_at).toDateString()

// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (buildsByDate[dateKey]) {
buildsByDate[dateKey].push(build)
} else {
buildsByDate[dateKey] = [build]
}
})

return buildsByDate
}

export const BuildsTable: FC<React.PropsWithChildren<BuildsTableProps>> = ({
builds,
}) => {
const isLoading = !builds
const buildsByDate = groupBuildsByDate(builds)

return (
<TableContainer>
<Table data-testid="builds-table" aria-describedby="builds table">
<TableBody>
{isLoading && <TableLoader />}

{buildsByDate &&
Object.keys(buildsByDate).map((dateStr) => {
const builds = buildsByDate[dateStr]

return (
<Fragment key={dateStr}>
<BuildDateRow date={new Date(dateStr)} />
{builds.map((build) => (
<BuildRow key={build.id} build={build} />
))}
</Fragment>
)
})}
{builds ? (
<Timeline
items={builds}
getDate={(build) => new Date(build.created_at)}
row={(build) => <BuildRow key={build.id} build={build} />}
/>
) : (
<TableLoader />
)}

{builds && builds.length === 0 && (
<TableRow>
Expand Down
53 changes: 53 additions & 0 deletions site/src/components/Timeline/Timeline.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import { TimelineDateRow } from "components/Timeline/TimelineDateRow"
import { Fragment } from "react"

type GetDateFn<TData> = (data: TData) => Date

const groupByDate = <TData,>(
items: TData[],
getDate: GetDateFn<TData>,
): Record<string, TData[]> => {
const itemsByDate: Record<string, TData[]> = {}

items.forEach((item) => {
const dateKey = getDate(item).toDateString()

// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (itemsByDate[dateKey]) {
itemsByDate[dateKey].push(item)
} else {
itemsByDate[dateKey] = [item]
}
})

return itemsByDate
}

export interface TimelineProps<TData> {
items: TData[]
getDate: GetDateFn<TData>
row: (item: TData) => JSX.Element
}

export const Timeline = <TData,>({
items,
getDate,
row,
}: TimelineProps<TData>): JSX.Element => {
const itemsByDate = groupByDate(items, getDate)

return (
<>
{Object.keys(itemsByDate).map((dateStr) => {
const items = itemsByDate[dateStr]

return (
<Fragment key={dateStr}>
<TimelineDateRow date={new Date(dateStr)} />
{items.map(row)}
</Fragment>
)
})}
</>
)
}
Loading