fix(favorites): various fixes when applying profile in background [gh#165](#165), [gh#166](#166), [gh#167](#167)

Author: exochron

Api.lua

@@ -7,7 +7,7 @@ function ADDON.Api:MountIdToOriginalIndex(mountId)
 
     local count = C_MountJournal.GetNumDisplayedMounts()
     for i = 1, count do
-        local displayedMountId = select(12, C_MountJournal.GetDisplayedMountInfo(i))
+        local displayedMountId = C_MountJournal.GetDisplayedMountID(i)
         if displayedMountId == mountId then
             return i
         end

DevZone/Debug.lua

@@ -78,9 +78,12 @@ end
 
 local function testFavorites()
     local _,_, favorites = ADDON.Api:GetFavoriteProfile()
-    local expectedMounts = CopyTable(favorites)
+    local expectedMounts = tFilter(favorites, function(mountId)
+        local _, _, _, _, _, _, _, _, _, shouldHideOnChar = C_MountJournal.GetMountInfoByID(mountId)
+        return not shouldHideOnChar
+    end)
 
-    for i = 1, 100 do
+    for i = 1, 10000 do
         local name, _, _, _, _, _, isFavorite, _,_,_,_, mountId = C_MountJournal.GetDisplayedMountInfo(i)
         if isFavorite then
             local listIndex = tIndexOf(expectedMounts,mountId)

Favorites.lua

@@ -1,27 +1,42 @@
 local _, ADDON = ...
 
 local function collectFavoredByApi()
+    local c = 0
     local mountIds = C_MountJournal.GetMountIDs()
     local favoredMounts = {}
     for _, mountId in ipairs(mountIds) do
         local _, _, _, _, _, _, isFavorite = C_MountJournal.GetMountInfoByID(mountId)
         if isFavorite then
-            favoredMounts[#favoredMounts+1] = mountId
+            c = c + 1
+            favoredMounts[c] = mountId
         end
     end
 
     return favoredMounts
 end
 
 local backgroundTimer
-local function UpdateFavoritesInBackground()
+local function cancelBackgroundTask()
     if backgroundTimer then
         backgroundTimer:Cancel()
     end
+    ADDON.Events:UnregisterFrameEventAndCallback("MOUNT_JOURNAL_SEARCH_UPDATED", 'cleanup-favorite-background')
+end
+local function UpdateFavoritesInBackground()
+    cancelBackgroundTask()
 
     local _, _ , favorites = ADDON.Api:GetFavoriteProfile()
-    local flippedFavorites = CopyValuesAsKeys(favorites)
+    favorites = tFilter(favorites, function(mountId)
+        local _, _, _, _, _, _, _, _, _, shouldHideOnChar = C_MountJournal.GetMountInfoByID(mountId)
+        return not shouldHideOnChar
+    end)
+
+    local flippedFavorites = {}
+    for _, v in pairs(favorites) do -- CopyValuesAsKeys() somehow created faulty list
+        flippedFavorites[v] = true
+    end
     local operationCount = #favorites
+    favorites = nil
 
     local favoredByApi = collectFavoredByApi()
 
@@ -36,29 +51,52 @@ local function UpdateFavoritesInBackground()
     end
 
     if operationCount > 0 then
-        backgroundTimer = C_Timer.NewTicker(0.4, function()
-            local toRemove = {}
-            for mountId, value in pairs(flippedFavorites) do
-                value = value ~= false
-                local _, _, _, _, _, _, isFavorite = C_MountJournal.GetMountInfoByID(mountId)
-                if isFavorite == value then
-                    toRemove[mountId] = mountId
+        local lastTickMount, tickTryMount = 0, 0
+        local tickHandler = function()
+            local mountId, shouldBeFavored = next(flippedFavorites)
+            if mountId then
+                if lastTickMount == mountId and tickTryMount >= 3 then
+                    flippedFavorites[mountId] = nil
                 else
-                    local index = ADDON.Api:MountIdToOriginalIndex(mountId)
+                    if lastTickMount == mountId then
+                        tickTryMount = tickTryMount + 1
+                    else
+                        lastTickMount = mountId
+                        tickTryMount = 1
+                    end
+
+                    local index = ADDON.Api:MountIdToOriginalIndex(mountId) -- costly call
                     if index then
-                        C_MountJournal.SetIsFavorite(index, value)
-                        break
+                        local isFavorite = C_MountJournal.GetIsFavorite(index)
+                        if isFavorite == shouldBeFavored then
+                            flippedFavorites[mountId] = nil
+                        else
+                            C_MountJournal.SetIsFavorite(index, shouldBeFavored)
+                        end
                     end
                 end
             end
-            for mountId, _ in pairs(toRemove) do
-                flippedFavorites[mountId] = nil
+
+            if TableIsEmpty(flippedFavorites) then
+                cancelBackgroundTask()
+            end
+        end
+
+        ADDON.Events:RegisterFrameEventAndCallback("MOUNT_JOURNAL_SEARCH_UPDATED", function()
+            local mountId, shouldBeFavored = next(flippedFavorites)
+            if mountId then
+                local _, _, _, _, _, _, isFavorite = C_MountJournal.GetMountInfoByID(mountId)
+                if isFavorite == shouldBeFavored then
+                    flippedFavorites[mountId] = nil
+                end
             end
 
             if TableIsEmpty(flippedFavorites) then
-                backgroundTimer:Cancel()
+                cancelBackgroundTask()
             end
-        end)
+        end, 'cleanup-favorite-background')
+
+        backgroundTimer = C_Timer.NewTicker(0.4, tickHandler)
     end
 end