Metals项目调试环境变量传递问题分析与解决

问题背景

在Scala开发环境中，Metals作为语言服务器提供了强大的调试功能。然而，近期发现一个关键问题：当开发者尝试通过调试模式运行测试用例时，预先配置的环境变量无法正确传递给测试进程。这一现象在常规程序运行调试时表现正常，但在测试调试场景下却出现了环境变量丢失的情况。

问题现象

开发者在使用Neovim配合Metals进行调试时，配置了如下调试参数：

dap.configurations.scala = {
  {
    type = 'scala',
    request = 'launch',
    name = 'RunOrTest',
    metals = {
      runType = 'runOrTestFile',
      env = { FOO = 'BAR' },
    },
  }
}

当调试普通Scala主类时，环境变量FOO能够被正确读取；但当调试测试套件时，系统抛出java.util.NoSuchElementException: FOO异常，表明环境变量未能成功传递。

技术分析

通过深入分析Metals源码和BSP协议交互日志，发现问题根源在于调试请求的数据类型选择不当。在调试普通程序时，Metals使用了scala-main-class数据类型，其中包含了完整的配置信息：

{
  "dataKind": "scala-main-class",
  "data": {
    "environmentVariables": ["FOO=BAR"]
  }
}

而在调试测试时，却使用了简化的scala-test-suites数据类型：

{
  "dataKind": "scala-test-suites",
  "data": ["MySuite"]
}

这种差异导致环境变量等调试配置信息在测试调试场景下丢失。正确的做法应该是使用scala-test-suites-selection数据类型，该类型支持包含更多调试参数。

解决方案

问题的修复需要修改DebugDiscovery.scala文件中的相关逻辑，将测试调试请求的数据类型从SCALA_TEST_SUITES变更为SCALA_TEST_SUITES_SELECTION。后者提供了完整的参数配置能力，包括环境变量的传递。

修改后的实现应当确保：

1. 保留原有的测试类选择功能
2. 正确传递所有调试配置参数
3. 保持与BSP协议的兼容性

验证方法

为了验证修复效果，可以在DebugDiscoverySuite测试类中添加专门的测试用例，检查：

• 环境变量是否被正确包含在调试请求中
• 测试选择功能是否仍然正常工作
• 各种调试参数是否能被正确处理

总结

这个问题的解决不仅修复了环境变量传递的功能缺陷，更重要的是完善了Metals测试调试功能的完整性。对于Scala开发者而言，这意味着能够在测试调试场景下使用与普通调试一致的环境配置能力，大大提升了开发体验的一致性。

该修复已被合并到Metals主分支，将在后续版本中发布。开发者可以关注Metals的更新日志，及时获取包含此修复的版本。