OmniSharp调试器中的stackTrace请求参数问题解析

问题背景

在OmniSharp调试器的使用过程中，开发者发现通过customRequest方法请求堆栈跟踪信息时会出现格式错误。具体表现为当调用debug.activeDebugSession.customRequest('stackTrace')时，系统会抛出"CodeExpectedError"异常，提示"堆栈跟踪消息格式不正确"。

问题分析

根据调试适配器协议(DAP)的规范，stackTrace请求中的startFrame参数是可选的，当省略时默认从0开始返回帧。然而在OmniSharp调试器的实际实现中，却强制要求必须提供startFrame参数，这与协议规范存在不一致。

解决方案

目前可以通过显式指定startFrame参数为0来解决这个问题：

const stack = await debug.activeDebugSession?.customRequest('stackTrace', { 
  threadId: debug.activeStackItem?.threadId ?? 1,
  startFrame: 0 
});

技术细节

这个问题源于OmniSharp调试器的实现历史。在早期版本中，由于VS Code总是会提供startFrame参数，调试器代码就没有处理参数缺失的情况。后来虽然增加了customRequestAPI，但这一限制条件未被移除，导致了与DAP规范的不兼容。

影响范围

该问题主要影响以下场景：

1. 开发者通过扩展API直接调用stackTrace请求
2. 未显式指定startFrame参数的情况
3. 使用较新版本的VS Code进行调试

最佳实践

虽然这个问题会在后续版本中修复，但目前建议开发者：

1. 在使用customRequest调用stackTrace时始终提供startFrame参数
2. 对返回值进行适当的错误处理
3. 关注OmniSharp的更新日志，及时获取修复信息

总结

这个案例展示了协议规范与实际实现之间可能存在的差异。作为开发者，在遇到类似问题时，除了查阅官方文档外，还应该了解特定实现的细节和历史背景，这样才能找到最有效的解决方案。同时，这也提醒我们在设计API时要充分考虑向前兼容性和协议遵循性。