サービスの結果

サービスの呼び出しは毎回結果を返します（例外がスローされない限り）。結果は成功または失敗のいずれかです。

成功の結果

成功の結果は、すべての操作が問題なく完了したことを示します。

例:

service_result = UsersService::Accept.call(user: User.first)

返却値:

# => <ApplicationService::Result @failure?=false, @success?=true, @user=..., @user?=true>

失敗の結果

失敗の結果は、内部で想定された問題が発生したことを示します。想定された問題は例外をスローせず、fail!メソッドを通じて呼び出されます。

失敗の結果は.callメソッドを使用した場合にのみ発生します。これにより外部APIからのレスポンスを処理できます。

失敗時の結果の例:

# => <ApplicationService::Result @error=There is some problem with the user, @failure?=true, @success?=false>

結果の内容

Resultは結果に関わらずデータを含みます。

成功時にはすべてのoutputアトリビュートが利用可能です。ヘルパーメソッドsuccess?とfailure?で結果を判定します。

service_result = UsersService::Accept.call(user: User.first)

service_result.success? # => true
service_result.failure? # => false

失敗時にはResultにエラーの詳細な説明を含むerrorも格納されます。

service_result = UsersService::Accept.call(user: User.first)

service_result.success? # => false
service_result.failure? # => true

service_result.error
# => #<ApplicationService::Exceptions::Failure: There is some problem with the user>

サービスの失敗について詳しくはこちらをご覧ください。

結果の処理

callによる呼び出し後に結果を処理します。

2つの方法があります: success?/failure?メソッド、またはon_success/on_failureフックです。

メソッド

メソッドsuccess?

service_result = NotificatorService::Slack::Error::Send.call(...)

return if service_result.success?

fail!(
  message: "The message was not sent to Slack",
  meta: { reason: service_result.error.message }
)

メソッドfailure?

failure?に型を渡すと特定の失敗タイプを確認できます。失敗タイプを参照してください。デフォルトの型はall（すべての失敗タイプに一致）です。

service_result = NotificatorService::Slack::Error::Send.call(...)

return unless service_result.failure?

fail!(
  message: "The message was not sent to Slack", 
  meta: { reason: service_result.error.message }
)

特定の失敗タイプを確認する場合:

service_result = NotificatorService::Slack::Error::Send.call(...)

return unless service_result.failure?(:validation)

fail!(
    message: "The message was not sent to Slack",
    meta: { reason: service_result.error.message }
)

述語メソッドで便利な型チェックが可能です:

WARNING

Resultのoutputアトリビュートにも述語メソッドがあります。名前の衝突を避けてください。

service_result = NotificatorService::Slack::Error::Send.call(...)

return unless service_result.all?

fail!(
  message: "The message was not sent to Slack",
  meta: { reason: service_result.error.message }
)

フック

結果処理の代替アプローチです:

NotificatorService::Slack::Error::Send
  .call(...)
  .on_failure do |exception:| 
    fail!(
      message: "The message was not sent to Slack", 
      meta: { reason: exception.message }
    )
  end

on_successメソッドはすべてのoutputアトリビュートを含むoutputs引数を提供します。on_failureに型を渡すこともできます:

NotificatorService::Slack::Error::Send
  .call(...)
  .on_success do |outputs:|
    notification.update!(original_data: outputs.response)
  end.on_failure(:all) do |exception:| 
    fail!(
      message: "The message was not sent to Slack", 
      meta: { reason: exception.message }
    )
  end