portainer/api/http/handler/edgejobs/edgejob_tasklogs_collect.go

package edgejobs

import (
	"errors"
	"net/http"
	"slices"

	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"
	httperror "github.com/portainer/portainer/pkg/libhttp/error"
	"github.com/portainer/portainer/pkg/libhttp/request"
	"github.com/portainer/portainer/pkg/libhttp/response"
)

// @id EdgeJobTasksCollect
// @summary Collect the log for a specifc task on an EdgeJob
// @description **Access policy**: administrator
// @tags edge_jobs
// @security ApiKeyAuth
// @security jwt
// @produce json
// @param id path int true "EdgeJob Id"
// @param taskID path int true "Task Id"
// @success 204
// @failure 500
// @failure 400
// @failure 503 "Edge compute features are disabled"
// @router /edge_jobs/{id}/tasks/{taskID}/logs [post]
func (handler *Handler) edgeJobTasksCollect(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)
	}

	taskID, err := request.RetrieveNumericRouteVariableValue(r, "taskID")
	if err != nil {
		return httperror.BadRequest("Invalid Task identifier route variable", err)
	}

	if err := handler.DataStore.UpdateTx(func(tx dataservices.DataStoreTx) error {
		edgeJob, err := tx.EdgeJob().Read(portainer.EdgeJobID(edgeJobID))
		if tx.IsErrObjectNotFound(err) {
			return httperror.NotFound("Unable to find an Edge job with the specified identifier inside the database", err)
		} else if err != nil {
			return httperror.InternalServerError("Unable to find an Edge job with the specified identifier inside the database", err)
		}

		endpointID := portainer.EndpointID(taskID)
		endpointsFromGroups, err := edge.GetEndpointsFromEdgeGroups(edgeJob.EdgeGroups, tx)
		if err != nil {
			return httperror.InternalServerError("Unable to get Endpoints from EdgeGroups", err)
		}

		if slices.Contains(endpointsFromGroups, endpointID) {
			edgeJob.GroupLogsCollection[endpointID] = portainer.EdgeJobEndpointMeta{
				CollectLogs: true,
				LogsStatus:  portainer.EdgeJobLogsStatusPending,
			}
		} else {
			meta := edgeJob.Endpoints[endpointID]
			meta.CollectLogs = true
			meta.LogsStatus = portainer.EdgeJobLogsStatusPending
			edgeJob.Endpoints[endpointID] = meta
		}

		if err := tx.EdgeJob().Update(edgeJob.ID, edgeJob); err != nil {
			return httperror.InternalServerError("Unable to persist Edge job changes in the database", err)
		}

		endpoint, err := tx.Endpoint().Endpoint(endpointID)
		if err != nil {
			return httperror.InternalServerError("Unable to retrieve environment from the database", err)
		}

		cache.Del(endpointID)

		if endpoint.Edge.AsyncMode {
			return httperror.BadRequest("Async Edge Endpoints are not supported in Portainer CE", nil)
		}

		return nil
	}); err != nil {
		var handlerError *httperror.HandlerError
		if errors.As(err, &handlerError) {
			return handlerError
		}

		return httperror.InternalServerError("Unexpected error", err)
	}

	return response.Empty(w)
}