ネットワーク対戦ゲームの実装に関する考察（リバーシ編）

## サマリー

サーバー ↔ クライアント間の通信は常に遅延する可能性があります。そのため、ステートフルなアプリケーションを実装する際には、因果関係を適切に扱うように実装しないと想定外の状態になってしまう可能性があるので注意が必要です。

## 実装予定のリバーシ

リバーシのネットワーク対戦ゲームを考えます。
![reversi.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/df37847f-24ec-c9d2-6114-1a21d4fd8765.png)

右側のプレイヤーは●（黒石）をボードに置きます。左側のプレイヤーは○（白石）をボードに置きます。


リバーシのボード(盤面)の情報はゲームサーバー側で管理します。プレイヤーの操作にもとづき、ゲームクライアントはインターネット越しにゲームサーバーに対してどのようなアクションを取ったかのメッセージを送信します。

クライアントとサーバーの通信はTCPなどのリアルタイム通信でも良さそうですし、今回の例ではREST APIなどでも実装できるかもしれません。

このリバーシのゲームでは1ターンあたりの制限時間n秒があり、制限時間までにプレイヤーのアクションがゲームサーバーで実行されなかった場合はサーバーが選んだボード上の位置に自動的に石を置きます。

## エッジケース

このリバーシではエッジケースの考慮が必要になってきます。

まず、下記の図のように右プレイヤーが●（黒石）をボードのe3の位置に置こうとしたので、クライアントからサーバーにPutStoneイベントを送信します：
![reversi-a1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/13184fee-a9fd-ddf1-b10c-432ae7a2aae2.png)

しかしネットワークの遅延で、制限時間内にサーバーに届きませんでした。この場合、サーバーが選んだボード上のc5の位置に●（黒石）が自動的に置かれます：
![reversi-a2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/4a78e28b-420a-734b-38f9-766f27c24b1d.png)

左側のプレイヤーが○（白石）をボードに置きます：
![reversi-a3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/1258411f-3ded-90f2-4ee3-aadffd223f8a.png)

再び右側のプレイヤーのターンがやってきました。そして、ちょうどそのタイミングで遅延していた「右側のプレイヤーが●（黒石）をボードのe3の位置に置くアクション（前のターンのもの）」がサーバーに届きました。

サーバーはこのアクションを受け入れたため、下記のボードの状態になってしまいました。：
![reversi-a4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/8f2a4a84-ebe9-32bd-414a-831ae5ee663a.png)

このときのボードの状態は右側のプレイヤーが想定していたものとは異なっています。

右側のプレイヤーとしては、下記のようなボードの状態を想定していたはずです：
![reversi-a5.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/6b7dea34-748a-79ef-3f2e-db8aa0a1fdc8.png)

## 原因

このような状況が発生してしまった原因としては、「遅延して届いたプレイヤーの石を置くアクション」をサーバー側で弾くことなく盤面に適用してしまったためです。プレイヤーの意図したアクションなのか、遅延して届いたアクションなのか、をサーバー側で区別できなかったため発生してしまいました。

## 回避策

これを避けるためには、クライアントとサーバーとでゲームの進行具合を非同期でも良いので同期する必要があります。

今回の場合は下記の方式などが考えられます。

- 対策のパターン A
	- プレイヤーからのアクションを送る際には、「どのターンに対するものなのか」をつけてもらう（メッセージにいわゆる論理クロックのようなものを必ず付与する）
		- 例: `PutStone: ●e3 @turn#1`

- 対策のパターン B
	- ターン切り替わり時にAckメッセージを返してもらう
		- ターン切り替わり時にサーバーはクライアントにターン番号を送ります。それに対してクライアントからサーバーにAckを返送してもらいます。
    		- Ackより後であれば、どのターンに対するアクションなのか、因果関係が判断つきます
		- こちらの方式のほうが他のメッセージの修正が不要ですし、「一定時間Ackが返ってこなかったので切断状態」みたいな判断もしやすそうです。

<!--
- 対策のパターン B'
	- ターン切り替わり時にAckメッセージを返してもらう
    	- クライアントから送られてきたAckの回数によってクライアント側で認識しているターンを特定します
        	- サーバー側では「クライアント側がどのターンのアクションとして送ってきたか？」を特定できるようになります
        - 対策のパターン Bと似ていますが「サーバーからのターン切り替わり指示にターン番号は含まない」という点が異なります。
            - こちらの方がプロトコルの変更に弱いかもしれません（ゲームスタート時からのAck回数を返す挙動が変わるとターン番号の算出が変わってしまう）
-->

このあたりの話は、[O'Reilly Japan - データ指向アプリケーションデザイン](https://www.oreilly.co.jp/books/9784873118703/) の「9.3.1 順序と因果関係」の話が参考になりそうな気がしています。

## 対策のパターン B: ターン切り替わり時にAckメッセージを返してもらう

「対策のパターン B: ターン切り替わり時にAckメッセージを返してもらう」の処理がどのようになりそうかを考えてみます。

まず、サーバーは3ターン目が始まったことを右側のプレイヤーに通知します：
![reversi-b1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/577cb805-8d0a-2e63-3544-2c35cc0a854c.png)

その直後、今回も右側のプレイヤーの「e3に●（黒石）を置くアクション」が遅延してサーバーに届きます。しかしこの場合、3ターン目に対するAckがまだ来ていないため、サーバーはこのアクションを無視します：
![reversi-b2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/3a7705ab-e47c-6188-aa76-aa896e086d6e.png)

右側のプレイヤーは自分の1ターン目の石を置くアクションが失敗し、ゲームが進行していることに気づきます。そこで3ターン目のAckを返送した後に再度石を置くアクションを実行します：
![reversi-b3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/148979/2ee65a7e-5736-5dd7-9ef2-d883130e4e60.png)

この場合であれば、サーバー側とクライアント側とでゲーム進行が一致しているのでアクションが受け入れられます。

## 状態遷移のABA問題

ちょっとした遅延なら良いのです（ギリギリ間に合わなくて相手のターンになってから自分のアクションが届いたなら、すでに相手のターンになってしまっているのでそもそも置けるはずがない）。しかし、ちょうど自分のターンが再び来てしまっていた場合には、「自分のターンかどうか」だけで判断するのでは不十分そうです。

このケースに対応するためには、アクションの因果関係がどうなっているかを特定する必要があります。つまり、上記のような「何ターン目に対するアクションなのか」で弾くようにする必要が出てきます。（これを **状態遷移のABA問題** とでも言ったら良いんでしょうか…？）