async-http-cache 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21fb7edbe7e010844dd2e65be5e6e89a254cf5255fd69fc8ab5361a8887fe736
-  data.tar.gz: ba72529946ade707aa5eb8b841f1dc1dbe4fcb89386b00d626e4cb2f6ddad4fe
+  metadata.gz: 923d97088cda9896dcec9c48c21b6142fc9002acfc15ae70a5cb6fac4eacf086
+  data.tar.gz: 9819dd06fa5f44a42c7b9f866477fa163df6e857ce0c5618306f5962f2bbfcc1
 SHA512:
-  metadata.gz: 3b595aa2984299737811729f0834e9fdef80f06aff21f3ce408f7ee2ccf02d1e93791559782b8568cb5aeb04674b65d8d0d10c54055ea297ce7d5765b4409152
-  data.tar.gz: 80617864a94487a8ab42bec43f005ff434353b774810613815d0894da5c762491ecb91ccbdac609470d2da30ff39f94844273a9051d4c63183ff52c4ac36519e
+  metadata.gz: c1ffbd84fe0928014e500f0290a25720581e50ef688e30ad8161fd3b62ea7a6acc21fe2b40a12cf47ef0f3ec2e007e2613f63cb4fdf1518bf324ae88c63b58ad
+  data.tar.gz: e4ece204ed54c4d23c1e831d887ae2b7cb169e702b80e890f4bac5438f393fb31c15a873f494ac1ffcc1d3a88663b4eb12e0abb2c95c9fee4e4f030771158b8c

data/README.md

@@ -30,6 +30,10 @@ ensure
 end
 ```
 
+## Vary
+
+The `vary` header creates a headache for proxy implementations, because it creates a combinatorial explosion of cache keys, even if the content is the same. Try to avoid it unless absolutely necessary.
+
 ## Contributing
 
 1. Fork it

data/async-http-cache.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 	
 	spec.add_dependency "async-http"
-	spec.add_dependency "protocol-http", "~> 0.14.2"
+	spec.add_dependency "protocol-http", "~> 0.14.4"
 	
 	spec.add_development_dependency "async-rspec", "~> 1.10"
 	

data/lib/async/http/cache/body.rb

@@ -37,7 +37,9 @@ module Async
 						
 						# Wrap the message with the callback:
 						::Protocol::HTTP::Body::Streamable.wrap(message) do |error|
-							unless error
+							if error
+								Async.logger.error(self) {error}
+							else
 								yield message, rewindable.buffered
 							end
 						end

data/lib/async/http/cache/general.rb

@@ -33,6 +33,7 @@ module Async
 				CACHE_CONTROL  = 'cache-control'
 				CONTENT_TYPE = 'content-type'
 				AUTHORIZATION = 'authorization'
+				COOKIE = 'cookie'
 				
 				def initialize(app, store: Store.default)
 					super(app)
@@ -40,12 +41,20 @@ module Async
 					@count = 0
 					
 					@store = store
-					@maximum_length = 128 * 1024
 				end
 				
 				attr :count
+				attr :store
+				
+				def close
+					@store.close
+				ensure
+					super
+				end
 				
 				def key(request)
+					@store.normalize(request)
+					
 					[request.authority, request.method, request.path]
 				end
 				
@@ -60,17 +69,21 @@ module Async
 						return false
 					end
 					
+					# We only support caching GET and HEAD requests:
+					unless request.method == 'GET' || request.method == 'HEAD'
+						return false
+					end
+					
 					if request.headers[AUTHORIZATION]
 						return false
 					end
 					
-					# We only support caching GET and HEAD requests:
-					if request.method == 'GET' || request.method == 'HEAD'
-						return true
+					if request.headers[COOKIE]
+						return false
 					end
 					
-					# Otherwise, we can't cache it:
-					return false
+					# Otherwise, we can cache it:
+					return true
 				end
 				
 				def wrap(key, request, response)
@@ -78,17 +91,8 @@ module Async
 						return response
 					end
 					
-					if body = response.body
-						if length = body.length
-							# Don't cache responses bigger than 128Kb:
-							return response if length > @maximum_length
-						else
-							# Don't cache responses without length:
-							return response
-						end
-					end
-					
 					return Body.wrap(response) do |message, body|
+						Async.logger.debug(self) {"Updating cache for #{key}..."}
 						@store.insert(key, request, Response.new(message, body))
 					end
 				end
@@ -110,7 +114,6 @@ module Async
 					
 					unless cache_control&.no_store?
 						if cacheable?(request)
-							Async.logger.debug(self) {"Updating cache for #{key}..."}
 							return wrap(key, request, super)
 						end
 					end

data/lib/async/http/cache/response.rb

@@ -47,19 +47,18 @@ module Async
 				attr :generated_at
 				
 				def cachable?
-					if set_cookie = @headers[SET_COOKIE]
-						return false
-					end
-					
 					if cache_control = @headers[CACHE_CONTROL]
-						if cache_control.private?
+						if cache_control.private? || !cache_control.public?
 							return false
 						end
-						
-						if cache_control.public?
-							return true
-						end
 					end
+					
+					if set_cookie = @headers[SET_COOKIE]
+						Async.logger.warn(self) {"Cannot cache response with set-cookie header!"}
+						return false
+					end
+					
+					return true
 				end
 				
 				def age

data/lib/async/http/cache/store/memory.rb

@@ -25,24 +25,82 @@ module Async
 		module Cache
 			module Store
 				class Memory
-					def initialize
+					def initialize(limit: 1024)
 						@index = {}
+						@limit = limit
+						
+						@hit = 0
+						@miss = 0
+						@pruned = 0
+						
+						@gardener = Async do |task|
+							while true
+								task.sleep(60)
+								
+								pruned = self.prune
+								@pruned += pruned
+								
+								Async.logger.debug(self) do |buffer|
+									if pruned > 0
+										buffer.puts "Pruned #{pruned} entries."
+									end
+									
+									buffer.puts "Hits: #{@hit} Misses: #{@miss} Pruned: #{@pruned} Ratio: #{(100.0*@hit/@miss).round(2)}%"
+									
+									body_usage = @index.sum{|key, value| value.body.length}
+									buffer.puts "Index size: #{@index.size} Memory usage: #{(body_usage / 1024.0**2).round(2)}MiB"
+									
+									# @index.each do |key, value|
+									# 	buffer.puts "#{key.join('-')}: #{value.body.length}B"
+									# end
+								end
+							end
+						end
 					end
 					
+					def close
+						@gardener.stop
+					end
+					
+					attr :index
+					
 					def lookup(key, request)
 						if response = @index[key]
 							if response.expired?
 								@index.delete(key)
 								
+								@pruned += 1
+								
 								return nil
 							end
 							
+							@hit += 1
+							
 							return response.dup
+						else
+							@miss += 1
+							
+							return nil
 						end
 					end
 					
 					def insert(key, request, response)
-						@index[key] = response
+						if @index.size < @limit
+							if response.body.length < 1024*64
+								@index[key] = response
+							end
+						end
+					end
+					
+					# @return [Integer] the number of pruned entries.
+					def prune
+						initial_count = @index.size
+						
+						@index.delete_if do |key, value|
+							value.expired?
+						end
+						
+						return initial_count - @index.size
 					end
 				end
 			end

data/lib/async/http/cache/store/vary.rb

@@ -25,28 +25,51 @@ module Async
 		module Cache
 			module Store
 				VARY = 'vary'
+				ACCEPT_ENCODING = 'accept-encoding'
 				
 				class Vary
-					def initialize(store, vary = {})
-						@store = store
+					def initialize(delegate, vary = {})
+						@delegate = delegate
 						@vary = vary
 					end
 					
+					def close
+						@delegate.close
+					end
+					
+					attr :delegate
+					
+					def normalize(request)
+						if accept_encoding = request.headers[ACCEPT_ENCODING]
+							if accept_encoding.include?("gzip")
+								request.headers.set(ACCEPT_ENCODING, "gzip")
+							else
+								request.headers.delete(ACCEPT_ENCODING)
+							end
+						end
+					end
+					
+					def key_for(headers, vary)
+						vary.map{|key| headers[key]}
+					end
+					
 					def lookup(key, request)
 						if vary = @vary[key]
 							# We should provide user-supported normalization here:
-							key = key + request.headers.extract(vary)
+							key = key + key_for(request.headers, vary)
 						end
 						
-						return @store.lookup(key, request)
+						return @delegate.lookup(key, request)
 					end
 					
 					def insert(key, request, response)
-						if vary = response.headers[VARY]
-							key = key + request.headers.extract(vary)
+						if vary = response.headers[VARY]&.sort
+							@vary[key] = vary
+							
+							key = key + key_for(request.headers, vary)
 						end
 						
-						@store.insert(key, request, response)
+						@delegate.insert(key, request, response)
 					end
 				end
 			end

data/lib/async/http/cache/version.rb

@@ -23,7 +23,7 @@
 module Async
 	module HTTP
 		module Cache
-			VERSION = "0.1.0"
+			VERSION = "0.1.1"
 		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-http-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.14.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.14.4
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Standard-compliant cache for async-http.