Logging: Track logged messages

[ithinkandicode]

In #138 I added the array variable logged_messages. I think this is a potentially very useful approach that could be applied it to all logged messages.

Implementation:

• In _loader_log, we save logged messages to an array.
  • This is the same as what I did for feat: ✨ Config JSON: Only log notice for no custom JSON once #138,
  • but with the array variable being in ModLoaderUtils instead.
• For each message, we can track all the data parts that are passed as variables to _loader_log
  • Ie. mod name, message, and type.
  • Actually, it might be better as a dictionary, with these keys:
    • all = All logged messages
    • by_mod = Notices logged via a certain mod
    • by_type = Notices of a specific type

API Methods:

• get_tracked_messages_all()
• get_tracked_messages_by_mod(mod_name: String)
• get_tracked_messages_by_type(type: String) -- where type is one of the current log types (fatal-error, error, etc)

Use Case:

This would be a massive help to players who are using mods, as it would save them needing to check the logs (and save them needing to know how to do that). This does depend on the game or a mod presenting this data, but this is the first step towards supporting that.

Note: This isn't related to UI at all. It simply provides data that a UI could interact with, which would be the responsibility of the game developer or modders -- like how Brotato's Mods screen interacts with ModLoader's current data (see example with otDan's mod BetterModList). So on that screen, it could include a console-like tray with any errors or warnings.

[ithinkandicode]

Suggestion from @Qubus0 via PR #138 (here):

For performance, it could be worth to store all the messages in a dictionary with the keys being their md5 version.

• A it doesn't have to look for the entire message every time
• B dictionary lookup is way faster
• C we can still get all the messages by just using .values()

print("Config JSON Notice: something something".md5_text())     # b1f526f21bb565e91f11096f3cc1b499
print("Config JSON Notice: something something".md5_text())     # b1f526f21bb565e91f11096f3cc1b499 - same
print("abc Config JSON Notice: something something".md5_text()) # 34b0bb58ba94c388f7dd361ec0836172 - not same

[ithinkandicode]

Is this actually possible? The logger funcs are static, so they couldn't save to a logged_messages variable in their own class. But they also can't access ModLoader.logged_messages either, because ModLoader isn't initialised at the point when the first log method is called.

[KANAjetzt]

Working on this now.
Just so I don't forget update get_mod_config() in config.gd line 73 and 75:

if not ModLoaderStore.logged_messages.has(full_msg):
   ModLoaderUtils.log_debug(full_msg, mod_dir_name)
   ModLoaderStore.logged_messages.push_back(full_msg)