File: 4.0-Upgrade.md

package info (click to toggle)
ruby-dalli 5.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 992 kB
  • sloc: ruby: 9,447; sh: 19; makefile: 4
file content (44 lines) | stat: -rw-r--r-- 2,056 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Dalli 4.0

This major version update contains several backwards incompatible changes.

## Breaking Changes

* **Ruby 3.1+ required** - Support for Ruby 2.6, 2.7, and 3.0 has been dropped.
* **Dalli::Server removed** - The deprecated `Dalli::Server` alias has been removed. Use `Dalli::Protocol::Binary` instead if you were referencing this directly.
* **:compression option removed** - Use `:compress` instead. The old option name was deprecated in 3.x.
* **close_on_fork removed** - Use `reconnect_on_fork` instead. The old method name was deprecated in 3.x.

## New Features

* **Security warning for Marshal** - Dalli now warns when using the default Marshal serializer, as deserializing untrusted data with Marshal can lead to remote code execution. Silence with `silence_marshal_warning: true` if you understand the risks, or switch to a safer serializer like JSON.
* **string_fastpath option** - New option to skip serialization for simple strings, improving performance for string-only workloads.
* **Meta protocol improvements** - Performance improvements for set operations when using the meta protocol.

## Other Changes

* Defense-in-depth input validation for stats command arguments
* Fix connection_pool 3.0 compatibility for Rack session store
* Fix session recovery after deletion
* Graceful reconnection when a fork is detected (instead of crashing)
* Support for SERVER_ERROR response from Memcached

## Migration Guide

1. **Update Ruby version** - Ensure you're running Ruby 3.1 or later.

2. **Update deprecated options** - If you use any of these, update them:
   ```ruby
   # Before
   Dalli::Client.new(servers, compression: true)

   # After
   Dalli::Client.new(servers, compress: true)
   ```

3. **Consider serializer security** - If you're caching user-controlled data, consider switching from Marshal to a safer serializer:
   ```ruby
   Dalli::Client.new(servers, serializer: JSON)
   ```

4. **Update Dalli::Server references** - If you referenced `Dalli::Server` directly (unlikely), update to `Dalli::Protocol::Binary`.