-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Web API Trigger capability and handler (#14580)
* Web API Trigger capability and handler * PR review comments * PR review comments: remove array of topics from client, timestamp on triggereventId and more * increase test timeout and handle context closure * fix lint * fix lint errors from cicd * go mod tidy to pickup latest -common * downgrade -common * lint * change TriggerConfig to Config to avoid stutter of triger.TriggerConfig * PR Review comments. Mostly return error from processTrigger * add check for at least one successful workflow invoke and test
- Loading branch information
1 parent
74a5b4f
commit 41443fa
Showing
8 changed files
with
1,157 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,279 @@ | ||
package webapi | ||
package trigger | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"errors" | ||
"fmt" | ||
"sync" | ||
|
||
ethCommon "github.com/ethereum/go-ethereum/common" | ||
|
||
"github.com/smartcontractkit/chainlink-common/pkg/capabilities" | ||
"github.com/smartcontractkit/chainlink-common/pkg/services" | ||
"github.com/smartcontractkit/chainlink-common/pkg/types/core" | ||
"github.com/smartcontractkit/chainlink-common/pkg/values" | ||
"github.com/smartcontractkit/chainlink/v2/core/logger" | ||
"github.com/smartcontractkit/chainlink/v2/core/services/gateway/api" | ||
"github.com/smartcontractkit/chainlink/v2/core/services/gateway/connector" | ||
"github.com/smartcontractkit/chainlink/v2/core/services/job" | ||
"github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers/common" | ||
"github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers/webapicapabilities" | ||
) | ||
|
||
func NewTrigger(config string, registry core.CapabilitiesRegistry, connector connector.GatewayConnector, lggr logger.Logger) (job.ServiceCtx, error) { | ||
// TODO (CAPPL-22, CAPPL-24): | ||
// - decode config | ||
// - create an implementation of the capability API and add it to the Registry | ||
// - create a handler and register it with Gateway Connector | ||
// - manage trigger subscriptions | ||
// - process incoming trigger events and related metadata | ||
return nil, nil | ||
const defaultSendChannelBufferSize = 1000 | ||
|
||
const TriggerType = "[email protected]" | ||
|
||
var webapiTriggerInfo = capabilities.MustNewCapabilityInfo( | ||
TriggerType, | ||
capabilities.CapabilityTypeTrigger, | ||
"A trigger to start workflow execution from a web api call", | ||
) | ||
|
||
type Input struct { | ||
} | ||
type Config struct { | ||
AllowedSenders []string `toml:"allowedSenders"` | ||
AllowedTopics []string `toml:"allowedTopics"` | ||
RateLimiter common.RateLimiterConfig `toml:"rateLimiter"` | ||
// RequiredParams is advisory to the web trigger message sender it is not enforced. | ||
RequiredParams []string `toml:"requiredParams"` | ||
} | ||
|
||
type webapiTrigger struct { | ||
allowedSenders map[string]bool | ||
allowedTopics map[string]bool | ||
ch chan<- capabilities.TriggerResponse | ||
config Config | ||
rateLimiter *common.RateLimiter | ||
} | ||
|
||
type triggerConnectorHandler struct { | ||
services.StateMachine | ||
|
||
capabilities.CapabilityInfo | ||
capabilities.Validator[Config, Input, capabilities.TriggerResponse] | ||
connector connector.GatewayConnector | ||
lggr logger.Logger | ||
mu sync.Mutex | ||
registeredWorkflows map[string]webapiTrigger | ||
} | ||
|
||
var _ capabilities.TriggerCapability = (*triggerConnectorHandler)(nil) | ||
var _ services.Service = &triggerConnectorHandler{} | ||
|
||
func NewTrigger(config string, registry core.CapabilitiesRegistry, connector connector.GatewayConnector, lggr logger.Logger) (*triggerConnectorHandler, error) { | ||
if connector == nil { | ||
return nil, errors.New("missing connector") | ||
} | ||
handler := &triggerConnectorHandler{ | ||
Validator: capabilities.NewValidator[Config, Input, capabilities.TriggerResponse](capabilities.ValidatorArgs{Info: webapiTriggerInfo}), | ||
connector: connector, | ||
registeredWorkflows: map[string]webapiTrigger{}, | ||
lggr: lggr.Named("WorkflowConnectorHandler"), | ||
} | ||
|
||
return handler, nil | ||
} | ||
|
||
// processTrigger iterates over each topic, checking against senders and rateLimits, then starting event processing and responding | ||
func (h *triggerConnectorHandler) processTrigger(ctx context.Context, gatewayID string, body *api.MessageBody, sender ethCommon.Address, payload webapicapabilities.TriggerRequestPayload) error { | ||
// Pass on the payload with the expectation that it's in an acceptable format for the executor | ||
wrappedPayload, err := values.WrapMap(payload) | ||
if err != nil { | ||
return fmt.Errorf("error wrapping payload %s", err) | ||
} | ||
topics := payload.Topics | ||
|
||
// empty topics is error for V1 | ||
if len(topics) == 0 { | ||
return fmt.Errorf("empty Workflow Topics") | ||
} | ||
|
||
// workflows that have matched topics | ||
matchedWorkflows := 0 | ||
// workflows that have matched topic and passed all checks | ||
fullyMatchedWorkflows := 0 | ||
for _, trigger := range h.registeredWorkflows { | ||
for _, topic := range topics { | ||
if trigger.allowedTopics[topic] { | ||
matchedWorkflows++ | ||
if !trigger.allowedSenders[sender.String()] { | ||
err = fmt.Errorf("unauthorized Sender %s, messageID %s", sender.String(), body.MessageId) | ||
h.lggr.Debugw(err.Error()) | ||
continue | ||
} | ||
if !trigger.rateLimiter.Allow(body.Sender) { | ||
err = fmt.Errorf("request rate-limited for sender %s, messageID %s", sender.String(), body.MessageId) | ||
continue | ||
} | ||
fullyMatchedWorkflows++ | ||
TriggerEventID := body.Sender + payload.TriggerEventID | ||
tr := capabilities.TriggerResponse{ | ||
Event: capabilities.TriggerEvent{ | ||
TriggerType: TriggerType, | ||
ID: TriggerEventID, | ||
Outputs: wrappedPayload, | ||
}, | ||
} | ||
select { | ||
case <-ctx.Done(): | ||
return nil | ||
case trigger.ch <- tr: | ||
// Sending n topics that match a workflow with n allowedTopics, can only be triggered once. | ||
break | ||
} | ||
} | ||
} | ||
} | ||
if matchedWorkflows == 0 { | ||
return fmt.Errorf("no Matching Workflow Topics") | ||
} | ||
|
||
if fullyMatchedWorkflows > 0 { | ||
return nil | ||
} | ||
return err | ||
} | ||
|
||
func (h *triggerConnectorHandler) HandleGatewayMessage(ctx context.Context, gatewayID string, msg *api.Message) { | ||
// TODO: Validate Signature | ||
body := &msg.Body | ||
sender := ethCommon.HexToAddress(body.Sender) | ||
var payload webapicapabilities.TriggerRequestPayload | ||
err := json.Unmarshal(body.Payload, &payload) | ||
if err != nil { | ||
h.lggr.Errorw("error decoding payload", "err", err) | ||
err = h.sendResponse(ctx, gatewayID, body, webapicapabilities.TriggerResponsePayload{Status: "ERROR", ErrorMessage: fmt.Errorf("error %s decoding payload", err.Error()).Error()}) | ||
if err != nil { | ||
h.lggr.Errorw("error sending response", "err", err) | ||
} | ||
return | ||
} | ||
|
||
switch body.Method { | ||
case webapicapabilities.MethodWebAPITrigger: | ||
resp := h.processTrigger(ctx, gatewayID, body, sender, payload) | ||
var response webapicapabilities.TriggerResponsePayload | ||
if resp == nil { | ||
response = webapicapabilities.TriggerResponsePayload{Status: "ACCEPTED"} | ||
} else { | ||
response = webapicapabilities.TriggerResponsePayload{Status: "ERROR", ErrorMessage: resp.Error()} | ||
h.lggr.Errorw("Error processing trigger", "gatewayID", gatewayID, "body", body, "response", resp) | ||
} | ||
err = h.sendResponse(ctx, gatewayID, body, response) | ||
if err != nil { | ||
h.lggr.Errorw("Error sending response", "body", body, "response", response, "err", err) | ||
} | ||
return | ||
|
||
default: | ||
h.lggr.Errorw("unsupported method", "id", gatewayID, "method", body.Method) | ||
err = h.sendResponse(ctx, gatewayID, body, webapicapabilities.TriggerResponsePayload{Status: "ERROR", ErrorMessage: fmt.Errorf("unsupported method %s", body.Method).Error()}) | ||
if err != nil { | ||
h.lggr.Errorw("error sending response", "err", err) | ||
} | ||
} | ||
} | ||
|
||
func (h *triggerConnectorHandler) RegisterTrigger(ctx context.Context, req capabilities.TriggerRegistrationRequest) (<-chan capabilities.TriggerResponse, error) { | ||
cfg := req.Config | ||
if cfg == nil { | ||
return nil, errors.New("config is required to register a web api trigger") | ||
} | ||
|
||
reqConfig, err := h.ValidateConfig(cfg) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
if len(reqConfig.AllowedSenders) == 0 { | ||
return nil, errors.New("allowedSenders must have at least 1 entry") | ||
} | ||
|
||
h.mu.Lock() | ||
defer h.mu.Unlock() | ||
_, errBool := h.registeredWorkflows[req.TriggerID] | ||
if errBool { | ||
return nil, fmt.Errorf("triggerId %s already registered", req.TriggerID) | ||
} | ||
|
||
rateLimiter, err := common.NewRateLimiter(reqConfig.RateLimiter) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
allowedSendersMap := map[string]bool{} | ||
for _, k := range reqConfig.AllowedSenders { | ||
allowedSendersMap[k] = true | ||
} | ||
|
||
allowedTopicsMap := map[string]bool{} | ||
for _, k := range reqConfig.AllowedTopics { | ||
allowedTopicsMap[k] = true | ||
} | ||
|
||
ch := make(chan capabilities.TriggerResponse, defaultSendChannelBufferSize) | ||
|
||
h.registeredWorkflows[req.TriggerID] = webapiTrigger{ | ||
allowedTopics: allowedTopicsMap, | ||
allowedSenders: allowedSendersMap, | ||
ch: ch, | ||
config: *reqConfig, | ||
rateLimiter: rateLimiter, | ||
} | ||
|
||
return ch, nil | ||
} | ||
|
||
func (h *triggerConnectorHandler) UnregisterTrigger(ctx context.Context, req capabilities.TriggerRegistrationRequest) error { | ||
h.mu.Lock() | ||
defer h.mu.Unlock() | ||
workflow, ok := h.registeredWorkflows[req.TriggerID] | ||
if !ok { | ||
return fmt.Errorf("triggerId %s not registered", req.TriggerID) | ||
} | ||
|
||
close(workflow.ch) | ||
delete(h.registeredWorkflows, req.TriggerID) | ||
return nil | ||
} | ||
|
||
func (h *triggerConnectorHandler) Start(ctx context.Context) error { | ||
return h.StartOnce("GatewayConnectorServiceWrapper", func() error { | ||
return h.connector.AddHandler([]string{"web_trigger"}, h) | ||
}) | ||
} | ||
func (h *triggerConnectorHandler) Close() error { | ||
return h.StopOnce("GatewayConnectorServiceWrapper", func() error { | ||
return nil | ||
}) | ||
} | ||
|
||
func (h *triggerConnectorHandler) HealthReport() map[string]error { | ||
return map[string]error{h.Name(): h.Healthy()} | ||
} | ||
|
||
func (h *triggerConnectorHandler) Name() string { | ||
return "WebAPITrigger" | ||
} | ||
|
||
func (h *triggerConnectorHandler) sendResponse(ctx context.Context, gatewayID string, requestBody *api.MessageBody, payload any) error { | ||
payloadJSON, err := json.Marshal(payload) | ||
if err != nil { | ||
h.lggr.Errorw("error marshalling payload", "err", err) | ||
payloadJSON, _ = json.Marshal(webapicapabilities.TriggerResponsePayload{Status: "ERROR", ErrorMessage: fmt.Errorf("error %s marshalling payload", err.Error()).Error()}) | ||
} | ||
|
||
msg := &api.Message{ | ||
Body: api.MessageBody{ | ||
MessageId: requestBody.MessageId, | ||
DonId: requestBody.DonId, | ||
Method: requestBody.Method, | ||
Receiver: requestBody.Sender, | ||
Payload: payloadJSON, | ||
}, | ||
} | ||
|
||
return h.connector.SendToGateway(ctx, gatewayID, msg) | ||
} |
Oops, something went wrong.