外部サービスへ接続する負荷試験を行うには

今回、負荷試験の対象としたのは、BASEのカートシステムです。

カートシステムには決済時に外部サービスを利用する箇所があり、通常の開発時には、外部サービスより提供されている検証環境へ接続しています。

一般的に提供されている検証環境は、本番環境ほどの性能ではなかったり、他の利用者と共用しているというものではないでしょうか。そのため、利用者の都合で自由に高負荷をかけることは難しいと言えます。負荷試験のような高負荷をかけることが可能か否か、また可能な場合、自由に実施してよいか、事前申請が必要かなどを確認し、それなりの準備を行う必要があります。

また利用が可能だったとして、外部サービス要因でパフォーマンス影響が出る懸念、送信するリクエストの制約など、外部サービスの提供する環境を使用する場合に考慮しなければならない点がいくつかあることがわかってきました。

f:id:ymiyamura:20190225153132p:plain

外部サービスへ接続しない

一方で、提供されている検証環境を使用せずに負荷試験を実施することについて検討します。

提供されている検証環境と同等の動作をするモックサービスを用意し、接続先を変更する
提供されている検証環境へ接続する処理を、外部接続せずに処理が完了するように変更する
いっそのことすべてを本番環境で行う

本番環境との差異を小さくするという点において、3を除けば、プログラムの変更が少なくなる1の方法が有利と言えそうです。稼働中のサービスで3を行うのは、リスクが高い上に、検証等の準備を含めるとコストが低いとは言えません。

調査を行ったところ、用意するモックサービスは、

BASEのサービスからのリクエストに対して
処理可能な形式のレスポンスを
適切な時間をかけて返してくれれば十分

という見通しを持つことができました。

これであればモックサービスを準備することが有力な選択肢になるだろうということになり、検討を始めました。

f:id:ymiyamura:20190225153217p:plain

モックサービスとしてSwaggerを検討する

さて、モックサービスをどのように準備するかということになり、調査を開始しました。

たとえば Swagger は、決まったレスポンスを返すモックサーバとして動作してくれるようです。作成したAPI定義がドキュメントとして残るなら、それも良さそうに思えます。ただし、「適切な時間をかけて返す」という部分が解決できないようで、採用を見送ることにしました。

ここでふと、 sleep(1); したいだけであれば、PHPで書いてしまえばよいのでは？と思い直し、PHPで作ってみることにしました。

PHPなら普段から書いていますので、キャッチアップのコストは不要です。

FastRouteで行為に高速なモックサービスを実装する

簡単なPHPで書けるだろうと高を括っていたため、特にウェブアプリケーションフレームワークは使用せずに実装をはじめました。

今回用意したいモックサービスのエンドポイントが8つほどあります。いくつか似たものはあるものの、バリエーションのあるURIであったため、ルーティングがあるといいなと思いました。

そこで FastRoute を使うことにしました。これでルールの一定しないエンドポイントでも、仮にエンドポイントを増やす場合にも拡張が容易になります。ずいぶん楽になりました。

<?
$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\RouteCollector $r) {
    $r->addRoute('GET', '/users', 'get_all_users_handler');
    // {id} must be a number (\d+)
    $r->addRoute('GET', '/user/{id:\d+}', 'get_user_handler');
    // The /{title} suffix is optional
    $r->addRoute('GET', '/articles/{id:\d+}[/{title}]', 'get_article_handler');
});