@akashic/headless-driver 2.9.1 → 2.10.0

package/lib/runner/RunnerManager.d.ts

@@ -1,12 +1,14 @@
-import { NodeVM } from "vm2";
 import type { AMFlowClient } from "../play/amflow/AMFlowClient";
 import type { PlayManager } from "../play/PlayManager";
 import type { EncodingType } from "../utils";
 import type { RunnerStartParameters } from "./Runner";
 import type { RunnerExecutionMode, RunnerPlayer, RunnerRenderingMode } from "./types";
-import type { RunnerV1, RunnerV1Game } from "./v1";
-import type { RunnerV2, RunnerV2Game } from "./v2";
-import type { RunnerV3, RunnerV3Game } from "./v3";
+import type { RunnerV1Game } from "./v1";
+import { RunnerV1 } from "./v1";
+import type { RunnerV2Game } from "./v2";
+import { RunnerV2 } from "./v2";
+import type { RunnerV3Game } from "./v3";
+import { RunnerV3 } from "./v3";
 export interface CreateRunnerParameters {
     playId: string;
     amflow: AMFlowClient;
@@ -16,16 +18,14 @@ export interface CreateRunnerParameters {
     player?: RunnerPlayer;
     /**
      * 信頼されたコンテンツであるかどうか。
-     * `true` の場合、そのコンテンツを「信頼されたもの」として扱い、外部モジュールまたは組み込みモジュールへのアクセスが許可される。
-     * `false` の場合、コンテンツまたはエンジンモジュールでの動作が一部制限される (外部モジュールまたは組み込みモジュールへのアクセスが制限など)。
-     * 特に理由がない限り `false` にしておくことを推奨。
+     * この設定は現在のバージョンにおいて形骸化している。本値により振る舞いは変化しない。
      * 初期値は `false` 。
      */
     trusted?: boolean;
     /**
      * レンダリングモード。
      * `"canvas"` を指定するとプライマリサーフェスの描画内容を `Runner#getPrimarySurface()` を経由して取得できる。
-     * `"canvas"` を指定した場合 `trusted` を `true` にしなければならない。また、利用側で node-canvas をインストールしなければならない。
+     * `"canvas"` を指定した場合、利用側で node-canvas をインストールしなければならない。
      * 初期値は `"none"` 。
      */
     renderingMode?: RunnerRenderingMode;
@@ -68,8 +68,6 @@ export declare class RunnerManager {
     constructor(playManager: PlayManager);
     /**
      * Runner を作成する。
-     * Runner は Node.js の Virtual Machine 上で実行される。
-     * 主な制限事項として process へのアクセスが制限される。
      * @param params パラメータ
      */
     createRunner(params: CreateRunnerParameters): Promise<string>;
@@ -116,6 +114,5 @@ export declare class RunnerManager {
     protected resolveGameConfiguration(gameJsonUrl: string): Promise<GameConfiguration>;
     protected loadJSON<T>(contentUrl: string): Promise<T>;
     protected createLoadFileHandler(allowedUrls: (string | RegExp)[] | null): (url: string, encoding: EncodingType, callback: (err: Error | null, data?: string | Uint8Array) => void) => void;
-    protected createVm(trusted?: boolean): NodeVM;
 }
 export {};

package/lib/runner/RunnerManager.js

@@ -10,16 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunnerManager = void 0;
-const fs = require("fs");
 const path = require("path");
-const url = require("url");
-const vm2_1 = require("vm2");
-const ExecVmScriptV1 = require("../ExecuteVmScriptV1");
-const ExecVmScriptV2 = require("../ExecuteVmScriptV2");
-const ExecVmScriptV3 = require("../ExecuteVmScriptV3");
 const Logger_1 = require("../Logger");
 const utils_1 = require("../utils");
-const requireEngineFiles_1 = require("./v3/requireEngineFiles");
+const v1_1 = require("./v1");
+const v2_1 = require("./v2");
+const v3_1 = require("./v3");
 /**
  * Runner を管理するマネージャ。
  */
@@ -31,8 +27,6 @@ class RunnerManager {
     }
     /**
      * Runner を作成する。
-     * Runner は Node.js の Virtual Machine 上で実行される。
-     * 主な制限事項として process へのアクセスが制限される。
      * @param params パラメータ
      */
     createRunner(params) {
@@ -87,20 +81,20 @@ class RunnerManager {
                 if (gameConfiguration.definitions) {
                     const defs = [];
                     for (let i = 0; i < gameConfiguration.definitions.length; i++) {
-                        const _url = url.resolve(engineConfiguration.asset_base_url, gameConfiguration.definitions[i]);
+                        const _url = (0, utils_1.resolveUrl)(engineConfiguration.asset_base_url, gameConfiguration.definitions[i]);
                         const _def = yield this.loadJSON(_url);
                         defs.push(_def);
                     }
                     version = defs.reduce((acc, def) => {
-                        return (def.environment && def.environment["sandbox-runtime"]) || acc;
+                        var _a;
+                        return (_a = (def.environment && def.environment["sandbox-runtime"])) !== null && _a !== void 0 ? _a : acc;
                     }, version);
-                    configurationBaseUrl = url.resolve(engineConfiguration.content_url, "./");
+                    configurationBaseUrl = (0, utils_1.resolveUrl)(engineConfiguration.content_url, "./");
                 }
                 else if (gameConfiguration.environment && gameConfiguration.environment["sandbox-runtime"]) {
                     version = gameConfiguration.environment["sandbox-runtime"];
                 }
                 const runnerId = `${this.nextRunnerId++}`;
-                const nvm = this.createVm(params.trusted);
                 const runnerParameter = {
                     contentUrl,
                     assetBaseUrl: engineConfiguration.asset_base_url,
@@ -121,24 +115,15 @@ class RunnerManager {
                 };
                 if (version === "3") {
                     (0, Logger_1.getSystemLogger)().info("v3 content");
-                    const filePath = ExecVmScriptV3.getFilePath();
-                    const str = fs.readFileSync(filePath, { encoding: "utf8" });
-                    const script = new vm2_1.VMScript(str, filePath);
-                    runner = nvm.run(script).createRunnerV3(runnerParameter);
+                    runner = new v3_1.RunnerV3(runnerParameter);
                 }
                 else if (version === "2") {
                     (0, Logger_1.getSystemLogger)().info("v2 content");
-                    const filePath = ExecVmScriptV2.getFilePath();
-                    const str = fs.readFileSync(filePath, { encoding: "utf8" });
-                    const script = new vm2_1.VMScript(str, filePath);
-                    runner = nvm.run(script).createRunnerV2(runnerParameter);
+                    runner = new v2_1.RunnerV2(runnerParameter);
                 }
                 else {
                     (0, Logger_1.getSystemLogger)().info("v1 content");
-                    const filePath = ExecVmScriptV1.getFilePath();
-                    const str = fs.readFileSync(filePath, { encoding: "utf8" });
-                    const script = new vm2_1.VMScript(str, filePath);
-                    runner = nvm.run(script).createRunnerV1(runnerParameter);
+                    runner = new v1_1.RunnerV1(runnerParameter);
                 }
                 runner.errorTrigger.add((err) => {
                     (0, Logger_1.getSystemLogger)().error(err.message);
@@ -285,27 +270,5 @@ class RunnerManager {
             });
         };
     }
-    createVm(trusted = false) {
-        return new vm2_1.NodeVM({
-            sandbox: {
-                trustedFunctions: {
-                    engineFiles: () => {
-                        return (0, requireEngineFiles_1.requireEngineFiles)();
-                    }
-                }
-            },
-            require: trusted
-                ? {
-                    context: "host",
-                    external: true,
-                    builtin: ["*"]
-                }
-                : {
-                    context: "sandbox",
-                    external: true,
-                    builtin: []
-                }
-        });
-    }
 }
 exports.RunnerManager = RunnerManager;

package/lib/runner/v1/platform/assets/NodeScriptAsset.d.ts

@@ -7,8 +7,6 @@ export interface NodeScriptAssetParameters {
     loadFileHandler: RunnerLoadFileHandler;
 }
 export declare class NodeScriptAsset extends g.ScriptAsset {
-    static PRE_SCRIPT: string;
-    static POST_SCRIPT: string;
     private errorHandler;
     private loadFileHandler;
     constructor(param: NodeScriptAssetParameters);

package/lib/runner/v1/platform/assets/NodeScriptAsset.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeScriptAsset = void 0;
+const vm_1 = require("vm");
 const engine_files_v1_1 = require("engine-files-v1");
 class NodeScriptAsset extends engine_files_v1_1.akashicEngine.ScriptAsset {
     constructor(param) {
@@ -21,9 +22,32 @@ class NodeScriptAsset extends engine_files_v1_1.akashicEngine.ScriptAsset {
         });
     }
     execute(execEnv) {
-        const func = new Function("g", NodeScriptAsset.PRE_SCRIPT + this.script + NodeScriptAsset.POST_SCRIPT);
         try {
-            func(execEnv);
+            const context = (0, vm_1.createContext)(Object.create(null));
+            (0, vm_1.runInContext)(`
+					(console, g) => {
+						globalThis.console = {
+							log: console.log,
+							info: console.info,
+							warn: console.warn,
+							error: console.error,
+							assert: console.assert,
+							clear: console.clear,
+							dir: console.dir,
+							time: console.time,
+							timeEnd: console.timeEnd,
+							trace: console.trace
+						};
+						globalThis.g = g;
+					}
+				`, context)(console, execEnv);
+            (0, vm_1.runInContext)(`
+					(function(exports, require, module, __filename, __dirname) {
+					${this.script}
+					})(g.module.exports, g.module.require, g.module, g.filename, g.dirname);
+				`, context, {
+                filename: `${this.path}`
+            });
         }
         catch (e) {
             this.errorHandler(e);
@@ -31,6 +55,4 @@ class NodeScriptAsset extends engine_files_v1_1.akashicEngine.ScriptAsset {
         return execEnv.module.exports;
     }
 }
-NodeScriptAsset.PRE_SCRIPT = "(function(exports, require, module, __filename, __dirname) {\n";
-NodeScriptAsset.POST_SCRIPT = "\n})(g.module.exports, g.module.require, g.module, g.filename, g.dirname);";
 exports.NodeScriptAsset = NodeScriptAsset;

package/lib/runner/v2/platform/assets/NodeScriptAsset.d.ts

@@ -7,8 +7,6 @@ export interface NodeScriptAssetParameters {
     loadFileHandler: RunnerLoadFileHandler;
 }
 export declare class NodeScriptAsset extends g.ScriptAsset {
-    static PRE_SCRIPT: string;
-    static POST_SCRIPT: string;
     private errorHandler;
     private loadFileHandler;
     constructor(param: NodeScriptAssetParameters);

package/lib/runner/v2/platform/assets/NodeScriptAsset.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeScriptAsset = void 0;
+const vm_1 = require("vm");
 const engine_files_v2_1 = require("engine-files-v2");
 class NodeScriptAsset extends engine_files_v2_1.akashicEngine.ScriptAsset {
     constructor(param) {
@@ -21,9 +22,32 @@ class NodeScriptAsset extends engine_files_v2_1.akashicEngine.ScriptAsset {
         });
     }
     execute(execEnv) {
-        const func = new Function("g", NodeScriptAsset.PRE_SCRIPT + this.script + NodeScriptAsset.POST_SCRIPT);
         try {
-            func(execEnv);
+            const context = (0, vm_1.createContext)(Object.create(null));
+            (0, vm_1.runInContext)(`
+					(console, g) => {
+						globalThis.console = {
+							log: console.log,
+							info: console.info,
+							warn: console.warn,
+							error: console.error,
+							assert: console.assert,
+							clear: console.clear,
+							dir: console.dir,
+							time: console.time,
+							timeEnd: console.timeEnd,
+							trace: console.trace
+						};
+						globalThis.g = g;
+					}
+				`, context)(console, execEnv);
+            (0, vm_1.runInContext)(`
+					(function(exports, require, module, __filename, __dirname) {
+					${this.script}
+					})(g.module.exports, g.module.require, g.module, g.filename, g.dirname);
+				`, context, {
+                filename: `${this.path}`
+            });
         }
         catch (e) {
             this.errorHandler(e);
@@ -31,6 +55,4 @@ class NodeScriptAsset extends engine_files_v2_1.akashicEngine.ScriptAsset {
         return execEnv.module.exports;
     }
 }
-NodeScriptAsset.PRE_SCRIPT = "(function(exports, require, module, __filename, __dirname) {\n";
-NodeScriptAsset.POST_SCRIPT = "\n})(g.module.exports, g.module.require, g.module, g.filename, g.dirname);";
 exports.NodeScriptAsset = NodeScriptAsset;

package/lib/runner/v3/platform/assets/NodeScriptAsset.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeScriptAsset = void 0;
+const vm_1 = require("vm");
 const Asset_1 = require("./Asset");
 class NodeScriptAsset extends Asset_1.Asset {
     constructor(param) {
@@ -40,14 +41,33 @@ class NodeScriptAsset extends Asset_1.Asset {
         for (const key of this.exports) {
             postScript += `exports["${key}"] = typeof ${key} !== "undefined" ? ${key} : undefined;\n`;
         }
-        const func = new Function("g", "(function(exports, require, module, __filename, __dirname) {\n" +
-            this.script +
-            "\n" +
-            postScript +
-            "\n" +
-            "})(g.module.exports, g.module.require, g.module, g.filename, g.dirname);");
         try {
-            func(execEnv);
+            const context = (0, vm_1.createContext)(Object.create(null));
+            (0, vm_1.runInContext)(`
+					(console, g) => {
+						globalThis.console = {
+							log: console.log,
+							info: console.info,
+							warn: console.warn,
+							error: console.error,
+							assert: console.assert,
+							clear: console.clear,
+							dir: console.dir,
+							time: console.time,
+							timeEnd: console.timeEnd,
+							trace: console.trace
+						};
+						globalThis.g = g;
+					}
+				`, context)(console, execEnv);
+            (0, vm_1.runInContext)(`
+					(function(exports, require, module, __filename, __dirname) {
+					${this.script}
+					${postScript}
+					})(g.module.exports, g.module.require, g.module, g.filename, g.dirname);
+				`, context, {
+                filename: `${this.path}`
+            });
         }
         catch (e) {
             this.errorHandler(e);

package/lib/utils.d.ts

@@ -21,3 +21,4 @@ export declare namespace LoadFileInternal {
     function loadImpl(url: string, encoding?: EncodingType): Promise<string | Uint8Array>;
 }
 export declare function isHttpProtocol(url: string): boolean;
+export declare function resolveUrl(from: string, to: string): string;

package/lib/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isHttpProtocol = exports.LoadFileInternal = exports.loadFile = void 0;
+exports.resolveUrl = exports.isHttpProtocol = exports.LoadFileInternal = exports.loadFile = void 0;
 const fs = require("fs");
 const node_fetch_1 = require("node-fetch");
 const waitings = [];
@@ -87,3 +87,14 @@ function isHttpProtocol(url) {
     return /^(http|https)\:\/\//.test(url);
 }
 exports.isHttpProtocol = isHttpProtocol;
+// @see https://nodejs.org/api/url.html#urlresolvefrom-to
+function resolveUrl(from, to) {
+    const resolvedUrl = new URL(to, new URL(from, "resolve://"));
+    if (resolvedUrl.protocol === "resolve:") {
+        // `from` is a relative URL.
+        const { pathname, search, hash } = resolvedUrl;
+        return pathname + search + hash;
+    }
+    return resolvedUrl.toString();
+}
+exports.resolveUrl = resolveUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akashic/headless-driver",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "description": "A library to execute contents using Akashic Engine headlessly",
   "main": "lib/index.js",
   "author": "DWANGO Co., Ltd.",
@@ -29,11 +29,10 @@
     "@akashic/trigger": "^2.0.0",
     "engine-files-v1": "npm:@akashic/engine-files@1.2.2",
     "engine-files-v2": "npm:@akashic/engine-files@2.2.3",
-    "engine-files-v3": "npm:@akashic/engine-files@3.7.3",
+    "engine-files-v3": "npm:@akashic/engine-files@3.7.4",
     "js-sha256": "^0.9.0",
     "lodash.clonedeep": "^4.5.0",
-    "node-fetch": "^2.6.7",
-    "vm2": "3.9.11"
+    "node-fetch": "^2.6.7"
   },
   "devDependencies": {
     "@akashic/eslint-config": "^1.1.1",
@@ -56,7 +55,7 @@
     "npm-run-all": "^4.1.5",
     "pixelmatch": "^5.3.0",
     "pngjs": "^7.0.0",
-    "prettier": "^2.7.1",
+    "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
     "rimraf": "^5.0.0",
     "serve-handler": "^6.1.3",

package/lib/ExecuteVmScriptV1.d.ts

@@ -1,4 +0,0 @@
-import type { RunnerParameters } from "./runner";
-import { RunnerV1 } from "./runner/v1";
-export declare function createRunnerV1(params: RunnerParameters): RunnerV1;
-export declare function getFilePath(): string;

package/lib/ExecuteVmScriptV1.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilePath = exports.createRunnerV1 = void 0;
-const v1_1 = require("./runner/v1");
-function createRunnerV1(params) {
-    return new v1_1.RunnerV1(params);
-}
-exports.createRunnerV1 = createRunnerV1;
-function getFilePath() {
-    return __filename;
-}
-exports.getFilePath = getFilePath;

package/lib/ExecuteVmScriptV2.d.ts

@@ -1,4 +0,0 @@
-import type { RunnerParameters } from "./runner";
-import { RunnerV2 } from "./runner/v2";
-export declare function createRunnerV2(params: RunnerParameters): RunnerV2;
-export declare function getFilePath(): string;

package/lib/ExecuteVmScriptV2.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilePath = exports.createRunnerV2 = void 0;
-const v2_1 = require("./runner/v2");
-function createRunnerV2(params) {
-    return new v2_1.RunnerV2(params);
-}
-exports.createRunnerV2 = createRunnerV2;
-function getFilePath() {
-    return __filename;
-}
-exports.getFilePath = getFilePath;

package/lib/ExecuteVmScriptV3.d.ts

@@ -1,4 +0,0 @@
-import type { RunnerParameters } from "./runner";
-import { RunnerV3 } from "./runner/v3";
-export declare function createRunnerV3(params: RunnerParameters): RunnerV3;
-export declare function getFilePath(): string;

package/lib/ExecuteVmScriptV3.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilePath = exports.createRunnerV3 = void 0;
-const v3_1 = require("./runner/v3");
-function createRunnerV3(params) {
-    return new v3_1.RunnerV3(params);
-}
-exports.createRunnerV3 = createRunnerV3;
-function getFilePath() {
-    return __filename;
-}
-exports.getFilePath = getFilePath;