Skip to content

fix(api): craft workflow run now locks repository #5943

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 1 commit into from
Sep 20, 2021
Merged

fix(api): craft workflow run now locks repository #5943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 32 additions & 13 deletions engine/api/workflow_run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (
"github.com/ovh/cds/engine/api/project"
"github.com/ovh/cds/engine/api/services"
"github.com/ovh/cds/engine/api/workflow"
"github.com/ovh/cds/engine/cache"
"github.com/ovh/cds/engine/featureflipping"
"github.com/ovh/cds/engine/service"
"github.com/ovh/cds/sdk"
Expand Down Expand Up @@ -949,7 +950,7 @@ func (api *API) postWorkflowRunHandler() service.Handler {
}
}

func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Workflow, wfRun *sdk.WorkflowRun, opts sdk.WorkflowRunPostHandlerOption) {
func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Workflow, wfRun *sdk.WorkflowRun, opts sdk.WorkflowRunPostHandlerOption) *workflow.ProcessorReport {
ctx, end := telemetry.Span(ctx, "api.initWorkflowRun",
telemetry.Tag(telemetry.TagProjectKey, projKey),
telemetry.Tag(telemetry.TagWorkflow, wf.Name),
Expand All @@ -965,15 +966,15 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
if err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, err)
report.Merge(ctx, r)
return
return report
}

// Add service for consumer if exists
s, err := services.LoadByConsumerID(context.Background(), api.mustDB(), c.ID)
if err != nil && !sdk.ErrorIs(err, sdk.ErrNotFound) {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, err)
report.Merge(ctx, r)
return
return report
}
c.Service = s

Expand All @@ -985,7 +986,23 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
if err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "cannot load project for as code workflow creation"))
report.Merge(ctx, r)
return
return report
}

// To avoid crafting more than once workflow as code from the same repo at the same time
// We lock the repository in redis
if wf.FromRepository != "" {
cackeKey := cache.Key("api", "initworkflow", "repository", wf.FromRepository)
ok, err := api.Cache.Lock(cackeKey, time.Minute, 100, 5)
if err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable lock repository in cache"))
report.Merge(ctx, r)
return report
}
if !ok {
return nil
}
defer api.Cache.Unlock(cackeKey) // nolint
}

defer func() {
Expand All @@ -1000,13 +1017,13 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
if err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to sync as code event"))
report.Merge(ctx, r)
return
return report
}
if res.Merged {
if err := workflow.UpdateFromRepository(api.mustDB(), wf.ID, res.FromRepository); err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to sync as code event"))
report.Merge(ctx, r)
return
return report
}
wf.FromRepository = res.FromRepository
event.PublishWorkflowUpdate(ctx, p.Key, *wf, *wf, c)
Expand Down Expand Up @@ -1034,7 +1051,7 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
if err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "cannot load project for as code workflow creation"))
report.Merge(ctx, r)
return
return report
}

// Get workflow from repository
Expand All @@ -1050,7 +1067,7 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
if err != nil {
r1 := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to get workflow from repository"))
report.Merge(ctx, r1)
return
return report
}

event.PublishWorkflowUpdate(ctx, p.Key, *wf, oldWf, c)
Expand All @@ -1060,7 +1077,7 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
if err != nil {
r1 := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to retrieve workflow secret"))
report.Merge(ctx, r1)
return
return report
}
}

Expand All @@ -1069,15 +1086,15 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
if err := saveWorkflowRunSecrets(ctx, api.mustDB(), p.ID, *wfRun, workflowSecrets); err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to compute workflow secrets %s/%s", p.Key, wf.Name))
report.Merge(ctx, r)
return
return report
}
}

tx, err := api.mustDB().Begin()
if err != nil {
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to start workflow %s/%s", p.Key, wf.Name))
report.Merge(ctx, r)
return
return report
}

r, err := workflow.StartWorkflowRun(ctx, tx, api.Cache, *p, wfRun, &opts, *c, asCodeInfosMsg)
Expand All @@ -1086,13 +1103,13 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
_ = tx.Rollback()
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to start workflow %s/%s", p.Key, wf.Name))
report.Merge(ctx, r)
return
return report
}
if err := tx.Commit(); err != nil {
_ = tx.Rollback()
r := failInitWorkflowRun(ctx, api.mustDB(), wfRun, sdk.WrapError(err, "unable to start workflow %s/%s", p.Key, wf.Name))
report.Merge(ctx, r)
return
return report
}
workflow.ResyncNodeRunsWithCommits(ctx, api.mustDB(), api.Cache, *p, report)

Expand Down Expand Up @@ -1125,6 +1142,8 @@ func (api *API) initWorkflowRun(ctx context.Context, projKey string, wf *sdk.Wor
log.Error(ctx, "unable to update parent workflow run: %v", err)
}
}

return report
}

func saveWorkflowRunSecrets(ctx context.Context, db *gorp.DbMap, projID int64, wr sdk.WorkflowRun, secrets *workflow.PushSecrets) error {
Expand Down
5 changes: 4 additions & 1 deletion engine/api/workflow_run_craft.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,10 @@ func (api *API) workflowRunCraft(ctx context.Context, id int64) error {

log.Debug(ctx, "api.workflowRunCraft> crafting workflow %s/%s #%d.%d (%d)", proj.Key, wf.Name, run.Number, run.LastSubNumber, run.ID)

api.initWorkflowRun(ctx, proj.Key, wf, run, *run.ToCraftOpts)
if api.initWorkflowRun(ctx, proj.Key, wf, run, *run.ToCraftOpts) == nil {
// If not report is sent back, it means that nothing has been done.
return nil
}

log.Info(ctx, "api.workflowRunCraft> workflow %s/%s #%d.%d (%d) crafted", proj.Key, wf.Name, run.Number, run.LastSubNumber, run.ID)

Expand Down