-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
be3f07e
commit c8726cc
Showing
11 changed files
with
553 additions
and
25 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/oarkflow/frame" | ||
| "github.com/oarkflow/frame/middlewares/server/idempotency" | ||
| "github.com/oarkflow/frame/middlewares/server/requestid" | ||
| "github.com/oarkflow/frame/server" | ||
| ) | ||
|
|
||
| func main() { | ||
| srv := server.Default(server.WithHostPorts(":8081")) | ||
| srv.Use(requestid.New()) | ||
| srv.Use(idempotency.New()) | ||
| srv.GET("/", idempotency.New(), func(c context.Context, ctx *frame.Context) { | ||
| ctx.JSON(200, "Hello world") | ||
| }) | ||
| srv.Spin() | ||
| } |
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,127 @@ | ||
| package idempotency | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/oarkflow/frame" | ||
| "github.com/oarkflow/frame/internal/bytesconv" | ||
| "github.com/oarkflow/frame/pkg/common/storage" | ||
| "github.com/oarkflow/frame/pkg/common/storage/memory" | ||
| ) | ||
|
|
||
| var ErrInvalidIdempotencyKey = errors.New("invalid idempotency key") | ||
|
|
||
| // Config defines the config for middleware. | ||
| type Config struct { | ||
| // Next defines a function to skip this middleware when returned true. | ||
| // | ||
| // Optional. Default: a function which skips the middleware on safe HTTP request method. | ||
| Next func(c *frame.Context) bool | ||
|
|
||
| // Lifetime is the maximum lifetime of an idempotency key. | ||
| // | ||
| // Optional. Default: 30 * time.Minute | ||
| Lifetime time.Duration | ||
|
|
||
| // KeyHeader is the name of the header that contains the idempotency key. | ||
| // | ||
| // Optional. Default: X-Idempotency-Key | ||
| KeyHeader string | ||
| // KeyHeaderValidate defines a function to validate the syntax of the idempotency header. | ||
| // | ||
| // Optional. Default: a function which ensures the header is 36 characters long (the size of an UUID). | ||
| KeyHeaderValidate func(string) error | ||
|
|
||
| // KeepResponseHeaders is a list of headers that should be kept from the original response. | ||
| // | ||
| // Optional. Default: nil (to keep all headers) | ||
| KeepResponseHeaders []string | ||
|
|
||
| // Lock locks an idempotency key. | ||
| // | ||
| // Optional. Default: an in-memory locker for this process only. | ||
| Lock Locker | ||
|
|
||
| // Storage stores response data by idempotency key. | ||
| // | ||
| // Optional. Default: an in-memory storage for this process only. | ||
| Storage storage.Storage | ||
| } | ||
|
|
||
| // ConfigDefault is the default config | ||
| var ConfigDefault = Config{ | ||
| Next: func(c *frame.Context) bool { | ||
| // Skip middleware if the request was done using a safe HTTP method | ||
| return frame.IsMethodSafe(bytesconv.B2s(c.Method())) | ||
| }, | ||
|
|
||
| Lifetime: 30 * time.Minute, | ||
|
|
||
| KeyHeader: "X-Idempotency-Key", | ||
| KeyHeaderValidate: func(k string) error { | ||
| if l, wl := len(k), 36; l != wl { // UUID length is 36 chars | ||
| return fmt.Errorf("%w: invalid length: %d != %d", ErrInvalidIdempotencyKey, l, wl) | ||
| } | ||
|
|
||
| return nil | ||
| }, | ||
|
|
||
| KeepResponseHeaders: nil, | ||
|
|
||
| Lock: nil, // Set in configDefault so we don't allocate data here. | ||
|
|
||
| Storage: nil, // Set in configDefault so we don't allocate data here. | ||
| } | ||
|
|
||
| // Helper function to set default values | ||
| func configDefault(config ...Config) Config { | ||
| // Return default config if nothing provided | ||
| if len(config) < 1 { | ||
| cfg := ConfigDefault | ||
|
|
||
| cfg.Lock = NewMemoryLock() | ||
| cfg.Storage = memory.New(memory.Config{ | ||
| GCInterval: cfg.Lifetime / 2, // Half the lifetime interval | ||
| }) | ||
|
|
||
| return cfg | ||
| } | ||
|
|
||
| // Override default config | ||
| cfg := config[0] | ||
|
|
||
| // Set default values | ||
|
|
||
| if cfg.Next == nil { | ||
| cfg.Next = ConfigDefault.Next | ||
| } | ||
|
|
||
| if cfg.Lifetime.Nanoseconds() == 0 { | ||
| cfg.Lifetime = ConfigDefault.Lifetime | ||
| } | ||
|
|
||
| if cfg.KeyHeader == "" { | ||
| cfg.KeyHeader = ConfigDefault.KeyHeader | ||
| } | ||
| if cfg.KeyHeaderValidate == nil { | ||
| cfg.KeyHeaderValidate = ConfigDefault.KeyHeaderValidate | ||
| } | ||
|
|
||
| if cfg.KeepResponseHeaders != nil && len(cfg.KeepResponseHeaders) == 0 { | ||
| cfg.KeepResponseHeaders = ConfigDefault.KeepResponseHeaders | ||
| } | ||
|
|
||
| if cfg.Lock == nil { | ||
| cfg.Lock = NewMemoryLock() | ||
| } | ||
|
|
||
| if cfg.Storage == nil { | ||
| cfg.Storage = memory.New(memory.Config{ | ||
| GCInterval: cfg.Lifetime / 2, // Half the lifetime interval | ||
| }) | ||
| } | ||
|
|
||
| return cfg | ||
| } |
Oops, something went wrong.