Tokyo Railways コンピュータ版のバグ修正

　昨日と今日は「Tokyo Railways コンピュータ版」の障害修正を集中的にやってます。特に今日は、先日にpumpCurryさんがたくさん報告してくれた件をまとめて直していて、コメントにあった２、３、４、８、９をつぶしました。
　この中で一番苦労したのが３番。コメントにあった「保存後読み込み直した時「プレイヤーさんの番です」と出たあと、なにかのはずみでフェイズが１つ進む時があります」というやつです。これは最初は「プレイヤーさんの番です」というダイアログの閉じるボタンのクリックイベントが２回以上入っておきているのだと思ったが、実は違っていた。ダイアログボタンの閉じるボタンのクリックイベントでは、ダイアログを閉じる以上のことは何一つやってなかった。連打はこの問題を引き起こす状態を作り出しやすいが、かならずしもボタンの連打とは関係ない現象だった。
　データをロードしたときの処理は、実は通常のセーブデータと自動セーブデータではちょっとだけ違っている。
　通常のセーブは移動フェイズか建設フェイズで行われるが、自動セーブデータはターン終了フェイズというタイミングでやっている。通常セーブしたデータをロードすると、セーブしたときのフェイズの初期処理をやってから、途中の状態の操作を再実行している。だが自動セーブデータの場合、通常セーブの処理の前にターン終了フェイズを完了させてターンを進行させている。問題の核心は、フェイズの初期処理とフェイズの終了処理はいずれもロード処理とは別のスレッドを作成して実行している点にあった。
　つまり、自動セーブデータのロード処理では以下の２つのスレッドを順番に実行している。
　　(1)ターン終了フェイズの終了処理スレッドの生成・実行
　　(2)現在のフェイズの初期処理スレッドの生成・実行
　この中で(1)のスレッドは非常に処理が短く終わり、(1)と(2)の間の処理は少しだけ重たい処理なので、通常ならば(2)が始まる前に(1)が終わる。つまり(1)のターン終了処理で次のターンに進んで、次のターンプレイヤーの移動処理の初期処理が走る。
　ところが、何らかの理由で(1)で生成されたスレッドが実行される前に(2)が始まってしまう場合がある。その場合には、(2)の現在のフェイズがまだターン終了フェイズのままだったりする。このとき、ターン終了フェイズの初期処理はもう一度データの自動セーブを行った後、そのまま現在のフェイズの終了処理を行ってしまう。そうすると、フェイズ終了処理が２回行われ、２度目の処理の時にはすでに移動フェイズに進んでいて、移動フェイズの終了処理が走ってしまっていた。
　この現象を起こす何らかの理由としては、沢山のスレッドを生成・実行している時というのが一番考えられるが、実はマウスクリック処理は、仕組上、クリックのたびにスレッドを生成・実行している。だからマウスクリックを連打すると沢山のスレッドが生成されてその順番待ちが発生し、(1)で生成されたスレッドの実行が遅れて、(2)に先に到達してしまうのだと思う。
　この現象はCPUコア数が少なければ発生しやすく、シングルコアのPCが一番発生しやすいと思うのだが、実は開発やテスト環境のPCはすべて２つ以上のコアをつんでたりする。だから私が発見できなかったのだと思う。
　で、対策なのだが、実は自動セーブデータのロードの際には(1)の処理は必要なのだが、(2)はいらなかったのだ。だから(2)をスキップすればそれで解決。要するに自動セーブデータと通常セーブデータで条件をきりか分けて処理を分けていたのだが、ちゃんと切り分けきれてなかったというだけの問題だった。それが、こんなスレッドがらみの面倒な不具合につながっていたとはちょっと最初はわからなかった。

　なにはともあれ、解決できてよかった。この問題を報告してくれたpumpCurry様に改めて感謝します。