【ruby on rails】railsで非同期処理時に返り値をうけとりたい

Question

ruby on railsで、非同期処理の結果を受け取って、controllerが呼び出された際にブラウザ上に表示したいです。
activeJobとSidekiqを用いることを想定しています。

現状は以下の通りです。

• job

#app/jobs/test_job.rb 
   class TestJob < ApplicationJob                                                                                                                        
     queue_as :default                                                                                                                                       
                                                                                                                                                             
     def perform(**message)                                                                                                                                                                                                                                                            
       message["hello"]="world"                                                                                                                              
       return message                                                                                                                                        
     end                                                                                                                                                     
   end  

• controller

#app/controllers/test_controller.rb
   class TestController < ApplicationController                                                                                                              
     def index                                                                                                                                               
         @message={}                                                                                                                                         
         @message=TestJob.perform_later(@message)                                                                                                        
                                                                                                                                                             
         render json: @message                                                                                                                               
     end                                                                                                                                                     
   end  

• 理想とする表示

{hello:world}

• 実際の表示

{
  "arguments":[
    {}
  ],
  "job_id": "4b55f945-a2a2-4711-9229-060c0a567aef",
  "queue_name": "default",
  "priority": null,
  "executions": 0, 
  "provider_job_id": "e04782f39c95840de0689a70"
}

どうやら自分のコードだとmessageはenqueueの成功状況を受け取っているっぽい＆ActiveJobでreturnはつかえなさそう　ということは想像がついたのですが、正しい方法に自力では行きつけませんでした。

どなたかご教授お願いいたします。

また先述の通り非同期処理にはsidekiqを使っていますが、sidekiqで無理ということであれば別のgemもしくはやり方を教えていただけると助かります。

（追記）
最終的には、とあるAPIから１０件程度のデータをうけとって、そのデータ１件１件を別のあるAPIに投げていき、それらすべての結果を表示するといったことをやりたいと考えています。
別APIからのレスポンスを受け取るのが、１件あたり2秒、合計で２０秒ほどかかってしまうので、非同期処理にしようとしてる次第です

Answer 1

なんとなく、非同期処理について何かしらの誤解があるように見えますね…。
通常のWebの同期処理と非同期処理についてざっくりまとめると以下のようになります。

• 通常のWebの処理（同期処理）: ユーザからのリクエストに対して何かの処理を行い、それをユーザにレスポンスとして返す。返した内容がブラウザに表示される。
• 非同期処理: ユーザのリクエストについての処理をレスポンスとして返さず、裏側で実行しておいて、別途何かしらの方法で伝える。

というわけで、「controllerが呼び出された際にブラウザ上に表示」するのであれば、同期処理として返した方が簡単です。

よくある非同期処理としては、ブラウザでは「処理を開始しました」とだけ返して、処理結果はメールで伝えるようなものですね。
もう少し凝ったものとしては、処理時間が長そうな場合、いったんブラウザでは「実行中…」的な文言を返しつつ、非同期処理の結果はWebSocket等で返す、といったものです。こちらはActionCableとかを使うことになりそうです。

どうして非同期処理をしたいのか、どういうふうに結果を返したいのかをもう少し考え直してみるとよいかもしれません。

Comments

[FumiakiNakao]

回答ありがとうございます。
おっしゃる通り、非同期処理の概念を誤解していたように思います。勉強しなおしてきます。

また、こちらの状況説明も足りませんでした。
最終的には、とあるAPIから１０件程度のデータをうけとって、そのデータ１件１件を別のあるAPIに投げていき、それらすべての結果を即時表示するといったことをやりたいと考えています。
別APIからのレスポンスを受け取るのが、１件あたり2秒、合計で２０秒ほどで、「実行中」というサークルを出すにも限界があるなとおもったので非同期で処理したいと考えていた次第です

ActionCableという概念は今まで知らなかったので非常に参考になりました　ありがとうございました

Answer 2

皆様回答ありがとうございました。

結局、非同期でおこないたい処理がhttp requestに限定されていたことから、typhoeusというgemを使って解決いたしました。

ですが、皆様の回答の中には自分が今まで使ったことのない機能があり、大変勉強になりました。今後参考にさせていただこうと思います.

Answer 3

非同期処理の結果をリアルタイムで受け取りたいという話でしたら、下記のような構成はいかがでしょうか？

実装内容は

クライアントサイド

・job実行リクエスト
・websocket(もしくはpolling)で非同期処理の結果の監視

サーバーサイド

・job実行リクエストの受付
・jobの実行
・jobの結果をwebsocket（もしくはpolling）で返す

jobの処理

・やりたい処理
・jobの結果をデータベースに保存する

シーケンス的には

１. クライアント→サーバー （job実行リクエスト）
２. サーバー→job （jobの呼び出し・実行）
３. サーバー→クライアント （job実行リクエストのレスポンスaccepted）

＊＊＊＊＊＊＊＊＊＊＊　websocket（もしくはpolling）で繰り返し
４. クライアント→サーバー（結果の取得リクエスト）
５. サーバー→クライアント（結果の取得リクエストのレスポンス）
＊＊＊＊＊＊＊＊＊＊＊

６. job→データベース （結果の登録）

非同期なので書くのが難しいですが、処理4、5を繰り返して、jobが更新するデータを返す。

Answer 4

重たい処理を、同期的っぽく処理しているように見せたいことはよくありますね。
Sidekiqだと終わったjobを消す運用の場合もあり、job_idを引き回したとしても上手にとれないことがあるので、perform_later自体の返り値を云々するのは、ちょっと難しいように思います。

実際のユースケースによるのですが、messageが永続化しても問題ない程度の「概念」を表しているのであれば、
messageをModel化してしまって、こんな感じの処理を書くことがあります。

class Message < ApplicationRecord
  # finished:boolean default: false
  # hello:text
  # 的なモデル
end

class TestJob < ApplicationJob
  def perform(message)

    # ものすごく重たい処理
    message.hello = 'world'
    # ものすごく重たい処理

    message.finished = true
    message.save!
  end
end

class TestController < ApplicationController
  # GET /test
  def index
    @message = Message.create!
    TestJob.perform_later(@message)
  end

  # GET /test/1
  def show
    @message = Message.find(params[:id])
    render json: @message
  end
end  

<script>

// 要jQuery
// 動作確認はしてない。ニュアンスが伝われば
var timer = setInterval(function(){
  $.getJSON('/test/<%= @message.id %>.json', function(data){
    if(data.finished) {
      $('#result').html(data.hello);
      clearInterval(timer);
    }
  });
}, 1000)
</script>

<pre id="result">now processing...</pre>

注意点として、Messageモデルはどんどん溜まってしまうので、定期実行でゴミを消すなどが必要でしょう。
(finishedをfinished_atにして、時間が経過していたら消してしまう、など)

Comments

[FumiakiNakao]

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

初心者的な質問で申し訳ないのですが、これは「`rails g model`などでモデル作成して、データをため込んでいく」というやり方ですかね？

最終的には、とあるAPIから１０件程度のデータをうけとって、そのデータ１件１件を別のあるAPIに投げていき、それらすべての結果を表示するといったことをやりたいと考えています。
別APIからのレスポンスを受け取るのが、１件あたり2秒、合計で２０秒ほどかかってしまうので、非同期処理にしようとしてる次第です

この状況で、教えてくださった方法は適切ですか？

追加で答えてくださると幸いです　よろしくお願いいたします！

[takumiabe]

> 「`rails g model`などでモデル作成して、データをため込んでいく」
そのとおりです。

> この状況で、教えてくださった方法は適切ですか？

その重さであれば、非同期処理にする他ないとは思います。

あとは、ユーザーが完了を知る必要がどれぐらい即座に必要か、というところです。

あらっぽくで良ければ、上記の1秒毎に簡易APIチェック、でも大丈夫でしょう。
ほぼリアルタイムに、であれば、他の方が示唆されておられるとおり、ActionCable / WebSocket のような、サーバーからのpush型のやりとりが必要になるかと思います。

たとえば、ajaxによる画像アップロードの実装を探して、参考にされるのも良いかもしれません。