2
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

届けこの思い(JavaScript内からOutSystemsのAll Exceptionsまで)〜rejectと$rejectに振り回された話〜

2
Posted at

はじめに

OutSystemsでJavaScriptを使った処理を書いていると、
例外を All Exceptions で拾えると思っていたのに拾えない、
という状況にハマることがありました。

特に Promise の reject と $reject の違いを理解していなかったことで、
エラーハンドリングにかなり混乱しました。

やりたかったこと

画面上で動く JavaScript を使った処理について、
責務を分けるために2つのクライアントアクションに分割していました。

  • クライアントアクションA
    • 画面コンポーネントの初期化処理を担当
    • JavaScript で各種設定を行う
    • イベント発火時に呼ばれるハンドラもここで定義する
  • クライアントアクションB
    • ユーザー操作をきっかけに呼ばれる処理
    • アクションAで定義したハンドラを実行する役割

構成としては、

  • 初期化や設定処理はアクションAにまとめたい
  • 実際のイベント発火や画面側の制御はアクションBで行いたい

という意図がありました。

そのため、
初期化やハンドラ定義を行うアクションA側で発生したエラーを、
呼び出し元であるアクションBの All Exceptions でまとめてハンドリングしたい

と考えていました。

実際に起きたこと

  • アクションAの JavaScript では、確かにエラーが発生していました
  • しかし、アクションBの All Exceptions ではエラーを受け取れませんでした
  • JavaScript 側で throw や reject をしても、想定していたように例外が伝播しませんでした

なぜ混乱したか

JavaScript の感覚では、

  • Promise を reject すれば
  • 呼び出し元で catch できる
  • = OutSystems 側でも例外として拾える

と考えていましたが、これは OutSystems では成立しませんでした。

本当の原因:reject と $reject の違い

この違いを理解できていなかったことが、最大の原因でした。

reject

  • JavaScript の Promise を失敗させるだけのものです
  • JavaScript の世界ではエラーとして扱われます
  • OutSystems のクライアントアクションの例外にはなりません

$reject

  • OutSystems に対して「この処理は失敗した」と伝えるためのものです
  • クライアントアクションとして失敗扱いになります
  • All Exceptions で拾える対象になります

つまり、

reject = JavaScript の失敗
$reject = OutSystems の失敗

という違いがありました。

どうやったら実現できたか

ポイントは reject と $reject の役割を分けて使うことでした。

OutSystems の Client Action から呼ばれる JavaScript では、

  • reject
    JavaScript 内で処理が失敗したことを示すだけ
  • $reject
    OutSystems 側に「例外」として伝えるためのもの

という違いがあります。

この違いを意識せずに実装していると、
JavaScript ではエラーになっているのに、
All Exceptions まで例外が届かない、という状態になります。


実装イメージ(実際の構成)

アクションA(初期化・ハンドラ定義)

  • 画面コンポーネントの初期化処理を担当
  • JavaScript 内でイベントハンドラを定義している
  • アクションBから呼び出される側
  • 処理中に問題が発生した場合は、reject で JavaScript として失敗を返す

アクションB(呼び出し元)

  • ユーザー操作をきっかけに実行される
  • JavaScript からアクションAをキックする
  • アクションAから失敗が返ってきた場合は、$reject を使って OutSystems の例外として扱う

学び

  • reject は JavaScript の世界の失敗
  • $reject は OutSystems に例外を届けるための手段
  • どの Client Action で $reject するかを決めないと、エラーは途中で止まってしまう

まとめ

OutSystems の JavaScript では、
「エラーを投げる」よりも、
「どこで例外として扱うか」を考えることが重要でした。

reject と $reject を役割ごとに使い分けることで、
別の Client Action からキックした処理でも、
例外は迷子にならず All Exceptions まで辿り着きました。

注意

今回のやり方は「All Exceptions まで例外を届けたい」ケースで有効でしたが、

  • すべてのエラーを All Exceptions で拾うべきかどうかは、画面や処理の責務に応じて設計する必要があります
  • 例外として扱うべきものと、制御フローとして扱うべきものは分けて考える方が安全です

また、reject や $reject の正確な挙動や使いどころについては、
OutSystemsの公式ページを一度きちんと確認することをおすすめします。

この記事は「こういうハマり方をした」という一例なので、
プロジェクトや設計方針に合わせて使い分けてください。

2
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?