studio/flamenco
studio/flamenco
12
30
Fork 38
Code Issues 63 Pull Requests 5 Releases Wiki Activity

Web Interface for Tags #104244

Merged
Sybren A. Stüvel merged 30 commits from Evelinealy/flamenco:tag-interface into main 2023-09-04 13:06:10 +02:00
Conversation 6 Commits 30 Files Changed 3 +77 -8
2 changed files with 77 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit ef4c573965 - Show all commits

48
internal/manager/api_impl/worker_mgt.go
View File

@ -237,13 +237,26 @@ func (f *Flamenco) SetWorkerTags(e echo.Context, workerUUID string) error {
func (f *Flamenco) DeleteWorkerTag(e echo.Context, tagUUID string) error {
ctx := e.Request().Context()
logger := requestLogger(e)
logger = logger.With().Str("tag", tagUUID).Logger()
logger = logger.With().Str("uuid", tagUUID).Logger()
if !uuid.IsValid(tagUUID) {
return sendAPIError(e, http.StatusBadRequest, "not a valid UUID")
}
err := f.persist.DeleteWorkerTag(ctx, tagUUID)
// Fetch the tag so its name can be logged.
dbTag, err := f.persist.FetchWorkerTag(ctx, tagUUID)
switch {
case errors.Is(err, persistence.ErrWorkerTagNotFound):
logger.Debug().Msg("non-existent worker tag requested")
return sendAPIError(e, http.StatusNotFound, "worker tag %q not found", tagUUID)
case err != nil:
logger.Error().Err(err).Msg("fetching worker tag")
return sendAPIError(e, http.StatusInternalServerError, "error fetching worker tag: %v", err)
}
logger = logger.With().Str("name", dbTag.Name).Logger()
err = f.persist.DeleteWorkerTag(ctx, tagUUID)
switch {
case errors.Is(err, persistence.ErrWorkerTagNotFound):
logger.Debug().Msg("non-existent worker tag requested")
@ -284,7 +297,7 @@ func (f *Flamenco) FetchWorkerTag(e echo.Context, tagUUID string) error {
func (f *Flamenco) UpdateWorkerTag(e echo.Context, tagUUID string) error {
ctx := e.Request().Context()
logger := requestLogger(e)
logger = logger.With().Str("tag", tagUUID).Logger()
logger = logger.With().Str("uuid", tagUUID).Logger()
if !uuid.IsValid(tagUUID) {
return sendAPIError(e, http.StatusBadRequest, "not a valid UUID")
@ -307,13 +320,24 @@ func (f *Flamenco) UpdateWorkerTag(e echo.Context, tagUUID string) error {
return sendAPIError(e, http.StatusInternalServerError, "error fetching worker tag: %v", err)
}
logCtx := logger.With()
if dbTag.Name == update.Name {
logCtx = logCtx.Str("name", dbTag.Name)
} else {
logCtx = logCtx.
Str("nameOld", dbTag.Name).
Str("nameNew", update.Name)
}
// Update the tag.
dbTag.Name = update.Name
if update.Description == nil {
dbTag.Description = ""
} else {
if update.Description != nil && dbTag.Description != *update.Description {
logCtx = logCtx.
Str("descriptionOld", dbTag.Description).
Str("descriptionNew", *update.Description)
dbTag.Description = *update.Description
}
logger = logCtx.Logger()
if err := f.persist.SaveWorkerTag(ctx, dbTag); err != nil {
logger.Error().Err(err).Msg("saving worker tag")
@ -321,7 +345,7 @@ func (f *Flamenco) UpdateWorkerTag(e echo.Context, tagUUID string) error {
}
// TODO: SocketIO broadcast of tag update.
logger.Info().Msg("worker tag updated")
return e.NoContent(http.StatusNoContent)
}
@ -366,20 +390,28 @@ func (f *Flamenco) CreateWorkerTag(e echo.Context) error {
tagUUID = uuid.New()
}
logCtx := logger.With().
Str("name", apiTag.Name).
Str("uuid", tagUUID)
dbTag := persistence.WorkerTag{
UUID: tagUUID,
Name: apiTag.Name,
}
if apiTag.Description != nil {
if apiTag.Description != nil && *apiTag.Description != "" {
dbTag.Description = *apiTag.Description
logCtx = logCtx.Str("description", dbTag.Description)
}
logger = logCtx.Logger()
// Store in the database.
if err := f.persist.CreateWorkerTag(ctx, &dbTag); err != nil {
logger.Error().Err(err).Msg("creating worker tag")
return sendAPIError(e, http.StatusInternalServerError, "error creating worker tag")
}
logger.Info().Msg("created new worker tag")
// TODO: SocketIO broadcast of tag creation.
return e.JSON(http.StatusOK, workerTagDBtoAPI(dbTag))

37
internal/manager/api_impl/worker_mgt_test.go
View File

@ -299,6 +299,23 @@ func TestWorkerTagCRUDHappyFlow(t *testing.T) {
Name: "updated name",
}
expectNewDBTag := persistence.WorkerTag{
UUID: UUID,
Name: newAPITag.Name,
Description: *apiTag.Description, // Not mentioning new description should keep old one.
}
// TODO: expect SocketIO broadcast of the tag update.
mf.persistence.EXPECT().FetchWorkerTag(gomock.Any(), UUID).Return(&expectDBTag, nil)
mf.persistence.EXPECT().SaveWorkerTag(gomock.Any(), &expectNewDBTag)
echo = mf.prepareMockedJSONRequest(newAPITag)
require.NoError(t, mf.flamenco.UpdateWorkerTag(echo, UUID))
assertResponseNoContent(t, echo)
// Update both description + name & save.
newAPITag = api.WorkerTag{
Name: "updated name",
Description: ptr(""),
}
expectNewDBTag = persistence.WorkerTag{
UUID: UUID,
Name: newAPITag.Name,
Description: "",
@ -310,10 +327,30 @@ func TestWorkerTagCRUDHappyFlow(t *testing.T) {
require.NoError(t, mf.flamenco.UpdateWorkerTag(echo, UUID))
assertResponseNoContent(t, echo)
// Update both description + name & save.
newAPITag = api.WorkerTag{
Name: "updated name",
Description: ptr("New Description"),
}
expectNewDBTag = persistence.WorkerTag{
UUID: UUID,
Name: newAPITag.Name,
Description: *newAPITag.Description,
}
// TODO: expect SocketIO broadcast of the tag update.
mf.persistence.EXPECT().FetchWorkerTag(gomock.Any(), UUID).Return(&expectDBTag, nil)
mf.persistence.EXPECT().SaveWorkerTag(gomock.Any(), &expectNewDBTag)
echo = mf.prepareMockedJSONRequest(newAPITag)
require.NoError(t, mf.flamenco.UpdateWorkerTag(echo, UUID))
assertResponseNoContent(t, echo)
// Delete.
mf.persistence.EXPECT().FetchWorkerTag(gomock.Any(), UUID).Return(&expectDBTag, nil)
mf.persistence.EXPECT().DeleteWorkerTag(gomock.Any(), UUID)
// TODO: expect SocketIO broadcast of the tag deletion.
echo = mf.prepareMockedJSONRequest(newAPITag)
require.NoError(t, mf.flamenco.DeleteWorkerTag(echo, UUID))
assertResponseNoContent(t, echo)
}
// TODO: add test for creation of already-existing tag.