rely on httpcache for response caching

This commit is contained in:
Will Norris 2013-12-25 18:48:10 -08:00
parent b9584c18cb
commit 73f6357cda
5 changed files with 43 additions and 119 deletions

31
cache/cache.go vendored
View file

@ -1,31 +0,0 @@
// Copyright 2013 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package cache implements a image cache.
package cache
import "github.com/willnorris/go-imageproxy/data"
// Cache provides a cache for image metadata and transformed variants of the
// image.
type Cache interface {
// Get retrieves the cached Image for the provided image URL.
Get(string) (image *data.Image, ok bool)
// Put caches the provided Image.
Save(*data.Image)
// Delete deletes the cached Image and all variants for the image at the specified URL.
Delete(string)
}

41
cache/memory.go vendored
View file

@ -1,41 +0,0 @@
// Copyright 2013 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cache
import "github.com/willnorris/go-imageproxy/data"
// MemoryCache provides an in-memory Cache implementation.
type MemoryCache struct {
images map[string]*data.Image
}
func NewMemoryCache() *MemoryCache {
return &MemoryCache{
make(map[string]*data.Image),
}
}
func (c MemoryCache) Get(u string) (*data.Image, bool) {
image, ok := c.images[u]
return image, ok
}
func (c MemoryCache) Save(image *data.Image) {
c.images[image.URL] = image
}
func (c MemoryCache) Delete(u string) {
delete(c.images, u)
}

View file

@ -21,7 +21,7 @@ import (
"net/http" "net/http"
"strings" "strings"
"github.com/willnorris/go-imageproxy/cache" "github.com/gregjones/httpcache"
"github.com/willnorris/go-imageproxy/proxy" "github.com/willnorris/go-imageproxy/proxy"
) )
@ -33,8 +33,8 @@ func main() {
fmt.Printf("go-imageproxy listening on %s\n", *addr) fmt.Printf("go-imageproxy listening on %s\n", *addr)
p := proxy.NewProxy(nil) c := httpcache.NewMemoryCache()
p.Cache = cache.NewMemoryCache() p := proxy.NewProxy(nil, c)
p.MaxWidth = 2000 p.MaxWidth = 2000
p.MaxHeight = 2000 p.MaxHeight = 2000
if *whitelist != "" { if *whitelist != "" {

View file

@ -12,15 +12,26 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
package cache package proxy
import "github.com/willnorris/go-imageproxy/data" // The Cache interface defines a cache for storing arbitrary data. The
// interface is designed to align with httpcache.Cache.
type Cache interface {
// Get retrieves the cached data for the provided key.
Get(key string) (data []byte, ok bool)
// Set caches the provided data.
Set(key string, data []byte)
// Delete deletes the cached data at the specified key.
Delete(key string)
}
// NopCache provides a no-op cache implementation that doesn't actually cache anything. // NopCache provides a no-op cache implementation that doesn't actually cache anything.
var NopCache = new(nopCache) var NopCache = new(nopCache)
type nopCache struct{} type nopCache struct{}
func (c nopCache) Get(u string) (*data.Image, bool) { return nil, false } func (c nopCache) Get(string) ([]byte, bool) { return nil, false }
func (c nopCache) Save(image *data.Image) {} func (c nopCache) Set(string, []byte) {}
func (c nopCache) Delete(u string) {} func (c nopCache) Delete(string) {}

View file

@ -26,7 +26,7 @@ import (
"time" "time"
"github.com/golang/glog" "github.com/golang/glog"
"github.com/willnorris/go-imageproxy/cache" "github.com/gregjones/httpcache"
"github.com/willnorris/go-imageproxy/data" "github.com/willnorris/go-imageproxy/data"
"github.com/willnorris/go-imageproxy/transform" "github.com/willnorris/go-imageproxy/transform"
) )
@ -79,7 +79,7 @@ func NewRequest(r *http.Request) (*data.Request, error) {
// Proxy serves image requests. // Proxy serves image requests.
type Proxy struct { type Proxy struct {
Client *http.Client // client used to fetch remote URLs Client *http.Client // client used to fetch remote URLs
Cache cache.Cache Cache Cache
// Whitelist specifies a list of remote hosts that images can be proxied from. An empty list means all hosts are allowed. // Whitelist specifies a list of remote hosts that images can be proxied from. An empty list means all hosts are allowed.
Whitelist []string Whitelist []string
@ -90,11 +90,24 @@ type Proxy struct {
// NewProxy constructs a new proxy. The provided http Client will be used to // NewProxy constructs a new proxy. The provided http Client will be used to
// fetch remote URLs. If nil is provided, http.DefaultClient will be used. // fetch remote URLs. If nil is provided, http.DefaultClient will be used.
func NewProxy(client *http.Client) *Proxy { func NewProxy(client *http.Client, cache Cache) *Proxy {
if client == nil { if client == nil {
client = http.DefaultClient client = http.DefaultClient
} }
return &Proxy{Client: client, Cache: cache.NopCache} if cache == nil {
cache = NopCache
}
return &Proxy{
Client: &http.Client{
Transport: &httpcache.Transport{
Transport: client.Transport,
Cache: cache,
MarkCachedResponses: true,
},
},
Cache: cache,
}
} }
// ServeHTTP handles image requests. // ServeHTTP handles image requests.
@ -122,23 +135,11 @@ func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request) {
return return
} }
image, ok := p.Cache.Get(u) image, err := p.fetchRemoteImage(u)
if !ok {
glog.Infof("image not cached")
image, err = p.fetchRemoteImage(u, nil)
if err != nil { if err != nil {
glog.Errorf("error fetching remote image: %v", err) glog.Errorf("error fetching remote image: %v", err)
} http.Error(w, fmt.Sprintf("Error fetching remote image: %v", err), http.StatusInternalServerError)
p.Cache.Save(image) return
} else if time.Now().After(image.Expires) {
glog.Infof("cached image expired")
image, err = p.fetchRemoteImage(u, image)
if err != nil {
glog.Errorf("error fetching remote image: %v", err)
}
p.Cache.Save(image)
} else {
glog.Infof("serving from cache")
} }
image, _ = transform.Transform(*image, req.Options) image, _ = transform.Transform(*image, req.Options)
@ -148,29 +149,13 @@ func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request) {
w.Write(image.Bytes) w.Write(image.Bytes)
} }
func (p *Proxy) fetchRemoteImage(u string, cached *data.Image) (*data.Image, error) { func (p *Proxy) fetchRemoteImage(u string) (*data.Image, error) {
glog.Infof("fetching remote image: %s", u) glog.Infof("fetching remote image: %s", u)
resp, err := p.Client.Get(u)
req, err := http.NewRequest("GET", u, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
if cached != nil && cached.Etag != "" {
req.Header.Add("If-None-Match", cached.Etag)
}
resp, err := p.Client.Do(req)
if err != nil {
return nil, err
}
if resp.StatusCode == http.StatusNotModified {
glog.Infof("remote image not modified (304 response)")
cached.Expires = parseExpires(resp)
return cached, nil
}
if resp.StatusCode != http.StatusOK { if resp.StatusCode != http.StatusOK {
return nil, errors.New(fmt.Sprintf("HTTP status not OK: %v", resp.Status)) return nil, errors.New(fmt.Sprintf("HTTP status not OK: %v", resp.Status))
} }