Wishlist

[LoyVanBeek]

Recently I started collecting a list of things I'd really like to have in FlexBE. This was a private list but why not make it public? Most are GUI-related and I don't have much experience there to make patches with.

• Breakpoints: execute up until a specific state, even in full autonomy.
• When repeating a state, show some indication of progress. Currently, the outcome of the previous run is highlighted while a new execution is busy, which makes it a bit unclear what is going on.
• Allow subclassing of EventState for better reuse of code.
• Tabs in the editor, so you can see how another behavior is implemented for reference
• Hotloading code, without relaunching backend.
• Edit subbehaviors while loaded as part of parent.
• Run 'Check behavior' from external process to aid CI
• Check external effects in flexbe_testing, e.g. setting a rosparam or calling an action.

BTW: FlexBE is really nice as it is and I recommend it to whoever will listen :-)

[pschillinger]

Thank you for recommending and thanks for sharing your wishlist. With Christmas approaching, this is the perfect time to do so. ;)

In general, I share many of these items with you. Still, for some of them, I'm not quite sure how to best realize them conceptually. So let me share my thoughts on each of them:

• Breakpoints: Good idea, didn't consider this so far. I just wonder how to best declare breakpoints. If you would like to tick some checkbox in the state properties of the App, this would likely be the most direct way, but then how to continue? So far, all that the App does is to generate code, so would a breakpoint be defined in the generated code? Or would something more dynamic be better suited here, like setting a ROS param?

• What sort of progress do you mean and what form of indication?

• I often thought about subclassing of EventState and would like to add it. In general, this is already possible, just the App does not recognize it. The parser uses the EventState to classify whether a class is a state implementation or something else. But there should be other ways to do so, maybe based on decorators.

• I don't think tabs would be easy to realize here, but multiple windows should be possible. The way nwjs (the javascript framework used as basis for the App) handles multiple processes is a bit weird though. When starting a second process, it will instead just trigger an event in the first process, meaning that the same environment variables are used as for the first window. This is a problem when sourcing different workspaces at the same time or using different roscores. Other than that, feel free to run rosrun flexbe_app run_app -o multiple times.

• Depends on the code. Changes of the executed behavior do not require a relaunch. Changes of included behaviors or states do. I recall there was an automatic reloading of the latter as well proposed some time ago. However, conceptually, this might cause inconsistencies when running the onboard engine remotely because only the code diff of the current behavior is transferred automatically on behavior start.

• Not sure how to do this best. Editing the state machine in the editor should be straight forward, but I don't know how much sense this would make without any access to the behavior dashboard of the included behavior. Also, if editing of subbehaviors is possible, I think it should be a given as well that these changes are updated online in the same way as changes in the toplevel behavior, i.e., this would require the code diff transfer of included behavior as mentioned above.

Happy to discuss all of these points further.

[LoyVanBeek]

Thanks for the response & tips, I'll try rosrun flexbe_app run_app -o. I've edited my original post for clarity on the progress thing.

As for breakpoints: something dynamic would be desirable, so they can be changed/added/removed at runtime. Just checking if the state's name is in a list on the paramserver would enough indeed.

[pschillinger]

Regarding subclassing EventState, I drafted an alternative state parser for the Flexbe App: It uses a Python subprocess to import and analyse the files to check whether it contains a state definition. This way, I can rely on Python to tell whether a class is a state class. In fact, I can extract all required information this way and would be able to fully replace the previous state parser.

However, the new parser is significantly slower because JavaScript takes some time for its subprocess stuff. For me, this means now around 15s of parsing time instead of <1s, required on each start. Also, using Python means now that all files of state packages are loaded (i.e., executed) in Python and states are half-way instantiated to determine their outcomes and userdata keys. One consequence is that states with import errors are not listed anymore. Not sure if all of the above is desirable... What do you think?

[LoyVanBeek]

Thanks for doing this!

I have to admit, the 15 second penalty is tough! I'm highly doubting if other users think the subclassing worth that. Neither is not seeing them in case of failed imports.

But: parsing in Python would maybe allow for another feature that has popped up. Namely: allowing CI to do the 'Check behavior' thing. I'm not deep enough into the code ATM to verify that that would help though. A colleague of mine is looking into that as well.

How come the python parsing is so slow?

[pschillinger]

It is not the parsing that is slow, it appears to solely be the overhead introduced by starting the subprocesses. If I let Python return immediately, I get about the same execution time as when actually parsing.

If I have time this weekend, I will try a slightly more advanced implementation of using a single, central Python process instead of separate calls. This is a bit more involved because it requires to manage the parallel calls of the different packages, but should remove most of the previous overhead. In case this is successful, I will integrate it and add an option to the settings for switching between the two parsers so that we can try it in practice.

[pschillinger]

I added the new Python parser as alternative, you can switch it in the settings. It now appears to have roughly the same execution time and warnings are printed whenever a state cannot be loaded. Let me know in case you face any problems.

[pschillinger]

FYI:

Run 'Check behavior' from external process to aid CI

-> See FlexBE/flexbe_app#55:

xvfb-run rosrun flexbe_app run_app --offline --check-behaviors
catkin run_tests flexbe_app

[LoyVanBeek]

Thanks! I've also gotten around to trying the breakpoints and behavior tests and finally trying out subclassing and cleaning up some code is on my TODO list as well.

[AravindaDP]

I would like to chime in and add couple of generic states assuming this is correct place to do so.

If the proposal for these are too generic let me know. Just thinking out loud

Generic Publisher/Subscriber State (At least for common set of message types including std_msgs primitive types, Pose variants, Twist etc) -- topic string topic name -- msg_type string message type

> data {msg_type} input value (In case publisher or output value in case of subscriber. Assumption userdata.data is of type given by msg_type)

<= done

this will load type by reflection of input parameter msg_type. (or from a prepopulated type dictionary)

Generic Service Client State (At least for common set of service calls (std_srv bool/empty/string etc)) Similar to above with the exception of request as input key and response as output key

Generic Simple Action Client State (At least for common set of action calls move base actions/moveit actions etc)

[AravindaDP]

I also believe ability to play/capture topics (Where state would publish or subscribe to) during state testing is benifitial. This might be facilitated by either allowing playing bag file in parallel to test (in case of state subscribe to topics) http://wiki.ros.org/flexbe/Tutorials/Writing%20State%20Tests%20Using%20flexbe_testing#Using_Bag_Files

For the case of state publishing to a topic we need additional parameter for specifying output topics in test configuration yaml file and then comparing against an array of message values/dat bag file content messages (Note that in case of publishing there could be multiple messages in contrast to input/output of a user data where only a single value need to be compared)

Here also we might need to restrict support to predefined set of data types. We might extend this to external service call/action call mocking as well but I guess that would be a lot of stretch work.