Path.Context.Wrap.Static causes global env inside Path.Wrap of a nested function call to be missing some game globals

[adi1998]

This is only observed when ModUtil is used in Hades 2 (Hell2Modding). Suggested replacement implementations by @AndreLouisIssa that seem to work for a very simple repro.

ModUtil.Context.Call = ModUtil.Context(
    function( info )
        info.env = setmetatable( { }, { __index = info.penv } )
        return table.unpack( info.args )
    end,
    function( info )
        local thread = coroutine.running( )
        local penv = threadEnvironments[ thread ]
        threadEnvironments[ thread ] = setmetatable( info.env, { __index = info.penv, __newindex = info.penv } )
        local ret = table.pack( info.arg( table.unpack( info.args ) ) )
        threadEnvironments[ thread ] = penv
        return table.unpack( ret )
    end
)

ModUtil.Context.Wrap.Static = ModUtil.Context(
    function( info )
        info.env = setmetatable( { }, { __index = info.penv } )
    end,
    function( info )
        return ModUtil.Wrap( info.arg, function( base, ... ) 
            local thread = coroutine.running( )
            local penv = threadEnvironments[ thread ]
            threadEnvironments[ thread ] = setmetatable( info.env, { __index = info.penv, __newindex = info.penv } )
            local ret = table.pack( base( ... ) )
            threadEnvironments[ thread ] = penv
            return table.unpack( ret )
        end, info.args[1] )
    end
)

some more context in the form a discord thread :) https://discord.com/channels/667753182608359424/1485464228180529182/1531648075482005505

[adi1998]

Simple mod which repro the issue

The CalculateDamageMultipliers wrap prints nil nil 1.2 when 1.2 1.2 1.2 is expected. This can be triggered by damaging any enemy or Skelly in the Crossroads

---@meta _
-- grabbing our dependencies,
-- these funky (---@) comments are just there
--	 to help VS Code find the definitions of things

---@diagnostic disable-next-line: undefined-global
local mods = rom.mods

---@module 'LuaENVY-ENVY-auto'
mods['LuaENVY-ENVY'].auto()
-- ^ this gives us `public` and `import`, among others
--	and makes all globals we define private to this plugin.
---@diagnostic disable: lowercase-global

---@diagnostic disable-next-line: undefined-global
rom = rom
---@diagnostic disable-next-line: undefined-global
_PLUGIN = _PLUGIN

-- get definitions for the game's globals
---@module 'game'
game = rom.game
---@module 'game-import'
import_as_fallback(game)

---@module 'SGG_Modding-SJSON'
sjson = mods['SGG_Modding-SJSON']
---@module 'SGG_Modding-ModUtil'
modutil = mods['SGG_Modding-ModUtil']

---@module 'SGG_Modding-Chalk'
chalk = mods["SGG_Modding-Chalk"]
---@module 'SGG_Modding-ReLoad'
reload = mods['SGG_Modding-ReLoad']

-- ---@module 'config'
-- config = chalk.auto 'config.lua'
-- -- ^ this updates our `.cfg` file in the config folder!
-- public.config = config -- so other mods can access our config


local function on_ready()
	-- what to do when we are ready, but not re-do on reload.
	local mod = modutil.mod.Mod.Register(_PLUGIN.guid)

	-- import 'ready.lua'
	modutil.mod.Path.Wrap("CalculateDamageMultipliers", function(baseFunc, attacker, victim, weaponData, triggerArgs )
		baseFunc( attacker, victim, weaponData, triggerArgs )
		print(damageMultipliers, game.damageMultipliers, game._G.damageMultipliers)
		return game._G.damageMultipliers * game._G.damageReductionMultipliers
	end)
end

local function on_reload()
end

local function on_ready_late()
	-- what to do when we are ready after all other mods
	--   but not re-do on reload.

	-- import 'ready_late.lua'
	modutil.mod.Path.Context.Wrap.Static("Damage", function ()
	end)
end

local function on_reload_late()
end

-- this allows us to limit certain functions to not be reloaded.
local loader = reload.auto_multiple()

-- this runs only when modutil and the game's lua is ready
modutil.once_loaded.game(function()
	loader.load("early", on_ready, on_reload)
end)

-- again but loaded later than other mods
mods.on_all_mods_loaded(function()
	modutil.once_loaded.game(function()
		loader.load("late", on_ready_late, on_reload_late)
	end)
end)