型を使ったワークフローの各ステップのモデリング

検証のステップ

code:text

substep "ValidateOrder" =

input: UnvalidatedOrder

output: ValidatedOrder OR ValidationError

dependencies: CheckProduceCodeExists, CheckAddressExists

入力に加えて、2 つの依存関係がある

1. 製品コードが存在するかどうかをチェックするための関数

2. 住所が存在するかどうかをチェックするための関数

https://scrapbox.io/files/669f4d5398f528001cf9073b.png

1. 製品コードが存在するかどうかをチェックするための関数

type CheckProductCodeExists = ProductCode -> bool

2. 住所が存在するかどうかをチェックするための関数

code:fsharp

type CheckedAddress = CheckedAddress of UnvalidatedAddress

type AddressValidationError = AddressValidationError of string

type CheckAddressExists =

UnvalidatedAddress -> Result<CheckedAddress, AddressValidationError>

依存関係を定義できたので、検証のステップは以下のように型定義できる

入出力は型定義済みと仮定する

code:fsharp

type ValidateOrder =

CheckProductCodeExists // 依存関係

-> CheckAddressExists // 依存関係

-> UnvalidatedOrder // 入力

-> Result<ValidatedOrder, ValidationError> // 出力

価格設定のステップ

code:text

substep "PriceOrder" =

input: ValidatedOrder

output: PricedOrder

dependencies: GetProductPrice

このステップには、製品コードが与えられると価格を返す 1 つの依存関係がある

https://scrapbox.io/files/669f506a9680bc001da44da4.png

依存関係を文書化する

code:fsharp

type GetProductPrice =

ProductCode -> Price

ステップ全体の型定義

code:fsharp

type PriceOrder =

GetProductPrice // 依存関係

-> ValidatedOrder // 入力

-> PricedOrder // 出力

注文確認のステップ

このステップでは、確認書を作成して、顧客に送信する

「確認書」のモデル作成

電子メールで送信する予定の HTML 文字列を含む

code:fsharp

type HtmlString = HtmlString of string

code:fsharp

type OrderAcknowledgment = {

EmailAddress: EmailAddress

Letter: HtmlString

}

顧客情報と注文内容に基づいて、テンプレートのようなものから作成される

code:fsharp

type CreateOrderAcknowledgmentLetter = PricedOrder -> HtmlString

確認書を「送る」処理をどう表現するか？

一般的に駄目なインタフェースの例

type SendOrderAcknowledgment = OrderAcknowledgment -> unit

🙅: 呼び出し元から送られたかどうかを判別できない

type SendOrderAcknowledgment = OrderAcknowledgment -> bool

type SendOrderAcknowledgment = OrderAcknowledgment -> OrderAcknowledgmentSent option

改善例

code:fsharp

type SendResult = Sent | NotSent

type SendOrderAcknowledgment =

OrderAcknowledgment -> SendResult

出力

「送信した」イベントを返すようにする

code:fsharp

type OrderAcknowledgmentSent = {

OrderId: OrderId

EmailAddress: EmailAddress

}

ステップ全体の型定義

code:fsharp

type AcknowledgeOrder =

CreateOrderAcknowledgmentLetter // 依存関係

-> SendOrderAcknowledgment // 依存関係

-> PricedOrder // 入力

-> OrderAcknowledgmentSent option // 出力

イベントの作成

code:text

workflow: "Place order" =

input: UnvalidatedOrder

output (on successs):

OrderAcknowledgmentSent

AND OrderPlaced (to send to shipping)

AND BillableOrderPlaced (to send to billing)

output (on error):

ValidationError

code:fsharp

type OrderPlaced = PricedOrder

code:fsharp

type BillableOrderPlaced = {

OrderId: OrderId

BillingAddress: Address

AmountToBill: BillingAmount

}

返すイベントをどう表現するか？

code:fsharp

type PlaceOrderResult = {

OrderPlaced: OrderPlaced

BillableOrderPlaced: BillableOrderPlaced

OrderAcknowledgmentSent: OrderAcknowledgmentSent option

}

更新が難しくなる

e.g. ワークフローに新しいイベントを追加する

code:fsharp

type PlaceOrderEvent =

| OrderPlaced of OrderPlaced

| BillableOrderPlaced of BillableOrderPlaced

| OrderAcknowledgmentSent of OrderAcknowledgmentSent

ワークフロー全体を壊すことなく更新できる

より一般的な概念を作ることもできる

ステップ全体の型定義

code:fsharp

type CreateEvents =

PricedOrder -> PlaceOrderEvent list