loveckiy.ivan
12 months ago
20 changed files with 1450 additions and 0 deletions
@ -0,0 +1,8 @@ |
|||
# Default ignored files |
|||
/shelf/ |
|||
/workspace.xml |
|||
# Editor-based HTTP Client requests |
|||
/httpRequests/ |
|||
# Datasource local storage ignored files |
|||
/dataSources/ |
|||
/dataSources.local.xml |
|||
@ -0,0 +1,185 @@ |
|||
package lib |
|||
|
|||
import ( |
|||
"fmt" |
|||
"sync" |
|||
"time" |
|||
|
|||
"github.com/ReneKroon/ttlcache" |
|||
|
|||
"github.com/pkg/errors" |
|||
) |
|||
|
|||
const cacheKeyPrefix = "cache." |
|||
|
|||
var ( |
|||
cacheCollection cache |
|||
) |
|||
|
|||
type cache struct { |
|||
items map[string]*cacheItem |
|||
mx sync.RWMutex |
|||
} |
|||
|
|||
type cacheItem struct { |
|||
// Getter определяет механизм получения данных от любого источника к/р поддерживает интерфейс
|
|||
reader Reader |
|||
cache *ttlcache.Cache |
|||
persistentCache *ttlcache.Cache |
|||
locks locks |
|||
cacheTTL time.Duration |
|||
} |
|||
|
|||
type Reader interface { |
|||
ReadSource() (res []byte, err error) |
|||
} |
|||
|
|||
func Cache() *cache { |
|||
if &cacheCollection == nil { |
|||
panic("cache has not been initialized, call CacheRegister() before use") |
|||
} |
|||
|
|||
return &cacheCollection |
|||
} |
|||
|
|||
// Register регистрируем новый кеш (указываем фукнцию, кр будет возвращать нужное значение)
|
|||
func (c *cache) Register(key string, source Reader, ttl time.Duration) (err error) { |
|||
c.mx.Lock() |
|||
defer c.mx.Unlock() |
|||
c.items = map[string]*cacheItem{} |
|||
|
|||
cache := ttlcache.NewCache() |
|||
cache.SkipTtlExtensionOnHit(true) |
|||
|
|||
ci := cacheItem{ |
|||
cache: cache, |
|||
persistentCache: ttlcache.NewCache(), |
|||
locks: locks{keys: map[string]bool{}}, |
|||
reader: source, |
|||
cacheTTL: ttl, |
|||
} |
|||
c.items[key] = &ci |
|||
return err |
|||
} |
|||
|
|||
// Unregister
|
|||
func (c *cache) Unregister(key string) (err error) { |
|||
c.mx.Lock() |
|||
defer c.mx.Unlock() |
|||
|
|||
delete(c.items, key) |
|||
return err |
|||
} |
|||
|
|||
// Get возвращает текущее значение параметра в сервисе keeper.
|
|||
// Нужно учитывать, что значения на время кешируются и обновляются с заданной периодичностью.
|
|||
func (c *cache) Get(key string) (value interface{}, err error) { |
|||
var item *cacheItem |
|||
var found bool |
|||
|
|||
item, found = c.items[key] |
|||
if !found { |
|||
return nil, fmt.Errorf("error. key is not found") |
|||
} |
|||
|
|||
if item.cache == nil { |
|||
return nil, fmt.Errorf("cache is not inited") |
|||
} |
|||
|
|||
if item.persistentCache == nil { |
|||
return nil, fmt.Errorf("persistent cache is not inited") |
|||
} |
|||
|
|||
if cachedValue, ok := item.cache.Get(cacheKeyPrefix + key); ok { |
|||
return cachedValue, nil |
|||
} |
|||
|
|||
// Если стоит блокировка, значит кто-то уже обновляет кеш. В этом случае
|
|||
// пытаемся отдать предыдущее значение.
|
|||
if item.locks.Get(key) { |
|||
return c.tryToGetOldValue(key) |
|||
} |
|||
|
|||
// Значение не найдено. Первый из запросов блокирует за собой обновление (на самом деле
|
|||
// может возникнуть ситуация когда несколько запросов поставят блокировку и начнут
|
|||
// обновлять кеш - пока считаем это некритичным).
|
|||
item.locks.Set(key, true) |
|||
defer item.locks.Set(key, false) |
|||
|
|||
var values []byte |
|||
values, err = item.reader.ReadSource() |
|||
if err != nil { |
|||
return nil, errors.Wrap(err, "could not get value from getter") |
|||
} |
|||
|
|||
value = values |
|||
|
|||
item.cache.SetWithTTL(cacheKeyPrefix+key, value, item.cacheTTL) |
|||
item.persistentCache.Set(cacheKeyPrefix+key, value) |
|||
|
|||
return value, nil |
|||
} |
|||
|
|||
// tryToGetOldValue пытается получить старое значение, если в момент запроса на актуальном стоит блокировка.
|
|||
func (c *cache) tryToGetOldValue(key string) (interface{}, error) { |
|||
var item *cacheItem |
|||
var found bool |
|||
|
|||
item, found = c.items[key] |
|||
if !found { |
|||
return nil, fmt.Errorf("error. key is not found") |
|||
} |
|||
|
|||
fnGetPersistentCacheValue := func() (interface{}, error) { |
|||
if cachedValue, ok := item.persistentCache.Get(cacheKeyPrefix + key); ok { |
|||
return cachedValue, nil |
|||
} |
|||
|
|||
return nil, fmt.Errorf("persinstent cache is empty") |
|||
} |
|||
|
|||
oldValue, err := fnGetPersistentCacheValue() |
|||
|
|||
// Повторяем попытку получить значение. При старте сервиса может возникнуть блокировка
|
|||
// обновления ключа, но при этом в постоянном кеше еще может не быть значения.
|
|||
if err != nil { |
|||
time.Sleep(100 * time.Millisecond) |
|||
|
|||
oldValue, err = fnGetPersistentCacheValue() |
|||
} |
|||
|
|||
return oldValue, err |
|||
} |
|||
|
|||
// CacheInit инициализировали глобальную переменную defaultCache
|
|||
// source - источник, откуда мы получаем значения для кеширования
|
|||
func CacheRegister() { |
|||
d := cache{ |
|||
items: map[string]*cacheItem{}, |
|||
mx: sync.RWMutex{}, |
|||
} |
|||
cacheCollection = d |
|||
} |
|||
|
|||
// locks выполняет функции блокировки при одновременном обновлении значений в кеше.
|
|||
type locks struct { |
|||
// keys хранит информацию о локах по каждому отдельному ключу.
|
|||
// Если значение установлено в true, в данный момент обновление кеша захвачено одной из горутин.
|
|||
keys map[string]bool |
|||
mx sync.RWMutex |
|||
} |
|||
|
|||
// Get возвращает информацию о том идет ли в данный момент обновление конкретного ключа.
|
|||
func (l *locks) Get(key string) bool { |
|||
l.mx.RLock() |
|||
defer l.mx.RUnlock() |
|||
|
|||
return l.keys[key] |
|||
} |
|||
|
|||
// Set устанавливает блокировку на обновление конкретного ключа другими горутинами.
|
|||
func (l *locks) Set(key string, value bool) { |
|||
l.mx.Lock() |
|||
l.keys[key] = value |
|||
l.mx.Unlock() |
|||
} |
|||
@ -0,0 +1,8 @@ |
|||
module git.lowcodeplatform.net/fabric/packages/cache |
|||
|
|||
go 1.19 |
|||
|
|||
require ( |
|||
github.com/ReneKroon/ttlcache v1.7.0 |
|||
github.com/pkg/errors v0.9.1 |
|||
) |
|||
@ -0,0 +1,14 @@ |
|||
github.com/ReneKroon/ttlcache v1.7.0 h1:8BkjFfrzVFXyrqnMtezAaJ6AHPSsVV10m6w28N/Fgkk= |
|||
github.com/ReneKroon/ttlcache v1.7.0/go.mod h1:8BGGzdumrIjWxdRx8zpK6L3oGMWvIXdvB2GD1cfvd+I= |
|||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= |
|||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= |
|||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= |
|||
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= |
|||
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= |
|||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= |
|||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= |
|||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= |
|||
github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= |
|||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= |
|||
go.uber.org/goleak v0.10.0 h1:G3eWbSNIskeRqtsN/1uI5B+eP73y3JUuBsv9AZjehb4= |
|||
go.uber.org/goleak v0.10.0/go.mod h1:VCZuO8V8mFPlL0F5J5GK1rtHV3DrFcQ1R8ryq7FK0aI= |
|||
@ -0,0 +1,18 @@ |
|||
language: go |
|||
|
|||
go: |
|||
- "1.14" |
|||
- "1.13" |
|||
git: |
|||
depth: 1 |
|||
|
|||
install: |
|||
- go install -race std |
|||
- go install golang.org/x/tools/cmd/cover |
|||
- go install golang.org/x/lint/golint |
|||
- export PATH=$HOME/gopath/bin:$PATH |
|||
|
|||
script: |
|||
- golint . |
|||
- go test -cover -race -count=1 -timeout=30s -run . |
|||
- cd bench; go test -run=Bench.* -bench=. -benchmem |
|||
@ -0,0 +1,21 @@ |
|||
MIT License |
|||
|
|||
Copyright (c) 2018 Rene Kroon |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy |
|||
of this software and associated documentation files (the "Software"), to deal |
|||
in the Software without restriction, including without limitation the rights |
|||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|||
copies of the Software, and to permit persons to whom the Software is |
|||
furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in all |
|||
copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|||
SOFTWARE. |
|||
@ -0,0 +1,71 @@ |
|||
## TTLCache - an in-memory cache with expiration |
|||
|
|||
TTLCache is a simple key/value cache in golang with the following functions: |
|||
|
|||
1. Thread-safe |
|||
2. Individual expiring time or global expiring time, you can choose |
|||
3. Auto-Extending expiration on `Get` -or- DNS style TTL, see `SkipTtlExtensionOnHit(bool)` |
|||
4. Fast and memory efficient |
|||
5. Can trigger callback on key expiration |
|||
6. Cleanup resources by calling `Close()` at end of lifecycle. |
|||
|
|||
Note (issue #25): by default, due to historic reasons, the TTL will be reset on each cache hit and you need to explicitly configure the cache to use a TTL that will not get extended. |
|||
|
|||
[](https://travis-ci.org/ReneKroon/ttlcache) |
|||
|
|||
#### Usage |
|||
```go |
|||
import ( |
|||
"time" |
|||
"fmt" |
|||
|
|||
"github.com/ReneKroon/ttlcache" |
|||
) |
|||
|
|||
func main () { |
|||
newItemCallback := func(key string, value interface{}) { |
|||
fmt.Printf("New key(%s) added\n", key) |
|||
} |
|||
checkExpirationCallback := func(key string, value interface{}) bool { |
|||
if key == "key1" { |
|||
// if the key equals "key1", the value |
|||
// will not be allowed to expire |
|||
return false |
|||
} |
|||
// all other values are allowed to expire |
|||
return true |
|||
} |
|||
expirationCallback := func(key string, value interface{}) { |
|||
fmt.Printf("This key(%s) has expired\n", key) |
|||
} |
|||
|
|||
cache := ttlcache.NewCache() |
|||
defer cache.Close() |
|||
cache.SetTTL(time.Duration(10 * time.Second)) |
|||
cache.SetExpirationCallback(expirationCallback) |
|||
|
|||
cache.Set("key", "value") |
|||
cache.SetWithTTL("keyWithTTL", "value", 10 * time.Second) |
|||
|
|||
value, exists := cache.Get("key") |
|||
count := cache.Count() |
|||
result := cache.Remove("key") |
|||
} |
|||
``` |
|||
|
|||
#### TTLCache - Some design considerations |
|||
|
|||
1. The complexity of the current cache is already quite high. Therefore i will not add 'convenience' features like an interface to supply a function to get missing keys. |
|||
2. The locking should be done only in the functions of the Cache struct. Else data races can occur or recursive locks are needed, which are both unwanted. |
|||
3. I prefer correct functionality over fast tests. It's ok for new tests to take seconds to proof something. |
|||
|
|||
#### Original Project |
|||
|
|||
TTLCache was forked from [wunderlist/ttlcache](https://github.com/wunderlist/ttlcache) to add extra functions not avaiable in the original scope. |
|||
The main differences are: |
|||
|
|||
1. A item can store any kind of object, previously, only strings could be saved |
|||
2. Optionally, you can add callbacks too: check if a value should expire, be notified if a value expires, and be notified when new values are added to the cache |
|||
3. The expiration can be either global or per item |
|||
4. Can exist items without expiration time |
|||
5. Expirations and callbacks are realtime. Don't have a pooling time to check anymore, now it's done with a heap. |
|||
@ -0,0 +1,307 @@ |
|||
package ttlcache |
|||
|
|||
import ( |
|||
"sync" |
|||
"time" |
|||
) |
|||
|
|||
// CheckExpireCallback is used as a callback for an external check on item expiration
|
|||
type checkExpireCallback func(key string, value interface{}) bool |
|||
|
|||
// ExpireCallback is used as a callback on item expiration or when notifying of an item new to the cache
|
|||
type expireCallback func(key string, value interface{}) |
|||
|
|||
// Cache is a synchronized map of items that can auto-expire once stale
|
|||
type Cache struct { |
|||
mutex sync.Mutex |
|||
ttl time.Duration |
|||
items map[string]*item |
|||
expireCallback expireCallback |
|||
checkExpireCallback checkExpireCallback |
|||
newItemCallback expireCallback |
|||
priorityQueue *priorityQueue |
|||
expirationNotification chan bool |
|||
expirationTime time.Time |
|||
skipTTLExtension bool |
|||
shutdownSignal chan (chan struct{}) |
|||
isShutDown bool |
|||
} |
|||
|
|||
func (cache *Cache) getItem(key string) (*item, bool, bool) { |
|||
item, exists := cache.items[key] |
|||
if !exists || item.expired() { |
|||
return nil, false, false |
|||
} |
|||
|
|||
if item.ttl >= 0 && (item.ttl > 0 || cache.ttl > 0) { |
|||
if cache.ttl > 0 && item.ttl == 0 { |
|||
item.ttl = cache.ttl |
|||
} |
|||
|
|||
if !cache.skipTTLExtension { |
|||
item.touch() |
|||
} |
|||
cache.priorityQueue.update(item) |
|||
} |
|||
|
|||
expirationNotification := false |
|||
if cache.expirationTime.After(time.Now().Add(item.ttl)) { |
|||
expirationNotification = true |
|||
} |
|||
return item, exists, expirationNotification |
|||
} |
|||
|
|||
func (cache *Cache) startExpirationProcessing() { |
|||
timer := time.NewTimer(time.Hour) |
|||
for { |
|||
var sleepTime time.Duration |
|||
cache.mutex.Lock() |
|||
if cache.priorityQueue.Len() > 0 { |
|||
sleepTime = time.Until(cache.priorityQueue.items[0].expireAt) |
|||
if sleepTime < 0 && cache.priorityQueue.items[0].expireAt.IsZero() { |
|||
sleepTime = time.Hour |
|||
} else if sleepTime < 0 { |
|||
sleepTime = time.Microsecond |
|||
} |
|||
if cache.ttl > 0 { |
|||
sleepTime = min(sleepTime, cache.ttl) |
|||
} |
|||
|
|||
} else if cache.ttl > 0 { |
|||
sleepTime = cache.ttl |
|||
} else { |
|||
sleepTime = time.Hour |
|||
} |
|||
|
|||
cache.expirationTime = time.Now().Add(sleepTime) |
|||
cache.mutex.Unlock() |
|||
|
|||
timer.Reset(sleepTime) |
|||
select { |
|||
case shutdownFeedback := <-cache.shutdownSignal: |
|||
timer.Stop() |
|||
cache.mutex.Lock() |
|||
if cache.priorityQueue.Len() > 0 { |
|||
cache.evictjob() |
|||
} |
|||
cache.mutex.Unlock() |
|||
shutdownFeedback <- struct{}{} |
|||
return |
|||
case <-timer.C: |
|||
timer.Stop() |
|||
cache.mutex.Lock() |
|||
if cache.priorityQueue.Len() == 0 { |
|||
cache.mutex.Unlock() |
|||
continue |
|||
} |
|||
|
|||
cache.cleanjob() |
|||
cache.mutex.Unlock() |
|||
|
|||
case <-cache.expirationNotification: |
|||
timer.Stop() |
|||
continue |
|||
} |
|||
} |
|||
} |
|||
|
|||
func (cache *Cache) evictjob() { |
|||
// index will only be advanced if the current entry will not be evicted
|
|||
i := 0 |
|||
for item := cache.priorityQueue.items[i]; ; item = cache.priorityQueue.items[i] { |
|||
|
|||
cache.priorityQueue.remove(item) |
|||
delete(cache.items, item.key) |
|||
if cache.expireCallback != nil { |
|||
go cache.expireCallback(item.key, item.data) |
|||
} |
|||
if cache.priorityQueue.Len() == 0 { |
|||
return |
|||
} |
|||
} |
|||
} |
|||
|
|||
func (cache *Cache) cleanjob() { |
|||
// index will only be advanced if the current entry will not be evicted
|
|||
i := 0 |
|||
for item := cache.priorityQueue.items[i]; item.expired(); item = cache.priorityQueue.items[i] { |
|||
|
|||
if cache.checkExpireCallback != nil { |
|||
if !cache.checkExpireCallback(item.key, item.data) { |
|||
item.touch() |
|||
cache.priorityQueue.update(item) |
|||
i++ |
|||
if i == cache.priorityQueue.Len() { |
|||
break |
|||
} |
|||
continue |
|||
} |
|||
} |
|||
|
|||
cache.priorityQueue.remove(item) |
|||
delete(cache.items, item.key) |
|||
if cache.expireCallback != nil { |
|||
go cache.expireCallback(item.key, item.data) |
|||
} |
|||
if cache.priorityQueue.Len() == 0 { |
|||
return |
|||
} |
|||
} |
|||
} |
|||
|
|||
// Close calls Purge, and then stops the goroutine that does ttl checking, for a clean shutdown.
|
|||
// The cache is no longer cleaning up after the first call to Close, repeated calls are safe though.
|
|||
func (cache *Cache) Close() { |
|||
|
|||
cache.mutex.Lock() |
|||
if !cache.isShutDown { |
|||
cache.isShutDown = true |
|||
cache.mutex.Unlock() |
|||
feedback := make(chan struct{}) |
|||
cache.shutdownSignal <- feedback |
|||
<-feedback |
|||
close(cache.shutdownSignal) |
|||
} else { |
|||
cache.mutex.Unlock() |
|||
} |
|||
cache.Purge() |
|||
} |
|||
|
|||
// Set is a thread-safe way to add new items to the map
|
|||
func (cache *Cache) Set(key string, data interface{}) { |
|||
cache.SetWithTTL(key, data, ItemExpireWithGlobalTTL) |
|||
} |
|||
|
|||
// SetWithTTL is a thread-safe way to add new items to the map with individual ttl
|
|||
func (cache *Cache) SetWithTTL(key string, data interface{}, ttl time.Duration) { |
|||
cache.mutex.Lock() |
|||
item, exists, _ := cache.getItem(key) |
|||
|
|||
if exists { |
|||
item.data = data |
|||
item.ttl = ttl |
|||
} else { |
|||
item = newItem(key, data, ttl) |
|||
cache.items[key] = item |
|||
} |
|||
|
|||
if item.ttl >= 0 && (item.ttl > 0 || cache.ttl > 0) { |
|||
if cache.ttl > 0 && item.ttl == 0 { |
|||
item.ttl = cache.ttl |
|||
} |
|||
item.touch() |
|||
} |
|||
|
|||
if exists { |
|||
cache.priorityQueue.update(item) |
|||
} else { |
|||
cache.priorityQueue.push(item) |
|||
} |
|||
|
|||
cache.mutex.Unlock() |
|||
if !exists && cache.newItemCallback != nil { |
|||
cache.newItemCallback(key, data) |
|||
} |
|||
cache.expirationNotification <- true |
|||
} |
|||
|
|||
// Get is a thread-safe way to lookup items
|
|||
// Every lookup, also touches the item, hence extending it's life
|
|||
func (cache *Cache) Get(key string) (interface{}, bool) { |
|||
cache.mutex.Lock() |
|||
item, exists, triggerExpirationNotification := cache.getItem(key) |
|||
|
|||
var dataToReturn interface{} |
|||
if exists { |
|||
dataToReturn = item.data |
|||
} |
|||
cache.mutex.Unlock() |
|||
if triggerExpirationNotification { |
|||
cache.expirationNotification <- true |
|||
} |
|||
return dataToReturn, exists |
|||
} |
|||
|
|||
func (cache *Cache) Remove(key string) bool { |
|||
cache.mutex.Lock() |
|||
object, exists := cache.items[key] |
|||
if !exists { |
|||
cache.mutex.Unlock() |
|||
return false |
|||
} |
|||
delete(cache.items, object.key) |
|||
cache.priorityQueue.remove(object) |
|||
cache.mutex.Unlock() |
|||
|
|||
return true |
|||
} |
|||
|
|||
// Count returns the number of items in the cache
|
|||
func (cache *Cache) Count() int { |
|||
cache.mutex.Lock() |
|||
length := len(cache.items) |
|||
cache.mutex.Unlock() |
|||
return length |
|||
} |
|||
|
|||
func (cache *Cache) SetTTL(ttl time.Duration) { |
|||
cache.mutex.Lock() |
|||
cache.ttl = ttl |
|||
cache.mutex.Unlock() |
|||
cache.expirationNotification <- true |
|||
} |
|||
|
|||
// SetExpirationCallback sets a callback that will be called when an item expires
|
|||
func (cache *Cache) SetExpirationCallback(callback expireCallback) { |
|||
cache.expireCallback = callback |
|||
} |
|||
|
|||
// SetCheckExpirationCallback sets a callback that will be called when an item is about to expire
|
|||
// in order to allow external code to decide whether the item expires or remains for another TTL cycle
|
|||
func (cache *Cache) SetCheckExpirationCallback(callback checkExpireCallback) { |
|||
cache.checkExpireCallback = callback |
|||
} |
|||
|
|||
// SetNewItemCallback sets a callback that will be called when a new item is added to the cache
|
|||
func (cache *Cache) SetNewItemCallback(callback expireCallback) { |
|||
cache.newItemCallback = callback |
|||
} |
|||
|
|||
// SkipTtlExtensionOnHit allows the user to change the cache behaviour. When this flag is set to true it will
|
|||
// no longer extend TTL of items when they are retrieved using Get, or when their expiration condition is evaluated
|
|||
// using SetCheckExpirationCallback.
|
|||
func (cache *Cache) SkipTtlExtensionOnHit(value bool) { |
|||
cache.skipTTLExtension = value |
|||
} |
|||
|
|||
// Purge will remove all entries
|
|||
func (cache *Cache) Purge() { |
|||
cache.mutex.Lock() |
|||
cache.items = make(map[string]*item) |
|||
cache.priorityQueue = newPriorityQueue() |
|||
cache.mutex.Unlock() |
|||
} |
|||
|
|||
// NewCache is a helper to create instance of the Cache struct
|
|||
func NewCache() *Cache { |
|||
|
|||
shutdownChan := make(chan chan struct{}) |
|||
|
|||
cache := &Cache{ |
|||
items: make(map[string]*item), |
|||
priorityQueue: newPriorityQueue(), |
|||
expirationNotification: make(chan bool), |
|||
expirationTime: time.Now(), |
|||
shutdownSignal: shutdownChan, |
|||
isShutDown: false, |
|||
} |
|||
go cache.startExpirationProcessing() |
|||
return cache |
|||
} |
|||
|
|||
func min(duration time.Duration, second time.Duration) time.Duration { |
|||
if duration < second { |
|||
return duration |
|||
} |
|||
return second |
|||
} |
|||
@ -0,0 +1,46 @@ |
|||
package ttlcache |
|||
|
|||
import ( |
|||
"time" |
|||
) |
|||
|
|||
const ( |
|||
// ItemNotExpire Will avoid the item being expired by TTL, but can still be exired by callback etc.
|
|||
ItemNotExpire time.Duration = -1 |
|||
// ItemExpireWithGlobalTTL will use the global TTL when set.
|
|||
ItemExpireWithGlobalTTL time.Duration = 0 |
|||
) |
|||
|
|||
func newItem(key string, data interface{}, ttl time.Duration) *item { |
|||
item := &item{ |
|||
data: data, |
|||
ttl: ttl, |
|||
key: key, |
|||
} |
|||
// since nobody is aware yet of this item, it's safe to touch without lock here
|
|||
item.touch() |
|||
return item |
|||
} |
|||
|
|||
type item struct { |
|||
key string |
|||
data interface{} |
|||
ttl time.Duration |
|||
expireAt time.Time |
|||
queueIndex int |
|||
} |
|||
|
|||
// Reset the item expiration time
|
|||
func (item *item) touch() { |
|||
if item.ttl > 0 { |
|||
item.expireAt = time.Now().Add(item.ttl) |
|||
} |
|||
} |
|||
|
|||
// Verify if the item is expired
|
|||
func (item *item) expired() bool { |
|||
if item.ttl <= 0 { |
|||
return false |
|||
} |
|||
return item.expireAt.Before(time.Now()) |
|||
} |
|||
@ -0,0 +1,71 @@ |
|||
package ttlcache |
|||
|
|||
import ( |
|||
"container/heap" |
|||
) |
|||
|
|||
func newPriorityQueue() *priorityQueue { |
|||
queue := &priorityQueue{} |
|||
heap.Init(queue) |
|||
return queue |
|||
} |
|||
|
|||
type priorityQueue struct { |
|||
items []*item |
|||
} |
|||
|
|||
func (pq *priorityQueue) update(item *item) { |
|||
heap.Fix(pq, item.queueIndex) |
|||
} |
|||
|
|||
func (pq *priorityQueue) push(item *item) { |
|||
heap.Push(pq, item) |
|||
} |
|||
|
|||
func (pq *priorityQueue) pop() *item { |
|||
if pq.Len() == 0 { |
|||
return nil |
|||
} |
|||
return heap.Pop(pq).(*item) |
|||
} |
|||
|
|||
func (pq *priorityQueue) remove(item *item) { |
|||
heap.Remove(pq, item.queueIndex) |
|||
} |
|||
|
|||
func (pq priorityQueue) Len() int { |
|||
length := len(pq.items) |
|||
return length |
|||
} |
|||
|
|||
// Less will consider items with time.Time default value (epoch start) as more than set items.
|
|||
func (pq priorityQueue) Less(i, j int) bool { |
|||
if pq.items[i].expireAt.IsZero() { |
|||
return false |
|||
} |
|||
if pq.items[j].expireAt.IsZero() { |
|||
return true |
|||
} |
|||
return pq.items[i].expireAt.Before(pq.items[j].expireAt) |
|||
} |
|||
|
|||
func (pq priorityQueue) Swap(i, j int) { |
|||
pq.items[i], pq.items[j] = pq.items[j], pq.items[i] |
|||
pq.items[i].queueIndex = i |
|||
pq.items[j].queueIndex = j |
|||
} |
|||
|
|||
func (pq *priorityQueue) Push(x interface{}) { |
|||
item := x.(*item) |
|||
item.queueIndex = len(pq.items) |
|||
pq.items = append(pq.items, item) |
|||
} |
|||
|
|||
func (pq *priorityQueue) Pop() interface{} { |
|||
old := pq.items |
|||
n := len(old) |
|||
item := old[n-1] |
|||
item.queueIndex = -1 |
|||
pq.items = old[0 : n-1] |
|||
return item |
|||
} |
|||
@ -0,0 +1,24 @@ |
|||
# Compiled Object files, Static and Dynamic libs (Shared Objects) |
|||
*.o |
|||
*.a |
|||
*.so |
|||
|
|||
# Folders |
|||
_obj |
|||
_test |
|||
|
|||
# Architecture specific extensions/prefixes |
|||
*.[568vq] |
|||
[568vq].out |
|||
|
|||
*.cgo1.go |
|||
*.cgo2.c |
|||
_cgo_defun.c |
|||
_cgo_gotypes.go |
|||
_cgo_export.* |
|||
|
|||
_testmain.go |
|||
|
|||
*.exe |
|||
*.test |
|||
*.prof |
|||
@ -0,0 +1,10 @@ |
|||
language: go |
|||
go_import_path: github.com/pkg/errors |
|||
go: |
|||
- 1.11.x |
|||
- 1.12.x |
|||
- 1.13.x |
|||
- tip |
|||
|
|||
script: |
|||
- make check |
|||
@ -0,0 +1,23 @@ |
|||
Copyright (c) 2015, Dave Cheney <dave@cheney.net> |
|||
All rights reserved. |
|||
|
|||
Redistribution and use in source and binary forms, with or without |
|||
modification, are permitted provided that the following conditions are met: |
|||
|
|||
* Redistributions of source code must retain the above copyright notice, this |
|||
list of conditions and the following disclaimer. |
|||
|
|||
* Redistributions in binary form must reproduce the above copyright notice, |
|||
this list of conditions and the following disclaimer in the documentation |
|||
and/or other materials provided with the distribution. |
|||
|
|||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
|||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
|||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|||
@ -0,0 +1,44 @@ |
|||
PKGS := github.com/pkg/errors |
|||
SRCDIRS := $(shell go list -f '{{.Dir}}' $(PKGS)) |
|||
GO := go |
|||
|
|||
check: test vet gofmt misspell unconvert staticcheck ineffassign unparam |
|||
|
|||
test: |
|||
$(GO) test $(PKGS) |
|||
|
|||
vet: | test |
|||
$(GO) vet $(PKGS) |
|||
|
|||
staticcheck: |
|||
$(GO) get honnef.co/go/tools/cmd/staticcheck |
|||
staticcheck -checks all $(PKGS) |
|||
|
|||
misspell: |
|||
$(GO) get github.com/client9/misspell/cmd/misspell |
|||
misspell \
|
|||
-locale GB \
|
|||
-error \
|
|||
*.md *.go |
|||
|
|||
unconvert: |
|||
$(GO) get github.com/mdempsky/unconvert |
|||
unconvert -v $(PKGS) |
|||
|
|||
ineffassign: |
|||
$(GO) get github.com/gordonklaus/ineffassign |
|||
find $(SRCDIRS) -name '*.go' | xargs ineffassign |
|||
|
|||
pedantic: check errcheck |
|||
|
|||
unparam: |
|||
$(GO) get mvdan.cc/unparam |
|||
unparam ./... |
|||
|
|||
errcheck: |
|||
$(GO) get github.com/kisielk/errcheck |
|||
errcheck $(PKGS) |
|||
|
|||
gofmt: |
|||
@echo Checking code is gofmted |
|||
@test -z "$(shell gofmt -s -l -d -e $(SRCDIRS) | tee /dev/stderr)" |
|||
@ -0,0 +1,59 @@ |
|||
# errors [](https://travis-ci.org/pkg/errors) [](https://ci.appveyor.com/project/davecheney/errors/branch/master) [](http://godoc.org/github.com/pkg/errors) [](https://goreportcard.com/report/github.com/pkg/errors) [](https://sourcegraph.com/github.com/pkg/errors?badge) |
|||
|
|||
Package errors provides simple error handling primitives. |
|||
|
|||
`go get github.com/pkg/errors` |
|||
|
|||
The traditional error handling idiom in Go is roughly akin to |
|||
```go |
|||
if err != nil { |
|||
return err |
|||
} |
|||
``` |
|||
which applied recursively up the call stack results in error reports without context or debugging information. The errors package allows programmers to add context to the failure path in their code in a way that does not destroy the original value of the error. |
|||
|
|||
## Adding context to an error |
|||
|
|||
The errors.Wrap function returns a new error that adds context to the original error. For example |
|||
```go |
|||
_, err := ioutil.ReadAll(r) |
|||
if err != nil { |
|||
return errors.Wrap(err, "read failed") |
|||
} |
|||
``` |
|||
## Retrieving the cause of an error |
|||
|
|||
Using `errors.Wrap` constructs a stack of errors, adding context to the preceding error. Depending on the nature of the error it may be necessary to reverse the operation of errors.Wrap to retrieve the original error for inspection. Any error value which implements this interface can be inspected by `errors.Cause`. |
|||
```go |
|||
type causer interface { |
|||
Cause() error |
|||
} |
|||
``` |
|||
`errors.Cause` will recursively retrieve the topmost error which does not implement `causer`, which is assumed to be the original cause. For example: |
|||
```go |
|||
switch err := errors.Cause(err).(type) { |
|||
case *MyError: |
|||
// handle specifically |
|||
default: |
|||
// unknown error |
|||
} |
|||
``` |
|||
|
|||
[Read the package documentation for more information](https://godoc.org/github.com/pkg/errors). |
|||
|
|||
## Roadmap |
|||
|
|||
With the upcoming [Go2 error proposals](https://go.googlesource.com/proposal/+/master/design/go2draft.md) this package is moving into maintenance mode. The roadmap for a 1.0 release is as follows: |
|||
|
|||
- 0.9. Remove pre Go 1.9 and Go 1.10 support, address outstanding pull requests (if possible) |
|||
- 1.0. Final release. |
|||
|
|||
## Contributing |
|||
|
|||
Because of the Go2 errors changes, this package is not accepting proposals for new functionality. With that said, we welcome pull requests, bug fixes and issue reports. |
|||
|
|||
Before sending a PR, please discuss your change by raising an issue. |
|||
|
|||
## License |
|||
|
|||
BSD-2-Clause |
|||
@ -0,0 +1,32 @@ |
|||
version: build-{build}.{branch} |
|||
|
|||
clone_folder: C:\gopath\src\github.com\pkg\errors |
|||
shallow_clone: true # for startup speed |
|||
|
|||
environment: |
|||
GOPATH: C:\gopath |
|||
|
|||
platform: |
|||
- x64 |
|||
|
|||
# http://www.appveyor.com/docs/installed-software |
|||
install: |
|||
# some helpful output for debugging builds |
|||
- go version |
|||
- go env |
|||
# pre-installed MinGW at C:\MinGW is 32bit only |
|||
# but MSYS2 at C:\msys64 has mingw64 |
|||
- set PATH=C:\msys64\mingw64\bin;%PATH% |
|||
- gcc --version |
|||
- g++ --version |
|||
|
|||
build_script: |
|||
- go install -v ./... |
|||
|
|||
test_script: |
|||
- set PATH=C:\gopath\bin;%PATH% |
|||
- go test -v ./... |
|||
|
|||
#artifacts: |
|||
# - path: '%GOPATH%\bin\*.exe' |
|||
deploy: off |
|||
@ -0,0 +1,288 @@ |
|||
// Package errors provides simple error handling primitives.
|
|||
//
|
|||
// The traditional error handling idiom in Go is roughly akin to
|
|||
//
|
|||
// if err != nil {
|
|||
// return err
|
|||
// }
|
|||
//
|
|||
// which when applied recursively up the call stack results in error reports
|
|||
// without context or debugging information. The errors package allows
|
|||
// programmers to add context to the failure path in their code in a way
|
|||
// that does not destroy the original value of the error.
|
|||
//
|
|||
// Adding context to an error
|
|||
//
|
|||
// The errors.Wrap function returns a new error that adds context to the
|
|||
// original error by recording a stack trace at the point Wrap is called,
|
|||
// together with the supplied message. For example
|
|||
//
|
|||
// _, err := ioutil.ReadAll(r)
|
|||
// if err != nil {
|
|||
// return errors.Wrap(err, "read failed")
|
|||
// }
|
|||
//
|
|||
// If additional control is required, the errors.WithStack and
|
|||
// errors.WithMessage functions destructure errors.Wrap into its component
|
|||
// operations: annotating an error with a stack trace and with a message,
|
|||
// respectively.
|
|||
//
|
|||
// Retrieving the cause of an error
|
|||
//
|
|||
// Using errors.Wrap constructs a stack of errors, adding context to the
|
|||
// preceding error. Depending on the nature of the error it may be necessary
|
|||
// to reverse the operation of errors.Wrap to retrieve the original error
|
|||
// for inspection. Any error value which implements this interface
|
|||
//
|
|||
// type causer interface {
|
|||
// Cause() error
|
|||
// }
|
|||
//
|
|||
// can be inspected by errors.Cause. errors.Cause will recursively retrieve
|
|||
// the topmost error that does not implement causer, which is assumed to be
|
|||
// the original cause. For example:
|
|||
//
|
|||
// switch err := errors.Cause(err).(type) {
|
|||
// case *MyError:
|
|||
// // handle specifically
|
|||
// default:
|
|||
// // unknown error
|
|||
// }
|
|||
//
|
|||
// Although the causer interface is not exported by this package, it is
|
|||
// considered a part of its stable public interface.
|
|||
//
|
|||
// Formatted printing of errors
|
|||
//
|
|||
// All error values returned from this package implement fmt.Formatter and can
|
|||
// be formatted by the fmt package. The following verbs are supported:
|
|||
//
|
|||
// %s print the error. If the error has a Cause it will be
|
|||
// printed recursively.
|
|||
// %v see %s
|
|||
// %+v extended format. Each Frame of the error's StackTrace will
|
|||
// be printed in detail.
|
|||
//
|
|||
// Retrieving the stack trace of an error or wrapper
|
|||
//
|
|||
// New, Errorf, Wrap, and Wrapf record a stack trace at the point they are
|
|||
// invoked. This information can be retrieved with the following interface:
|
|||
//
|
|||
// type stackTracer interface {
|
|||
// StackTrace() errors.StackTrace
|
|||
// }
|
|||
//
|
|||
// The returned errors.StackTrace type is defined as
|
|||
//
|
|||
// type StackTrace []Frame
|
|||
//
|
|||
// The Frame type represents a call site in the stack trace. Frame supports
|
|||
// the fmt.Formatter interface that can be used for printing information about
|
|||
// the stack trace of this error. For example:
|
|||
//
|
|||
// if err, ok := err.(stackTracer); ok {
|
|||
// for _, f := range err.StackTrace() {
|
|||
// fmt.Printf("%+s:%d\n", f, f)
|
|||
// }
|
|||
// }
|
|||
//
|
|||
// Although the stackTracer interface is not exported by this package, it is
|
|||
// considered a part of its stable public interface.
|
|||
//
|
|||
// See the documentation for Frame.Format for more details.
|
|||
package errors |
|||
|
|||
import ( |
|||
"fmt" |
|||
"io" |
|||
) |
|||
|
|||
// New returns an error with the supplied message.
|
|||
// New also records the stack trace at the point it was called.
|
|||
func New(message string) error { |
|||
return &fundamental{ |
|||
msg: message, |
|||
stack: callers(), |
|||
} |
|||
} |
|||
|
|||
// Errorf formats according to a format specifier and returns the string
|
|||
// as a value that satisfies error.
|
|||
// Errorf also records the stack trace at the point it was called.
|
|||
func Errorf(format string, args ...interface{}) error { |
|||
return &fundamental{ |
|||
msg: fmt.Sprintf(format, args...), |
|||
stack: callers(), |
|||
} |
|||
} |
|||
|
|||
// fundamental is an error that has a message and a stack, but no caller.
|
|||
type fundamental struct { |
|||
msg string |
|||
*stack |
|||
} |
|||
|
|||
func (f *fundamental) Error() string { return f.msg } |
|||
|
|||
func (f *fundamental) Format(s fmt.State, verb rune) { |
|||
switch verb { |
|||
case 'v': |
|||
if s.Flag('+') { |
|||
io.WriteString(s, f.msg) |
|||
f.stack.Format(s, verb) |
|||
return |
|||
} |
|||
fallthrough |
|||
case 's': |
|||
io.WriteString(s, f.msg) |
|||
case 'q': |
|||
fmt.Fprintf(s, "%q", f.msg) |
|||
} |
|||
} |
|||
|
|||
// WithStack annotates err with a stack trace at the point WithStack was called.
|
|||
// If err is nil, WithStack returns nil.
|
|||
func WithStack(err error) error { |
|||
if err == nil { |
|||
return nil |
|||
} |
|||
return &withStack{ |
|||
err, |
|||
callers(), |
|||
} |
|||
} |
|||
|
|||
type withStack struct { |
|||
error |
|||
*stack |
|||
} |
|||
|
|||
func (w *withStack) Cause() error { return w.error } |
|||
|
|||
// Unwrap provides compatibility for Go 1.13 error chains.
|
|||
func (w *withStack) Unwrap() error { return w.error } |
|||
|
|||
func (w *withStack) Format(s fmt.State, verb rune) { |
|||
switch verb { |
|||
case 'v': |
|||
if s.Flag('+') { |
|||
fmt.Fprintf(s, "%+v", w.Cause()) |
|||
w.stack.Format(s, verb) |
|||
return |
|||
} |
|||
fallthrough |
|||
case 's': |
|||
io.WriteString(s, w.Error()) |
|||
case 'q': |
|||
fmt.Fprintf(s, "%q", w.Error()) |
|||
} |
|||
} |
|||
|
|||
// Wrap returns an error annotating err with a stack trace
|
|||
// at the point Wrap is called, and the supplied message.
|
|||
// If err is nil, Wrap returns nil.
|
|||
func Wrap(err error, message string) error { |
|||
if err == nil { |
|||
return nil |
|||
} |
|||
err = &withMessage{ |
|||
cause: err, |
|||
msg: message, |
|||
} |
|||
return &withStack{ |
|||
err, |
|||
callers(), |
|||
} |
|||
} |
|||
|
|||
// Wrapf returns an error annotating err with a stack trace
|
|||
// at the point Wrapf is called, and the format specifier.
|
|||
// If err is nil, Wrapf returns nil.
|
|||
func Wrapf(err error, format string, args ...interface{}) error { |
|||
if err == nil { |
|||
return nil |
|||
} |
|||
err = &withMessage{ |
|||
cause: err, |
|||
msg: fmt.Sprintf(format, args...), |
|||
} |
|||
return &withStack{ |
|||
err, |
|||
callers(), |
|||
} |
|||
} |
|||
|
|||
// WithMessage annotates err with a new message.
|
|||
// If err is nil, WithMessage returns nil.
|
|||
func WithMessage(err error, message string) error { |
|||
if err == nil { |
|||
return nil |
|||
} |
|||
return &withMessage{ |
|||
cause: err, |
|||
msg: message, |
|||
} |
|||
} |
|||
|
|||
// WithMessagef annotates err with the format specifier.
|
|||
// If err is nil, WithMessagef returns nil.
|
|||
func WithMessagef(err error, format string, args ...interface{}) error { |
|||
if err == nil { |
|||
return nil |
|||
} |
|||
return &withMessage{ |
|||
cause: err, |
|||
msg: fmt.Sprintf(format, args...), |
|||
} |
|||
} |
|||
|
|||
type withMessage struct { |
|||
cause error |
|||
msg string |
|||
} |
|||
|
|||
func (w *withMessage) Error() string { return w.msg + ": " + w.cause.Error() } |
|||
func (w *withMessage) Cause() error { return w.cause } |
|||
|
|||
// Unwrap provides compatibility for Go 1.13 error chains.
|
|||
func (w *withMessage) Unwrap() error { return w.cause } |
|||
|
|||
func (w *withMessage) Format(s fmt.State, verb rune) { |
|||
switch verb { |
|||
case 'v': |
|||
if s.Flag('+') { |
|||
fmt.Fprintf(s, "%+v\n", w.Cause()) |
|||
io.WriteString(s, w.msg) |
|||
return |
|||
} |
|||
fallthrough |
|||
case 's', 'q': |
|||
io.WriteString(s, w.Error()) |
|||
} |
|||
} |
|||
|
|||
// Cause returns the underlying cause of the error, if possible.
|
|||
// An error value has a cause if it implements the following
|
|||
// interface:
|
|||
//
|
|||
// type causer interface {
|
|||
// Cause() error
|
|||
// }
|
|||
//
|
|||
// If the error does not implement Cause, the original error will
|
|||
// be returned. If the error is nil, nil will be returned without further
|
|||
// investigation.
|
|||
func Cause(err error) error { |
|||
type causer interface { |
|||
Cause() error |
|||
} |
|||
|
|||
for err != nil { |
|||
cause, ok := err.(causer) |
|||
if !ok { |
|||
break |
|||
} |
|||
err = cause.Cause() |
|||
} |
|||
return err |
|||
} |
|||
@ -0,0 +1,38 @@ |
|||
// +build go1.13
|
|||
|
|||
package errors |
|||
|
|||
import ( |
|||
stderrors "errors" |
|||
) |
|||
|
|||
// Is reports whether any error in err's chain matches target.
|
|||
//
|
|||
// The chain consists of err itself followed by the sequence of errors obtained by
|
|||
// repeatedly calling Unwrap.
|
|||
//
|
|||
// An error is considered to match a target if it is equal to that target or if
|
|||
// it implements a method Is(error) bool such that Is(target) returns true.
|
|||
func Is(err, target error) bool { return stderrors.Is(err, target) } |
|||
|
|||
// As finds the first error in err's chain that matches target, and if so, sets
|
|||
// target to that error value and returns true.
|
|||
//
|
|||
// The chain consists of err itself followed by the sequence of errors obtained by
|
|||
// repeatedly calling Unwrap.
|
|||
//
|
|||
// An error matches target if the error's concrete value is assignable to the value
|
|||
// pointed to by target, or if the error has a method As(interface{}) bool such that
|
|||
// As(target) returns true. In the latter case, the As method is responsible for
|
|||
// setting target.
|
|||
//
|
|||
// As will panic if target is not a non-nil pointer to either a type that implements
|
|||
// error, or to any interface type. As returns false if err is nil.
|
|||
func As(err error, target interface{}) bool { return stderrors.As(err, target) } |
|||
|
|||
// Unwrap returns the result of calling the Unwrap method on err, if err's
|
|||
// type contains an Unwrap method returning error.
|
|||
// Otherwise, Unwrap returns nil.
|
|||
func Unwrap(err error) error { |
|||
return stderrors.Unwrap(err) |
|||
} |
|||
@ -0,0 +1,177 @@ |
|||
package errors |
|||
|
|||
import ( |
|||
"fmt" |
|||
"io" |
|||
"path" |
|||
"runtime" |
|||
"strconv" |
|||
"strings" |
|||
) |
|||
|
|||
// Frame represents a program counter inside a stack frame.
|
|||
// For historical reasons if Frame is interpreted as a uintptr
|
|||
// its value represents the program counter + 1.
|
|||
type Frame uintptr |
|||
|
|||
// pc returns the program counter for this frame;
|
|||
// multiple frames may have the same PC value.
|
|||
func (f Frame) pc() uintptr { return uintptr(f) - 1 } |
|||
|
|||
// file returns the full path to the file that contains the
|
|||
// function for this Frame's pc.
|
|||
func (f Frame) file() string { |
|||
fn := runtime.FuncForPC(f.pc()) |
|||
if fn == nil { |
|||
return "unknown" |
|||
} |
|||
file, _ := fn.FileLine(f.pc()) |
|||
return file |
|||
} |
|||
|
|||
// line returns the line number of source code of the
|
|||
// function for this Frame's pc.
|
|||
func (f Frame) line() int { |
|||
fn := runtime.FuncForPC(f.pc()) |
|||
if fn == nil { |
|||
return 0 |
|||
} |
|||
_, line := fn.FileLine(f.pc()) |
|||
return line |
|||
} |
|||
|
|||
// name returns the name of this function, if known.
|
|||
func (f Frame) name() string { |
|||
fn := runtime.FuncForPC(f.pc()) |
|||
if fn == nil { |
|||
return "unknown" |
|||
} |
|||
return fn.Name() |
|||
} |
|||
|
|||
// Format formats the frame according to the fmt.Formatter interface.
|
|||
//
|
|||
// %s source file
|
|||
// %d source line
|
|||
// %n function name
|
|||
// %v equivalent to %s:%d
|
|||
//
|
|||
// Format accepts flags that alter the printing of some verbs, as follows:
|
|||
//
|
|||
// %+s function name and path of source file relative to the compile time
|
|||
// GOPATH separated by \n\t (<funcname>\n\t<path>)
|
|||
// %+v equivalent to %+s:%d
|
|||
func (f Frame) Format(s fmt.State, verb rune) { |
|||
switch verb { |
|||
case 's': |
|||
switch { |
|||
case s.Flag('+'): |
|||
io.WriteString(s, f.name()) |
|||
io.WriteString(s, "\n\t") |
|||
io.WriteString(s, f.file()) |
|||
default: |
|||
io.WriteString(s, path.Base(f.file())) |
|||
} |
|||
case 'd': |
|||
io.WriteString(s, strconv.Itoa(f.line())) |
|||
case 'n': |
|||
io.WriteString(s, funcname(f.name())) |
|||
case 'v': |
|||
f.Format(s, 's') |
|||
io.WriteString(s, ":") |
|||
f.Format(s, 'd') |
|||
} |
|||
} |
|||
|
|||
// MarshalText formats a stacktrace Frame as a text string. The output is the
|
|||
// same as that of fmt.Sprintf("%+v", f), but without newlines or tabs.
|
|||
func (f Frame) MarshalText() ([]byte, error) { |
|||
name := f.name() |
|||
if name == "unknown" { |
|||
return []byte(name), nil |
|||
} |
|||
return []byte(fmt.Sprintf("%s %s:%d", name, f.file(), f.line())), nil |
|||
} |
|||
|
|||
// StackTrace is stack of Frames from innermost (newest) to outermost (oldest).
|
|||
type StackTrace []Frame |
|||
|
|||
// Format formats the stack of Frames according to the fmt.Formatter interface.
|
|||
//
|
|||
// %s lists source files for each Frame in the stack
|
|||
// %v lists the source file and line number for each Frame in the stack
|
|||
//
|
|||
// Format accepts flags that alter the printing of some verbs, as follows:
|
|||
//
|
|||
// %+v Prints filename, function, and line number for each Frame in the stack.
|
|||
func (st StackTrace) Format(s fmt.State, verb rune) { |
|||
switch verb { |
|||
case 'v': |
|||
switch { |
|||
case s.Flag('+'): |
|||
for _, f := range st { |
|||
io.WriteString(s, "\n") |
|||
f.Format(s, verb) |
|||
} |
|||
case s.Flag('#'): |
|||
fmt.Fprintf(s, "%#v", []Frame(st)) |
|||
default: |
|||
st.formatSlice(s, verb) |
|||
} |
|||
case 's': |
|||
st.formatSlice(s, verb) |
|||
} |
|||
} |
|||
|
|||
// formatSlice will format this StackTrace into the given buffer as a slice of
|
|||
// Frame, only valid when called with '%s' or '%v'.
|
|||
func (st StackTrace) formatSlice(s fmt.State, verb rune) { |
|||
io.WriteString(s, "[") |
|||
for i, f := range st { |
|||
if i > 0 { |
|||
io.WriteString(s, " ") |
|||
} |
|||
f.Format(s, verb) |
|||
} |
|||
io.WriteString(s, "]") |
|||
} |
|||
|
|||
// stack represents a stack of program counters.
|
|||
type stack []uintptr |
|||
|
|||
func (s *stack) Format(st fmt.State, verb rune) { |
|||
switch verb { |
|||
case 'v': |
|||
switch { |
|||
case st.Flag('+'): |
|||
for _, pc := range *s { |
|||
f := Frame(pc) |
|||
fmt.Fprintf(st, "\n%+v", f) |
|||
} |
|||
} |
|||
} |
|||
} |
|||
|
|||
func (s *stack) StackTrace() StackTrace { |
|||
f := make([]Frame, len(*s)) |
|||
for i := 0; i < len(f); i++ { |
|||
f[i] = Frame((*s)[i]) |
|||
} |
|||
return f |
|||
} |
|||
|
|||
func callers() *stack { |
|||
const depth = 32 |
|||
var pcs [depth]uintptr |
|||
n := runtime.Callers(3, pcs[:]) |
|||
var st stack = pcs[0:n] |
|||
return &st |
|||
} |
|||
|
|||
// funcname removes the path prefix component of a function's name reported by func.Name().
|
|||
func funcname(name string) string { |
|||
i := strings.LastIndex(name, "/") |
|||
name = name[i+1:] |
|||
i = strings.Index(name, ".") |
|||
return name[i+1:] |
|||
} |
|||
@ -0,0 +1,6 @@ |
|||
# github.com/ReneKroon/ttlcache v1.7.0 |
|||
## explicit; go 1.14 |
|||
github.com/ReneKroon/ttlcache |
|||
# github.com/pkg/errors v0.9.1 |
|||
## explicit |
|||
github.com/pkg/errors |
|||
Loading…
Reference in new issue