Ruby LSP 项目中的类继承线性化问题解析

问题背景

在 Ruby LSP 项目中，开发者发现了一个关于类继承线性化的有趣问题。当在测试辅助文件中重新打开 Rails 的核心测试类（如 ActionDispatch::IntegrationTest）时，会导致测试代码镜片（Code Lens）功能失效，测试也无法在测试资源管理器中正确显示。

技术细节

这个问题源于 Ruby LSP 的索引器在处理类重新打开时的行为。具体来说，当开发者按照 Rails 官方文档的建议，在 test/test_helper.rb 文件中重新打开测试基类并添加自定义辅助方法时：

class ActionDispatch::IntegrationTest
  include Devise::Test::IntegrationHelpers
  
  # 自定义辅助方法
  def some_helper_method
    # ...
  end
end

Ruby LSP 的索引器会创建两个类条目：

1. 原始定义：继承自 ActiveSupport::TestCase
2. 重新打开的版本：默认继承自 Object

在计算类继承线性化时，索引器错误地选择了重新打开版本的继承信息（Object），而忽略了原始定义的继承关系（ActiveSupport::TestCase），导致测试框架无法正确识别这些测试类。

影响范围

这个问题主要影响以下场景：

• 使用 Rails 测试框架的项目
• 在测试辅助文件中重新打开测试基类
• 使用 Ruby LSP 的测试发现和代码镜片功能

受影响的主要测试基类包括：

• ActionDispatch::IntegrationTest
• ActiveSupport::TestCase
• ApplicationSystemTestCase

临时解决方案

在问题修复前，开发者可以采用以下临时解决方案：

1. 关闭 Ruby LSP 的完整测试发现功能：

{
  "rubyLsp.featureFlags": {
    "fullTestDiscovery": false
  }
}

2. 避免在测试辅助文件中重新打开测试基类（不推荐，因为这违背了 Rails 的最佳实践）

技术原理深入

Ruby LSP 的索引器在处理类定义时，会收集所有同名的类条目。在计算继承关系时，它原本的逻辑是：

1. 查找所有同名的类定义
2. 选择第一个找到的具有父类定义的条目
3. 基于该父类计算线性化继承链

问题在于，当类被重新打开时：

• 原始定义（在 Rails 源码中）有明确的父类
• 重新打开的版本（在测试辅助文件中）没有显式指定父类，默认为 Object
• 索引器错误地选择了重新打开版本的继承信息

修复方案

Shopify 团队已经通过 PR 修复了这个问题，主要改进包括：

1. 修改索引器逻辑，正确处理重新打开的类定义
2. 确保优先考虑原始定义的继承关系
3. 完善继承线性化的计算算法

最佳实践建议

即使问题已经修复，开发者在使用 Ruby LSP 时仍应注意：

1. 遵循 Rails 官方文档的测试辅助方法添加方式
2. 保持 Ruby LSP 插件和服务器版本更新
3. 复杂的类重新打开场景可能需要额外的索引配置
4. 遇到类似问题时，可以使用 Ruby LSP 提供的调试脚本验证索引结果

总结

这个问题展示了 Ruby 元编程与工具链交互时可能出现的微妙问题。Ruby LSP 作为现代 Ruby 开发的重要工具，其索引器的准确性直接影响开发体验。通过理解这类问题的本质，开发者可以更好地利用 Ruby 的动态特性，同时避免与工具链的潜在冲突。