Sidekiq 7.3.0+ 在 Ruby 2.7 下的字符串冻结问题解析

问题背景

在 Sidekiq 7.3.0 及以上版本中，当与 sidekiq-scheduler 一起在 Ruby 2.7 环境下运行时，会出现一个关于字符串冻结的有趣问题。具体表现为在渲染 ERB 模板时抛出 FrozenError: can't modify frozen String: "<link" 异常。

技术细节分析

这个问题的根源在于 Ruby 2.7 对字符串插值行为的特殊处理。在 Ruby 2.7 中，当使用字符串插值时，生成的字符串会继承源文件的魔法注释（magic comment）中指定的冻结状态。这与 Ruby 3.0 及更高版本的行为不同。

在 Sidekiq 的 Web 帮助程序中，有以下关键代码：

def html_tag(tagname, attrs = {})
  s = "<#{tagname}"
  attrs.each_pair { |k, v| s << %( #{k}="#{v}") }
  s << ">"
end

当这段代码在 Ruby 2.7 下运行时，字符串插值 "<#{tagname}" 生成的字符串会被自动冻结，导致后续的 << 操作失败。

解决方案演进

Sidekiq 社区针对这个问题提出了几种解决方案：

1. 最低版本限制方案：将最低要求的 Ruby 版本提升至 3.0，从根本上避免这个问题。但这对仍在使用 Ruby 2.7 的用户不友好。

2. 字符串解冻方案：通过添加 + 操作符显式解冻字符串：

   s = +"<#{tagname}" # 显式创建可变字符串
   

最终，Sidekiq 采用了第二种方案，因为它既能解决问题，又能保持对 Ruby 2.7 的兼容性。同时添加了清晰的注释，说明这个修改是为了 Ruby 2.7 的兼容性，未来可以移除。

技术启示

这个案例给我们几个重要的技术启示：

1. 版本兼容性：Ruby 2.7 和 3.0 在字符串处理上有细微但重要的行为差异，开发跨版本兼容的库时需要特别注意。

2. 防御性编程：对于可能被修改的字符串，显式地确保其可变性是一种好的实践。

3. 代码可维护性：添加清晰的注释说明兼容性补丁的用途和未来清理计划，有助于后续维护。

最佳实践建议

对于类似的字符串操作场景，建议：

1. 如果确定字符串需要被修改，使用 String.new 或 +"" 显式创建可变字符串
2. 在支持多版本 Ruby 的库中，对字符串操作进行充分测试
3. 对于临时性的兼容代码，添加清晰的注释说明其目的和移除条件

这个问题虽然看似简单，但它揭示了 Ruby 版本间细微行为差异可能带来的影响，也展示了开源社区如何协作解决这类兼容性问题。