mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-15 12:27:59 +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
184 lines
5.4 KiB
Go
184 lines
5.4 KiB
Go
package middleware
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"strings"
|
|
|
|
"github.com/zitadel/logging"
|
|
"google.golang.org/grpc"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/execution"
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
exec_repo "github.com/zitadel/zitadel/internal/repository/execution"
|
|
"github.com/zitadel/zitadel/internal/telemetry/tracing"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
func ExecutionHandler(queries *query.Queries) grpc.UnaryServerInterceptor {
|
|
return func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
|
|
requestTargets, responseTargets := queryTargets(ctx, queries, info.FullMethod)
|
|
|
|
// call targets otherwise return req
|
|
handledReq, err := executeTargetsForRequest(ctx, requestTargets, info.FullMethod, req)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
response, err := handler(ctx, handledReq)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return executeTargetsForResponse(ctx, responseTargets, info.FullMethod, handledReq, response)
|
|
}
|
|
}
|
|
|
|
func executeTargetsForRequest(ctx context.Context, targets []execution.Target, fullMethod string, req interface{}) (_ interface{}, err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer span.EndWithError(err)
|
|
|
|
// if no targets are found, return without any calls
|
|
if len(targets) == 0 {
|
|
return req, nil
|
|
}
|
|
|
|
ctxData := authz.GetCtxData(ctx)
|
|
info := &ContextInfoRequest{
|
|
FullMethod: fullMethod,
|
|
InstanceID: authz.GetInstance(ctx).InstanceID(),
|
|
ProjectID: ctxData.ProjectID,
|
|
OrgID: ctxData.OrgID,
|
|
UserID: ctxData.UserID,
|
|
Request: req,
|
|
}
|
|
|
|
return execution.CallTargets(ctx, targets, info)
|
|
}
|
|
|
|
func executeTargetsForResponse(ctx context.Context, targets []execution.Target, fullMethod string, req, resp interface{}) (_ interface{}, err error) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer span.EndWithError(err)
|
|
|
|
// if no targets are found, return without any calls
|
|
if len(targets) == 0 {
|
|
return resp, nil
|
|
}
|
|
|
|
ctxData := authz.GetCtxData(ctx)
|
|
info := &ContextInfoResponse{
|
|
FullMethod: fullMethod,
|
|
InstanceID: authz.GetInstance(ctx).InstanceID(),
|
|
ProjectID: ctxData.ProjectID,
|
|
OrgID: ctxData.OrgID,
|
|
UserID: ctxData.UserID,
|
|
Request: req,
|
|
Response: resp,
|
|
}
|
|
|
|
return execution.CallTargets(ctx, targets, info)
|
|
}
|
|
|
|
type ExecutionQueries interface {
|
|
TargetsByExecutionIDs(ctx context.Context, ids1, ids2 []string) (execution []*query.ExecutionTarget, err error)
|
|
}
|
|
|
|
func queryTargets(
|
|
ctx context.Context,
|
|
queries ExecutionQueries,
|
|
fullMethod string,
|
|
) ([]execution.Target, []execution.Target) {
|
|
ctx, span := tracing.NewSpan(ctx)
|
|
defer span.End()
|
|
|
|
targets, err := queries.TargetsByExecutionIDs(ctx,
|
|
idsForFullMethod(fullMethod, domain.ExecutionTypeRequest),
|
|
idsForFullMethod(fullMethod, domain.ExecutionTypeResponse),
|
|
)
|
|
requestTargets := make([]execution.Target, 0, len(targets))
|
|
responseTargets := make([]execution.Target, 0, len(targets))
|
|
if err != nil {
|
|
logging.WithFields("fullMethod", fullMethod).WithError(err).Info("unable to query targets")
|
|
return requestTargets, responseTargets
|
|
}
|
|
|
|
for _, target := range targets {
|
|
if strings.HasPrefix(target.GetExecutionID(), exec_repo.IDAll(domain.ExecutionTypeRequest)) {
|
|
requestTargets = append(requestTargets, target)
|
|
} else if strings.HasPrefix(target.GetExecutionID(), exec_repo.IDAll(domain.ExecutionTypeResponse)) {
|
|
responseTargets = append(responseTargets, target)
|
|
}
|
|
}
|
|
|
|
return requestTargets, responseTargets
|
|
}
|
|
|
|
func idsForFullMethod(fullMethod string, executionType domain.ExecutionType) []string {
|
|
return []string{exec_repo.ID(executionType, fullMethod), exec_repo.ID(executionType, serviceFromFullMethod(fullMethod)), exec_repo.IDAll(executionType)}
|
|
}
|
|
|
|
func serviceFromFullMethod(s string) string {
|
|
parts := strings.Split(s, "/")
|
|
return parts[1]
|
|
}
|
|
|
|
var _ execution.ContextInfo = &ContextInfoRequest{}
|
|
|
|
type ContextInfoRequest struct {
|
|
FullMethod string `json:"fullMethod,omitempty"`
|
|
InstanceID string `json:"instanceID,omitempty"`
|
|
OrgID string `json:"orgID,omitempty"`
|
|
ProjectID string `json:"projectID,omitempty"`
|
|
UserID string `json:"userID,omitempty"`
|
|
Request interface{} `json:"request,omitempty"`
|
|
}
|
|
|
|
func (c *ContextInfoRequest) GetHTTPRequestBody() []byte {
|
|
data, err := json.Marshal(c)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
return data
|
|
}
|
|
|
|
func (c *ContextInfoRequest) SetHTTPResponseBody(resp []byte) error {
|
|
if !json.Valid(resp) {
|
|
return zerrors.ThrowPreconditionFailed(nil, "ACTION-4m9s2", "Errors.Execution.ResponseIsNotValidJSON")
|
|
}
|
|
return json.Unmarshal(resp, c.Request)
|
|
}
|
|
|
|
func (c *ContextInfoRequest) GetContent() interface{} {
|
|
return c.Request
|
|
}
|
|
|
|
var _ execution.ContextInfo = &ContextInfoResponse{}
|
|
|
|
type ContextInfoResponse struct {
|
|
FullMethod string `json:"fullMethod,omitempty"`
|
|
InstanceID string `json:"instanceID,omitempty"`
|
|
OrgID string `json:"orgID,omitempty"`
|
|
ProjectID string `json:"projectID,omitempty"`
|
|
UserID string `json:"userID,omitempty"`
|
|
Request interface{} `json:"request,omitempty"`
|
|
Response interface{} `json:"response,omitempty"`
|
|
}
|
|
|
|
func (c *ContextInfoResponse) GetHTTPRequestBody() []byte {
|
|
data, err := json.Marshal(c)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
return data
|
|
}
|
|
|
|
func (c *ContextInfoResponse) SetHTTPResponseBody(resp []byte) error {
|
|
return json.Unmarshal(resp, c.Response)
|
|
}
|
|
|
|
func (c *ContextInfoResponse) GetContent() interface{} {
|
|
return c.Response
|
|
}
|