modulatingforce/forcebot_rs

Fork 0

ModulesManager #37

Merged

modulatingforce merged 22 commits from modulesmanager into main

2024-03-22 21:34:08 -04:00

modulatingforce commented

2024-03-20 21:07:14 -04:00

Owner

Addressing #26

Plan of Action :

Review current BotModules code . In particular, where we can set the statusdb in

pub struct ModulesManager {
    statusdb: Arc<RwLock<HashMap<ModType, Vec<ModStatusType>>>>,
    pub botactions: Arc<RwLock<HashMap<ModType, Vec<BotAction>>>>,
}

Create ModulesManager Methods to work with StatusTypes
Bot should NOT allow BotAction to run (e.g., Listener or BotCommand)
- FUTURE For Routines, when a module is set to Disabled, it should also Abort all running routines for the Module >> At least ensure this requirement is in the Routines issue > That will be addressed here #5 (comment)
Unit tests
BotCommands to Enable & Disable Modules
Runtime / live tests
Comments cleanup

Addressing https://git.flake.sh/modulatingforce/forcebot_rs/issues/26 **Plan of Action :** - [x] Review current `BotModules` code . In particular, where we can set the `statusdb` in ```rust pub struct ModulesManager { statusdb: Arc<RwLock<HashMap<ModType, Vec<ModStatusType>>>>, pub botactions: Arc<RwLock<HashMap<ModType, Vec<BotAction>>>>, } ``` - [x] Create ModulesManager Methods to work with StatusTypes - [x] Bot should NOT allow `BotAction` to run (e.g., `Listener` or `BotCommand`) - [x] **FUTURE** For `Routines`, when a module is set to Disabled, it should also Abort all running routines for the Module >> At least ensure this requirement is in the Routines issue > That will be addressed here https://git.flake.sh/modulatingforce/forcebot_rs/issues/5#issuecomment-608 - [x] Unit tests - [x] BotCommands to Enable & Disable Modules - [x] Runtime / live tests - [x] Comments cleanup

modulatingforce self-assigned this 2024-03-20 21:07:46 -04:00

modulatingforce added this to the Rust Learning project 2024-03-20 21:07:50 -04:00

modulatingforce added this to the Prototype 1.0 milestone 2024-03-20 21:07:52 -04:00

modulatingforce added the

Kind/Feature

Priority

High

labels 2024-03-20 21:08:05 -04:00

modulatingforce added a new dependency 2024-03-20 21:09:56 -04:00

#26 [CORE] ModulesManager

modulatingforce started working 2024-03-20 22:29:52 -04:00

modulatingforce commented

2024-03-20 22:31:30 -04:00

Author

Owner

At the moment, during ModulesManager.add_botaction() , the BotModule is ensured existing in statusdb , and is Enabled(Instance)

         let mut dbt = self.statusdb.write().await;
         let statusvector = dbt.entry(in_module.clone()).or_insert(Vec::new());
         statusvector.push(ModStatusType::Enabled(StatusLvl::Instance)); // Pushes the Module as Enabled at Instance Level

We should be handling the above elsewhere, Disabled By Default at Instance level (except for certain Core modules) , unless Explicitly Coded to be Enabled

By Keeping Default Disabled, but being able to Enable at Channel level gives some control

At the moment, during `ModulesManager.add_botaction()` , the `BotModule` is ensured existing in `statusdb` , and is `Enabled(Instance)` https://git.flake.sh/modulatingforce/forcebot_rs/src/commit/b5873a6ac179371861298f2cbbd67b99d9c190ff/src/core/botmodules.rs#L302-L305 --- We should be handling the above elsewhere, Disabled By Default at Instance level (except for certain `Core` modules) , unless Explicitly Coded to be Enabled - By Keeping Default Disabled, but being able to Enable at Channel level gives some control

modulatingforce stopped working 2024-03-21 09:39:02 -04:00

11 hours 9 minutes

modulatingforce commented

2024-03-21 09:39:37 -04:00

Author

Owner

LULE I did not work on this for 11 hours - but testing this timer functionality - though I did a bit

modulatingforce added 8 commits 2024-03-21 09:40:54 -04:00

ModGroup enum eb8877f0c1

identity adds core modules dda0050513

modgroup default statuses ca3bca9ae6

refactor statustype b353589576

botmodules helper fns a066329730

reorg statusdb 1b44ec4f4c

cont helper fns 5280d18702

smol

ci/woodpecker/pr/cargo-checks Pipeline was successful

Details

23f12b3956

modulatingforce commented

2024-03-21 10:15:15 -04:00

Author

Owner

Business Rules

#todo may need to add this business logic in a wiki or the issue

Drafted this last night that I'm gearing my current commits on related to ModGroup

`ModGroup` Core & Custom

Core BotModules should :

Critical Modules
Always Be Enabled, and Enabled at an Instance Level
They are never enabled / disabled at Channel Levels
There should be no way to Disable these BotModules

Custom BotModules should :

Optional Modules
be toggleable between Enabled/Disabled at Channel or Instance Level
When added, they are Disabled at an Instance Level
- Moderators can Enable/Disable the BotModule at Channel Level > In this case, Enabled(Channel) / Disabled(Channel) will be returned
A custom modules developer can call ModulesManager to Enable the Module at Instance Level , after they've added BotActions
A BotAdmin can Enable at Instance Level
Enabled At Instance Level means :
- If the Channel does not Define a Status Level OR that Channel is Defined as Enabled > Enabled(Instance) or Enabled(Channel) will be returned
  - This allows Modules to be Enabled by Default to Introduce the functionality . The custom modules developer or admin should understand this before Enabling at Instance Level
- If the Channel is Defined a Disabled > Disabled(Channel) will be returned
Force Disable fn to Disable a Module by Setting Disabled(Instance) and removing all Enabled(Channel) (doing nothing to Disabled(Channel) that exists)
- This should require elevated access

# Business Rules - [ ] _#todo_ may need to add this business logic in a wiki or the issue Drafted this last night that I'm gearing my current commits on related to `ModGroup` ## `ModGroup` Core & Custom `Core` BotModules should : - Critical Modules - Always Be Enabled, and Enabled at an Instance Level - They are never enabled / disabled at Channel Levels - There should be no way to Disable these BotModules `Custom` BotModules should : - Optional Modules - be toggleable between Enabled/Disabled at Channel or Instance Level - When added, they are Disabled at an Instance Level - Moderators can Enable/Disable the BotModule at Channel Level > In this case, Enabled(Channel) / Disabled(Channel) will be returned - A custom modules developer can call ModulesManager to Enable the Module at Instance Level , after they've added BotActions - A BotAdmin can Enable at Instance Level - Enabled At Instance Level means : - If the Channel does not Define a Status Level OR that Channel is Defined as Enabled > Enabled(Instance) or Enabled(Channel) will be returned - This allows Modules to be Enabled by Default to Introduce the functionality . The custom modules developer or admin should understand this before Enabling at Instance Level - If the Channel is Defined a Disabled > Disabled(Channel) will be returned - Force Disable fn to Disable a Module by Setting Disabled(Instance) and removing all Enabled(Channel) (doing nothing to Disabled(Channel) that exists) - This should require elevated access

modulatingforce commented

2024-03-21 12:24:30 -04:00

Author

Owner

Unit Tests should be based on the following ModulesManager methods

pub async fn modstatus(&self, in_module: ModType, in_chnl: ChType) -> StatusType

pub async fn set_instance_disabled(&self, in_module: ModType) -> (StatusType,ChangeResult)

pub async fn force_disable(&self, in_module: ModType) -> (StatusType,ChangeResult)

pub async fn set_instance_enabled(&self, in_module: ModType) -> (StatusType,ChangeResult)

pub async fn set_ch_disabled(&self, in_module: ModType , in_chnl: ChType) -> (StatusType,ChangeResult)

pub async fn set_ch_enabled(&self, in_module: ModType , in_chnl: ChType) -> (StatusType,ChangeResult)

pub async fn affirm_in_statusdb(&self,in_module:ModType,in_modgroup: ModGroup)

- [x] Unit Tests should be based on the following `ModulesManager` methods ```rust pub async fn modstatus(&self, in_module: ModType, in_chnl: ChType) -> StatusType pub async fn set_instance_disabled(&self, in_module: ModType) -> (StatusType,ChangeResult) pub async fn force_disable(&self, in_module: ModType) -> (StatusType,ChangeResult) pub async fn set_instance_enabled(&self, in_module: ModType) -> (StatusType,ChangeResult) pub async fn set_ch_disabled(&self, in_module: ModType , in_chnl: ChType) -> (StatusType,ChangeResult) pub async fn set_ch_enabled(&self, in_module: ModType , in_chnl: ChType) -> (StatusType,ChangeResult) pub async fn affirm_in_statusdb(&self,in_module:ModType,in_modgroup: ModGroup) ```

modulatingforce added 2 commits 2024-03-21 14:02:11 -04:00

complete helper fns 619cdd1923

unit tests

ci/woodpecker/pr/cargo-checks Pipeline was successful

Details

68f9be4968

modulatingforce referenced this pull request

2024-03-21 14:59:26 -04:00

[ENH] Routine functionality #5

modulatingforce deleted spent time 2024-03-21 21:21:30 -04:00

- 11 hours 9 minutes

modulatingforce added 9 commits 2024-03-22 19:08:30 -04:00

(init) modulesmgr commands 2cf44bb6ca

(cont) enable/disable logic 0d6cc132ea

botmodule case insensitive 072903882d

unit tests 8b4c21ba58

(cont) enable cmd logic 7757dd1820

(cont) disable cmd logic 29c8f74531

validate status ba6117d692

load botmodules module 582702fab2

rsp only to elevated users

ci/woodpecker/pr/cargo-checks Pipeline failed

Details

2c298663b1

modulatingforce added 1 commit 2024-03-22 19:51:28 -04:00

listener modules validated

ci/woodpecker/pr/cargo-checks Pipeline failed

Details

4b0d51a674

modulatingforce added 1 commit 2024-03-22 20:18:08 -04:00

clippy adj

ci/woodpecker/pr/cargo-checks Pipeline was successful

Details

06e182df55

modulatingforce commented

2024-03-22 20:20:09 -04:00

Author

Owner

Beautiful looking good.

Going to monitor for a few days in case there's any additional changes I can tack on that might be related to modules

Also need to do a comments cleanup

Beautiful looking good. Going to monitor for a few days in case there's any additional changes I can tack on that might be related to modules Also need to do a comments cleanup

modulatingforce added the

Status

Need More Info

label 2024-03-22 20:20:20 -04:00

modulatingforce added 1 commit 2024-03-22 21:06:22 -04:00

comments cleanup

ci/woodpecker/pr/cargo-checks Pipeline was successful

Details

72ebd5193c

modulatingforce referenced this pull request

2024-03-22 21:30:15 -04:00

[CORE] ModulesManager #26

modulatingforce commented

2024-03-22 21:32:28 -04:00

Author

Owner

Really want this merge ASAP before working on other functionality .

Going to Approve the Merge but keep the Branch for any potential Code Improvements while Issue #26 is still open

Ideally should delete out the Branch after the Issue is closed out

Really want this merge ASAP before working on other functionality . Going to Approve the Merge but keep the Branch for any potential Code Improvements while Issue https://git.flake.sh/modulatingforce/forcebot_rs/issues/26 is still open Ideally should delete out the Branch after the Issue is closed out

modulatingforce removed the

Status

Need More Info

label 2024-03-22 21:33:12 -04:00

modulatingforce changed title from ~~WIP: ModulesManager~~ to ModulesManager

2024-03-22 21:33:28 -04:00

modulatingforce merged commit 45e3f02297 into main

2024-03-22 21:34:08 -04:00

modulatingforce referenced this pull request from a commit

2024-03-22 21:34:09 -04:00

Merge pull request 'ModulesManager' (#37) from modulesmanager into main

modulatingforce referenced this pull request

2024-03-22 21:36:07 -04:00

[CORE] ModulesManager #26

modulatingforce commented

2024-04-03 00:07:39 -04:00

Author

Owner

No need to keep the branch if there are no changes to add soon. Deleting the branch for now ; the issue can remain open and we can create a new PR if there are code changes that are required or need to be explored

modulatingforce deleted branch modulesmanager

2024-04-03 00:07:53 -04:00

No reviewers