modulatingforce/forcebot_rs
1
0
Fork 0
Code Issues 33 Pull requests 11 Projects 2 Activity

WIP: Basic Routine Functionality #40

Draft
modulatingforce wants to merge 23 commits from routines-functionality into master
pull from: routines-functionality
merge into: modulatingforce:master
Conversation 6 Commits 23 Files changed 7 +1649 -24
modulatingforce commented 2024-03-22 22:51:33 -04:00
Owner
Copy link

To address #5

Plan of Action :

  • Review Routine functionality from py implementation
  • Design working Routines functionality that using findings from #5
  • Code/Implement Routines Feature
  • BotCommands that allow you to manage Routines (at least Basic management) - ⏩ As Mentioned in #5 , will be handled in separate future PR
  • To Test functionality, create a fun countdown BotCommand that allows an Elevated Chatter to
      1. -a add channels to target a routine message
      1. start to start the routine with an input String, that sends a number of messages to the targeted channels with a countdown, until it reaches 0 when it sends a cute or funny message
  • Unit Tests
To address https://git.flake.sh/modulatingforce/forcebot_rs/issues/5 # Plan of Action : - [x] Review Routine functionality from py implementation - Related : https://twitchio.dev/en/stable/exts/routines.html - [x] Design working Routines functionality that using findings from https://git.flake.sh/modulatingforce/forcebot_rs/issues/5 - [x] Code/Implement Routines Feature - [x] BotCommands that allow you to manage Routines (at least Basic management) - ⏩ As Mentioned in https://git.flake.sh/modulatingforce/forcebot_rs/issues/5 , will be handled in separate future PR - [ ] To Test functionality, create a fun `countdown` `BotCommand` that allows an Elevated Chatter to - 1. `-a` add channels to target a routine message - 2. `start` to start the routine with an input `String`, that sends a number of messages to the targeted channels with a countdown, until it reaches 0 when it sends a cute or funny message - [ ] Unit Tests
modulatingforce added this to the Rust Learning project 2024-03-22 22:51:42 -04:00
modulatingforce self-assigned this 2024-03-22 22:51:49 -04:00
modulatingforce added the
Kind/Feature
Priority
High
 labels 2024-03-22 22:52:03 -04:00
modulatingforce added this to the Prototype 1.0 milestone 2024-03-22 22:52:10 -04:00
modulatingforce added a new dependency 2024-03-22 22:54:04 -04:00
#5 [ENH] Routine functionality
modulatingforce commented 2024-03-22 23:03:04 -04:00
Author
Owner
Copy link

Reviewing the py twitchio documentation on routines - https://twitchio.dev/en/stable/exts/routines.html

The API wasn't too complicated . Among the functionality and attributes it included the following

  • completed_iterations
  • remaining_iterations
  • start_time
  • cancel()
  • change_interval()
  • restart()
    • you could specify stop_on_error (bool) whether to stop and cancel the routine on error . Defaults to True
    • you could specify force (bool) to cancel the currently running routine immediately and restart or if False, allow the routine to finish it's current iteration
  • start()
    • you could specify stop_on_error (bool) whether to stop and cancel the routine on error . Defaults to True
  • stop()
Reviewing the py `twitchio` documentation on routines - https://twitchio.dev/en/stable/exts/routines.html The API wasn't too complicated . Among the functionality and attributes it included the following - `completed_iterations` - `remaining_iterations` - `start_time` - `cancel()` - `change_interval()` - `restart()` - you could specify `stop_on_error` (`bool`) whether to stop and cancel the routine on error . Defaults to True - you could specify `force` (`bool`) to cancel the currently running routine immediately and restart or if False, allow the routine to finish it's current iteration - `start()` - you could specify `stop_on_error` (`bool`) whether to stop and cancel the routine on error . Defaults to True - `stop()`
modulatingforce commented 2024-03-22 23:19:20 -04:00
Author
Owner
Copy link

From Obsidian Vault note Brainstorm 0322

[x] Desired Functionality

The following might be a basic starter draft of what I want. Let's see what I come up with

  • Basic Functionality :
    • Define a Routine , including it's characteristics
    • Add it to the Modules statusdb with it's BotModule - ⏩ As Mentioned in #5 , will be handled in separate future PR
    • Retrieve that Routine from statusdb - ⏩ As Mentioned in #5 , will be handled in separate future PR
    • start() the Routine
    • at any point, stop() the Routine
  • Enhanced Features :
    • Clone a Routine
      • This also adds an entry if required in statusdb , depending on where clones are separated - - ⏩ As Mentioned in #5 , will be handled in separate future PR
      • Clones can be managed separately - ✅ can be managed with existing HashMap ontop of the new Routine objects
    • Able to take any Routine and Adjust characteristics - ✅ Routine has RoutineAttr
  • BotAction Routine Management
    • When the BotModule is Disabled , ensure that all related Routine are stop() ⏩ As Mentioned in #5 , will be handled in separate future PR
_From Obsidian Vault note Brainstorm 0322_ # [x] Desired Functionality The following might be a basic starter draft of what I want. Let's see what I come up with - [x] Basic Functionality : - [x] Define a Routine , including it's characteristics - [x] Add it to the Modules `statusdb` with it's `BotModule` - ⏩ As Mentioned in https://git.flake.sh/modulatingforce/forcebot_rs/issues/5 , will be handled in separate future PR - [x] Retrieve that Routine from `statusdb` - ⏩ As Mentioned in https://git.flake.sh/modulatingforce/forcebot_rs/issues/5 , will be handled in separate future PR - [x] `start()` the Routine - [x] at any point, `stop()` the Routine - [x] Enhanced Features : - Clone a Routine - [x] This also adds an entry if required in `statusdb` , depending on where clones are separated - - ⏩ As Mentioned in https://git.flake.sh/modulatingforce/forcebot_rs/issues/5 , will be handled in separate future PR - [x] Clones can be managed separately - ✅ can be managed with existing `HashMap` ontop of the new `Routine` objects - [x] Able to take any Routine and Adjust characteristics - ✅ `Routine` has `RoutineAttr` - [x] `BotAction` `Routine` Management - When the `BotModule` is `Disabled` , ensure that all related `Routine` are `stop()` ⏩ As Mentioned in https://git.flake.sh/modulatingforce/forcebot_rs/issues/5 , will be handled in separate future PR
modulatingforce added 1 commit 2024-03-25 23:26:47 -04:00
Merge branch 'main' into routines-functionality
All checks were successful
ci/woodpecker/pr/cargo-checks Pipeline was successful
Details
34c3c8af7a
modulatingforce added 3 commits 2024-03-26 16:56:37 -04:00
(init) experiment test module
All checks were successful
ci/woodpecker/pr/cargo-checks Pipeline was successful
Details
4e9316ad49
modulatingforce added a new dependency 2024-03-26 19:47:41 -04:00
#46 WIP: Child fn should be able to access BotAction Header
modulatingforce commented 2024-03-26 21:57:40 -04:00
Author
Owner
Copy link

This is in essence a small demo of the problem scenario I'm facing when developing the start() method

https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=5c743e156cc110fc5a8c319991d44a21

This is in essence a small demo of the problem scenario I'm facing when developing the `start()` method https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=5c743e156cc110fc5a8c319991d44a21
modulatingforce commented 2024-03-26 22:42:16 -04:00
Author
Owner
Copy link

This is in essence a small demo of the problem scenario I'm facing when developing the start() method

https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=5c743e156cc110fc5a8c319991d44a21

Following may be the workaround - something similar I did with existing runner and listener_main_prvmsg for BotInstance

https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=0fc9e09bc9d4d53ee492814a2914b4e8

> This is in essence a small demo of the problem scenario I'm facing when developing the `start()` method > > https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=5c743e156cc110fc5a8c319991d44a21 Following may be the workaround - something similar I did with existing `runner` and `listener_main_prvmsg` for `BotInstance` https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=0fc9e09bc9d4d53ee492814a2914b4e8
modulatingforce added 2 commits 2024-03-27 02:35:36 -04:00
(cont) routine start
All checks were successful
ci/woodpecker/pr/cargo-checks Pipeline was successful
Details
3f8e798050
modulatingforce added 1 commit 2024-03-27 10:18:19 -04:00
(cont) start runonce
All checks were successful
ci/woodpecker/pr/cargo-checks Pipeline was successful
Details
b08d91af5d
modulatingforce reviewed 2024-03-27 11:45:17 -04:00
modulatingforce left a comment
Author
Owner
Copy link

Addressing the following separate issue in #47

Addressing the following separate issue in #47
src/core/botmodules.rs Outdated
@ -573,0 +919,4 @@
// while inroutine.read().await.remaining_iterations.unwrap_or(0) > 1 {
// execution body
inroutine.read().await.loopbody().await;
modulatingforce commented 2024-03-27 11:44:27 -04:00
Author
Owner
Copy link

During Live Tests , issuing BotCommand appears to setup & begin to start() the routine , but never makes it to this point when the routine is started .

Strangely, the traces in this same tokio::spawn are being logged? But nothing is being logged within the loopbody() or after this line

Created PR #47 to address this issue

During Live Tests , issuing `BotCommand` appears to setup & begin to `start()` the routine , but never makes it to this point when the routine is started . Strangely, the traces in this same `tokio::spawn` are being logged? But nothing is being logged within the `loopbody()` or after this line Created PR #47 to address this issue
modulatingforce commented 2024-03-28 00:52:27 -04:00
Author
Owner
Copy link

Fixed . Refer to Resolution Notes - #47 (comment)

Fixed . Refer to Resolution Notes - https://git.flake.sh/modulatingforce/forcebot_rs/pulls/47#issuecomment-792
modulatingforce marked this conversation as resolved
modulatingforce reviewed 2024-03-27 13:32:40 -04:00
modulatingforce left a comment
Author
Owner
Copy link
  • Need to check if this area is impacting #47
- [x] Need to check if this area is impacting https://git.flake.sh/modulatingforce/forcebot_rs/pulls/47
src/custom/experimental/experiment003.rs Outdated
@ -0,0 +190,4 @@
params.clone()
).await;
newr.clone().write().await.join_handle.take().expect("Issue with join handle").await.unwrap();
modulatingforce commented 2024-03-27 13:31:53 -04:00
Author
Owner
Copy link
newr
.clone()   // <-- is this required?
.write()
.await
.join_handle
.take()  // <-- is this an issue? Is this related to https://git.flake.sh/modulatingforce/forcebot_rs/pulls/47 ? 
.expect("Issue with join handle")
.await.unwrap();
``` newr .clone() // <-- is this required? .write() .await .join_handle .take() // <-- is this an issue? Is this related to https://git.flake.sh/modulatingforce/forcebot_rs/pulls/47 ? .expect("Issue with join handle") .await.unwrap(); ```
modulatingforce commented 2024-03-27 14:18:42 -04:00
Author
Owner
Copy link

Removing this statement completely seems to help resolve #47

Removing this statement completely seems to help resolve https://git.flake.sh/modulatingforce/forcebot_rs/pulls/47
modulatingforce commented 2024-03-28 00:53:30 -04:00
Author
Owner
Copy link

Fixed . Refer to Resolution Notes - #47 (comment)

Fixed . Refer to Resolution Notes - https://git.flake.sh/modulatingforce/forcebot_rs/pulls/47#issuecomment-792
modulatingforce marked this conversation as resolved
modulatingforce reviewed 2024-03-27 13:49:08 -04:00
modulatingforce left a comment
Author
Owner
Copy link

Consider adjusting Routine.join_handle

Consider adjusting `Routine.join_handle`
src/core/botmodules.rs Outdated
@ -573,0 +622,4 @@
exec_body: bot_actions::actions_util::ExecBody,
// parent_params : Option<ExecBodyParams> ,
parent_params : ExecBodyParams ,
pub join_handle : Option<JoinHandle<()>> ,
modulatingforce commented 2024-03-27 13:48:42 -04:00
Author
Owner
Copy link

Should we make this just JoinHandle<()> ? This will require Routines to always have this defined

Should we make this just `JoinHandle<()>` ? This will require `Routines` to always have this defined
modulatingforce commented 2024-03-27 14:11:03 -04:00
Author
Owner
Copy link

No Keep with Option<JoinHandle<()>> . While constructing in Routine::from() , there is no JoinHandle yet . A JoinHandle is created at Task Spawn (which should be when it is Start)

No Keep with `Option<JoinHandle<()>>` . While constructing in `Routine::from()` , there is no `JoinHandle` yet . A `JoinHandle` is created at Task Spawn (which should be when it is `Start`)
modulatingforce marked this conversation as resolved
modulatingforce added 1 commit 2024-03-27 14:52:22 -04:00
proper join handling at custom
All checks were successful
ci/woodpecker/pr/cargo-checks Pipeline was successful
Details
8da8460e47
modulatingforce added the
Bot_Code
Core
 label 2024-03-27 17:47:59 -04:00
modulatingforce added the
Complexity
Advanced
 label 2024-03-27 18:22:51 -04:00
modulatingforce modified the project from Rust Learning to Forcebot Prototype 1.0 Push 2024-03-27 18:31:51 -04:00
modulatingforce added the
Phase 3.0
Coding > Implementation
 label 2024-03-27 20:12:23 -04:00
modulatingforce commented 2024-03-28 01:03:40 -04:00
Author
Owner
Copy link

[x] Routine Methods

  • validate_self_attr(self)
  • from() - Constructor
    pub async fn from(
        name : String ,
        module : BotModule ,
        channel : Channel,
        routine_attr : Vec<RoutineAttr> ,
        exec_body : bot_actions::actions_util::ExecBody ,
        parent_params : ExecBodyParams
    ) -> Result<
            Arc<RwLock<Routine>>,
            String
        >
  • start()
    pub async fn start(
        trg_routine_ar : Arc<RwLock<Routine>>
    ) -> Result<Arc<RwLock<Routine>>,String>
  • stop(&self) -> Result<String,String>
  • cancel(&self) -> Result<String,String>
  • restart
    pub async fn restart(
        &self,
        _force : bool
    ) -> Result<String,String>
  • change_channel()
    pub fn change_channel(
        &self,
        _channel : Channel
    ) -> Result<String,String>
  • set_routine_attributes()
    pub async fn set_routine_attributes(
        &mut self,
        routine_attr : Vec<RoutineAttr>
    ) -> Result<String,String>
# [x] Routine Methods - [x] `validate_self_attr(self)` - [x] `from()` - Constructor ```rust pub async fn from( name : String , module : BotModule , channel : Channel, routine_attr : Vec<RoutineAttr> , exec_body : bot_actions::actions_util::ExecBody , parent_params : ExecBodyParams ) -> Result< Arc<RwLock<Routine>>, String > ``` - [x] `start()` ```rust pub async fn start( trg_routine_ar : Arc<RwLock<Routine>> ) -> Result<Arc<RwLock<Routine>>,String> ``` - [x] ` stop(&self) -> Result<String,String> ` - [x] `cancel(&self) -> Result<String,String> ` - [x] `restart` ```rust pub async fn restart( &self, _force : bool ) -> Result<String,String> ``` - [x] `change_channel()` ```rust pub fn change_channel( &self, _channel : Channel ) -> Result<String,String> ``` - [x] `set_routine_attributes()` ```rust pub async fn set_routine_attributes( &mut self, routine_attr : Vec<RoutineAttr> ) -> Result<String,String> ```
modulatingforce changed title from WIP: Routines Functionality to WIP: Core Routines Functionality 2024-03-28 09:23:03 -04:00
modulatingforce changed title from WIP: Core Routines Functionality to WIP: Basic Routines Functionality 2024-03-28 09:23:09 -04:00
modulatingforce changed title from WIP: Basic Routines Functionality to WIP: Basic Routine Functionality 2024-03-28 09:24:39 -04:00
modulatingforce added
Phase 4.0
QA > Unit Testing & Design
 and removed
Phase 3.0
Coding > Implementation
 labels 2024-03-28 09:32:50 -04:00
modulatingforce added 16 commits 2024-03-29 09:05:40 -04:00
ISSUE - potential lock issue
All checks were successful
ci/woodpecker/pr/cargo-checks Pipeline was successful
Details
b5e95668a5
modulatingforce reviewed 2024-03-29 09:23:54 -04:00
modulatingforce left a comment
Author
Owner
Copy link
  • Addressing in PR - #51
    This is considered a block of the current PR
- [ ] Addressing in PR - https://git.flake.sh/modulatingforce/forcebot_rs/pulls/51 This is considered a block of the current PR
src/custom/experimental/experiment003.rs
@ -0,0 +412,4 @@
if let BotAction::R(c) = &*guard {
println!("{:?}",c.read().await.channel);
}
println!("Critical code area end"); // <= 03.29 - ISSUE This is NOT printed
modulatingforce commented 2024-03-29 09:19:36 -04:00
Author
Owner
Copy link

ISSUE . The defined Routine's Custom Execution Body is being reached (so the custom fn is being triggered as expected); However, I believe at L413 where c.read().await.channel , it never goes beyond that point within the same Custom fn body

Even if the bot continues to be responsive (i.e., the main bot continues to run), the rest of the routine is not. I believe this is suggesting there's a lock with one of the objects we're introducing with this feature . In the above line, I believe the lock involves ExecBodyParam's curr_act value

**_ISSUE ._** The defined Routine's Custom Execution Body is being reached (so the custom `fn` is being triggered as expected); However, I believe at L413 where `c.read().await.channel` , it never goes beyond that point within the same Custom `fn` body Even if the bot continues to be responsive (i.e., the `main` bot continues to run), the rest of the routine is not. I *believe* this is suggesting there's a lock with one of the objects we're introducing with this feature . In the above line, I believe the lock involves `ExecBodyParam`'s `curr_act` value
modulatingforce added a new dependency 2024-03-29 09:38:49 -04:00
#51 WIP: Routine Unresponsive due to Deadlock
modulatingforce added the
Status
Blocked
 label 2024-03-29 09:44:04 -04:00
modulatingforce added the
Ownership
Individual Lead
 label 2024-03-31 09:54:45 -04:00
modulatingforce commented 2024-03-31 17:26:50 -04:00
Author
Owner
Copy link
  • refactor out routine into it's own module
  • consider the same for bot_action
- [ ] refactor out `routine` into it's own module - [ ] consider the same for `bot_action`
All checks were successful
ci/woodpecker/pr/cargo-checks Pipeline was successful
Details
This pull request has changes conflicting with the target branch.
  • src/core/identity.rs
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin routines-functionality:routines-functionality
git checkout routines-functionality
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Automated
  
Backlog
Post_Prototype_1.0

  
Bot_Code
Core

  
Bot_Code
Custom

  
CI/CD
  
Complexity
Advanced

  
Complexity
Basic

  
Complexity
Expert

  
Complexity
Intermediate

  
Kind/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Bug Fix

Branches intended to address an existing Bug

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Nix
  
Ownership
Collab

  
Ownership
Collab with Leads
Collab with one or more Leads

  
Ownership
Individual Lead

  
Ownership
In-Review
Ownership may be in a review or disputed status

  
Ownership
Needs Owner > May Delegate
Tasks that may need reassignment

  
Ownership
Workshop with Leads
Workshop Tasks

  
Phase 1.0
Requirements > Drafting

  
Phase 1.0
Requirements > Researching

  
Phase 1.0
Requirements > Review & Planning

  
Phase 2.0
Design > Research & Analysis

  
Phase 3.0
Coding > Implementation

  
Phase 4.0
QA > Unit Testing & Design

  
Phase 5.0
Resolution > Completed

  
Phase 5.0
Resolution > Review for Completion

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

No labels
Automated
Backlog
Post_Prototype_1.0
Bot_Code
Core
Bot_Code
Custom
CI/CD
Complexity
Advanced
Complexity
Basic
Complexity
Expert
Complexity
Intermediate
Kind/Breaking
Kind/Bug
Kind/Bug Fix
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Nix
Ownership
Collab
Ownership
Collab with Leads
Ownership
Individual Lead
Ownership
In-Review
Ownership
Needs Owner > May Delegate
Ownership
Workshop with Leads
Phase 1.0
Requirements > Drafting
Phase 1.0
Requirements > Researching
Phase 1.0
Requirements > Review & Planning
Phase 2.0
Design > Research & Analysis
Phase 3.0
Coding > Implementation
Phase 4.0
QA > Unit Testing & Design
Phase 5.0
Resolution > Completed
Phase 5.0
Resolution > Review for Completion
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No milestone
Prototype 1.0
Projects
Clear projects
No items
No project
Forcebot Prototype 1.0 Push
Assignees
Clear assignees
No assignees
modulatingforce
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks
#5 [ENH] Routine functionality}
modulatingforce/forcebot_rs
Depends on
#46 WIP: Child fn should be able to access BotAction Header
modulatingforce/forcebot_rs
#51 WIP: Routine Unresponsive due to Deadlock
modulatingforce/forcebot_rs
Reference: modulatingforce/forcebot_rs#40
No description provided.
Delete branch "routines-functionality"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?