WezTerm SSH连接WSL2时的键盘输入问题解析

问题现象

在使用WezTerm的SSH功能连接WSL2时，用户遇到了键盘输入异常的问题。具体表现为：

1. 数字键1、2、3等无法正常输入，而是输出类似";2;49~"的转义序列
2. 组合键如Ctrl+C也无法正常工作，输出"5;99~"等异常序列
3. 问题仅在通过wezterm ssh连接时出现，直接使用WezTerm启动终端则正常

技术分析

键盘编码机制

WezTerm在处理键盘输入时，会使用多种编码方式将物理按键转换为终端可识别的序列。其中modifyOtherKeys模式是一种特殊的编码方式，它通过转义序列来精确描述修饰键(如Shift、Ctrl等)与普通键的组合。

当终端启用了modifyOtherKeys模式后，WezTerm会发送类似\u{1b}[27;2;49~的序列来表示Shift+1组合键。正常情况下，终端应用(如shell)应该能够正确解析这些序列。

问题根源

经过深入排查，发现问题源于一个名为"termium"的第三方工具(Codeium的组件)。该工具在shell启动时自动加载，并开启了modifyOtherKeys模式，但未能正确关闭此模式，导致后续所有键盘输入都被错误编码。

解决方案

1. 临时解决方法：

   • 在WezTerm中按Ctrl+Shift+P打开命令面板
   • 选择"Reset the terminal emulation state in the current pane"选项
   • 这将重置终端模拟状态，但可能只是临时解决方案

2. 根本解决方法：

   • 检查并禁用自动加载termium的配置
   • 修改shell启动文件(.zshrc/.bashrc等)，移除termium的自动加载
   • 或者联系termium开发者修复该问题

深入理解

WezTerm的键盘处理流程

1. 硬件键盘事件被Windows系统捕获
2. WezTerm接收并处理这些事件
3. 根据当前终端状态决定编码方式
4. 发送相应的转义序列到终端应用

诊断工具

WezTerm提供了强大的诊断工具：

• debug_keys_event：详细记录键盘事件处理过程
• wezterm record：记录终端会话的所有输入输出
• wezterm replay --explain-only：解析记录的转义序列

最佳实践建议

1. 当遇到终端输入问题时，首先尝试最小化环境(如使用空配置启动shell)
2. 逐步添加组件/配置，定位问题来源
3. 善用WezTerm的诊断工具分析问题
4. 对于第三方工具，注意其可能对终端状态的修改

总结

终端键盘输入问题往往源于终端状态被意外修改或编码方式不匹配。通过系统性的排查和使用适当的诊断工具，可以有效定位和解决这类问题。WezTerm提供了丰富的功能来帮助用户诊断和解决终端使用中的各种问题。