dalli 5.3.1 → 5.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf53cb1683b72cd89df9074f442a040de892003a6f39254e4958654a9f430a7
-  data.tar.gz: 46b400e8a5cb63261af72340de184bf7f1188a7b5fc2454a052af13e8ff62167
+  metadata.gz: 01e6a1f1483a28b5913847f35280e7c4cf2f490f01ddda3607ba1cf7687e3081
+  data.tar.gz: 0a4c8e31094f2d0fabc9a17062765d7e5293ec29ed338fabca6c93076d4ea224
 SHA512:
-  metadata.gz: 518451bbab10db4e47140cd9b716c1845ca1b1be08f95e5e5996d4f6dc655f7a9bfd2a40e51c968cdaa45eaa3355518d41a0e7c36a37367d2c387bc9dcb18bed
-  data.tar.gz: 84c9fa710a82fb7f444f50b84820e43c7697050fd70376117d6d9daa30f905d159bd1639e29762c027391b8521361888075b47df476f6cfb59ddcb0e76496f78
+  metadata.gz: 1fa29fe92cc42e648f5752c79a185466e24614283d0ebed7f8a12a5b3ab2f98806065c1989c403144b10809ad33baaa4033c66f140e80500c4ecb9c3a6b6a41b
+  data.tar.gz: be9a46942962a98dc2d14d9058f48c0b78c22c245b447e7578b030aa941e286a67941516e0d8a9d377167fd9fcbb3960865c3c118e2f3e8ba88ba1aece683914

data/CHANGELOG.md

@@ -4,6 +4,13 @@ Dalli Changelog
 Unreleased
 ==========
 
+5.3.2
+==========
+
+Bug fixes:
+
+- A signal arriving while `Dalli::Compressor` or `Dalli::GzipCompressor` was compressing or decompressing could make Ruby's zlib return before it had finished (ruby/zlib#49). Depending on the Ruby and zlib gem versions, that raised `Zlib::BufError` or `Zlib::DataError`, or stored a truncated value that later failed to decompress. Both compressors now keep finishing the stream until zlib reports its end. `GzipCompressor` no longer goes through `GzipWriter` and `GzipReader`, so it now always returns decompressed values as binary strings, as `Compressor` does (#1299)
+
 5.3.1
 ==========
 

data/lib/dalli/compressor.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'zlib'
-require 'stringio'
 
 module Dalli
   ##
@@ -10,7 +9,7 @@ module Dalli
   ##
   class Compressor
     def self.compress(data)
-      Zlib::Deflate.deflate(data)
+      deflate_fully(Zlib::Deflate.new, data)
     end
 
     # DEFLATE can't expand data by more than about 1032:1
@@ -24,11 +23,51 @@ module Dalli
     # as the output passes it, so a small compressed value can't expand into
     # gigabytes of memory.
     def self.decompress(data, max_bytes: nil)
-      return Zlib::Inflate.inflate(data) unless may_exceed?(data, max_bytes)
+      return inflate_fully(Zlib::Inflate.new, data) unless may_exceed?(data, max_bytes)
 
       inflate_within_limit(Zlib::Inflate.new, data, max_bytes)
     end
 
+    # Ruby's zlib extension can return from a call before zlib has finished
+    # when a signal interrupts it (ruby/zlib#49). One-shot calls like
+    # Zlib::Deflate.deflate then raise or, with zlib 3.2.4, return truncated
+    # output, so these call finish until the stream has ended.
+    def self.deflate_fully(deflater, data)
+      finish_stream(deflater, deflater.deflate(data, Zlib::FINISH))
+    ensure
+      deflater.close
+    end
+
+    def self.inflate_fully(inflater, data)
+      finish_stream(inflater, feed(inflater, data) || String.new(encoding: Encoding::BINARY))
+    ensure
+      inflater.close
+    end
+
+    # zlib gem 3.2.3 and earlier retry an interrupted inflate even when it has
+    # used up its input, and raise the Z_BUF_ERROR zlib returns for that. The
+    # output so far stays in the stream, and finish raises for input that is
+    # truly truncated.
+    def self.feed(inflater, data, &)
+      inflater.inflate(data, &)
+    rescue Zlib::BufError
+      nil
+    end
+
+    def self.finish_stream(stream, out)
+      out << next_chunk(stream) until stream.finished?
+      out
+    end
+
+    # Each finish makes progress, so one that returns nothing means the
+    # stream can't end: the compressed input is truncated
+    def self.next_chunk(stream)
+      chunk = stream.finish
+      raise Zlib::BufError, 'buffer error' if chunk.empty?
+
+      chunk
+    end
+
     # False when even the largest possible expansion stays within max_bytes,
     # so the value can be inflated in one step
     def self.may_exceed?(data, max_bytes)
@@ -43,16 +82,15 @@ module Dalli
         # with Zlib::Inflate.inflate; finish would return it as output
         break if inflater.finished?
       end
-      return out if inflater.finished?
-
-      append_within_limit(out, inflater.finish, max_bytes)
+      append_within_limit(out, next_chunk(inflater), max_bytes) until inflater.finished?
+      out
     ensure
       inflater.close
     end
 
     # Both yielded and returned output count toward the limit
     def self.inflate_slice(inflater, slice, out, max_bytes)
-      rest = inflater.inflate(slice) { |chunk| append_within_limit(out, chunk, max_bytes) }
+      rest = feed(inflater, slice) { |chunk| append_within_limit(out, chunk, max_bytes) }
       append_within_limit(out, rest, max_bytes)
     end
 
@@ -70,19 +108,18 @@ module Dalli
   # entry.
   ##
   class GzipCompressor
+    # MAX_WBITS + 16 makes zlib write and read the gzip format (and check its CRC)
+    WINDOW_BITS = Zlib::MAX_WBITS + 16
+
     def self.compress(data)
-      io = StringIO.new(+'', 'w')
-      gz = Zlib::GzipWriter.new(io)
-      gz.write(data)
-      gz.close
-      io.string
+      Compressor.deflate_fully(Zlib::Deflate.new(Zlib::DEFAULT_COMPRESSION, WINDOW_BITS), data)
     end
 
     def self.decompress(data, max_bytes: nil)
-      return Zlib::GzipReader.new(StringIO.new(data, 'rb')).read unless Compressor.may_exceed?(data, max_bytes)
+      inflater = Zlib::Inflate.new(WINDOW_BITS)
+      return Compressor.inflate_fully(inflater, data) unless Compressor.may_exceed?(data, max_bytes)
 
-      # MAX_WBITS + 16 makes zlib read the gzip format (and check its CRC)
-      Compressor.inflate_within_limit(Zlib::Inflate.new(Zlib::MAX_WBITS + 16), data, max_bytes)
+      Compressor.inflate_within_limit(inflater, data, max_bytes)
     end
   end
 end

data/lib/dalli/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Dalli
-  VERSION = '5.3.1'
+  VERSION = '5.3.2'
 
   MIN_SUPPORTED_MEMCACHED_VERSION = '1.6.27'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.3.2
 platform: ruby
 authors:
 - Peter M. Goldstein
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.23
+rubygems_version: 4.0.24
 specification_version: 4
 summary: High performance memcached client for Ruby
 test_files: []