Oocana Rust

OOMOL Studio's workflow engine, implemented in Rust.

Install Executor

To run JavaScript/TypeScript blocks like in OOMOL Studio, you need to install @oomol/node-executor.

npm install -g @oomol/node-executor @oomol/oocana-sdk
# check nodejs-executor is added to $PATH
which nodejs-executor

---

To run Python blocks like in OOMOL Studio, we need to install oocana-python-executor. You can install python-executor via pip install python-executor. Typically, Python dependencies are installed in virtual environments, and package managers will add python-executor to $PATH (this behavior may vary depending on the package manager).

# activate python virtual environment
pip install oocana-python-executor oocana
# check python-executor is added to $PATH
which python-executor

How to Use

This project produces a CLI executable program that supports multiple subcommands, among which the run subcommand supports executing flow.

• install a mqtt broker and start it

# for macos: brew install mosquitto
apt update && apt install -y mosquitto
# start mosquitto with port 47688 in background. If you want run mosquitto in foreground, you can remove -d option.
mosquitto -d -p 47688

• run oocana command

During development, use cargo run instead of the executable file, such as the run subcommand:

cargo run run examples/base

examples has multiple examples, you can try them.

you can download different platform oocana binary from github release

Usage instructions can be viewed through cargo run help.

Build Binary for Current System Architecture

1. Install Rust.
2. Execute cargo build --release at the project root.
3. The output will be at target/release/oocana.

clean:

cargo clean

Configuration

oocana supports loading configuration from files. The configuration file formats can be toml, json, or json5. By default, it will look for configuration files config.toml, config.json, or config.json5 under ~/.oocana/. If none are found, the default configuration will be used. You can also specify the configuration file path using the --config parameter.

more details can be found in configuration

Log

release version won't print log to stdout and stderr. For user who want to see log in stdout and stderr, you can need pass --verbose for run subcommand.

You can find all run subcommand logs in ~/.oocana/session/<session_id>/. Session id need to be replaced with the actual session id, if not given, oocana will generate a new random session id. For user who want to specify session id, you can pass --session <session_id> for run subcommand.

Project Structure

This project uses a workspace (monorepo) structure.

• cli Configures command line parameters
• core Handles core scheduling business
• examples A demo showing how to execute
• mainframe Manages communication between this program and executed block subprocesses
• manifest_reader Responsible for reading flow diagrams and block meta information from YAML files and processing them into internal structures for core to use
• sdk Oocana block SDK implemented in Rust, used for testing this project
• src Rust program entry point
• tests Project tests
• utils Reusable utility methods for this project
• npm Packages binaries for different environments as NPM packages