番号札デラックス

defmodule AnnoyingPassengerAutoresponder do
  use GenServer
  # Client API

  def start_link(init_arg) do
    GenServer.start_link(__MODULE__, init_arg)
  end

  def are_we_there_yet?(pid) do
    GenServer.call(pid, :are_we_there_yet?)
  end

  # Server callbacks

  @impl GenServer
  def init(_init_arg) do
    # the initial count of questions asked is always 0
    state = 0
    {:ok, state}
  end

  @impl GenServer
  def handle_call(:are_we_there_yet?, _from, state) do
    reply =
      cond do
        state <= 3 -> "No."
        state <= 10 -> "I told you #{state} times already. No."
        true -> "..."
      end

    # increase the count of questions asked
    new_state = state + 1
    # reply to the caller
    {:reply, reply, new_state}
  end
end

説明

基本的なTake-A-Numberマシンはとてもよく売れていましたが、市場に出回っている他のモデルに比べて高度な機能が足りない、と一部のユーザーから不満の声が上がっていました。

メーカーはユーザーの声に耳を傾け、より多くの機能を備えたデラックスモデルを発売することを決めました。そして、今回もこのマシンのソフトウェアを書く仕事を任されることになりました。

デラックスモデルに追加された新しい機能は次のとおりです。

• 現在順番待ちしている番号を管理すること。
• 最小番号と最大番号を設定できること。これにより、同じ施設内の異なる部署にお客さんを並ばせるために複数のデラックスTake-A-Numberマシンを使い、番号の範囲で部署を見分けられるようになります。
• 妊婦やお年寄りに優先サービスを提供するため、特定の番号が列を飛ばせるようにすること。
• うっかり週末中マシンの電源を入れっぱなしにしてエネルギーを無駄にするのを防ぐ、自動シャットダウン。

マシンのビジネスロジックは同僚によってすでに実装されていて、モジュールTakeANumberDeluxe.Stateにあります。ここでの作業は、それをGenServerで包むことです。

1. マシンを起動する

モジュールTakeANumberDeluxeでGenServerビヘイビアを使います。

関数start_link/1と、必要なGenServerコールバックを実装します。

start_link/1に渡される引数はキーワードリストです。:min_numberと:max_numberというキーを含んでいます。これらのキーの値は、関数TakeANumberDeluxe.State.new/2に渡す必要があります。

関数TakeANumberDeluxe.State.new/2が{:ok, state}というタプルを返したら、返された状態をマシンの状態として、マシンを起動します。代わりに{:error, error}というタプルを返したら、返されたエラーを停止理由として、マシンを停止します。

TakeANumberDeluxe.start_link(min_number: 1, max_number: 9)
# => {:ok, #PID<0.174.0>}

TakeANumberDeluxe.start_link(min_number: 9, max_number: 1)
# => {:error, :invalid_configuration}

関数TakeANumberDeluxe.State.new/2が省略可能な3番目の引数auto_shutdown_timeoutも受け取ることに気づいたかもしれません。これはこの演習の最後のステップで使います。

2. マシンの状態を報告する

関数report_state/1と、必要なGenServerコールバックを実装します。マシンは呼び出し元に現在の状態を返信します。

{:ok, machine} = TakeANumberDeluxe.start_link(min_number: 1, max_number: 10)
TakeANumberDeluxe.report_state(machine)
# => %TakeANumberDeluxe.State{
#      max_number: 10,
#      min_number: 1,
#      queue: %TakeANumberDeluxe.Queue{in: [], out: []},
#      auto_shutdown_timeout: :infinity,
#    }

3. 新しい番号をキューに追加する

関数queue_new_number/1と、必要なGenServerコールバックを実装します。

マシンの現在の状態を渡して、関数TakeANumberDeluxe.State.queue_new_number/1を呼び出します。

関数TakeANumberDeluxe.State.queue_new_number/1が{:ok, new_number, new_state}というタプルを返したら、マシンは呼び出し元に新しい番号を返信し、新しい状態を自身の状態として設定します。代わりに{:error, error}というタプルを返したら、マシンは呼び出し元にエラーを返信し、状態は変更しません。

{:ok, machine} = TakeANumberDeluxe.start_link(min_number: 1, max_number: 2)
TakeANumberDeluxe.queue_new_number(machine)
# => {:ok, 1}

TakeANumberDeluxe.queue_new_number(machine)
# => {:ok, 2}

TakeANumberDeluxe.queue_new_number(machine)
# => {:error, :all_possible_numbers_are_in_use}

4. 次に待っている番号を呼び出す

関数serve_next_queued_number/2と、必要なGenServerコールバックを実装します。

マシンの現在の状態と、2番目の省略可能な引数priority_numberを渡して、関数TakeANumberDeluxe.State.serve_next_queued_number/2を呼び出します。

関数TakeANumberDeluxe.State.serve_next_queued_number/2が{:ok, next_number, new_state}というタプルを返したら、マシンは呼び出し元に次の番号を返信し、新しい状態を自身の状態として設定します。代わりに{:error, error}というタプルを返したら、マシンは呼び出し元にエラーを返信し、状態は変更しません。

{:ok, machine} = TakeANumberDeluxe.start_link(min_number: 1, max_number: 10)
TakeANumberDeluxe.queue_new_number(machine)
# => {:ok, 1}

TakeANumberDeluxe.serve_next_queued_number(machine)
# => {:ok, 1}

TakeANumberDeluxe.serve_next_queued_number(machine)
# => {:error, :empty_queue}

5. 状態をリセットする

関数reset_state/1と、必要なGenServerコールバックを実装します。

現在の状態のmin_numberとmax_numberを使って、関数TakeANumberDeluxe.State.new/2を呼び出し、新しい状態を作成します。マシンは新しい状態を自身の状態として設定します。呼び出し元には返信しません。

{:ok, machine} = TakeANumberDeluxe.start_link(min_number: 1, max_number: 10)

TakeANumberDeluxe.reset_state(machine)
# => :ok

6. 自動シャットダウンを実装する

マシンの起動処理を変更します。init_argとして渡されたキーワードリストのキー:auto_shutdown_timeoutの値を読み取り、それを3番目の引数としてTakeANumberDeluxe.State.new/3に渡します。:auto_shutdown_timeoutが指定されていなければ、デフォルト値の:infinityを使います。

マシンの状態のリセット処理も変更し、auto_shutdown_timeoutをTakeANumberDeluxe.State.new/3に渡すようにします。

実装したすべてのコールバック（init/1とすべてのhandle_*コールバック）の戻り値に、タイムアウトを設定するよう変更します。現在のマシンの状態にあるキー:auto_shutdown_timeoutの値を使います。init/1の戻り値{:stop, reason}にはタイムアウトを追加しないでください。タイムアウトは、サーバーが受信ループを開始した後にのみ適用されます。

指定されたタイムアウト内に他のメッセージを一切受信しなかった場合にマシンへ送られる:timeoutメッセージを処理するGenServerコールバックを実装します。理由:normalでプロセスを終了させます。

予期しないメッセージも、無視して処理するようにしてください。

{:ok, machine} =
  TakeANumberDeluxe.start_link(
    min_number: 1,
    max_number: 10,
    auto_shutdown_timeout: :timer.hours(2)
  )

# after 3 hours...

TakeANumberDeluxe.queue_new_number(machine)
# => ** (exit) exited in: GenServer.call(#PID<0.171.0>, :queue_new_number, 5000)
#        ** (EXIT) no process: the process is not alive or there's no process currently associated with the given name, possibly because its application isn't started
#       (elixir 1.13.0) lib/gen_server.ex:1030: GenServer.call/3