-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Isolate and refactor caching logic (#94)
* Isolate and refactor caching logic Signed-off-by: Douglas Camata <[email protected]> * Fix some tests Signed-off-by: Douglas Camata <[email protected]> * Save cache type from parser into the config Signed-off-by: Douglas Camata <[email protected]> * Address review comments Signed-off-by: Douglas Camata <[email protected]> * Fix broken merge conflict resolution Signed-off-by: Douglas Camata <[email protected]> * Fix broken merge conflict solution * Fix IsSet doc * Tidy up go.mod Signed-off-by: Douglas Camata <[email protected]> --------- Signed-off-by: Douglas Camata <[email protected]>
- Loading branch information
1 parent
b900e5f
commit 8e03ce0
Showing
5 changed files
with
117 additions
and
46 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| // Copyright (c) Bartłomiej Płotka @bwplotka | ||
| // Licensed under the Apache License 2.0. | ||
|
|
||
| package cache | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/pkg/errors" | ||
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
| type cacheType string | ||
|
|
||
| const ( | ||
| timeDay = 24 * time.Hour | ||
| defaultCacheValidity = 5 * timeDay | ||
| cacheTypeEmpty = cacheType("") | ||
| cacheTypeNone = cacheType("none") | ||
| cacheTypeSQLite = cacheType("sqlite") | ||
| ) | ||
|
|
||
| // Config holds the cache configuration. | ||
| type Config struct { | ||
| // type is the type of the cache. | ||
| cacheType cacheType | ||
| // Validity is the duration for which the cache is valid. | ||
| Validity time.Duration | ||
| // Jitter is the jitter to apply when considering a cached entry valid or not. | ||
| Jitter time.Duration | ||
|
|
||
| cacheParser *configParser | ||
| } | ||
|
|
||
| // NewConfig is the constructor for Config. | ||
| func NewConfig() Config { | ||
| return Config{ | ||
| cacheParser: newConfigParser(), | ||
| } | ||
| } | ||
|
|
||
| // IsSet tell whether a cache configuration is present. | ||
| func (c *Config) IsSet() bool { | ||
| return c.cacheType != cacheTypeNone && c.cacheType != cacheTypeEmpty | ||
| } | ||
|
|
||
| // UnmarshalYAML puts the unmarshalled yaml data into the internal cache parser | ||
| // struct. This prevents access to the string data of jitter and validity. | ||
| func (c *Config) UnmarshalYAML(value *yaml.Node) error { | ||
| if err := value.Decode(c.cacheParser); err != nil { | ||
| return err | ||
| } | ||
| if err := c.load(); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // load validates the cache configuration from the parser and copy it | ||
| // into the configuration. | ||
| func (c *Config) load() error { | ||
| switch c.cacheParser.Type { | ||
| case cacheTypeSQLite: | ||
| if c.cacheParser.Validity != "" { | ||
| var err error | ||
| c.Validity, err = time.ParseDuration(c.cacheParser.Validity) | ||
| if err != nil { | ||
| return errors.Wrap(err, "parsing cache validity duration") | ||
| } | ||
| } | ||
|
|
||
| if c.cacheParser.Jitter != "" { | ||
| var err error | ||
| c.Jitter, err = time.ParseDuration(c.cacheParser.Jitter) | ||
| if err != nil { | ||
| return errors.Wrap(err, "parsing cache jitter duration") | ||
| } | ||
| } | ||
| case cacheTypeNone, cacheTypeEmpty: | ||
| default: | ||
| return errors.New("unsupported cache type") | ||
| } | ||
| c.cacheType = c.cacheParser.Type | ||
| return nil | ||
| } | ||
|
|
||
| // configParser represents a cache configuration that can be parsed. | ||
| // These fields are not embed in a unified Config struct to avoid accidental | ||
| // usage of the duration fields (i.e. Validity and Jitter) as strings. | ||
| type configParser struct { | ||
| Type cacheType `yaml:"type"` | ||
| Validity string `yaml:"validity"` | ||
| Jitter string `yaml:"jitter"` | ||
| } | ||
|
|
||
| // newConfigParser is the constructor for ConfigParser. | ||
| func newConfigParser() *configParser { | ||
| return &configParser{ | ||
| Validity: defaultCacheValidity.String(), | ||
| } | ||
| } |
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