foreach()内で async/await を使うな

March 10, 2022

はじめに

自戒をこめて書きますシリーズ第 2 弾です． foreach() に渡すコールバックでは async/await を使うなという話です．

foreach() に渡したコールバック関数の戻り地は無視されている

foreach() の内部実装を見てみましょう．

// Production steps of ECMA-262, Edition 5, 15.4.4.18
// Reference: http://es5.github.io/#x15.4.4.18

if (!Array.prototype["forEach"]) {
  Array.prototype.forEach = function (callback, thisArg) {
    if (this == null) {
      throw new TypeError("Array.prototype.forEach called on null or undefined");
    }

    var T, k;
    // 1. Let O be the result of calling toObject() passing the
    // |this| value as the argument.
    var O = Object(this);

    // 2. Let lenValue be the result of calling the Get() internal
    // method of O with the argument "length".
    // 3. Let len be toUint32(lenValue).
    var len = O.length >>> 0;

    // 4. If isCallable(callback) is false, throw a TypeError exception.
    // See: http://es5.github.com/#x9.11
    if (typeof callback !== "function") {
      throw new TypeError(callback + " is not a function");
    }

    // 5. If thisArg was supplied, let T be thisArg; else let
    // T be undefined.
    if (arguments.length > 1) {
      T = thisArg;
    }

    // 6. Let k be 0
    k = 0;

    // 7. Repeat, while k < len
    while (k < len) {
      var kValue;

      // a. Let Pk be ToString(k).
      //    This is implicit for LHS operands of the in operator
      // b. Let kPresent be the result of calling the HasProperty
      //    internal method of O with argument Pk.
      //    This step can be combined with c
      // c. If kPresent is true, then
      if (k in O) {
        // i. Let kValue be the result of calling the Get internal
        // method of O with argument Pk.
        kValue = O[k];

        // ii. Call the Call internal method of callback with T as
        // the this value and argument list containing kValue, k, and O.
        callback.call(T, kValue, k, O);
      }
      // d. Increase k by 1.
      k++;
    }
    // 8. return undefined
  };
}

mdn web docs より引用．[1]

ポイントは以下です．

callback.call() には await がついていない．
callback.call() の返り値は無視される（扱われていない）．
そもそも foreach() は非同期関数(async function)ではない．

このことから foreach() に async function を渡しても Promise オブジェクトは無視され，実行の終了は待たれません．解決策としては以下の 2 つが考えられます．

"for-of" を使う

for (let d of data) {
  await someFunc(d);
}

シンプルな方法です．これで問題はないパターンも多いですが，この書き方では直列的な実行になります．それぞれが独立した処理で，並列で処理できる場合には後述する手法の方が好ましいでしょう．

"Promise.all()" を使う

Promise.all(
  data.map((d) => {
    await someFunc(d);
  }),
);

map() で Promise の配列を生成し， Promise.all() で解決させます．こちらは並列に実行できます．

さいごに

await 句は「実行の終了を待つ」ではなく，「Promise オブジェクトが返された場合に resolve もしくは reject されるのを待つ」と捉えた方が良いでしょう，という気付きでした．「強烈に甘い書き方」を「脱糖」するとどうなるのかについて，忘れないようにしたいものです．

参考

1. Array.prototype.forEach() - JavaScript | MDN