ESOUI - Bug with EVENT_UNIT_CREATED and GetUnit*

ESOUI (https://www.esoui.com/forums/index.php)

- General Authoring Discussion (https://www.esoui.com/forums/forumdisplay.php?f=174)

- - Bug with EVENT_UNIT_CREATED and GetUnit* (https://www.esoui.com/forums/showthread.php?t=5553)

Bug with EVENT_UNIT_CREATED and GetUnit*

I tried to get the unit name of newly joined group members and found that it does not work as expected.
Here is the code I tested it with:

Lua Code:

EVENT_MANAGER:RegisterForEvent("nametest", EVENT_UNIT_CREATED, function(_, unitTag) 
df("unit created: %s %s (%s)", tostring(unitTag), GetUnitDisplayName(unitTag), tostring(DoesUnitExist(unitTag)))
end)

When I make a new group, I get one EVENT_UNIT_CREATED for myself which is fine, but for some reason I get two events for whoever I invited. Besides that everything works fine in all three events.

Code:

unit created: group1 @sirinsidiator (true)

unit created: group2 @groupie1 (true)

unit created: group2 @groupie1 (true)

But when I invite another player, the first occurrence returns an empty name and only the second one works as expected.

Code:

unit created: group3  (true)

unit created: group3 @groupie2 (true)

DoesUnitExist does not help as it always returns true, so the only thing I can do is check for an empty string and ignore those events.

This probably isn't very helpful, but here is a snippet I found in the lua files. It looks like they call a delay when a unit is created (or destroyed) and then call self:BuildMasterList() to rebuild all of the group data from scratch. So whatever is causing it, this is probably a known issue. They do the same when a unit is destroyed.

ZO_GroupList_Manager.lua

Lua Code:

function ZO_GroupList_Manager:RegisterForEvents()
    --  During group invitation, we can receive a lot of event spam at once on a single invite when the
     -- involved players are at the same location. Add a delay so we only refresh once in cases like this.
    local function DelayedRefreshData()
        self.delayedRebuildCounter = self.delayedRebuildCounter - 1
        if self.delayedRebuildCounter == 0 then
            self:RefreshData()
        end
    end
 
    local function RegisterDelayedRefresh()
        self.delayedRebuildCounter = self.delayedRebuildCounter + 1
        zo_callLater(DelayedRefreshData, 50)
    end
 
  ...
end
 
EVENT_MANAGER:RegisterForEvent("ZO_GroupList_OnUnitCreated", EVENT_UNIT_CREATED, RegisterDelayedRefreshOnUnitEvent)
EVENT_MANAGER:RegisterForEvent("ZO_GroupList_OnUnitDestroyed", EVENT_UNIT_DESTROYED, RegisterDelayedRefreshOnUnitEvent)