Crate mcai_worker_sdk

MCAI Worker SDK

This library is an SDK to communicate via message broker with StepFlow. It’s used for every worker as an abstraction. It manage itself requirements, message parsing, direct messaging.

Worker implementation

1. Create a Rust project
2. Add MCAI Worker SDK as a dependency in Cargo.toml: mcai_worker_sdk = "^1.0"
3. Update the main file with the example provided here to implement MessageEvent trait, and call the start_worker to start the worker itself.

use mcai_worker_sdk::prelude::*;
use serde_derive::Deserialize;
use schemars::JsonSchema;

#[derive(Debug)]
struct WorkerNameEvent {}

#[derive(Debug, Deserialize, JsonSchema)]
struct WorkerParameters {}

// For opensource workers
default_rust_mcai_worker_description!();
// Or uncomment one of these lines for licensed workers
// default_rust_mcai_worker_description!(Private);
// default_rust_mcai_worker_description!(Commercial);
// You can also specify the name of your organisation
// default_rust_mcai_worker_description!("My Organisation", Commercial);

impl McaiWorker<WorkerParameters, RustMcaiWorkerDescription> for WorkerNameEvent {
}
static WORKER_NAME_EVENT: WorkerNameEvent = WorkerNameEvent {};

// uncomment it to start the worker
// fn main() {
//   mcai_worker_sdk::start_worker(&WORKER_NAME_EVENT);
// }

Runtime configuration

AMQP connection

Variable	Description
AMQP_HOSTNAME	IP or host of AMQP server (default: localhost)
AMQP_PORT	AMQP server port (default: 5672)
AMQP_TLS	enable secure connection using AMQPS (default: false, enable with true or 1 or TRUE or True)
AMQP_USERNAME	Username used to connect to AMQP server (default: guest)
AMQP_PASSWORD	Password used to connect to AMQP server (default: guest)
AMQP_VHOST	AMQP virtual host (default: /)
AMQP_QUEUE	AMQP queue name used to receive job orders (default: job_undefined)
AMQP_SERVER_CONFIGURATION	RabbitMP configuration. Either standalone or cluster (default: standalone)

Vault connection

Variable	Description
BACKEND_HOSTNAME	URL used to connect to backend server (default: http://127.0.0.1:4000/api)
BACKEND_USERNAME	Username used to connect to backend server
BACKEND_PASSWORD	Password used to connect to backend server

Start worker locally

MCAI Worker SDK can be launched locally - without RabbitMQ. It can process some message for different purpose (functional tests, message order examples, etc.).

To start worker in this mode, setup the environment variable SOURCE_ORDERS with path(s) to json orders. It can take multiple orders, joined with : on unix platform, ; on windows os.

Examples:

RUST_LOG=info SOURCE_ORDERS=./examples/success_order.json:./examples/error_order.json cargo run --example worker

Re-exports

• pub use message_exchange::message::publish_job_progression;
• pub use parameter::container::ParametersContainer;

Modules

• config
• job
  Module to manage Job
• mcai_worker
• message_exchange
  Connectors between message brokers and processors
• parameter
• prelude
• processor
• reexport
• worker
  Module to manage the worker (configuration and status information)

Macros

• default_rust_mcai_worker_description

Enums

• MessageError
  Internal error status to manage process errors

Type Aliases

• McaiChannel
  Exposed Channel type
• Result