package api_impl /* ***** BEGIN GPL LICENSE BLOCK ***** * * Original Code Copyright (C) 2022 Blender Foundation. * * This file is part of Flamenco. * * Flamenco is free software: you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free Software * Foundation, either version 3 of the License, or (at your option) any later * version. * * Flamenco is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR * A PARTICULAR PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along with * Flamenco. If not, see . * * ***** END GPL LICENSE BLOCK ***** */ import ( "fmt" "net/http" "strings" "github.com/google/uuid" "github.com/labstack/echo/v4" "golang.org/x/crypto/bcrypt" "gitlab.com/blender/flamenco-ng-poc/internal/manager/persistence" "gitlab.com/blender/flamenco-ng-poc/pkg/api" ) // RegisterWorker registers a new worker and stores it in the database. func (f *Flamenco) RegisterWorker(e echo.Context) error { logger := requestLogger(e) var req api.RegisterWorkerJSONBody err := e.Bind(&req) if err != nil { logger.Warn().Err(err).Msg("bad request received") return sendAPIError(e, http.StatusBadRequest, "invalid format") } // TODO: validate the request, should at least have non-empty name, secret, and platform. logger.Info().Str("nickname", req.Nickname).Msg("registering new worker") hashedPassword, err := bcrypt.GenerateFromPassword([]byte(req.Secret), bcrypt.DefaultCost) if err != nil { logger.Warn().Err(err).Msg("error hashing worker password") return sendAPIError(e, http.StatusBadRequest, "error hashing password") } dbWorker := persistence.Worker{ UUID: uuid.New().String(), Name: req.Nickname, Secret: string(hashedPassword), Platform: req.Platform, Address: e.RealIP(), SupportedTaskTypes: strings.Join(req.SupportedTaskTypes, ","), } if err := f.persist.CreateWorker(e.Request().Context(), &dbWorker); err != nil { logger.Warn().Err(err).Msg("error creating new worker in DB") return sendAPIError(e, http.StatusBadRequest, "error registering worker") } return e.JSON(http.StatusOK, &api.RegisteredWorker{ Uuid: dbWorker.UUID, Nickname: dbWorker.Name, Address: dbWorker.Address, LastActivity: dbWorker.LastActivity, Platform: dbWorker.Platform, Software: dbWorker.Software, Status: dbWorker.Status, SupportedTaskTypes: strings.Split(dbWorker.SupportedTaskTypes, ","), }) } func (f *Flamenco) SignOn(e echo.Context) error { logger := requestLogger(e) var req api.SignOnJSONBody err := e.Bind(&req) if err != nil { logger.Warn().Err(err).Msg("bad request received") return sendAPIError(e, http.StatusBadRequest, "invalid format") } logger.Info().Msg("worker signing on") w, err := f.workerUpdateAfterSignOn(e, req) if err != nil { return sendAPIError(e, http.StatusInternalServerError, "error storing worker in database") } resp := api.WorkerStateChange{} if w.StatusRequested != "" { resp.StatusRequested = w.StatusRequested } else { resp.StatusRequested = api.WorkerStatusAwake } return e.JSON(http.StatusOK, resp) } func (f *Flamenco) workerUpdateAfterSignOn(e echo.Context, update api.SignOnJSONBody) (*persistence.Worker, error) { logger := requestLogger(e) w := requestWorkerOrPanic(e) // Update the worker for with the new sign-on info. w.Status = api.WorkerStatusStarting w.Address = e.RealIP() w.Name = update.Nickname // Remove trailing spaces from task types, and convert to lower case. for idx := range update.SupportedTaskTypes { update.SupportedTaskTypes[idx] = strings.TrimSpace(strings.ToLower(update.SupportedTaskTypes[idx])) } w.SupportedTaskTypes = strings.Join(update.SupportedTaskTypes, ",") // Save the new Worker info to the database. err := f.persist.SaveWorker(e.Request().Context(), w) if err != nil { logger.Warn().Err(err). Str("newStatus", string(w.Status)). Msg("error storing Worker in database") return nil, err } return w, nil } func (f *Flamenco) SignOff(e echo.Context) error { logger := requestLogger(e) var req api.SignOnJSONBody err := e.Bind(&req) if err != nil { logger.Warn().Err(err).Msg("bad request received") return sendAPIError(e, http.StatusBadRequest, "invalid format") } logger.Info().Msg("worker signing off") w := requestWorkerOrPanic(e) w.Status = api.WorkerStatusOffline if w.StatusRequested == api.WorkerStatusShutdown { w.StatusRequested = "" } // TODO: check whether we should pass the request context here, or a generic // background context, as this should be stored even when the HTTP connection // is aborted. err = f.persist.SaveWorkerStatus(e.Request().Context(), w) if err != nil { logger.Warn(). Err(err). Str("newStatus", string(w.Status)). Msg("error storing worker status in database") return sendAPIError(e, http.StatusInternalServerError, "error storing new status in database") } return e.String(http.StatusNoContent, "") } // (GET /api/worker/state) func (f *Flamenco) WorkerState(e echo.Context) error { worker := requestWorkerOrPanic(e) if worker.StatusRequested == "" { return e.String(http.StatusNoContent, "") } return e.JSON(http.StatusOK, api.WorkerStateChange{ StatusRequested: worker.StatusRequested, }) } // Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals. // (POST /api/worker/state-changed) func (f *Flamenco) WorkerStateChanged(e echo.Context) error { logger := requestLogger(e) var req api.WorkerStateChangedJSONRequestBody err := e.Bind(&req) if err != nil { logger.Warn().Err(err).Msg("bad request received") return sendAPIError(e, http.StatusBadRequest, "invalid format") } w := requestWorkerOrPanic(e) logger = logger.With(). Str("currentStatus", string(w.Status)). Str("newStatus", string(req.Status)). Logger() w.Status = req.Status if w.StatusRequested != "" && req.Status != w.StatusRequested { logger.Warn(). Str("workersRequestedStatus", string(w.StatusRequested)). Msg("worker changed to status that was not requested") } else { logger.Info().Msg("worker changed status") // Either there was no status change request (and this is a no-op) or the // status change was actually acknowledging the request. w.StatusRequested = "" } err = f.persist.SaveWorkerStatus(e.Request().Context(), w) if err != nil { logger.Warn().Err(err). Str("newStatus", string(w.Status)). Msg("error storing Worker in database") return sendAPIError(e, http.StatusInternalServerError, "error storing worker in database") } return e.String(http.StatusNoContent, "") } func (f *Flamenco) ScheduleTask(e echo.Context) error { logger := requestLogger(e) worker := requestWorkerOrPanic(e) logger.Info().Msg("worker requesting task") // Check that this worker is actually allowed to do work. requiredStatusToGetTask := api.WorkerStatusAwake if worker.Status != api.WorkerStatusAwake { logger.Warn(). Str("workerStatus", string(worker.Status)). Str("requiredStatus", string(requiredStatusToGetTask)). Msg("worker asking for task but is in wrong state") return sendAPIError(e, http.StatusConflict, fmt.Sprintf("worker is in state %q, requires state %q to execute tasks", worker.Status, requiredStatusToGetTask)) } if worker.StatusRequested != "" { logger.Warn(). Str("workerStatus", string(worker.Status)). Str("requestedStatus", string(worker.StatusRequested)). Msg("worker asking for task but needs state change first") return e.JSON(http.StatusLocked, api.WorkerStateChange{ StatusRequested: worker.StatusRequested, }) } // Get a task to execute: dbTask, err := f.persist.ScheduleTask(worker) if err != nil { logger.Warn().Err(err).Msg("error scheduling task for worker") return sendAPIError(e, http.StatusInternalServerError, "internal error finding a task for you: %v", err) } if dbTask == nil { return e.String(http.StatusNoContent, "") } // Convert database objects to API objects: apiCommands := []api.Command{} for _, cmd := range dbTask.Commands { apiCommands = append(apiCommands, api.Command{ Name: cmd.Name, Parameters: cmd.Parameters, }) } apiTask := api.AssignedTask{ Uuid: dbTask.UUID, Commands: apiCommands, Job: dbTask.Job.UUID, JobPriority: dbTask.Job.Priority, JobType: dbTask.Job.JobType, Name: dbTask.Name, Priority: dbTask.Priority, Status: api.TaskStatus(dbTask.Status), TaskType: dbTask.Type, } // Perform variable replacement before sending to the Worker. customisedTask := replaceTaskVariables(f.config, apiTask, *worker) return e.JSON(http.StatusOK, customisedTask) }