@@ -10,28 +10,35 @@ package cache
1010// Repo: https://github.com/fabiocicerchia/go-proxy-cache
1111
1212import (
13- "errors"
14- "fmt"
1513 "net/http"
1614 "net/url"
1715 "strings"
1816 "time"
1917
18+ "github.com/pkg/errors"
19+
2020 "github.com/fabiocicerchia/go-proxy-cache/cache/engine"
2121 "github.com/fabiocicerchia/go-proxy-cache/utils"
2222 "github.com/fabiocicerchia/go-proxy-cache/utils/slice"
2323 log "github.com/sirupsen/logrus"
2424)
2525
26- // CacheObj - Contains cache settings and current cached/cacheable object.
27- type CacheObj struct {
28- AllowedStatuses []int
29- AllowedMethods []string
30- CurrentObj URIObj
31- DomainID string
26+ var errMissingRedisConnection = errors .New ("missing redis connection" )
27+ var errNotAllowed = errors .New ("not allowed" )
28+ var errCannotFetchMetadata = errors .New ("cannot fetch metadata" )
29+ var errCannotGetKey = errors .New ("cannot get key" )
30+ var errCannotDecode = errors .New ("cannot decode" )
31+ var errVaryWildcard = errors .New ("vary: *" )
32+
33+ // Object - Contains cache settings and current cached/cacheable object.
34+ type Object struct {
35+ AllowedStatuses []int
36+ AllowedMethods []string
37+ CurrentURIObject URIObj
38+ DomainID string
3239}
3340
34- // URIObj - Holds details about the response
41+ // URIObj - Holds details about the response.
3542type URIObj struct {
3643 URL url.URL
3744 Host string
@@ -44,35 +51,34 @@ type URIObj struct {
4451}
4552
4653// IsStatusAllowed - Checks if a status code is allowed to be cached.
47- func (c CacheObj ) IsStatusAllowed () bool {
48- return slice .ContainsInt (c .AllowedStatuses , c .CurrentObj .StatusCode )
54+ func (c Object ) IsStatusAllowed () bool {
55+ return slice .ContainsInt (c .AllowedStatuses , c .CurrentURIObject .StatusCode )
4956}
5057
5158// IsMethodAllowed - Checks if a HTTP method is allowed to be cached.
52- func (c CacheObj ) IsMethodAllowed () bool {
53- return slice .ContainsString (c .AllowedMethods , c .CurrentObj .Method )
59+ func (c Object ) IsMethodAllowed () bool {
60+ return slice .ContainsString (c .AllowedMethods , c .CurrentURIObject .Method )
5461}
5562
5663// IsValid - Verifies the validity of a cacheable object.
57- func (c CacheObj ) IsValid () (bool , error ) {
58- if ! c .IsStatusAllowed () || slice .LenSliceBytes (c .CurrentObj .Content ) == 0 {
59- return false , fmt .Errorf (
60- "not allowed. status %d - content length %d" ,
61- c .CurrentObj .StatusCode ,
62- slice .LenSliceBytes (c .CurrentObj .Content ),
63- )
64+ func (c Object ) IsValid () (bool , error ) {
65+ if ! c .IsStatusAllowed () || slice .LenSliceBytes (c .CurrentURIObject .Content ) == 0 {
66+ return false , errors .Wrapf (errNotAllowed ,
67+ "status %d - content length %d" ,
68+ c .CurrentURIObject .StatusCode ,
69+ slice .LenSliceBytes (c .CurrentURIObject .Content ))
6470 }
6571
6672 return true , nil
6773}
6874
69- func (c CacheObj ) handleMetadata (domainID string , targetURL url.URL , expiration time.Duration ) ([]string , error ) {
70- meta , err := GetVary (c .CurrentObj .ResponseHeaders )
75+ func (c Object ) handleMetadata (domainID string , targetURL url.URL , expiration time.Duration ) ([]string , error ) {
76+ meta , err := GetVary (c .CurrentURIObject .ResponseHeaders )
7177 if err != nil {
7278 return []string {}, err
7379 }
7480
75- _ , err = StoreMetadata (domainID , c .CurrentObj .Method , targetURL , meta , expiration )
81+ _ , err = StoreMetadata (domainID , c .CurrentURIObject .Method , targetURL , meta , expiration )
7682 if err != nil {
7783 return []string {}, err
7884 }
@@ -81,15 +87,21 @@ func (c CacheObj) handleMetadata(domainID string, targetURL url.URL, expiration
8187}
8288
8389// StoreFullPage - Stores the whole page response in cache.
84- func (c CacheObj ) StoreFullPage (expiration time.Duration ) (bool , error ) {
90+ func (c Object ) StoreFullPage (expiration time.Duration ) (bool , error ) {
8591 if ! c .IsStatusAllowed () || ! c .IsMethodAllowed () || expiration < 1 {
86- log .Debugf ("Not allowed to be stored. Status: %v - Method: %v - Expiration: %v" , c .IsStatusAllowed (), c .IsMethodAllowed (), expiration )
92+ log .Debugf (
93+ "Not allowed to be stored. Status: %v - Method: %v - Expiration: %v" ,
94+ c .IsStatusAllowed (),
95+ c .IsMethodAllowed (),
96+ expiration ,
97+ )
98+
8799 return false , nil
88100 }
89101
90- targetURL := c .CurrentObj .URL
91- targetURL .Scheme = c .CurrentObj .Scheme
92- targetURL .Host = c .CurrentObj .Host
102+ targetURL := c .CurrentURIObject .URL
103+ targetURL .Scheme = c .CurrentURIObject .Scheme
104+ targetURL .Host = c .CurrentURIObject .Host
93105
94106 meta , err := c .handleMetadata (c .DomainID , targetURL , expiration )
95107 if err != nil {
@@ -98,61 +110,61 @@ func (c CacheObj) StoreFullPage(expiration time.Duration) (bool, error) {
98110
99111 conn := engine .GetConn (c .DomainID )
100112 if conn == nil {
101- return false , fmt . Errorf ( "missing redis connection for %s"c .DomainID )
113+ return false , errors . Wrapf ( errMissingRedisConnection , "Error for %s"c .DomainID )
102114 }
103115
104- encoded , err := conn .Encode (c .CurrentObj )
116+ encoded , err := conn .Encode (c .CurrentURIObject )
105117 if err != nil {
106118 return false , err
107119 }
108120
109- key := StorageKey (c .CurrentObj .Method , targetURL , meta , c .CurrentObj .RequestHeaders )
121+ key := StorageKey (c .CurrentURIObject .Method , targetURL , meta , c .CurrentURIObject .RequestHeaders )
110122
111123 return conn .Set (key , encoded , expiration )
112124}
113125
114126// RetrieveFullPage - Retrieves the whole page response from cache.
115- func (c * CacheObj ) RetrieveFullPage (method string , url url.URL , reqHeaders http.Header ) error {
127+ func (c * Object ) RetrieveFullPage (method string , url url.URL , reqHeaders http.Header ) error {
116128 obj := & URIObj {}
117129
118130 meta , err := FetchMetadata (c .DomainID , method , url )
119131 if err != nil {
120- return fmt . Errorf ( "cannot fetch metadata: %s" , err )
132+ return errors . Wrap ( errCannotFetchMetadata , err . Error () )
121133 }
122134
123135 conn := engine .GetConn (c .DomainID )
124136 if conn == nil {
125- return fmt . Errorf ( "missing redis connection for %s"c .DomainID )
137+ return errors . Wrapf ( errMissingRedisConnection , "Error for %s"c .DomainID )
126138 }
127139
128140 key := StorageKey (method , url , meta , reqHeaders )
129141 log .Debugf ("StorageKey: %s" , key )
130142
131143 encoded , err := conn .Get (key )
132144 if err != nil {
133- return fmt . Errorf ( "cannot get key: %s" , err )
145+ return errors . Wrap ( errCannotGetKey , err . Error () )
134146 }
135147
136148 err = conn .Decode (encoded , obj )
137149 if err != nil {
138- return fmt . Errorf ( "cannot decode: %s" , err )
150+ return errors . Wrap ( errCannotDecode , err . Error () )
139151 }
140152
141- c .CurrentObj = * obj
153+ c .CurrentURIObject = * obj
142154
143155 return nil
144156}
145157
146158// PurgeFullPage - Deletes the whole page response from cache.
147- func (c CacheObj ) PurgeFullPage (method string , url url.URL ) (bool , error ) {
159+ func (c Object ) PurgeFullPage (method string , url url.URL ) (bool , error ) {
148160 err := PurgeMetadata (c .DomainID , url )
149161 if err != nil {
150162 return false , err
151163 }
152164
153165 conn := engine .GetConn (c .DomainID )
154166 if conn == nil {
155- return false , fmt . Errorf ( "missing redis connection for %s"c .DomainID )
167+ return false , errors . Wrapf ( errMissingRedisConnection , "Error for %s"c .DomainID )
156168 }
157169
158170 var meta []string
@@ -161,6 +173,7 @@ func (c CacheObj) PurgeFullPage(method string, url url.URL) (bool, error) {
161173 match := utils .StringSeparatorOne + "PURGE" + utils .StringSeparatorOne
162174 replace := utils .StringSeparatorOne + "*" + utils .StringSeparatorOne
163175 keyPattern := strings .Replace (key , match , replace , 1 ) + "*"
176+
164177 affected , err := conn .DelWildcard (keyPattern )
165178 if err != nil {
166179 return false , err
@@ -192,7 +205,7 @@ func FetchMetadata(domainID string, method string, url url.URL) ([]string, error
192205
193206 conn := engine .GetConn (domainID )
194207 if conn == nil {
195- return []string {}, fmt . Errorf ( "missing redis connection for %s"domainID )
208+ return []string {}, errors . Wrapf ( errMissingRedisConnection , "Error for %s"domainID )
196209 }
197210
198211 return conn .List (key )
@@ -204,10 +217,11 @@ func PurgeMetadata(domainID string, url url.URL) error {
204217
205218 conn := engine .GetConn (domainID )
206219 if conn == nil {
207- return fmt . Errorf ( "missing redis connection for %s"domainID )
220+ return errors . Wrapf ( errMissingRedisConnection , "Error for %s"domainID )
208221 }
209222
210223 _ , err := conn .DelWildcard (keyPattern )
224+
211225 return err
212226}
213227
@@ -217,10 +231,11 @@ func StoreMetadata(domainID string, method string, url url.URL, meta []string, e
217231
218232 conn := engine .GetConn (domainID )
219233 if conn == nil {
220- return false , fmt . Errorf ( "missing redis connection for %s"domainID )
234+ return false , errors . Wrapf ( errMissingRedisConnection , "Error for %s"domainID )
221235 }
222236
223- _ = conn .Del (key ) //nolint:golint,errcheck
237+ _ = conn .Del (key )
238+
224239 err := conn .Push (key , meta )
225240 if err != nil {
226241 return false , err
@@ -242,7 +257,7 @@ func GetVary(headers http.Header) ([]string, error) {
242257 vary := headers .Get ("Vary" )
243258
244259 if vary == "*" {
245- return []string {}, errors . New ( "vary: *" )
260+ return []string {}, errVaryWildcard
246261 }
247262
248263 varyList := strings .Split (vary , "," )
0 commit comments