Files
CrimsonandGitHub d8a440a5a2 fix(connectors): prevent injection of arbitrary json keys in connector config (#526)
* Rename engine/plugins package to avoid confusion with connector/plugins package

* Update instances of plugins to be renamed to connectors

* Use Load/Unload for Connectors Manager to avoid confusion with Plugin Registry actions

* Add some unit tests for connectors.Manager

* Add Config method to Plugin interface

* Use validated config instead of raw config for insertion into DB

* Update plugin template to include new Config command

* Ensure plugin is not nil in workflow unit tests

* Small adjustments to e2e test expectations to reflect change in json validation of config

* Update codecoverage to exclude new generated files

* Guard against nil map in combineConfigs

* Update Plugin interface in CONTRIBUTING.md
2025-09-02 13:06:12 +00:00

99 lines
3.9 KiB
Go

package activities
import (
"context"
"errors"
"github.com/formancehq/payments/internal/connectors"
"github.com/formancehq/payments/internal/connectors/plugins"
"github.com/formancehq/payments/internal/models"
"github.com/formancehq/payments/internal/storage"
errorsutils "github.com/formancehq/payments/internal/utils/errors"
"go.temporal.io/sdk/activity"
"go.temporal.io/sdk/temporal"
)
const (
ErrTypeStorage = "STORAGE"
ErrTypeDefault = "DEFAULT"
ErrTypeInvalidArgument = "INVALID_ARGUMENT"
ErrTypeRateLimited = "RATE_LIMITED"
ErrTypeUnimplemented = "UNIMPLEMENTED"
)
func (a Activities) temporalPluginError(ctx context.Context, err error) error {
return a.temporalPluginErrorCheck(ctx, err, false)
}
func (a Activities) temporalPluginPollingError(ctx context.Context, err error, periodic bool) error {
return a.temporalPluginErrorCheck(ctx, err, periodic)
}
func (a Activities) temporalPluginErrorCheck(ctx context.Context, err error, isPeriodic bool) error {
// Since typed errors are discard with temporal when returning from an activity,
// we need only to pass to temporal the cause of the error and not all the
// stack trace.
cause := errorsutils.Cause(err)
switch {
// Do not retry the following errors
case errors.Is(err, plugins.ErrNotImplemented):
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeUnimplemented, cause)
case errors.Is(err, plugins.ErrInvalidClientRequest):
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeInvalidArgument, cause)
case errors.Is(err, plugins.ErrCurrencyNotSupported):
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeInvalidArgument, cause)
case errors.Is(err, connectors.ErrNotFound):
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeInvalidArgument, cause)
case errors.Is(err, models.ErrMissingConnectorMetadata):
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeInvalidArgument, cause)
case errors.Is(err, models.ErrWebhookVerification):
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeInvalidArgument, cause)
case errors.As(err, &models.NonRetryableError):
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeInvalidArgument, cause)
// Potentially retry
case errors.Is(err, plugins.ErrUpstreamRatelimit):
// periodic tasks will be repeated in the future anyway so we can skip retry in case of rate-limiting
if isPeriodic {
info := activity.GetInfo(ctx)
a.logger.WithFields(map[string]any{
"workflow_type": info.WorkflowType.Name,
"scheduled_time": info.ScheduledTime.String(),
"workflow_id": info.WorkflowExecution.ID,
}).Debug("disabling retry for polled activity triggered by schedule due to rate-limit")
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeRateLimited, cause)
}
return temporal.NewApplicationErrorWithOptions(err.Error(), ErrTypeRateLimited, temporal.ApplicationErrorOptions{
// temporal already implements a backoff strategy, but let's add an extra delay before the next retry
// https://docs.temporal.io/encyclopedia/retry-policies#per-error-next-retry-delay
NextRetryDelay: a.rateLimitingRetryDelay,
})
// Retry the following errors
case errors.Is(err, plugins.ErrNotYetInstalled):
// We want to retry in case of not installed
return temporal.NewApplicationErrorWithCause(err.Error(), ErrTypeDefault, cause)
default:
return temporal.NewApplicationErrorWithCause(err.Error(), ErrTypeDefault, cause)
}
}
func temporalStorageError(err error) error {
if err == nil {
return nil
}
switch {
case errors.Is(err, storage.ErrNotFound),
errors.Is(err, storage.ErrDuplicateKeyValue),
errors.Is(err, storage.ErrValidation),
errors.Is(err, storage.ErrForeignKeyViolation):
// Do not retry these errors
return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeStorage, err)
default:
return temporal.NewApplicationErrorWithCause(err.Error(), ErrTypeStorage, err)
}
}