feat: claim prebuilds based on workspace parameters instead of preset id #19279
Conversation
e999a58 to
f07cccc
Compare
| @@ -1810,6 +1810,14 @@ func (q *querier) FetchVolumesResourceMonitorsUpdatedAfter(ctx context.Context, | |||
| return q.db.FetchVolumesResourceMonitorsUpdatedAfter(ctx, updatedAt) | |||
| } | |||
|
|
|||
| func (q *querier) FindMatchingPresetID(ctx context.Context, arg database.FindMatchingPresetIDParams) (uuid.UUID, error) { | |||
| _, err := q.GetTemplateVersionByID(ctx, arg.TemplateVersionID) | |||
There was a problem hiding this comment.
I don't like this, but I can't find a better way and there is precedent for this approach. Open to alternatives.
There was a problem hiding this comment.
The alternative is to essentially duplicate the logic in GetTemplateVersionByID, which I'm less a fan of.
| return err | ||
| } | ||
|
|
||
| if b.templateVersionPresetID == uuid.Nil { |
There was a problem hiding this comment.
This is not strictly necessary for when a prebuilt workspace is claimed, but it ensures that a workspace build always has a preset ID set if one matches.
| @@ -1810,6 +1810,14 @@ func (q *querier) FetchVolumesResourceMonitorsUpdatedAfter(ctx context.Context, | |||
| return q.db.FetchVolumesResourceMonitorsUpdatedAfter(ctx, updatedAt) | |||
| } | |||
|
|
|||
| func (q *querier) FindMatchingPresetID(ctx context.Context, arg database.FindMatchingPresetIDParams) (uuid.UUID, error) { | |||
| _, err := q.GetTemplateVersionByID(ctx, arg.TemplateVersionID) | |||
There was a problem hiding this comment.
The alternative is to essentially duplicate the logic in GetTemplateVersionByID, which I'm less a fan of.
| SELECT unnest(@parameter_names::text[]) AS name, | ||
| unnest(@parameter_values::text[]) AS value |
There was a problem hiding this comment.
| SELECT unnest(@parameter_names::text[]) AS name, | |
| unnest(@parameter_values::text[]) AS value | |
| SELECT | |
| unnest(@parameter_names::text[]) AS name, | |
| unnest(@parameter_values::text[]) AS value |
I suggest avoiding alignment, and if needed, line-break so indentation can be used.
| COALESCE(COUNT(tvpp.name), 0) AS total_preset_params, | ||
| COALESCE(COUNT(pp.name), 0) AS matching_params | ||
| FROM template_version_presets tvp | ||
| LEFT JOIN template_version_preset_parameters tvpp ON tvpp.template_version_preset_id = tvp.id |
There was a problem hiding this comment.
These left join suggests there is merit in including presets with no parameters as well as zero matches with provided params, why would we want this?
There was a problem hiding this comment.
Presets that define 0 parameters are valid. They're used in more trivial templates, usually docker based, where there really isn't much to change but one still wants prebuilds. In this case one would define a preset with no parameters that desires n prebuilt workspaces. This form of the query allows a workspace in such a template to still match a preset and therefore claim a prebuilt workspace.
There was a problem hiding this comment.
This is useful for simpler parameters where one wants prebuilds without specifying any parameters. You could define a preset that sets no parameters. If such a preset exists, it would be selected automatically by this.
| if err != nil { | ||
| return BuildError{http.StatusInternalServerError, "find matching preset", err} | ||
| } | ||
| b.templateVersionPresetID = presetID |
There was a problem hiding this comment.
This code path could suggest to the reader that there will always be a match, a comment mentioning it will be nil if none is found may be beneficial to avoid wrong assumptions (since we're not returning error from find).
Closes #18356.
This change finds and selects a matching preset if one was not chosen during workspace creation. This solidifies the relationship between presets and parameters.
When a workspace is created without in explicitly chosen preset, it will now still be eligible to claim a prebuilt workspace if one is available.