refactor: cleanup match ticker step 3

lua/wikis/commons/MatchTicker/Controller.lua

@@ -1,3 +1,3 @@
 ---
 -- @Liquipedia
 -- page=Module:MatchTicker/Controller
@@ -12,7 +12,6 @@
 local Game = Lua.import('Module:Game')
 local Logic = Lua.import('Module:Logic')
 local Lpdb = Lua.import('Module:Lpdb')
-local Operator = Lua.import('Module:Operator')
 local String = Lua.import('Module:StringUtils')
 local Table = Lua.import('Module:Table')
 local TeamTemplate = Lua.import('Module:TeamTemplate')
@@ -32,7 +31,7 @@
 local BooleanOperator = Condition.BooleanOperator
 local ColumnName = Condition.ColumnName
 
-local DEFAULT_QUERY_COLUMNS = {
+local QUERY_COLUMNS = {
 	'match2opponents',
 	'winner',
 	'pagename',
@@ -72,7 +71,6 @@
 ---@field player string?
 ---@field teamPages string[]?
 ---@field hideTournament boolean
----@field queryColumns string[]
 ---@field additionalConditions string
 ---@field recent boolean
 ---@field upcoming boolean
@@ -94,7 +92,6 @@
 ---@field header Renderable?
 
 ---@class MatchTickerGameData
----@field asGame boolean?
 ---@field gameIds number[]
 ---@field map string?
 ---@field mapDisplayName string?
@@ -133,7 +130,6 @@
 		limit = tonumber(args.limit) or DEFAULT_LIMIT,
 		order = args.order or (Logic.readBool(args.recent) and DEFAULT_RECENT_ORDER or DEFAULT_ORDER),
 		player = args.player and mw.ext.TeamLiquidIntegration.resolve_redirect(args.player):gsub(' ', '_') or nil,
-		queryColumns = args.queryColumns or DEFAULT_QUERY_COLUMNS,
 		additionalConditions = args.additionalConditions or '',
 		recent = Logic.readBool(args.recent),
 		upcoming = Logic.readBool(args.upcoming),
@@ -208,22 +204,27 @@
 ---queries the matches and filters them for unwanted ones
 ---@private
 ---@param config MatchTickerConfig
----@return table[]
+---@return {match: MatchGroupUtilMatch, gameData: MatchTickerGameData?}[]
 function MatchTickerController.fetchMatches(config)
+	local shouldFetchTournamentData = config.regions or config.featuredOnly
 	local matches = {}
 	Lpdb.executeMassQuery('match2',
 		{
 			conditions = MatchTickerController.buildQueryConditions(config),
 			order = config.order,
-			query = table.concat(config.queryColumns, ','),
+			query = table.concat(QUERY_COLUMNS, ','),
 			limit = DEFAULT_LIMIT,
 		},
 		function(record)
-			record = MatchTickerController.parseMatch(record, config)
-			if not MatchTickerController.keepMatch(record, config) then
+			local parsedMatch = MatchGroupUtil.matchFromRecord(record)
+			local tournamentData
+			if shouldFetchTournamentData then
+				tournamentData = MatchTickerController.fetchTournament(parsedMatch.parent)
+			end
+			if not MatchTickerController.keepMatch(parsedMatch, tournamentData, config) then
 				return
 			end
-			for _, match in ipairs(MatchTickerController.expandGamesOfMatch(record, config)) do
+			for _, match in ipairs(MatchTickerController.expandGamesOfMatch(parsedMatch, config)) do
 				table.insert(matches, match)
 			end
 			if #matches >= config.limit then
@@ -237,9 +238,9 @@
 		return {}
 	end
 
-	matches = MatchTickerController.sortMatches(matches, config)
+	MatchTickerController.sortMatches(matches, config)
 	matches = Array.sub(matches, 1, config.limit)
-	matches = Array.map(matches, function(match) return MatchTickerController.adjustMatch(match, config) end)
+	Array.forEach(matches, function(match) return MatchTickerController.adjustMatch(match, config) end)
 
 	return matches
 end
@@ -358,41 +359,28 @@
 	return dateConditions:add{ConditionNode(ColumnName('date'), Comparator.gt, NOW)}
 end
 
----@private
----@param match table
----@param config MatchTickerConfig
----@return table
-function MatchTickerController.parseMatch(match, config)
-	match.opponents = Array.map(match.match2opponents, function(opponent, opponentIndex)
-		return MatchGroupUtil.opponentFromRecord(match, opponent, opponentIndex)
-	end)
-	if config.regions or config.featuredOnly then
-		match.tournamentData = MatchTickerController.fetchTournament(match.parent)
-	end
-	return match
-end
-
 local previousMatchWasTbd = false
 ---@private
----@param match table
+---@param match MatchGroupUtilMatch
+---@param tournamentData StandardTournament?
 ---@param config MatchTickerConfig
 ---@return boolean
-function MatchTickerController.keepMatch(match, config)
+function MatchTickerController.keepMatch(match, tournamentData, config)
 	if match.extradata and match.extradata.hidden then
 		return false
 	end
 	-- Remove matches with wrong region
 	if config.regions then
-		if not match.tournamentData then
+		if not tournamentData then
 			return false
 		end
-		if not Table.includes(config.regions, match.tournamentData.region) then
+		if not Table.includes(config.regions, tournamentData.region) then
 			return false
 		end
 	end
 
 	if config.featuredOnly then
-		local matchIsInFeaturedTournament = match.tournamentData and match.tournamentData.featured
+		local matchIsInFeaturedTournament = tournamentData and tournamentData.featured
 		local matchIsFeatured = match.extradata and match.extradata.featured
 		if not matchIsInFeaturedTournament and not matchIsFeatured then
 			return false
@@ -418,19 +406,20 @@
 end
 
 ---@private
----@param match table
+---@param match MatchGroupUtilMatch
 ---@param config MatchTickerConfig
----@return table[]
+---@return {match: MatchGroupUtilMatch, gameData: MatchTickerGameData?}[]
 function MatchTickerController.expandGamesOfMatch(match, config)
-	if not match.match2games or #match.match2games < 2 then
-		return {match}
+	if not match.games or #match.games < 2 then
+		return {{match = match}}
 	end
 
-	if Array.all(match.match2games, function(game) return game.date == match.date end) then
-		return {match}
+	if Array.all(match.games, function(game) return game.date == match.date end) then
+		return {{match = match}}
 	end
 
-	local expandedGames = Array.map(match.match2games, function(game, gameIndex)
+	---@type {match: MatchGroupUtilMatch, gameData: MatchTickerGameData?}[]
+	local expandedGames = Array.map(match.games, function(game, gameIndex)
 		if config.recent and Logic.isEmpty(game.winner) then
 			return
 		end
@@ -448,93 +437,94 @@
 		end
 
 		local gameMatch = Table.copy(match)
-		gameMatch.match2games = {}
-		gameMatch.asGame = true
-		gameMatch.asGameIndexes = {gameIndex}
+		gameMatch.games = {}
 
 		gameMatch.winner = game.winner
 		gameMatch.date = game.date
-		gameMatch.map = game.map
 		gameMatch.vod = Logic.nilIfEmpty(game.vod) or match.vod
-		gameMatch.opponents = Array.map(match.match2opponents, function(opponent, opponentIndex)
+		gameMatch.opponents = Array.map(match.opponents, function(opponent, opponentIndex)
 			return MatchUtil.enrichGameOpponentFromMatchOpponent(opponent, game.opponents[opponentIndex])
 		end)
-		gameMatch.match2opponents = gameMatch.opponents
 		gameMatch.extradata = Table.merge(gameMatch.extradata, game.extradata)
-		return gameMatch
+		---@type MatchTickerGameData
+		local gameData = {
+			gameIds = {gameIndex},
+			map = game.map,
+			mapDisplayName = game.extradata and game.extradata.displayname
+		}
+		return {match = gameMatch, gameData = gameData}
 	end)
 
-	return Array.map(Array.groupAdjacentBy(expandedGames, Operator.property('date')), function (gameGroup)
-		if #gameGroup > 1 then
-			local lastIndexes = gameGroup[#gameGroup].asGameIndexes
-			table.insert(gameGroup[1].asGameIndexes, lastIndexes[#lastIndexes])
-		end
+	return Array.map(
+		Array.groupAdjacentBy(
+			expandedGames,
+			function(gameAsMatch) return gameAsMatch.match.date end
+		),
+		function (gameGroup)
+			if #gameGroup > 1 then
+				local lastIds = gameGroup[#gameGroup].gameData.gameIds
+				table.insert(gameGroup[1].gameData.gameIds, lastIds[#lastIds])
+			end
 
-		return gameGroup[1]
-	end)
+			return {match = gameGroup[1].match, gameData = gameGroup[1].gameData}
+		end
+	)
 end
 
 ---@private
----@param matches table[]
+---@param matches {match: MatchGroupUtilMatch, gameData: MatchTickerGameData?}[]
 ---@param config MatchTickerConfig
----@return table[]
 function MatchTickerController.sortMatches(matches, config)
 	local reverse = config.recent and true or false
-	return Array.sortBy(matches, FnUtil.identity, function (a, b)
-		if a.date ~= b.date then
+	Array.sortInPlaceBy(matches, FnUtil.identity, function (a, b)
+		local aDate, bDate = a.match.date, b.match.date
+		if aDate ~= bDate then
 			if reverse then
-				return a.date > b.date
+				return aDate > bDate
 			end
-			return b.date > a.date
+			return bDate > aDate
 		end
-		if a.match2id ~= b.match2id then
-			return a.match2id < b.match2id
+		if a.match.matchId ~= b.match.matchId then
+			return a.match.matchId < b.match.matchId
 		end
-		return ((a.asGameIndexes or {})[1] or 0) < ((b.asGameIndexes or {})[1] or 0)
+		return (((a.gameData or {}).gameIds or {})[1] or 0) < (((b.gameData or {}).gameIds or {})[1] or 0)
 	end)
 end
 
 --- Will only switch if enteredOpponentOnLeft is enabled AND there are exactly 2 opponents
 ---@private
----@param match table
+---@param match {match: MatchGroupUtilMatch, gameData: MatchTickerGameData?}
 ---@param config MatchTickerConfig
----@return table
 function MatchTickerController.adjustMatch(match, config)
-	if not config.enteredOpponentOnLeft or #match.opponents ~= 2 then
-		return match
+	if not config.enteredOpponentOnLeft or #match.match.opponents ~= 2 then
+		return
 	end
 
 	local opponentNames = Array.extend({config.player}, config.teamPages)
 	if
 		--check for the name value
-		Table.includes(opponentNames, ((match.opponents[2].name or ''):gsub(' ', '_')))
+		Table.includes(opponentNames, ((match.match.opponents[2].name or ''):gsub(' ', '_')))
 		--check inside match2players too for the player value
-		or config.player and Table.any(match.opponents[2].players, function(_, playerData)
+		or config.player and Table.any(match.match.opponents[2].players, function(_, playerData)
 			return (playerData.pageName or ''):gsub(' ', '_') == config.player end)
 	then
-		return MatchTickerController.switchOpponents(match)
+		MatchTickerController.switchOpponents(match)
 	end
-
-	return match
 end
 
 --- Will only switch if there are exactly 2 opponents
 ---@private
----@param match table
----@return table
+---@param match {match: MatchGroupUtilMatch, gameData: MatchTickerGameData?}
 function MatchTickerController.switchOpponents(match)
-	if #match.opponents ~= 2 then
-		return match
+	if #match.match.opponents ~= 2 then
+		return
 	end
-	local winner = tonumber(match.winner) or 0
-	match.winner = winner == 1 and 2
+	local winner = tonumber(match.match.winner) or 0
+	match.match.winner = winner == 1 and 2
 		or winner == 2 and 1
-		or match.winner
-
-	match.match2opponents[1], match.match2opponents[2] = match.match2opponents[2], match.match2opponents[1]
-	match.opponents[1], match.opponents[2] = match.opponents[2], match.opponents[1]
+		or match.match.winner
 
-	return match
+	match.match.opponents[1], match.match.opponents[2] = match.match.opponents[2], match.match.opponents[1]
 end
 
 --- Fetches region of a tournament

lua/wikis/commons/Widget/Match/Ticker/Wrapper.lua

@@ -9,13 +9,13 @@ local Lua = require('Module:Lua')
 
 local Array = Lua.import('Module:Array')
 local Component = Lua.import('Module:Widget/Component')
-local MatchGroupUtil = Lua.import('Module:MatchGroup/Util/Custom')
 
 local Html = Lua.import('Module:Widget/Html')
 local MatchCard = Lua.import('Module:Widget/Match/Card')
 local HorizontalContainer = Lua.import('Module:Widget/Match/Ticker/HorizontalContainer')
 
----@param props {matches: table[], header: Renderable?, showInfoForEmptyResults: boolean, wrapperClasses: string[],
+---@param props {matches: {match: MatchGroupUtilMatch, gameData: MatchTickerGameData?}[],
+---header: Renderable?, showInfoForEmptyResults: boolean, wrapperClasses: string[],
 ---hideTournament: boolean, displayGameIcons: boolean, onlyHighlightOnValue: string?, variant: 'vertical'|'horizontal'}
 ---@return Renderable?
 local function MatchTickerWrapper(props)
@@ -36,17 +36,12 @@ local function MatchTickerWrapper(props)
 
 	local matchCards = Array.map(matches, function(match)
 		return MatchCard{
-			match = MatchGroupUtil.matchFromRecord(match),
+			match = match.match,
 			hideTournament = props.hideTournament,
 			displayGameIcons = props.displayGameIcons,
 			onlyHighlightOnValue = props.onlyHighlightOnValue,
 			variant = props.variant == 'horizontal' and 'vertical' or nil,
-			gameData = {
-				asGame = match.asGame,
-				gameIds = match.asGameIndexes,
-				map = match.map,
-				mapDisplayName = match.extradata and match.extradata.displayname or nil
-			}
+			gameData = match.gameData
 		}
 	end)