mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2026-11-19 15:23:12 +09:00
Address review on the statistics plugin
The plugin is now exp_player_statistics (@expcluster/player-statistics), with the module, global, permission, route and database directory renamed to match. The exp-statistics locale section keeps its name. Every statistic is tracked unconditionally, so the enable flags are gone from config.lua. Playtime and JoinCount are no longer counted in game: clusterio already keeps online time and joins for each user, so the controller fills them in from the user when a player's totals are requested, and the web page does the same from the user list. They are not stored or adjusted by the plugin. The web table has a column picker, a multiple select with check boxes, Select all and Reset buttons, showing "N statistics selected". The choice is kept in local storage. The user page shows the statistics of the player in a grid like the core player stats. The readme statistics table drops its second title and uses the short time format. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
27456e368c
commit
ad1c83def8
37 files changed
+515
-418
No files matched your search
@@ -0,0 +1,120 @@
|
||||
local Suite = ... --- @type Suite<ExpPlayerStatistics.TestEnv>
|
||||
|
||||
Suite.test("increment() adds to the unsent statistics", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
Stats.increment(alice, "Kills")
|
||||
Stats.increment(alice, "Kills", 4)
|
||||
Suite.eq(Stats.get(alice, "Kills"), 5, "by one, then by the amount")
|
||||
Suite.eq(Stats.get("alice", "Kills"), 5, "by player name")
|
||||
Suite.eq(Stats.get(alice, "Deaths"), 0, "missing statistics are zero")
|
||||
end)
|
||||
|
||||
Suite.test("send_all() sends every player with changes in one update", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local bob = env.add_player{ name = "bob" }
|
||||
env.add_player{ name = "carol" }
|
||||
Stats.increment(alice, "Kills", 2)
|
||||
Stats.increment(bob, "Deaths")
|
||||
Stats.send_all()
|
||||
|
||||
Suite.eq(#env.sent, 1, "one update")
|
||||
Suite.eq(assert(env.sent[1]).channel, "exp_player_statistics:update", "on the update channel")
|
||||
local players = assert(env.sent[1]).data.players
|
||||
table.sort(players, function(a, b) return a.name < b.name end)
|
||||
Suite.eq(players, {
|
||||
{ name = "alice", stats = { Kills = 2 } },
|
||||
{ name = "bob", stats = { Deaths = 1 } },
|
||||
}, "players without changes are left out")
|
||||
end)
|
||||
|
||||
Suite.test("sending clears the unsent statistics but keeps the total", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
Stats.increment(alice, "Kills", 2)
|
||||
Stats.send_all()
|
||||
Suite.eq(Stats.get(alice, "Kills"), 2, "moved into the totals")
|
||||
|
||||
env.reset_log()
|
||||
Stats.send_all()
|
||||
Suite.empty(env.sent, "nothing is sent twice")
|
||||
|
||||
Stats.increment(alice, "Kills")
|
||||
Stats.send_all()
|
||||
Suite.eq(assert(env.sent[1]).data.players, { { name = "alice", stats = { Kills = 1 } } }, "only the new delta is sent")
|
||||
Suite.eq(Stats.get(alice, "Kills"), 3, "the total includes it")
|
||||
end)
|
||||
|
||||
Suite.test("send() sends one player", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local bob = env.add_player{ name = "bob" }
|
||||
Stats.increment(alice, "Kills")
|
||||
Stats.increment(bob, "Kills")
|
||||
Stats.send("alice")
|
||||
Suite.eq(env.sent, { { channel = "exp_player_statistics:update", data = { players = { { name = "alice", stats = { Kills = 1 } } } } } }, "only that player")
|
||||
|
||||
env.reset_log()
|
||||
Stats.send("carol")
|
||||
Suite.empty(env.sent, "nothing is sent for a player without changes")
|
||||
end)
|
||||
|
||||
Suite.test("receive_totals() adds the unsent statistics to the totals", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
Stats.increment(alice, "Kills", 2)
|
||||
Stats.receive_totals{ name = "alice", stats = { Kills = 10, Deaths = 1 } }
|
||||
Suite.eq(Stats.get(alice, "Kills"), 12, "received plus unsent")
|
||||
Suite.eq(Stats.get(alice, "Deaths"), 1, "received only")
|
||||
|
||||
Stats.send_all()
|
||||
Suite.eq(assert(env.sent[1]).data.players[1].stats, { Kills = 2 }, "the received totals are not sent back")
|
||||
Suite.eq(Stats.get(alice, "Kills"), 12, "the total is unchanged by sending")
|
||||
end)
|
||||
|
||||
Suite.test("receive_totals() ignores players who are not online", function(env)
|
||||
local Stats = env.Statistics
|
||||
env.add_player{ name = "bob", connected = false }
|
||||
Stats.receive_totals{ name = "bob", stats = { Kills = 10 } }
|
||||
Stats.receive_totals{ name = "nobody", stats = { Kills = 10 } }
|
||||
Suite.eq(Stats.get("bob", "Kills"), 0, "offline")
|
||||
Suite.eq(Stats.get("nobody", "Kills"), 0, "never joined")
|
||||
end)
|
||||
|
||||
Suite.test("send_and_forget() sends then drops the totals", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
Stats.receive_totals{ name = "alice", stats = { Kills = 10 } }
|
||||
Stats.increment(alice, "Kills")
|
||||
Stats.send_and_forget("alice")
|
||||
Suite.eq(assert(env.sent[1]).data.players[1].stats, { Kills = 1 }, "the unsent delta is sent")
|
||||
Suite.eq(Stats.get(alice, "Kills"), 0, "nothing is kept")
|
||||
end)
|
||||
|
||||
Suite.test("discard_unsent() drops what was not sent", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
Stats.receive_totals{ name = "alice", stats = { Kills = 10 } }
|
||||
Stats.increment(alice, "Kills")
|
||||
Stats.discard_unsent()
|
||||
Suite.eq(Stats.get(alice, "Kills"), 10, "only the totals remain")
|
||||
Stats.send_all()
|
||||
Suite.empty(env.sent, "nothing to send")
|
||||
end)
|
||||
|
||||
Suite.test("format() shows times and numbers", function(env)
|
||||
local Stats = env.Statistics
|
||||
Suite.eq(Stats.format("Playtime", 90), { "time-long", 90 }, "long time")
|
||||
Suite.eq(Stats.format("AfkTime", 90, true), { "time-short", 90 }, "short time")
|
||||
Suite.eq(Stats.format("Kills", 7), "7", "number")
|
||||
Suite.eq(Stats.units.DistanceTravelled, " tiles", "distance has a unit")
|
||||
end)
|
||||
|
||||
Suite.test("display_order lists every enabled statistic", function(env)
|
||||
local order = env.Statistics.display_order
|
||||
Suite.eq(#order, 24, "all enabled by default")
|
||||
Suite.eq(order[1], "Playtime", "in the configured order")
|
||||
end)
|
||||
|
||||
return Suite.run()
|
||||
@@ -0,0 +1,101 @@
|
||||
--[[-- Test environment for the statistics module
|
||||
Extends the shared stubs with fresh copies of module/control.lua and
|
||||
module/events.lua, stubs of the exp_util functions they use, and players with
|
||||
the fields the trackers read.
|
||||
|
||||
Run as a chunk by test/lua/runner.js, receiving the shared folder. The suite
|
||||
returned here becomes `...` in each test file.
|
||||
]]
|
||||
|
||||
local shared_root = ... --- @type string
|
||||
local source = assert(debug.getinfo(1, "S")).source:gsub("\\", "/")
|
||||
local plugin_root = assert(source:match("^@(.*)/test/module/env%.lua$"))
|
||||
|
||||
local Framework = assert(loadfile(shared_root .. "/framework.lua"))() --- @type Framework
|
||||
|
||||
--- Every event the module listens to, ids start after the shared stubs
|
||||
local event_names = {
|
||||
"on_player_left_game", "on_player_created", "on_player_changed_position",
|
||||
"on_marked_for_deconstruction", "on_player_mined_entity", "on_entity_damaged",
|
||||
"on_entity_died", "on_rocket_launched", "on_research_finished",
|
||||
"on_built_entity", "on_chart_tag_added", "on_console_chat", "on_console_command",
|
||||
"on_picked_up_item", "on_player_built_tile", "on_player_crafted_item",
|
||||
"on_player_deconstructed_area", "on_player_died", "on_player_mined_tile",
|
||||
"on_player_used_capsule", "on_player_repaired_entity",
|
||||
}
|
||||
|
||||
--- @class ExpPlayerStatistics.TestEnv : Stubs
|
||||
--- @field Statistics ExpPlayerStatistics A fresh copy of the statistics module
|
||||
--- @field handlers { events: table<number, fun(event: table)>, on_nth_tick: table<number, fun()> } From events.lua
|
||||
--- @field force fun(name: string): table A force stub with the online players added to it
|
||||
--- @field raise fun(name: string, event: table) Call the handler of an event by its name
|
||||
--- @field add_player fun(params: ExpPlayerStatistics.TestPlayerParams): ExpPlayerStatistics.TestPlayer
|
||||
|
||||
--- @class ExpPlayerStatistics.TestPlayerParams : Stubs.PlayerParams
|
||||
--- @field afk_time number? Defaults to 0
|
||||
--- @field force string? Defaults to "player"
|
||||
|
||||
--- @class ExpPlayerStatistics.TestPlayer : Stubs.Player
|
||||
--- @field afk_time number
|
||||
--- @field force table
|
||||
|
||||
return Framework.suite(function(env)
|
||||
--- @cast env ExpPlayerStatistics.TestEnv
|
||||
local events = {}
|
||||
for index, name in ipairs(event_names) do
|
||||
events[name] = 10 + index
|
||||
end
|
||||
env.extend_defines{ events = events }
|
||||
|
||||
env.extend_requires{
|
||||
["modules/exp_util"] = {
|
||||
format_time_factory_locale = function(opts)
|
||||
return function(value) return { "time-" .. opts.format, value } end
|
||||
end,
|
||||
},
|
||||
["modules/exp_util/storage"] = {
|
||||
register = function() end,
|
||||
},
|
||||
["util"] = {
|
||||
format_number = function(value) return tostring(value) end,
|
||||
},
|
||||
}
|
||||
env.extend_requires{
|
||||
["modules/exp_player_statistics/config"] = assert(loadfile(plugin_root .. "/module/config.lua"))(),
|
||||
}
|
||||
env.Statistics = assert(loadfile(plugin_root .. "/module/control.lua"))() --- @type ExpPlayerStatistics
|
||||
env.extend_requires{ ["modules/exp_player_statistics/control"] = env.Statistics }
|
||||
env.handlers = assert(loadfile(plugin_root .. "/module/events.lua"))()
|
||||
|
||||
local forces = {}
|
||||
function env.force(name)
|
||||
local force = forces[name]
|
||||
if not force then
|
||||
force = { name = name, valid = true, connected_players = {} }
|
||||
forces[name] = force
|
||||
end
|
||||
return force
|
||||
end
|
||||
|
||||
local add_player = env.add_player
|
||||
function env.add_player(params)
|
||||
local player = add_player(params) --[[@as ExpPlayerStatistics.TestPlayer]]
|
||||
local force = env.force(params.force or "player")
|
||||
rawset(player, "afk_time", params.afk_time or 0)
|
||||
rawset(player, "force", force)
|
||||
rawset(player, "object_name", "LuaPlayer")
|
||||
if player.connected then
|
||||
force.connected_players[#force.connected_players + 1] = player
|
||||
end
|
||||
return player
|
||||
end
|
||||
|
||||
function env.raise(name, event)
|
||||
local id = (defines.events --[[@as table<string, number>]])[name]
|
||||
local handler = env.handlers.events[id]
|
||||
assert(handler, "no handler for " .. name)
|
||||
handler(event)
|
||||
end
|
||||
|
||||
return env
|
||||
end)
|
||||
@@ -0,0 +1,133 @@
|
||||
local Suite = ... --- @type Suite<ExpPlayerStatistics.TestEnv>
|
||||
|
||||
Suite.test("counters go up by one for online players", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local bob = env.add_player{ name = "bob", connected = false }
|
||||
env.raise("on_console_chat", { player_index = alice.index })
|
||||
env.raise("on_console_chat", { player_index = alice.index })
|
||||
env.raise("on_player_died", { player_index = alice.index })
|
||||
env.raise("on_console_chat", { player_index = bob.index })
|
||||
env.raise("on_console_chat", {})
|
||||
|
||||
Suite.eq(Stats.get(alice, "ChatMessages"), 2, "chat")
|
||||
Suite.eq(Stats.get(alice, "Deaths"), 1, "deaths")
|
||||
Suite.eq(Stats.get(bob, "ChatMessages"), 0, "offline players are skipped")
|
||||
end)
|
||||
|
||||
Suite.test("a player is counted once per map", function(env)
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
env.raise("on_player_created", { player_index = alice.index })
|
||||
Suite.eq(env.Statistics.get(alice, "MapsPlayed"), 1, "maps played")
|
||||
end)
|
||||
|
||||
Suite.test("afk time goes up each minute, playtime comes from clusterio", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local bob = env.add_player{ name = "bob", afk_time = 6 * 3600 }
|
||||
local tick = env.handlers.on_nth_tick[3600]
|
||||
game.tick = 3600
|
||||
tick()
|
||||
tick()
|
||||
|
||||
Suite.eq(Stats.get(alice, "Playtime"), 0, "playtime is not counted")
|
||||
Suite.eq(Stats.get(alice, "AfkTime"), 0, "not afk")
|
||||
Suite.eq(Stats.get(bob, "AfkTime"), 2, "afk")
|
||||
end)
|
||||
|
||||
Suite.test("distance is not counted while afk", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local bob = env.add_player{ name = "bob", afk_time = 6 * 3600 }
|
||||
env.raise("on_player_changed_position", { player_index = alice.index })
|
||||
env.raise("on_player_changed_position", { player_index = bob.index })
|
||||
Suite.eq(Stats.get(alice, "DistanceTravelled"), 1, "moving")
|
||||
Suite.eq(Stats.get(bob, "DistanceTravelled"), 0, "afk")
|
||||
end)
|
||||
|
||||
Suite.test("removed entities count as ore, trees or machines", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local function entity(type, force)
|
||||
return { valid = true, type = type, force = force or env.force("neutral") }
|
||||
end
|
||||
env.raise("on_player_mined_entity", { player_index = alice.index, entity = entity("resource") })
|
||||
env.raise("on_marked_for_deconstruction", { player_index = alice.index, entity = entity("tree") })
|
||||
env.raise("on_player_mined_entity", { player_index = alice.index, entity = entity("assembling-machine", alice.force) })
|
||||
env.raise("on_player_mined_entity", { player_index = alice.index, entity = entity("assembling-machine", env.force("enemy")) })
|
||||
env.raise("on_marked_for_deconstruction", { entity = entity("tree") })
|
||||
|
||||
Suite.eq(Stats.get(alice, "OreMined"), 1, "ore")
|
||||
Suite.eq(Stats.get(alice, "TreesDestroyed"), 1, "trees, by players only")
|
||||
Suite.eq(Stats.get(alice, "MachinesRemoved"), 1, "own force only")
|
||||
end)
|
||||
|
||||
Suite.test("damage and kills count against hostile entities", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local character = { valid = true, type = "character", object_name = "LuaEntity", player = alice }
|
||||
local enemy = { valid = true, force = env.force("enemy") }
|
||||
local ally = { valid = true, force = alice.force }
|
||||
env.raise("on_entity_damaged", { cause = character, entity = enemy, final_damage_amount = 12.7 })
|
||||
env.raise("on_entity_damaged", { cause = character, entity = ally, final_damage_amount = 5 })
|
||||
env.raise("on_entity_died", { cause = character, entity = enemy })
|
||||
env.raise("on_entity_died", { entity = enemy })
|
||||
|
||||
Suite.eq(Stats.get(alice, "DamageDealt"), 12, "damage is floored, allies are skipped")
|
||||
Suite.eq(Stats.get(alice, "Kills"), 1, "kills without a cause are skipped")
|
||||
end)
|
||||
|
||||
Suite.test("vehicles credit their driver", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local enemy = { valid = true, force = env.force("enemy") }
|
||||
local car = {
|
||||
valid = true, type = "car",
|
||||
get_driver = function() return alice end,
|
||||
get_passenger = function() return nil end,
|
||||
}
|
||||
local empty_train = {
|
||||
valid = true, type = "locomotive",
|
||||
get_driver = function() return nil end,
|
||||
get_passenger = function() return nil end,
|
||||
}
|
||||
env.raise("on_entity_died", { cause = car, entity = enemy })
|
||||
env.raise("on_entity_died", { cause = empty_train, entity = enemy })
|
||||
Suite.eq(Stats.get(alice, "Kills"), 1, "the driver, not the empty train")
|
||||
end)
|
||||
|
||||
Suite.test("rockets and research count for every online player on the force", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local bob = env.add_player{ name = "bob" }
|
||||
local carol = env.add_player{ name = "carol", force = "other" }
|
||||
env.raise("on_rocket_launched", { rocket_silo = { valid = true, force = alice.force } })
|
||||
env.raise("on_research_finished", { research = { valid = true, force = alice.force } })
|
||||
env.raise("on_research_finished", { by_script = true, research = { valid = true, force = alice.force } })
|
||||
|
||||
Suite.eq({ Stats.get(alice, "RocketsLaunched"), Stats.get(bob, "RocketsLaunched") }, { 1, 1 }, "rockets")
|
||||
Suite.eq(Stats.get(alice, "ResearchCompleted"), 1, "research by script is skipped")
|
||||
Suite.eq(Stats.get(carol, "RocketsLaunched"), 0, "other forces are skipped")
|
||||
end)
|
||||
|
||||
Suite.test("leaving sends the player and forgets them", function(env)
|
||||
local Stats = env.Statistics
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
local bob = env.add_player{ name = "bob" }
|
||||
Stats.increment(alice, "Kills")
|
||||
Stats.increment(bob, "Kills")
|
||||
env.raise("on_player_left_game", { player_index = alice.index })
|
||||
|
||||
Suite.eq(assert(env.sent[1]).data.players, { { name = "alice", stats = { Kills = 1 } } }, "only the player leaving")
|
||||
Suite.eq(Stats.get(alice, "Kills"), 0, "forgotten")
|
||||
Suite.eq(Stats.get(bob, "Kills"), 1, "others are kept")
|
||||
end)
|
||||
|
||||
Suite.test("everyone is sent every 5 minutes", function(env)
|
||||
local alice = env.add_player{ name = "alice" }
|
||||
env.Statistics.increment(alice, "Kills")
|
||||
env.handlers.on_nth_tick[5 * 3600]()
|
||||
Suite.eq(#env.sent, 1, "one update")
|
||||
end)
|
||||
|
||||
return Suite.run()
|
||||
Reference in new issue
Block a user