trusted フラグの追加

[yu-ogi]

このPullRequestが解決する内容

• RunnerManager#createRunner() のパラメータに trusted フラグを追加します。
  • このフラグが真の場合、対象のゲームコンテンツを「信頼されたもの」として実行します。信頼されたコンテンツであれば、エンジンモジュールから外部モジュールまたは組み込みモジュールへのアクセスが許可されます。それにより将来的には headless-driver の描画内容を出力する機能の提供などが期待できます。
• vm2 周りの実装を一部リファクタリングします。
  • loadFile() の処理を headless-driver 側に移動します。
  • Asset 側までファイルロード関数 (loadFileHandler()) を渡すようにします。

破壊的変更

• 部分的に あり
  • ただし headless-driver を利用する分には影響がありません。

[yu-ogi]

headless-driver 側で定義しているグローバルオブジェクトの型定義を headless-driver-runner 側で定義しているのがどうにも奇妙で部分的な変更が困難だったため、 headless-driver 側からファイルロード関数を渡すように修正してしまいました。

[yu-ogi]

このあたりは文言修正のみです。

[yu-ogi]

本来 NodeVM 上で process.exit() を実行してもエラーとなる (process is not defined となる) はずなのですが、どうにも process.exit() が実行できてしまうようでした。
ミニマムのサンプルを作ってみても再現できず原因が全くわからないため、やむを得ず TODO コメントでテストコードのみ残しています。

[yu-ogi]

調査してみたところ、どうやら context: host とすると NodeVM の require 先では process.exit() が有効となることがわかりました。これは仕様上の制限かもしれない (外部モジュールまで sandbox の制限をすると正常な動作が期待できないなどの理由) ため、そうであればこのテスト自体は不要となるかもしれません。

// module1.js
module.exports = () => {
	require("./module2")();
}

// module2.js
module.exports = () => {
	console.log('typeof process.exit', typeof process.exit);
}

// index.js
const { NodeVM } = require('vm2');

const vm1 = new NodeVM({
	require: {
		context: 'sandbox',
		external: true,
	}
});
const vm2 = new NodeVM({
	require: {
		context: 'host',
		external: true,
	}
});

// sandbox-0
vm1.run(`console.log('typeof process.exit', typeof process.exit)`);
// sandbox-1
vm1.run(`require('./module1')();`, 'index.js');
// sandbox-2
vm1.run(`require('./module2')();`, 'index.js');

// host-0
vm2.run(`console.log('typeof process.exit', typeof process.exit)`);
// host-1
vm2.run(`require('./module1')();`, 'index.js');
// host-2
vm2.run(`require('./module2')();`, 'index.js');

$ node index.js
typeof process.exit undefined
typeof process.exit undefined
typeof process.exit undefined
typeof process.exit undefined
typeof process.exit function
typeof process.exit function

[yu-ogi]

https://github.com/patriksimek/vm2#nodevm

require.context - host (default) to require modules in host and proxy them to sandbox. sandbox to load, compile and require modules in sandbox. Builtin modules except events always required in host and proxied to sandbox.

[yu-ogi]

 trusted でも allowUrls が有効であることを確認します。

[yu-ogi]

バージョンごとに runnerParameters が異なることを想定して別々でパラメータを定義していましたが、型定義自体は RunnerParameters であることには変わりないため共通の変数でまとめてしまいました。

[ShinobuTakahashi]

コメントが v1 となっています。

[yu-ogi]

おお、ありがとうございます。ややこしいので 過去バージョンのため〜〜 に統一してしまいました。

[ShinobuTakahashi]

ここと resolveGameConfiguration(), loadJSON() の async も消せそうです。

[yu-ogi]

ここは単に不要な return await を嫌っただけなので他の箇所については修正する必要は無いかなと。

• https://github.com/eslint/eslint/blob/master/docs/rules/no-return-await.md
• https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Statements/async_function

[ShinobuTakahashi]

なるほど、理解しました。ありがとうございます。

[xnv]

コメント加えましたが approved.

[xnv]

true の場合と false の場合の違いについてコメントしておきたいです。(特に true の場合に何が可能になるのか、どういう時に使用すべきでないか)

[yu-ogi]

こちらコメント追加しました。

[yu-ogi]

#250 をマージ後、このブランチを master へマージしようと思います。

prepare-1.7.0 ブランチを master から派生してそちらにマージしようと思います。