@akashic/headless-driver 2.17.10 → 2.18.0

package/lib/runner/Runner.d.ts

@@ -92,6 +92,12 @@ export declare abstract class Runner {
      * @param ms 進行するミリ秒。
      */
     abstract advance(ms: number): Promise<void>;
+    /**
+     * Runner を呼び出し時点で得られる最新状態まで進める。
+     * passive かつリアルタイムでのみ利用可能。
+     * @param timeout タイムアウトまでのミリ時間。省略時は `5000` 。ゲーム内時間ではなく実時間である点に注意。
+     */
+    abstract advanceLatest(timeout?: number): Promise<void>;
     /**
      * Runner を一フレーム進行する。
      */

package/lib/runner/v1/RunnerV1.d.ts

@@ -18,6 +18,7 @@ export declare class RunnerV1 extends Runner {
     step(): Promise<void>;
     protected _stepMinimal(): void;
     advance(ms: number): Promise<void>;
+    advanceLatest(_timeout?: number): Promise<void>;
     changeGameDriverState(param: gdr.GameDriverInitializeParameterObject): Promise<void>;
     firePointEvent(event: RunnerPointEvent): void;
     getPrimarySurface(): never;

package/lib/runner/v1/RunnerV1.js

@@ -125,6 +125,11 @@ class RunnerV1 extends Runner_1.Runner {
             yield (0, promises_1.setImmediate)();
         });
     }
+    advanceLatest(_timeout) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.errorTrigger.fire(new Error("Runner#advanceLatest() is not supported in RunnerV1"));
+        });
+    }
     changeGameDriverState(param) {
         return new Promise((resolve, reject) => {
             if (!this.driver) {

package/lib/runner/v2/RunnerV2.d.ts

@@ -17,6 +17,7 @@ export declare class RunnerV2 extends Runner {
     resume(): void;
     step(): Promise<void>;
     advance(ms: number): Promise<void>;
+    advanceLatest(timeout?: number): Promise<void>;
     changeGameDriverState(param: gdr.GameDriverInitializeParameterObject): Promise<void>;
     firePointEvent(event: RunnerPointEvent): void;
     getPrimarySurface(): never;

package/lib/runner/v2/RunnerV2.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunnerV2 = void 0;
 const promises_1 = require("node:timers/promises");
 const engine_files_v2_1 = require("engine-files-v2");
+const Logger_1 = require("../../Logger");
 const Runner_1 = require("../Runner");
 const PlatformV2_1 = require("./platform/PlatformV2");
 class RunnerV2 extends Runner_1.Runner {
@@ -113,6 +114,65 @@ class RunnerV2 extends Runner_1.Runner {
             yield (0, promises_1.setImmediate)();
         });
     }
+    advanceLatest() {
+        return __awaiter(this, arguments, void 0, function* (timeout = 5000) {
+            var _a, _b;
+            if (this.driver == null) {
+                this.errorTrigger.fire(new Error("Cannot call Runner#advanceLatest() before initialization"));
+                return;
+            }
+            if (this.running) {
+                this.errorTrigger.fire(new Error("Cannot call Runner#advanceLatest() while running"));
+                return;
+            }
+            if (this.executionMode !== "passive" || this.loopMode !== "realtime") {
+                (0, Logger_1.getSystemLogger)().warn("RunnerV2#advanceLatest() is only available when executionMode is 'passive' and loopMode is 'realtime'");
+                return;
+            }
+            const tickBuffer = (_b = (_a = this.driver) === null || _a === void 0 ? void 0 : _a._gameLoop) === null || _b === void 0 ? void 0 : _b._tickBuffer;
+            if (!tickBuffer) {
+                this.errorTrigger.fire(new Error("RunnerV2#advanceLatest() aborted because tickBuffer does not exist"));
+                return;
+            }
+            const startTime = performance.now();
+            // 最新の Tick をリクエストして、トリガーを待機する Promise を準備
+            const gotTickPromise = new Promise((resolve, reject) => {
+                const timeoutId = setTimeout(() => {
+                    reject(new Error("RunnerV2#advanceLatest() timeout: no tick response"));
+                }, Math.max(0, timeout - (performance.now() - startTime)));
+                // 新しい Tick が存在した場合
+                tickBuffer.gotNextTickTrigger.addOnce(() => {
+                    clearTimeout(timeoutId);
+                    resolve();
+                });
+                // Tick がない場合
+                tickBuffer.gotNoTickTrigger.addOnce(() => {
+                    clearTimeout(timeoutId);
+                    resolve();
+                });
+            });
+            // 先に requestTicks を呼び出して、並行して Tick の取得を開始
+            tickBuffer.requestTicks();
+            // gotNoTickTrigger または gotNextTickTrigger が fire するまで待機
+            yield gotTickPromise;
+            // TickBuffer#currentAge === TickBuffer#knownLatestAge になるまで進める
+            while (tickBuffer.currentAge < tickBuffer.knownLatestAge) {
+                if (performance.now() - startTime > timeout) {
+                    this.errorTrigger.fire(new Error("RunnerV2#advanceLatest() timeout: failed to catch up to knownLatestAge"));
+                    return;
+                }
+                // 一度に最大 100 ステップ実行
+                const batchSize = Math.min(100, tickBuffer.knownLatestAge - tickBuffer.currentAge);
+                for (let i = 0; i < batchSize; i++) {
+                    if (tickBuffer.currentAge >= tickBuffer.knownLatestAge) {
+                        break;
+                    }
+                    this._stepMinimal();
+                }
+                yield (0, promises_1.setImmediate)();
+            }
+        });
+    }
     changeGameDriverState(param) {
         return new Promise((resolve, reject) => {
             if (!this.driver) {

package/lib/runner/v3/RunnerV3.d.ts

@@ -20,6 +20,7 @@ export declare class RunnerV3 extends Runner {
     resume(): void;
     step(): Promise<void>;
     advance(ms: number): Promise<void>;
+    advanceLatest(timeout?: number): Promise<void>;
     changeGameDriverState(param: gdr.GameDriverInitializeParameterObject): Promise<void>;
     firePointEvent(event: RunnerPointEvent): void;
     /**

package/lib/runner/v3/RunnerV3.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunnerV3 = void 0;
 const promises_1 = require("node:timers/promises");
+const Logger_1 = require("../../Logger");
 const Runner_1 = require("../Runner");
 const engineFiles_1 = require("./engineFiles");
 const PlatformV3_1 = require("./platform/PlatformV3");
@@ -122,6 +123,65 @@ class RunnerV3 extends Runner_1.Runner {
             yield (0, promises_1.setImmediate)();
         });
     }
+    advanceLatest() {
+        return __awaiter(this, arguments, void 0, function* (timeout = 5000) {
+            var _a, _b;
+            if (this.driver == null) {
+                this.errorTrigger.fire(new Error("Cannot call Runner#advanceLatest() before initialization"));
+                return;
+            }
+            if (this.running) {
+                this.errorTrigger.fire(new Error("Cannot call Runner#advanceLatest() while running"));
+                return;
+            }
+            if (this.executionMode !== "passive" || this.loopMode !== "realtime") {
+                (0, Logger_1.getSystemLogger)().warn("RunnerV3#advanceLatest() is only available when executionMode is 'passive' and loopMode is 'realtime'");
+                return;
+            }
+            const tickBuffer = (_b = (_a = this.driver) === null || _a === void 0 ? void 0 : _a._gameLoop) === null || _b === void 0 ? void 0 : _b._tickBuffer;
+            if (!tickBuffer) {
+                this.errorTrigger.fire(new Error("RunnerV3#advanceLatest() aborted because tickBuffer does not exist"));
+                return;
+            }
+            const startTime = performance.now();
+            // 最新の Tick をリクエストして、トリガーを待機する Promise を準備
+            const gotTickPromise = new Promise((resolve, reject) => {
+                const timeoutId = setTimeout(() => {
+                    reject(new Error("RunnerV3#advanceLatest() timeout: no tick response"));
+                }, Math.max(0, timeout - (performance.now() - startTime)));
+                // 新しい Tick が存在した場合
+                tickBuffer.gotNextTickTrigger.addOnce(() => {
+                    clearTimeout(timeoutId);
+                    resolve();
+                });
+                // Tick がない場合
+                tickBuffer.gotNoTickTrigger.addOnce(() => {
+                    clearTimeout(timeoutId);
+                    resolve();
+                });
+            });
+            // 先に requestTicks を呼び出して、並行して Tick の取得を開始
+            tickBuffer.requestTicks();
+            // gotNoTickTrigger または gotNextTickTrigger が fire するまで待機
+            yield gotTickPromise;
+            // TickBuffer#currentAge === TickBuffer#knownLatestAge になるまで進める
+            while (tickBuffer.currentAge < tickBuffer.knownLatestAge) {
+                if (performance.now() - startTime > timeout) {
+                    this.errorTrigger.fire(new Error("RunnerV3#advanceLatest() timeout: failed to catch up to knownLatestAge"));
+                    return;
+                }
+                // 一度に最大 100 ステップ実行
+                const batchSize = Math.min(100, tickBuffer.knownLatestAge - tickBuffer.currentAge);
+                for (let i = 0; i < batchSize; i++) {
+                    if (tickBuffer.currentAge >= tickBuffer.knownLatestAge) {
+                        break;
+                    }
+                    this._stepMinimal();
+                }
+                yield (0, promises_1.setImmediate)();
+            }
+        });
+    }
     changeGameDriverState(param) {
         return new Promise((resolve, reject) => {
             if (!this.driver) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akashic/headless-driver",
-  "version": "2.17.10",
+  "version": "2.18.0",
   "description": "A library to execute contents using Akashic Engine headlessly",
   "main": "lib/index.js",
   "author": "DWANGO Co., Ltd.",
@@ -33,7 +33,7 @@
     "@akashic/trigger": "^2.0.0",
     "engine-files-v1": "npm:@akashic/engine-files@1.4.0",
     "engine-files-v2": "npm:@akashic/engine-files@2.4.0",
-    "engine-files-v3": "npm:@akashic/engine-files@3.13.2",
+    "engine-files-v3": "npm:@akashic/engine-files@3.13.3",
     "js-sha256": "^0.11.0",
     "lodash.clonedeep": "^4.5.0",
     "node-fetch": "^2.6.7"
@@ -42,7 +42,7 @@
     "@akashic/eslint-config": "^3.0.2",
     "@akashic/remark-preset-lint": "^0.1.2",
     "@napi-rs/canvas": "^0.1.66",
-    "@types/jest": "^29.1.1",
+    "@types/jest": "^30.0.0",
     "@types/lodash.clonedeep": "^4.5.7",
     "@types/node": "^24.0.0",
     "@types/node-fetch": "^2.6.2",
@@ -52,7 +52,7 @@
     "eslint-config-prettier": "^10.0.0",
     "get-port": "^5.1.1",
     "image-size": "^1.0.2",
-    "jest": "^29.1.2",
+    "jest": "^30.0.0",
     "npm-run-all": "^4.1.5",
     "pixelmatch": "^5.3.0",
     "pngjs": "^7.0.0",
@@ -60,7 +60,7 @@
     "remark-cli": "^12.0.0",
     "rimraf": "^6.0.0",
     "serve-handler": "^6.1.3",
-    "ts-jest": "^29.2.5",
+    "ts-jest": "^29.4.6",
     "typescript": "^5.7.3"
   },
   "jest": {