Skip to content

feat: notify on workspace update #15979

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.

Sign up for GitHub

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 10 commits into from
Jan 2, 2025
Merged

feat: notify on workspace update #15979

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
541b852
add notification on workspace update
DanielleMaywood Dec 30, 2024
835e49c
tests: test expectations
DanielleMaywood Dec 30, 2024
b43a7e6
chore: change error message, add error log
DanielleMaywood Dec 31, 2024
c683985
chore: apply feedback
DanielleMaywood Dec 31, 2024
b3707a1
fix: broken logic
DanielleMaywood Dec 31, 2024
7f10ecc
chore: wrap in transaction
DanielleMaywood Jan 2, 2025
1a493ff
chore: remove whitespace between call and return err
DanielleMaywood Jan 2, 2025
32adc00
chore: actually use the transaction, oops
DanielleMaywood Jan 2, 2025
90380f7
chore: changes
DanielleMaywood Jan 2, 2025
71ec1ac
chore: move prep of builder and notify out of tx
DanielleMaywood Jan 2, 2025
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
Prev Previous commit
chore: move prep of builder and notify out of tx
  • Loading branch information
@DanielleMaywood
DanielleMaywood committed Jan 2, 2025
commit 71ec1ac108339cde47aaae060fcb1249ba6b574c
39 changes: 17 additions & 22 deletions coderd/workspacebuilds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,12 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
return
}

builder := wsbuilder.New(workspace, database.WorkspaceTransition(createBuild.Transition)).
Initiator(apiKey.UserID).
RichParameterValues(createBuild.RichParameterValues).
LogLevel(string(createBuild.LogLevel)).
DeploymentValues(api.Options.DeploymentValues)

var (
previousWorkspaceBuild database.WorkspaceBuild
workspaceBuild *database.WorkspaceBuild
Expand All @@ -348,12 +354,6 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
return nil
}

builder := wsbuilder.New(workspace, database.WorkspaceTransition(createBuild.Transition)).
Initiator(apiKey.UserID).
RichParameterValues(createBuild.RichParameterValues).
LogLevel(string(createBuild.LogLevel)).
DeploymentValues(api.Options.DeploymentValues)

if createBuild.TemplateVersionID != uuid.Nil {
builder = builder.VersionID(createBuild.TemplateVersionID)
}
Expand Down Expand Up @@ -385,17 +385,7 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
},
audit.WorkspaceBuildBaggageFromRequest(r),
)
if err != nil {
return err
}

// If this workspace build has a different template version ID to the previous build
// we can assume it has just been updated.
if createBuild.TemplateVersionID != uuid.Nil && createBuild.TemplateVersionID != previousWorkspaceBuild.TemplateVersionID {
api.notifyWorkspaceUpdated(ctx, tx, apiKey.UserID, workspace, createBuild.RichParameterValues)
}

return nil
return err
}, nil)
var buildErr wsbuilder.BuildError
if xerrors.As(err, &buildErr) {
Expand Down Expand Up @@ -453,6 +443,12 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
return
}

// If this workspace build has a different template version ID to the previous build
// we can assume it has just been updated.
if createBuild.TemplateVersionID != uuid.Nil && createBuild.TemplateVersionID != previousWorkspaceBuild.TemplateVersionID {
api.notifyWorkspaceUpdated(ctx, apiKey.UserID, workspace, createBuild.RichParameterValues)
}

api.publishWorkspaceUpdate(ctx, workspace.OwnerID, wspubsub.WorkspaceEvent{
Kind: wspubsub.WorkspaceEventKindStateChange,
WorkspaceID: workspace.ID,
Expand All @@ -463,32 +459,31 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {

func (api *API) notifyWorkspaceUpdated(
ctx context.Context,
db database.Store,
initiatorID uuid.UUID,
workspace database.Workspace,
parameters []codersdk.WorkspaceBuildParameter,
) {
log := api.Logger.With(slog.F("workspace_id", workspace.ID))

template, err := db.GetTemplateByID(ctx, workspace.TemplateID)
template, err := api.Database.GetTemplateByID(ctx, workspace.TemplateID)
if err != nil {
log.Warn(ctx, "failed to fetch template for workspace creation notification", slog.F("template_id", workspace.TemplateID), slog.Error(err))
return
}

version, err := db.GetTemplateVersionByID(ctx, template.ActiveVersionID)
version, err := api.Database.GetTemplateVersionByID(ctx, template.ActiveVersionID)
if err != nil {
log.Warn(ctx, "failed to fetch template version for workspace creation notification", slog.F("template_id", workspace.TemplateID), slog.Error(err))
return
}

initiator, err := db.GetUserByID(ctx, initiatorID)
initiator, err := api.Database.GetUserByID(ctx, initiatorID)
if err != nil {
log.Warn(ctx, "failed to fetch user for workspace update notification", slog.F("initiator_id", initiatorID), slog.Error(err))
return
}

owner, err := db.GetUserByID(ctx, workspace.OwnerID)
owner, err := api.Database.GetUserByID(ctx, workspace.OwnerID)
if err != nil {
log.Warn(ctx, "failed to fetch user for workspace update notification", slog.F("owner_id", workspace.OwnerID), slog.Error(err))
return
Expand Down
Loading