package edgejobs import ( "errors" "maps" "net/http" "slices" "strconv" portainer "github.com/portainer/portainer/api" "github.com/portainer/portainer/api/dataservices" "github.com/portainer/portainer/api/internal/edge" "github.com/portainer/portainer/api/internal/edge/cache" "github.com/portainer/portainer/api/internal/endpointutils" httperror "github.com/portainer/portainer/pkg/libhttp/error" "github.com/portainer/portainer/pkg/libhttp/request" "github.com/asaskevich/govalidator" ) type edgeJobUpdatePayload struct { Name *string CronExpression *string Recurring *bool Endpoints []portainer.EndpointID EdgeGroups []portainer.EdgeGroupID FileContent *string } func (payload *edgeJobUpdatePayload) Validate(r *http.Request) error { if payload.Name != nil && !govalidator.Matches(*payload.Name, `^[a-zA-Z0-9][a-zA-Z0-9_.-]+$`) { return errors.New("invalid Edge job name format. Allowed characters are: [a-zA-Z0-9_.-]") } return nil } // @id EdgeJobUpdate // @summary Update an EdgeJob // @description **Access policy**: administrator // @tags edge_jobs // @security ApiKeyAuth // @security jwt // @accept json // @produce json // @param id path int true "EdgeJob Id" // @param body body edgeJobUpdatePayload true "EdgeGroup data" // @success 200 {object} portainer.EdgeJob // @failure 500 // @failure 400 // @failure 503 "Edge compute features are disabled" // @router /edge_jobs/{id} [put] func (handler *Handler) edgeJobUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError { edgeJobID, err := request.RetrieveNumericRouteVariableValue(r, "id") if err != nil { return httperror.BadRequest("Invalid Edge job identifier route variable", err) } var payload edgeJobUpdatePayload if err := request.DecodeAndValidateJSONPayload(r, &payload); err != nil { return httperror.BadRequest("Invalid request payload", err) } var edgeJob *portainer.EdgeJob err = handler.DataStore.UpdateTx(func(tx dataservices.DataStoreTx) error { edgeJob, err = handler.updateEdgeJob(tx, portainer.EdgeJobID(edgeJobID), payload) return err }) return txResponse(w, edgeJob, err) } func (handler *Handler) updateEdgeJob(tx dataservices.DataStoreTx, edgeJobID portainer.EdgeJobID, payload edgeJobUpdatePayload) (*portainer.EdgeJob, error) { edgeJob, err := tx.EdgeJob().Read(edgeJobID) if tx.IsErrObjectNotFound(err) { return nil, httperror.NotFound("Unable to find an Edge job with the specified identifier inside the database", err) } else if err != nil { return nil, httperror.InternalServerError("Unable to find an Edge job with the specified identifier inside the database", err) } if err := handler.updateEdgeSchedule(tx, edgeJob, &payload); err != nil { return nil, httperror.InternalServerError("Unable to update Edge job", err) } if err := tx.EdgeJob().Update(edgeJob.ID, edgeJob); err != nil { return nil, httperror.InternalServerError("Unable to persist Edge job changes inside the database", err) } return edgeJob, nil } func (handler *Handler) updateEdgeSchedule(tx dataservices.DataStoreTx, edgeJob *portainer.EdgeJob, payload *edgeJobUpdatePayload) error { if payload.Name != nil { edgeJob.Name = *payload.Name } endpointsToAdd := map[portainer.EndpointID]bool{} endpointsToRemove := map[portainer.EndpointID]bool{} if payload.Endpoints != nil { endpointsMap := map[portainer.EndpointID]portainer.EdgeJobEndpointMeta{} newEndpoints := endpointutils.EndpointSet(payload.Endpoints) for endpointID := range edgeJob.Endpoints { if !newEndpoints[endpointID] { endpointsToRemove[endpointID] = true } } for _, endpointID := range payload.Endpoints { endpoint, err := tx.Endpoint().Endpoint(endpointID) if err != nil { return err } if !endpointutils.IsEdgeEndpoint(endpoint) { continue } if meta, exists := edgeJob.Endpoints[endpointID]; exists { endpointsMap[endpointID] = meta } else { endpointsMap[endpointID] = portainer.EdgeJobEndpointMeta{} endpointsToAdd[endpointID] = true } } edgeJob.Endpoints = endpointsMap } if len(payload.EdgeGroups) == 0 && len(edgeJob.EdgeGroups) > 0 { endpoints, err := edge.GetEndpointsFromEdgeGroups(edgeJob.EdgeGroups, tx) if err != nil { return errors.New("unable to get endpoints from edge groups") } for _, endpointID := range endpoints { endpointsToRemove[endpointID] = true } edgeJob.EdgeGroups = nil } edgeGroupsToAdd := []portainer.EdgeGroupID{} edgeGroupsToRemove := []portainer.EdgeGroupID{} endpointsFromGroupsToAddMap := map[portainer.EndpointID]portainer.EdgeJobEndpointMeta{} if len(payload.EdgeGroups) > 0 { for _, edgeGroupID := range payload.EdgeGroups { if _, err := tx.EdgeGroup().Read(edgeGroupID); err != nil { return err } if !slices.Contains(edgeJob.EdgeGroups, edgeGroupID) { edgeGroupsToAdd = append(edgeGroupsToAdd, edgeGroupID) } } endpointsFromGroupsToAdd, err := edge.GetEndpointsFromEdgeGroups(edgeGroupsToAdd, tx) if err != nil { return errors.New("unable to get endpoints from edge groups") } endpointsFromGroupsToAddMap = convertEndpointsToMetaObject(endpointsFromGroupsToAdd) for endpointID := range endpointsFromGroupsToAddMap { endpointsToAdd[endpointID] = true } newEdgeGroups := edge.EdgeGroupSet(payload.EdgeGroups) for _, edgeGroupID := range edgeJob.EdgeGroups { if !newEdgeGroups[edgeGroupID] { edgeGroupsToRemove = append(edgeGroupsToRemove, edgeGroupID) } } endpointsFromGroupsToRemove, err := edge.GetEndpointsFromEdgeGroups(edgeGroupsToRemove, tx) if err != nil { return errors.New("unable to get endpoints from edge groups") } endpointsToRemoveMap := convertEndpointsToMetaObject(endpointsFromGroupsToRemove) for endpointID := range endpointsToRemoveMap { endpointsToRemove[endpointID] = true } edgeJob.EdgeGroups = payload.EdgeGroups } updateVersion := false if payload.CronExpression != nil && *payload.CronExpression != edgeJob.CronExpression { edgeJob.CronExpression = *payload.CronExpression updateVersion = true } fileContent, err := handler.FileService.GetFileContent(edgeJob.ScriptPath, "") if err != nil { return err } if payload.FileContent != nil && *payload.FileContent != string(fileContent) { fileContent = []byte(*payload.FileContent) if _, err := handler.FileService.StoreEdgeJobFileFromBytes(strconv.Itoa(int(edgeJob.ID)), fileContent); err != nil { return err } updateVersion = true } if payload.Recurring != nil && *payload.Recurring != edgeJob.Recurring { edgeJob.Recurring = *payload.Recurring updateVersion = true } if updateVersion { edgeJob.Version++ } maps.Copy(endpointsFromGroupsToAddMap, edgeJob.Endpoints) for endpointID := range endpointsFromGroupsToAddMap { cache.Del(endpointID) } for endpointID := range endpointsToRemove { cache.Del(endpointID) } return nil }