1005281342/iwf-golang-samples

samples for iWF-Golang-SDK

iwf-golang-samples

Samples for iWF Golang SDK that runs against iWF server

Setup

1. Start a iWF server following the instructions
2. Run this project

• To build the binary, run make bins
• To run the sample service: run ./iwf-samples start

Note that by default this project will listen on 8803 port(default worker port for iWF Golang SDK)

Product Use case samples

Subscription workflow

This Subscription workflow (with unit tests) is to match the use case described in

• Temporal TypeScript tutorials
• Temporal go sample
• Temporal Java Sample
• Cadence Java example

Use case statement

Build an application for a limited time Subscription (eg a 36 month Phone plan) that satisfies these conditions:

1. When the user signs up, send a welcome email and start a free trial for TrialPeriod.

2. When the TrialPeriod expires, start the billing process.

• If the user cancels during the trial, send a trial cancellation email.

3. Billing Process:

• As long as you have not exceeded MaxBillingPeriods, charge the customer for the BillingPeriodChargeAmount.
• Then wait for the next BillingPeriod.
• If the customer cancels during a billing period, send a subscription cancellation email.
• If Subscription has ended normally (exceeded MaxBillingPeriods without cancellation), send a subscription ended email.

4. At any point while subscriptions are ongoing, be able to look up and change any customer's amount charged and current status and info. 

Of course, this all has to be fault tolerant, scalable to millions of customers, testable, maintainable, and observable.

How to run

To start a subscription workflow:

• Open http://localhost:8803/subscription/start

It will return you a workflowId.

The controller is hard coded to start with 20s as trial period, 10s as billing period, $100 as period charge amount for 10 max billing periods

To update the period charge amount :

• Open http://localhost:8803/subscription/updateChargeAmount?workflowId=&newChargeAmount=

To cancel the subscription:

• Open http://localhost:8803/subscription/cancel?workflowId=

It's recommended to use a iWF state diagram to visualize the workflow design like this:

iWF feature samples

1. Basic IO workflow: Open http://localhost:8803/basic/start in your browser. This workflow demonstrates:
   • How to start workflow with input and get output
   • How to pass input from a state to a next state
2. Persistence workflow: Open http://localhost:8803/persistence/start in your browser. This workflow demonstrates:
   • How to use data objects to share data across workflows
   • How to use search attributes to share data and also searching for workflows
   • How to use record events API
   • How to use StateLocal to pass data from start to decide API
3. Signal workflow: Open http://localhost:8803/signal/start in your browser. This workflow demonstrates:
   • How to use signal
   • How to use AnyCommandCompleted trigger type
   • State1 start API will wait for two signals, when any of them is received, the decide API is trigger
4. Timer workflow: Open http://localhost:8803/timer/start in your browser. This workflow demonstrates:
   • How to use a durable timer
   • State1 start API will wait for a timer, when timer fires, the decide API is trigger
5. InterstateChannel workflow: Open http://localhost:8803/interstateChannel/start in your browser. This workflow demonstrates:
   • How to use interstate channel to synchronize multi threading/in parallel workflow execution
   • State0 will go to State1 and State2
   • State1 will wait for a InterStateChannel from State2
   • State2 will send a signal and then finish as a "dead end"

Then watch the workflow in Cadence or Temporal Web UI

See more samples in SDK integration tests for how to interact with the clients.