0be1ca30dd
The number of interfaces declared by the `api_impl` package is getting large, so they deserve their own file. No functional changes.
89 lines
2.2 KiB
Go
89 lines
2.2 KiB
Go
// Package api_impl implements the OpenAPI API from pkg/api/flamenco-openapi.yaml.
|
|
package api_impl
|
|
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strconv"
|
|
"sync"
|
|
"time"
|
|
|
|
"git.blender.org/flamenco/pkg/api"
|
|
"github.com/labstack/echo/v4"
|
|
)
|
|
|
|
type Flamenco struct {
|
|
jobCompiler JobCompiler
|
|
persist PersistenceService
|
|
broadcaster ChangeBroadcaster
|
|
logStorage LogStorage
|
|
config ConfigService
|
|
stateMachine TaskStateMachine
|
|
shaman Shaman
|
|
|
|
// The task scheduler can be locked to prevent multiple Workers from getting
|
|
// the same task. It is also used for certain other queries, like
|
|
// `MayWorkerRun` to prevent similar race conditions.
|
|
taskSchedulerMutex sync.Mutex
|
|
}
|
|
|
|
var _ api.ServerInterface = (*Flamenco)(nil)
|
|
|
|
// NewFlamenco creates a new Flamenco service.
|
|
func NewFlamenco(
|
|
jc JobCompiler,
|
|
jps PersistenceService,
|
|
b ChangeBroadcaster,
|
|
ls LogStorage,
|
|
cs ConfigService,
|
|
sm TaskStateMachine,
|
|
sha Shaman,
|
|
) *Flamenco {
|
|
return &Flamenco{
|
|
jobCompiler: jc,
|
|
persist: jps,
|
|
broadcaster: b,
|
|
logStorage: ls,
|
|
config: cs,
|
|
stateMachine: sm,
|
|
shaman: sha,
|
|
}
|
|
}
|
|
|
|
// sendAPIError wraps sending of an error in the Error format, and
|
|
// handling the failure to marshal that.
|
|
func sendAPIError(e echo.Context, code int, message string, args ...interface{}) error {
|
|
if len(args) > 0 {
|
|
// Only interpret 'message' as format string if there are actually format parameters.
|
|
message = fmt.Sprintf(message, args...)
|
|
}
|
|
|
|
apiErr := api.Error{
|
|
Code: int32(code),
|
|
Message: message,
|
|
}
|
|
return e.JSON(code, apiErr)
|
|
}
|
|
|
|
// sendAPIErrorDBBusy sends a HTTP 503 Service Unavailable, with a hopefully
|
|
// reasonable "retry after" header.
|
|
func sendAPIErrorDBBusy(e echo.Context, message string, args ...interface{}) error {
|
|
if len(args) > 0 {
|
|
// Only interpret 'message' as format string if there are actually format parameters.
|
|
message = fmt.Sprintf(message, args)
|
|
}
|
|
|
|
code := http.StatusServiceUnavailable
|
|
apiErr := api.Error{
|
|
Code: int32(code),
|
|
Message: message,
|
|
}
|
|
|
|
retryAfter := 1 * time.Second
|
|
seconds := int64(retryAfter.Seconds())
|
|
e.Response().Header().Set("Retry-After", strconv.FormatInt(seconds, 10))
|
|
return e.JSON(code, apiErr)
|
|
}
|