VSCode新手：通过Docker进行远程Jest/节点调试

Question

我最近从Vim切换到VSCode，我正在尝试为通过docker运行的jest测试设置VSCode调试。

调试工作。。。某种程度上。如果我想运行jest测试并激活断点，我需要：

1. 插入断点
2. 开始运行相关的jest测试通过vscode-jest测试下面的launch.json任务
3. 在测试套件到达断点之前快速执行Docker：附加到节点

显然不理想-我希望确保VSCode在运行vscode-jest-test时自动附加到调试器。简而言之：在通过Docker运行Jest测试时，有没有一种简单的方法来附加VSCode调试器？

这是我目前的发布会。json和包。json文件。非常感谢您的帮助：

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Docker: Attach to Node",
      "port": 9229,
      "address": "localhost",
      "localRoot": "${workspaceFolder}",
      "remoteRoot": "/www",
      "protocol": "inspector"
    },
    {
      "type": "node",
      "request": "launch",
      "name": "vscode-jest-tests",
      "runtimeExecutable": "npm",
      "runtimeArgs": [ "run", "test:debug" ],
      "address": "127.0.0.1",
      "port": 9229,
      "breakOnLoad": true,
      "restart": true,
      "timeout": 10000,
      "localRoot": "${workspaceFolder}",
      "remoteRoot": "/www",
      "outFiles": [
        "${workspaceFolder}/dist/**/*.js"
      ],
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen"
    }
  ]
}

#...
"scripts": {
  "test:debug": "docker exec -it kiva_api node --nolazy --inspect-brk=0.0.0.0:9229 node_modules/.bin/jest --runInBand --config=test/jest-e2e.json"
}
#...

PS：如果我从命令行运行npm run test:debug

Answer 1

大半天后，明白了。

VSCode启动。json

{
  "type": "node",
  "name": "docker-jest",
  "request": "attach",
  "address": "0.0.0.0",
  "port": 9229,
  "localRoot": "${workspaceFolder}",
  "remoteRoot": "/app", // Will depend on your setup
  "skipFiles": [
    "<node_internals>/**/*.js",
    "${workspaceFolder}/node_modules/**/*.js"
  ],
  "internalConsoleOptions": "neverOpen",
  "presentation": {
    "reveal": "silent"
  }
},

确保docker容器在端口9229打开的情况下运行。我使用tail-d/dev/null来保持我的运行。我不会详细介绍docker设置，因为有很多关于这个主题的在线资源。

然后进入docker容器

$ docker exec -it container_name /bin/bash

然后跑

$ node --inspect-brk=0.0.0.0:9229 --nolazy -r ./node_modules/ts-node/register ./node_modules/jest/bin/jest.js --config=./jest-config.json --runInBand

--runInBand标志是这个工作的关键。

--runInBand使所有测试都在父进程而不是子进程中运行。

你应该看到

root@7a0ba832e7f9:/app# node --inspect-brk=0.0.0.0:9229 --nolazy -r ./node_modules/ts-node/register ./node_modules/jest/bin/jest.js --config=./jest-config.json --runInBand
Debugger listening on ws://0.0.0.0:9229/267bfe8c-dfa8-45e0-a86c-abcadbd97bea
For help, see: https://nodejs.org/en/docs/inspector

在笑话中设置断点。spec.ts文件并执行docker jest调试器。

如果仍然存在问题，请确保应用程序未在同一端口上以调试模式运行。测试将继续执行，仅短暂暂停，显示以下内容：；

Starting inspector on 0.0.0.0:9229 failed: address already in use

如果发生这种情况，只需将节点命令和launch.json中使用的调试端口更改为其他端口并打开docker端口。

Answer 2

这是我的发布会。使用Docker调试Jest测试的json配置。

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "name": "Docker: Jest Tests",
      "request": "launch",
      "program": "${workspaceFolder}/node_modules/.bin/jest",
      "args": [
        "--runInBand"
      ],
      "cwd": "${workspaceFolder}",
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen",
      "disableOptimisticBPs": true,
      "windows": {
        "program": "${workspaceFolder}/node_modules/jest/bin/jest",
      },
      "protocol": "inspector"
    }
  ]
}

想法是启动docker compose，包括一个数据库（Postgres、MongoDB等）和一个api应用程序，然后通过VSCode运行和调试。

Answer 3

这是我的解决方案，主要来自你的同一个问题。谢谢你的提问：）

首先在监视模式下启动jest（--watchAll），这样进程保持活动状态。（在代码片段中，我假设一个后端容器通过docker compose运行，端口9229暴露在主机上）

docker-compose exec backend \
  node --inspect=0.0.0.0:9229 -r tsconfig-paths/register -r ts-node/register \
  node_modules/.bin/jest --watchAll --runInBand 

现在在VSCode. vscode/launch.json配置中添加一个要附加到正在运行的进程的配置。注意：确保Remote teRoot适合您的设置。

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
        "type": "node",
        "request": "attach",
        "name": "Docker: Debug tests",
        "address": "127.0.0.1",
        "port": 9229,
        "trace": true,
        "restart": true,
        "timeout": 10000,
        "localRoot": "${workspaceFolder}",
        "remoteRoot": "/app",
        "outFiles": [
            "${workspaceFolder}/dist/**/*.js"
        ],
        "disableOptimisticBPs": true,            
        "internalConsoleOptions": "neverOpen",
        "continueOnAttach": true,
    }]
}

从这里开始，我已经能够正确地开发和调试我的代码。