nodeのutil.promisifyの実装について

Question

https://github.com/nodejs/node/blob/master/lib/internal/util.js#L256-308

nodeのpromisifyの実装ですが、229行目でsetPrototypeOfを行っていると思います、
特に必要ないと思うのですが、なぜsetPrototypeOfを行っているかわかるでしょうか？
こういうケースで必要などあれば教えていただけないでしょうか？

該当部分をざっくり書くと、このような実装になっており★部分のsetPrototypeOfしている理由を知りたいです

function promisify(original) { 
   function fn(...args) { 
      return new Promise((resolve)=>{
          original.call(this, ...args, (err, ...values) => {
              resolve(promise, values[0]); 
          }) 
      }
   }
      
   Object.setPrototypeOf(fn, Object.getPrototypeOf(original));   // ★ setPrototypeOfをなぜ行う？？？
   Object.defineProperties(fn, Object.getOwnPropertyDescriptors(original)); 
   return fn
} 

Answer 1

私がそのコードを書いたわけではないので、以下は推測です。

実験としてその行を消すと、おそらく↓のテストが失敗するでしょう。
/test/parallel/test-util-promisify.js

ケースとしては以下が思いつきました。

1. 別のコンテキストから得た関数を promisify するケース
2. class Foo extends Function のインスタンスを promisify するケース

1. 別のコンテキストから得た関数を promisify するケース

vm.runInNewContext の結果として得られるオブジェクトは、vm.runInNewContext を実行しているのとは別のコンテキストで生成されたものになり、文字列にすると同じでも、instanceof の結果が異なります。

const array1 = [1, 2, 3];
console.log(array1);
// → [1, 2, 3]

const array2 = vm.runInNewContext('[1, 2, 3]');
console.log(array2);
// → [1, 2, 3]

console.log([Array.isArray(array1), array1 instanceof Array]);
// → [true, true]
console.log([Array.isArray(array2), array2 instanceof Array]);
// → [true, false]

ブラウザでも Web Worker や iframe を扱う時に注意が必要なポイントです。
参考文献：instanceof と複数のコンテキスト

setPrototypeOf により、別のコンテキストの関数を promisify した後の関数も、prototype としてその別のコンテキストの Function.prototype を持つことになります。

2. class Foo extends Function のインスタンスを promisify するケース

const util = require('util');

class Foo extends Function {
  constructor() {
    super('callback', 'callback(null, 100)');
  }
  get bar() {
    return 'bar';
  }
}

function myPromisify(fn) {
  return (...args) => new Promise((resolve, reject) => {
    fn(...args, (error, value) => error ? reject(error) : resolve(value));
  });
}

const foo = new Foo();
const promisified1 = util.promisify(foo);
const promisified2 = myPromisify(foo);
console.log([promisified1.bar, promisified2.bar]);
// → ['bar', undefined]
console.log([promisified1 instanceof Foo, promisified2 instanceof Foo]);
// → [true, false]

↑のように、Function を継承するクラス Foo のインスタンスを promisify する場合に、setPrototypeOf しないと、結果は Foo のインスタンスではなくなります。

---

まとめると、error-first callback style な関数を async な関数にする以外の副作用を起こさないようにする処置なのではないかと思いますが、いかがでしょうか。

Comments

[退会済みユーザー]

ご回答ありがとうございます。
凄くなっとくしました。
テストケースから予測する事や、extends Functionが可能な事など思いもつかない事もりだくさんな回答で大変勉強になりました。
javascriptは奥が深くて楽しいですね。
回答を見ただけなので、明日色々こねくり回して楽しみたいと思います。
ありがとうございます！

[退会済みユーザー]

疑問が解消できたようで、よかったです。Function を継承すると、インスタンスが関数呼び出しできるようになり、typeof は "object" ではなく "function" になります。ただし、回答のように super(...) の中に処理を書くと、グローバルスコープになってしまってクラスを作る意味がありません。なので、実際には Proxy を使うことになることを補足しておきます。

class Foo extends Function {

　constructor() {
　　super();
　　return new Proxy(this, {
　　　apply(target, thisArg, argumentsList) {
　　　　return target.executeFoo(...argumentsList);
　　　}
　　});
　}

　executeFoo() {
　　// ここに処理を書く
　}

}
※全角スペースでインデントしています。ご注意ください。
https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Proxy

[退会済みユーザー]

追加情報ありがとうございます。
Proxyですね。確認してみます！

[退会済みユーザー]

たびたびすみません。せっかく setPrototypeOf の話題なので、Proxy ではなくて、setPrototypeOf の例の方が良かったですね。

class Foo extends Function {
　constructor() {
　　const foo = Object.setPrototypeOf(
　　　(...args) => foo.bar(...args),
　　　Object.getPrototypeOf(super())
　　);
　　return foo;
　}
　bar(...args) {
　　return args.join('-');
　}
　baz() {
　　return 'baz';
　}
}

const foo = new Foo();
console.log(foo instanceof Foo);
// → true
console.log(foo(1, 2, 3));
// → '1-2-3'
console.log(foo.bar(1, 2, 3));
// → '1-2-3'
console.log(foo.baz(1, 2, 3));
// → 'baz'

※全角スペースでインデントしています。ご注意ください。
※2018/1/27：コードに間違いがあったため、constructor内を修正いたしました。

これなら、Proxyが使えない環境でも動きます。

[退会済みユーザー]

さらなる追加情報ありがとうございます。
setPrototypeOfに関数を渡すイメージを持っていなかったので非常に参考になります。
通常は普通に関数定義すれば良いと思うので、パッと使いどころのイメージができませんが。
知識としては、持っておいて損はないので大変勉強になりました。

それにしても、奥が深くて震えあがりますね。
ご回答ありがとうございました。