Add support for generic player chat commands (trigger words) #427

cemathey · 2023-12-27T17:34:01Z

Add generic player chat commands (trigger words)
Add a cache (MostRecentEvents) that is updated every kill or team kill
Refactored scorebot/scoreboard stuff a little bit to use their types/lookups elsewhere
Adds a discord_invite_url option to RconServerSettingsType
Updates the webhook user configs to return a sorted list of admin ping words to guarantee the order when running tests
Adds SafeStringFormat a subclass of dict that will accept any formatted string and replace missing keys with the key itself to avoid exceptions when using "".format_map()"

This supports two types of information, info we can get from anywhere in the RCON without any extra details (server name, etc.) and info that is only available depending on the context. This is represented by two types (MessageVariable and MessageVariableContext).

It does pass in the steam_id_64 when used in rcon.hooks.trigger_words since the chatting players steam ID is always available and allows us to look up VIP status, etc.

Users can add as many commands/command formats as they want, but they can only add {variable} style variables if they're either in the MessageVariable or MessageVariableContext enums to avoid typos, etc.

This does require some more work to support the rest of the scoreboard types, and if this is an acceptable way to do this, we could use this across the board in other places in RCON (automods, etc.) to allow people more options when automatically messaging players.

We can also use this to add end of round stuff for #392

add recent_actions

Add dataclass "MostRecentsEvents"

Add recent_actions.py

in progress...

wip

…-config-version)

ElGuillermo · 2023-12-27T18:50:27Z

Seems quite good for me, but I'd prefer FlorianSW to approve this one.

FlorianSW

Didn't look that much into the other parts from what I commented. But first let us sort out my comments, please :)

FlorianSW · 2024-01-13T19:14:27Z

rconweb/api/user_settings.py

@@ -2474,6 +2474,85 @@ def set_watchlist_discord_webhooks_config(request):
    )


+@csrf_exempt
+@login_required()
+# TODO permission


is this going to be added in this PR?

Whoops, yeah I need to add that, good catch.

tests/test_message_variables.py

FlorianSW · 2024-01-13T21:32:28Z

tests/test_message_variables.py

+            ),
+            "1234",
+            MostRecentEvents(
+                last_victim_name="some guy", last_victim_weapon="some weapon"


last_victim_name does not exist on MostRecentEvents? 🤔

Out of date from when I had them merged, then split them for reduced cache size, but we decided to put them back for ease of use.

FlorianSW · 2024-01-13T21:35:44Z

tests/test_message_variables.py

+    monkeypatch.setattr(
+        rcon.hooks,
+        "get_recent_actions",
+        lambda x: {steam_id_64: recent_event},


Shouldn't it be:

lambda: {steam_id_64: recent_event},

? (without the x argument)

Yeah whoops, this was out of date from before I split the cache into two calls, one to set and one to get.

FlorianSW · 2024-01-13T21:54:00Z

rcon/hooks.py

@@ -76,6 +89,97 @@ def initialise_vote_map(rcon: Rcon, struct_log):
        logger.exception("Something went wrong in vote map init")


+@on_chat


It's really hard for me to get through this code, tbh :D First of all: Searching for all these cache entries for the victim and nemesis seems unneeded and actually wrong, as all required information is already available through the player_1_cache entry, if I'm not mistaken.

I walked through the code locally and running the tests revealed them being red as well. My suggested code seems to work (at least the tests are green and I'm pretty sure it is doing what it is supposed to do based on my understanding of the code):

Suggested change

@on_chat

@on_chat

def trigger_words(rcon: Rcon, struct_log: StructuredLogLineType):

config = TriggerWordsUserConfig.load_from_db()

if not config.enabled:

logger.debug("Trigger words are disabled")

return

chat_message = struct_log["sub_content"]

if chat_message is None:

return

event_cache = get_recent_actions()

steam_id_64: str = struct_log["steam_id_64_1"]

if steam_id_64 is None:

return

player_1_cache = event_cache.get(steam_id_64, MostRecentEvents())

chat_words = set(re.split(CHAT_WORDS_RE, chat_message))

for trigger in config.trigger_words:

if not (

triggered := contains_triggering_word(chat_words, trigger.words)

) and not contains_triggering_word(chat_words, config.describe_words):

continue

if triggered:

message_vars: list[str] = re.findall(MESSAGE_VAR_RE, trigger.message)

populated_variables = populate_message_variables(

vars=message_vars, steam_id_64=steam_id_64

)

formatted_message = format_message_string(

trigger.message,

populated_variables=populated_variables,

context={

MessageVariableContext.player_name.value: struct_log["player"],

MessageVariableContext.player_steam_id_64.value: steam_id_64,

MessageVariableContext.last_victim_steam_id_64.value: player_1_cache.last_victim_steam_id_64,

MessageVariableContext.last_victim_name.value: player_1_cache.last_victim_name,

MessageVariableContext.last_victim_weapon.value: player_1_cache.last_victim_weapon,

MessageVariableContext.last_nemesis_steam_id_64.value: player_1_cache.last_nemesis_steam_id_64,

MessageVariableContext.last_nemesis_name.value: player_1_cache.last_nemesis_name,

MessageVariableContext.last_nemesis_weapon.value: player_1_cache.last_nemesis_weapon,

MessageVariableContext.last_tk_nemesis_steam_id_64.value: player_1_cache.last_tk_nemesis_steam_id_64,

MessageVariableContext.last_tk_nemesis_name.value: player_1_cache.last_tk_nemesis_name,

MessageVariableContext.last_tk_nemesis_weapon.value: player_1_cache.last_tk_nemesis_weapon,

MessageVariableContext.last_tk_victim_steam_id_64.value: player_1_cache.last_tk_victim_steam_id_64,

MessageVariableContext.last_tk_victim_name.value: player_1_cache.last_tk_nemesis_name,

MessageVariableContext.last_tk_victim_weapon.value: player_1_cache.last_tk_victim_weapon,

},

)

rcon.do_message_player(

steam_id_64=struct_log["steam_id_64_1"],

message=formatted_message,

save_message=False,

)

else:

description = config.describe_trigger_words()

if description:

rcon.do_message_player(

steam_id_64=struct_log["steam_id_64_1"],

message="\n".join(description),

save_message=False,

)

else:

logger.warning(

"No descriptions set for trigger words, %s",

", ".join(config.describe_words),

)

FlorianSW · 2024-01-13T21:54:51Z

rcon/types.py

+
+
+@dataclass
+class MostRecentEvents:


The following fields seem to be missing? 🤔

last_victim_name last_nemesis_name last_tk_victim_name last_tk_nemesis_name

?

FlorianSW · 2024-01-13T22:02:40Z

rcon/hooks.py

+        else MostRecentEvents()
+    )
+
+    chat_words = set(re.split(CHAT_WORDS_RE, chat_message))


The second thing I have trouble to understand, tbh 😅
I think the only reason of this code is to separate words based to be able to look for trigger words, right? What I don't get is: Why would we separate !who-killed-me to ["!who", "killed", "me"]? Shouldn't it be one entry in the array as the whole group of words? Like only splitting by spaces? It would be as simple as:

chat_words = chat_message.split(' ')

After all: why would you need to split the chat words at all? Wouldn't a simple "contains" for the trigger.words be sufficient? 🤔

…-config-version)

cemathey · 2024-01-17T05:03:40Z

Okay I:

Added the player names back into the cache so it's easier to use
Expanded/updated the tests
Renamed everything so that these are command words instead of trigger words, it's more descriptive and it won't conflict with names if we add a generic BM style trigger system later
Forced commands to be limited to ! and @ prefixes only
Set ? as the prefix to trigger the description of a command
Set the recent player actions (kills, etc.) cache to be reset on match start
Updated the recent player actions cache TTL to 2.5 hours since that's the longest possible HLL match currently
Forced the player cache to update the redis cache when it's set so it's available in other Python interpreter instances
Added the permissions for the endpoints

FlorianSW · 2024-01-22T17:55:45Z

rcon/recent_actions.py


    set_recent_actions(cached_actions)
+    # Refresh the redis cache so it's available for interprocess communication
+    get_recent_actions()


Sounds like premature optimization to me :D But it's ok.

It's actually required if any other process wants to be able to pull it out of the redis cache, it clears on setting, and any other process that was to call it would just get back a totally empty one.

I don't know if we even want it available in any other process, but if another service wants those values for any reason it has to be done like this (or persisted to the database)

FlorianSW · 2024-01-22T17:57:36Z

Looks good :) Feel free to merge after the conflicts are resolved 🤗

…-config-version)

ElGuillermo and others added 26 commits November 29, 2023 17:04

Update __init__.py

ad37f01

add recent_actions

Update types.py

4837454

Add dataclass "MostRecentsEvents"

Add files via upload

0f891d4

Add recent_actions.py

Create trigger_words.py

bc3a697

in progress...

Update trigger_words.py

7c19411

Update trigger_words.py

d7f6206

Update hooks.py

fab5357

wip

Fix syntax error

757af9d

Update trigger words user config

6d955b2

Expose trigger word URLs

b3a62ec

Add generic chat trigger implementation

4b8ec4a

Log when SafeStringFormat is called with a misisng key

d3ed834

Add more score variables

5648d32

Merge branch 'master' into Feature---Custom-trigger-words-in-chat-(UI…

0fb40b2

…-config-version)

Fix most recent events

cbef920

Validate message variables properly

5d12a17

Merge branch 'master' into Feature---Custom-trigger-words-in-chat-(UI…

4bae470

…-config-version)

Split recent action cache into get/set methods

28936a9

Fix scorebot

2abeb7c

Update notes

319deb1

Add help commands to describe trigger words

074a06f

Add VIP info

89d1d31

Remove redundant cached info

4457302

Move config check to be the first check

7c8f57b

Remove completed TODO

253a257

Move config check to be the first check

e8e20eb

cemathey requested review from FlorianSW and ElGuillermo December 27, 2023 17:34

FlorianSW requested changes Jan 13, 2024

View reviewed changes

cemathey added 12 commits January 16, 2024 11:15

Fix tests

12a7903

Include player names in cache again

5379799

Add permissions

1d0644c

Merge branch 'master' into Feature---Custom-trigger-words-in-chat-(UI…

d630513

…-config-version)

Add permission migration

9100b96

get_rcon was added upstream

a44fb6b

Adjust cache time, reset on match start

767e47d

Update redis when cache updated

dfb9d4e

Return player names to cache, add tests, refactor word detection

b393c1a

Rename to chat commands for clarity

49844c2

Add documentation

d414541

More renaming

918e3af

FlorianSW approved these changes Jan 22, 2024

View reviewed changes

cemathey added 2 commits January 22, 2024 12:52

Merge branch 'master' into Feature---Custom-trigger-words-in-chat-(UI…

7493771

…-config-version)

Fix link

e87ff68

cemathey merged commit a272dbc into master Jan 22, 2024

cemathey deleted the Feature---Custom-trigger-words-in-chat-(UI-config-version) branch January 22, 2024 20:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for generic player chat commands (trigger words) #427

Add support for generic player chat commands (trigger words) #427

cemathey commented Dec 27, 2023

ElGuillermo commented Dec 27, 2023

FlorianSW left a comment

FlorianSW Jan 13, 2024

cemathey Jan 14, 2024

FlorianSW Jan 13, 2024

cemathey Jan 16, 2024

FlorianSW Jan 13, 2024

cemathey Jan 16, 2024

FlorianSW Jan 13, 2024

FlorianSW Jan 13, 2024

FlorianSW Jan 13, 2024

cemathey commented Jan 17, 2024

FlorianSW Jan 22, 2024

cemathey Jan 22, 2024

FlorianSW commented Jan 22, 2024

		@@ -76,6 +89,97 @@ def initialise_vote_map(rcon: Rcon, struct_log):
		logger.exception("Something went wrong in vote map init")


		@on_chat

-@on_chat
+@on_chat
+def trigger_words(rcon: Rcon, struct_log: StructuredLogLineType):
+    config = TriggerWordsUserConfig.load_from_db()
+    if not config.enabled:
+        logger.debug("Trigger words are disabled")
+        return
+    chat_message = struct_log["sub_content"]
+    if chat_message is None:
+        return
+    event_cache = get_recent_actions()
+    steam_id_64: str = struct_log["steam_id_64_1"]
+    if steam_id_64 is None:
+        return
+    player_1_cache = event_cache.get(steam_id_64, MostRecentEvents())
+    chat_words = set(re.split(CHAT_WORDS_RE, chat_message))
+    for trigger in config.trigger_words:
+        if not (
+            triggered := contains_triggering_word(chat_words, trigger.words)
+        ) and not contains_triggering_word(chat_words, config.describe_words):
+            continue
+        if triggered:
+            message_vars: list[str] = re.findall(MESSAGE_VAR_RE, trigger.message)
+            populated_variables = populate_message_variables(
+                vars=message_vars, steam_id_64=steam_id_64
+            )
+            formatted_message = format_message_string(
+                trigger.message,
+                populated_variables=populated_variables,
+                context={
+                    MessageVariableContext.player_name.value: struct_log["player"],
+                    MessageVariableContext.player_steam_id_64.value: steam_id_64,
+                    MessageVariableContext.last_victim_steam_id_64.value: player_1_cache.last_victim_steam_id_64,
+                    MessageVariableContext.last_victim_name.value: player_1_cache.last_victim_name,
+                    MessageVariableContext.last_victim_weapon.value: player_1_cache.last_victim_weapon,
+                    MessageVariableContext.last_nemesis_steam_id_64.value: player_1_cache.last_nemesis_steam_id_64,
+                    MessageVariableContext.last_nemesis_name.value: player_1_cache.last_nemesis_name,
+                    MessageVariableContext.last_nemesis_weapon.value: player_1_cache.last_nemesis_weapon,
+                    MessageVariableContext.last_tk_nemesis_steam_id_64.value: player_1_cache.last_tk_nemesis_steam_id_64,
+                    MessageVariableContext.last_tk_nemesis_name.value: player_1_cache.last_tk_nemesis_name,
+                    MessageVariableContext.last_tk_nemesis_weapon.value: player_1_cache.last_tk_nemesis_weapon,
+                    MessageVariableContext.last_tk_victim_steam_id_64.value: player_1_cache.last_tk_victim_steam_id_64,
+                    MessageVariableContext.last_tk_victim_name.value: player_1_cache.last_tk_nemesis_name,
+                    MessageVariableContext.last_tk_victim_weapon.value: player_1_cache.last_tk_victim_weapon,
+                },
+            )
+            rcon.do_message_player(
+                steam_id_64=struct_log["steam_id_64_1"],
+                message=formatted_message,
+                save_message=False,
+            )
+        else:
+            description = config.describe_trigger_words()
+            if description:
+                rcon.do_message_player(
+                    steam_id_64=struct_log["steam_id_64_1"],
+                    message="\n".join(description),
+                    save_message=False,
+                )
+            else:
+                logger.warning(
+                    "No descriptions set for trigger words, %s",
+                    ", ".join(config.describe_words),
+                )



		@dataclass
		class MostRecentEvents:

Add support for generic player chat commands (trigger words) #427

Add support for generic player chat commands (trigger words) #427

Conversation

cemathey commented Dec 27, 2023

ElGuillermo commented Dec 27, 2023

FlorianSW left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cemathey commented Jan 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FlorianSW commented Jan 22, 2024