rack-brotli 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9664462a848cd456a905f8443b7da55ccd77cb195ab4de07c906565eda3cc233
-  data.tar.gz: 8eb1ef7457774d7df327f67b571abe0f4416497c1d1c27dbfabe31d79eb7dc41
+  metadata.gz: 0b74bec06cbe4c1bb630015f38590e272bffa0bf0ae35543625bff909872d920
+  data.tar.gz: a34a2637ad36992b49368ed62cfc1ffeb195588d2eec5fe04c542b624447e8ce
 SHA512:
-  metadata.gz: 75b8954ad9aac90190159ccbe97f2e25952d4c28f7ce408a49c1f5e013dff1db62cb051221c3a4c84a278626a71a7e1faea641da68ea13632e62ecc42f4a60e0
-  data.tar.gz: b6263aa03b94babf5490f40345e32a379594a54ce5749463b5d4a57140ef8476fe3bd0e03e8a3ebc90cfc0145b8cb22d915d65956d2b7f9260bd1284fe8ff977
+  metadata.gz: 677a662e25d59d451e7fd8477fa135febf135df5e9764282c2340df9c848a4c2e3579a7b7cb6de0ddde4cbeb2bda3478ff3f43377fc888db202f1bb6172f3c47
+  data.tar.gz: f5c9643048b9002d0aad3b35e76c6b783c46306c26ab9e34cac5a6a3b25c1d7a0793793303acdfbb474a6dbd96fe2d881eb9eee30cd96d72f218aa74a01e4bb9

data/README.md

@@ -1,4 +1,4 @@
-# Rack::Brotli [![Gem Version](https://badge.fury.io/rb/rack-brotli.svg)](https://badge.fury.io/rb/rack-brotli) [![Build Status](https://travis-ci.org/marcotc/rack-brotli.svg?branch=master)](https://travis-ci.org/marcotc/rack-brotli)
+# Rack::Brotli [![Gem Version](https://badge.fury.io/rb/rack-brotli.svg)](https://badge.fury.io/rb/rack-brotli) [![Build Status](https://github.com/marcotc/rack-brotli/actions/workflows/test.yml/badge.svg)](https://github.com/marcotc/rack-brotli/actions/workflows/test.yml)
 
 `Rack::Brotli` compresses `Rack` responses using [Google's Brotli](https://github.com/google/brotli) compression algorithm.
 
@@ -17,7 +17,10 @@ Requiring `'rack/brotli'` will autoload `Rack::Brotli` module. The following exa
 require 'rack'
 require 'rack/brotli'
 
-use Rack::Brotli
+use Rack::Brotli # Default compression quality is 5
+
+# You can also provide native Brotli compression options:
+# use Rack::Brotli, quality: 11
 
 run theapp
 ```
@@ -26,10 +29,10 @@ run theapp
 
 To run the entire test suite, run 
 
-    rake test
+    bundle exec rake test
 
 ### Links
 
-* rack-brotli on GitHub:: <http://github.com/marcotc/rack-brotli>
-* Rack:: <http://rack.rubyforge.org/>
-* Rack On GitHub:: <http://github.com/rack/rack>
+* rack-brotli: <http://github.com/marcotc/rack-brotli>
+* Brotli for Ruby: <https://github.com/miyucy/brotli>
+* Rack: <http://github.com/rack/rack>

data/lib/rack/brotli/deflater.rb

@@ -1,17 +1,13 @@
-require "brotli"
-require 'rack/utils'
+# frozen_string_literal: true
+
+require 'brotli'
+require "rack/utils"
+require 'rack/request'
+require 'rack/body_proxy'
 
 module Rack::Brotli
-  # This middleware enables compression of http responses.
-  #
-  # Currently supported compression algorithms:
-  #
-  #   * br
-  #
-  # The middleware automatically detects when compression is supported
-  # and allowed. For example no transformation is made when a cache
-  # directive of 'no-transform' is present, or when the response status
-  # code is one that doesn't allow an entity body.
+  # This middleware enables compression of http responses with the `br` encoding,
+  # when support is detected and allowed.
   class Deflater
     ##
     # Creates Rack::Brotli middleware.
@@ -21,81 +17,107 @@ module Rack::Brotli
     #           'if' - a lambda enabling / disabling deflation based on returned boolean value
     #                  e.g use Rack::Brotli, :if => lambda { |env, status, headers, body| body.map(&:bytesize).reduce(0, :+) > 512 }
     #           'include' - a list of content types that should be compressed
-    #           'deflater' - Brotli compression options
+    #           'deflater' - Brotli compression options Hash (see https://brotli.org/encode.html#a4d4 and https://github.com/miyucy/brotli/blob/ea0e058031177e5cc42e361f7d2702a951048a31/ext/brotli/brotli.c#L119-L180)
+    #              - 'mode'
+    #              - 'quality'
+    #              - 'lgwin'
+    #              - 'lgblock'
     def initialize(app, options = {})
       @app = app
 
       @condition = options[:if]
       @compressible_types = options[:include]
-      @deflater_options = { quality: 5 }.merge(options[:deflater] || {})
+      @deflater_options = { quality: 5 }.merge(options.fetch(:deflater, {}))
+      @sync = options.fetch(:sync, true)
     end
 
     def call(env)
-      status, headers, body = @app.call(env)
-      headers = Rack::Utils::HeaderHash.new(headers)
+      status, headers, body = response = @app.call(env)
 
       unless should_deflate?(env, status, headers, body)
-        return [status, headers, body]
+        return response
       end
 
       request = Rack::Request.new(env)
 
-      encoding = Rack::Utils.select_best_encoding(%w(br),
-                                            request.accept_encoding)
-
-      return [status, headers, body] unless encoding
+      encoding = Rack::Utils.select_best_encoding(%w(br identity), request.accept_encoding)
 
       # Set the Vary HTTP header.
-      vary = headers["Vary"].to_s.split(",").map(&:strip)
-      unless vary.include?("*") || vary.include?("Accept-Encoding")
-        headers["Vary"] = vary.push("Accept-Encoding").join(",")
+      vary = headers["vary"].to_s.split(",").map(&:strip)
+      unless vary.include?("*") || vary.any?{|v| v.downcase == 'accept-encoding'}
+        headers["vary"] = vary.push("Accept-Encoding").join(",")
       end
 
       case encoding
       when "br"
-        headers['Content-Encoding'] = "br"
+        headers['content-encoding'] = "br"
         headers.delete(Rack::CONTENT_LENGTH)
-        [status, headers, BrotliStream.new(body, @deflater_options)]
-      when nil
+        response[2] = BrotliStream.new(body, @sync, @deflater_options)
+        response
+      when "identity"
+        response
+      else
+        # Only possible encoding values here are 'br', 'identity', and nil
         message = "An acceptable encoding for the requested resource #{request.fullpath} could not be found."
         bp = Rack::BodyProxy.new([message]) { body.close if body.respond_to?(:close) }
-        [406, {Rack::CONTENT_TYPE => "text/plain", Rack::CONTENT_LENGTH => message.length.to_s}, bp]
+        [406, { Rack::CONTENT_TYPE => "text/plain", Rack::CONTENT_LENGTH => message.length.to_s }, bp]
       end
     end
 
+    # Body class used for encoded responses.
     class BrotliStream
-      include Rack::Utils
 
-      def initialize(body, options)
+      BUFFER_LENGTH = 128 * 1_024
+
+      def initialize(body, sync, br_options)
         @body = body
-        @options = options
+        @br_options = br_options
+        @sync = sync
       end
 
+      # Yield compressed strings to the given block.
       def each(&block)
         @writer = block
-        # Use String.new instead of '' to support environments with strings frozen by default.
-        buffer = String.new
-        @body.each { |part|
-          buffer << part
-        }
-        yield ::Brotli.deflate(buffer, @options)
+        br = Brotli::Writer.new(self, @br_options)
+        # @body.each is equivalent to @body.gets (slow)
+        if @body.is_a? ::File # XXX: Should probably be ::IO
+          while part = @body.read(BUFFER_LENGTH)
+            br.write(part)
+            br.flush if @sync
+          end
+        else
+          @body.each { |part|
+            # Skip empty strings, as they would result in no output,
+            # and flushing empty parts could raise an IO error.
+            next if part.empty?
+            br.write(part)
+            br.flush if @sync
+          }
+        end
       ensure
-        @writer = nil
+        br.finish
       end
 
+      # Call the block passed to #each with the compressed data.
+      def write(data)
+        @writer.call(data)
+      end
+
+      # Close the original body if possible.
       def close
         @body.close if @body.respond_to?(:close)
       end
     end
-    
+
     private
 
+    # Whether the body should be compressed.
     def should_deflate?(env, status, headers, body)
       # Skip compressing empty entity body responses and responses with
       # no-transform set.
-      if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status) ||
-          headers[Rack::CACHE_CONTROL].to_s =~ /\bno-transform\b/ ||
-         (headers['Content-Encoding'] && headers['Content-Encoding'] !~ /\bidentity\b/)
+      if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) ||
+        /\bno-transform\b/.match?(headers[Rack::CACHE_CONTROL].to_s) ||
+        headers['content-encoding']&.!~(/\bidentity\b/)
         return false
       end
 
@@ -105,6 +127,10 @@ module Rack::Brotli
       # Skip if @condition lambda is given and evaluates to false
       return false if @condition && !@condition.call(env, status, headers, body)
 
+      # No point in compressing empty body, also handles usage with
+      # Rack::Sendfile.
+      return false if headers[Rack::CONTENT_LENGTH] == '0'
+
       true
     end
   end

data/lib/rack/brotli/version.rb

@@ -2,7 +2,7 @@ module Rack
   module Brotli
     class Version
       def self.to_s
-        '1.2.0'
+        '2.0.0'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-brotli
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Marco Costa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -16,90 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: brotli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.3'
 description: Rack::Brotli enables Google's Brotli compression on HTTP responses
 email: marco@marcotc.com
 executables: []
@@ -138,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 2
 summary: Brotli compression for Rack responses