Перейти к основному содержимому

Lua - Отладка кода на remote сервере

· 5 мин. чтения

debugger.lua

примечание

Пост создан в стиле заметок, а не руководства. Будет полезен тем, кто хочет удаленно дебажить свои Lua приложения, но еще подбирает инструмент.

Проблема в том, что вся информация на китайском. Каждый известный LuaDebug написал китаец и они не хотят переводить документацию на английский.

Все, кроме одного решения рассчитаны на отладку через VSCode. MobDebug может применяться еще с ZeroBrain Studio.

Важный момент для понимания:

  • клиент – наше луа приложение или скрипт
  • сервер – vscode

Сначала запускается сервер (нажатие кнопки старта debug в VSCode начинает слушать определенный порт), затем клиент подключается к серверу по TCP. Нажатие кнопки отладки, в отличии от локального дебага, не запускает код на компе с VSCode, а начинает ждать подключение по TCP

VSCode LuaHelper + LuaPanda.lua​

.

  • LuaHelper/LuaPanda китайская поделка, не работает пауза, данные передаются в виде непонятно чего.
  • Есть переподключение, если отключить дебаггер, а потом включить заново. В mobdebug надо перезапускать луа скрипт/приложение
  • В LuaPanda.lua сверху рекомендую изменить consoleLogLevel = 0 на время тестов
  • Еще поглядывать в консоль "Выходные данные" Ctrl + J в VSCode: 
{
	"type": "LuaHelper-Debug",
	"request": "launch",
	"name": "LuaHelper-Attach",
	"description": "any",
	"cwd": "${workspaceFolder}",
	"luaFileExtension": "",
	"connectionPort": 8172,
	"stopOnEntry": true,
	"useCHook": true,
	"autoPathMode": true,
	"logLevel": 1
},
require('LuaPanda').start('123.123.123.123', 8172)

VSCode Lua Debugger от devCAT + vscode-debuggee.lua​

Debug конфиг брал тут (третий). Но он не запустился сразу. Удалил расширение VSCode, заменил конфиг на MobDebug. Оказывается, API VSCode расширений очень похожи, но в vscode-debuggee.lua пришлось напильником заменить пару строк:

-- было
sourceBasePath = initMessage.sourceBasePath
directorySeperator = initMessage.directorySeperator

-- стало
sourceBasePath = initMessage.arguments.sourceBasePath
directorySeperator = initMessage.arguments.directorySeperator

⚠️ Проблема нашлась в том, что после брейкпоинта нужно удалять его, чтобы работа скрипта продолжилась. Иначе застакается на строке (не работает кнопка продолжить). Если второй раз поставить брейкпоинт после удаления, то он почему-то не работает второй раз.

local util = require("gmod.util") -- или можно просто скормить cjson/dkjson
local json = {
	encode = util.TableToJSON,
	decode = util.JSONToTable,
}
local debuggee = require 'vscode-debuggee'
local startResult, breakerType = debuggee.start(json, {
	controllerHost = "123.123.123.123",
	controllerPort = 8172,
	dumpCommunication = true, -- принт в вывод VSCode того, что получает и отправляет
})
print('debuggee start ->', startResult, breakerType)

VSCode MobDebug Adapter + mobdebug.lua​

Оригинальный mobdebug.lua отличается от того, что идет с плагином. Оригинал не подходит, поскольку в нем сообщения принимаются без json, а плагин шлет json. Оригинал используется в ZeroBrain Studio.

mobdebug нравится больше, чем LuaPanda, но файл засран говном. Работает пауза, меньше китайщины и багов. Более здраво выглядит конфиг.

Пример первого запроса от VSCode к Lua при подключении:

#128
{"command":"welcome","arguments":{"stopOnEntry":true,"sourceBasePath":"/Users/amd/Desktop/ggram-bots","directorySeperator":"/"}}#230
{"type":"request","seq":3,"command":"setBreakpoints","arguments":{"source":{"name":"commands.lua","path":"/Users/amd/Desktop/ggram-bots/bots/aanebots/commands.lua"},"lines":[31],"breakpoints":[{"line":31}],"sourceModified":false}}#216
{"type":"request","seq":4,"command":"setBreakpoints","arguments":{"source":{"name":"launcher.lua","path":"/Users/amd/Desktop/ggram-bots/launcher.lua"},"lines":[64],"breakpoints":[{"line":64}],"sourceModified":false}}
{
	"type": "luaMobDebug",
	"name": "Lua MobDebug: Listen",
	"request": "attach",
	"workingDirectory": "${workspaceFolder}",
	"sourceBasePath": "${workspaceFolder}",
	"listenPublicly": true,
	"listenPort": 8172,
	"stopOnEntry": true,
	"sourceEncoding": "UTF-8",
	// "runMode": "task",
	// "interpreter": "lua5.3"
},
local mobdebug = require("mobdebug")
mobdebug.logging(true)
mobdebug.start("123.123.123.123", 8172)

VSCode LuaDebug от actboy168 + не пойму что​

Самая популярная и перспективная библиотека, но я так и не смог понять, как ее установить в приложение lua файлом, чтобы проводить поистине удаленную разработку через Socket. Пришлось достать приложение из Docker контейнера, но при этом этот дебаггер оказался действительно самым удобным и качественным.

Полуудаленный дебаг получилось реализовать, используя VSCode Remote – SSH. Т.е. по сути дебаг был как бы локальным, но при этом все выполнялось на удаленном хосте. Просто не получилось дебажить внутри Docker.

Этот дебаггер используют RealTimeLogic и этим меня подкупили. Вроде не глупая компания.

debugger.lua БЕЗ VSCode​

debugger.lua

Это один файл-дебаггер. Код прелестный, минималистичный. Все нравится. Но нет расширения для VSCode. Это REPL скрипт, который подкупает, если запустить интерактивный туториал:

git clone https://github.com/slembcke/debugger.lua.git debugger && cd debugger
lua tutorial.lua

Мои скрипты запускаются через docker-compose.yml файл, но этот дебаггер при попытке использования все крашил. Исправил запуском контейнера без docker-compose и добавлением параметров -it в docker run.

Так скрипт работал хорошо, но в некоторых случаях не работало продолжение воспроизведения кода после брейкпоинта. Не знаю в чем дело

🍬 Бонус​

Как я уже говорил, плагины для VSCode при старте дебага начинают слушать определенный TCP порт на устройстве, а Lua приложение подключается к этому порту и потом начинается обмен данными туда-сюда. Ниже команды, которые мне сократили несколько часов жизни:

# Открыть и слушать локальный порт
netcat netcat -l -p 8172

# Подключиться к порту на определенном IP
# Все, что начать писать в терминале – отобразится на первом хосте и наоборот
nc ip port

В моем случае я так проверял, что порт действительно открыт и мог отправлять произвольные данные в ручном режиме, чтобы что-то подшлифовать напильником при необходимости.

предупреждение

С netcat вообще следует начинать до того, как устанавливать какой-либо плагин или lua модуль, потому что remote debug не будет работать, если не "открыть" (пробросить) порт в роутере или если провайдер выдал вам серый IP. В случае с серым IP могу порекомендовать Tailscale. Он поможет обойти NAT и процедуру проброса портов