feat: add enrich config to adapter (#3)

* feat: add enrich config to adapter

* some other config was moved from java-core to java-dap

* fix(test): adding missing dep for tests

Author: s1n7ax

lua/java-dap/api/runner.lua

@@ -0,0 +1,73 @@
+local class = require('java-core.utils.class')
+local log = require('java-core.utils.log')
+
+---@class java-dap.DapRunner
+---@field private server uv_tcp_t
+local Runner = class()
+
+---@return java-dap.DapRunner
+function Runner:new()
+	local o = {
+		server = nil,
+	}
+
+	setmetatable(o, self)
+	self.__index = self
+	return o
+end
+
+---Dap run with given config
+---@param config java-core.DapLauncherConfig
+---@param report java_test.JUnitTestReport
+function Runner:run_by_config(config, report)
+	log.debug('running dap with config: ', config)
+
+	require('dap').run(config --[[@as Configuration]], {
+		before = function(conf)
+			return self:before(conf, report)
+		end,
+
+		after = function()
+			return self:after()
+		end,
+	})
+end
+
+---Runs before the dap run
+---@private
+---@param conf java-core.DapLauncherConfig
+---@param report java_test.JUnitTestReport
+---@return java-core.DapLauncherConfig
+function Runner:before(conf, report)
+	log.debug('running "before" callback')
+
+	self.server = assert(vim.loop.new_tcp(), 'uv.new_tcp() must return handle')
+	self.server:bind('127.0.0.1', 0)
+	self.server:listen(128, function(err)
+		assert(not err, err)
+
+		local sock = assert(vim.loop.new_tcp(), 'uv.new_tcp must return handle')
+		self.server:accept(sock)
+		local success = sock:read_start(report:get_stream_reader(sock))
+		assert(success == 0, 'failed to listen to reader')
+	end)
+
+	-- replace the port number in the generated args
+	conf.args =
+		conf.args:gsub('-port ([0-9]+)', '-port ' .. self.server:getsockname().port)
+
+	return conf
+end
+
+---Runs aafter the dap run
+---@private
+function Runner:after()
+	vim.debug('running "after" callback')
+
+	if self.server then
+		self.server:shutdown()
+		self.server:close()
+	end
+end
+
+return Runner

lua/java-dap/api/setup.lua

@@ -0,0 +1,130 @@
+local adapters = require('java-dap.data.adapters')
+
+local log = require('java-core.utils.log')
+local class = require('java-core.utils.class')
+
+local JavaDebug = require('java-core.ls.clients.java-debug-client')
+
+---@class java-dap.Setup
+---@field private client LspClient
+---@field private java_debug java-core.DebugClient
+local Setup = class()
+
+---@param client any
+function Setup:_init(client)
+	self.client = client
+
+	self.java_debug = JavaDebug(client)
+end
+
+---@class java-dap.DapAdapter
+---@field type string
+---@field host string
+---@field port integer
+
+---Returns the dap adapter config
+---@return java-dap.DapAdapter # dap adapter details
+function Setup:get_dap_adapter()
+	log.debug('creating dap adapter for java')
+
+	local port = self.java_debug:start_debug_session()
+
+	return {
+		type = 'server',
+		host = '127.0.0.1',
+		port = port,
+		enrich_config = function(config, callback)
+			local updated_config = self:enrich_config(config)
+			callback(updated_config)
+		end,
+	}
+end
+
+---Returns the launch config filled with required data if missing in the passed
+--config
+---@private
+---@param config java-dap.DapLauncherConfigOverridable
+---@return java-dap.DapLauncherConfigOverridable
+function Setup:enrich_config(config)
+	config = vim.deepcopy(config)
+
+	local main = config.mainClass
+	local project = config.projectName
+
+	assert(main, 'To enrich the config, mainClass should already be present')
+	assert(project, 'To enrich the config, projectName should already be present')
+
+	if not config.classPaths or config.modulePaths then
+		local paths = self.java_debug:resolve_classpath(main, project)
+
+		if not config.modulePaths then
+			config.modulePaths = paths[1]
+		end
+
+		if not config.classPaths then
+			config.classPaths = paths[2]
+		end
+	end
+
+	if not config.javaExec then
+		local java_exec = self.java_debug:resolve_java_executable(main, project)
+		config.javaExec = java_exec
+	end
+
+	return config
+end
+
+---Returns the dap configuration for the current project
+---@return java-dap.DapLauncherConfig[] # dap configuration details
+function Setup:get_dap_config()
+	log.info('creating dap configuration for java')
+
+	local mains = self.java_debug:resolve_main_class()
+	local config = {}
+
+	for _, main in ipairs(mains) do
+		table.insert(config, adapters.main_to_dap_launch_config(main))
+	end
+
+	return config
+end
+
+return Setup
+
+---@class java-dap.DapLauncherConfigOverridable
+---@field name? string
+---@field type? string
+---@field request? string
+---@field mainClass? string
+---@field projectName? string
+---@field cwd? string
+---@field classPaths? string[]
+---@field modulePaths? string[]
+---@field vmArgs? string
+---@field noDebug? boolean
+---@field javaExec? string
+---@field args? string
+---@field env? { [string]: string; }
+---@field envFile? string
+---@field sourcePaths? string[]
+---@field preLaunchTask? string
+---@field postDebugTask? string
+
+---@class java-dap.DapLauncherConfig
+---@field name string
+---@field type string
+---@field request string
+---@field mainClass string
+---@field projectName string
+---@field cwd string
+---@field classPaths string[]
+---@field modulePaths string[]
+---@field vmArgs string
+---@field noDebug boolean
+---@field javaExec string
+---@field args string
+---@field env? { [string]: string; }
+---@field envFile? string
+---@field sourcePaths string[]
+---@field preLaunchTask? string
+---@field postDebugTask? string

lua/java-dap/data/adapters.lua

@@ -0,0 +1,19 @@
+local M = {}
+
+---Returns the dap config record
+---@param main JavaDebugResolveMainClassRecord
+---@return java-dap.DapLauncherConfig
+function M.main_to_dap_launch_config(main)
+	local project_name = main.projectName
+	local main_class = main.mainClass
+
+	return {
+		request = 'launch',
+		type = 'java',
+		name = string.format('%s -> %s', project_name, main_class),
+		projectName = project_name,
+		mainClass = main_class,
+	}
+end
+
+return M

lua/java-dap/init.lua

@@ -1,7 +1,5 @@
-local plugin = require('java-dap')
-
 describe('setup', function()
 	it('java-dap', function()
-		assert('plugin module should be avaiable', plugin)
+		assert('setup module should be avaiable', require('java-dap.api.setup'))
 	end)
 end)

tests/before-test.lua

@@ -1,5 +1,12 @@
 local lazypath = vim.fn.stdpath('data') .. '/lazy/lazy.nvim'
 
+---@diagnostic disable: assign-type-mismatch
+---@param path string
+---@return string|nil
+local function local_plug(path)
+	return vim.fn.isdirectory(path) == 1 and path or nil
+end
+
 if not vim.loop.fs_stat(lazypath) then
 	vim.fn.system({
 		'git',
@@ -20,6 +27,12 @@ require('lazy').setup({
 		'nvim-lua/plenary.nvim',
 		lazy = false,
 	},
+	{
+		'nvim-java/nvim-java-core',
+		---@diagnostic disable-next-line: assign-type-mismatch
+		dir = local_plug('~/Workspace/nvim-java-core'),
+		lazy = false,
+	},
 }, {
 	root = temp_path,
 	lockfile = temp_path .. '/lazy-lock.json',

tests/java-dap/java_dap_spec.lua

@@ -0,0 +1,14 @@
+---@diagnostic disable: assign-type-mismatch
+---@param dev_path string
+---@param plug_path string
+---@return string|nil
+local function local_plug(dev_path, plug_path)
+	return (vim.fn.isdirectory(dev_path) == 1) and dev_path or plug_path
+end
+
+local plug_path = './.test_plugins'
+
+vim.opt.rtp:append(plug_path .. '/plenary.nvim')
+vim.opt.rtp:append(
+	local_plug('~/Workspace/nvim-java-core', plug_path .. '/nvim-java-core')
+)