Calway.Automation 0.9.10

Calway.Automation

This library implements an Automation Workflow/Statemachine with strongly typed State

Usage

The main goal was to have a workflow in code where the state could be persisted (as json) in a database and based on the database record we could recreate the Automation and the State.

Create it in code

using Calway.Automation;

var automation = new EmailWorkflow();
automation.SetState(state => { 
	state.Email = "email@domain.com";
});
automation.NextStep();

Console.WriteLine(automation.LastStepResult.ToString());


public class EmailWorkflowState 
{
	public string Email { get; set; }
	public DateTime FirstEmailSent { get; set; }
	public DateTime ReminderEmailSent { get; set; }
}

public class EmailWorkflow : AutomationEngine<EmailWorkflowState> 
{
	class FirstEmailStep: AutomationStep<EmailWorkflowState>
	{
		public FirstEmailStep(string id, string name) : base(id, name)
        {
        }

		public override bool Action(EmailForkflowState state) 
		{
			// Add code to send the First Email
			state.FirstEmailSent = DateTime.UtcNow;
		}

		/// <summary>
		/// After sending the email we can wait for 14 days before we need to take action again. We could just check every day
		/// but when we already now that any Transition after this Step will be 14 days we can use that to optimize. Since not all
		/// transitions are based on time we need to choose a delay ourselves.
		/// </summary>
		public override DateTime? NextStepTriggerDate(EmailWorkflowState state) => DateTime.UtcNow.AddDays(14);
	}

	class ReminderEmailStep: AutomationStep<EmailWorkflowState>
	{
		public ReminderEmailStep(string id, string name) : base(id, name)
        {
        }

		public override bool Action(EmailForkflowState state) 
		{
			// Add code to send the Reminder Email
			state.ReminderEmailSent = DateTime.UtcNow;
		}

		/// <summary>
		/// After sending the reminder we will wait another 7 days
		/// </summary>
		public override DateTime? NextStepTriggerDate(EmailWorkflowState state) => DateTime.UtcNow.AddDays(7);
	}

	/// <summary>
	/// After sending the First email we wait for 14 days before continuing.
	/// </summary>
	private bool ReminderEmailCondition(EmailWorkflowWState state) => state.FirstEmailSent < DateTime.UtcNow.AddDays(-14);

	public EmailWorkflow() : base()
	{
		AddStep(new FirstEmailStep("first-email", "Send the first Email")
			AddConditionalTransition("reminder-email", ReminderEmailCondition);
		AddStep(new ReminderEmailStep("reminder-email", "Send a reminder Email");
	}
}

This automation start by sending an initial email, and then waits for 14 days before sending a reminder email and waiting 7 days before closing/ending this automation.