VS Code中preLaunchTask执行后调试会话无法启动问题排查

问题描述 #

配置VSCode的launch.json和tasks.json用于远程调试Django/Celery，启动调试时make up-debug（实际运行docker-compose）能正常执行并输出类似celery is redy的内容，但调试会话始终无法启动，怀疑是输出文本匹配失败。

配置文件内容 #

launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Djangp: Remote Attach",
      "type": "python",
      "request": "attach",
      "preLaunchTask": "up-debug",
      "connect": {
        "host": "127.0.0.1",
        "port": 5678
      },
      "django": true,
      "justMyCode": false,
    },
]

tasks.json

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "up-debug",
      "type": "shell",
      "command": "make up-debug",
      // "isBackground": true,
      "problemMatcher": {
        "owner": "custom",
        "severity": "warning",
        "pattern": {
          "regexp": "^\\s*(\\S+).+(celery@\\S+).+(ready)\\s*$",
          "message": 0,
        }
      }
    }
  ]
}

问题分析与解决 #

1. 正则表达式与实际输出不匹配 #

你的正则^\\s*(\\S+).+(celery@\\S+).+(ready)\\s*$包含celery@\\S+，但实际输出是celery is redy，没有@符号，完全匹配不上。另外输出里的redy是拼写错误，需改成ready，否则即使正则修正也会匹配失败。

建议将正则修改为适配实际输出的格式，比如：

^\\s*celery is ready\\s*$

2. 未启用后台任务模式 #

make up-debug运行docker-compose是启动后台服务，任务不会自动结束，必须设置"isBackground": true，否则VSCode会一直等待任务完成，不会启动调试。

3. 后台任务需配置就绪匹配规则 #

对于后台任务，problemMatcher需要明确任务启动完成的标志，需添加background字段，指定任务开始和就绪的匹配规则。

修正后的tasks.json示例 #

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "up-debug",
      "type": "shell",
      "command": "make up-debug",
      "isBackground": true,
      "problemMatcher": {
        "owner": "custom",
        "severity": "warning",
        "background": {
          "activeOnStart": true,
          "beginsPattern": "^.*Starting.*$", // 匹配服务启动的初始输出
          "endsPattern": "^\\s*celery is ready\\s*$" // 匹配Celery就绪的标志输出
        },
        "pattern": {
          "regexp": "^\\s*celery is ready\\s*$",
          "message": 0
        }
      }
    }
  ]
}

4. launch.json的拼写错误 #

"name": "Djangp: Remote Attach"里的Djangp是拼写错误，建议改成Django，避免混淆。

内容的提问来源于stack exchange，提问作者miaoz2001