Confusing execution order in lazy.nvim

[s1n7ax]

I'm the author of nvim-java and since a lot of people seem to mess up the order of how things should be setup, I planed to add validations to show errors. But, I noticed some weird stuff.

In general, for nvim-java to work correctly, nvim-java.setup() should be executed before lspconfig.jdtls.setup() because I wrap lspconfig.jdtls.setup() to do some configurations.

This is my local config on lazyvim.
https://github.com/s1n7ax/lazyvim-dotnvim/blob/ad0b36789e1f40b2a8d6d0c93a58a6209be5c45b/lua/plugins/java/init.lua

require('utils.file').is_pkg_dir is a util I created to load files from the local path if the path exists. On my PC, everything loads from the local paths.

I added some console logs to find out in what order everything is being executed. I changed the opts value from table to functions and added logs. In plugins, I added logs at the start of the setup functions.

local f = require('utils.file').is_pkg_dir

require('lspconfig').jdtls.setup({})

return {
  'williamboman/mason-lspconfig.nvim',
  dependencies = {
    {
      'williamboman/mason.nvim',
      opts = {
        registries = {
          'github:nvim-java/mason-registry',
          'github:mason-org/mason-registry',
        },
      },
    },
    {
      'nvim-java/nvim-java',
      dir = f('~/Workspace/nvim-java'),
      opts = function()
        vim.print('nvim-java.opts()')
        return {
          jdk = {
            auto_install = false,
          },
          notifications = {
            dap = false,
          },
        }
      end,
      dependencies = {
        {
          'nvim-java/lua-async-await',
          dir = f('~/Workspace/lua-async-await'),
        },
        {
          'nvim-java/nvim-java-core',
          dir = f('~/Workspace/nvim-java-core'),
        },
        {
          'nvim-java/nvim-java-test',
          dir = f('~/Workspace/nvim-java-test'),
        },
        {
          'nvim-java/nvim-java-dap',
          dir = f('~/Workspace/nvim-java-dap'),
        },
        {
          'nvim-java/nvim-java-refactor',
          dir = f('~/Workspace/nvim-java-refactor'),
        },
        'MunifTanjim/nui.nvim',
        'neovim/nvim-lspconfig',
        'mfussenegger/nvim-dap',
      },
    },
  },
  opts = function()
    vim.print('mason-lspconfig.opts()')
    return {
      handlers = {
        ['jdtls'] = function()
          vim.print('lspconfig.jdtls.setup() from mason-lspconfig handlers')
          require('lspconfig').jdtls.setup({})
        end,
      },
    }
  end,
}

Following is the order everything is being executed. Note that > lspconfig.jdtls.setup() is the log I added to jdtls setup function inside lspconfig project.

> lspconfig.jdtls.setup()
mason-lspconfig.opts()
mason-lspconfig.setup()
> lspconfig.jdtls.setup()
nvim-java.opts()
nvim-java.setup()
mason-lspconfig.setup()
lspconfig.jdtls.setup() from mason-lspconfig handlers
> lspconfig.jdtls.setup()

I have few questions.

• Since nvim-java is a dependency of mason-lspconfig, shouldn't nvim-java.opts() and nvim-java.setup() be called before mason-lspconfig.setup()?
• Any idea why > lspconfig.jdtls.setup() and mason-lspconfig.setup() is called way too many times?

[folke]

It's hard to tell without seeing what's happening in your other files, but that require('lspconfig').jdtls.setup({}) at the top is for sure bad.

That will partially load lspconfig, while lazy doesn't yet know all it's deps etc (or reverse deps for that matter).

You probably have mason-lspconfig as a dep (or the reverse) of lspconfig in another file.

Due to that require at the top, those two will load already, so that's why you're seeing it being setup before nvim-java.

Normally opts for a plugin is only resolved once, unless it gets requested during spec parsing and it changes again afterward. In that case, it might be resolved multiple times. Which is exactly what happens here.

In general, you always should make sure your specs don't load any plugins and use closures where needed.

[s1n7ax]

@folke I just tested the same in this minimal config. This only includes nvim-java plugin spec, treesitter java parser and lazyvim dap core extra. Nothing else

https://github.com/nvim-java/play-lazyvim

Mason lspconfig is being setup more than once for sure.

Probably not related to lazy.nvim but I'm pretty sure something is wrong. I will dig into this further.

[s1n7ax]

@folke
Good news is jdtls setup is only called once in minimal config But mason-lspconfig is setup twice.

mason-lspconfig.opts()
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>mason-lspconfig.setup()
stack traceback:
	...m/lazy/mason-lspconfig.nvim/lua/mason-lspconfig/init.lua:23: in function 'setup'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:373: in function <...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:371>
	[C]: in function 'xpcall'
	.../.local/share/nvim/lazy/lazy.nvim/lua/lazy/core/util.lua:113: in function 'try'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:381: in function 'config'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:348: in function '_load'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:191: in function 'load'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:342: in function <...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:341>
	[C]: in function 'xpcall'
	.../.local/share/nvim/lazy/lazy.nvim/lua/lazy/core/util.lua:113: in function 'try'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:341: in function '_load'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:191: in function 'load'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:342: in function <...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:341>
	[C]: in function 'xpcall'
	.../.local/share/nvim/lazy/lazy.nvim/lua/lazy/core/util.lua:113: in function 'try'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:341: in function '_load'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:191: in function 'load'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:123: in function 'startup'
	/root/.local/share/nvim/lazy/lazy.nvim/lua/lazy/init.lua:112: in function 'setup'
	/root/.config/nvim/lua/config/lazy.lua:10: in main chunk
	[C]: in function 'require'
	/root/.config/nvim/init.lua:2: in main chunk
nvim-java.setup()
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>mason-lspconfig.setup()
stack traceback:
	...m/lazy/mason-lspconfig.nvim/lua/mason-lspconfig/init.lua:23: in function 'setup'
	...share/nvim/lazy/LazyVim/lua/lazyvim/plugins/lsp/init.lua:226: in function 'config'
	...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:366: in function <...local/share/nvim/lazy/lazy.nvim/lua/lazy/core/loader.lua:364>
nvim-java.opts()
nvim-java.setup()

Once from lazy.nvim and the other time by LazyVim

[folke]

I wasn't aware you were using LazyVim. LazyVim does indeed run setup of lspconfig-mason manually.
The issue is that you set opts on mason-lspconfig.
Will make a small change to prevent it setting up twice.

[folke]

See LazyVim/LazyVim@8c900f9

Just so you know, mason-lspconfig was only setup once in LazyVim. It's your custom config that does it more than once

[s1n7ax]

@folke Well, yes. Who would have though it's being called explicitly. Isn't that how I'm supposed to run nvim-java before lspconfig? Is there any other way?

[s1n7ax]

@folke I see there is setup table in nvim-lspconfig