modulatingforce/forcebot_rs

Fork 0

WIP: Log loaded modules and actions #53

Draft

modulatingforce wants to merge 0 commits from Log-modules-acts into master

modulatingforce commented

2024-03-29 20:31:11 -04:00

Owner

Initial description

Smol enhancement. In BotInstance constructor method init() , add logic that prints into the log the BotModules and botactions that were successfully loaded

At the moment, this functionality was implemented in main(), and spits out line by line as it went through the botactions vector

For this PR,

we'll need to move that implementation from main() moved to in the BotInstance::init()
- Source logic here - https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/main.rs#L26-L53
- needs to be moved somewhere here - https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botinstance.rs#L134-L143
Adjust the logic so it is constructed in one easy line for debuggers to identify
[ optional & intermediate ] add private methods to ModulesManager like get_modules() and get_botactions()

# Initial description Smol enhancement. In `BotInstance` constructor method `init()` , add logic that prints into the log the `BotModules` and `botactions` that were successfully loaded At the moment, this functionality was implemented in `main()`, and spits out line by line as it went through the `botactions` vector For this PR, - [ ] we'll need to move that implementation from `main()` moved to in the `BotInstance::init()` - Source logic here - https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/main.rs#L26-L53 - needs to be moved somewhere here - https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botinstance.rs#L134-L143 - [ ] Adjust the logic so it is constructed in one easy line for debuggers to identify - [ ] [ _optional & intermediate_ ] add private methods to `ModulesManager` like `get_modules()` and `get_botactions()`

modulatingforce added the

Requirements > Drafting

labels 2024-03-29 20:31:38 -04:00

modulatingforce added this to the Forcebot Prototype 1.0 Push project 2024-03-29 20:33:04 -04:00

modulatingforce commented

2024-03-31 09:13:02 -04:00

Author

Owner

Thinking about delegating or showcasing

modulatingforce commented

2024-03-31 09:44:37 -04:00

Author

Owner

I wanted to flesh out the details a bit of this PR , but I think I'm intending to delegate this later

modulatingforce added the

Ownership

Needs Owner > May Delegate

label 2024-03-31 09:44:53 -04:00

modulatingforce commented

2024-04-05 13:08:54 -04:00

Author

Owner

Just in case these are helpful for implementing

From main() that logs each BotAction , but one line at a time

    {
        botlog::trace("Reading bot actions", Some("main()".to_string()), None);

        let actsdb = Arc::clone(&bot.botmodules.botactions);
        let actsdb_lock = actsdb.read().await;

        for acts in (*actsdb_lock).values() {
            for act in acts {

                let act_prelock = act;
                let act = act_prelock.read().await;

                let outstr = match &(*act) {
                    botmodules::BotAction::C(b) => {
                        format!("bot actions > Command : {}", b.command)
                    }
                    botmodules::BotAction::L(l) => {
                        format!("bot actions > Listener : {}", l.name)
                    }
                    _ => "Not a valid match??".to_string(),
                };

                botlog::info(outstr.as_str(), Some("main()".to_string()), None);
            }
        }
    }

Helpful ModulesManager methods

fn moduleslist(&self) -> HashMap<BotModule,ModGroup>
- https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botmodules.rs#L629
- HINT : The returned HashMap is the same as Arc::clone(&bot.botmodules.botactions) above in main() , except without Arc<RwLock<T>>
fn modstatus(&self, in_module: BotModule, in_chnl: Channel) -> StatusType
- https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botmodules.rs#L646
- Returns StatusType of the Module . For example, Enabled/Disabled - refer to https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botmodules.rs#L457

I'll say this is relatively intermediate because the Arc<RwLock<T>> involved and unpacking

Just in case these are helpful for implementing Related https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/main.rs#L28-L53 From `main()` that logs each `BotAction` , but one line at a time ```rust { botlog::trace("Reading bot actions", Some("main()".to_string()), None); let actsdb = Arc::clone(&bot.botmodules.botactions); let actsdb_lock = actsdb.read().await; for acts in (*actsdb_lock).values() { for act in acts { let act_prelock = act; let act = act_prelock.read().await; let outstr = match &(*act) { botmodules::BotAction::C(b) => { format!("bot actions > Command : {}", b.command) } botmodules::BotAction::L(l) => { format!("bot actions > Listener : {}", l.name) } _ => "Not a valid match??".to_string(), }; botlog::info(outstr.as_str(), Some("main()".to_string()), None); } } } ``` --- Helpful `ModulesManager` methods - `fn moduleslist(&self) -> HashMap<BotModule,ModGroup>` - https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botmodules.rs#L629 - HINT : The returned HashMap is the same as `Arc::clone(&bot.botmodules.botactions)` above in `main()` , except without `Arc<RwLock<T>>` - `fn modstatus(&self, in_module: BotModule, in_chnl: Channel) -> StatusType ` - https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botmodules.rs#L646 - Returns `StatusType` of the Module . For example, Enabled/Disabled - refer to https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/Log-modules-acts/src/core/botmodules.rs#L457 --- I'll say this is relatively intermediate because the `Arc<RwLock<T>>` involved and unpacking

modulatingforce added

and removed

labels 2024-04-05 13:09:20 -04:00