-
Notifications
You must be signed in to change notification settings - Fork 395
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
satellite/{db,analytics,payments}: add chore for auto account freeze
This change adds a new chore that will check for failed invoices and potentially freeze corresponding accounts. It makes slight modifications to stripemock.go and invoices.go (adding stripe CustomerID to the Invoice struct). Issue: storj/storj-private#140 Change-Id: I161f4037881222003bd231559c75f43360509894
- Loading branch information
1 parent
31ec4fa
commit faeea88
Showing
17 changed files
with
734 additions
and
3 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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| // Copyright (C) 2023 Storj Labs, Inc. | ||
| // See LICENSE for copying information. | ||
|
|
||
| package accountfreeze | ||
|
|
||
| import ( | ||
| "context" | ||
| "time" | ||
|
|
||
| "github.com/spacemonkeygo/monkit/v3" | ||
| "github.com/zeebo/errs" | ||
| "go.uber.org/zap" | ||
|
|
||
| "storj.io/common/sync2" | ||
| "storj.io/storj/satellite/analytics" | ||
| "storj.io/storj/satellite/console" | ||
| "storj.io/storj/satellite/payments" | ||
| "storj.io/storj/satellite/payments/stripecoinpayments" | ||
| ) | ||
|
|
||
| var ( | ||
| // Error is the standard error class for automatic freeze errors. | ||
| Error = errs.Class("account-freeze-chore") | ||
| mon = monkit.Package() | ||
| ) | ||
|
|
||
| // Config contains configurable values for account freeze chore. | ||
| type Config struct { | ||
| Enabled bool `help:"whether to run this chore." default:"false"` | ||
| Interval time.Duration `help:"How often to run this chore, which is how often unpaid invoices are checked." default:"24h"` | ||
| GracePeriod time.Duration `help:"How long to wait between a warning event and freezing an account." default:"720h"` | ||
| PriceThreshold int64 `help:"The failed invoice amount beyond which an account will not be frozen" default:"2000"` | ||
| } | ||
|
|
||
| // Chore is a chore that checks for unpaid invoices and potentially freezes corresponding accounts. | ||
| type Chore struct { | ||
| log *zap.Logger | ||
| freezeService *console.AccountFreezeService | ||
| analytics *analytics.Service | ||
| usersDB console.Users | ||
| payments payments.Accounts | ||
| accounts stripecoinpayments.DB | ||
| config Config | ||
| nowFn func() time.Time | ||
| Loop *sync2.Cycle | ||
| } | ||
|
|
||
| // NewChore is a constructor for Chore. | ||
| func NewChore(log *zap.Logger, accounts stripecoinpayments.DB, payments payments.Accounts, usersDB console.Users, freezeService *console.AccountFreezeService, analytics *analytics.Service, config Config) *Chore { | ||
| return &Chore{ | ||
| log: log, | ||
| freezeService: freezeService, | ||
| analytics: analytics, | ||
| usersDB: usersDB, | ||
| accounts: accounts, | ||
| config: config, | ||
| payments: payments, | ||
| nowFn: time.Now, | ||
| Loop: sync2.NewCycle(config.Interval), | ||
| } | ||
| } | ||
|
|
||
| // Run runs the chore. | ||
| func (chore *Chore) Run(ctx context.Context) (err error) { | ||
| defer mon.Task()(&ctx)(&err) | ||
| return chore.Loop.Run(ctx, func(ctx context.Context) (err error) { | ||
|
|
||
| invoices, err := chore.payments.Invoices().ListFailed(ctx) | ||
| if err != nil { | ||
| chore.log.Error("Could not list invoices", zap.Error(Error.Wrap(err))) | ||
| return nil | ||
| } | ||
|
|
||
| for _, invoice := range invoices { | ||
| userID, err := chore.accounts.Customers().GetUserID(ctx, invoice.CustomerID) | ||
| if err != nil { | ||
| chore.log.Error("Could not get userID", zap.String("invoice", invoice.ID), zap.Error(Error.Wrap(err))) | ||
| continue | ||
| } | ||
|
|
||
| user, err := chore.usersDB.Get(ctx, userID) | ||
| if err != nil { | ||
| chore.log.Error("Could not get user", zap.String("invoice", invoice.ID), zap.Error(Error.Wrap(err))) | ||
| continue | ||
| } | ||
|
|
||
| if invoice.Amount > chore.config.PriceThreshold { | ||
| chore.analytics.TrackLargeUnpaidInvoice(invoice.ID, userID, user.Email) | ||
| continue | ||
| } | ||
|
|
||
| freeze, warning, err := chore.freezeService.GetAll(ctx, userID) | ||
| if err != nil { | ||
| chore.log.Error("Could not check freeze status", zap.String("invoice", invoice.ID), zap.Error(Error.Wrap(err))) | ||
| continue | ||
| } | ||
| if freeze != nil { | ||
| // account already frozen | ||
| continue | ||
| } | ||
|
|
||
| if warning == nil { | ||
| err = chore.freezeService.WarnUser(ctx, userID) | ||
| if err != nil { | ||
| chore.log.Error("Could not add warning event", zap.String("invoice", invoice.ID), zap.Error(Error.Wrap(err))) | ||
| continue | ||
| } | ||
| chore.analytics.TrackAccountFreezeWarning(userID, user.Email) | ||
| continue | ||
| } | ||
|
|
||
| if chore.nowFn().Sub(warning.CreatedAt) > chore.config.GracePeriod { | ||
| err = chore.freezeService.FreezeUser(ctx, userID) | ||
| if err != nil { | ||
| chore.log.Error("Could not freeze account", zap.String("invoice", invoice.ID), zap.Error(Error.Wrap(err))) | ||
| continue | ||
| } | ||
| chore.analytics.TrackAccountFrozen(userID, user.Email) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
| } | ||
|
|
||
| // TestSetNow sets nowFn on chore for testing. | ||
| func (chore *Chore) TestSetNow(f func() time.Time) { | ||
| chore.nowFn = f | ||
| } | ||
|
|
||
| // Close closes the chore. | ||
| func (chore *Chore) Close() error { | ||
| chore.Loop.Close() | ||
| return nil | ||
| } |
Oops, something went wrong.