Skip to content

fix(coderd): alter return signature of convertWorkspace, add check for requesterID #11796

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 1 commit into from
Jan 24, 2024
Merged
Changes from all 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
93 changes: 73 additions & 20 deletions coderd/workspaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,23 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
})
return
}
httpapi.Write(ctx, rw, http.StatusOK, convertWorkspace(

w, err := convertWorkspace(
apiKey.UserID,
workspace,
data.builds[0],
data.templates[0],
ownerName,
api.Options.AllowWorkspaceRenames,
))
)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error converting workspace.",
Detail: err.Error(),
})
return
}
httpapi.Write(ctx, rw, http.StatusOK, w)
}

// workspaces returns all workspaces a user can read.
Expand Down Expand Up @@ -280,14 +289,22 @@ func (api *API) workspaceByOwnerAndName(rw http.ResponseWriter, r *http.Request)
})
return
}
httpapi.Write(ctx, rw, http.StatusOK, convertWorkspace(
w, err := convertWorkspace(
apiKey.UserID,
workspace,
data.builds[0],
data.templates[0],
ownerName,
api.Options.AllowWorkspaceRenames,
))
)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error converting workspace.",
Detail: err.Error(),
})
return
}
httpapi.Write(ctx, rw, http.StatusOK, w)
}

// Create a new workspace for the currently authenticated user.
Expand Down Expand Up @@ -590,14 +607,22 @@ func (api *API) postWorkspacesByOrganization(rw http.ResponseWriter, r *http.Req
return
}

httpapi.Write(ctx, rw, http.StatusCreated, convertWorkspace(
w, err := convertWorkspace(
apiKey.UserID,
workspace,
apiBuild,
template,
member.Username,
api.Options.AllowWorkspaceRenames,
))
)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error converting workspace.",
Detail: err.Error(),
})
return
}
httpapi.Write(ctx, rw, http.StatusCreated, w)
}

// @Summary Update workspace metadata by ID
Expand Down Expand Up @@ -931,14 +956,23 @@ func (api *API) putWorkspaceDormant(rw http.ResponseWriter, r *http.Request) {
}

aReq.New = workspace
httpapi.Write(ctx, rw, http.StatusOK, convertWorkspace(

w, err := convertWorkspace(
apiKey.UserID,
workspace,
data.builds[0],
data.templates[0],
ownerName,
api.Options.AllowWorkspaceRenames,
))
)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error converting workspace.",
Detail: err.Error(),
})
return
}
httpapi.Write(ctx, rw, http.StatusOK, w)
}

// @Summary Extend workspace deadline by ID
Expand Down Expand Up @@ -1349,16 +1383,27 @@ func (api *API) watchWorkspace(rw http.ResponseWriter, r *http.Request) {
})
return
}

w, err := convertWorkspace(
apiKey.UserID,
workspace,
data.builds[0],
data.templates[0],
ownerName,
api.Options.AllowWorkspaceRenames,
)
if err != nil {
_ = sendEvent(ctx, codersdk.ServerSentEvent{
Type: codersdk.ServerSentEventTypeError,
Data: codersdk.Response{
Message: "Internal error converting workspace.",
Detail: err.Error(),
},
})
}
_ = sendEvent(ctx, codersdk.ServerSentEvent{
Type: codersdk.ServerSentEventTypeData,
Data: convertWorkspace(
apiKey.UserID,
workspace,
data.builds[0],
data.templates[0],
ownerName,
api.Options.AllowWorkspaceRenames,
),
Data: w,
})
}

Expand Down Expand Up @@ -1505,14 +1550,19 @@ func convertWorkspaces(requesterID uuid.UUID, workspaces []database.Workspace, d
continue
}

apiWorkspaces = append(apiWorkspaces, convertWorkspace(
w, err := convertWorkspace(
requesterID,
workspace,
build,
template,
owner.Username,
data.allowRenames,
))
)
if err != nil {
return nil, xerrors.Errorf("convert workspace: %w", err)
}

apiWorkspaces = append(apiWorkspaces, w)
}
return apiWorkspaces, nil
}
Expand All @@ -1524,7 +1574,10 @@ func convertWorkspace(
template database.Template,
ownerName string,
allowRenames bool,
) codersdk.Workspace {
) (codersdk.Workspace, error) {
if requesterID == uuid.Nil {
return codersdk.Workspace{}, xerrors.Errorf("developer error: requesterID cannot be uuid.Nil!")
}
var autostartSchedule *string
if workspace.AutostartSchedule.Valid {
autostartSchedule = &workspace.AutostartSchedule.String
Expand Down Expand Up @@ -1583,7 +1636,7 @@ func convertWorkspace(
AutomaticUpdates: codersdk.AutomaticUpdates(workspace.AutomaticUpdates),
AllowRenames: allowRenames,
Favorite: requesterFavorite,
}
}, nil
}

func convertWorkspaceTTLMillis(i sql.NullInt64) *int64 {
Expand Down