qeweney 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63226f0b1696e99fb7c6cb322420ddf08fa6b9a0abd3652a5867c9186e0dd5b2
-  data.tar.gz: abb173aa33639169d3341e553bcbc91a8595727fae03844daebc0cb82e51b881
+  metadata.gz: bfb8f3a7995ccb0d35e79ecb1cbc9f2556ee4bc5e0bc7d61d3f1278395ea47df
+  data.tar.gz: 04cf0bbb7ebe8a701ab7a7b4e912e461ffc744ece02a1b75ff791eba22036da6
 SHA512:
-  metadata.gz: 9d43894a867eaf901cb4cdecf0d907f9257ffcdf369dc89ad1528738f006c854d07bf9850e54fe2fef6e316576593fa8d829f13bc82b5a8ba700a2726daa861b
-  data.tar.gz: d5f6d8eb6b520200b0864defcf5ef16f53965de0bac7304ca0bdf685faadf3f7528b8fecf0ba9377a3338bffbd993b851eb9e76af22fdd5dd966d4348a5ee28b
+  metadata.gz: 4f2d77164b052af1cdae718a2c44ccb3c0313bcc73cc87b637b9a1ccabee6701fecd5b223020b4ca854e74d218fefc0101a6150a4e426a9b5c2f1e41a8d6a951
+  data.tar.gz: 0030e7024d6a42f0301ba515e49f1e8da52e3b65368b515d81b520396a187dc0adf8107b32b8f0d08eb0f62d0e3c6f2f9e34f617a69444211b01b4971d950ed2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4 2021-02-12
+
+- Implement caching and compression for serving static files
+
 ## 0.3 2021-02-12
 
 - Implement `Request#serve_io`, `Request#serve_file`, `Request#redirect`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qeweney (0.3)
+    qeweney (0.4)
       escape_utils (~> 1.2.1)
 
 GEM

data/TODO.md

@@ -32,3 +32,68 @@
         end
       end
     ```
+
+## Caching
+
+```ruby
+req.route do
+  req.on 'assets' do
+    # setting cache to true implies the following:
+    # - etag (calculated from file stat)
+    # - last-modified (from file stat)
+    # - vary: Accept-Encoding
+
+    # before responding, looks at the following headers
+    # if-modified-since: (date from client's cache)
+    # if-none-match: (etag from client's cache)
+    # cache-control: no-cache will prevent caching
+    req.serve_file(path, base_path: STATIC_PATH, cache: true)
+
+    # We can control this manually instead:
+    req.serve_file(path, base_path: STATIC_PATH, cache: {
+      etag: 'blahblah',
+      last_modified: Time.now - 365*86400,
+      vary: 'Accept-Encoding, User-Agent'
+    })
+  end
+end
+```
+
+So, the algorithm:
+
+```ruby
+def validate_client_cache(path)
+  return false if headers['cache-control'] == 'no-cache'
+  
+  stat = File.stat(path)
+  etag = file_stat_to_etag(path, stat)
+  return false if headers['if-none-match'] != etag
+
+  modified = file_stat_to_modified_stamp(stat)
+  return false if headers['if-modified-since'] != modified
+
+  true
+end
+
+def file_stat_to_etag(path, stat)
+  "#{stat.mtime.to_i.to_s(36)}#{stat.size.to_s(36)}"
+end
+
+require 'time'
+
+def file_stat_to_modified_stamp(stat)
+  stat.mtime.httpdate
+end
+```
+
+## response compression
+
+```ruby
+req.route do
+  req.on 'assets' do
+    # gzip on the fly
+    req.serve_file(path, base_path: STATIC_PATH, gzip: :gzip)
+  end
+end
+
+```

data/lib/qeweney/request_info.rb

@@ -61,6 +61,15 @@ module Qeweney
     def forwarded_for
       @headers['x-forwarded-for']
     end
+
+    # TODO: should return encodings in client's order of preference (and take
+    # into account q weights)
+    def accept_encoding
+      encoding = @headers['accept-encoding']
+      return [] unless encoding
+
+      encoding.split(',').map { |i| i.strip }
+    end
   end
 
   module RequestInfoClassMethods

data/lib/qeweney/response.rb

@@ -1,21 +1,78 @@
 # frozen_string_literal: true
 
+require 'time'
+require 'zlib'
+require 'stringio'
+
 require_relative 'status'
 
 module Qeweney
+  module StaticFileCaching
+    class << self
+      def file_stat_to_etag(stat)
+        "#{stat.mtime.to_i.to_s(36)}#{stat.size.to_s(36)}"
+      end
+      
+      def file_stat_to_last_modified(stat)
+        stat.mtime.httpdate
+      end
+    end
+  end
+
   module ResponseMethods
     def redirect(url, status = Status::FOUND)
       respond(nil, ':status' => status, 'Location' => url)
     end
 
     def serve_file(path, opts)
-      File.open(file_full_path(path, opts), 'r') do |f|
-        serve_io(f, opts)
+      full_path = file_full_path(path, opts)
+      stat = File.stat(full_path)
+      etag = StaticFileCaching.file_stat_to_etag(stat)
+      last_modified = StaticFileCaching.file_stat_to_last_modified(stat)
+
+      if validate_static_file_cache(etag, last_modified)
+        return respond(nil, {
+          ':status' => Status::NOT_MODIFIED,
+          'etag' => etag
+        })
       end
-    rescue Errno::ENOENT
+
+      respond_with_static_file(full_path, etag, last_modified, opts)
+    rescue Errno::ENOENT => e
       respond(nil, ':status' => Status::NOT_FOUND)
     end
 
+    def respond_with_static_file(path, etag, last_modified, opts)
+      File.open(path, 'r') do |f|
+        opts = opts.merge(headers: {
+          'etag' => etag,
+          'last-modified' => last_modified,
+        })
+
+        # accept_encoding should return encodings in client's order of preference
+        accept_encoding.each do |encoding|
+          case encoding
+          when 'deflate'
+            return serve_io_deflate(f, opts)
+          when 'gzip'
+            return serve_io_gzip(f, opts)
+          end
+        end
+        serve_io(f, opts)
+      end
+    end
+
+    def validate_static_file_cache(etag, last_modified)
+      if (none_match = headers['if-none-match'])
+        return true if none_match == etag
+      end
+      if (modified_since = headers['if-modified-since'])
+        return true if modified_since == last_modified
+      end
+    
+      false
+    end
+
     def file_full_path(path, opts)
       if (base_path = opts[:base_path])
         File.join(opts[:base_path], path)
@@ -25,7 +82,30 @@ module Qeweney
     end
 
     def serve_io(io, opts)
-      respond(io.read)
+      respond(io.read, opts[:headers] || {})
+    end
+
+    def serve_io_deflate(io, opts)
+      deflate = Zlib::Deflate.new
+      headers = opts[:headers].merge(
+        'content-encoding' => 'deflate',
+        'vary' => 'Accept-Encoding'
+      )
+
+      respond(deflate.deflate(io.read, Zlib::FINISH), headers)
+    end
+
+    def serve_io_gzip(io, opts)
+      buf = StringIO.new
+      z = Zlib::GzipWriter.new(buf)
+      z << io.read
+      z.flush
+      z.close
+      headers = opts[:headers].merge(
+        'content-encoding' => 'gzip',
+        'vary' => 'Accept-Encoding'
+      )
+      respond(buf.string, headers)
     end
   end
 end

data/lib/qeweney/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Qeweney
-  VERSION = '0.3'
+  VERSION = '0.4'
 end

data/test/helper.rb

@@ -11,8 +11,26 @@ require 'minitest/autorun'
 require 'minitest/reporters'
 
 module Qeweney
-  def self.mock(headers)
-    Request.new(headers, nil)
+  class MockAdapter
+    attr_reader :calls
+
+    def initialize
+      @calls = []
+    end
+
+    def method_missing(sym, *args)
+      calls << [sym, *args]
+    end
+  end
+
+  def self.mock(headers = {})
+    Request.new(headers, MockAdapter.new)
+  end
+
+  class Request
+    def response_calls
+      adapter.calls
+    end
   end
 end
 

data/test/test_response.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+class RedirectTest < MiniTest::Test
+  def test_redirect
+    r = Qeweney.mock
+    r.redirect('/foo')
+
+    assert_equal [
+      [:respond, nil, {":status"=>302, "Location"=>"/foo"}]
+    ], r.response_calls
+  end
+
+  def test_redirect_wirth_status
+    r = Qeweney.mock
+    r.redirect('/bar', Qeweney::Status::MOVED_PERMANENTLY)
+
+    assert_equal [
+      [:respond, nil, {":status"=>301, "Location"=>"/bar"}]
+    ], r.response_calls
+  end
+end
+
+class StaticFileResponeTest < MiniTest::Test
+  def setup
+    @path = File.join(__dir__, 'helper.rb')
+    @stat = File.stat(@path)
+
+    @etag = Qeweney::StaticFileCaching.file_stat_to_etag(@stat)
+    @last_modified = Qeweney::StaticFileCaching.file_stat_to_last_modified(@stat)
+    @content = IO.read(@path)
+  end
+
+  def test_serve_file
+    r = Qeweney.mock
+    r.serve_file('helper.rb', base_path: __dir__)
+
+    assert_equal [
+      [:respond, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
+    ], r.response_calls
+  end
+
+  def test_serve_file_with_cache_headers
+    r = Qeweney.mock('if-none-match' => @etag)
+    r.serve_file('helper.rb', base_path: __dir__)
+    assert_equal [
+      [:respond, nil, { 'etag' => @etag, ':status' => Qeweney::Status::NOT_MODIFIED }]
+    ], r.response_calls
+
+    r = Qeweney.mock('if-modified-since' => @last_modified)
+    r.serve_file('helper.rb', base_path: __dir__)
+    assert_equal [
+      [:respond, nil, { 'etag' => @etag, ':status' => Qeweney::Status::NOT_MODIFIED }]
+    ], r.response_calls
+
+    r = Qeweney.mock('if-none-match' => 'foobar')
+    r.serve_file('helper.rb', base_path: __dir__)
+    assert_equal [
+      [:respond, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
+    ], r.response_calls
+
+    r = Qeweney.mock('if-modified-since' => Time.now.httpdate)
+    r.serve_file('helper.rb', base_path: __dir__)
+    assert_equal [
+      [:respond, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
+    ], r.response_calls
+  end
+
+  def test_serve_file_deflate
+    r = Qeweney.mock('accept-encoding' => 'deflate')
+    r.serve_file('helper.rb', base_path: __dir__)
+
+    deflate = Zlib::Deflate.new
+    deflated_content = deflate.deflate(@content, Zlib::FINISH)
+    
+    assert_equal [
+      [:respond, deflated_content, {
+        'etag' => @etag,
+        'last-modified' => @last_modified,
+        'vary' => 'Accept-Encoding',
+        'content-encoding' => 'deflate'
+      }]
+    ], r.response_calls
+  end
+
+  def test_serve_file_gzip
+    r = Qeweney.mock('accept-encoding' => 'gzip')
+    r.serve_file('helper.rb', base_path: __dir__)
+
+    buf = StringIO.new
+    z = Zlib::GzipWriter.new(buf)
+    z << @content
+    z.flush
+    z.close
+    gzipped_content = buf.string
+    
+    assert_equal [
+      [:respond, gzipped_content, {
+        'etag' => @etag,
+        'last-modified' => @last_modified,
+        'vary' => 'Accept-Encoding',
+        'content-encoding' => 'gzip'
+      }]
+    ], r.response_calls
+  end
+
+  def test_serve_file_non_existent
+    r = Qeweney.mock
+    r.serve_file('foo.rb', base_path: __dir__)
+    assert_equal [
+      [:respond, nil, { ':status' => Qeweney::Status::NOT_FOUND }]
+    ], r.response_calls
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qeweney
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -93,7 +93,8 @@ files:
 - qeweney.gemspec
 - test/helper.rb
 - test/run.rb
-- test/test_request.rb
+- test/test_request_info.rb
+- test/test_response.rb
 homepage: http://github.com/digital-fabric/qeweney
 licenses:
 - MIT