refactor: ♻️ Logging + ✨ Store Logs

[KANAjetzt]

Logging refactor

• Moved log utils into its one file (res://addons/mod_loader/api/log.gd) and Class (ModLoaderLog).
• New Resource for log entries ModLoaderLogEntry
• New util functions to work with stored logs
  • get_all_as_resource_array()
  • get_all_as_string_array()
  • get_by_mod_as_resource_array(mod_name: String)
  • get_by_mod_as_string_array(mod_name: String)
  • get_by_type_as_resource_array(type: String)
  • get_by_type_as_string_array(type: String)

Edit (Darkly77): This PR also introduces the feature of storing logged messages (via _store_log), which gives purpose to the methods listed above.

Todos

• Move functions to ModLoaderLog
  • _write_to_log_file
  • _rotate_log_file
  • _clear_old_log_backups
  • _is_mod_name_ignored
  • _get_verbosity
  • _loader_log
  • _get_time_string
  • _get_date_string
  • _get_date_time_string
• Move functions to ModLoaderLog and leave deprecation() func
  • log_fatal -> ModLoaderLog.fatal
  • log_error -> ModLoaderLog.error
  • log_warning -> ModLoaderLog.warning
  • log_info -> ModLoaderLog.info
  • log_success -> ModLoaderLog.success
  • log_debug -> ModLoaderLog.debug
  • log_debug_json_print -> ModLoaderLog.debug_json_print
• Add ignored_mod_names_in_log to ml_options in ModLoaderStore and options_profile.gd
• update get_mod_config() in config.gd line 73 and 75
• Add get_all_as_resource()
• Add get_all_as_string()
• Add get_by_mod_as_resource(mod_name: String)
• Add get_by_mod_as_string(mod_name: String)
• Add get_by_type_as_resource(type: String)
• Add get_by_type_as_string(type: String)
• Error Handling
  • Check if key exists in get_by_mod(mod_name: String)

Test Mod

KANA-LogViewer.zip

Related Issues

• Closes Logging: Track logged messages #140

[KANAjetzt]

Oh and I still need to fix this:

• Logging: Track logged messages #140 (comment)

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)

[ithinkandicode]

I was thinking the log funcs would be moved to ./add_ons/mod_loader/api/log.gd?

And that the class would follow the standard of other API classes, ie. ModLoaderLog. That follows the established standard and retains the namespaced class names.

Note: The current classes directory might be misnamed (my fault), as it's actually only used for resources. The functional classes are actually in api now.

[ithinkandicode]

I've looked over this PR's code in more detail and I have some notes.

There are still logging methods in ModLoaderUtils. Can they all be moved to ModLoaderLog please? And leave deprecation funcs behind -- eg. see #208, which moves methods from ModLoader.* to ModLoaderMod.*

How come you've used a class instance for LogManager? Why not use it with static methods, like other API methods do? Then you can log things with ModLoaderLog.method, rather than ModLoaderStore.LogManager.method.

Generally I think we should keep the ModLoaderFoo standard of class names. This makes it easier to identify methods that originate with ModLoader, and avoids potential conflicts with games/mods that use more generic class names (eg. an existing game might already have a class called LogManager, but it definitely won't have a class called ModLoaderLog).

You've used ModLoaderStore to store a class instance, but it's not intended to be used that way. It's meant to be a simple data store, partly to fix using local vars in ModLoader (see #161 + #172), but also to fix the issue of static class methods being unable to save data to their own class's local variables (because that class hasn't been instanced). So now instead, they can store data to ModLoaderStore. In this case, ModLoaderStore lets you keep track of any logged messages, via ModLoaderStore.logged_messages. So all your static methods can still exist in ModLoaderLog, but you can also save data, like logged messaged, to ModLoaderStore.

[KANAjetzt]

I will rework this to account for #153.
Ty @ithinkandicode for the review 👍

[ithinkandicode]

Should this PR be called "Logging Refactor", instead of "store logged messages"? Just thinking of the commit message which is set automatically from the PR title

[KANAjetzt]

good point

[Qubus0]

only minor things.
very nice work 🚀