mirror of
https://github.com/zitadel/zitadel.git
synced 2025-01-05 22:52:46 +00:00
cc3ec1e2a7
# Which Problems Are Solved The current v3alpha actions APIs don't exactly adhere to the [new resources API design](https://zitadel.com/docs/apis/v3#standard-resources). # How the Problems Are Solved - **Breaking**: The current v3alpha actions APIs are removed. This is breaking. - **Resource Namespace**: New v3alpha actions APIs for targets and executions are added under the namespace /resources. - **Feature Flag**: New v3alpha actions APIs still have to be activated using the actions feature flag - **Reduced Executions Overhead**: Executions are managed similar to settings according to the new API design: an empty list of targets basically makes an execution a Noop. So a single method, SetExecution is enough to cover all use cases. Noop executions are not returned in future search requests. - **Compatibility**: The executions created with previous v3alpha APIs are still available to be managed with the new executions API. # Additional Changes - Removed integration tests which test executions but rely on readable targets. They are added again with #8169 # Additional Context Closes #8168
123 lines
3.4 KiB
Go
123 lines
3.4 KiB
Go
package execution
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"io"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/zitadel/logging"
|
|
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/telemetry/tracing"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
type ContextInfo interface {
|
|
GetHTTPRequestBody() []byte
|
|
GetContent() interface{}
|
|
SetHTTPResponseBody([]byte) error
|
|
}
|
|
|
|
type Target interface {
|
|
GetTargetID() string
|
|
IsInterruptOnError() bool
|
|
GetEndpoint() string
|
|
GetTargetType() domain.TargetType
|
|
GetTimeout() time.Duration
|
|
}
|
|
|
|
// CallTargets call a list of targets in order with handling of error and responses
|
|
func CallTargets(
|
|
ctx context.Context,
|
|
targets []Target,
|
|
info ContextInfo,
|
|
) (_ interface{}, err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer span.EndWithError(err)
|
|
|
|
for _, target := range targets {
|
|
// call the type of target
|
|
resp, err := CallTarget(ctx, target, info)
|
|
// handle error if interrupt is set
|
|
if err != nil && target.IsInterruptOnError() {
|
|
return nil, err
|
|
}
|
|
if len(resp) > 0 {
|
|
// error in unmarshalling
|
|
if err := info.SetHTTPResponseBody(resp); err != nil && target.IsInterruptOnError() {
|
|
return nil, err
|
|
}
|
|
}
|
|
}
|
|
return info.GetContent(), nil
|
|
}
|
|
|
|
type ContextInfoRequest interface {
|
|
GetHTTPRequestBody() []byte
|
|
}
|
|
|
|
// CallTarget call the desired type of target with handling of responses
|
|
func CallTarget(
|
|
ctx context.Context,
|
|
target Target,
|
|
info ContextInfoRequest,
|
|
) (res []byte, err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer span.EndWithError(err)
|
|
|
|
switch target.GetTargetType() {
|
|
// get request, ignore response and return request and error for handling in list of targets
|
|
case domain.TargetTypeWebhook:
|
|
return nil, webhook(ctx, target.GetEndpoint(), target.GetTimeout(), info.GetHTTPRequestBody())
|
|
// get request, return response and error
|
|
case domain.TargetTypeCall:
|
|
return Call(ctx, target.GetEndpoint(), target.GetTimeout(), info.GetHTTPRequestBody())
|
|
case domain.TargetTypeAsync:
|
|
go func(target Target, info ContextInfoRequest) {
|
|
if _, err := Call(ctx, target.GetEndpoint(), target.GetTimeout(), info.GetHTTPRequestBody()); err != nil {
|
|
logging.WithFields("target", target.GetTargetID()).OnError(err).Info(err)
|
|
}
|
|
}(target, info)
|
|
return nil, nil
|
|
default:
|
|
return nil, zerrors.ThrowInternal(nil, "EXEC-auqnansr2m", "Errors.Execution.Unknown")
|
|
}
|
|
}
|
|
|
|
// webhook call a webhook, ignore the response but return the errror
|
|
func webhook(ctx context.Context, url string, timeout time.Duration, body []byte) error {
|
|
_, err := Call(ctx, url, timeout, body)
|
|
return err
|
|
}
|
|
|
|
// Call function to do a post HTTP request to a desired url with timeout
|
|
func Call(ctx context.Context, url string, timeout time.Duration, body []byte) (_ []byte, err error) {
|
|
ctx, cancel := context.WithTimeout(ctx, timeout)
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer func() {
|
|
cancel()
|
|
span.EndWithError(err)
|
|
}()
|
|
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewBuffer(body))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
req.Header.Set("Content-Type", "application/json")
|
|
|
|
client := http.DefaultClient
|
|
resp, err := client.Do(req)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
// Check for success between 200 and 299, redirect 300 to 399 is handled by the client, return error with statusCode >= 400
|
|
if resp.StatusCode >= 200 && resp.StatusCode <= 299 {
|
|
return io.ReadAll(resp.Body)
|
|
}
|
|
return nil, zerrors.ThrowUnknown(nil, "EXEC-dra6yamk98", "Errors.Execution.Failed")
|
|
}
|