PHP：jsonを返すAPI制作時のタイムアウトエラー処理に関して

Question

PHPで外部公開のAPIを制作する際、タイムアウト関連のエラー処理は皆様どのように実装しておりますでしょうか？
※戻り値はjson形式

①外部からAPIを叩く側は10秒間レスポンスが無ければタイムアウトで再起の処理に入ります。

②API側で10秒間レスポンスを返せていないことを判断するのは難しいかと思います。

この場合、jsonを返す直前にAPIを叩いた側との接続が切れていないか？を判断出来ればよいかと考えておりますが、実装方法が検討ついておりません。

どなたでも構いませんので、知恵をお貸し下さい。宜しくお願い致します。

Answer 1

これはクライアント側のajaxの最大待ち時間を設定したいと話でしょうか？
それともサーバー側のタイムアウト設定の話でしょうか？

前者であればpromise内でsetIntervalなどでxhr処理が終わっているかを
繰り返しチェックし、上限が来たらrejectすればよいと思います
後者であればサーバー設定でできると思います

sample

よくよくテストしてみましたが
ignore_user_abort()をチェックするために出力が必要なようで、
そうとう姑息ですがこんな感じでどうでしょうか？

※必要なファイル

• send.htm
• recv.php
• log.txt

※テスト方法1
send.htmの※注1の7＝最大7秒でタイムアウトする
recv.phpの※注2の5＝5秒かんウェイトをかける
結果：5秒間カウントダウンして、JSONデータを受け取る
このときlog.txtには5秒間カウントダウンしたデータが出力されている

※テスト方法2
send.htmの※注1の7を2に書き換える＝最大2秒でタイムアウトする
recv.phpの※注2の5＝5秒かんウェイトをかける、そのまま
結果：2秒間カウントダウンして、errになる
このときxhrがabortされ接続は切断されるので、logには2秒分のログしか残らない

send.htm

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script>
new Promise(function(resolver,rejector){
  var timerId;
  var fd=new FormData();
  fd.append('x','test');
  var xhr = new XMLHttpRequest();
  xhr.open('POST','recv.php');
  xhr.addEventListener("load" ,function() {
    clearInterval(timerId);
    return resolver(this);
  });
  var count=7;//※注1
  timerId=setInterval(function(){
    console.log(count);
    count--;
    if(count==0){
      clearInterval(timerId);
      xhr.abort();
      return rejector(this);
    }
    
  },1000);
  xhr.send(fd);
}).then(function(xhr){
  console.log(JSON.parse(xhr.response));
  console.log("end");
}).catch(function(){
  console.log("err");
});
</script>

recv.php

<?PHP
ignore_user_abort(false);
set_time_limit(1);
set_error_handler('myErrorHandler');
function myErrorHandler($errno, $errstr){
  if($errno==E_NOTICE and preg_match("/^ob_end_clean/",$errstr)){
    return true;
  }else{
    return false;
  }
}
file_put_contents('log.txt','');
for ( $i=0 ; $i<5; $i++){ //※注2:
  echo("\r");
  flush();
  try{
    ob_end_clean();
  }catch(exception $e){
    print $e->getMessage();
  }
  
  file_put_contents('log.txt',"$i..".connection_aborted()."(".connection_status().")".PHP_EOL,FILE_APPEND);
  sleep(1);
}
print json_encode($_POST);
?>

log.txt:空ファイル

Comments

[akira_12]

説明不足、申し訳ありません。

ご回答ありがとうございます。

まず、クライアント側のajaxの待ち時間が最大10秒に設定されている状況（外部ベンダーが別途制作）です。

クライアントから叩かれたAPIの処理実行時間が10秒を上回ってしまった場合、jsonを吐き出した瞬間には既にクライアント側でタイムアウト処理にて切断（結果がクライアント側に返らない状況）になってしまいます。

この時、サーバー側でクライアント側のタイムアウト処理に引っかかったのでjsonを返さない。という仕組みを組み込めないかと考えております。

[yambejp]

返ってきたjsonを無視すれば済む話だとおもますが
クライアントがサーバーのタイムアウトを制御する必要があるなら
APIがその機能を実装していないと無理でしょう
具体的にはクライアントからサーバーにJSONを要求する際に
パラメータとして上限時間をわたし、APIがその上限時間で
処理をやめるという機能です

[akira_12]

再度の説明不足、申し訳ありません。

制作するのはAPI側となります。

サーバー側でjsonを返す（内部処理をコミットする）か否かを判断したいと考えております。

[raichi]

サーバー側だと、一発目のAPIの後、「正常終了した」という通信(API)をアプリ側からサーバー側で受け取らないと、実現できないような気がしますよ？

[yambejp]

いろいろテストしてみました
時間があれば試してみて下さい

ちなみに、「内部処理をコミットするか否かを判断したい」という場合は
ignore_user_abort(true);としておいて、ignore_user_abort()の
値をみて分岐することになるでしょう

Answer 2

接続処理を参考にすると実装出来るのではないでしょうか？
ぱっと見た感じだと、connection_aborted() 関数辺りが使えるかと思います。

Comments

[akira_12]

ご回答ありがとうございます。

connection_abortedは試してみましたがダメでした。
①外部からAPIをコール
②API側で強制的にタイムアウトを起こすようにスリープ10秒を設定
③念のため外部からAPIをコールしたブラウザを閉じる
④API側でコールされたが接続が切れた状態を作り出した上でconnection_abortedを実行
⑤切断されていないという戻り値

引き続きご教授戴きました接続処理、参考にさせて戴きます。