cannot unregister EVENT_RAID_SCORE_NOTIFICATION_*

[sirinsidiator]

I am currently playing around with the notification system and have encountered some strangeness that I cannot explain to myself.
My test setup:

ZO_PreHook(CHAT_SYSTEM, "OnNumNotificationsChanged", function(self, totalNumNotifications)
    d("changed from " .. tostring(self.currentNumNotifications) .. " to " .. totalNumNotifications)
    if(totalNumNotifications > 0) then error("test") end
end)
 
zo_callLater(function()
    d(NOTIFICATIONS.eventNamespace)
    d(EVENT_MANAGER:UnregisterForEvent(NOTIFICATIONS.eventNamespace, EVENT_RAID_SCORE_NOTIFICATION_ADDED))
    d(EVENT_MANAGER:UnregisterForEvent(NOTIFICATIONS.eventNamespace, EVENT_RAID_SCORE_NOTIFICATION_REMOVED))
 
    EVENT_MANAGER:RegisterForEvent("test", EVENT_RAID_SCORE_NOTIFICATION_ADDED, function() d("add event") end)
    EVENT_MANAGER:RegisterForEvent("test", EVENT_RAID_SCORE_NOTIFICATION_REMOVED, function() d("remove event") end)
end, 1000)

I expect this to hide the raid notifications until some other event refreshes the notification manager.
When I load the addon I get:

KeyboardNotifications
true
true

Which means it has unregistered both events successfully, but instead of ignoring the raid notifications it still handles them as if I never unregistered the event.
When I already have got some of them in my notifications panel and press the delete button, it shows

remove event
changed from 4 to 3

and then throws my error with the following stack traceback:

	[C]: in function 'error'
	user:/AddOns/test/test.lua:42: in function 'hookFunction'
	EsoUI/Libraries/Utility/ZO_Hook.lua:19: in function 'OnNumNotificationsChanged'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:705: in function 'ZO_NotificationManager:BuildNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:678: in function 'ZO_NotificationManager:RefreshNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:58: in function 'ZO_NotificationProvider:PushUpdateToNotificationManager'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:34: in function '(anonymous)'

When I let myself get killed and revive, it also throws the same error two times in a row.

Notifications_Common.lua:34 is inside the handler function that gets registered to both events in question and is - as far as I can see - never used anywhere else.

Maybe somebody can explain to me what is happening.

[Garkin]

What is happening:

1. Lets trigger any notification event, other then raid score. For example EVENT_CAMPAIGN_QUEUE_JOINED:
   

   EVENT_MANAGER:RegisterForEvent(self.notificationManager.eventNamespace, event, self.pushUpdateCallback)

   translated to global reference it is:
   

   EVENT_MANAGER:RegisterForEvent("KeyboardNotifications", EVENT_CAMPAIGN_QUEUE_JOINED, NOTIFICATIONS.providers[3].pushUpdateCallback)

2. NOTIFICATIONS.providers[3].pushUpdateCallback
   

   provider.pushUpdateCallback = function()
       provider:PushUpdateToNotificationManager()
   end

3. NOTIFICATIONS.providers[3]:PushUpdateToNotificationManager()
   

   function ZO_NotificationProvider:PushUpdateToNotificationManager()
       self:BuildNotificationList()
       self.notificationManager:RefreshNotificationList()
   end

4. NOTIFICATIONS.providers[3].notificationManager:RefreshNotificationList() == NOTIFICATIONS:RefreshNotificationList()
   

   function ZO_NotificationManager:RefreshNotificationList()
       self:ClearNotificationList()
       self:BuildNotificationList()
       self:FinishNotificationList()
   end

5. NOTIFICATIONS:BuildNotificationList()
   

   function ZO_NotificationManager:BuildNotificationList()
       for i = 1, #self.providers do
           self.providers[i]:BuildNotificationList()
       end
    
       --rest of the original code
    
   end

6. NOTIFICATIONS.providers[10]:BuildNotificationList() - NOTIFICATIONS.providers[10] is an instance of ZO_KeyboardLeaderboardRaidProvider

As you can see raid score notification will be eventually added to the list even if you unregister update events.

[merlight]

Perhaps what you need to override is ZO_NotificationList:FilterScrollList()

edit: no, that wouldn't report correct numbers. So post-hook ZO_LeaderboardRaidProvider:BuildNotificationList(), removing undesired entries (which is all of them? if so, no need to call original, just ZO_ClearNumericallyIndexedTable(self.list) and done )

edit2: lol, exactly Garkin, I just edited it before reading your post

[Garkin]

Originally Posted by merlight Perhaps what you need to override is ZO_NotificationList:FilterScrollList()

I'm hooking ZO_LeaderboardRaidProvider:BuildNotificationList() in No, thank you! (and before I have used the same hook in my updated version of Thurisaz Guild Info).
I think that's the best place where you can change which notifications will be displayed. If you modify FilterScrollList instead, I believe that when you receive new notification there will be glowing notification button on the chat window. It's becuae function just counts number of items on each notification list (#provider.list), it does not check if items are filtered or not.

[sirinsidiator]

It's clear to me that it will trigger when any other notification event is fired, but that does not explain why it still happens in response to me clicking the delete button on a raid notification after I unregistered the EVENT_RAID_SCORE_NOTIFICATION_REMOVED event.

I will test it again with all other notification events unregistered in the evening.
In that case the push function in line 34 should never be called, right?

[Minceraft]

Originally Posted by sirinsidiator It's clear to me that it will trigger when any other notification event is fired, but that does not explain why it still happens in response to me clicking the delete button on a raid notification after I unregistered the EVENT_RAID_SCORE_NOTIFICATION_REMOVED event.

I was thinking maybe that each EVENT is considered a separate EVENT in terms of you're blocking only the NEXT event that fires...then it clears the clear..kinda the same way that ON_PLAYER_ACTIVATED works... When you unregister it at the end of it's own function, it will re register every time you reload the UI or the like...so when you click the delete button, maybe it's canceling out your cancel?? Clicking the delete button may reset the event registry for the function. Just a thought!

[Garkin]

Originally Posted by Minceraft I was thinking maybe that each EVENT is considered a separate EVENT in terms of you're blocking only the NEXT event that fires...then it clears the clear..kinda the same way that ON_PLAYER_ACTIVATED works... When you unregister it at the end of it's own function, it will re register every time you reload the UI or the like...so when you click the delete button, maybe it's canceling out your cancel?? Clicking the delete button may reset the event registry for the function. Just a thought!

It has nothing to do with next event. You are either registered for that event or not. If you relaod UI, everything goes to the default state. So if default state is that you're registered fo EVENT_PLAYER_ACTIVATED, your function will be called.

Originally Posted by sirinsidiator It's clear to me that it will trigger when any other notification event is fired, but that does not explain why it still happens in response to me clicking the delete button on a raid notification after I unregistered the EVENT_RAID_SCORE_NOTIFICATION_REMOVED event. I will test it again with all other notification events unregistered in the evening. In that case the push function in line 34 should never be called, right?

Yes, pushUpdateCallback is called only if registered event is triggered. Try to check which events are triggered at the time when you click Delete button using the Zgoo (/zgoo events).

[sirinsidiator]

Just tried to unregister every event related to notifications:

ZO_PreHook(CHAT_SYSTEM, "OnNumNotificationsChanged", function(self, totalNumNotifications)
    error("test")
end)
 
local events = {
    "EVENT_INCOMING_FRIEND_INVITE_ADDED",
    "EVENT_INCOMING_FRIEND_INVITE_REMOVED",
    "EVENT_INCOMING_FRIEND_INVITE_NOTE_UPDATED",
    "EVENT_GUILD_INVITES_INITIALIZED",
    "EVENT_GUILD_INVITE_ADDED",
    "EVENT_GUILD_INVITE_REMOVED",
    "EVENT_CAMPAIGN_QUEUE_JOINED",
    "EVENT_CAMPAIGN_QUEUE_LEFT",
    "EVENT_CAMPAIGN_QUEUE_STATE_CHANGED",
    "EVENT_RESURRECT_REQUEST",
    "EVENT_RESURRECT_REQUEST_REMOVED",
    "EVENT_PLAYER_ALIVE",
    "EVENT_GROUP_INVITE_RECEIVED",
    "EVENT_GROUP_INVITE_REMOVED",
    "EVENT_TRADE_INVITE_CONSIDERING",
    "EVENT_TRADE_INVITE_REMOVED",
    "EVENT_QUEST_SHARED",
    "EVENT_QUEST_SHARE_REMOVED",
    "EVENT_PLEDGE_OF_MARA_OFFER",
    "EVENT_PLEDGE_OF_MARA_OFFER_REMOVED",
    "EVENT_AGENT_CHAT_REQUESTED",
    "EVENT_AGENT_CHAT_ACCEPTED",
    "EVENT_AGENT_CHAT_DECLINED",
    "EVENT_RAID_SCORE_NOTIFICATION_ADDED",
    "EVENT_RAID_SCORE_NOTIFICATION_REMOVED",
}
 
local function ReassignEvent(name)
    d("unregister " .. name .. ": " .. tostring(EVENT_MANAGER:UnregisterForEvent(NOTIFICATIONS.eventNamespace, _G[name])))
    EVENT_MANAGER:RegisterForEvent("test", _G[name], function() d(name) end)
end
 
zo_callLater(function()
    d(NOTIFICATIONS.eventNamespace)
    for _, name in ipairs(events) do
        ReassignEvent(name)
    end
end, 1000)

The messages that were showing up when I revived obviously were caused by EVENT_PLAYER_ALIVE.

When I join a campaign queue I get:

EVENT_CAMPAIGN_QUEUE_JOINED
user:/AddOns/test/test.lua:130: test
stack traceback:
	[C]: in function 'error'
	user:/AddOns/test/test.lua:130: in function 'hookFunction'
	EsoUI/Libraries/Utility/ZO_Hook.lua:19: in function 'OnNumNotificationsChanged'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:705: in function 'ZO_NotificationManager:BuildNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:678: in function 'ZO_NotificationManager:RefreshNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:58: in function 'ZO_NotificationProvider:PushUpdateToNotificationManager'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:34: in function '(anonymous)'
EVENT_CAMPAIGN_QUEUE_STATE_CHANGED
user:/AddOns/test/test.lua:130: test
stack traceback:
	[C]: in function 'error'
	user:/AddOns/test/test.lua:130: in function 'hookFunction'
	EsoUI/Libraries/Utility/ZO_Hook.lua:19: in function 'OnNumNotificationsChanged'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:705: in function 'ZO_NotificationManager:BuildNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:678: in function 'ZO_NotificationManager:RefreshNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:58: in function 'ZO_NotificationProvider:PushUpdateToNotificationManager'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:34: in function '(anonymous)'
EVENT_CAMPAIGN_QUEUE_LEFT
user:/AddOns/test/test.lua:130: test
stack traceback:
	[C]: in function 'error'
	user:/AddOns/test/test.lua:130: in function 'hookFunction'
	EsoUI/Libraries/Utility/ZO_Hook.lua:19: in function 'OnNumNotificationsChanged'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:705: in function 'ZO_NotificationManager:BuildNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:678: in function 'ZO_NotificationManager:RefreshNotificationList'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:58: in function 'ZO_NotificationProvider:PushUpdateToNotificationManager'
	EsoUI/Ingame/Contacts/Notifications_Common.lua:34: in function '(anonymous)'

I am not sure what I am missing here, but in my opinion this should work and not call the push function anymore...

[merlight]

Try unregistering for GAMEPAD_NOTIFICATIONS as well, not sure how they would only use one.

[sirinsidiator]

local function ReassignEvent(namespace, name)
    d("unregister " .. name .. ": " .. tostring(EVENT_MANAGER:UnregisterForEvent(namespace, _G[name])))
    EVENT_MANAGER:RegisterForEvent("test", _G[name], function() d(name) end)
end
 
zo_callLater(function()
    d(NOTIFICATIONS.eventNamespace)
    for _, name in ipairs(events) do
        ReassignEvent(NOTIFICATIONS.eventNamespace, name)
    end
    
    d(GAMEPAD_NOTIFICATIONS.eventNamespace)
    for _, name in ipairs(events) do
        ReassignEvent(GAMEPAD_NOTIFICATIONS.eventNamespace, name)
    end
end, 1000)

You deserve a medal merlight!